2 * Copyright (c) 2020 PANTHEON.tech, s.r.o. 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 static java.util.Objects.requireNonNull;
12 import com.google.common.collect.ImmutableList;
13 import com.google.common.collect.ImmutableSet;
14 import java.util.ArrayList;
15 import java.util.Collection;
16 import java.util.List;
17 import java.util.Optional;
18 import java.util.stream.Stream;
19 import org.eclipse.jdt.annotation.NonNull;
20 import org.opendaylight.yangtools.yang.common.QNameModule;
21 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
22 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
23 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
24 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
25 import org.opendaylight.yangtools.yang.model.api.meta.StatementDefinition;
26 import org.opendaylight.yangtools.yang.parser.spi.meta.CopyHistory;
27 import org.opendaylight.yangtools.yang.parser.spi.meta.CopyType;
28 import org.opendaylight.yangtools.yang.parser.spi.meta.NamespaceBehaviour.NamespaceStorageNode;
29 import org.opendaylight.yangtools.yang.parser.spi.meta.NamespaceBehaviour.StorageNodeType;
30 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
31 import org.opendaylight.yangtools.yang.parser.spi.source.StatementSourceReference;
32 import org.slf4j.Logger;
33 import org.slf4j.LoggerFactory;
36 * A statement which has been inferred to exist. Functionally it is equivalent to a SubstatementContext, but it is not
37 * backed by a declaration (and declared statements). It is backed by a prototype StatementContextBase and has only
38 * effective substatements, which are either transformed from that prototype or added by inference.
40 final class InferredStatementContext<A, D extends DeclaredStatement<A>, E extends EffectiveStatement<A, D>>
41 extends StatementContextBase<A, D, E> {
42 private static final Logger LOG = LoggerFactory.getLogger(InferredStatementContext.class);
44 private final @NonNull StatementContextBase<A, D, E> prototype;
45 private final @NonNull StatementContextBase<?, ?, ?> parent;
46 private final @NonNull CopyType childCopyType;
47 private final QNameModule targetModule;
48 private final A argument;
50 private InferredStatementContext(final InferredStatementContext<A, D, E> original,
51 final StatementContextBase<?, ?, ?> parent) {
53 this.parent = requireNonNull(parent);
54 this.childCopyType = original.childCopyType;
55 this.targetModule = original.targetModule;
56 this.prototype = original.prototype;
57 this.argument = original.argument;
60 InferredStatementContext(final StatementContextBase<?, ?, ?> parent, final StatementContextBase<A, D, E> prototype,
61 final CopyType myCopyType, final CopyType childCopyType, final QNameModule targetModule) {
62 super(prototype.definition(), CopyHistory.of(myCopyType, prototype.getCopyHistory()));
63 this.parent = requireNonNull(parent);
64 this.prototype = requireNonNull(prototype);
65 this.argument = targetModule == null ? prototype.getStatementArgument()
66 : prototype.definition().adaptArgumentValue(prototype, targetModule);
67 this.childCopyType = requireNonNull(childCopyType);
68 this.targetModule = targetModule;
70 // FIXME: YANGTOOLS-784: instantiate these lazily
71 addEffectiveSubstatements(createEffective());
75 public Collection<? extends StatementContextBase<?, ?, ?>> mutableDeclaredSubstatements() {
76 return ImmutableList.of();
80 public Iterable<? extends StmtContext<?, ?, ?>> allSubstatements() {
81 // No need to concat with declared
82 return effectiveSubstatements();
86 public Stream<? extends StmtContext<?, ?, ?>> allSubstatementsStream() {
87 // No need to concat with declared
88 return effectiveSubstatements().stream();
92 public StatementSourceReference getStatementSourceReference() {
93 return prototype.getStatementSourceReference();
97 public String rawStatementArgument() {
98 return prototype.rawStatementArgument();
102 public Optional<StmtContext<?, ?, ?>> getOriginalCtx() {
103 final Optional<StmtContext<?, ?, ?>> orig = prototype.getOriginalCtx();
104 return orig.isPresent() ? orig : Optional.of(prototype);
108 public Optional<? extends StmtContext<?, ?, ?>> getPreviousCopyCtx() {
109 return Optional.of(prototype);
114 return prototype.buildDeclared();
118 InferredStatementContext<A, D, E> reparent(final StatementContextBase<?, ?, ?> newParent) {
119 return new InferredStatementContext<>(this, newParent);
122 // Instantiate this statement's effective substatements. Note this method has side-effects in namespaces and overall
123 // BuildGlobalContext, hence it must be called at most once.
124 private List<Mutable<?, ?, ?>> createEffective() {
125 final Collection<? extends StatementContextBase<?, ?, ?>> declared = prototype.mutableDeclaredSubstatements();
126 final Collection<? extends Mutable<?, ?, ?>> effective = prototype.mutableEffectiveSubstatements();
127 final List<Mutable<?, ?, ?>> buffer = new ArrayList<>(declared.size() + effective.size());
129 for (final Mutable<?, ?, ?> stmtContext : declared) {
130 if (stmtContext.isSupportedByFeatures()) {
131 copySubstatement(stmtContext, buffer);
134 for (final Mutable<?, ?, ?> stmtContext : effective) {
135 copySubstatement(stmtContext, buffer);
141 // Statement copy mess starts here
143 // FIXME: This is messy and is probably wrong in some corner case. Even if it is correct, the way how it is correct
144 // relies on hard-coded maps. At the end of the day, the logic needs to be controlled by statement's
146 // FIXME: YANGTOOLS-652: these maps look very much like those in UsesStatementImpl
147 private static final ImmutableSet<YangStmtMapping> REUSED_DEF_SET = ImmutableSet.of(
148 YangStmtMapping.TYPE,
149 YangStmtMapping.TYPEDEF,
150 YangStmtMapping.USES);
151 private static final ImmutableSet<YangStmtMapping> NOCOPY_FROM_GROUPING_SET = ImmutableSet.of(
152 YangStmtMapping.DESCRIPTION,
153 YangStmtMapping.REFERENCE,
154 YangStmtMapping.STATUS);
156 private void copySubstatement(final Mutable<?, ?, ?> substatement, final Collection<Mutable<?, ?, ?>> buffer) {
157 final StatementDefinition def = substatement.getPublicDefinition();
159 // FIXME: YANGTOOLS-652: formerly known as "isReusedByUses"
160 if (REUSED_DEF_SET.contains(def)) {
161 LOG.debug("Reusing substatement {} for {}", substatement, this);
162 buffer.add(substatement);
165 // FIXME: YANGTOOLS-652: formerly known as "needToCopyByUses" (note inverted check, though)
166 if (NOCOPY_FROM_GROUPING_SET.contains(def)) {
167 // This is to say: if parent of source context is a grouping, ignore this statement.
168 if (YangStmtMapping.GROUPING.equals(substatement.coerceParentContext().getPublicDefinition())) {
169 LOG.debug("Skipping grouping statement {}", substatement);
174 // FIXME: YANGTOOLS-694: we are forcing a copy here, hence even statements not affected by parent, copyType
175 // or targetModule (and don't forget its substatements!). This really should be a callout
176 // to StatementSupport. Note if that callout is allowed to return an Optional, it can
177 // take care at least of the 'grouping from uses' case above.
178 final Mutable<?, ?, ?> copy = childCopyOf(substatement, childCopyType, targetModule);
179 LOG.debug("Copying substatement {} for {} as {}", substatement, this, copy);
183 // Statement copy mess ends here
186 * KEEP THINGS ORGANIZED!
188 * below methods exist in the same form in SubstatementContext. If any adjustment is made here, make sure it is
189 * properly updated there.
192 public Optional<SchemaPath> getSchemaPath() {
193 return substatementGetSchemaPath();
197 public A getStatementArgument() {
202 public StatementContextBase<?, ?, ?> getParentContext() {
207 public StorageNodeType getStorageNodeType() {
208 return StorageNodeType.STATEMENT_LOCAL;
212 public NamespaceStorageNode getParentNamespaceStorage() {
217 public RootStatementContext<?, ?, ?> getRoot() {
218 return parent.getRoot();
222 public boolean isConfiguration() {
223 return isConfiguration(parent);
227 protected boolean isIgnoringIfFeatures() {
228 return isIgnoringIfFeatures(parent);
232 protected boolean isIgnoringConfig() {
233 return isIgnoringConfig(parent);
237 protected boolean isParentSupportedByFeatures() {
238 return parent.isSupportedByFeatures();