BUG-6522: create a specialized CopyHistory object
[yangtools.git] / yang / yang-parser-impl / src / main / java / org / opendaylight / yangtools / yang / parser / stmt / reactor / SubstatementContext.java
index f921e13b2adb0cae97135ab46aec2e91488d1cbe..6d369e6b6f50840da796725889ad195ba5ed8b6b 100644 (file)
@@ -7,62 +7,80 @@
  */
 package org.opendaylight.yangtools.yang.parser.stmt.reactor;
 
-import java.util.List;
-import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.GroupingUtils;
-import org.opendaylight.yangtools.yang.common.QNameModule;
+import com.google.common.base.Optional;
+import com.google.common.base.Preconditions;
+import com.google.common.base.Verify;
 import java.util.Collection;
 import org.opendaylight.yangtools.yang.common.QName;
-import com.google.common.base.Preconditions;
+import org.opendaylight.yangtools.yang.common.QNameModule;
+import org.opendaylight.yangtools.yang.model.api.SchemaPath;
 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
+import org.opendaylight.yangtools.yang.model.api.stmt.AugmentStatement;
+import org.opendaylight.yangtools.yang.model.api.stmt.ChoiceStatement;
+import org.opendaylight.yangtools.yang.model.api.stmt.ConfigStatement;
+import org.opendaylight.yangtools.yang.model.api.stmt.KeyStatement;
+import org.opendaylight.yangtools.yang.model.api.stmt.RefineStatement;
+import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier;
+import org.opendaylight.yangtools.yang.model.api.stmt.UsesStatement;
+import org.opendaylight.yangtools.yang.parser.spi.meta.CopyType;
+import org.opendaylight.yangtools.yang.parser.spi.meta.InferenceException;
 import org.opendaylight.yangtools.yang.parser.spi.meta.NamespaceBehaviour.NamespaceStorageNode;
 import org.opendaylight.yangtools.yang.parser.spi.meta.NamespaceBehaviour.Registry;
-import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
+import org.opendaylight.yangtools.yang.parser.spi.meta.QNameCacheNamespace;
+import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
+import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
+import org.opendaylight.yangtools.yang.parser.spi.source.AugmentToChoiceNamespace;
+import org.opendaylight.yangtools.yang.parser.spi.validation.ValidationBundlesNamespace;
+import org.opendaylight.yangtools.yang.parser.spi.validation.ValidationBundlesNamespace.ValidationBundleType;
+import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.GroupingUtils;
+import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.Utils;
 
-class SubstatementContext<A, D extends DeclaredStatement<A>, E extends EffectiveStatement<A, D>>
-        extends StatementContextBase<A, D, E> {
+final class SubstatementContext<A, D extends DeclaredStatement<A>, E extends EffectiveStatement<A, D>> extends
+        StatementContextBase<A, D, E> {
 
     private final StatementContextBase<?, ?, ?> parent;
     private final A argument;
+    private volatile SchemaPath schemaPath;
 
-    SubstatementContext(StatementContextBase<?, ?, ?> parent,
-            ContextBuilder<A, D, E> builder) throws SourceException {
+    SubstatementContext(final StatementContextBase<?, ?, ?> parent, final ContextBuilder<A, D, E> builder) {
         super(builder);
-        this.parent = Preconditions.checkNotNull(parent,
-                "Parent must not be null");
-        this.argument = builder.getDefinition().parseArgumentValue(this,
-                builder.getRawArgument());
+        this.parent = Preconditions.checkNotNull(parent, "Parent must not be null");
+        this.argument = builder.getDefinition().parseArgumentValue(this, builder.getRawArgument());
     }
 
-    SubstatementContext(SubstatementContext<A, D, E> original,
-            QNameModule newQNameModule,
-            StatementContextBase<?, ?, ?> newParent, TypeOfCopy typeOfCopy)
-            throws SourceException {
+    @SuppressWarnings("unchecked")
+    SubstatementContext(final SubstatementContext<A, D, E> original, final QNameModule newQNameModule,
+            final StatementContextBase<?, ?, ?> newParent, final CopyType typeOfCopy) {
         super(original);
         this.parent = newParent;
 
-        if (newQNameModule != null && original.argument instanceof QName) {
-            QName originalQName = (QName) original.argument;
-            this.argument = (A) QName.create(newQNameModule,
-                    originalQName.getLocalName());
+        if (newQNameModule != null) {
+            if (original.argument instanceof QName) {
+                final QName originalQName = (QName) original.argument;
+                this.argument = (A) getFromNamespace(QNameCacheNamespace.class,
+                        QName.create(newQNameModule, originalQName.getLocalName()));
+            } else if (StmtContextUtils.producesDeclared(original, KeyStatement.class)) {
+                this.argument = (A) StmtContextUtils.replaceModuleQNameForKey(
+                        (StmtContext<Collection<SchemaNodeIdentifier>, KeyStatement, ?>) original, newQNameModule);
+            } else {
+                this.argument = original.argument;
+            }
         } else {
             this.argument = original.argument;
         }
-
-        copyDeclaredStmts(original, newQNameModule, typeOfCopy);
-
-        copyEffectiveStmts(original, newQNameModule, typeOfCopy);
     }
 
-    private void copyDeclaredStmts(SubstatementContext<A, D, E> original,
-            QNameModule newQNameModule, TypeOfCopy typeOfCopy)
-            throws SourceException {
-        Collection<? extends StatementContextBase<?, ?, ?>> originalDeclaredSubstatements = original
+    private void copyDeclaredStmts(final SubstatementContext<A, D, E> original, final QNameModule newQNameModule,
+            final CopyType typeOfCopy) {
+        final Collection<? extends StatementContextBase<?, ?, ?>> originalDeclaredSubstatements = original
                 .declaredSubstatements();
-        for (StatementContextBase<?, ?, ?> stmtContext : originalDeclaredSubstatements) {
+        for (final StatementContextBase<?, ?, ?> stmtContext : originalDeclaredSubstatements) {
+            if (!StmtContextUtils.areFeaturesSupported(stmtContext)) {
+                continue;
+            }
             if (GroupingUtils.needToCopyByUses(stmtContext)) {
-                StatementContextBase<?, ?, ?> copy = stmtContext.createCopy(
-                        newQNameModule, this, typeOfCopy);
+                final StatementContextBase<?, ?, ?> copy = stmtContext.createCopy(newQNameModule, this, typeOfCopy);
                 this.addEffectiveSubstatement(copy);
             } else if (GroupingUtils.isReusedByUses(stmtContext)) {
                 this.addEffectiveSubstatement(stmtContext);
@@ -70,15 +88,13 @@ class SubstatementContext<A, D extends DeclaredStatement<A>, E extends Effective
         }
     }
 
-    private void copyEffectiveStmts(SubstatementContext<A, D, E> original,
-            QNameModule newQNameModule, TypeOfCopy typeOfCopy)
-            throws SourceException {
-        Collection<? extends StatementContextBase<?, ?, ?>> originalEffectiveSubstatements = original
+    private void copyEffectiveStmts(final SubstatementContext<A, D, E> original, final QNameModule newQNameModule,
+            final CopyType typeOfCopy) {
+        final Collection<? extends StatementContextBase<?, ?, ?>> originalEffectiveSubstatements = original
                 .effectiveSubstatements();
-        for (StatementContextBase<?, ?, ?> stmtContext : originalEffectiveSubstatements) {
+        for (final StatementContextBase<?, ?, ?> stmtContext : originalEffectiveSubstatements) {
             if (GroupingUtils.needToCopyByUses(stmtContext)) {
-                StatementContextBase<?, ?, ?> copy = stmtContext.createCopy(
-                        newQNameModule, this, typeOfCopy);
+                final StatementContextBase<?, ?, ?> copy = stmtContext.createCopy(newQNameModule, this, typeOfCopy);
                 this.addEffectiveSubstatement(copy);
             } else if (GroupingUtils.isReusedByUses(stmtContext)) {
                 this.addEffectiveSubstatement(stmtContext);
@@ -112,25 +128,137 @@ class SubstatementContext<A, D extends DeclaredStatement<A>, E extends Effective
     }
 
     @Override
-    public StatementContextBase<A, D, E> createCopy(QNameModule newQNameModule,
-            StatementContextBase<?, ?, ?> newParent, TypeOfCopy typeOfCopy)
-            throws SourceException {
-        SubstatementContext<A, D, E> copy = new SubstatementContext<>(this,
-                newQNameModule, newParent, typeOfCopy);
-        copy.setTypeOfCopy(typeOfCopy);
-        copy.setOriginalCtx(this);
+    public StatementContextBase<?, ?, ?> createCopy(final StatementContextBase<?, ?, ?> newParent,
+            final CopyType typeOfCopy) {
+        return createCopy(null, newParent, typeOfCopy);
+    }
+
+    @Override
+    public StatementContextBase<A, D, E> createCopy(final QNameModule newQNameModule,
+            final StatementContextBase<?, ?, ?> newParent, final CopyType typeOfCopy) {
+        final SubstatementContext<A, D, E> copy = new SubstatementContext<>(this, newQNameModule, newParent, typeOfCopy);
+
+        copy.appendCopyHistory(typeOfCopy, this.getCopyHistory());
+
+        if (this.getOriginalCtx() != null) {
+            copy.setOriginalCtx(this.getOriginalCtx());
+        } else {
+            copy.setOriginalCtx(this);
+        }
+
+        definition().onStatementAdded(copy);
+
+        copy.copyDeclaredStmts(this, newQNameModule, typeOfCopy);
+        copy.copyEffectiveStmts(this, newQNameModule, typeOfCopy);
         return copy;
     }
 
+    private boolean isSupportedAsShorthandCase() {
+        final Collection<?> supportedCaseShorthands = getFromNamespace(ValidationBundlesNamespace.class,
+                ValidationBundleType.SUPPORTED_CASE_SHORTHANDS);
+        return supportedCaseShorthands == null || supportedCaseShorthands.contains(getPublicDefinition());
+    }
+
+    private SchemaPath createSchemaPath() {
+        final Optional<SchemaPath> maybeParentPath = parent.getSchemaPath();
+        Verify.verify(maybeParentPath.isPresent(), "Parent %s does not have a SchemaPath", parent);
+        final SchemaPath parentPath = maybeParentPath.get();
+
+        if (argument instanceof QName) {
+            final QName qname = (QName) argument;
+            if (StmtContextUtils.producesDeclared(this, UsesStatement.class)) {
+                return maybeParentPath.orNull();
+            }
+
+            final SchemaPath path;
+            if ((StmtContextUtils.producesDeclared(getParentContext(), ChoiceStatement.class)
+                    || Boolean.TRUE.equals(parent.getFromNamespace(AugmentToChoiceNamespace.class, parent)))
+                    && isSupportedAsShorthandCase()) {
+                path = parentPath.createChild(qname);
+            } else {
+                path = parentPath;
+            }
+            return path.createChild(qname);
+        }
+        if (argument instanceof String) {
+            // FIXME: This may yield illegal argument exceptions
+            final StatementContextBase<?, ?, ?> originalCtx = getOriginalCtx();
+            final QName qname = (originalCtx != null) ? Utils.qNameFromArgument(originalCtx, (String) argument) : Utils
+                    .qNameFromArgument(this, (String) argument);
+            return parentPath.createChild(qname);
+        }
+        if (argument instanceof SchemaNodeIdentifier
+                && (StmtContextUtils.producesDeclared(this, AugmentStatement.class) || StmtContextUtils
+                        .producesDeclared(this, RefineStatement.class))) {
+
+            return parentPath.createChild(((SchemaNodeIdentifier) argument).getPathFromRoot());
+        }
+        if (Utils.isUnknownNode(this)) {
+            return parentPath.createChild(getPublicDefinition().getStatementName());
+        }
+
+        // FIXME: this does not look right
+        return maybeParentPath.orNull();
+    }
+
     @Override
-    public List<Object> getArgumentsFromRoot() {
-        List<Object> argumentsFromRoot = parent.getArgumentsFromRoot();
-        argumentsFromRoot.add(argument);
-        return argumentsFromRoot;
+    public Optional<SchemaPath> getSchemaPath() {
+        SchemaPath local = schemaPath;
+        if (local == null) {
+            synchronized (this) {
+                local = schemaPath;
+                if (local == null) {
+                    local = createSchemaPath();
+                    schemaPath = local;
+                }
+            }
+
+        }
+
+        return Optional.fromNullable(local);
     }
 
     @Override
     public boolean isRootContext() {
         return false;
     }
+
+    @Override
+    public boolean isConfiguration() {
+        final StmtContext<Boolean, ?, ?> configStatement = StmtContextUtils.findFirstSubstatement(this,
+                ConfigStatement.class);
+
+        /*
+         * If "config" statement is not specified, the default is the same as
+         * the parent schema node's "config" value.
+         */
+        if (configStatement == null) {
+            return parent.isConfiguration();
+        }
+
+        /*
+         * If a parent node has "config" set to "true", the node underneath it
+         * can have "config" set to "true" or "false".
+         */
+        if (parent.isConfiguration()) {
+            return configStatement.getStatementArgument();
+        }
+
+        /*
+         * If a parent node has "config" set to "false", no node underneath it
+         * can have "config" set to "true", therefore only "false" is permitted.
+         */
+        if (!configStatement.getStatementArgument()) {
+            return false;
+        }
+
+        throw new InferenceException(
+                "Parent node has config statement set to false, therefore no node underneath it can have config set to true",
+                getStatementSourceReference());
+    }
+
+    @Override
+    public boolean isEnabledSemanticVersioning() {
+        return parent.isEnabledSemanticVersioning();
+    }
 }