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