Bug 4662: Introduce a SemanticVersion concept - pre-linkage phase
[yangtools.git] / yang / yang-parser-impl / src / main / java / org / opendaylight / yangtools / yang / parser / stmt / reactor / SourceSpecificContext.java
index 9ddfae041944f0effe131f2783b5e1dae9a8ced3..ef26cda0730361e2122ec47e873a76136b5b7a85 100644 (file)
@@ -11,17 +11,19 @@ import com.google.common.base.Preconditions;
 import com.google.common.collect.HashMultimap;
 import com.google.common.collect.ImmutableMap;
 import com.google.common.collect.Multimap;
+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 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.model.api.ModuleIdentifier;
 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;
@@ -35,8 +37,13 @@ import org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase;
 import org.opendaylight.yangtools.yang.parser.spi.meta.NamespaceBehaviour;
 import org.opendaylight.yangtools.yang.parser.spi.meta.NamespaceBehaviour.NamespaceStorageNode;
 import org.opendaylight.yangtools.yang.parser.spi.meta.NamespaceBehaviour.StorageNodeType;
+import org.opendaylight.yangtools.yang.parser.spi.meta.QNameCacheNamespace;
 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.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.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.spi.source.QNameToStatementDefinition;
@@ -89,36 +96,34 @@ public class SourceSpecificContext implements NamespaceStorageNode, NamespaceBeh
         return currentContext.getStatementDefinition(name);
     }
 
-    ContextBuilder<?, ?, ?> createDeclaredChild(final StatementContextBase<?, ?, ?> current, final QName name, final StatementSourceReference ref) {
+    ContextBuilder<?, ?, ?> createDeclaredChild(final StatementContextBase<?, ?, ?> current, final QName name,
+                                                final StatementSourceReference ref) {
         StatementDefinitionContext<?, ?, ?> def = getDefinition(name);
 
         if (def == null) {
-            //unknown-stmts (from import, include or local-scope)
-            if (qNameToStmtDefMap.get(Utils.trimPrefix(name)) != null) {
-                QName key = Utils.qNameFromArgument(current, name.getLocalName());
-                if (key != null) {
-                    final StatementContextBase<?,?,?> extension = (StatementContextBase<?, ?, ?>) currentContext
-                            .getAllFromNamespace(ExtensionNamespace.class).get(key);
-                    if (extension != null) {
-                        final QName arg = (QName) ((SubstatementContext<?, ?, ?>) extension).getStatementArgument();
-                        final QName qName = QName.create(arg, extension.getIdentifier().getArgument());
-
-                        def = new StatementDefinitionContext<>(new UnknownStatementImpl.Definition
-                                (getNewStatementDefinition(qName)));
-                    } else {
-                        throw new IllegalArgumentException("Not found unknown statement: " + name);
-                    }
-                }
+            // unknown-stmts (from import, include or local-scope)
+            if (qNameToStmtDefMap.get(name) != null) {
+                final StatementContextBase<?, ?, ?> extension =
+                        (StatementContextBase<?, ?, ?>) currentContext.getAllFromNamespace(ExtensionNamespace.class).get(name);
+
+                SourceException.throwIfNull(extension, current.getStatementSourceReference(), "Extension %s not found",
+                    name);
+
+                final QName arg = (QName) extension.getStatementArgument();
+                final QName qName = current.getFromNamespace(QNameCacheNamespace.class,
+                    QName.create(arg, extension.getIdentifier().getArgument()));
+
+                def = new StatementDefinitionContext<>(new UnknownStatementImpl.Definition(
+                    getNewStatementDefinition(qName)));
             } else {
-                //type-body-stmts
+                // type-body-stmts
                 def = resolveTypeBodyStmts(name.getLocalName());
             }
-        }
-        else if (current != null && current.definition().getRepresentingClass().equals(UnknownStatementImpl.class)) {
+        } else if (current != null && current.definition().getRepresentingClass().equals(UnknownStatementImpl.class)) {
             QName qName = Utils.qNameFromArgument(current, name.getLocalName());
 
-            def = new StatementDefinitionContext<>(new UnknownStatementImpl.Definition
-                    (getNewStatementDefinition(qName)));
+            def = new StatementDefinitionContext<>(new UnknownStatementImpl.Definition(
+                getNewStatementDefinition(qName)));
         }
 
         Preconditions.checkArgument(def != null, "Statement %s does not have type mapping defined.", name);
@@ -134,15 +139,17 @@ public class SourceSpecificContext implements NamespaceStorageNode, NamespaceBeh
     }
 
     @SuppressWarnings({"rawtypes", "unchecked"})
-    private ContextBuilder<?, ?, ?> createDeclaredRoot(final StatementDefinitionContext<?, ?, ?> def, final StatementSourceReference ref) {
+    private ContextBuilder<?, ?, ?> createDeclaredRoot(final StatementDefinitionContext<?, ?, ?> def,
+                                                       final StatementSourceReference ref) {
         return new ContextBuilder(def, ref) {
 
             @Override
-            public StatementContextBase build() throws SourceException {
+            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());
+                    Preconditions.checkState(root.getIdentifier().equals(createIdentifier()),
+                            "Root statement was already defined as %s.", root.getIdentifier());
                 }
                 root.resetLists();
                 return root;
@@ -164,14 +171,16 @@ public class SourceSpecificContext implements NamespaceStorageNode, NamespaceBeh
     }
 
     void startPhase(final ModelProcessingPhase phase) {
-        @Nullable ModelProcessingPhase previousPhase = phase.getPreviousPhase();
+        @Nullable
+        ModelProcessingPhase previousPhase = phase.getPreviousPhase();
         Preconditions.checkState(Objects.equals(previousPhase, finishedPhase));
         Preconditions.checkState(modifiers.get(previousPhase).isEmpty());
         inProgressPhase = phase;
     }
 
     @Override
-    public <K, V, N extends IdentifierNamespace<K, V>> void addToLocalStorage(final Class<N> type, final K key, final V value) {
+    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);
         }
@@ -218,7 +227,8 @@ public class SourceSpecificContext implements NamespaceStorageNode, NamespaceBeh
     }
 
     @Override
-    public <K, V, N extends IdentifierNamespace<K, V>> NamespaceBehaviour<K, V, N> getNamespaceBehaviour(final Class<N> type) {
+    public <K, V, N extends IdentifierNamespace<K, V>> NamespaceBehaviour<K, V, N> getNamespaceBehaviour(
+            final Class<N> type) {
         return currentContext.getNamespaceBehaviour(type);
     }
 
@@ -249,9 +259,9 @@ public class SourceSpecificContext implements NamespaceStorageNode, NamespaceBeh
 
 
     private static boolean tryToProgress(final Collection<ModifierImpl> currentPhaseModifiers) {
-
-        Iterator<ModifierImpl> modifier = currentPhaseModifiers.iterator();
         boolean hasProgressed = false;
+
+        final Iterator<ModifierImpl> modifier = currentPhaseModifiers.iterator();
         while (modifier.hasNext()) {
             if (modifier.next().tryApply()) {
                 modifier.remove();
@@ -302,8 +312,11 @@ public class SourceSpecificContext implements NamespaceStorageNode, NamespaceBeh
 
     void loadStatements() throws SourceException {
         switch (inProgressPhase) {
+            case SOURCE_PRE_LINKAGE:
+                source.writePreLinkage(new StatementContextWriter(this, inProgressPhase), stmtDef());
+                break;
             case SOURCE_LINKAGE:
-                source.writeLinkage(new StatementContextWriter(this, inProgressPhase), stmtDef());
+                source.writeLinkage(new StatementContextWriter(this, inProgressPhase), stmtDef(), preLinkagePrefixes());
                 break;
             case STATEMENT_DEFINITION:
                 source.writeLinkageAndStatementDefinitions(new StatementContextWriter(this, inProgressPhase), stmtDef(), prefixes());
@@ -337,36 +350,55 @@ public class SourceSpecificContext implements NamespaceStorageNode, NamespaceBeh
         }
     }
 
+    private PrefixToModule preLinkagePrefixes() {
+        PrefixToModuleMap preLinkagePrefixes = new PrefixToModuleMap(true);
+        Map<String, URI> prefixToNamespaceMap = getAllFromLocalStorage(ImpPrefixToNamespace.class);
+        if(prefixToNamespaceMap == null) {
+            //:FIXME if it is a submodule without any import, the map is null. Handle also submodules and includes...
+            return null;
+        }
+        for (Entry<String, URI> prefixToNamespace : prefixToNamespaceMap.entrySet()) {
+            preLinkagePrefixes.put(prefixToNamespace.getKey(), QNameModule.create(prefixToNamespace.getValue(), null));
+        }
+
+        return preLinkagePrefixes;
+    }
 
     private PrefixToModule prefixes() {
-        Map<String, QNameModule> prefixes = currentContext.getAllFromNamespace(PrefixToModule.class);
-        for (Map.Entry<String, QNameModule> prefix : prefixes.entrySet()) {
-            prefixToModuleMap.put(prefix.getKey(), prefix.getValue());
+        final Map<String, ModuleIdentifier> allPrefixes = getRoot().getAllFromNamespace(ImpPrefixToModuleIdentifier
+                .class);
+        final Map<String, ModuleIdentifier> belongsToPrefixes = getRoot().getAllFromNamespace
+                (BelongsToPrefixToModuleIdentifier.class);
+        if (belongsToPrefixes != null) {
+            allPrefixes.putAll(belongsToPrefixes);
+        }
+
+        for (Entry<String, ModuleIdentifier> stringModuleIdentifierEntry : allPrefixes.entrySet()) {
+            final QNameModule namespace = getRoot().getFromNamespace(ModuleIdentifierToModuleQName.class,
+                stringModuleIdentifierEntry.getValue());
+            prefixToModuleMap.put(stringModuleIdentifierEntry.getKey(), namespace);
         }
         return prefixToModuleMap;
     }
 
     private QNameToStatementDefinition stmtDef() {
-        //regular YANG statements added
+        // regular YANG statements added
         ImmutableMap<QName, StatementSupport<?, ?, ?>> definitions = currentContext.getSupportsForPhase(
                 inProgressPhase).getDefinitions();
-        for (Map.Entry<QName, StatementSupport<?, ?, ?>> entry : definitions.entrySet()) {
+        for (Entry<QName, StatementSupport<?, ?, ?>> entry : definitions.entrySet()) {
             qNameToStmtDefMap.put(entry.getKey(), entry.getValue());
         }
 
-        //extensions added
+        // extensions added
         if (inProgressPhase.equals(ModelProcessingPhase.FULL_DECLARATION)) {
-            Map<QName, StmtContext<?, ExtensionStatement, EffectiveStatement<QName, ExtensionStatement>>> extensions = currentContext
-                    .getAllFromNamespace(ExtensionNamespace.class);
+            Map<QName, StmtContext<?, ExtensionStatement, EffectiveStatement<QName, ExtensionStatement>>> extensions =
+                    currentContext.getAllFromNamespace(ExtensionNamespace.class);
             if (extensions != null) {
-                for (Map.Entry<QName, StmtContext<?, ExtensionStatement, EffectiveStatement<QName, ExtensionStatement>>> extension : extensions
-                        .entrySet()) {
-                    qNameToStmtDefMap
-                            .put(QName.create(YangConstants.RFC6020_YIN_MODULE,
-                                    extension.getKey().getLocalName()),
-                                    (StatementDefinition) ((StatementContextBase<?, ?, ?>) extension
-                                            .getValue()).definition()
-                                            .getFactory());
+                for (Entry<QName, StmtContext<?, ExtensionStatement, EffectiveStatement<QName, ExtensionStatement>>> extension :
+                    extensions.entrySet()) {
+                    qNameToStmtDefMap.put((extension.getKey()),
+                        (StatementDefinition) ((StatementContextBase<?, ?, ?>) extension.getValue()).definition()
+                        .getFactory());
                 }
             }
         }