yang/yang-parser-reactor/src/main/java/org/opendaylight/yangtools/yang/parser/stmt/reactor/RootStatementContext.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 static com.google.common.base.Preconditions.checkArgument;
  11 import static com.google.common.base.Preconditions.checkState;
  12 import static com.google.common.base.Verify.verify;
  13 import static java.util.Objects.requireNonNull;
  14
  15 import com.google.common.collect.ImmutableList;
  16 import com.google.common.collect.ImmutableSet;
  17 import java.util.ArrayList;
  18 import java.util.Collection;
  19 import java.util.HashSet;
  20 import java.util.List;
  21 import java.util.Map;
  22 import java.util.Optional;
  23 import java.util.Set;
  24 import org.eclipse.jdt.annotation.NonNull;
  25 import org.eclipse.jdt.annotation.Nullable;
  26 import org.opendaylight.yangtools.yang.common.YangVersion;
  27 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  28 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
  29 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  30 import org.opendaylight.yangtools.yang.model.api.meta.IdentifierNamespace;
  31 import org.opendaylight.yangtools.yang.model.repo.api.SourceIdentifier;
  32 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase;
  33 import org.opendaylight.yangtools.yang.parser.spi.meta.MutableStatement;
  34 import org.opendaylight.yangtools.yang.parser.spi.meta.NamespaceBehaviour.NamespaceStorageNode;
  35 import org.opendaylight.yangtools.yang.parser.spi.meta.NamespaceBehaviour.Registry;
  36 import org.opendaylight.yangtools.yang.parser.spi.meta.NamespaceBehaviour.StorageNodeType;
  37 import org.opendaylight.yangtools.yang.parser.spi.source.IncludedModuleContext;
  38 import org.opendaylight.yangtools.yang.parser.spi.source.StatementSourceReference;
  39
  40 /**
  41  * Root statement class for a YANG source. All statements defined in that YANG source are mapped underneath an instance
  42  * of this class, hence recursive lookups from them cross this class.
  43  */
  44 public class RootStatementContext<A, D extends DeclaredStatement<A>, E extends EffectiveStatement<A, D>> extends
  45         AbstractResumedStatement<A, D, E> {
  46
  47     public static final YangVersion DEFAULT_VERSION = YangVersion.VERSION_1;
  48
  49     private final @NonNull SourceSpecificContext sourceContext;
  50     private final A argument;
  51
  52     private YangVersion rootVersion;
  53     private Set<SourceIdentifier> requiredSources = ImmutableSet.of();
  54     private SourceIdentifier rootIdentifier;
  55
  56     /**
  57      * References to RootStatementContext of submodules which are included in this source.
  58      */
  59     private List<RootStatementContext<?, ?, ?>> includedContexts = ImmutableList.of();
  60
  61     RootStatementContext(final SourceSpecificContext sourceContext, final StatementDefinitionContext<A, D, E> def,
  62         final StatementSourceReference ref, final String rawArgument) {
  63         super(def, ref, rawArgument);
  64         this.sourceContext = requireNonNull(sourceContext);
  65         this.argument = def.parseArgumentValue(this, rawStatementArgument());
  66     }
  67
  68     RootStatementContext(final SourceSpecificContext sourceContext, final StatementDefinitionContext<A, D, E> def,
  69             final StatementSourceReference ref, final String rawArgument, final YangVersion version,
  70             final SourceIdentifier identifier) {
  71         this(sourceContext, def, ref, rawArgument);
  72         this.setRootVersion(version);
  73         this.setRootIdentifier(identifier);
  74     }
  75
  76     @Override
  77     public StatementContextBase<?, ?, ?> getParentContext() {
  78         // null as root cannot have parent
  79         return null;
  80     }
  81
  82     @Override
  83     public NamespaceStorageNode getParentNamespaceStorage() {
  84         // namespace storage of source context
  85         return sourceContext;
  86     }
  87
  88     @Override
  89     public StorageNodeType getStorageNodeType() {
  90         return StorageNodeType.ROOT_STATEMENT_LOCAL;
  91     }
  92
  93     @Override
  94     public RootStatementContext<?, ?, ?> getRoot() {
  95         // this as its own root
  96         return this;
  97     }
  98
  99     SourceSpecificContext getSourceContext() {
 100         return sourceContext;
 101     }
 102
 103     @Override
 104     public A getStatementArgument() {
 105         return argument;
 106     }
 107
 108     @Override
 109     public Optional<SchemaPath> getSchemaPath() {
 110         return Optional.of(SchemaPath.ROOT);
 111     }
 112
 113     @Override
 114     public boolean isConfiguration() {
 115         return true;
 116     }
 117
 118     @Override
 119     public <K, V, N extends IdentifierNamespace<K, V>> V putToLocalStorage(final Class<N> type, final K key,
 120             final V value) {
 121         if (IncludedModuleContext.class.isAssignableFrom(type)) {
 122             if (includedContexts.isEmpty()) {
 123                 includedContexts = new ArrayList<>(1);
 124             }
 125             verify(value instanceof RootStatementContext);
 126             includedContexts.add((RootStatementContext<?, ?, ?>) value);
 127         }
 128         return super.putToLocalStorage(type, key, value);
 129     }
 130
 131     @Override
 132     public <K, V, N extends IdentifierNamespace<K, V>> V getFromLocalStorage(final Class<N> type, final K key) {
 133         return getFromLocalStorage(type, key, new HashSet<>());
 134     }
 135
 136     /*
 137      * We need to track already checked RootStatementContexts due to possible
 138      * circular chains of includes between submodules
 139      */
 140     private <K, V, N extends IdentifierNamespace<K, V>> @Nullable V getFromLocalStorage(final Class<N> type,
 141             final K key, final HashSet<RootStatementContext<?, ?, ?>> alreadyChecked) {
 142         final V potentialLocal = super.getFromLocalStorage(type, key);
 143         if (potentialLocal != null) {
 144             return potentialLocal;
 145         }
 146
 147         alreadyChecked.add(this);
 148         for (final RootStatementContext<?, ?, ?> includedSource : includedContexts) {
 149             if (alreadyChecked.contains(includedSource)) {
 150                 continue;
 151             }
 152             final V potential = includedSource.getFromLocalStorage(type, key, alreadyChecked);
 153             if (potential != null) {
 154                 return potential;
 155             }
 156         }
 157         return null;
 158     }
 159
 160     @Override
 161     public <K, V, N extends IdentifierNamespace<K, V>> Map<K, V> getAllFromLocalStorage(final Class<N> type) {
 162         return getAllFromLocalStorage(type, new HashSet<>());
 163     }
 164
 165     /*
 166      * We need to track already checked RootStatementContexts due to possible
 167      * circular chains of includes between submodules
 168      */
 169     private <K, V, N extends IdentifierNamespace<K, V>> @Nullable Map<K, V> getAllFromLocalStorage(final Class<N> type,
 170             final HashSet<RootStatementContext<?, ?, ?>> alreadyChecked) {
 171         final Map<K, V> potentialLocal = super.getAllFromLocalStorage(type);
 172         if (potentialLocal != null) {
 173             return potentialLocal;
 174         }
 175
 176         alreadyChecked.add(this);
 177         for (final RootStatementContext<?, ?, ?> includedSource : includedContexts) {
 178             if (alreadyChecked.contains(includedSource)) {
 179                 continue;
 180             }
 181             final Map<K, V> potential = includedSource.getAllFromLocalStorage(type, alreadyChecked);
 182             if (potential != null) {
 183                 return potential;
 184             }
 185         }
 186         return null;
 187     }
 188
 189     /**
 190      * Return the set of required sources.
 191      *
 192      * @return Required sources.
 193      */
 194     Collection<SourceIdentifier> getRequiredSources() {
 195         return ImmutableSet.copyOf(requiredSources);
 196     }
 197
 198     SourceIdentifier getRootIdentifier() {
 199         return rootIdentifier;
 200     }
 201
 202     @Override
 203     protected boolean isIgnoringIfFeatures() {
 204         return false;
 205     }
 206
 207     @Override
 208     protected boolean isIgnoringConfig() {
 209         return false;
 210     }
 211
 212     @Override
 213     protected boolean isParentSupportedByFeatures() {
 214         return true;
 215     }
 216
 217     void setRootIdentifierImpl(final SourceIdentifier identifier) {
 218         this.rootIdentifier = requireNonNull(identifier);
 219     }
 220
 221     @NonNull Registry getBehaviourRegistryImpl() {
 222         return sourceContext;
 223     }
 224
 225     boolean isEnabledSemanticVersioningImpl() {
 226         return sourceContext.globalContext().isEnabledSemanticVersioning();
 227     }
 228
 229     @NonNull YangVersion getRootVersionImpl() {
 230         return rootVersion == null ? DEFAULT_VERSION : rootVersion;
 231     }
 232
 233     void setRootVersionImpl(final YangVersion version) {
 234         checkArgument(sourceContext.globalContext().getSupportedVersions().contains(version),
 235                 "Unsupported yang version %s in %s", version, getStatementSourceReference());
 236         checkState(this.rootVersion == null, "Version of root %s has been already set to %s", argument,
 237                 this.rootVersion);
 238         this.rootVersion = requireNonNull(version);
 239     }
 240
 241     void addMutableStmtToSealImpl(final MutableStatement mutableStatement) {
 242         sourceContext.globalContext().addMutableStmtToSeal(mutableStatement);
 243     }
 244
 245     void addRequiredSourceImpl(final SourceIdentifier dependency) {
 246         checkState(sourceContext.getInProgressPhase() == ModelProcessingPhase.SOURCE_PRE_LINKAGE,
 247                 "Add required module is allowed only in ModelProcessingPhase.SOURCE_PRE_LINKAGE phase");
 248         if (requiredSources.isEmpty()) {
 249             requiredSources = new HashSet<>();
 250         }
 251         requiredSources.add(dependency);
 252     }
 253
 254     @Override
 255     StatementContextBase<A, D, E> reparent(final StatementContextBase<?, ?, ?> newParent) {
 256         throw new UnsupportedOperationException("Root statement cannot be reparented to" + newParent);
 257     }
 258 }