yang/yang-parser-impl/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.Optional;
  11 import com.google.common.base.Preconditions;
  12 import com.google.common.base.Verify;
  13 import java.util.Collection;
  14 import java.util.Objects;
  15 import org.opendaylight.yangtools.yang.common.QName;
  16 import org.opendaylight.yangtools.yang.common.QNameModule;
  17 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  18 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
  19 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  20 import org.opendaylight.yangtools.yang.model.api.stmt.AugmentStatement;
  21 import org.opendaylight.yangtools.yang.model.api.stmt.ChoiceStatement;
  22 import org.opendaylight.yangtools.yang.model.api.stmt.ConfigStatement;
  23 import org.opendaylight.yangtools.yang.model.api.stmt.KeyStatement;
  24 import org.opendaylight.yangtools.yang.model.api.stmt.RefineStatement;
  25 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier;
  26 import org.opendaylight.yangtools.yang.model.api.stmt.UsesStatement;
  27 import org.opendaylight.yangtools.yang.parser.spi.meta.InferenceException;
  28 import org.opendaylight.yangtools.yang.parser.spi.meta.NamespaceBehaviour.NamespaceStorageNode;
  29 import org.opendaylight.yangtools.yang.parser.spi.meta.NamespaceBehaviour.Registry;
  30 import org.opendaylight.yangtools.yang.parser.spi.meta.QNameCacheNamespace;
  31 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  32 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
  33 import org.opendaylight.yangtools.yang.parser.spi.source.AugmentToChoiceNamespace;
  34 import org.opendaylight.yangtools.yang.parser.spi.validation.ValidationBundlesNamespace;
  35 import org.opendaylight.yangtools.yang.parser.spi.validation.ValidationBundlesNamespace.ValidationBundleType;
  36 import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.GroupingUtils;
  37 import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.Utils;
  38
  39 final class SubstatementContext<A, D extends DeclaredStatement<A>, E extends EffectiveStatement<A, D>> extends
  40         StatementContextBase<A, D, E> {
  41
  42     private final StatementContextBase<?, ?, ?> parent;
  43     private final A argument;
  44     private volatile SchemaPath schemaPath;
  45
  46     SubstatementContext(final StatementContextBase<?, ?, ?> parent, final ContextBuilder<A, D, E> builder) {
  47         super(builder);
  48         this.parent = Preconditions.checkNotNull(parent, "Parent must not be null");
  49         this.argument = builder.getDefinition().parseArgumentValue(this, builder.getRawArgument());
  50     }
  51
  52     @SuppressWarnings("unchecked")
  53     SubstatementContext(final SubstatementContext<A, D, E> original, final QNameModule newQNameModule,
  54             final StatementContextBase<?, ?, ?> newParent, final TypeOfCopy typeOfCopy) {
  55         super(original);
  56         this.parent = newParent;
  57
  58         if (newQNameModule != null) {
  59             if (original.argument instanceof QName) {
  60                 final QName originalQName = (QName) original.argument;
  61                 this.argument = (A) getFromNamespace(QNameCacheNamespace.class,
  62                         QName.create(newQNameModule, originalQName.getLocalName()));
  63             } else if (StmtContextUtils.producesDeclared(original, KeyStatement.class)) {
  64                 this.argument = (A) StmtContextUtils.replaceModuleQNameForKey(
  65                         (StmtContext<Collection<SchemaNodeIdentifier>, KeyStatement, ?>) original, newQNameModule);
  66             } else {
  67                 this.argument = original.argument;
  68             }
  69         } else {
  70             this.argument = original.argument;
  71         }
  72     }
  73
  74     private void copyDeclaredStmts(final SubstatementContext<A, D, E> original, final QNameModule newQNameModule,
  75             final TypeOfCopy typeOfCopy) {
  76         final Collection<? extends StatementContextBase<?, ?, ?>> originalDeclaredSubstatements = original
  77                 .declaredSubstatements();
  78         for (final StatementContextBase<?, ?, ?> stmtContext : originalDeclaredSubstatements) {
  79             if (!StmtContextUtils.areFeaturesSupported(stmtContext)) {
  80                 continue;
  81             }
  82             if (GroupingUtils.needToCopyByUses(stmtContext)) {
  83                 final StatementContextBase<?, ?, ?> copy = stmtContext.createCopy(newQNameModule, this, typeOfCopy);
  84                 this.addEffectiveSubstatement(copy);
  85             } else if (GroupingUtils.isReusedByUses(stmtContext)) {
  86                 this.addEffectiveSubstatement(stmtContext);
  87             }
  88         }
  89     }
  90
  91     private void copyEffectiveStmts(final SubstatementContext<A, D, E> original, final QNameModule newQNameModule,
  92             final TypeOfCopy typeOfCopy) {
  93         final Collection<? extends StatementContextBase<?, ?, ?>> originalEffectiveSubstatements = original
  94                 .effectiveSubstatements();
  95         for (final StatementContextBase<?, ?, ?> stmtContext : originalEffectiveSubstatements) {
  96             if (GroupingUtils.needToCopyByUses(stmtContext)) {
  97                 final StatementContextBase<?, ?, ?> copy = stmtContext.createCopy(newQNameModule, this, typeOfCopy);
  98                 this.addEffectiveSubstatement(copy);
  99             } else if (GroupingUtils.isReusedByUses(stmtContext)) {
 100                 this.addEffectiveSubstatement(stmtContext);
 101             }
 102         }
 103     }
 104
 105     @Override
 106     public StatementContextBase<?, ?, ?> getParentContext() {
 107         return parent;
 108     }
 109
 110     @Override
 111     public NamespaceStorageNode getParentNamespaceStorage() {
 112         return parent;
 113     }
 114
 115     @Override
 116     public Registry getBehaviourRegistry() {
 117         return parent.getBehaviourRegistry();
 118     }
 119
 120     @Override
 121     public RootStatementContext<?, ?, ?> getRoot() {
 122         return parent.getRoot();
 123     }
 124
 125     @Override
 126     public A getStatementArgument() {
 127         return argument;
 128     }
 129
 130     @Override
 131     public StatementContextBase<?, ?, ?> createCopy(final StatementContextBase<?, ?, ?> newParent,
 132             final TypeOfCopy typeOfCopy) {
 133         return createCopy(null, newParent, typeOfCopy);
 134     }
 135
 136     @Override
 137     public StatementContextBase<A, D, E> createCopy(final QNameModule newQNameModule,
 138             final StatementContextBase<?, ?, ?> newParent, final TypeOfCopy typeOfCopy) {
 139         final SubstatementContext<A, D, E> copy = new SubstatementContext<>(this, newQNameModule, newParent, typeOfCopy);
 140
 141         copy.addAllToCopyHistory(this.getCopyHistory());
 142         copy.addToCopyHistory(typeOfCopy);
 143
 144         if (this.getOriginalCtx() != null) {
 145             copy.setOriginalCtx(this.getOriginalCtx());
 146         } else {
 147             copy.setOriginalCtx(this);
 148         }
 149
 150         definition().onStatementAdded(copy);
 151
 152         copy.copyDeclaredStmts(this, newQNameModule, typeOfCopy);
 153         copy.copyEffectiveStmts(this, newQNameModule, typeOfCopy);
 154         return copy;
 155     }
 156
 157     private boolean isSupportedAsShorthandCase() {
 158         final Collection<?> supportedCaseShorthands = getFromNamespace(ValidationBundlesNamespace.class,
 159                 ValidationBundleType.SUPPORTED_CASE_SHORTHANDS);
 160         return supportedCaseShorthands == null || supportedCaseShorthands.contains(getPublicDefinition());
 161     }
 162
 163     private SchemaPath createSchemaPath() {
 164         final Optional<SchemaPath> maybeParentPath = parent.getSchemaPath();
 165         Verify.verify(maybeParentPath.isPresent(), "Parent %s does not have a SchemaPath", parent);
 166         final SchemaPath parentPath = maybeParentPath.get();
 167
 168         if (argument instanceof QName) {
 169             final QName qname = (QName) argument;
 170             if (StmtContextUtils.producesDeclared(this, UsesStatement.class)) {
 171                 return maybeParentPath.orNull();
 172             }
 173
 174             final SchemaPath path;
 175             if ((StmtContextUtils.producesDeclared(getParentContext(), ChoiceStatement.class)
 176                     || Boolean.TRUE.equals(parent.getFromNamespace(AugmentToChoiceNamespace.class, parent)))
 177                     && isSupportedAsShorthandCase()) {
 178                 path = parentPath.createChild(qname);
 179             } else {
 180                 path = parentPath;
 181             }
 182             return path.createChild(qname);
 183         }
 184         if (argument instanceof String) {
 185             // FIXME: This may yield illegal argument exceptions
 186             final StatementContextBase<?, ?, ?> originalCtx = getOriginalCtx();
 187             final QName qname = (originalCtx != null) ? Utils.qNameFromArgument(originalCtx, (String) argument) : Utils
 188                     .qNameFromArgument(this, (String) argument);
 189             return parentPath.createChild(qname);
 190         }
 191         if (argument instanceof SchemaNodeIdentifier
 192                 && (StmtContextUtils.producesDeclared(this, AugmentStatement.class) || StmtContextUtils
 193                         .producesDeclared(this, RefineStatement.class))) {
 194
 195             return parentPath.createChild(((SchemaNodeIdentifier) argument).getPathFromRoot());
 196         }
 197         if (Utils.isUnknownNode(this)) {
 198             return parentPath.createChild(getPublicDefinition().getStatementName());
 199         }
 200
 201         // FIXME: this does not look right
 202         return maybeParentPath.orNull();
 203     }
 204
 205     @Override
 206     public Optional<SchemaPath> getSchemaPath() {
 207         SchemaPath local = schemaPath;
 208         if (local == null) {
 209             synchronized (this) {
 210                 local = schemaPath;
 211                 if (local == null) {
 212                     local = createSchemaPath();
 213                     schemaPath = local;
 214                 }
 215             }
 216
 217         }
 218
 219         return Optional.fromNullable(local);
 220     }
 221
 222     @Override
 223     public boolean isRootContext() {
 224         return false;
 225     }
 226
 227     @Override
 228     public boolean isConfiguration() {
 229         final StmtContext<Boolean, ?, ?> configStatement = StmtContextUtils.findFirstSubstatement(this,
 230                 ConfigStatement.class);
 231
 232         /*
 233          * If "config" statement is not specified, the default is the same as
 234          * the parent schema node's "config" value.
 235          */
 236         if (configStatement == null) {
 237             return parent.isConfiguration();
 238         }
 239
 240         /*
 241          * If a parent node has "config" set to "true", the node underneath it
 242          * can have "config" set to "true" or "false".
 243          */
 244         if (parent.isConfiguration()) {
 245             return configStatement.getStatementArgument();
 246         }
 247
 248         /*
 249          * If a parent node has "config" set to "false", no node underneath it
 250          * can have "config" set to "true", therefore only "false" is permitted.
 251          */
 252         if (!configStatement.getStatementArgument()) {
 253             return false;
 254         }
 255
 256         throw new InferenceException(
 257                 "Parent node has config statement set to false, therefore no node underneath it can have config set to true",
 258                 getStatementSourceReference());
 259     }
 260
 261     @Override
 262     public boolean isEnabledSemanticVersioning() {
 263         return parent.isEnabledSemanticVersioning();
 264     }
 265 }