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 com.google.common.base.Verify.verify;
12 import static com.google.common.base.Verify.verifyNotNull;
14 import java.util.Collection;
15 import java.util.stream.Stream;
16 import org.eclipse.jdt.annotation.NonNull;
17 import org.eclipse.jdt.annotation.Nullable;
18 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
19 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
20 import org.opendaylight.yangtools.yang.model.api.meta.StatementDefinition;
21 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase;
22 import org.opendaylight.yangtools.yang.parser.spi.meta.StatementFactory;
23 import org.opendaylight.yangtools.yang.parser.spi.meta.StatementSupport;
24 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
25 import org.opendaylight.yangtools.yang.parser.spi.source.StatementSourceReference;
26 import org.opendaylight.yangtools.yang.parser.spi.source.StatementWriter.ResumedStatement;
29 * Intermediate subclass of StatementContextBase facing the parser stream via implementation of ResumedStatement. This
30 * shields inference-type substatements from these details.
32 * @param <A> Argument type
33 * @param <D> Declared Statement representation
34 * @param <E> Effective Statement representation
36 abstract class AbstractResumedStatement<A, D extends DeclaredStatement<A>, E extends EffectiveStatement<A, D>>
37 extends OriginalStmtCtx<A, D, E> implements ResumedStatement {
38 private final String rawArgument;
40 private StatementMap substatements = StatementMap.empty();
41 private @Nullable D declaredInstance;
42 private boolean implicitDeclared;
45 AbstractResumedStatement(final AbstractResumedStatement<A, D, E> original) {
47 this.rawArgument = original.rawArgument;
48 this.substatements = original.substatements;
49 this.declaredInstance = original.declaredInstance;
52 AbstractResumedStatement(final StatementDefinitionContext<A, D, E> def, final StatementSourceReference ref,
53 final String rawArgument) {
55 this.rawArgument = def.support().internArgument(rawArgument);
59 public final String rawArgument() {
64 public Collection<? extends StatementContextBase<?, ?, ?>> mutableDeclaredSubstatements() {
65 return verifyNotNull(substatements);
69 public final D declared() {
71 return (existing = declaredInstance) != null ? existing : loadDeclared();
74 private @NonNull D loadDeclared() {
75 final ModelProcessingPhase phase = getCompletedPhase();
76 checkState(phase == ModelProcessingPhase.FULL_DECLARATION || phase == ModelProcessingPhase.EFFECTIVE_MODEL,
77 "Cannot build declared instance after phase %s", phase);
78 return declaredInstance = definition().getFactory().createDeclared(this, substatementsAsDeclared());
81 @SuppressWarnings({ "rawtypes", "unchecked" })
82 private @NonNull Stream<DeclaredStatement<?>> substatementsAsDeclared() {
83 final Stream<AbstractResumedStatement<?, ?, ?>> stream;
84 if (implicitDeclared) {
85 stream = substatements.stream().map(AbstractResumedStatement::unmaskUndeclared);
87 stream = (Stream) substatements.stream();
90 return stream.map(AbstractResumedStatement::declared);
94 public final StatementDefinition getDefinition() {
95 return publicDefinition();
99 public final StatementSourceReference getSourceReference() {
100 return sourceReference();
104 public final boolean isFullyDefined() {
105 return fullyDefined();
109 final E createEffective(final StatementFactory<A, D, E> factory) {
110 return createEffective(factory, this, streamDeclared(), streamEffective());
113 // Creates EffectiveStatement through full materialization and assumes declared statement presence
114 private @NonNull E createEffective(final StatementFactory<A, D, E> factory,
115 final StatementContextBase<A, D, E> ctx, final Stream<? extends StmtContext<?, ?, ?>> declared,
116 final Stream<? extends StmtContext<?, ?, ?>> effective) {
117 // Statement reference count infrastructure makes an assumption that effective statement is only built after
118 // the declared statement is already done. Statements tracked by this class always have a declared view, and
119 // we need to ensure that is built before we touch effective substatements.
121 // Once the effective substatement stream has been exhausted, reference counting will triggers a sweep, hence
122 // the substatements may be gone by the time the factory attempts to acquire the declared statement.
125 return factory.createEffective(ctx, declared, effective);
129 final E createInferredEffective(final StatementFactory<A, D, E> factory,
130 final InferredStatementContext<A, D, E> ctx, final Stream<? extends StmtContext<?, ?, ?>> declared,
131 final Stream<? extends StmtContext<?, ?, ?>> effective) {
132 return createEffective(factory, ctx, declared, effective);
136 * Create a new substatement at the specified offset.
138 * @param offset Substatement offset
139 * @param def definition context
140 * @param ref source reference
141 * @param argument statement argument
142 * @param <X> new substatement argument type
143 * @param <Y> new substatement declared type
144 * @param <Z> new substatement effective type
145 * @return A new substatement
147 @SuppressWarnings("checkstyle:methodTypeParameterName")
148 final <X, Y extends DeclaredStatement<X>, Z extends EffectiveStatement<X, Y>>
149 AbstractResumedStatement<X, Y, Z> createSubstatement(final int offset,
150 final StatementDefinitionContext<X, Y, Z> def, final StatementSourceReference ref,
151 final String argument) {
152 final ModelProcessingPhase inProgressPhase = getRoot().getSourceContext().getInProgressPhase();
153 checkState(inProgressPhase != ModelProcessingPhase.EFFECTIVE_MODEL,
154 "Declared statement cannot be added in effective phase at: %s", sourceReference());
156 final SubstatementContext<X, Y, Z> ret;
157 final var implicitParent = definition().getImplicitParentFor(this, def.getPublicView());
158 if (implicitParent.isPresent()) {
159 implicitDeclared = true;
160 final var parent = createUndeclared(offset, implicitParent.orElseThrow(), ref, argument);
161 ret = new SubstatementContext<>(parent, def, ref, argument);
162 parent.addEffectiveSubstatement(ret);
164 ret = new SubstatementContext<>(this, def, ref, argument);
165 substatements = substatements.put(offset, ret);
168 def.onStatementAdded(ret);
172 private <X, Y extends DeclaredStatement<X>, Z extends EffectiveStatement<X, Y>>
173 UndeclaredStmtCtx<X, Y, Z> createUndeclared(final int offset, final StatementSupport<X, Y, Z> support,
174 final StatementSourceReference ref, final String argument) {
175 final UndeclaredStmtCtx<X, Y, Z> ret;
176 final var implicitParent = definition().getImplicitParentFor(this, support.getPublicView());
177 if (implicitParent.isPresent()) {
178 final var parent = createUndeclared(offset, implicitParent.orElseThrow(), ref, argument);
179 ret = new UndeclaredStmtCtx<>(parent, support, argument);
180 parent.addEffectiveSubstatement(ret);
182 ret = new UndeclaredStmtCtx<>(this, support, argument);
183 substatements = substatements.put(offset, ret);
185 support.onStatementAdded(ret);
190 final Stream<? extends @NonNull StmtContext<?, ?, ?>> streamDeclared() {
191 return substatements.stream().filter(StmtContext::isSupportedToBuildEffective);
195 final void dropDeclaredSubstatements() {
196 substatements = null;
200 * Attempt to lookup a declared substatement by its offset in this statement, passing through any implicit
201 * statements which have been created to encapsulate it.
203 * @param offset Substatement offset
204 * @return Substatement, or null if substatement does not exist.
206 final @Nullable AbstractResumedStatement<?, ?, ?> enterSubstatement(final int offset) {
207 final var stmt = substatements.get(offset);
208 return stmt == null ? null : unmaskUndeclared(stmt);
211 private static @NonNull AbstractResumedStatement<?, ?, ?> unmaskUndeclared(final ReactorStmtCtx<?, ?, ?> stmt) {
213 while (!(ret instanceof AbstractResumedStatement)) {
214 verify(ret instanceof UndeclaredStmtCtx, "Unexpectred statement %s", ret);
215 ret = ((UndeclaredStmtCtx<?, ?, ?>) ret).getResumedSubstatement();
217 return (AbstractResumedStatement<?, ?, ?>) ret;
221 * End the specified phase for this statement and return this statement's declared parent statement.
223 * @param phase processing phase that ended
224 * @return Declared parent statement
226 final @Nullable AbstractResumedStatement<?, ?, ?> exitStatement(final ModelProcessingPhase phase) {
227 finishDeclaration(phase);
228 final var parent = getParentContext();
229 if (parent == null) {
233 var ret = verifyParent(parent);
234 // Unwind all undeclared statements
235 while (!(ret instanceof AbstractResumedStatement)) {
236 ret.finishDeclaration(phase);
237 ret = verifyParent(ret.getParentContext());
239 return (AbstractResumedStatement<?, ?, ?>) ret;
242 // FIXME: AbstractResumedStatement should only ever have OriginalStmtCtx parents, which would remove the need for
243 // this method. In ordered to do that we need to untangle SubstatementContext's users and do not allow it
244 // being reparent()ed.
245 private static OriginalStmtCtx<?, ?, ?> verifyParent(final StatementContextBase<?, ?, ?> parent) {
246 verify(parent instanceof OriginalStmtCtx, "Unexpected parent context %s", parent);
247 return (OriginalStmtCtx<?, ?, ?>) parent;
250 final void resizeSubstatements(final int expectedSize) {
251 substatements = substatements.ensureCapacity(expectedSize);
255 final void declarationFinished(final ModelProcessingPhase phase) {
256 finishChildrenDeclaration(phase);
257 finishDeclaration(phase);
260 private void finishChildrenDeclaration(final ModelProcessingPhase phase) {
261 checkState(isFullyDefined());
262 substatements.forEach(stmt -> stmt.declarationFinished(phase));