2 * Copyright (c) 2015 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.yangtools.yang.parser.stmt.reactor;
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.validation.ValidationBundlesNamespace;
33 import org.opendaylight.yangtools.yang.parser.spi.validation.ValidationBundlesNamespace.ValidationBundleType;
34 import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.GroupingUtils;
35 import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.Utils;
37 final class SubstatementContext<A, D extends DeclaredStatement<A>, E extends EffectiveStatement<A, D>>
38 extends StatementContextBase<A, D, E> {
40 private final StatementContextBase<?, ?, ?> parent;
41 private final A argument;
42 private volatile SchemaPath schemaPath;
44 SubstatementContext(final StatementContextBase<?, ?, ?> parent, final ContextBuilder<A, D, E> builder) {
46 this.parent = Preconditions.checkNotNull(parent, "Parent must not be null");
47 this.argument = builder.getDefinition().parseArgumentValue(this, builder.getRawArgument());
50 @SuppressWarnings("unchecked")
51 SubstatementContext(final SubstatementContext<A, D, E> original,
52 final QNameModule newQNameModule,
53 final StatementContextBase<?, ?, ?> newParent, final TypeOfCopy typeOfCopy) {
55 this.parent = newParent;
57 if (newQNameModule != null) {
58 if (original.argument instanceof QName) {
59 QName originalQName = (QName) original.argument;
61 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,
68 this.argument = original.argument;
71 this.argument = original.argument;
76 private void copyDeclaredStmts(final SubstatementContext<A, D, E> original,
77 final QNameModule newQNameModule, final TypeOfCopy typeOfCopy) {
78 Collection<? extends StatementContextBase<?, ?, ?>> originalDeclaredSubstatements = original
79 .declaredSubstatements();
80 for (StatementContextBase<?, ?, ?> stmtContext : originalDeclaredSubstatements) {
81 if (GroupingUtils.needToCopyByUses(stmtContext)) {
82 StatementContextBase<?, ?, ?> copy = stmtContext.createCopy(
83 newQNameModule, this, typeOfCopy);
84 this.addEffectiveSubstatement(copy);
85 } else if (GroupingUtils.isReusedByUses(stmtContext)) {
86 this.addEffectiveSubstatement(stmtContext);
91 private void copyEffectiveStmts(final SubstatementContext<A, D, E> original,
92 final QNameModule newQNameModule, final TypeOfCopy typeOfCopy) {
93 Collection<? extends StatementContextBase<?, ?, ?>> originalEffectiveSubstatements = original
94 .effectiveSubstatements();
95 for (StatementContextBase<?, ?, ?> stmtContext : originalEffectiveSubstatements) {
96 if (GroupingUtils.needToCopyByUses(stmtContext)) {
97 StatementContextBase<?, ?, ?> copy = stmtContext.createCopy(
98 newQNameModule, this, typeOfCopy);
99 this.addEffectiveSubstatement(copy);
100 } else if (GroupingUtils.isReusedByUses(stmtContext)) {
101 this.addEffectiveSubstatement(stmtContext);
107 public StatementContextBase<?, ?, ?> getParentContext() {
112 public NamespaceStorageNode getParentNamespaceStorage() {
117 public Registry getBehaviourRegistry() {
118 return parent.getBehaviourRegistry();
122 public RootStatementContext<?, ?, ?> getRoot() {
123 return parent.getRoot();
127 public A getStatementArgument() {
132 public StatementContextBase<?, ?, ?> createCopy(
133 final StatementContextBase<?, ?, ?> newParent, final TypeOfCopy typeOfCopy) {
134 return createCopy(null, newParent, typeOfCopy);
138 public StatementContextBase<A, D, E> createCopy(final QNameModule newQNameModule,
139 final StatementContextBase<?, ?, ?> newParent, final TypeOfCopy typeOfCopy) {
140 SubstatementContext<A, D, E> copy = new SubstatementContext<>(this, newQNameModule, newParent, typeOfCopy);
142 copy.addAllToCopyHistory(this.getCopyHistory());
143 copy.addToCopyHistory(typeOfCopy);
145 if (this.getOriginalCtx() != null) {
146 copy.setOriginalCtx(this.getOriginalCtx());
148 copy.setOriginalCtx(this);
151 definition().onStatementAdded(copy);
153 copy.copyDeclaredStmts(this, newQNameModule, typeOfCopy);
154 copy.copyEffectiveStmts(this, newQNameModule, typeOfCopy);
158 private boolean isSupportedAsShorthandCase() {
159 final Collection<?> supportedCaseShorthands = getFromNamespace(ValidationBundlesNamespace.class,
160 ValidationBundleType.SUPPORTED_CASE_SHORTHANDS);
161 return supportedCaseShorthands == null || supportedCaseShorthands.contains(getPublicDefinition());
164 private SchemaPath createSchemaPath() {
165 final Optional<SchemaPath> maybeParentPath = parent.getSchemaPath();
166 Verify.verify(maybeParentPath.isPresent(), "Parent %s does not have a SchemaPath", parent);
167 final SchemaPath parentPath = maybeParentPath.get();
169 if (argument instanceof QName) {
170 QName qname = (QName) argument;
171 if (StmtContextUtils.producesDeclared(this, UsesStatement.class)) {
172 return maybeParentPath.orNull();
175 final SchemaPath path;
176 if (StmtContextUtils.producesDeclared(getParentContext(), ChoiceStatement.class)
177 && isSupportedAsShorthandCase()) {
178 path = parentPath.createChild(qname);
182 return path.createChild(qname);
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)
188 : Utils.qNameFromArgument(this, (String) argument);
189 return parentPath.createChild(qname);
191 if (argument instanceof SchemaNodeIdentifier &&
192 (StmtContextUtils.producesDeclared(this, AugmentStatement.class)
193 || StmtContextUtils.producesDeclared(this, RefineStatement.class))) {
195 return parentPath.createChild(((SchemaNodeIdentifier) argument).getPathFromRoot());
197 if (Utils.isUnknownNode(this)) {
198 return parentPath.createChild(getPublicDefinition().getStatementName());
201 // FIXME: this does not look right
202 return maybeParentPath.orNull();
206 public Optional<SchemaPath> getSchemaPath() {
207 SchemaPath local = schemaPath;
209 synchronized (this) {
212 local = createSchemaPath();
219 return Optional.fromNullable(local);
223 public boolean isRootContext() {
228 public boolean isConfiguration() {
229 StmtContext<Boolean, ?, ?> configStatement = StmtContextUtils
230 .findFirstSubstatement(this, ConfigStatement.class);
233 * If "config" statement is not specified, the default is the same as
234 * the parent schema node's "config" value.
236 if (configStatement == null) {
237 return parent.isConfiguration();
241 * If a parent node has "config" set to "true", the node underneath it can
242 * have "config" set to "true" or "false".
244 if (parent.isConfiguration()) {
245 return configStatement.getStatementArgument();
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.
252 if (!configStatement.getStatementArgument()) {
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());