yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/stmt/reactor/SourceSpecificContext.java

   1 /*
   2  * Copyright (c) 2015 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.yangtools.yang.parser.stmt.reactor;
   9
  10 import com.google.common.base.Preconditions;
  11 import com.google.common.collect.HashMultimap;
  12 import com.google.common.collect.ImmutableMap;
  13 import com.google.common.collect.Multimap;
  14 import java.net.URI;
  15 import java.util.ArrayList;
  16 import java.util.Collection;
  17 import java.util.Iterator;
  18 import java.util.List;
  19 import java.util.Map;
  20 import java.util.Map.Entry;
  21 import java.util.Objects;
  22 import javax.annotation.Nullable;
  23 import org.opendaylight.yangtools.concepts.Mutable;
  24 import org.opendaylight.yangtools.yang.common.QName;
  25 import org.opendaylight.yangtools.yang.common.QNameModule;
  26 import org.opendaylight.yangtools.yang.model.api.ModuleIdentifier;
  27 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
  28 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  29 import org.opendaylight.yangtools.yang.model.api.meta.IdentifierNamespace;
  30 import org.opendaylight.yangtools.yang.model.api.meta.StatementDefinition;
  31 import org.opendaylight.yangtools.yang.model.api.stmt.ExtensionStatement;
  32 import org.opendaylight.yangtools.yang.parser.spi.ExtensionNamespace;
  33 import org.opendaylight.yangtools.yang.parser.spi.meta.ImportedNamespaceContext;
  34 import org.opendaylight.yangtools.yang.parser.spi.meta.InferenceException;
  35 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder;
  36 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase;
  37 import org.opendaylight.yangtools.yang.parser.spi.meta.NamespaceBehaviour;
  38 import org.opendaylight.yangtools.yang.parser.spi.meta.NamespaceBehaviour.NamespaceStorageNode;
  39 import org.opendaylight.yangtools.yang.parser.spi.meta.NamespaceBehaviour.StorageNodeType;
  40 import org.opendaylight.yangtools.yang.parser.spi.meta.QNameCacheNamespace;
  41 import org.opendaylight.yangtools.yang.parser.spi.meta.StatementSupport;
  42 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  43 import org.opendaylight.yangtools.yang.parser.spi.source.BelongsToPrefixToModuleIdentifier;
  44 import org.opendaylight.yangtools.yang.parser.spi.source.ImpPrefixToModuleIdentifier;
  45 import org.opendaylight.yangtools.yang.parser.spi.source.ImpPrefixToNamespace;
  46 import org.opendaylight.yangtools.yang.parser.spi.source.ModuleIdentifierToModuleQName;
  47 import org.opendaylight.yangtools.yang.parser.spi.source.PrefixToModule;
  48 import org.opendaylight.yangtools.yang.parser.spi.source.PrefixToModuleMap;
  49 import org.opendaylight.yangtools.yang.parser.spi.source.QNameToStatementDefinition;
  50 import org.opendaylight.yangtools.yang.parser.spi.source.QNameToStatementDefinitionMap;
  51 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
  52 import org.opendaylight.yangtools.yang.parser.spi.source.StatementSourceReference;
  53 import org.opendaylight.yangtools.yang.parser.spi.source.StatementStreamSource;
  54 import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.BitsSpecificationImpl;
  55 import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.Decimal64SpecificationImpl;
  56 import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.EnumSpecificationImpl;
  57 import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.IdentityRefSpecificationImpl;
  58 import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.InstanceIdentifierSpecificationImpl;
  59 import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.LeafrefSpecificationImpl;
  60 import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.TypeUtils;
  61 import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.UnionSpecificationImpl;
  62 import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.UnknownStatementImpl;
  63 import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.Utils;
  64
  65 public class SourceSpecificContext implements NamespaceStorageNode, NamespaceBehaviour.Registry, Mutable {
  66
  67     public enum PhaseCompletionProgress {
  68         NO_PROGRESS,
  69         PROGRESS,
  70         FINISHED
  71     }
  72
  73     private final StatementStreamSource source;
  74     private final BuildGlobalContext currentContext;
  75     private final Collection<NamespaceStorageNode> importedNamespaces = new ArrayList<>();
  76     private final Multimap<ModelProcessingPhase, ModifierImpl> modifiers = HashMultimap.create();
  77
  78     private RootStatementContext<?, ?, ?> root;
  79
  80     private ModelProcessingPhase inProgressPhase;
  81     private ModelProcessingPhase finishedPhase = ModelProcessingPhase.INIT;
  82     private final QNameToStatementDefinitionMap qNameToStmtDefMap = new QNameToStatementDefinitionMap();
  83     private final PrefixToModuleMap prefixToModuleMap = new PrefixToModuleMap();
  84
  85
  86     SourceSpecificContext(final BuildGlobalContext currentContext, final StatementStreamSource source) {
  87         this.source = source;
  88         this.currentContext = currentContext;
  89     }
  90
  91     ModelProcessingPhase getInProgressPhase() {
  92         return inProgressPhase;
  93     }
  94
  95     StatementDefinitionContext<?, ?, ?> getDefinition(final QName name) {
  96         return currentContext.getStatementDefinition(name);
  97     }
  98
  99     ContextBuilder<?, ?, ?> createDeclaredChild(final StatementContextBase<?, ?, ?> current, final QName name,
 100                                                 final StatementSourceReference ref) {
 101         StatementDefinitionContext<?, ?, ?> def = getDefinition(name);
 102
 103         if (def == null) {
 104             // unknown-stmts (from import, include or local-scope)
 105             if (qNameToStmtDefMap.get(name) != null) {
 106                 final StatementContextBase<?, ?, ?> extension =
 107                         (StatementContextBase<?, ?, ?>) currentContext.getAllFromNamespace(ExtensionNamespace.class).get(name);
 108
 109                 SourceException.throwIfNull(extension, current.getStatementSourceReference(), "Extension %s not found",
 110                     name);
 111
 112                 final QName arg = (QName) extension.getStatementArgument();
 113                 final QName qName = current.getFromNamespace(QNameCacheNamespace.class,
 114                     QName.create(arg, extension.getIdentifier().getArgument()));
 115
 116                 def = new StatementDefinitionContext<>(new UnknownStatementImpl.Definition(
 117                     getNewStatementDefinition(qName)));
 118             } else {
 119                 // type-body-stmts
 120                 def = resolveTypeBodyStmts(name.getLocalName());
 121             }
 122         } else if (current != null && current.definition().getRepresentingClass().equals(UnknownStatementImpl.class)) {
 123             QName qName = Utils.qNameFromArgument(current, name.getLocalName());
 124
 125             def = new StatementDefinitionContext<>(new UnknownStatementImpl.Definition(
 126                 getNewStatementDefinition(qName)));
 127         }
 128
 129         Preconditions.checkArgument(def != null, "Statement %s does not have type mapping defined.", name);
 130         if (current == null) {
 131             return createDeclaredRoot(def, ref);
 132         }
 133         return current.substatementBuilder(def, ref);
 134     }
 135
 136     // FIXME: This should be populated differently
 137     StatementDefinition getNewStatementDefinition(final QName qName) {
 138         return new ModelDefinedStatementDefinition(qName);
 139     }
 140
 141     @SuppressWarnings({"rawtypes", "unchecked"})
 142     private ContextBuilder<?, ?, ?> createDeclaredRoot(final StatementDefinitionContext<?, ?, ?> def,
 143                                                        final StatementSourceReference ref) {
 144         return new ContextBuilder(def, ref) {
 145
 146             @Override
 147             public StatementContextBase build() {
 148                 if (root == null) {
 149                     root = new RootStatementContext(this, SourceSpecificContext.this);
 150                 } else {
 151                     Preconditions.checkState(root.getIdentifier().equals(createIdentifier()),
 152                             "Root statement was already defined as %s.", root.getIdentifier());
 153                 }
 154                 root.resetLists();
 155                 return root;
 156             }
 157
 158         };
 159     }
 160
 161     RootStatementContext<?, ?, ?> getRoot() {
 162         return root;
 163     }
 164
 165     DeclaredStatement<?> buildDeclared() {
 166         return root.buildDeclared();
 167     }
 168
 169     EffectiveStatement<?, ?> buildEffective() {
 170         return root.buildEffective();
 171     }
 172
 173     void startPhase(final ModelProcessingPhase phase) {
 174         @Nullable
 175         ModelProcessingPhase previousPhase = phase.getPreviousPhase();
 176         Preconditions.checkState(Objects.equals(previousPhase, finishedPhase));
 177         Preconditions.checkState(modifiers.get(previousPhase).isEmpty());
 178         inProgressPhase = phase;
 179     }
 180
 181     @Override
 182     public <K, V, N extends IdentifierNamespace<K, V>> void addToLocalStorage(final Class<N> type, final K key,
 183            final V value) {
 184         if (ImportedNamespaceContext.class.isAssignableFrom(type)) {
 185             importedNamespaces.add((NamespaceStorageNode) value);
 186         }
 187         getRoot().addToLocalStorage(type, key, value);
 188     }
 189
 190     @Override
 191     public StorageNodeType getStorageNodeType() {
 192         return StorageNodeType.SOURCE_LOCAL_SPECIAL;
 193     }
 194
 195     @Override
 196     public <K, V, N extends IdentifierNamespace<K, V>> V getFromLocalStorage(final Class<N> type, final K key) {
 197         final V potentialLocal = getRoot().getFromLocalStorage(type, key);
 198         if (potentialLocal != null) {
 199             return potentialLocal;
 200         }
 201         for (NamespaceStorageNode importedSource : importedNamespaces) {
 202             V potential = importedSource.getFromLocalStorage(type, key);
 203             if (potential != null) {
 204                 return potential;
 205             }
 206         }
 207         return null;
 208     }
 209
 210     @Nullable
 211     @Override
 212     public <K, V, N extends IdentifierNamespace<K, V>> Map<K, V> getAllFromLocalStorage(final Class<N> type) {
 213         final Map<K, V> potentialLocal = getRoot().getAllFromLocalStorage(type);
 214
 215         if (potentialLocal != null) {
 216             return potentialLocal;
 217         }
 218
 219         for (final NamespaceStorageNode importedSource : importedNamespaces) {
 220             final Map<K, V> potential = importedSource.getAllFromLocalStorage(type);
 221
 222             if (potential != null) {
 223                 return potential;
 224             }
 225         }
 226         return null;
 227     }
 228
 229     @Override
 230     public <K, V, N extends IdentifierNamespace<K, V>> NamespaceBehaviour<K, V, N> getNamespaceBehaviour(
 231             final Class<N> type) {
 232         return currentContext.getNamespaceBehaviour(type);
 233     }
 234
 235     @Override
 236     public NamespaceStorageNode getParentNamespaceStorage() {
 237         return currentContext;
 238     }
 239
 240     PhaseCompletionProgress tryToCompletePhase(final ModelProcessingPhase phase) throws SourceException {
 241         Collection<ModifierImpl> currentPhaseModifiers = modifiers.get(phase);
 242
 243         boolean hasProgressed = tryToProgress(currentPhaseModifiers);
 244
 245         boolean phaseCompleted = root.tryToCompletePhase(phase);
 246
 247         hasProgressed = (tryToProgress(currentPhaseModifiers) | hasProgressed);
 248
 249         if (phaseCompleted && (currentPhaseModifiers.isEmpty())) {
 250             finishedPhase = phase;
 251             return PhaseCompletionProgress.FINISHED;
 252
 253         }
 254         if (hasProgressed) {
 255             return PhaseCompletionProgress.PROGRESS;
 256         }
 257         return PhaseCompletionProgress.NO_PROGRESS;
 258     }
 259
 260
 261     private static boolean tryToProgress(final Collection<ModifierImpl> currentPhaseModifiers) {
 262         boolean hasProgressed = false;
 263
 264         final Iterator<ModifierImpl> modifier = currentPhaseModifiers.iterator();
 265         while (modifier.hasNext()) {
 266             if (modifier.next().tryApply()) {
 267                 modifier.remove();
 268                 hasProgressed = true;
 269             }
 270         }
 271
 272         return hasProgressed;
 273
 274     }
 275
 276     ModelActionBuilder newInferenceAction(final ModelProcessingPhase phase) {
 277         ModifierImpl action = new ModifierImpl(phase);
 278         modifiers.put(phase, action);
 279         return action;
 280     }
 281
 282     @Override
 283     public String toString() {
 284         return "SourceSpecificContext [source=" + source + ", current=" + inProgressPhase + ", finished="
 285                 + finishedPhase + "]";
 286     }
 287
 288     SourceException failModifiers(final ModelProcessingPhase identifier) {
 289         final List<SourceException> exceptions = new ArrayList<>();
 290         for (ModifierImpl mod : modifiers.get(identifier)) {
 291             try {
 292                 mod.failModifier();
 293             } catch (SourceException e) {
 294                 exceptions.add(e);
 295             }
 296         }
 297
 298         final String message = String.format("Yang model processing phase %s failed", identifier);
 299         if (exceptions.isEmpty()) {
 300             return new InferenceException(message, root.getStatementSourceReference());
 301         }
 302
 303         final InferenceException e = new InferenceException(message, root.getStatementSourceReference(),
 304             exceptions.get(0));
 305         final Iterator<SourceException> it = exceptions.listIterator(1);
 306         while (it.hasNext()) {
 307             e.addSuppressed(it.next());
 308         }
 309
 310         return e;
 311     }
 312
 313     void loadStatements() throws SourceException {
 314         switch (inProgressPhase) {
 315             case SOURCE_PRE_LINKAGE:
 316                 source.writePreLinkage(new StatementContextWriter(this, inProgressPhase), stmtDef());
 317                 break;
 318             case SOURCE_LINKAGE:
 319                 source.writeLinkage(new StatementContextWriter(this, inProgressPhase), stmtDef(), preLinkagePrefixes());
 320                 break;
 321             case STATEMENT_DEFINITION:
 322                 source.writeLinkageAndStatementDefinitions(new StatementContextWriter(this, inProgressPhase), stmtDef(), prefixes());
 323                 break;
 324             case FULL_DECLARATION:
 325                 source.writeFull(new StatementContextWriter(this, inProgressPhase), stmtDef(), prefixes());
 326                 break;
 327             default:
 328                 break;
 329         }
 330     }
 331
 332     private static StatementDefinitionContext<?, ?, ?> resolveTypeBodyStmts(final String typeArgument) {
 333         switch (typeArgument) {
 334             case TypeUtils.DECIMAL64:
 335                 return new StatementDefinitionContext<>(new Decimal64SpecificationImpl.Definition());
 336             case TypeUtils.UNION:
 337                 return new StatementDefinitionContext<>(new UnionSpecificationImpl.Definition());
 338             case TypeUtils.ENUMERATION:
 339                 return new StatementDefinitionContext<>(new EnumSpecificationImpl.Definition());
 340             case TypeUtils.LEAF_REF:
 341                 return new StatementDefinitionContext<>(new LeafrefSpecificationImpl.Definition());
 342             case TypeUtils.BITS:
 343                 return new StatementDefinitionContext<>(new BitsSpecificationImpl.Definition());
 344             case TypeUtils.IDENTITY_REF:
 345                 return new StatementDefinitionContext<>(new IdentityRefSpecificationImpl.Definition());
 346             case TypeUtils.INSTANCE_IDENTIFIER:
 347                 return new StatementDefinitionContext<>(new InstanceIdentifierSpecificationImpl.Definition());
 348             default:
 349                 return null;
 350         }
 351     }
 352
 353     private PrefixToModule preLinkagePrefixes() {
 354         PrefixToModuleMap preLinkagePrefixes = new PrefixToModuleMap(true);
 355         Map<String, URI> prefixToNamespaceMap = getAllFromLocalStorage(ImpPrefixToNamespace.class);
 356         if(prefixToNamespaceMap == null) {
 357             //:FIXME if it is a submodule without any import, the map is null. Handle also submodules and includes...
 358             return null;
 359         }
 360         for (Entry<String, URI> prefixToNamespace : prefixToNamespaceMap.entrySet()) {
 361             preLinkagePrefixes.put(prefixToNamespace.getKey(), QNameModule.create(prefixToNamespace.getValue(), null));
 362         }
 363
 364         return preLinkagePrefixes;
 365     }
 366
 367     private PrefixToModule prefixes() {
 368         final Map<String, ModuleIdentifier> allPrefixes = getRoot().getAllFromNamespace(ImpPrefixToModuleIdentifier
 369                 .class);
 370         final Map<String, ModuleIdentifier> belongsToPrefixes = getRoot().getAllFromNamespace
 371                 (BelongsToPrefixToModuleIdentifier.class);
 372         if (belongsToPrefixes != null) {
 373             allPrefixes.putAll(belongsToPrefixes);
 374         }
 375
 376         for (Entry<String, ModuleIdentifier> stringModuleIdentifierEntry : allPrefixes.entrySet()) {
 377             final QNameModule namespace = getRoot().getFromNamespace(ModuleIdentifierToModuleQName.class,
 378                 stringModuleIdentifierEntry.getValue());
 379             prefixToModuleMap.put(stringModuleIdentifierEntry.getKey(), namespace);
 380         }
 381         return prefixToModuleMap;
 382     }
 383
 384     private QNameToStatementDefinition stmtDef() {
 385         // regular YANG statements added
 386         ImmutableMap<QName, StatementSupport<?, ?, ?>> definitions = currentContext.getSupportsForPhase(
 387                 inProgressPhase).getDefinitions();
 388         for (Entry<QName, StatementSupport<?, ?, ?>> entry : definitions.entrySet()) {
 389             qNameToStmtDefMap.put(entry.getKey(), entry.getValue());
 390         }
 391
 392         // extensions added
 393         if (inProgressPhase.equals(ModelProcessingPhase.FULL_DECLARATION)) {
 394             Map<QName, StmtContext<?, ExtensionStatement, EffectiveStatement<QName, ExtensionStatement>>> extensions =
 395                     currentContext.getAllFromNamespace(ExtensionNamespace.class);
 396             if (extensions != null) {
 397                 for (Entry<QName, StmtContext<?, ExtensionStatement, EffectiveStatement<QName, ExtensionStatement>>> extension :
 398                     extensions.entrySet()) {
 399                     qNameToStmtDefMap.put((extension.getKey()),
 400                         (StatementDefinition) ((StatementContextBase<?, ?, ?>) extension.getValue()).definition()
 401                         .getFactory());
 402                 }
 403             }
 404         }
 405         return qNameToStmtDefMap;
 406     }
 407 }