*/
package org.opendaylight.yangtools.yang.parser.stmt.reactor;
-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 java.util.Optional;
+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.source.IncludedModuleContext;
+import org.opendaylight.yangtools.yang.parser.spi.source.StatementSourceReference;
/**
- * root statement class for a Yang source
+ * Root statement class for a YANG source. All statements defined in that YANG source are mapped underneath an instance
+ * of this class, hence recursive lookups from them cross this class.
*/
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;
- RootStatementContext(final ContextBuilder<A, D, E> builder, final SourceSpecificContext sourceContext) {
- super(builder);
- this.sourceContext = sourceContext;
- this.argument = builder.getDefinition().parseArgumentValue(this, builder.getRawArgument());
- }
-
- RootStatementContext(final RootStatementContext<A, D, E> original, final QNameModule newQNameModule,
- final TypeOfCopy typeOfCopy) {
- super(original);
-
- sourceContext = original.sourceContext;
- this.argument = original.argument;
-
- copyDeclaredStmts(original, newQNameModule, typeOfCopy);
-
- copyEffectiveStmts(original, newQNameModule, typeOfCopy);
-
- }
+ private YangVersion version;
+ private Collection<ModuleIdentifier> requiredModules = ImmutableSet.of();
+ private ModuleIdentifier identifier;
/**
- * copies declared statements from original to this' substatements
- *
- * @param typeOfCopy
- * determines whether copy is used by augmentation or uses
- * @throws org.opendaylight.yangtools.yang.parser.spi.source.SourceException
+ * References to RootStatementContext of submodules which are included in this source.
*/
- private void copyDeclaredStmts(final RootStatementContext<A, D, E> original, final QNameModule newQNameModule,
- final TypeOfCopy typeOfCopy) {
- Collection<? extends StmtContext<?, ?, ?>> originalDeclaredSubstatements = original.declaredSubstatements();
- for (StmtContext<?, ?, ?> stmtContext : originalDeclaredSubstatements) {
- this.addEffectiveSubstatement(stmtContext.createCopy(newQNameModule, this, typeOfCopy));
- }
+ private Collection<RootStatementContext<?, ?, ?>> includedContexts = ImmutableList.of();
+
+ 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 = def.parseArgumentValue(this, rawStatementArgument());
}
- /**
- * copies effective statements from original to this' substatements
- *
- * @param typeOfCopy
- * determines whether copy is used by augmentation or uses
- * @throws org.opendaylight.yangtools.yang.parser.spi.source.SourceException
- */
- private void copyEffectiveStmts(final RootStatementContext<A, D, E> original, final QNameModule newQNameModule,
- final TypeOfCopy typeOfCopy) {
- Collection<? extends StmtContext<?, ?, ?>> originalEffectiveSubstatements = original.effectiveSubstatements();
- for (StmtContext<?, ?, ?> stmtContext : originalEffectiveSubstatements) {
- this.addEffectiveSubstatement(stmtContext.createCopy(newQNameModule, this, typeOfCopy));
- }
+ 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);
}
/**
return sourceContext;
}
- /**
- * @return registry of source context
- */
@Override
public Registry getBehaviourRegistry() {
return sourceContext;
/**
* @return this as its own root
*/
+ @Nonnull
@Override
public RootStatementContext<?, ?, ?> getRoot() {
return this;
return argument;
}
- /**
- * @return copy of this considering {@link TypeOfCopy} (augment, uses)
- *
- * @throws org.opendaylight.yangtools.yang.parser.spi.source.SourceException instance of SourceException
- */
@Override
- public StatementContextBase<?, ?, ?> createCopy(final StatementContextBase<?, ?, ?> newParent,
- final TypeOfCopy typeOfCopy) {
- return createCopy(null, newParent, typeOfCopy);
+ public StatementContextBase<A, D, E> createCopy(final StatementContextBase<?, ?, ?> newParent,
+ final CopyType typeOfCopy) {
+ throw new UnsupportedOperationException("Root context cannot be copied");
}
- /**
- * @return copy of this considering {@link TypeOfCopy} (augment, uses)
- *
- * @throws org.opendaylight.yangtools.yang.parser.spi.source.SourceException instance of SourceException
- */
@Override
public StatementContextBase<A, D, E> createCopy(final QNameModule newQNameModule,
- final StatementContextBase<?, ?, ?> newParent, final TypeOfCopy typeOfCopy) {
- RootStatementContext<A, D, E> copy = new RootStatementContext<>(this, newQNameModule, typeOfCopy);
+ final StatementContextBase<?, ?, ?> newParent, final CopyType typeOfCopy) {
+ throw new UnsupportedOperationException("Root context cannot be copied");
+ }
+
+ @Nonnull
+ @Override
+ public Optional<SchemaPath> getSchemaPath() {
+ return Optional.of(SchemaPath.ROOT);
+ }
+
+ @Override
+ public boolean isConfiguration() {
+ return true;
+ }
+
+ @Override
+ public boolean isInYangDataExtensionBody() {
+ return false;
+ }
+
+ @Override
+ public boolean isEnabledSemanticVersioning() {
+ return sourceContext.isEnabledSemanticVersioning();
+ }
- copy.addAllToCopyHistory(this.getCopyHistory());
- copy.addToCopyHistory(typeOfCopy);
+ @Override
+ 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()) {
+ includedContexts = new ArrayList<>(1);
+ }
+ Verify.verify(value instanceof RootStatementContext);
+ includedContexts.add((RootStatementContext<?, ?, ?>) 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;
+ }
- if (this.getOriginalCtx() != null) {
- copy.setOriginalCtx(this.getOriginalCtx());
- } else {
- copy.setOriginalCtx(this);
+ 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;
+ }
}
- definition().onStatementAdded(copy);
- return copy;
+ return null;
}
+ @Nullable
@Override
- public Optional<SchemaPath> getSchemaPath() {
- return Optional.of(SchemaPath.ROOT);
+ public <K, V, N extends IdentifierNamespace<K, V>> Map<K, V> getAllFromLocalStorage(final Class<N> type) {
+ return getAllFromLocalStorage(type, new HashSet<>());
}
- /**
- * @return true
+ /*
+ * 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;
+ }
+
+ 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 boolean isRootContext() {
- return true;
+ public YangVersion getRootVersion() {
+ return version == null ? DEFAULT_VERSION : version;
}
@Override
- public boolean isConfiguration() {
- return true;
+ 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;
}
}
Code Review / yangtools.git / blobdiff