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 com.google.common.base.Preconditions.checkState;
11 import static java.util.Objects.requireNonNull;
13 import com.google.common.collect.ImmutableList;
14 import java.util.Collection;
15 import java.util.List;
16 import java.util.Optional;
17 import java.util.stream.Stream;
18 import org.eclipse.jdt.annotation.NonNull;
19 import org.eclipse.jdt.annotation.Nullable;
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.meta.StatementDefinition;
23 import org.opendaylight.yangtools.yang.parser.spi.meta.CopyHistory;
24 import org.opendaylight.yangtools.yang.parser.spi.meta.CopyType;
25 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase;
26 import org.opendaylight.yangtools.yang.parser.spi.meta.StatementSupport;
27 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
28 import org.opendaylight.yangtools.yang.parser.spi.source.ImplicitSubstatement;
29 import org.opendaylight.yangtools.yang.parser.spi.source.StatementSourceReference;
30 import org.opendaylight.yangtools.yang.parser.spi.source.StatementWriter.ResumedStatement;
33 * Intermediate subclass of StatementContextBase facing the parser stream via implementation of ResumedStatement. This
34 * shields inference-type substatements from these details.
36 * @param <A> Argument type
37 * @param <D> Declared Statement representation
38 * @param <E> Effective Statement representation
40 abstract class AbstractResumedStatement<A, D extends DeclaredStatement<A>, E extends EffectiveStatement<A, D>>
41 extends StatementContextBase<A, D, E> implements ResumedStatement {
42 private final @NonNull StatementSourceReference statementDeclSource;
43 private final String rawArgument;
45 private List<StatementContextBase<?, ?, ?>> effective = ImmutableList.of();
46 private StatementMap substatements = StatementMap.empty();
47 private @Nullable D declaredInstance;
50 AbstractResumedStatement(final AbstractResumedStatement<A, D, E> original) {
52 this.statementDeclSource = original.statementDeclSource;
53 this.rawArgument = original.rawArgument;
54 this.substatements = original.substatements;
55 this.declaredInstance = original.declaredInstance;
58 AbstractResumedStatement(final StatementDefinitionContext<A, D, E> def, final StatementSourceReference ref,
59 final String rawArgument) {
61 this.statementDeclSource = requireNonNull(ref);
62 this.rawArgument = def.support().internArgument(rawArgument);
65 AbstractResumedStatement(final StatementDefinitionContext<A, D, E> def, final StatementSourceReference ref,
66 final String rawArgument, final CopyType copyType) {
67 super(def, CopyHistory.of(copyType, CopyHistory.original()));
68 this.statementDeclSource = requireNonNull(ref);
69 this.rawArgument = rawArgument;
73 public final Optional<StmtContext<A, D, E>> getOriginalCtx() {
74 return Optional.empty();
78 public final Optional<StmtContext<A, D, E>> getPreviousCopyCtx() {
79 return Optional.empty();
83 public final StatementSourceReference getStatementSourceReference() {
84 return statementDeclSource;
88 public final String rawStatementArgument() {
93 public Collection<? extends StatementContextBase<?, ?, ?>> mutableDeclaredSubstatements() {
98 public final Collection<? extends Mutable<?, ?, ?>> mutableEffectiveSubstatements() {
99 return mutableEffectiveSubstatements(effective);
103 public final void removeStatementFromEffectiveSubstatements(final StatementDefinition statementDef) {
104 effective = removeStatementFromEffectiveSubstatements(effective, statementDef);
108 public final void removeStatementFromEffectiveSubstatements(final StatementDefinition statementDef,
109 final String statementArg) {
110 effective = removeStatementFromEffectiveSubstatements(effective, statementDef, statementArg);
114 public final void addEffectiveSubstatement(final Mutable<?, ?, ?> substatement) {
115 effective = addEffectiveSubstatement(effective, substatement);
119 final void addEffectiveSubstatementsImpl(final Collection<? extends Mutable<?, ?, ?>> statements) {
120 effective = addEffectiveSubstatementsImpl(effective, statements);
124 public final D buildDeclared() {
126 return (existing = declaredInstance) != null ? existing : loadDeclared();
129 private @NonNull D loadDeclared() {
130 final ModelProcessingPhase phase = getCompletedPhase();
131 checkState(phase == ModelProcessingPhase.FULL_DECLARATION || phase == ModelProcessingPhase.EFFECTIVE_MODEL,
132 "Cannot build declared instance after phase %s", phase);
133 return declaredInstance = definition().getFactory().createDeclared(this);
137 public @NonNull StatementDefinition getDefinition() {
138 return getPublicDefinition();
142 public @NonNull StatementSourceReference getSourceReference() {
143 return getStatementSourceReference();
147 public boolean isFullyDefined() {
148 return fullyDefined();
152 * Create a new substatement at the specified offset.
154 * @param offset Substatement offset
155 * @param def definition context
156 * @param ref source reference
157 * @param argument statement argument
158 * @param <X> new substatement argument type
159 * @param <Y> new substatement declared type
160 * @param <Z> new substatement effective type
161 * @return A new substatement
163 @SuppressWarnings("checkstyle:methodTypeParameterName")
164 final <X, Y extends DeclaredStatement<X>, Z extends EffectiveStatement<X, Y>>
165 AbstractResumedStatement<X, Y, Z> createSubstatement(final int offset,
166 final StatementDefinitionContext<X, Y, Z> def, final StatementSourceReference ref,
167 final String argument) {
168 final ModelProcessingPhase inProgressPhase = getRoot().getSourceContext().getInProgressPhase();
169 checkState(inProgressPhase != ModelProcessingPhase.EFFECTIVE_MODEL,
170 "Declared statement cannot be added in effective phase at: %s", getStatementSourceReference());
172 final Optional<StatementSupport<?, ?, ?>> implicitParent =
173 definition().getImplicitParentFor(def.getPublicView());
174 if (implicitParent.isPresent()) {
175 return createImplicitParent(offset, implicitParent.get(), ref, argument).createSubstatement(offset, def,
179 final AbstractResumedStatement<X, Y, Z> ret = new SubstatementContext<>(this, def, ref, argument);
180 substatements = substatements.put(offset, ret);
181 def.onStatementAdded(ret);
186 final boolean hasEmptySubstatements() {
187 return substatements.size() == 0 && effective.isEmpty();
191 final Iterable<StatementContextBase<?, ?, ?>> effectiveChildrenToComplete() {
196 final Stream<? extends StmtContext<?, ?, ?>> streamDeclared() {
197 return declaredSubstatements().stream();
201 final Stream<? extends StmtContext<?, ?, ?>> streamEffective() {
202 return effective.stream();
206 * Lookup substatement by its offset in this statement.
208 * @param offset Substatement offset
209 * @return Substatement, or null if substatement does not exist.
211 final AbstractResumedStatement<?, ?, ?> lookupSubstatement(final int offset) {
212 return substatements.get(offset);
215 final void resizeSubstatements(final int expectedSize) {
216 substatements = substatements.ensureCapacity(expectedSize);
219 final void walkChildren(final ModelProcessingPhase phase) {
220 checkState(isFullyDefined());
221 substatements.forEach(stmt -> {
222 stmt.walkChildren(phase);
223 stmt.endDeclared(phase);
227 private AbstractResumedStatement<?, ?, ?> createImplicitParent(final int offset,
228 final StatementSupport<?, ?, ?> implicitParent, final StatementSourceReference ref, final String argument) {
229 final StatementDefinitionContext<?, ?, ?> def = new StatementDefinitionContext<>(implicitParent);
230 return createSubstatement(offset, def, ImplicitSubstatement.of(ref), argument);