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