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 static com.google.common.base.Preconditions.checkArgument;
11 import static com.google.common.base.Preconditions.checkState;
12 import static com.google.common.base.Verify.verify;
13 import static com.google.common.base.Verify.verifyNotNull;
14 import static java.util.Objects.requireNonNull;
16 import com.google.common.collect.ImmutableCollection;
17 import com.google.common.collect.ImmutableList;
18 import com.google.common.collect.ImmutableMultimap;
19 import com.google.common.collect.Multimap;
20 import com.google.common.collect.Multimaps;
21 import java.util.ArrayList;
22 import java.util.Collection;
23 import java.util.Collections;
24 import java.util.EnumMap;
25 import java.util.EventListener;
26 import java.util.Iterator;
27 import java.util.List;
28 import java.util.Map.Entry;
29 import java.util.Optional;
30 import java.util.stream.Stream;
31 import org.eclipse.jdt.annotation.NonNull;
32 import org.eclipse.jdt.annotation.Nullable;
33 import org.opendaylight.yangtools.yang.common.QNameModule;
34 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
35 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
36 import org.opendaylight.yangtools.yang.model.api.meta.StatementDefinition;
37 import org.opendaylight.yangtools.yang.parser.spi.meta.CopyHistory;
38 import org.opendaylight.yangtools.yang.parser.spi.meta.CopyType;
39 import org.opendaylight.yangtools.yang.parser.spi.meta.ImplicitParentAwareStatementSupport;
40 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder;
41 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase;
42 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase.ExecutionOrder;
43 import org.opendaylight.yangtools.yang.parser.spi.meta.MutableStatement;
44 import org.opendaylight.yangtools.yang.parser.spi.meta.NamespaceBehaviour;
45 import org.opendaylight.yangtools.yang.parser.spi.meta.NamespaceKeyCriterion;
46 import org.opendaylight.yangtools.yang.parser.spi.meta.ParserNamespace;
47 import org.opendaylight.yangtools.yang.parser.spi.meta.StatementFactory;
48 import org.opendaylight.yangtools.yang.parser.spi.meta.StatementNamespace;
49 import org.opendaylight.yangtools.yang.parser.spi.meta.StatementSupport;
50 import org.opendaylight.yangtools.yang.parser.spi.meta.StatementSupport.CopyPolicy;
51 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
52 import org.opendaylight.yangtools.yang.parser.spi.meta.UndeclaredStatementFactory;
53 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
54 import org.opendaylight.yangtools.yang.parser.stmt.reactor.NamespaceBehaviourWithListeners.KeyedValueAddedListener;
55 import org.opendaylight.yangtools.yang.parser.stmt.reactor.NamespaceBehaviourWithListeners.PredicateValueAddedListener;
56 import org.slf4j.Logger;
57 import org.slf4j.LoggerFactory;
60 * Core reactor statement implementation of {@link Mutable}.
62 * @param <A> Argument type
63 * @param <D> Declared Statement representation
64 * @param <E> Effective Statement representation
66 abstract class StatementContextBase<A, D extends DeclaredStatement<A>, E extends EffectiveStatement<A, D>>
67 extends ReactorStmtCtx<A, D, E> implements CopyHistory {
69 * Event listener when an item is added to model namespace.
71 interface OnNamespaceItemAdded extends EventListener {
73 * Invoked whenever a new item is added to a namespace.
75 void namespaceItemAdded(StatementContextBase<?, ?, ?> context, Class<?> namespace, Object key, Object value);
79 * Event listener when a parsing {@link ModelProcessingPhase} is completed.
81 interface OnPhaseFinished extends EventListener {
83 * Invoked whenever a processing phase has finished.
85 boolean phaseFinished(StatementContextBase<?, ?, ?> context, ModelProcessingPhase finishedPhase);
89 * Interface for all mutations within an {@link ModelActionBuilder.InferenceAction}.
91 interface ContextMutation {
96 private static final Logger LOG = LoggerFactory.getLogger(StatementContextBase.class);
98 // Bottom 4 bits, encoding a CopyHistory, aight?
99 private static final byte COPY_ORIGINAL = 0x00;
100 private static final byte COPY_LAST_TYPE_MASK = 0x03;
101 @Deprecated(since = "7.0.9", forRemoval = true)
102 private static final byte COPY_ADDED_BY_USES = 0x04;
103 private static final byte COPY_ADDED_BY_AUGMENTATION = 0x08;
105 // Top four bits, of which we define the topmost two to 0. We use the bottom two to encode last CopyType, aight?
106 private static final int COPY_CHILD_TYPE_SHIFT = 4;
108 private static final CopyType @NonNull [] COPY_TYPE_VALUES = CopyType.values();
111 final int copyTypes = COPY_TYPE_VALUES.length;
112 // This implies CopyType.ordinal() is <= COPY_TYPE_MASK
113 verify(copyTypes == COPY_LAST_TYPE_MASK + 1, "Unexpected %s CopyType values", copyTypes);
117 * 8 bits worth of instance storage. This is treated as a constant bit field with following structure:
126 * The four allocated fields are:
128 * <li>{@code lst}, encoding the four states corresponding to {@link CopyHistory#getLastOperation()}</li>
129 * <li>{@code u}, encoding {@link #isAddedByUses()}</li>
130 * <li>{@code a}, encoding {@link #isAugmenting()}</li>
131 * <li>{@code cct} encoding {@link #childCopyType()}</li>
133 * We still have two unused bits.
135 private final byte bitsAight;
137 // Note: this field can strictly be derived in InferredStatementContext, but it forms the basis of many of our
138 // operations, hence we want to keep it close by.
139 private final @NonNull StatementDefinitionContext<A, D, E> definition;
141 // TODO: consider keying by Byte equivalent of ExecutionOrder
142 private Multimap<ModelProcessingPhase, OnPhaseFinished> phaseListeners = ImmutableMultimap.of();
143 private Multimap<ModelProcessingPhase, ContextMutation> phaseMutation = ImmutableMultimap.of();
145 private List<StmtContext<?, ?, ?>> effectOfStatement = ImmutableList.of();
148 * {@link ModelProcessingPhase.ExecutionOrder} value of current {@link ModelProcessingPhase} of this statement.
150 private byte executionOrder;
152 // TODO: we a single byte of alignment shadow left, we should think how we can use it to cache information we build
153 // during InferredStatementContext.tryToReusePrototype(). We usually end up being routed to
154 // copyAsChildOfImpl() -- which performs an eager instantiation and checks for changes afterwards. We should
155 // be able to capture how parent scope affects the copy in a few bits. If we can do that, than we can reap
156 // the benefits by just examining new parent context and old parent context contribution to the state. If
157 // their impact is the same, we can skip instantiation of statements and directly reuse them (individually,
158 // or as a complete file).
160 // Whatever we end up tracking, we need to track two views of that -- for the statement itself
161 // (sans substatements) and a summary of substatements. I think it should be possible to get this working
162 // with 2x5bits -- we have up to 15 mutable bits available if we share the field with implicitDeclaredFlag.
164 // Copy constructor used by subclasses to implement reparent()
165 StatementContextBase(final StatementContextBase<A, D, E> original) {
167 this.bitsAight = original.bitsAight;
168 this.definition = original.definition;
169 this.executionOrder = original.executionOrder;
172 StatementContextBase(final StatementDefinitionContext<A, D, E> def) {
173 this.definition = requireNonNull(def);
174 this.bitsAight = COPY_ORIGINAL;
177 StatementContextBase(final StatementDefinitionContext<A, D, E> def, final CopyType copyType) {
178 this.definition = requireNonNull(def);
179 this.bitsAight = (byte) copyFlags(copyType);
182 StatementContextBase(final StatementContextBase<A, D, E> prototype, final CopyType copyType,
183 final CopyType childCopyType) {
184 this.definition = prototype.definition;
185 this.bitsAight = (byte) (copyFlags(copyType)
186 | prototype.bitsAight & ~COPY_LAST_TYPE_MASK | childCopyType.ordinal() << COPY_CHILD_TYPE_SHIFT);
189 private static int copyFlags(final CopyType copyType) {
190 return historyFlags(copyType) | copyType.ordinal();
193 private static byte historyFlags(final CopyType copyType) {
194 return switch (copyType) {
195 case ADDED_BY_AUGMENTATION -> COPY_ADDED_BY_AUGMENTATION;
196 case ADDED_BY_USES -> COPY_ADDED_BY_USES;
197 case ADDED_BY_USES_AUGMENTATION -> COPY_ADDED_BY_AUGMENTATION | COPY_ADDED_BY_USES;
198 case ORIGINAL -> COPY_ORIGINAL;
203 public final Collection<? extends StmtContext<?, ?, ?>> getEffectOfStatement() {
204 return effectOfStatement;
208 public final void addAsEffectOfStatement(final Collection<? extends StmtContext<?, ?, ?>> ctxs) {
209 if (ctxs.isEmpty()) {
213 if (effectOfStatement.isEmpty()) {
214 effectOfStatement = new ArrayList<>(ctxs.size());
216 effectOfStatement.addAll(ctxs);
220 // CopyHistory integration
224 public final CopyHistory history() {
229 @Deprecated(since = "7.0.9", forRemoval = true)
230 public final boolean isAddedByUses() {
231 return (bitsAight & COPY_ADDED_BY_USES) != 0;
235 @Deprecated(since = "8.0.0")
236 public final boolean isAugmenting() {
237 return (bitsAight & COPY_ADDED_BY_AUGMENTATION) != 0;
241 public final CopyType getLastOperation() {
242 return COPY_TYPE_VALUES[bitsAight & COPY_LAST_TYPE_MASK];
245 // This method exists only for space optimization of InferredStatementContext
246 final CopyType childCopyType() {
247 return COPY_TYPE_VALUES[bitsAight >> COPY_CHILD_TYPE_SHIFT & COPY_LAST_TYPE_MASK];
251 // Inference completion tracking
255 final byte executionOrder() {
256 return executionOrder;
259 // FIXME: this should be propagated through a correct constructor
261 final void setCompletedPhase(final ModelProcessingPhase completedPhase) {
262 this.executionOrder = completedPhase.executionOrder();
266 public final <K, V, T extends K, U extends V, N extends ParserNamespace<K, V>> void addToNs(
267 final Class<@NonNull N> type, final T key, final U value) {
268 addToNamespace(type, key, value);
271 static final Collection<? extends Mutable<?, ?, ?>> mutableEffectiveSubstatements(
272 final List<ReactorStmtCtx<?, ?, ?>> effective) {
273 return effective instanceof ImmutableCollection ? effective : Collections.unmodifiableCollection(effective);
276 private static List<ReactorStmtCtx<?, ?, ?>> shrinkEffective(final List<ReactorStmtCtx<?, ?, ?>> effective) {
277 return effective.isEmpty() ? ImmutableList.of() : effective;
280 static final List<ReactorStmtCtx<?, ?, ?>> removeStatementFromEffectiveSubstatements(
281 final List<ReactorStmtCtx<?, ?, ?>> effective, final StatementDefinition statementDef) {
282 if (effective.isEmpty()) {
286 final Iterator<? extends StmtContext<?, ?, ?>> iterator = effective.iterator();
287 while (iterator.hasNext()) {
288 final StmtContext<?, ?, ?> next = iterator.next();
289 if (statementDef.equals(next.publicDefinition())) {
294 return shrinkEffective(effective);
297 static final List<ReactorStmtCtx<?, ?, ?>> removeStatementFromEffectiveSubstatements(
298 final List<ReactorStmtCtx<?, ?, ?>> effective, final StatementDefinition statementDef,
299 final String statementArg) {
300 if (statementArg == null) {
301 return removeStatementFromEffectiveSubstatements(effective, statementDef);
304 if (effective.isEmpty()) {
308 final Iterator<ReactorStmtCtx<?, ?, ?>> iterator = effective.iterator();
309 while (iterator.hasNext()) {
310 final Mutable<?, ?, ?> next = iterator.next();
311 if (statementDef.equals(next.publicDefinition()) && statementArg.equals(next.rawArgument())) {
316 return shrinkEffective(effective);
320 public final <X, Y extends DeclaredStatement<X>, Z extends EffectiveStatement<X, Y>>
321 Mutable<X, Y, Z> createUndeclaredSubstatement(final StatementSupport<X, Y, Z> support, final X arg) {
322 requireNonNull(support);
323 checkArgument(support instanceof UndeclaredStatementFactory, "Unsupported statement support %s", support);
325 final var ret = new UndeclaredStmtCtx<>(this, support, arg);
326 support.onStatementAdded(ret);
330 final List<ReactorStmtCtx<?, ?, ?>> addEffectiveSubstatement(final List<ReactorStmtCtx<?, ?, ?>> effective,
331 final Mutable<?, ?, ?> substatement) {
332 final ReactorStmtCtx<?, ?, ?> stmt = verifyStatement(substatement);
333 final List<ReactorStmtCtx<?, ?, ?>> resized = beforeAddEffectiveStatement(effective, 1);
334 ensureCompletedExecution(stmt);
339 static final void afterAddEffectiveSubstatement(final Mutable<?, ?, ?> substatement) {
340 // Undeclared statements still need to have 'onDeclarationFinished()' triggered
341 if (substatement instanceof UndeclaredStmtCtx) {
342 finishDeclaration((UndeclaredStmtCtx<?, ?, ?>) substatement);
346 // Split out to keep generics working without a warning
347 private static <X, Y extends DeclaredStatement<X>, Z extends EffectiveStatement<X, Y>> void finishDeclaration(
348 final UndeclaredStmtCtx<X, Y, Z> substatement) {
349 substatement.definition().onDeclarationFinished(substatement, ModelProcessingPhase.FULL_DECLARATION);
353 public final void addEffectiveSubstatements(final Collection<? extends Mutable<?, ?, ?>> statements) {
354 if (!statements.isEmpty()) {
355 statements.forEach(StatementContextBase::verifyStatement);
356 addEffectiveSubstatementsImpl(statements);
360 abstract void addEffectiveSubstatementsImpl(Collection<? extends Mutable<?, ?, ?>> statements);
362 final List<ReactorStmtCtx<?, ?, ?>> addEffectiveSubstatementsImpl(final List<ReactorStmtCtx<?, ?, ?>> effective,
363 final Collection<? extends Mutable<?, ?, ?>> statements) {
364 final List<ReactorStmtCtx<?, ?, ?>> resized = beforeAddEffectiveStatement(effective, statements.size());
365 final Collection<? extends ReactorStmtCtx<?, ?, ?>> casted =
366 (Collection<? extends ReactorStmtCtx<?, ?, ?>>) statements;
367 if (executionOrder != ExecutionOrder.NULL) {
368 for (ReactorStmtCtx<?, ?, ?> stmt : casted) {
369 ensureCompletedExecution(stmt, executionOrder);
373 resized.addAll(casted);
377 abstract Iterator<ReactorStmtCtx<?, ?, ?>> effectiveChildrenToComplete();
379 // exposed for InferredStatementContext only
380 final void ensureCompletedPhase(final Mutable<?, ?, ?> stmt) {
381 ensureCompletedExecution(verifyStatement(stmt));
384 // Make sure target statement has transitioned at least to our phase (if we have one). This method is just before we
385 // take allow a statement to become our substatement. This is needed to ensure that every statement tree does not
386 // contain any statements which did not complete the same phase as the root statement.
387 private void ensureCompletedExecution(final ReactorStmtCtx<?, ?, ?> stmt) {
388 if (executionOrder != ExecutionOrder.NULL) {
389 ensureCompletedExecution(stmt, executionOrder);
393 private static void ensureCompletedExecution(final ReactorStmtCtx<?, ?, ?> stmt, final byte executionOrder) {
394 verify(stmt.tryToCompletePhase(executionOrder), "Statement %s cannot complete phase %s", stmt, executionOrder);
397 private static ReactorStmtCtx<?, ?, ?> verifyStatement(final Mutable<?, ?, ?> stmt) {
398 verify(stmt instanceof ReactorStmtCtx, "Unexpected statement %s", stmt);
399 return (ReactorStmtCtx<?, ?, ?>) stmt;
402 private List<ReactorStmtCtx<?, ?, ?>> beforeAddEffectiveStatement(final List<ReactorStmtCtx<?, ?, ?>> effective,
404 // We cannot allow statement to be further mutated.
405 // TODO: we really want to say 'not NULL and not at or after EFFECTIVE_MODEL here. This will matter if we have
406 // a phase after EFFECTIVE_MODEL
407 verify(executionOrder != ExecutionOrder.EFFECTIVE_MODEL, "Cannot modify finished statement at %s",
409 return beforeAddEffectiveStatementUnsafe(effective, toAdd);
412 final List<ReactorStmtCtx<?, ?, ?>> beforeAddEffectiveStatementUnsafe(final List<ReactorStmtCtx<?, ?, ?>> effective,
414 final ModelProcessingPhase inProgressPhase = getRoot().getSourceContext().getInProgressPhase();
415 checkState(inProgressPhase == ModelProcessingPhase.FULL_DECLARATION
416 || inProgressPhase == ModelProcessingPhase.EFFECTIVE_MODEL,
417 "Effective statement cannot be added in declared phase at: %s", sourceReference());
419 return effective.isEmpty() ? new ArrayList<>(toAdd) : effective;
423 final E createEffective() {
424 final E result = createEffective(definition.getFactory());
425 if (result instanceof MutableStatement) {
426 getRoot().addMutableStmtToSeal((MutableStatement) result);
431 abstract @NonNull E createEffective(@NonNull StatementFactory<A, D, E> factory);
434 * Return a stream of declared statements which can be built into an {@link EffectiveStatement}, as per
435 * {@link StmtContext#buildEffective()} contract.
437 * @return Stream of supported declared statements.
439 // FIXME: we really want to unify this with streamEffective(), under its name
440 abstract Stream<? extends @NonNull StmtContext<?, ?, ?>> streamDeclared();
443 * Return a stream of inferred statements which can be built into an {@link EffectiveStatement}, as per
444 * {@link StmtContext#buildEffective()} contract.
446 * @return Stream of supported effective statements.
448 // FIXME: this method is currently a misnomer, but unifying with streamDeclared() would make this accurate again
449 abstract Stream<? extends @NonNull StmtContext<?, ?, ?>> streamEffective();
452 final boolean doTryToCompletePhase(final byte targetOrder) {
453 final boolean finished = phaseMutation.isEmpty() || runMutations(targetOrder);
454 if (completeChildren(targetOrder) && finished) {
455 onPhaseCompleted(targetOrder);
461 private boolean completeChildren(final byte targetOrder) {
462 boolean finished = true;
463 for (final StatementContextBase<?, ?, ?> child : mutableDeclaredSubstatements()) {
464 finished &= child.tryToCompletePhase(targetOrder);
466 final var it = effectiveChildrenToComplete();
467 while (it.hasNext()) {
468 finished &= it.next().tryToCompletePhase(targetOrder);
473 private boolean runMutations(final byte targetOrder) {
474 final ModelProcessingPhase phase = verifyNotNull(ModelProcessingPhase.ofExecutionOrder(targetOrder));
475 final Collection<ContextMutation> openMutations = phaseMutation.get(phase);
476 return openMutations.isEmpty() || runMutations(phase, openMutations);
479 private boolean runMutations(final ModelProcessingPhase phase, final Collection<ContextMutation> openMutations) {
480 boolean finished = true;
481 final Iterator<ContextMutation> it = openMutations.iterator();
482 while (it.hasNext()) {
483 final ContextMutation current = it.next();
484 if (current.isFinished()) {
491 if (openMutations.isEmpty()) {
492 phaseMutation.removeAll(phase);
493 cleanupPhaseMutation();
498 private void cleanupPhaseMutation() {
499 if (phaseMutation.isEmpty()) {
500 phaseMutation = ImmutableMultimap.of();
505 * Occurs on end of {@link ModelProcessingPhase} of source parsing. This method must not be called with
506 * {@code executionOrder} equal to {@link ExecutionOrder#NULL}.
508 * @param phase that was to be completed (finished)
509 * @throws SourceException when an error occurred in source parsing
511 private void onPhaseCompleted(final byte completedOrder) {
512 executionOrder = completedOrder;
513 if (completedOrder == ExecutionOrder.EFFECTIVE_MODEL) {
514 // We have completed effective model, substatements are guaranteed not to change
515 summarizeSubstatementPolicy();
518 final ModelProcessingPhase phase = verifyNotNull(ModelProcessingPhase.ofExecutionOrder(completedOrder));
519 final Collection<OnPhaseFinished> listeners = phaseListeners.get(phase);
520 if (!listeners.isEmpty()) {
521 runPhaseListeners(phase, listeners);
525 private void summarizeSubstatementPolicy() {
526 if (definition().support().copyPolicy() == CopyPolicy.EXACT_REPLICA || noSensitiveSubstatements()) {
527 setAllSubstatementsContextIndependent();
532 * Determine whether any substatements are copy-sensitive as determined by {@link StatementSupport#copyPolicy()}.
533 * Only {@link CopyPolicy#CONTEXT_INDEPENDENT}, {@link CopyPolicy#EXACT_REPLICA} and {@link CopyPolicy#IGNORE} are
534 * copy-insensitive. Note that statements which are not {@link StmtContext#isSupportedToBuildEffective()} are all
535 * considered copy-insensitive.
538 * Implementations are expected to call {@link #noSensitiveSubstatements()} to actually traverse substatement sets.
540 * @return True if no substatements require copy-sensitive handling
542 abstract boolean noSensitiveSubstatements();
545 * Determine whether any of the provided substatements are context-sensitive for purposes of implementing
546 * {@link #noSensitiveSubstatements()}.
548 * @param substatements Substatements to check
549 * @return True if no substatements require context-sensitive handling
551 static boolean noSensitiveSubstatements(final Collection<? extends ReactorStmtCtx<?, ?, ?>> substatements) {
552 for (ReactorStmtCtx<?, ?, ?> stmt : substatements) {
553 if (stmt.isSupportedToBuildEffective()) {
554 if (!stmt.allSubstatementsContextIndependent()) {
555 // This is a recursive property
559 switch (stmt.definition().support().copyPolicy()) {
560 case CONTEXT_INDEPENDENT:
572 private void runPhaseListeners(final ModelProcessingPhase phase, final Collection<OnPhaseFinished> listeners) {
573 final Iterator<OnPhaseFinished> listener = listeners.iterator();
574 while (listener.hasNext()) {
575 final OnPhaseFinished next = listener.next();
576 if (next.phaseFinished(this, phase)) {
581 if (listeners.isEmpty()) {
582 phaseListeners.removeAll(phase);
583 if (phaseListeners.isEmpty()) {
584 phaseListeners = ImmutableMultimap.of();
590 final StatementDefinitionContext<A, D, E> definition() {
594 final <K, V, N extends ParserNamespace<K, V>> void onNamespaceItemAddedAction(final Class<N> type, final K key,
595 final OnNamespaceItemAdded listener) {
596 final Object potential = getFromNamespace(type, key);
597 if (potential != null) {
598 LOG.trace("Listener on {} key {} satisfied immediately", type, key);
599 listener.namespaceItemAdded(this, type, key, potential);
603 getBehaviour(type).addListener(new KeyedValueAddedListener<>(this, key) {
605 void onValueAdded(final Object value) {
606 listener.namespaceItemAdded(StatementContextBase.this, type, key, value);
611 final <K, V, N extends ParserNamespace<K, V>> void onNamespaceItemAddedAction(final Class<N> type,
612 final ModelProcessingPhase phase, final NamespaceKeyCriterion<K> criterion,
613 final OnNamespaceItemAdded listener) {
614 final Optional<Entry<K, V>> existing = getFromNamespace(type, criterion);
615 if (existing.isPresent()) {
616 final Entry<K, V> entry = existing.get();
617 LOG.debug("Listener on {} criterion {} found a pre-existing match: {}", type, criterion, entry);
618 waitForPhase(entry.getValue(), type, phase, criterion, listener);
622 final NamespaceBehaviourWithListeners<K, V, N> behaviour = getBehaviour(type);
623 behaviour.addListener(new PredicateValueAddedListener<K, V>(this) {
625 boolean onValueAdded(final K key, final V value) {
626 if (criterion.match(key)) {
627 LOG.debug("Listener on {} criterion {} matched added key {}", type, criterion, key);
628 waitForPhase(value, type, phase, criterion, listener);
637 final <K, V, N extends ParserNamespace<K, V>> void selectMatch(final Class<N> type,
638 final NamespaceKeyCriterion<K> criterion, final OnNamespaceItemAdded listener) {
639 final Optional<Entry<K, V>> optMatch = getFromNamespace(type, criterion);
640 checkState(optMatch.isPresent(), "Failed to find a match for criterion %s in namespace %s node %s", criterion,
642 final Entry<K, V> match = optMatch.get();
643 listener.namespaceItemAdded(StatementContextBase.this, type, match.getKey(), match.getValue());
646 final <K, V, N extends ParserNamespace<K, V>> void waitForPhase(final Object value, final Class<N> type,
647 final ModelProcessingPhase phase, final NamespaceKeyCriterion<K> criterion,
648 final OnNamespaceItemAdded listener) {
649 ((StatementContextBase<?, ? ,?>) value).addPhaseCompletedListener(phase,
650 (context, phaseCompleted) -> {
651 selectMatch(type, criterion, listener);
656 private <K, V, N extends ParserNamespace<K, V>> NamespaceBehaviourWithListeners<K, V, N> getBehaviour(
657 final Class<N> type) {
658 final NamespaceBehaviour<K, V, N> behaviour = getBehaviourRegistry().getNamespaceBehaviour(type);
659 checkArgument(behaviour instanceof NamespaceBehaviourWithListeners, "Namespace %s does not support listeners",
662 return (NamespaceBehaviourWithListeners<K, V, N>) behaviour;
665 private static <T> Multimap<ModelProcessingPhase, T> newMultimap() {
666 return Multimaps.newListMultimap(new EnumMap<>(ModelProcessingPhase.class), () -> new ArrayList<>(1));
670 * Adds {@link OnPhaseFinished} listener for a {@link ModelProcessingPhase} end. If the base has already completed
671 * the listener is notified immediately.
673 * @param phase requested completion phase
674 * @param listener listener to invoke
675 * @throws NullPointerException if any of the arguments is null
677 void addPhaseCompletedListener(final ModelProcessingPhase phase, final OnPhaseFinished listener) {
678 requireNonNull(phase, "Statement context processing phase cannot be null");
679 requireNonNull(listener, "Statement context phase listener cannot be null");
681 ModelProcessingPhase finishedPhase = ModelProcessingPhase.ofExecutionOrder(executionOrder);
682 while (finishedPhase != null) {
683 if (phase.equals(finishedPhase)) {
684 listener.phaseFinished(this, finishedPhase);
687 finishedPhase = finishedPhase.getPreviousPhase();
689 if (phaseListeners.isEmpty()) {
690 phaseListeners = newMultimap();
693 phaseListeners.put(phase, listener);
697 * Adds a {@link ContextMutation} to a {@link ModelProcessingPhase}.
699 * @throws IllegalStateException when the mutation was registered after phase was completed
701 final void addMutation(final ModelProcessingPhase phase, final ContextMutation mutation) {
702 checkState(executionOrder < phase.executionOrder(), "Mutation registered after phase was completed at: %s",
705 if (phaseMutation.isEmpty()) {
706 phaseMutation = newMultimap();
708 phaseMutation.put(phase, mutation);
711 final void removeMutation(final ModelProcessingPhase phase, final ContextMutation mutation) {
712 if (!phaseMutation.isEmpty()) {
713 phaseMutation.remove(phase, mutation);
714 cleanupPhaseMutation();
719 public final <K, KT extends K, N extends StatementNamespace<K, ?, ?>> void addContext(
720 final Class<@NonNull N> namespace, final KT key,final StmtContext<?, ?, ?> stmt) {
721 addContextToNamespace(namespace, key, stmt);
725 public final Optional<? extends Mutable<?, ?, ?>> copyAsChildOf(final Mutable<?, ?, ?> parent, final CopyType type,
726 final QNameModule targetModule) {
727 checkEffectiveModelCompleted(this);
728 return Optional.ofNullable(copyAsChildOfImpl(parent, type, targetModule));
731 private @Nullable ReactorStmtCtx<A, D, E> copyAsChildOfImpl(final Mutable<?, ?, ?> parent, final CopyType type,
732 final QNameModule targetModule) {
733 final StatementSupport<A, D, E> support = definition.support();
734 final CopyPolicy policy = support.copyPolicy();
737 return replicaAsChildOf(parent);
738 case CONTEXT_INDEPENDENT:
739 if (allSubstatementsContextIndependent()) {
740 return replicaAsChildOf(parent);
746 return (ReactorStmtCtx<A, D, E>) parent.childCopyOf(this, type, targetModule);
750 throw new IllegalStateException("Statement " + support.getPublicView() + " should never be copied");
752 throw new IllegalStateException("Unhandled policy " + policy);
757 final ReactorStmtCtx<?, ?, ?> asEffectiveChildOf(final StatementContextBase<?, ?, ?> parent, final CopyType type,
758 final QNameModule targetModule) {
759 final ReactorStmtCtx<A, D, E> copy = copyAsChildOfImpl(parent, type, targetModule);
761 // The statement fizzled, this should never happen, perhaps a verify()?
765 parent.ensureCompletedExecution(copy);
766 return canReuseCurrent(copy) ? this : copy;
769 private boolean canReuseCurrent(final @NonNull ReactorStmtCtx<A, D, E> copy) {
770 // Defer to statement factory to see if we can reuse this object. If we can and have only context-independent
771 // substatements we can reuse the object. More complex cases are handled indirectly via the copy.
772 return definition.getFactory().canReuseCurrent(copy, this, buildEffective().effectiveSubstatements())
773 && allSubstatementsContextIndependent();
777 public final Mutable<?, ?, ?> childCopyOf(final StmtContext<?, ?, ?> stmt, final CopyType type,
778 final QNameModule targetModule) {
779 checkEffectiveModelCompleted(stmt);
780 if (stmt instanceof StatementContextBase) {
781 return childCopyOf((StatementContextBase<?, ?, ?>) stmt, type, targetModule);
782 } else if (stmt instanceof ReplicaStatementContext) {
783 return ((ReplicaStatementContext<?, ?, ?>) stmt).replicaAsChildOf(this);
785 throw new IllegalArgumentException("Unsupported statement " + stmt);
789 private <X, Y extends DeclaredStatement<X>, Z extends EffectiveStatement<X, Y>> Mutable<X, Y, Z> childCopyOf(
790 final StatementContextBase<X, Y, Z> original, final CopyType type, final QNameModule targetModule) {
791 final var implicitParent = definition.getImplicitParentFor(this, original.publicDefinition());
793 final StatementContextBase<X, Y, Z> result;
794 final InferredStatementContext<X, Y, Z> copy;
796 if (implicitParent.isPresent()) {
797 result = new UndeclaredStmtCtx(this, implicitParent.orElseThrow(), original, type);
799 final CopyType childCopyType = switch (type) {
800 case ADDED_BY_AUGMENTATION -> CopyType.ORIGINAL;
801 case ADDED_BY_USES_AUGMENTATION -> CopyType.ADDED_BY_USES;
802 case ADDED_BY_USES, ORIGINAL -> type;
804 copy = new InferredStatementContext<>(result, original, childCopyType, type, targetModule);
805 result.addEffectiveSubstatement(copy);
806 result.definition.onStatementAdded(result);
808 result = copy = new InferredStatementContext<>(this, original, type, type, targetModule);
811 original.definition.onStatementAdded(copy);
816 final ReplicaStatementContext<A, D, E> replicaAsChildOf(final StatementContextBase<?, ?, ?> parent) {
817 return new ReplicaStatementContext<>(parent, this);
820 private static void checkEffectiveModelCompleted(final StmtContext<?, ?, ?> stmt) {
821 final ModelProcessingPhase phase = stmt.getCompletedPhase();
822 checkState(phase == ModelProcessingPhase.EFFECTIVE_MODEL,
823 "Attempted to copy statement %s which has completed phase %s", stmt, phase);
827 public final boolean hasImplicitParentSupport() {
828 return definition.getFactory() instanceof ImplicitParentAwareStatementSupport;
832 public final StmtContext<?, ?, ?> wrapWithImplicit(final StmtContext<?, ?, ?> original) {
833 final var optImplicit = definition.getImplicitParentFor(this, original.publicDefinition());
834 if (optImplicit.isEmpty()) {
838 checkArgument(original instanceof StatementContextBase, "Unsupported original %s", original);
839 final var origBase = (StatementContextBase<?, ?, ?>)original;
841 @SuppressWarnings({ "rawtypes", "unchecked" })
842 final UndeclaredStmtCtx<?, ?, ?> result = new UndeclaredStmtCtx(origBase, optImplicit.orElseThrow());
843 result.addEffectiveSubstatement(origBase.reparent(result));
844 result.setCompletedPhase(original.getCompletedPhase());
848 abstract StatementContextBase<A, D, E> reparent(StatementContextBase<?, ?, ?> newParent);
851 * Indicate that the set of substatements is empty. This is a preferred shortcut to substatement stream filtering.
853 * @return True if {@link #allSubstatements()} and {@link #allSubstatementsStream()} would return an empty stream.
855 abstract boolean hasEmptySubstatements();