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.util.ArrayList;
  15 import java.util.Collection;
  16 import java.util.Iterator;
  17 import java.util.List;
  18 import java.util.Map;
  19 import java.util.Map.Entry;
  20 import java.util.Objects;
  21 import javax.annotation.Nullable;
  22 import org.opendaylight.yangtools.concepts.Mutable;
  23 import org.opendaylight.yangtools.yang.common.QName;
  24 import org.opendaylight.yangtools.yang.common.QNameModule;
  25 import org.opendaylight.yangtools.yang.model.api.ModuleIdentifier;
  26 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
  27 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  28 import org.opendaylight.yangtools.yang.model.api.meta.IdentifierNamespace;
  29 import org.opendaylight.yangtools.yang.model.api.meta.StatementDefinition;
  30 import org.opendaylight.yangtools.yang.model.api.stmt.ExtensionStatement;
  31 import org.opendaylight.yangtools.yang.parser.spi.ExtensionNamespace;
  32 import org.opendaylight.yangtools.yang.parser.spi.meta.ImportedNamespaceContext;
  33 import org.opendaylight.yangtools.yang.parser.spi.meta.InferenceException;
  34 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder;
  35 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase;
  36 import org.opendaylight.yangtools.yang.parser.spi.meta.NamespaceBehaviour;
  37 import org.opendaylight.yangtools.yang.parser.spi.meta.NamespaceBehaviour.NamespaceStorageNode;
  38 import org.opendaylight.yangtools.yang.parser.spi.meta.NamespaceBehaviour.StorageNodeType;
  39 import org.opendaylight.yangtools.yang.parser.spi.meta.QNameCacheNamespace;
  40 import org.opendaylight.yangtools.yang.parser.spi.meta.StatementSupport;
  41 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  42 import org.opendaylight.yangtools.yang.parser.spi.source.BelongsToPrefixToModuleIdentifier;
  43 import org.opendaylight.yangtools.yang.parser.spi.source.ImpPrefixToModuleIdentifier;
  44 import org.opendaylight.yangtools.yang.parser.spi.source.ModuleIdentifierToModuleQName;
  45 import org.opendaylight.yangtools.yang.parser.spi.source.PrefixToModule;
  46 import org.opendaylight.yangtools.yang.parser.spi.source.PrefixToModuleMap;
  47 import org.opendaylight.yangtools.yang.parser.spi.source.QNameToStatementDefinition;
  48 import org.opendaylight.yangtools.yang.parser.spi.source.QNameToStatementDefinitionMap;
  49 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
  50 import org.opendaylight.yangtools.yang.parser.spi.source.StatementSourceReference;
  51 import org.opendaylight.yangtools.yang.parser.spi.source.StatementStreamSource;
  52 import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.BitsSpecificationImpl;
  53 import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.Decimal64SpecificationImpl;
  54 import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.EnumSpecificationImpl;
  55 import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.IdentityRefSpecificationImpl;
  56 import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.InstanceIdentifierSpecificationImpl;
  57 import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.LeafrefSpecificationImpl;
  58 import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.TypeUtils;
  59 import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.UnionSpecificationImpl;
  60 import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.UnknownStatementImpl;
  61 import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.Utils;
  62
  63 public class SourceSpecificContext implements NamespaceStorageNode, NamespaceBehaviour.Registry, Mutable {
  64
  65     public enum PhaseCompletionProgress {
  66         NO_PROGRESS,
  67         PROGRESS,
  68         FINISHED
  69     }
  70
  71     private final StatementStreamSource source;
  72     private final BuildGlobalContext currentContext;
  73     private final Collection<NamespaceStorageNode> importedNamespaces = new ArrayList<>();
  74     private final Multimap<ModelProcessingPhase, ModifierImpl> modifiers = HashMultimap.create();
  75
  76     private RootStatementContext<?, ?, ?> root;
  77
  78     private ModelProcessingPhase inProgressPhase;
  79     private ModelProcessingPhase finishedPhase = ModelProcessingPhase.INIT;
  80     private final QNameToStatementDefinitionMap qNameToStmtDefMap = new QNameToStatementDefinitionMap();
  81     private final PrefixToModuleMap prefixToModuleMap = new PrefixToModuleMap();
  82
  83
  84     SourceSpecificContext(final BuildGlobalContext currentContext, final StatementStreamSource source) {
  85         this.source = source;
  86         this.currentContext = currentContext;
  87     }
  88
  89     ModelProcessingPhase getInProgressPhase() {
  90         return inProgressPhase;
  91     }
  92
  93     StatementDefinitionContext<?, ?, ?> getDefinition(final QName name) {
  94         return currentContext.getStatementDefinition(name);
  95     }
  96
  97     ContextBuilder<?, ?, ?> createDeclaredChild(final StatementContextBase<?, ?, ?> current, final QName name,
  98                                                 final StatementSourceReference ref) {
  99         StatementDefinitionContext<?, ?, ?> def = getDefinition(name);
 100
 101         if (def == null) {
 102             // unknown-stmts (from import, include or local-scope)
 103             if (qNameToStmtDefMap.get(name) != null) {
 104                     final StatementContextBase<?, ?, ?> extension =
 105                             (StatementContextBase<?, ?, ?>) currentContext.getAllFromNamespace(ExtensionNamespace.class).get(name);
 106                 if (extension != null) {
 107                     final QName arg = (QName) extension.getStatementArgument();
 108                     final QName qName = current.getFromNamespace(QNameCacheNamespace.class,
 109                             QName.create(arg, extension.getIdentifier().getArgument()));
 110
 111                     def = new StatementDefinitionContext<>(new UnknownStatementImpl.Definition(
 112                             getNewStatementDefinition(qName)));
 113                 } else {
 114                         throw new SourceException("Extension not found: " + name,
 115                                 current.getStatementSourceReference());
 116                 }
 117             } else {
 118                 // type-body-stmts
 119                 def = resolveTypeBodyStmts(name.getLocalName());
 120             }
 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() throws SourceException {
 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
 263         Iterator<ModifierImpl> modifier = currentPhaseModifiers.iterator();
 264         boolean hasProgressed = false;
 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_LINKAGE:
 316                 source.writeLinkage(new StatementContextWriter(this, inProgressPhase), stmtDef());
 317                 break;
 318             case STATEMENT_DEFINITION:
 319                 source.writeLinkageAndStatementDefinitions(new StatementContextWriter(this, inProgressPhase), stmtDef(), prefixes());
 320                 break;
 321             case FULL_DECLARATION:
 322                 source.writeFull(new StatementContextWriter(this, inProgressPhase), stmtDef(), prefixes());
 323                 break;
 324             default:
 325                 break;
 326         }
 327     }
 328
 329     private static StatementDefinitionContext<?, ?, ?> resolveTypeBodyStmts(final String typeArgument) {
 330         switch (typeArgument) {
 331             case TypeUtils.DECIMAL64:
 332                 return new StatementDefinitionContext<>(new Decimal64SpecificationImpl.Definition());
 333             case TypeUtils.UNION:
 334                 return new StatementDefinitionContext<>(new UnionSpecificationImpl.Definition());
 335             case TypeUtils.ENUMERATION:
 336                 return new StatementDefinitionContext<>(new EnumSpecificationImpl.Definition());
 337             case TypeUtils.LEAF_REF:
 338                 return new StatementDefinitionContext<>(new LeafrefSpecificationImpl.Definition());
 339             case TypeUtils.BITS:
 340                 return new StatementDefinitionContext<>(new BitsSpecificationImpl.Definition());
 341             case TypeUtils.IDENTITY_REF:
 342                 return new StatementDefinitionContext<>(new IdentityRefSpecificationImpl.Definition());
 343             case TypeUtils.INSTANCE_IDENTIFIER:
 344                 return new StatementDefinitionContext<>(new InstanceIdentifierSpecificationImpl.Definition());
 345             default:
 346                 return null;
 347         }
 348     }
 349
 350     private PrefixToModule prefixes() {
 351         final Map<String, ModuleIdentifier> allPrefixes = getRoot().getAllFromNamespace(ImpPrefixToModuleIdentifier
 352                 .class);
 353         final Map<String, ModuleIdentifier> belongsToPrefixes = getRoot().getAllFromNamespace
 354                 (BelongsToPrefixToModuleIdentifier.class);
 355         if (belongsToPrefixes != null)
 356             allPrefixes.putAll(belongsToPrefixes);
 357
 358         for (Entry<String, ModuleIdentifier> stringModuleIdentifierEntry : allPrefixes.entrySet()) {
 359             final QNameModule namespace = getRoot().getFromNamespace(ModuleIdentifierToModuleQName.class,
 360                     stringModuleIdentifierEntry.getValue());
 361             prefixToModuleMap.put(stringModuleIdentifierEntry.getKey(), namespace);
 362         }
 363         return prefixToModuleMap;
 364     }
 365
 366     private QNameToStatementDefinition stmtDef() {
 367         // regular YANG statements added
 368         ImmutableMap<QName, StatementSupport<?, ?, ?>> definitions = currentContext.getSupportsForPhase(
 369                 inProgressPhase).getDefinitions();
 370         for (Map.Entry<QName, StatementSupport<?, ?, ?>> entry : definitions.entrySet()) {
 371             qNameToStmtDefMap.put(entry.getKey(), entry.getValue());
 372         }
 373
 374         // extensions added
 375         if (inProgressPhase.equals(ModelProcessingPhase.FULL_DECLARATION)) {
 376             Map<QName, StmtContext<?, ExtensionStatement, EffectiveStatement<QName, ExtensionStatement>>> extensions = currentContext
 377                     .getAllFromNamespace(ExtensionNamespace.class);
 378             if (extensions != null) {
 379                 for (Map.Entry<QName, StmtContext<?, ExtensionStatement, EffectiveStatement<QName, ExtensionStatement>>> extension : extensions
 380                         .entrySet()) {
 381                     qNameToStmtDefMap
 382                               .put((extension.getKey()),
 383                                     (StatementDefinition) ((StatementContextBase<?, ?, ?>) extension
 384                                             .getValue()).definition()
 385                                             .getFactory());
 386                 }
 387             }
 388         }
 389         return qNameToStmtDefMap;
 390     }
 391 }