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 java.util.Collection;
14 import java.util.Optional;
15 import org.eclipse.jdt.annotation.NonNull;
16 import org.eclipse.jdt.annotation.Nullable;
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.meta.StatementDefinition;
20 import org.opendaylight.yangtools.yang.parser.spi.meta.CopyHistory;
21 import org.opendaylight.yangtools.yang.parser.spi.meta.CopyType;
22 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase;
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.ImplicitSubstatement;
26 import org.opendaylight.yangtools.yang.parser.spi.source.StatementSourceReference;
27 import org.opendaylight.yangtools.yang.parser.spi.source.StatementWriter.ResumedStatement;
30 * Intermediate subclass of StatementContextBase facing the parser stream via implementation of ResumedStatement. This
31 * shields inference-type substatements from these details.
33 * @param <A> Argument type
34 * @param <D> Declared Statement representation
35 * @param <E> Effective Statement representation
37 abstract class AbstractResumedStatement<A, D extends DeclaredStatement<A>, E extends EffectiveStatement<A, D>>
38 extends StatementContextBase<A, D, E> implements ResumedStatement {
39 private final @NonNull StatementSourceReference statementDeclSource;
40 private final String rawArgument;
42 private StatementMap substatements = StatementMap.empty();
43 private @Nullable D declaredInstance;
46 AbstractResumedStatement(final AbstractResumedStatement<A, D, E> original) {
48 this.statementDeclSource = original.statementDeclSource;
49 this.rawArgument = original.rawArgument;
50 this.substatements = original.substatements;
51 this.declaredInstance = original.declaredInstance;
54 AbstractResumedStatement(final StatementDefinitionContext<A, D, E> def, final StatementSourceReference ref,
55 final String rawArgument) {
57 this.statementDeclSource = requireNonNull(ref);
58 this.rawArgument = def.support().internArgument(rawArgument);
61 AbstractResumedStatement(final StatementDefinitionContext<A, D, E> def, final StatementSourceReference ref,
62 final String rawArgument, final CopyType copyType) {
63 super(def, CopyHistory.of(copyType, CopyHistory.original()));
64 this.statementDeclSource = requireNonNull(ref);
65 this.rawArgument = rawArgument;
69 public final Optional<StmtContext<A, D, E>> getOriginalCtx() {
70 return Optional.empty();
74 public final Optional<StmtContext<A, D, E>> getPreviousCopyCtx() {
75 return Optional.empty();
79 public final StatementSourceReference getStatementSourceReference() {
80 return statementDeclSource;
84 public final String rawStatementArgument() {
89 public Collection<? extends StatementContextBase<?, ?, ?>> mutableDeclaredSubstatements() {
94 public final D buildDeclared() {
96 return (existing = declaredInstance) != null ? existing : loadDeclared();
99 private @NonNull D loadDeclared() {
100 final ModelProcessingPhase phase = getCompletedPhase();
101 checkState(phase == ModelProcessingPhase.FULL_DECLARATION || phase == ModelProcessingPhase.EFFECTIVE_MODEL,
102 "Cannot build declared instance after phase %s", phase);
103 return declaredInstance = definition().getFactory().createDeclared(this);
107 public @NonNull StatementDefinition getDefinition() {
108 return getPublicDefinition();
112 public @NonNull StatementSourceReference getSourceReference() {
113 return getStatementSourceReference();
117 public boolean isFullyDefined() {
118 return fullyDefined();
122 * Create a new substatement at the specified offset.
124 * @param offset Substatement offset
125 * @param def definition context
126 * @param ref source reference
127 * @param argument statement argument
128 * @param <X> new substatement argument type
129 * @param <Y> new substatement declared type
130 * @param <Z> new substatement effective type
131 * @return A new substatement
133 @SuppressWarnings("checkstyle:methodTypeParameterName")
134 final <X, Y extends DeclaredStatement<X>, Z extends EffectiveStatement<X, Y>>
135 AbstractResumedStatement<X, Y, Z> createSubstatement(final int offset,
136 final StatementDefinitionContext<X, Y, Z> def, final StatementSourceReference ref,
137 final String argument) {
138 final ModelProcessingPhase inProgressPhase = getRoot().getSourceContext().getInProgressPhase();
139 checkState(inProgressPhase != ModelProcessingPhase.EFFECTIVE_MODEL,
140 "Declared statement cannot be added in effective phase at: %s", getStatementSourceReference());
142 final Optional<StatementSupport<?, ?, ?>> implicitParent =
143 definition().getImplicitParentFor(def.getPublicView());
144 if (implicitParent.isPresent()) {
145 return createImplicitParent(offset, implicitParent.get(), ref, argument).createSubstatement(offset, def,
149 final AbstractResumedStatement<X, Y, Z> ret = new SubstatementContext<>(this, def, ref, argument);
150 substatements = substatements.put(offset, ret);
151 def.onStatementAdded(ret);
156 final boolean hasEmptySubstatements() {
157 return substatements.size() == 0 && hasEmptyEffectiveSubstatements();
161 * Lookup substatement by its offset in this statement.
163 * @param offset Substatement offset
164 * @return Substatement, or null if substatement does not exist.
166 final AbstractResumedStatement<?, ?, ?> lookupSubstatement(final int offset) {
167 return substatements.get(offset);
170 final void resizeSubstatements(final int expectedSize) {
171 substatements = substatements.ensureCapacity(expectedSize);
174 final void walkChildren(final ModelProcessingPhase phase) {
175 checkState(isFullyDefined());
176 substatements.forEach(stmt -> {
177 stmt.walkChildren(phase);
178 stmt.endDeclared(phase);
182 private AbstractResumedStatement<?, ?, ?> createImplicitParent(final int offset,
183 final StatementSupport<?, ?, ?> implicitParent, final StatementSourceReference ref, final String argument) {
184 final StatementDefinitionContext<?, ?, ?> def = new StatementDefinitionContext<>(implicitParent);
185 return createSubstatement(offset, def, ImplicitSubstatement.of(ref), argument);