package org.opendaylight.yangtools.yang.parser.stmt.reactor;
import com.google.common.base.Preconditions;
+import com.google.common.base.Verify;
import com.google.common.collect.HashMultimap;
-import com.google.common.collect.ImmutableMap;
+import com.google.common.collect.ImmutableList;
+import com.google.common.collect.ImmutableTable;
import com.google.common.collect.Multimap;
+import com.google.common.collect.Table;
import java.net.URI;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
-import java.util.Map.Entry;
import java.util.Objects;
import java.util.Optional;
+import java.util.Set;
import javax.annotation.Nullable;
import org.opendaylight.yangtools.concepts.Mutable;
import org.opendaylight.yangtools.yang.common.QName;
import org.opendaylight.yangtools.yang.common.QNameModule;
+import org.opendaylight.yangtools.yang.common.YangConstants;
+import org.opendaylight.yangtools.yang.common.YangVersion;
import org.opendaylight.yangtools.yang.model.api.ModuleIdentifier;
+import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
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.model.api.meta.StatementDefinition;
-import org.opendaylight.yangtools.yang.model.api.stmt.ExtensionStatement;
-import org.opendaylight.yangtools.yang.parser.spi.ExtensionNamespace;
-import org.opendaylight.yangtools.yang.parser.spi.meta.ImportedNamespaceContext;
import org.opendaylight.yangtools.yang.parser.spi.meta.InferenceException;
import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder;
import org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase;
import org.opendaylight.yangtools.yang.parser.spi.meta.NamespaceBehaviour.StorageNodeType;
import org.opendaylight.yangtools.yang.parser.spi.meta.StatementDefinitionNamespace;
import org.opendaylight.yangtools.yang.parser.spi.meta.StatementSupport;
-import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
+import org.opendaylight.yangtools.yang.parser.spi.meta.StatementSupportBundle;
+import org.opendaylight.yangtools.yang.parser.spi.source.BelongsToModuleContext;
import org.opendaylight.yangtools.yang.parser.spi.source.BelongsToPrefixToModuleIdentifier;
import org.opendaylight.yangtools.yang.parser.spi.source.ImpPrefixToModuleIdentifier;
import org.opendaylight.yangtools.yang.parser.spi.source.ImpPrefixToNamespace;
+import org.opendaylight.yangtools.yang.parser.spi.source.ImportedModuleContext;
import org.opendaylight.yangtools.yang.parser.spi.source.ModuleIdentifierToModuleQName;
import org.opendaylight.yangtools.yang.parser.spi.source.PrefixToModule;
import org.opendaylight.yangtools.yang.parser.spi.source.PrefixToModuleMap;
import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.UnionSpecificationImpl;
import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.UnknownStatementImpl;
import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.Utils;
+import org.opendaylight.yangtools.yang.parser.stmt.rfc7950.LeafrefSpecificationRfc7950Support;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
}
private static final Logger LOG = LoggerFactory.getLogger(SourceSpecificContext.class);
+ private static final Table<YangVersion, String, StatementSupport<?, ?, ?>> BUILTIN_TYPE_SUPPORTS =
+ ImmutableTable.<YangVersion, String, StatementSupport<?, ?, ?>>builder()
+ .put(YangVersion.VERSION_1, TypeUtils.DECIMAL64, new Decimal64SpecificationImpl.Definition())
+ .put(YangVersion.VERSION_1, TypeUtils.UNION, new UnionSpecificationImpl.Definition())
+ .put(YangVersion.VERSION_1, TypeUtils.ENUMERATION, new EnumSpecificationImpl.Definition())
+ .put(YangVersion.VERSION_1, TypeUtils.LEAF_REF, new LeafrefSpecificationImpl.Definition())
+ .put(YangVersion.VERSION_1_1, TypeUtils.LEAF_REF, new LeafrefSpecificationRfc7950Support())
+ .put(YangVersion.VERSION_1, TypeUtils.BITS, new BitsSpecificationImpl.Definition())
+ .put(YangVersion.VERSION_1, TypeUtils.IDENTITY_REF, new IdentityRefSpecificationImpl.Definition())
+ .put(YangVersion.VERSION_1, TypeUtils.INSTANCE_IDENTIFIER, new InstanceIdentifierSpecificationImpl.Definition())
+ .build();
+
+ private static final QName TYPE = YangStmtMapping.TYPE.getStatementName();
- private final StatementStreamSource source;
- private final BuildGlobalContext currentContext;
- private final Collection<NamespaceStorageNode> importedNamespaces = new ArrayList<>();
private final Multimap<ModelProcessingPhase, ModifierImpl> modifiers = HashMultimap.create();
-
-
private final QNameToStatementDefinitionMap qNameToStmtDefMap = new QNameToStatementDefinitionMap();
private final PrefixToModuleMap prefixToModuleMap = new PrefixToModuleMap();
+ private final BuildGlobalContext currentContext;
+ private final StatementStreamSource source;
+ /*
+ * "imported" namespaces in this source -- this points to RootStatementContexts of
+ * - modules imported via 'import' statement
+ * - parent module, declared via 'belongs-to' statement
+ */
+ private Collection<RootStatementContext<?, ?, ?>> importedNamespaces = ImmutableList.of();
private ModelProcessingPhase finishedPhase = ModelProcessingPhase.INIT;
private ModelProcessingPhase inProgressPhase;
private RootStatementContext<?, ?, ?> root;
SourceSpecificContext(final BuildGlobalContext currentContext, final StatementStreamSource source) {
- this.currentContext = currentContext;
- this.source = source;
+ this.currentContext = Preconditions.checkNotNull(currentContext);
+ this.source = Preconditions.checkNotNull(source);
}
- public boolean isEnabledSemanticVersioning(){
+ boolean isEnabledSemanticVersioning(){
return currentContext.isEnabledSemanticVersioning();
}
return inProgressPhase;
}
- StatementDefinitionContext<?, ?, ?> getDefinition(final QName name) {
- return currentContext.getStatementDefinition(name);
- }
+ StatementContextBase<?, ?, ?> createDeclaredChild(final StatementContextBase<?, ?, ?> current, final int childId,
+ QName name, final String argument, final StatementSourceReference ref) {
+ if (current != null) {
+ // Fast path: we are entering a statement which was emitted in previous phase
+ final StatementContextBase<?, ?, ?> existing = current.lookupSubstatement(childId);
+ if (existing != null) {
+ return existing;
+ }
+ }
- ContextBuilder<?, ?, ?> createDeclaredChild(final StatementContextBase<?, ?, ?> current, final QName name,
- final StatementSourceReference ref) {
- StatementDefinitionContext<?, ?, ?> def = getDefinition(name);
+ // FIXME: BUG-7038: Refactor/clean up this special case
+ if (TYPE.equals(name)) {
+ SourceException.throwIfNull(argument, ref, "Type statement requires an argument");
+ if (TypeUtils.isYangTypeBodyStmtString(argument)) {
+ name = QName.create(YangConstants.RFC6020_YIN_MODULE, argument);
+ } else {
+ name = QName.create(YangConstants.RFC6020_YIN_MODULE, TYPE.getLocalName());
+ }
+ }
+ StatementDefinitionContext<?, ?, ?> def = currentContext.getStatementDefinition(getRootVersion(), name);
if (def == null) {
- // unknown-stmts (from import, include or local-scope)
- if (qNameToStmtDefMap.get(name) != null) {
- final StatementDefinition extension = currentContext.getFromNamespace(
- StatementDefinitionNamespace.class, name);
- SourceException.throwIfNull(extension, current.getStatementSourceReference(), "Extension %s not found",
- name);
-
- def = new StatementDefinitionContext<>(new UnknownStatementImpl.Definition(extension));
+ final StatementSupport<?, ?, ?> extension = qNameToStmtDefMap.get(name);
+ if (extension != null) {
+ def = new StatementDefinitionContext<>(extension);
} else {
// type-body-stmts
- def = resolveTypeBodyStmts(name.getLocalName());
+ def = resolveTypeBodyStmts(name.getLocalName(), getRootVersion());
}
} else if (current != null && current.definition().getRepresentingClass().equals(UnknownStatementImpl.class)) {
- // FIXME: What's going on here?
+ /*
+ * This code wraps statements encountered inside an extension so they do not get confused with regular
+ * statements.
+ *
+ * FIXME: BUG-7037: re-evaluate whether this is really needed, as this is a very expensive way of making
+ * this work. We really should be peeking into the extension definition to find these nodes,
+ * as otherwise we are not reusing definitions nor support for these nodes.
+ */
final QName qName = Utils.qNameFromArgument(current, name.getLocalName());
-
def = new StatementDefinitionContext<>(new UnknownStatementImpl.Definition(
- new ModelDefinedStatementDefinition(qName)));
+ new ModelDefinedStatementDefinition(qName, argument != null)));
}
- Preconditions.checkArgument(def != null, "Statement %s does not have type mapping defined.", name);
- if (current == null) {
- return createDeclaredRoot(def, ref);
+ InferenceException.throwIfNull(def, ref, "Statement %s does not have type mapping defined.", name);
+ if (def.hasArgument()) {
+ SourceException.throwIfNull(argument, ref, "Statement %s requires an argument", name);
+ } else {
+ SourceException.throwIf(argument != null, ref, "Statement %s does not take argument", name);
}
- return current.substatementBuilder(def, ref);
- }
-
- @SuppressWarnings({"rawtypes", "unchecked"})
- private ContextBuilder<?, ?, ?> createDeclaredRoot(final StatementDefinitionContext<?, ?, ?> def,
- final StatementSourceReference ref) {
- return new ContextBuilder(def, ref) {
- @Override
- public StatementContextBase build() {
- if (root == null) {
- root = new RootStatementContext(this, SourceSpecificContext.this);
- } else {
- Preconditions.checkState(root.getIdentifier().equals(createIdentifier()),
- "Root statement was already defined as %s.", root.getIdentifier());
- }
- root.resetLists();
- return root;
- }
+ if (current != null) {
+ return current.createSubstatement(childId, def, ref, argument);
+ }
- };
+ /*
+ * If root is null or root version is other than default,
+ * we need to create new root.
+ */
+ if (root == null) {
+ root = new RootStatementContext<>(this, def, ref, argument);
+ } else if (!RootStatementContext.DEFAULT_VERSION.equals(root.getRootVersion())
+ && inProgressPhase == ModelProcessingPhase.SOURCE_LINKAGE) {
+ root = new RootStatementContext<>(this, def, ref, argument, root.getRootVersion());
+ } else {
+ final QName rootStatement = root.definition().getStatementName();
+ final String rootArgument = root.rawStatementArgument();
+
+ Preconditions.checkState(Objects.equals(def.getStatementName(), rootStatement)
+ && Objects.equals(argument, rootArgument),
+ "Root statement was already defined as '%s %s'.", rootStatement, rootArgument);
+ }
+ return root;
}
RootStatementContext<?, ?, ?> getRoot() {
return root;
}
+ /**
+ * Return version of root statement context.
+ *
+ * @return version of root statement context
+ */
+ YangVersion getRootVersion() {
+ return root != null ? root.getRootVersion() : RootStatementContext.DEFAULT_VERSION;
+ }
+
DeclaredStatement<?> buildDeclared() {
return root.buildDeclared();
}
void startPhase(final ModelProcessingPhase phase) {
@Nullable final ModelProcessingPhase previousPhase = phase.getPreviousPhase();
- Preconditions.checkState(Objects.equals(previousPhase, finishedPhase));
- Preconditions.checkState(modifiers.get(previousPhase).isEmpty());
+ Verify.verify(Objects.equals(previousPhase, finishedPhase),
+ "Phase sequencing violation: previous phase should be %s, source %s has %s", previousPhase, source,
+ finishedPhase);
+
+ final Collection<ModifierImpl> previousModifiers = modifiers.get(previousPhase);
+ Preconditions.checkState(previousModifiers.isEmpty(),
+ "Previous phase %s has unresolved modifiers %s in source %s",
+ previousPhase, previousModifiers, source);
+
inProgressPhase = phase;
LOG.debug("Source {} started phase {}", source, phase);
}
@Override
public <K, V, N extends IdentifierNamespace<K, V>> void addToLocalStorage(final Class<N> type, final K key,
final V value) {
- if (ImportedNamespaceContext.class.isAssignableFrom(type)) {
- importedNamespaces.add((NamespaceStorageNode) value);
+
+ if (BelongsToModuleContext.class.isAssignableFrom(type) || ImportedModuleContext.class.isAssignableFrom(type)) {
+ if (importedNamespaces.isEmpty()) {
+ importedNamespaces = new ArrayList<>(1);
+ }
+
+ Verify.verify(value instanceof RootStatementContext);
+ importedNamespaces.add((RootStatementContext<?, ?, ?>) value);
}
+
+ // RootStatementContext takes care of IncludedModuleContext and the rest...
getRoot().addToLocalStorage(type, key, value);
}
if (potentialLocal != null) {
return potentialLocal;
}
+
for (final NamespaceStorageNode importedSource : importedNamespaces) {
final V potential = importedSource.getFromLocalStorage(type, key);
if (potential != null) {
@Override
public <K, V, N extends IdentifierNamespace<K, V>> Map<K, V> getAllFromLocalStorage(final Class<N> type) {
final Map<K, V> potentialLocal = getRoot().getAllFromLocalStorage(type);
-
if (potentialLocal != null) {
return potentialLocal;
}
return hasProgressed ? PhaseCompletionProgress.PROGRESS : PhaseCompletionProgress.NO_PROGRESS;
}
-
private static boolean tryToProgress(final Collection<ModifierImpl> currentPhaseModifiers) {
boolean hasProgressed = false;
}
return hasProgressed;
-
}
ModelActionBuilder newInferenceAction(final ModelProcessingPhase phase) {
final String message = String.format("Yang model processing phase %s failed", identifier);
final InferenceException e = new InferenceException(message, root.getStatementSourceReference(),
exceptions.get(0));
- final Iterator<SourceException> it = exceptions.listIterator(1);
- while (it.hasNext()) {
- e.addSuppressed(it.next());
- }
+ exceptions.listIterator(1).forEachRemaining(e::addSuppressed);
return Optional.of(e);
}
}
}
- private static StatementDefinitionContext<?, ?, ?> resolveTypeBodyStmts(final String typeArgument) {
- switch (typeArgument) {
- case TypeUtils.DECIMAL64:
- return new StatementDefinitionContext<>(new Decimal64SpecificationImpl.Definition());
- case TypeUtils.UNION:
- return new StatementDefinitionContext<>(new UnionSpecificationImpl.Definition());
- case TypeUtils.ENUMERATION:
- return new StatementDefinitionContext<>(new EnumSpecificationImpl.Definition());
- case TypeUtils.LEAF_REF:
- return new StatementDefinitionContext<>(new LeafrefSpecificationImpl.Definition());
- case TypeUtils.BITS:
- return new StatementDefinitionContext<>(new BitsSpecificationImpl.Definition());
- case TypeUtils.IDENTITY_REF:
- return new StatementDefinitionContext<>(new IdentityRefSpecificationImpl.Definition());
- case TypeUtils.INSTANCE_IDENTIFIER:
- return new StatementDefinitionContext<>(new InstanceIdentifierSpecificationImpl.Definition());
- default:
- return null;
+ private static StatementDefinitionContext<?, ?, ?> resolveTypeBodyStmts(final String typeArgument,
+ final YangVersion version) {
+ StatementSupport<?, ?, ?> support = BUILTIN_TYPE_SUPPORTS.get(version, typeArgument);
+
+ if (support == null) {
+ support = BUILTIN_TYPE_SUPPORTS.get(YangVersion.VERSION_1, typeArgument);
}
+
+ return support == null ? null : new StatementDefinitionContext<>(support);
}
private PrefixToModule preLinkagePrefixes() {
//:FIXME if it is a submodule without any import, the map is null. Handle also submodules and includes...
return null;
}
- for (final Entry<String, URI> prefixToNamespace : prefixToNamespaceMap.entrySet()) {
- preLinkagePrefixes.put(prefixToNamespace.getKey(), QNameModule.create(prefixToNamespace.getValue(), null));
- }
+ prefixToNamespaceMap.forEach((key, value) -> preLinkagePrefixes.put(key, QNameModule.create(value, null)));
return preLinkagePrefixes;
}
allPrefixes.putAll(belongsToPrefixes);
}
- for (final Entry<String, ModuleIdentifier> stringModuleIdentifierEntry : allPrefixes.entrySet()) {
- final QNameModule namespace = getRoot().getFromNamespace(ModuleIdentifierToModuleQName.class,
- stringModuleIdentifierEntry.getValue());
- prefixToModuleMap.put(stringModuleIdentifierEntry.getKey(), namespace);
- }
+ allPrefixes.forEach((key, value) ->
+ prefixToModuleMap.put(key, getRoot().getFromNamespace(ModuleIdentifierToModuleQName.class, value)));
+
return prefixToModuleMap;
}
private QNameToStatementDefinition stmtDef() {
// regular YANG statements and extension supports added
- final ImmutableMap<QName, StatementSupport<?, ?, ?>> definitions = currentContext.getSupportsForPhase(
- inProgressPhase).getDefinitions();
- for (final Entry<QName, StatementSupport<?, ?, ?>> entry : definitions.entrySet()) {
- qNameToStmtDefMap.put(entry.getKey(), entry.getValue());
+ final StatementSupportBundle supportsForPhase = currentContext.getSupportsForPhase(inProgressPhase);
+ qNameToStmtDefMap.putAll(supportsForPhase.getCommonDefinitions());
+ qNameToStmtDefMap.putAll(supportsForPhase.getDefinitionsSpecificForVersion(getRootVersion()));
+
+ // No further actions needed
+ if (inProgressPhase != ModelProcessingPhase.FULL_DECLARATION) {
+ return qNameToStmtDefMap;
}
- // extensions added
- if (inProgressPhase.equals(ModelProcessingPhase.FULL_DECLARATION)) {
- final Map<QName, StmtContext<?, ExtensionStatement, EffectiveStatement<QName, ExtensionStatement>>> extensions =
- currentContext.getAllFromNamespace(ExtensionNamespace.class);
- if (extensions != null) {
- for (final Entry<QName, StmtContext<?, ExtensionStatement, EffectiveStatement<QName, ExtensionStatement>>> extension :
- extensions.entrySet()) {
- if(qNameToStmtDefMap.get(extension.getKey()) == null) {
- qNameToStmtDefMap.put((extension.getKey()),
- (StatementDefinition) ((StatementContextBase<?, ?, ?>) extension.getValue()).definition()
- .getFactory());
- }
+ // We need to any and all extension statements which have been declared in the context
+ final Map<QName, StatementSupport<?, ?, ?>> extensions = currentContext.getAllFromNamespace(
+ StatementDefinitionNamespace.class);
+ if (extensions != null) {
+ extensions.forEach((qname, support) -> {
+ final StatementSupport<?, ?, ?> existing = qNameToStmtDefMap.putIfAbsent(qname, support);
+ if (existing != null) {
+ LOG.debug("Source {} already defines statement {} as {}", source, qname, existing);
+ } else {
+ LOG.debug("Source {} defined statement {} as {}", source, qname, support);
}
- }
+ });
}
return qNameToStmtDefMap;
}
+
+ public Set<YangVersion> getSupportedVersions() {
+ return currentContext.getSupportedVersions();
+ }
}
Code Review / yangtools.git / blobdiff