yang/yang-parser-reactor/src/main/java/org/opendaylight/yangtools/yang/parser/stmt/reactor/SubstatementContext.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.base.Verify;
  12 import java.util.Collection;
  13 import java.util.Optional;
  14 import javax.annotation.Nonnull;
  15 import org.opendaylight.yangtools.util.OptionalBoolean;
  16 import org.opendaylight.yangtools.yang.common.QName;
  17 import org.opendaylight.yangtools.yang.common.QNameModule;
  18 import org.opendaylight.yangtools.yang.common.YangVersion;
  19 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  20 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
  21 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  22 import org.opendaylight.yangtools.yang.model.api.stmt.AugmentStatement;
  23 import org.opendaylight.yangtools.yang.model.api.stmt.ChoiceStatement;
  24 import org.opendaylight.yangtools.yang.model.api.stmt.ConfigStatement;
  25 import org.opendaylight.yangtools.yang.model.api.stmt.DeviationStatement;
  26 import org.opendaylight.yangtools.yang.model.api.stmt.RefineStatement;
  27 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier;
  28 import org.opendaylight.yangtools.yang.model.api.stmt.UsesStatement;
  29 import org.opendaylight.yangtools.yang.model.repo.api.SourceIdentifier;
  30 import org.opendaylight.yangtools.yang.parser.spi.meta.CopyType;
  31 import org.opendaylight.yangtools.yang.parser.spi.meta.InferenceException;
  32 import org.opendaylight.yangtools.yang.parser.spi.meta.MutableStatement;
  33 import org.opendaylight.yangtools.yang.parser.spi.meta.NamespaceBehaviour.NamespaceStorageNode;
  34 import org.opendaylight.yangtools.yang.parser.spi.meta.NamespaceBehaviour.Registry;
  35 import org.opendaylight.yangtools.yang.parser.spi.meta.NamespaceBehaviour.StorageNodeType;
  36 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  37 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
  38 import org.opendaylight.yangtools.yang.parser.spi.source.AugmentToChoiceNamespace;
  39 import org.opendaylight.yangtools.yang.parser.spi.source.StatementSourceReference;
  40 import org.opendaylight.yangtools.yang.parser.spi.validation.ValidationBundlesNamespace;
  41 import org.opendaylight.yangtools.yang.parser.spi.validation.ValidationBundlesNamespace.ValidationBundleType;
  42
  43 final class SubstatementContext<A, D extends DeclaredStatement<A>, E extends EffectiveStatement<A, D>> extends
  44         StatementContextBase<A, D, E> {
  45     private final StatementContextBase<?, ?, ?> parent;
  46     private final A argument;
  47
  48     /**
  49      * Config statements are not all that common which means we are performing a recursive search towards the root
  50      * every time {@link #isConfiguration()} is invoked. This is quite expensive because it causes a linear search
  51      * for the (usually non-existent) config statement.
  52      *
  53      * <p>
  54      * This field maintains a resolution cache, so once we have returned a result, we will keep on returning the same
  55      * result without performing any lookups.
  56      */
  57     // BooleanField value
  58     private byte configuration;
  59
  60     /**
  61      * This field maintains a resolution cache for ignore config, so once we have returned a result, we will
  62      * keep on returning the same result without performing any lookups.
  63      */
  64     // BooleanField value
  65     private byte ignoreConfig;
  66
  67     /**
  68      * This field maintains a resolution cache for ignore if-feature, so once we have returned a result, we will
  69      * keep on returning the same result without performing any lookups.
  70      */
  71     // BooleanField value
  72     private byte ignoreIfFeature;
  73
  74     private volatile SchemaPath schemaPath;
  75
  76     SubstatementContext(final StatementContextBase<?, ?, ?> parent, final StatementDefinitionContext<A, D, E> def,
  77             final StatementSourceReference ref, final String rawArgument) {
  78         super(def, ref, rawArgument);
  79         this.parent = Preconditions.checkNotNull(parent, "Parent must not be null");
  80         this.argument = def.parseArgumentValue(this, rawStatementArgument());
  81     }
  82
  83     SubstatementContext(final StatementContextBase<A, D, E> original, final StatementContextBase<?, ?, ?> parent,
  84             final CopyType copyType, final QNameModule targetModule) {
  85         super(original, copyType);
  86         this.parent = Preconditions.checkNotNull(parent);
  87         this.argument = targetModule == null ? original.getStatementArgument()
  88                 : original.definition().adaptArgumentValue(original, targetModule);
  89     }
  90
  91     @Override
  92     public StatementContextBase<?, ?, ?> getParentContext() {
  93         return parent;
  94     }
  95
  96     @Override
  97     public StorageNodeType getStorageNodeType() {
  98         return StorageNodeType.STATEMENT_LOCAL;
  99     }
 100
 101     @Override
 102     public NamespaceStorageNode getParentNamespaceStorage() {
 103         return parent;
 104     }
 105
 106     @Override
 107     public Registry getBehaviourRegistry() {
 108         return parent.getBehaviourRegistry();
 109     }
 110
 111     @Nonnull
 112     @Override
 113     public RootStatementContext<?, ?, ?> getRoot() {
 114         return parent.getRoot();
 115     }
 116
 117     @Override
 118     public A getStatementArgument() {
 119         return argument;
 120     }
 121
 122     private boolean isSupportedAsShorthandCase() {
 123         final Collection<?> supportedCaseShorthands = getFromNamespace(ValidationBundlesNamespace.class,
 124                 ValidationBundleType.SUPPORTED_CASE_SHORTHANDS);
 125         return supportedCaseShorthands == null || supportedCaseShorthands.contains(getPublicDefinition());
 126     }
 127
 128     private SchemaPath createSchemaPath() {
 129         final Optional<SchemaPath> maybeParentPath = parent.getSchemaPath();
 130         Verify.verify(maybeParentPath.isPresent(), "Parent %s does not have a SchemaPath", parent);
 131         final SchemaPath parentPath = maybeParentPath.get();
 132
 133         if (StmtContextUtils.isUnknownStatement(this)) {
 134             return parentPath.createChild(getPublicDefinition().getStatementName());
 135         }
 136         if (argument instanceof QName) {
 137             final QName qname = (QName) argument;
 138             if (StmtContextUtils.producesDeclared(this, UsesStatement.class)) {
 139                 return maybeParentPath.orElse(null);
 140             }
 141
 142             final SchemaPath path;
 143             if ((StmtContextUtils.producesDeclared(getParentContext(), ChoiceStatement.class)
 144                     || Boolean.TRUE.equals(parent.getFromNamespace(AugmentToChoiceNamespace.class, parent)))
 145                     && isSupportedAsShorthandCase()) {
 146                 path = parentPath.createChild(qname);
 147             } else {
 148                 path = parentPath;
 149             }
 150             return path.createChild(qname);
 151         }
 152         if (argument instanceof String) {
 153             // FIXME: This may yield illegal argument exceptions
 154             final Optional<StmtContext<?, ?, ?>> originalCtx = getOriginalCtx();
 155             final QName qname = StmtContextUtils.qnameFromArgument(originalCtx.orElse(this), (String) argument);
 156             return parentPath.createChild(qname);
 157         }
 158         if (argument instanceof SchemaNodeIdentifier
 159                 && (StmtContextUtils.producesDeclared(this, AugmentStatement.class)
 160                         || StmtContextUtils.producesDeclared(this, RefineStatement.class)
 161                         || StmtContextUtils.producesDeclared(this, DeviationStatement.class))) {
 162
 163             return parentPath.createChild(((SchemaNodeIdentifier) argument).getPathFromRoot());
 164         }
 165
 166         // FIXME: this does not look right
 167         return maybeParentPath.orElse(null);
 168     }
 169
 170     @Nonnull
 171     @Override
 172     public Optional<SchemaPath> getSchemaPath() {
 173         SchemaPath local = schemaPath;
 174         if (local == null) {
 175             synchronized (this) {
 176                 local = schemaPath;
 177                 if (local == null) {
 178                     local = createSchemaPath();
 179                     schemaPath = local;
 180                 }
 181             }
 182         }
 183
 184         return Optional.ofNullable(local);
 185     }
 186
 187     @Override
 188     public boolean isConfiguration() {
 189         if (isIgnoringConfig()) {
 190             return true;
 191         }
 192
 193         if (OptionalBoolean.isPresent(configuration)) {
 194             return OptionalBoolean.get(configuration);
 195         }
 196
 197         final StmtContext<Boolean, ?, ?> configStatement = StmtContextUtils.findFirstSubstatement(this,
 198             ConfigStatement.class);
 199         final boolean parentIsConfig = parent.isConfiguration();
 200
 201         final boolean isConfig;
 202         if (configStatement != null) {
 203             isConfig = configStatement.getStatementArgument();
 204
 205             // Validity check: if parent is config=false this cannot be a config=true
 206             InferenceException.throwIf(isConfig && !parentIsConfig, getStatementSourceReference(),
 207                     "Parent node has config=false, this node must not be specifed as config=true");
 208         } else {
 209             // If "config" statement is not specified, the default is the same as the parent's "config" value.
 210             isConfig = parentIsConfig;
 211         }
 212
 213         // Resolved, make sure we cache this return
 214         configuration = OptionalBoolean.of(isConfig);
 215         return isConfig;
 216     }
 217
 218     @Override
 219     public boolean isEnabledSemanticVersioning() {
 220         return parent.isEnabledSemanticVersioning();
 221     }
 222
 223     @Override
 224     public YangVersion getRootVersion() {
 225         return getRoot().getRootVersion();
 226     }
 227
 228     @Override
 229     public void setRootVersion(final YangVersion version) {
 230         getRoot().setRootVersion(version);
 231     }
 232
 233     @Override
 234     public void addMutableStmtToSeal(final MutableStatement mutableStatement) {
 235         getRoot().addMutableStmtToSeal(mutableStatement);
 236     }
 237
 238     @Override
 239     public void addRequiredSource(final SourceIdentifier dependency) {
 240         getRoot().addRequiredSource(dependency);
 241     }
 242
 243     @Override
 244     public void setRootIdentifier(final SourceIdentifier identifier) {
 245         getRoot().setRootIdentifier(identifier);
 246     }
 247
 248     @Override
 249     protected boolean isIgnoringIfFeatures() {
 250         if (OptionalBoolean.isPresent(ignoreIfFeature)) {
 251             return OptionalBoolean.get(ignoreIfFeature);
 252         }
 253
 254         final boolean ret = definition().isIgnoringIfFeatures() || parent.isIgnoringIfFeatures();
 255         ignoreIfFeature = OptionalBoolean.of(ret);
 256
 257         return ret;
 258     }
 259
 260     @Override
 261     protected boolean isIgnoringConfig() {
 262         if (OptionalBoolean.isPresent(ignoreConfig)) {
 263             return OptionalBoolean.get(ignoreConfig);
 264         }
 265
 266         final boolean ret = definition().isIgnoringConfig() || parent.isIgnoringConfig();
 267         ignoreConfig = OptionalBoolean.of(ret);
 268
 269         return ret;
 270     }
 271
 272     @Override
 273     protected boolean isParentSupportedByFeatures() {
 274         return parent.isSupportedByFeatures();
 275     }
 276 }