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
 107                 SourceException.throwIfNull(extension, current.getStatementSourceReference(), "Extension %s not found",
 108                     name);
 109
 110                 final QName arg = (QName) extension.getStatementArgument();
 111                 final QName qName = current.getFromNamespace(QNameCacheNamespace.class,
 112                     QName.create(arg, extension.getIdentifier().getArgument()));
 113
 114                 def = new StatementDefinitionContext<>(new UnknownStatementImpl.Definition(
 115                     getNewStatementDefinition(qName)));
 116             } else {
 117                 // type-body-stmts
 118                 def = resolveTypeBodyStmts(name.getLocalName());
 119             }
 120         } else if (current != null && current.definition().getRepresentingClass().equals(UnknownStatementImpl.class)) {
 121             QName qName = Utils.qNameFromArgument(current, name.getLocalName());
 122
 123             def = new StatementDefinitionContext<>(new UnknownStatementImpl.Definition(
 124                 getNewStatementDefinition(qName)));
 125         }
 126
 127         Preconditions.checkArgument(def != null, "Statement %s does not have type mapping defined.", name);
 128         if (current == null) {
 129             return createDeclaredRoot(def, ref);
 130         }
 131         return current.substatementBuilder(def, ref);
 132     }
 133
 134     // FIXME: This should be populated differently
 135     StatementDefinition getNewStatementDefinition(final QName qName) {
 136         return new ModelDefinedStatementDefinition(qName);
 137     }
 138
 139     @SuppressWarnings({"rawtypes", "unchecked"})
 140     private ContextBuilder<?, ?, ?> createDeclaredRoot(final StatementDefinitionContext<?, ?, ?> def,
 141                                                        final StatementSourceReference ref) {
 142         return new ContextBuilder(def, ref) {
 143
 144             @Override
 145             public StatementContextBase build() {
 146                 if (root == null) {
 147                     root = new RootStatementContext(this, SourceSpecificContext.this);
 148                 } else {
 149                     Preconditions.checkState(root.getIdentifier().equals(createIdentifier()),
 150                             "Root statement was already defined as %s.", root.getIdentifier());
 151                 }
 152                 root.resetLists();
 153                 return root;
 154             }
 155
 156         };
 157     }
 158
 159     RootStatementContext<?, ?, ?> getRoot() {
 160         return root;
 161     }
 162
 163     DeclaredStatement<?> buildDeclared() {
 164         return root.buildDeclared();
 165     }
 166
 167     EffectiveStatement<?, ?> buildEffective() {
 168         return root.buildEffective();
 169     }
 170
 171     void startPhase(final ModelProcessingPhase phase) {
 172         @Nullable
 173         ModelProcessingPhase previousPhase = phase.getPreviousPhase();
 174         Preconditions.checkState(Objects.equals(previousPhase, finishedPhase));
 175         Preconditions.checkState(modifiers.get(previousPhase).isEmpty());
 176         inProgressPhase = phase;
 177     }
 178
 179     @Override
 180     public <K, V, N extends IdentifierNamespace<K, V>> void addToLocalStorage(final Class<N> type, final K key,
 181            final V value) {
 182         if (ImportedNamespaceContext.class.isAssignableFrom(type)) {
 183             importedNamespaces.add((NamespaceStorageNode) value);
 184         }
 185         getRoot().addToLocalStorage(type, key, value);
 186     }
 187
 188     @Override
 189     public StorageNodeType getStorageNodeType() {
 190         return StorageNodeType.SOURCE_LOCAL_SPECIAL;
 191     }
 192
 193     @Override
 194     public <K, V, N extends IdentifierNamespace<K, V>> V getFromLocalStorage(final Class<N> type, final K key) {
 195         final V potentialLocal = getRoot().getFromLocalStorage(type, key);
 196         if (potentialLocal != null) {
 197             return potentialLocal;
 198         }
 199         for (NamespaceStorageNode importedSource : importedNamespaces) {
 200             V potential = importedSource.getFromLocalStorage(type, key);
 201             if (potential != null) {
 202                 return potential;
 203             }
 204         }
 205         return null;
 206     }
 207
 208     @Nullable
 209     @Override
 210     public <K, V, N extends IdentifierNamespace<K, V>> Map<K, V> getAllFromLocalStorage(final Class<N> type) {
 211         final Map<K, V> potentialLocal = getRoot().getAllFromLocalStorage(type);
 212
 213         if (potentialLocal != null) {
 214             return potentialLocal;
 215         }
 216
 217         for (final NamespaceStorageNode importedSource : importedNamespaces) {
 218             final Map<K, V> potential = importedSource.getAllFromLocalStorage(type);
 219
 220             if (potential != null) {
 221                 return potential;
 222             }
 223         }
 224         return null;
 225     }
 226
 227     @Override
 228     public <K, V, N extends IdentifierNamespace<K, V>> NamespaceBehaviour<K, V, N> getNamespaceBehaviour(
 229             final Class<N> type) {
 230         return currentContext.getNamespaceBehaviour(type);
 231     }
 232
 233     @Override
 234     public NamespaceStorageNode getParentNamespaceStorage() {
 235         return currentContext;
 236     }
 237
 238     PhaseCompletionProgress tryToCompletePhase(final ModelProcessingPhase phase) throws SourceException {
 239         Collection<ModifierImpl> currentPhaseModifiers = modifiers.get(phase);
 240
 241         boolean hasProgressed = tryToProgress(currentPhaseModifiers);
 242
 243         boolean phaseCompleted = root.tryToCompletePhase(phase);
 244
 245         hasProgressed = (tryToProgress(currentPhaseModifiers) | hasProgressed);
 246
 247         if (phaseCompleted && (currentPhaseModifiers.isEmpty())) {
 248             finishedPhase = phase;
 249             return PhaseCompletionProgress.FINISHED;
 250
 251         }
 252         if (hasProgressed) {
 253             return PhaseCompletionProgress.PROGRESS;
 254         }
 255         return PhaseCompletionProgress.NO_PROGRESS;
 256     }
 257
 258
 259     private static boolean tryToProgress(final Collection<ModifierImpl> currentPhaseModifiers) {
 260         boolean hasProgressed = false;
 261
 262         final Iterator<ModifierImpl> modifier = currentPhaseModifiers.iterator();
 263         while (modifier.hasNext()) {
 264             if (modifier.next().tryApply()) {
 265                 modifier.remove();
 266                 hasProgressed = true;
 267             }
 268         }
 269
 270         return hasProgressed;
 271
 272     }
 273
 274     ModelActionBuilder newInferenceAction(final ModelProcessingPhase phase) {
 275         ModifierImpl action = new ModifierImpl(phase);
 276         modifiers.put(phase, action);
 277         return action;
 278     }
 279
 280     @Override
 281     public String toString() {
 282         return "SourceSpecificContext [source=" + source + ", current=" + inProgressPhase + ", finished="
 283                 + finishedPhase + "]";
 284     }
 285
 286     SourceException failModifiers(final ModelProcessingPhase identifier) {
 287         final List<SourceException> exceptions = new ArrayList<>();
 288         for (ModifierImpl mod : modifiers.get(identifier)) {
 289             try {
 290                 mod.failModifier();
 291             } catch (SourceException e) {
 292                 exceptions.add(e);
 293             }
 294         }
 295
 296         final String message = String.format("Yang model processing phase %s failed", identifier);
 297         if (exceptions.isEmpty()) {
 298             return new InferenceException(message, root.getStatementSourceReference());
 299         }
 300
 301         final InferenceException e = new InferenceException(message, root.getStatementSourceReference(),
 302             exceptions.get(0));
 303         final Iterator<SourceException> it = exceptions.listIterator(1);
 304         while (it.hasNext()) {
 305             e.addSuppressed(it.next());
 306         }
 307
 308         return e;
 309     }
 310
 311     void loadStatements() throws SourceException {
 312         switch (inProgressPhase) {
 313             case SOURCE_LINKAGE:
 314                 source.writeLinkage(new StatementContextWriter(this, inProgressPhase), stmtDef());
 315                 break;
 316             case STATEMENT_DEFINITION:
 317                 source.writeLinkageAndStatementDefinitions(new StatementContextWriter(this, inProgressPhase), stmtDef(), prefixes());
 318                 break;
 319             case FULL_DECLARATION:
 320                 source.writeFull(new StatementContextWriter(this, inProgressPhase), stmtDef(), prefixes());
 321                 break;
 322             default:
 323                 break;
 324         }
 325     }
 326
 327     private static StatementDefinitionContext<?, ?, ?> resolveTypeBodyStmts(final String typeArgument) {
 328         switch (typeArgument) {
 329             case TypeUtils.DECIMAL64:
 330                 return new StatementDefinitionContext<>(new Decimal64SpecificationImpl.Definition());
 331             case TypeUtils.UNION:
 332                 return new StatementDefinitionContext<>(new UnionSpecificationImpl.Definition());
 333             case TypeUtils.ENUMERATION:
 334                 return new StatementDefinitionContext<>(new EnumSpecificationImpl.Definition());
 335             case TypeUtils.LEAF_REF:
 336                 return new StatementDefinitionContext<>(new LeafrefSpecificationImpl.Definition());
 337             case TypeUtils.BITS:
 338                 return new StatementDefinitionContext<>(new BitsSpecificationImpl.Definition());
 339             case TypeUtils.IDENTITY_REF:
 340                 return new StatementDefinitionContext<>(new IdentityRefSpecificationImpl.Definition());
 341             case TypeUtils.INSTANCE_IDENTIFIER:
 342                 return new StatementDefinitionContext<>(new InstanceIdentifierSpecificationImpl.Definition());
 343             default:
 344                 return null;
 345         }
 346     }
 347
 348     private PrefixToModule prefixes() {
 349         final Map<String, ModuleIdentifier> allPrefixes = getRoot().getAllFromNamespace(ImpPrefixToModuleIdentifier
 350                 .class);
 351         final Map<String, ModuleIdentifier> belongsToPrefixes = getRoot().getAllFromNamespace
 352                 (BelongsToPrefixToModuleIdentifier.class);
 353         if (belongsToPrefixes != null) {
 354             allPrefixes.putAll(belongsToPrefixes);
 355         }
 356
 357         for (Entry<String, ModuleIdentifier> stringModuleIdentifierEntry : allPrefixes.entrySet()) {
 358             final QNameModule namespace = getRoot().getFromNamespace(ModuleIdentifierToModuleQName.class,
 359                 stringModuleIdentifierEntry.getValue());
 360             prefixToModuleMap.put(stringModuleIdentifierEntry.getKey(), namespace);
 361         }
 362         return prefixToModuleMap;
 363     }
 364
 365     private QNameToStatementDefinition stmtDef() {
 366         // regular YANG statements added
 367         ImmutableMap<QName, StatementSupport<?, ?, ?>> definitions = currentContext.getSupportsForPhase(
 368                 inProgressPhase).getDefinitions();
 369         for (Entry<QName, StatementSupport<?, ?, ?>> entry : definitions.entrySet()) {
 370             qNameToStmtDefMap.put(entry.getKey(), entry.getValue());
 371         }
 372
 373         // extensions added
 374         if (inProgressPhase.equals(ModelProcessingPhase.FULL_DECLARATION)) {
 375             Map<QName, StmtContext<?, ExtensionStatement, EffectiveStatement<QName, ExtensionStatement>>> extensions =
 376                     currentContext.getAllFromNamespace(ExtensionNamespace.class);
 377             if (extensions != null) {
 378                 for (Entry<QName, StmtContext<?, ExtensionStatement, EffectiveStatement<QName, ExtensionStatement>>> extension :
 379                     extensions.entrySet()) {
 380                     qNameToStmtDefMap.put((extension.getKey()),
 381                         (StatementDefinition) ((StatementContextBase<?, ?, ?>) extension.getValue()).definition()
 382                         .getFactory());
 383                 }
 384             }
 385         }
 386         return qNameToStmtDefMap;
 387     }
 388 }