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.Preconditions;
11 import com.google.common.base.Verify;
12 import java.util.Collection;
13 import java.util.Optional;
14 import javax.annotation.Nonnull;
15 import org.opendaylight.yangtools.util.OptionalBoolean;
16 import org.opendaylight.yangtools.yang.common.QName;
17 import org.opendaylight.yangtools.yang.common.QNameModule;
18 import org.opendaylight.yangtools.yang.common.YangVersion;
19 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
20 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
21 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
22 import org.opendaylight.yangtools.yang.model.api.stmt.AugmentStatement;
23 import org.opendaylight.yangtools.yang.model.api.stmt.ChoiceStatement;
24 import org.opendaylight.yangtools.yang.model.api.stmt.ConfigStatement;
25 import org.opendaylight.yangtools.yang.model.api.stmt.DeviationStatement;
26 import org.opendaylight.yangtools.yang.model.api.stmt.RefineStatement;
27 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier;
28 import org.opendaylight.yangtools.yang.model.api.stmt.UsesStatement;
29 import org.opendaylight.yangtools.yang.model.repo.api.SourceIdentifier;
30 import org.opendaylight.yangtools.yang.parser.spi.meta.CopyType;
31 import org.opendaylight.yangtools.yang.parser.spi.meta.InferenceException;
32 import org.opendaylight.yangtools.yang.parser.spi.meta.MutableStatement;
33 import org.opendaylight.yangtools.yang.parser.spi.meta.NamespaceBehaviour.NamespaceStorageNode;
34 import org.opendaylight.yangtools.yang.parser.spi.meta.NamespaceBehaviour.Registry;
35 import org.opendaylight.yangtools.yang.parser.spi.meta.NamespaceBehaviour.StorageNodeType;
36 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
37 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
38 import org.opendaylight.yangtools.yang.parser.spi.source.AugmentToChoiceNamespace;
39 import org.opendaylight.yangtools.yang.parser.spi.source.StatementSourceReference;
40 import org.opendaylight.yangtools.yang.parser.spi.validation.ValidationBundlesNamespace;
41 import org.opendaylight.yangtools.yang.parser.spi.validation.ValidationBundlesNamespace.ValidationBundleType;
43 final class SubstatementContext<A, D extends DeclaredStatement<A>, E extends EffectiveStatement<A, D>> extends
44 StatementContextBase<A, D, E> {
45 private final StatementContextBase<?, ?, ?> parent;
46 private final A argument;
49 * Config statements are not all that common which means we are performing a recursive search towards the root
50 * every time {@link #isConfiguration()} is invoked. This is quite expensive because it causes a linear search
51 * for the (usually non-existent) config statement.
54 * This field maintains a resolution cache, so once we have returned a result, we will keep on returning the same
55 * result without performing any lookups.
58 private byte configuration;
61 * This field maintains a resolution cache for ignore config, so once we have returned a result, we will
62 * keep on returning the same result without performing any lookups.
65 private byte ignoreConfig;
68 * This field maintains a resolution cache for ignore if-feature, so once we have returned a result, we will
69 * keep on returning the same result without performing any lookups.
72 private byte ignoreIfFeature;
74 private volatile SchemaPath schemaPath;
76 SubstatementContext(final StatementContextBase<?, ?, ?> parent, final StatementDefinitionContext<A, D, E> def,
77 final StatementSourceReference ref, final String rawArgument) {
78 super(def, ref, rawArgument);
79 this.parent = Preconditions.checkNotNull(parent, "Parent must not be null");
80 this.argument = def.parseArgumentValue(this, rawStatementArgument());
83 SubstatementContext(final StatementContextBase<A, D, E> original, final StatementContextBase<?, ?, ?> parent,
84 final CopyType copyType, final QNameModule targetModule) {
85 super(original, copyType);
86 this.parent = Preconditions.checkNotNull(parent);
87 this.argument = targetModule == null ? original.getStatementArgument()
88 : original.definition().adaptArgumentValue(original, targetModule);
92 public StatementContextBase<?, ?, ?> getParentContext() {
97 public StorageNodeType getStorageNodeType() {
98 return StorageNodeType.STATEMENT_LOCAL;
102 public NamespaceStorageNode getParentNamespaceStorage() {
107 public Registry getBehaviourRegistry() {
108 return parent.getBehaviourRegistry();
113 public RootStatementContext<?, ?, ?> getRoot() {
114 return parent.getRoot();
118 public A getStatementArgument() {
122 private boolean isSupportedAsShorthandCase() {
123 final Collection<?> supportedCaseShorthands = getFromNamespace(ValidationBundlesNamespace.class,
124 ValidationBundleType.SUPPORTED_CASE_SHORTHANDS);
125 return supportedCaseShorthands == null || supportedCaseShorthands.contains(getPublicDefinition());
128 private SchemaPath createSchemaPath() {
129 final Optional<SchemaPath> maybeParentPath = parent.getSchemaPath();
130 Verify.verify(maybeParentPath.isPresent(), "Parent %s does not have a SchemaPath", parent);
131 final SchemaPath parentPath = maybeParentPath.get();
133 if (StmtContextUtils.isUnknownStatement(this)) {
134 return parentPath.createChild(getPublicDefinition().getStatementName());
136 if (argument instanceof QName) {
137 final QName qname = (QName) argument;
138 if (StmtContextUtils.producesDeclared(this, UsesStatement.class)) {
139 return maybeParentPath.orElse(null);
142 final SchemaPath path;
143 if ((StmtContextUtils.producesDeclared(getParentContext(), ChoiceStatement.class)
144 || Boolean.TRUE.equals(parent.getFromNamespace(AugmentToChoiceNamespace.class, parent)))
145 && isSupportedAsShorthandCase()) {
146 path = parentPath.createChild(qname);
150 return path.createChild(qname);
152 if (argument instanceof String) {
153 // FIXME: This may yield illegal argument exceptions
154 final Optional<StmtContext<?, ?, ?>> originalCtx = getOriginalCtx();
155 final QName qname = StmtContextUtils.qnameFromArgument(originalCtx.orElse(this), (String) argument);
156 return parentPath.createChild(qname);
158 if (argument instanceof SchemaNodeIdentifier
159 && (StmtContextUtils.producesDeclared(this, AugmentStatement.class)
160 || StmtContextUtils.producesDeclared(this, RefineStatement.class)
161 || StmtContextUtils.producesDeclared(this, DeviationStatement.class))) {
163 return parentPath.createChild(((SchemaNodeIdentifier) argument).getPathFromRoot());
166 // FIXME: this does not look right
167 return maybeParentPath.orElse(null);
172 public Optional<SchemaPath> getSchemaPath() {
173 SchemaPath local = schemaPath;
175 synchronized (this) {
178 local = createSchemaPath();
184 return Optional.ofNullable(local);
188 public boolean isConfiguration() {
189 if (isIgnoringConfig()) {
193 if (OptionalBoolean.isPresent(configuration)) {
194 return OptionalBoolean.get(configuration);
197 final StmtContext<Boolean, ?, ?> configStatement = StmtContextUtils.findFirstSubstatement(this,
198 ConfigStatement.class);
199 final boolean parentIsConfig = parent.isConfiguration();
201 final boolean isConfig;
202 if (configStatement != null) {
203 isConfig = configStatement.getStatementArgument();
205 // Validity check: if parent is config=false this cannot be a config=true
206 InferenceException.throwIf(isConfig && !parentIsConfig, getStatementSourceReference(),
207 "Parent node has config=false, this node must not be specifed as config=true");
209 // If "config" statement is not specified, the default is the same as the parent's "config" value.
210 isConfig = parentIsConfig;
213 // Resolved, make sure we cache this return
214 configuration = OptionalBoolean.of(isConfig);
219 public boolean isEnabledSemanticVersioning() {
220 return parent.isEnabledSemanticVersioning();
224 public YangVersion getRootVersion() {
225 return getRoot().getRootVersion();
229 public void setRootVersion(final YangVersion version) {
230 getRoot().setRootVersion(version);
234 public void addMutableStmtToSeal(final MutableStatement mutableStatement) {
235 getRoot().addMutableStmtToSeal(mutableStatement);
239 public void addRequiredSource(final SourceIdentifier dependency) {
240 getRoot().addRequiredSource(dependency);
244 public void setRootIdentifier(final SourceIdentifier identifier) {
245 getRoot().setRootIdentifier(identifier);
249 protected boolean isIgnoringIfFeatures() {
250 if (OptionalBoolean.isPresent(ignoreIfFeature)) {
251 return OptionalBoolean.get(ignoreIfFeature);
254 final boolean ret = definition().isIgnoringIfFeatures() || parent.isIgnoringIfFeatures();
255 ignoreIfFeature = OptionalBoolean.of(ret);
261 protected boolean isIgnoringConfig() {
262 if (OptionalBoolean.isPresent(ignoreConfig)) {
263 return OptionalBoolean.get(ignoreConfig);
266 final boolean ret = definition().isIgnoringConfig() || parent.isIgnoringConfig();
267 ignoreConfig = OptionalBoolean.of(ret);
273 protected boolean isParentSupportedByFeatures() {
274 return parent.isSupportedByFeatures();