BUG-7052: reduce StatementContextBase proliferation even more
[yangtools.git] / yang / yang-parser-impl / src / main / java / org / opendaylight / yangtools / yang / parser / stmt / reactor / RootStatementContext.java
index dc2c4bc206901ac4208966d80f03f13834043864..7bb341e73c5dc633de57bb2f739d5b800316a736 100644 (file)
@@ -11,22 +11,29 @@ import com.google.common.base.Optional;
 import com.google.common.base.Preconditions;
 import com.google.common.base.Verify;
 import com.google.common.collect.ImmutableList;
+import com.google.common.collect.ImmutableSet;
 import java.util.ArrayList;
 import java.util.Collection;
+import java.util.HashSet;
 import java.util.Map;
+import javax.annotation.Nonnull;
 import javax.annotation.Nullable;
 import org.opendaylight.yangtools.yang.common.QNameModule;
+import org.opendaylight.yangtools.yang.common.YangVersion;
+import org.opendaylight.yangtools.yang.model.api.ModuleIdentifier;
 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.meta.IdentifierNamespace;
 import org.opendaylight.yangtools.yang.parser.spi.meta.CopyType;
+import org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase;
+import org.opendaylight.yangtools.yang.parser.spi.meta.MutableStatement;
 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.meta.NamespaceBehaviour.StorageNodeType;
 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
-import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
-import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.IncludedModuleContext;
+import org.opendaylight.yangtools.yang.parser.spi.source.IncludedModuleContext;
+import org.opendaylight.yangtools.yang.parser.spi.source.StatementSourceReference;
 
 /**
  * Root statement class for a YANG source. All statements defined in that YANG source are mapped underneath an instance
@@ -35,18 +42,33 @@ import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.IncludedModuleContext
 public class RootStatementContext<A, D extends DeclaredStatement<A>, E extends EffectiveStatement<A, D>> extends
         StatementContextBase<A, D, E> {
 
+    public static final YangVersion DEFAULT_VERSION = YangVersion.VERSION_1;
+
     private final SourceSpecificContext sourceContext;
     private final A argument;
 
+    private YangVersion version;
+    private Collection<ModuleIdentifier> requiredModules = ImmutableSet.of();
+    private ModuleIdentifier identifier;
+
     /**
      * References to RootStatementContext of submodules which are included in this source.
      */
     private Collection<RootStatementContext<?, ?, ?>> includedContexts = ImmutableList.of();
 
-    RootStatementContext(final ContextBuilder<A, D, E> builder, final SourceSpecificContext sourceContext) {
-        super(builder);
+    RootStatementContext(final SourceSpecificContext sourceContext, final StatementDefinitionContext<A, D, E> def,
+        final StatementSourceReference ref, final String rawArgument) {
+        super(def, ref, rawArgument);
         this.sourceContext = Preconditions.checkNotNull(sourceContext);
-        this.argument = builder.getDefinition().parseArgumentValue(this, builder.getRawArgument());
+        this.argument = def.parseArgumentValue(this, rawStatementArgument());
+    }
+
+    RootStatementContext(final SourceSpecificContext sourceContext, final StatementDefinitionContext<A, D, E> def,
+            final StatementSourceReference ref, final String rawArgument, final YangVersion version,
+            final ModuleIdentifier identifier) {
+        this(sourceContext, def, ref, rawArgument);
+        this.setRootVersion(version);
+        this.setRootIdentifier(identifier);
     }
 
     RootStatementContext(final RootStatementContext<A, D, E> original, final QNameModule newQNameModule,
@@ -56,12 +78,12 @@ public class RootStatementContext<A, D extends DeclaredStatement<A>, E extends E
         sourceContext = Preconditions.checkNotNull(original.sourceContext);
         this.argument = original.argument;
 
-        final Collection<StatementContextBase<?, ?, ?>> declared = original.declaredSubstatements();
-        final Collection<StatementContextBase<?, ?, ?>> effective = original.effectiveSubstatements();
-        final Collection<StatementContextBase<?, ?, ?>> buffer = new ArrayList<>(declared.size() + effective.size());
+        final Collection<? extends Mutable<?, ?, ?>> declared = original.mutableDeclaredSubstatements();
+        final Collection<? extends Mutable<?, ?, ?>> effective = original.mutableEffectiveSubstatements();
+        final Collection<Mutable<?, ?, ?>> buffer = new ArrayList<>(declared.size() + effective.size());
 
-        for (final StatementContextBase<?, ?, ?> stmtContext : declared) {
-            if (StmtContextUtils.areFeaturesSupported(stmtContext)) {
+        for (final Mutable<?, ?, ?> stmtContext : declared) {
+            if (stmtContext.isSupportedByFeatures()) {
                 buffer.add(stmtContext.createCopy(newQNameModule, this, typeOfCopy));
             }
         }
@@ -88,9 +110,6 @@ public class RootStatementContext<A, D extends DeclaredStatement<A>, E extends E
         return sourceContext;
     }
 
-    /**
-     * @return registry of source context
-     */
     @Override
     public Registry getBehaviourRegistry() {
         return sourceContext;
@@ -103,6 +122,7 @@ public class RootStatementContext<A, D extends DeclaredStatement<A>, E extends E
     /**
      * @return this as its own root
      */
+    @Nonnull
     @Override
     public RootStatementContext<?, ?, ?> getRoot() {
         return this;
@@ -123,7 +143,7 @@ public class RootStatementContext<A, D extends DeclaredStatement<A>, E extends E
      * @throws org.opendaylight.yangtools.yang.parser.spi.source.SourceException instance of SourceException
      */
     @Override
-    public StatementContextBase<?, ?, ?> createCopy(final StatementContextBase<?, ?, ?> newParent,
+    public StatementContextBase<A, D, E> createCopy(final StatementContextBase<?, ?, ?> newParent,
             final CopyType typeOfCopy) {
         return createCopy(null, newParent, typeOfCopy);
     }
@@ -149,6 +169,7 @@ public class RootStatementContext<A, D extends DeclaredStatement<A>, E extends E
         return copy;
     }
 
+    @Nonnull
     @Override
     public Optional<SchemaPath> getSchemaPath() {
         return Optional.of(SchemaPath.ROOT);
@@ -167,13 +188,18 @@ public class RootStatementContext<A, D extends DeclaredStatement<A>, E extends E
         return true;
     }
 
+    @Override
+    public boolean isInYangDataExtensionBody() {
+        return false;
+    }
+
     @Override
     public boolean isEnabledSemanticVersioning() {
         return sourceContext.isEnabledSemanticVersioning();
     }
 
     @Override
-    public <K, V, N extends IdentifierNamespace<K, V>> void addToLocalStorage(final Class<N> type, final K key,
+    public <K, V, N extends IdentifierNamespace<K, V>> V putToLocalStorage(final Class<N> type, final K key,
             final V value) {
         if (IncludedModuleContext.class.isAssignableFrom(type)) {
             if (includedContexts.isEmpty()) {
@@ -182,17 +208,33 @@ public class RootStatementContext<A, D extends DeclaredStatement<A>, E extends E
             Verify.verify(value instanceof RootStatementContext);
             includedContexts.add((RootStatementContext<?, ?, ?>) value);
         }
-        super.addToLocalStorage(type, key, value);
+        return super.putToLocalStorage(type, key, value);
     }
 
+    @Nullable
     @Override
     public <K, V, N extends IdentifierNamespace<K, V>> V getFromLocalStorage(final Class<N> type, final K key) {
+        return getFromLocalStorage(type, key, new HashSet<>());
+    }
+
+    /*
+     * We need to track already checked RootStatementContexts due to possible
+     * circular chains of includes between submodules
+     */
+    @Nullable
+    private <K, V, N extends IdentifierNamespace<K, V>> V getFromLocalStorage(final Class<N> type, final K key,
+            final HashSet<RootStatementContext<?, ?, ?>> alreadyChecked) {
         final V potentialLocal = super.getFromLocalStorage(type, key);
         if (potentialLocal != null) {
             return potentialLocal;
         }
-        for (final NamespaceStorageNode includedSource : includedContexts) {
-            final V potential = includedSource.getFromLocalStorage(type, key);
+
+        alreadyChecked.add(this);
+        for (final RootStatementContext<?, ?, ?> includedSource : includedContexts) {
+            if (alreadyChecked.contains(includedSource)) {
+                continue;
+            }
+            final V potential = includedSource.getFromLocalStorage(type, key, alreadyChecked);
             if (potential != null) {
                 return potential;
             }
@@ -203,16 +245,74 @@ public class RootStatementContext<A, D extends DeclaredStatement<A>, E extends E
     @Nullable
     @Override
     public <K, V, N extends IdentifierNamespace<K, V>> Map<K, V> getAllFromLocalStorage(final Class<N> type) {
+        return getAllFromLocalStorage(type, new HashSet<>());
+    }
+
+    /*
+     * We need to track already checked RootStatementContexts due to possible
+     * circular chains of includes between submodules
+     */
+    @Nullable
+    private <K, V, N extends IdentifierNamespace<K, V>> Map<K, V> getAllFromLocalStorage(final Class<N> type,
+            final HashSet<RootStatementContext<?, ?, ?>> alreadyChecked) {
         final Map<K, V> potentialLocal = super.getAllFromLocalStorage(type);
         if (potentialLocal != null) {
             return potentialLocal;
         }
-        for (final NamespaceStorageNode includedSource : includedContexts) {
-            final Map<K, V> potential = includedSource.getAllFromLocalStorage(type);
+
+        alreadyChecked.add(this);
+        for (final RootStatementContext<?, ?, ?> includedSource : includedContexts) {
+            if (alreadyChecked.contains(includedSource)) {
+                continue;
+            }
+            final Map<K, V> potential = includedSource.getAllFromLocalStorage(type, alreadyChecked);
             if (potential != null) {
                 return potential;
             }
         }
         return null;
     }
+
+    @Override
+    public YangVersion getRootVersion() {
+        return version == null ? DEFAULT_VERSION : version;
+    }
+
+    @Override
+    public void setRootVersion(final YangVersion version) {
+        Preconditions.checkArgument(sourceContext.getSupportedVersions().contains(version),
+                "Unsupported yang version %s in %s", version, getStatementSourceReference());
+        Preconditions.checkState(this.version == null, "Version of root %s has been already set to %s", argument,
+                this.version);
+        this.version = Preconditions.checkNotNull(version);
+    }
+
+    @Override
+    public void addMutableStmtToSeal(final MutableStatement mutableStatement) {
+        sourceContext.addMutableStmtToSeal(mutableStatement);
+    }
+
+    @Override
+    public void addRequiredModule(final ModuleIdentifier dependency) {
+        Preconditions.checkState(sourceContext.getInProgressPhase() == ModelProcessingPhase.SOURCE_PRE_LINKAGE,
+                "Add required module is allowed only in ModelProcessingPhase.SOURCE_PRE_LINKAGE phase");
+        if (requiredModules.isEmpty()) {
+            requiredModules = new HashSet<>();
+        }
+        requiredModules.add(dependency);
+    }
+
+    Collection<ModuleIdentifier> getRequiredModules() {
+        return ImmutableSet.copyOf(requiredModules);
+    }
+
+    @Override
+    public void setRootIdentifier(final ModuleIdentifier identifier) {
+        Preconditions.checkNotNull(identifier);
+        this.identifier = identifier;
+    }
+
+    ModuleIdentifier getRootIdentifier() {
+        return identifier;
+    }
 }