Bug 6867: Extend yang statement parser to support different yang versions
[yangtools.git] / yang / yang-parser-impl / src / main / java / org / opendaylight / yangtools / yang / parser / stmt / reactor / SourceSpecificContext.java
index 9c4416fc7db9bc4a5b05938b5d8a6ffbe2f14777..680b7f379cdef5d5b07c2060877edd14961eef18 100644 (file)
@@ -8,6 +8,7 @@
 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.ImmutableList;
 import com.google.common.collect.ImmutableMap;
@@ -18,21 +19,20 @@ 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.Rfc6020Mapping;
 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;
@@ -41,10 +41,12 @@ import org.opendaylight.yangtools.yang.parser.spi.meta.NamespaceBehaviour.Namesp
 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;
@@ -75,6 +77,32 @@ public class SourceSpecificContext implements NamespaceStorageNode, NamespaceBeh
         FINISHED
     }
 
+    @SuppressWarnings({"rawtypes", "unchecked"})
+    private final class RootContextBuilder extends ContextBuilder {
+        RootContextBuilder(final StatementDefinitionContext def, final StatementSourceReference sourceRef) {
+            super(def, sourceRef);
+        }
+
+        @Override
+        public StatementContextBase build() {
+            /*
+             * If root is null or root version is other than default,
+             * we need to create new root.
+             */
+            if (root == null) {
+                root = new RootStatementContext(this, SourceSpecificContext.this);
+            } else if (!RootStatementContext.DEFAULT_VERSION.equals(root.getRootVersion())
+                    && inProgressPhase == ModelProcessingPhase.SOURCE_LINKAGE) {
+                root = new RootStatementContext(this, SourceSpecificContext.this, root.getRootVersion());
+            } else {
+                Preconditions.checkState(root.getIdentifier().equals(createIdentifier()),
+                        "Root statement was already defined as %s.", root.getIdentifier());
+            }
+            root.resetLists();
+            return root;
+        }
+    }
+
     private static final Logger LOG = LoggerFactory.getLogger(SourceSpecificContext.class);
     private static final Map<String, StatementSupport<?, ?, ?>> BUILTIN_TYPE_SUPPORTS =
             ImmutableMap.<String, StatementSupport<?, ?, ?>>builder()
@@ -86,6 +114,7 @@ public class SourceSpecificContext implements NamespaceStorageNode, NamespaceBeh
             .put(TypeUtils.IDENTITY_REF, new IdentityRefSpecificationImpl.Definition())
             .put(TypeUtils.INSTANCE_IDENTIFIER, new InstanceIdentifierSpecificationImpl.Definition())
             .build();
+    private static final QName TYPE = Rfc6020Mapping.TYPE.getStatementName();
 
     private final Multimap<ModelProcessingPhase, ModifierImpl> modifiers = HashMultimap.create();
     private final QNameToStatementDefinitionMap qNameToStmtDefMap = new QNameToStatementDefinitionMap();
@@ -93,7 +122,12 @@ public class SourceSpecificContext implements NamespaceStorageNode, NamespaceBeh
     private final BuildGlobalContext currentContext;
     private final StatementStreamSource source;
 
-    private Collection<NamespaceStorageNode> importedNamespaces = ImmutableList.of();
+    /*
+     * "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;
@@ -103,7 +137,7 @@ public class SourceSpecificContext implements NamespaceStorageNode, NamespaceBeh
         this.source = Preconditions.checkNotNull(source);
     }
 
-    public boolean isEnabledSemanticVersioning(){
+    boolean isEnabledSemanticVersioning(){
         return currentContext.isEnabledSemanticVersioning();
     }
 
@@ -111,66 +145,70 @@ public class SourceSpecificContext implements NamespaceStorageNode, NamespaceBeh
         return inProgressPhase;
     }
 
-    StatementDefinitionContext<?, ?, ?> getDefinition(final QName name) {
-        return currentContext.getStatementDefinition(name);
-    }
+    ContextBuilder<?, ?, ?> createDeclaredChild(final StatementContextBase<?, ?, ?> current, final int childId,
+            QName name, final String argument, final StatementSourceReference ref) {
+        // 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());
+            }
+        }
 
-    ContextBuilder<?, ?, ?> createDeclaredChild(final StatementContextBase<?, ?, ?> current, final QName name,
-                                                final StatementSourceReference ref) {
-        StatementDefinitionContext<?, ?, ?> def = getDefinition(name);
+        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());
             }
         } 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)));
         }
 
         Preconditions.checkArgument(def != null, "Statement %s does not have type mapping defined.", name);
+        final ContextBuilder<?, ?, ?> ret;
         if (current == null) {
-            return createDeclaredRoot(def, ref);
+            ret = new RootContextBuilder(def, ref);
+        } else {
+            ret = current.substatementBuilder(childId, def, ref);
         }
-        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 (argument != null) {
+            ret.setArgument(argument, ref);
+        }
 
-        };
+        return ret;
     }
 
     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();
     }
@@ -190,12 +228,17 @@ public class SourceSpecificContext implements NamespaceStorageNode, NamespaceBeh
     @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)) {
+
+        if (BelongsToModuleContext.class.isAssignableFrom(type) || ImportedModuleContext.class.isAssignableFrom(type)) {
             if (importedNamespaces.isEmpty()) {
                 importedNamespaces = new ArrayList<>(1);
             }
-            importedNamespaces.add((NamespaceStorageNode) value);
+
+            Verify.verify(value instanceof RootStatementContext);
+            importedNamespaces.add((RootStatementContext<?, ?, ?>) value);
         }
+
+        // RootStatementContext takes care of IncludedModuleContext and the rest...
         getRoot().addToLocalStorage(type, key, value);
     }
 
@@ -210,6 +253,7 @@ public class SourceSpecificContext implements NamespaceStorageNode, NamespaceBeh
         if (potentialLocal != null) {
             return potentialLocal;
         }
+
         for (final NamespaceStorageNode importedSource : importedNamespaces) {
             final V potential = importedSource.getFromLocalStorage(type, key);
             if (potential != null) {
@@ -223,7 +267,6 @@ public class SourceSpecificContext implements NamespaceStorageNode, NamespaceBeh
     @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;
         }
@@ -269,7 +312,6 @@ public class SourceSpecificContext implements NamespaceStorageNode, NamespaceBeh
         return hasProgressed ? PhaseCompletionProgress.PROGRESS : PhaseCompletionProgress.NO_PROGRESS;
     }
 
-
     private static boolean tryToProgress(final Collection<ModifierImpl> currentPhaseModifiers) {
         boolean hasProgressed = false;
 
@@ -282,7 +324,6 @@ public class SourceSpecificContext implements NamespaceStorageNode, NamespaceBeh
         }
 
         return hasProgressed;
-
     }
 
     ModelActionBuilder newInferenceAction(final ModelProcessingPhase phase) {
@@ -314,10 +355,7 @@ public class SourceSpecificContext implements NamespaceStorageNode, NamespaceBeh
         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);
     }
@@ -355,10 +393,8 @@ public class SourceSpecificContext implements NamespaceStorageNode, NamespaceBeh
             //: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;
     }
 
@@ -371,38 +407,41 @@ public class SourceSpecificContext implements NamespaceStorageNode, NamespaceBeh
             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();
+    }
 }