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