parser/yang-parser-reactor/src/main/java/org/opendaylight/yangtools/yang/parser/stmt/reactor/StatementContextBase.java

   1 /*
   2  * Copyright (c) 2015 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   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
   7  */
   8 package org.opendaylight.yangtools.yang.parser.stmt.reactor;
   9
  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;
  15
  16 import com.google.common.base.VerifyException;
  17 import com.google.common.collect.ImmutableCollection;
  18 import com.google.common.collect.ImmutableList;
  19 import com.google.common.collect.ImmutableMultimap;
  20 import com.google.common.collect.Multimap;
  21 import com.google.common.collect.Multimaps;
  22 import java.util.ArrayList;
  23 import java.util.Collection;
  24 import java.util.Collections;
  25 import java.util.EnumMap;
  26 import java.util.EventListener;
  27 import java.util.Iterator;
  28 import java.util.List;
  29 import java.util.Map.Entry;
  30 import java.util.Optional;
  31 import java.util.stream.Stream;
  32 import org.eclipse.jdt.annotation.NonNull;
  33 import org.eclipse.jdt.annotation.Nullable;
  34 import org.opendaylight.yangtools.yang.common.QNameModule;
  35 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
  36 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  37 import org.opendaylight.yangtools.yang.model.api.meta.StatementDefinition;
  38 import org.opendaylight.yangtools.yang.parser.spi.meta.CopyHistory;
  39 import org.opendaylight.yangtools.yang.parser.spi.meta.CopyType;
  40 import org.opendaylight.yangtools.yang.parser.spi.meta.ImplicitParentAwareStatementSupport;
  41 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder;
  42 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase;
  43 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase.ExecutionOrder;
  44 import org.opendaylight.yangtools.yang.parser.spi.meta.MutableStatement;
  45 import org.opendaylight.yangtools.yang.parser.spi.meta.NamespaceBehaviour;
  46 import org.opendaylight.yangtools.yang.parser.spi.meta.NamespaceKeyCriterion;
  47 import org.opendaylight.yangtools.yang.parser.spi.meta.ParserNamespace;
  48 import org.opendaylight.yangtools.yang.parser.spi.meta.StatementFactory;
  49 import org.opendaylight.yangtools.yang.parser.spi.meta.StatementNamespace;
  50 import org.opendaylight.yangtools.yang.parser.spi.meta.StatementSupport;
  51 import org.opendaylight.yangtools.yang.parser.spi.meta.StatementSupport.CopyPolicy;
  52 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  53 import org.opendaylight.yangtools.yang.parser.spi.meta.UndeclaredStatementFactory;
  54 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
  55 import org.opendaylight.yangtools.yang.parser.stmt.reactor.NamespaceBehaviourWithListeners.KeyedValueAddedListener;
  56 import org.opendaylight.yangtools.yang.parser.stmt.reactor.NamespaceBehaviourWithListeners.PredicateValueAddedListener;
  57 import org.slf4j.Logger;
  58 import org.slf4j.LoggerFactory;
  59
  60 /**
  61  * Core reactor statement implementation of {@link Mutable}.
  62  *
  63  * @param <A> Argument type
  64  * @param <D> Declared Statement representation
  65  * @param <E> Effective Statement representation
  66  */
  67 abstract class StatementContextBase<A, D extends DeclaredStatement<A>, E extends EffectiveStatement<A, D>>
  68         extends ReactorStmtCtx<A, D, E> implements CopyHistory {
  69     /**
  70      * Event listener when an item is added to model namespace.
  71      */
  72     interface OnNamespaceItemAdded extends EventListener {
  73         /**
  74          * Invoked whenever a new item is added to a namespace.
  75          */
  76         void namespaceItemAdded(StatementContextBase<?, ?, ?> context, Class<?> namespace, Object key, Object value);
  77     }
  78
  79     /**
  80      * Event listener when a parsing {@link ModelProcessingPhase} is completed.
  81      */
  82     interface OnPhaseFinished extends EventListener {
  83         /**
  84          * Invoked whenever a processing phase has finished.
  85          */
  86         boolean phaseFinished(StatementContextBase<?, ?, ?> context, ModelProcessingPhase finishedPhase);
  87     }
  88
  89     /**
  90      * Interface for all mutations within an {@link ModelActionBuilder.InferenceAction}.
  91      */
  92     interface ContextMutation {
  93
  94         boolean isFinished();
  95     }
  96
  97     private static final Logger LOG = LoggerFactory.getLogger(StatementContextBase.class);
  98
  99     // Bottom 4 bits, encoding a CopyHistory, aight?
 100     private static final byte COPY_ORIGINAL              = 0x00;
 101     private static final byte COPY_LAST_TYPE_MASK        = 0x03;
 102     @Deprecated(since = "7.0.9", forRemoval = true)
 103     private static final byte COPY_ADDED_BY_USES         = 0x04;
 104     private static final byte COPY_ADDED_BY_AUGMENTATION = 0x08;
 105
 106     // Top four bits, of which we define the topmost two to 0. We use the bottom two to encode last CopyType, aight?
 107     private static final int COPY_CHILD_TYPE_SHIFT       = 4;
 108
 109     private static final CopyType @NonNull [] COPY_TYPE_VALUES = CopyType.values();
 110
 111     static {
 112         final int copyTypes = COPY_TYPE_VALUES.length;
 113         // This implies CopyType.ordinal() is <= COPY_TYPE_MASK
 114         verify(copyTypes == COPY_LAST_TYPE_MASK + 1, "Unexpected %s CopyType values", copyTypes);
 115     }
 116
 117     /**
 118      * 8 bits worth of instance storage. This is treated as a constant bit field with following structure:
 119      * <pre>
 120      *   <code>
 121      * |7|6|5|4|3|2|1|0|
 122      * |0 0|cct|a|u|lst|
 123      *   </code>
 124      * </pre>
 125      *
 126      * <p>
 127      * The four allocated fields are:
 128      * <ul>
 129      *   <li>{@code lst}, encoding the four states corresponding to {@link CopyHistory#getLastOperation()}</li>
 130      *   <li>{@code u}, encoding {@link #isAddedByUses()}</li>
 131      *   <li>{@code a}, encoding {@link #isAugmenting()}</li>
 132      *   <li>{@code cct} encoding {@link #childCopyType()}</li>
 133      * </ul>
 134      * We still have two unused bits.
 135      */
 136     private final byte bitsAight;
 137
 138     // Note: this field can strictly be derived in InferredStatementContext, but it forms the basis of many of our
 139     //       operations, hence we want to keep it close by.
 140     private final @NonNull StatementDefinitionContext<A, D, E> definition;
 141
 142     // TODO: consider keying by Byte equivalent of ExecutionOrder
 143     private Multimap<ModelProcessingPhase, OnPhaseFinished> phaseListeners = ImmutableMultimap.of();
 144     private Multimap<ModelProcessingPhase, ContextMutation> phaseMutation = ImmutableMultimap.of();
 145
 146     private List<StmtContext<?, ?, ?>> effectOfStatement = ImmutableList.of();
 147
 148     /**
 149      * {@link ModelProcessingPhase.ExecutionOrder} value of current {@link ModelProcessingPhase} of this statement.
 150      */
 151     private byte executionOrder;
 152
 153     /**
 154      * This field should live in AbstractResumedStatement, but is placed here for memory efficiency to squat in the
 155      * alignment shadow of {@link #bitsAight} and {@link #executionOrder}.
 156      */
 157     private boolean implicitDeclaredFlag;
 158
 159     // TODO: we a single byte of alignment shadow left, we should think how we can use it to cache information we build
 160     //       during InferredStatementContext.tryToReusePrototype(). We usually end up being routed to
 161     //       copyAsChildOfImpl() -- which performs an eager instantiation and checks for changes afterwards. We should
 162     //       be able to capture how parent scope affects the copy in a few bits. If we can do that, than we can reap
 163     //       the benefits by just examining new parent context and old parent context contribution to the state. If
 164     //       their impact is the same, we can skip instantiation of statements and directly reuse them (individually,
 165     //       or as a complete file).
 166     //
 167     //       Whatever we end up tracking, we need to track two views of that -- for the statement itself
 168     //       (sans substatements) and a summary of substatements. I think it should be possible to get this working
 169     //       with 2x5bits -- we have up to 15 mutable bits available if we share the field with implicitDeclaredFlag.
 170
 171     // Copy constructor used by subclasses to implement reparent()
 172     StatementContextBase(final StatementContextBase<A, D, E> original) {
 173         super(original);
 174         this.bitsAight = original.bitsAight;
 175         this.definition = original.definition;
 176         this.executionOrder = original.executionOrder;
 177     }
 178
 179     StatementContextBase(final StatementDefinitionContext<A, D, E> def) {
 180         this.definition = requireNonNull(def);
 181         this.bitsAight = COPY_ORIGINAL;
 182     }
 183
 184     StatementContextBase(final StatementDefinitionContext<A, D, E> def, final CopyType copyType) {
 185         this.definition = requireNonNull(def);
 186         this.bitsAight = (byte) copyFlags(copyType);
 187     }
 188
 189     StatementContextBase(final StatementContextBase<A, D, E> prototype, final CopyType copyType,
 190             final CopyType childCopyType) {
 191         this.definition = prototype.definition;
 192         this.bitsAight = (byte) (copyFlags(copyType)
 193             | prototype.bitsAight & ~COPY_LAST_TYPE_MASK | childCopyType.ordinal() << COPY_CHILD_TYPE_SHIFT);
 194     }
 195
 196     private static int copyFlags(final CopyType copyType) {
 197         return historyFlags(copyType) | copyType.ordinal();
 198     }
 199
 200     private static byte historyFlags(final CopyType copyType) {
 201         switch (copyType) {
 202             case ADDED_BY_AUGMENTATION:
 203                 return COPY_ADDED_BY_AUGMENTATION;
 204             case ADDED_BY_USES:
 205                 return COPY_ADDED_BY_USES;
 206             case ADDED_BY_USES_AUGMENTATION:
 207                 return COPY_ADDED_BY_AUGMENTATION | COPY_ADDED_BY_USES;
 208             case ORIGINAL:
 209                 return COPY_ORIGINAL;
 210             default:
 211                 throw new VerifyException("Unhandled type " + copyType);
 212         }
 213     }
 214
 215     @Override
 216     public final Collection<? extends StmtContext<?, ?, ?>> getEffectOfStatement() {
 217         return effectOfStatement;
 218     }
 219
 220     @Override
 221     public final void addAsEffectOfStatement(final Collection<? extends StmtContext<?, ?, ?>> ctxs) {
 222         if (ctxs.isEmpty()) {
 223             return;
 224         }
 225
 226         if (effectOfStatement.isEmpty()) {
 227             effectOfStatement = new ArrayList<>(ctxs.size());
 228         }
 229         effectOfStatement.addAll(ctxs);
 230     }
 231
 232     //
 233     // CopyHistory integration
 234     //
 235
 236     @Override
 237     public final CopyHistory history() {
 238         return this;
 239     }
 240
 241     @Override
 242     @Deprecated(since = "7.0.9", forRemoval = true)
 243     public final boolean isAddedByUses() {
 244         return (bitsAight & COPY_ADDED_BY_USES) != 0;
 245     }
 246
 247     @Override
 248     @Deprecated(since = "8.0.0")
 249     public final boolean isAugmenting() {
 250         return (bitsAight & COPY_ADDED_BY_AUGMENTATION) != 0;
 251     }
 252
 253     @Override
 254     public final CopyType getLastOperation() {
 255         return COPY_TYPE_VALUES[bitsAight & COPY_LAST_TYPE_MASK];
 256     }
 257
 258     // This method exists only for space optimization of InferredStatementContext
 259     final CopyType childCopyType() {
 260         return COPY_TYPE_VALUES[bitsAight >> COPY_CHILD_TYPE_SHIFT & COPY_LAST_TYPE_MASK];
 261     }
 262
 263     //
 264     // Inference completion tracking
 265     //
 266
 267     @Override
 268     final byte executionOrder() {
 269         return executionOrder;
 270     }
 271
 272     // FIXME: this should be propagated through a correct constructor
 273     @Deprecated
 274     final void setCompletedPhase(final ModelProcessingPhase completedPhase) {
 275         this.executionOrder = completedPhase.executionOrder();
 276     }
 277
 278     @Override
 279     public final <K, V, T extends K, U extends V, N extends ParserNamespace<K, V>> void addToNs(
 280             final Class<@NonNull N> type, final T key, final U value) {
 281         addToNamespace(type, key, value);
 282     }
 283
 284     static final Collection<? extends Mutable<?, ?, ?>> mutableEffectiveSubstatements(
 285             final List<ReactorStmtCtx<?, ?, ?>> effective) {
 286         return effective instanceof ImmutableCollection ? effective : Collections.unmodifiableCollection(effective);
 287     }
 288
 289     private static List<ReactorStmtCtx<?, ?, ?>> shrinkEffective(final List<ReactorStmtCtx<?, ?, ?>> effective) {
 290         return effective.isEmpty() ? ImmutableList.of() : effective;
 291     }
 292
 293     static final List<ReactorStmtCtx<?, ?, ?>> removeStatementFromEffectiveSubstatements(
 294             final List<ReactorStmtCtx<?, ?, ?>> effective, final StatementDefinition statementDef) {
 295         if (effective.isEmpty()) {
 296             return effective;
 297         }
 298
 299         final Iterator<? extends StmtContext<?, ?, ?>> iterator = effective.iterator();
 300         while (iterator.hasNext()) {
 301             final StmtContext<?, ?, ?> next = iterator.next();
 302             if (statementDef.equals(next.publicDefinition())) {
 303                 iterator.remove();
 304             }
 305         }
 306
 307         return shrinkEffective(effective);
 308     }
 309
 310     static final List<ReactorStmtCtx<?, ?, ?>> removeStatementFromEffectiveSubstatements(
 311             final List<ReactorStmtCtx<?, ?, ?>> effective, final StatementDefinition statementDef,
 312             final String statementArg) {
 313         if (statementArg == null) {
 314             return removeStatementFromEffectiveSubstatements(effective, statementDef);
 315         }
 316
 317         if (effective.isEmpty()) {
 318             return effective;
 319         }
 320
 321         final Iterator<ReactorStmtCtx<?, ?, ?>> iterator = effective.iterator();
 322         while (iterator.hasNext()) {
 323             final Mutable<?, ?, ?> next = iterator.next();
 324             if (statementDef.equals(next.publicDefinition()) && statementArg.equals(next.rawArgument())) {
 325                 iterator.remove();
 326             }
 327         }
 328
 329         return shrinkEffective(effective);
 330     }
 331
 332     @Override
 333     public final <X, Y extends DeclaredStatement<X>, Z extends EffectiveStatement<X, Y>>
 334             Mutable<X, Y, Z> addUndeclaredSubstatement(final StatementSupport<X, Y, Z> support, final X arg) {
 335         requireNonNull(support);
 336         checkArgument(support instanceof UndeclaredStatementFactory, "Unsupported statement support %s", support);
 337
 338         final var ret = new UndeclaredStmtCtx<>(this, support, arg);
 339         support.onStatementAdded(ret);
 340         addEffectiveSubstatement(ret);
 341         return ret;
 342     }
 343
 344     final List<ReactorStmtCtx<?, ?, ?>> addEffectiveSubstatement(final List<ReactorStmtCtx<?, ?, ?>> effective,
 345             final Mutable<?, ?, ?> substatement) {
 346         verifyStatement(substatement);
 347
 348         final List<ReactorStmtCtx<?, ?, ?>> resized = beforeAddEffectiveStatement(effective, 1);
 349         final ReactorStmtCtx<?, ?, ?> stmt = (ReactorStmtCtx<?, ?, ?>) substatement;
 350         ensureCompletedExecution(stmt);
 351         resized.add(stmt);
 352         return resized;
 353     }
 354
 355     @Override
 356     public final void addEffectiveSubstatements(final Collection<? extends Mutable<?, ?, ?>> statements) {
 357         if (!statements.isEmpty()) {
 358             statements.forEach(StatementContextBase::verifyStatement);
 359             addEffectiveSubstatementsImpl(statements);
 360         }
 361     }
 362
 363     abstract void addEffectiveSubstatementsImpl(Collection<? extends Mutable<?, ?, ?>> statements);
 364
 365     final List<ReactorStmtCtx<?, ?, ?>> addEffectiveSubstatementsImpl(final List<ReactorStmtCtx<?, ?, ?>> effective,
 366             final Collection<? extends Mutable<?, ?, ?>> statements) {
 367         final List<ReactorStmtCtx<?, ?, ?>> resized = beforeAddEffectiveStatement(effective, statements.size());
 368         final Collection<? extends ReactorStmtCtx<?, ?, ?>> casted =
 369             (Collection<? extends ReactorStmtCtx<?, ?, ?>>) statements;
 370         if (executionOrder != ExecutionOrder.NULL) {
 371             for (ReactorStmtCtx<?, ?, ?> stmt : casted) {
 372                 ensureCompletedExecution(stmt, executionOrder);
 373             }
 374         }
 375
 376         resized.addAll(casted);
 377         return resized;
 378     }
 379
 380     abstract Iterator<ReactorStmtCtx<?, ?, ?>> effectiveChildrenToComplete();
 381
 382     // exposed for InferredStatementContext only
 383     final void ensureCompletedPhase(final Mutable<?, ?, ?> stmt) {
 384         verifyStatement(stmt);
 385         ensureCompletedExecution((ReactorStmtCtx<?, ?, ?>) stmt);
 386     }
 387
 388     // Make sure target statement has transitioned at least to our phase (if we have one). This method is just before we
 389     // take allow a statement to become our substatement. This is needed to ensure that every statement tree does not
 390     // contain any statements which did not complete the same phase as the root statement.
 391     private void ensureCompletedExecution(final ReactorStmtCtx<?, ?, ?> stmt) {
 392         if (executionOrder != ExecutionOrder.NULL) {
 393             ensureCompletedExecution(stmt, executionOrder);
 394         }
 395     }
 396
 397     private static void ensureCompletedExecution(final ReactorStmtCtx<?, ?, ?> stmt, final byte executionOrder) {
 398         verify(stmt.tryToCompletePhase(executionOrder), "Statement %s cannot complete phase %s", stmt, executionOrder);
 399     }
 400
 401     private static void verifyStatement(final Mutable<?, ?, ?> stmt) {
 402         verify(stmt instanceof ReactorStmtCtx, "Unexpected statement %s", stmt);
 403     }
 404
 405     private List<ReactorStmtCtx<?, ?, ?>> beforeAddEffectiveStatement(final List<ReactorStmtCtx<?, ?, ?>> effective,
 406             final int toAdd) {
 407         // We cannot allow statement to be further mutated.
 408         // TODO: we really want to say 'not NULL and not at or after EFFECTIVE_MODEL here. This will matter if we have
 409         //       a phase after EFFECTIVE_MODEL
 410         verify(executionOrder != ExecutionOrder.EFFECTIVE_MODEL, "Cannot modify finished statement at %s",
 411             sourceReference());
 412         return beforeAddEffectiveStatementUnsafe(effective, toAdd);
 413     }
 414
 415     final List<ReactorStmtCtx<?, ?, ?>> beforeAddEffectiveStatementUnsafe(final List<ReactorStmtCtx<?, ?, ?>> effective,
 416             final int toAdd) {
 417         final ModelProcessingPhase inProgressPhase = getRoot().getSourceContext().getInProgressPhase();
 418         checkState(inProgressPhase == ModelProcessingPhase.FULL_DECLARATION
 419                 || inProgressPhase == ModelProcessingPhase.EFFECTIVE_MODEL,
 420                 "Effective statement cannot be added in declared phase at: %s", sourceReference());
 421
 422         return effective.isEmpty() ? new ArrayList<>(toAdd) : effective;
 423     }
 424
 425     @Override
 426     final E createEffective() {
 427         final E result = createEffective(definition.getFactory());
 428         if (result instanceof MutableStatement) {
 429             getRoot().addMutableStmtToSeal((MutableStatement) result);
 430         }
 431         return result;
 432     }
 433
 434     abstract @NonNull E createEffective(@NonNull StatementFactory<A, D, E> factory);
 435
 436     /**
 437      * Routing of the request to build an effective statement from {@link InferredStatementContext} towards the original
 438      * definition site. This is needed to pick the correct instantiation method: for declared statements we will
 439      * eventually land in {@link AbstractResumedStatement}, for underclared statements that will be
 440      * {@link UndeclaredStmtCtx}.
 441      *
 442      * @param factory Statement factory
 443      * @param ctx Inferred statement context, i.e. where the effective statement is instantiated
 444      * @return Built effective stateue
 445      */
 446     abstract @NonNull E createInferredEffective(@NonNull StatementFactory<A, D, E> factory,
 447         @NonNull InferredStatementContext<A, D, E> ctx);
 448
 449     /**
 450      * Return a stream of declared statements which can be built into an {@link EffectiveStatement}, as per
 451      * {@link StmtContext#buildEffective()} contract.
 452      *
 453      * @return Stream of supported declared statements.
 454      */
 455     // FIXME: we really want to unify this with streamEffective(), under its name
 456     abstract Stream<? extends @NonNull StmtContext<?, ?, ?>> streamDeclared();
 457
 458     /**
 459      * Return a stream of inferred statements which can be built into an {@link EffectiveStatement}, as per
 460      * {@link StmtContext#buildEffective()} contract.
 461      *
 462      * @return Stream of supported effective statements.
 463      */
 464     // FIXME: this method is currently a misnomer, but unifying with streamDeclared() would make this accurate again
 465     abstract Stream<? extends @NonNull StmtContext<?, ?, ?>> streamEffective();
 466
 467     @Override
 468     final boolean doTryToCompletePhase(final byte targetOrder) {
 469         final boolean finished = phaseMutation.isEmpty() || runMutations(targetOrder);
 470         if (completeChildren(targetOrder) && finished) {
 471             onPhaseCompleted(targetOrder);
 472             return true;
 473         }
 474         return false;
 475     }
 476
 477     private boolean completeChildren(final byte targetOrder) {
 478         boolean finished = true;
 479         for (final StatementContextBase<?, ?, ?> child : mutableDeclaredSubstatements()) {
 480             finished &= child.tryToCompletePhase(targetOrder);
 481         }
 482         final var it = effectiveChildrenToComplete();
 483         while (it.hasNext()) {
 484             finished &= it.next().tryToCompletePhase(targetOrder);
 485         }
 486         return finished;
 487     }
 488
 489     private boolean runMutations(final byte targetOrder) {
 490         final ModelProcessingPhase phase = verifyNotNull(ModelProcessingPhase.ofExecutionOrder(targetOrder));
 491         final Collection<ContextMutation> openMutations = phaseMutation.get(phase);
 492         return openMutations.isEmpty() || runMutations(phase, openMutations);
 493     }
 494
 495     private boolean runMutations(final ModelProcessingPhase phase, final Collection<ContextMutation> openMutations) {
 496         boolean finished = true;
 497         final Iterator<ContextMutation> it = openMutations.iterator();
 498         while (it.hasNext()) {
 499             final ContextMutation current = it.next();
 500             if (current.isFinished()) {
 501                 it.remove();
 502             } else {
 503                 finished = false;
 504             }
 505         }
 506
 507         if (openMutations.isEmpty()) {
 508             phaseMutation.removeAll(phase);
 509             cleanupPhaseMutation();
 510         }
 511         return finished;
 512     }
 513
 514     private void cleanupPhaseMutation() {
 515         if (phaseMutation.isEmpty()) {
 516             phaseMutation = ImmutableMultimap.of();
 517         }
 518     }
 519
 520     /**
 521      * Occurs on end of {@link ModelProcessingPhase} of source parsing. This method must not be called with
 522      * {@code executionOrder} equal to {@link ExecutionOrder#NULL}.
 523      *
 524      * @param phase that was to be completed (finished)
 525      * @throws SourceException when an error occurred in source parsing
 526      */
 527     private void onPhaseCompleted(final byte completedOrder) {
 528         executionOrder = completedOrder;
 529         if (completedOrder == ExecutionOrder.EFFECTIVE_MODEL) {
 530             // We have completed effective model, substatements are guaranteed not to change
 531             summarizeSubstatementPolicy();
 532         }
 533
 534         final ModelProcessingPhase phase = verifyNotNull(ModelProcessingPhase.ofExecutionOrder(completedOrder));
 535         final Collection<OnPhaseFinished> listeners = phaseListeners.get(phase);
 536         if (!listeners.isEmpty()) {
 537             runPhaseListeners(phase, listeners);
 538         }
 539     }
 540
 541     private void summarizeSubstatementPolicy() {
 542         if (definition().support().copyPolicy() == CopyPolicy.EXACT_REPLICA || noSensitiveSubstatements()) {
 543             setAllSubstatementsContextIndependent();
 544         }
 545     }
 546
 547     /**
 548      * Determine whether any substatements are copy-sensitive as determined by {@link StatementSupport#copyPolicy()}.
 549      * Only {@link CopyPolicy#CONTEXT_INDEPENDENT}, {@link CopyPolicy#EXACT_REPLICA} and {@link CopyPolicy#IGNORE} are
 550      * copy-insensitive. Note that statements which are not {@link StmtContext#isSupportedToBuildEffective()} are all
 551      * considered copy-insensitive.
 552      *
 553      * <p>
 554      * Implementations are expected to call {@link #noSensitiveSubstatements()} to actually traverse substatement sets.
 555      *
 556      * @return True if no substatements require copy-sensitive handling
 557      */
 558     abstract boolean noSensitiveSubstatements();
 559
 560     /**
 561      * Determine whether any of the provided substatements are context-sensitive for purposes of implementing
 562      * {@link #noSensitiveSubstatements()}.
 563      *
 564      * @param substatements Substatements to check
 565      * @return True if no substatements require context-sensitive handling
 566      */
 567     static boolean noSensitiveSubstatements(final Collection<? extends ReactorStmtCtx<?, ?, ?>> substatements) {
 568         for (ReactorStmtCtx<?, ?, ?> stmt : substatements) {
 569             if (stmt.isSupportedToBuildEffective()) {
 570                 if (!stmt.allSubstatementsContextIndependent()) {
 571                     // This is a recursive property
 572                     return false;
 573                 }
 574
 575                 switch (stmt.definition().support().copyPolicy()) {
 576                     case CONTEXT_INDEPENDENT:
 577                     case EXACT_REPLICA:
 578                     case IGNORE:
 579                         break;
 580                     default:
 581                         return false;
 582                 }
 583             }
 584         }
 585         return true;
 586     }
 587
 588     private void runPhaseListeners(final ModelProcessingPhase phase, final Collection<OnPhaseFinished> listeners) {
 589         final Iterator<OnPhaseFinished> listener = listeners.iterator();
 590         while (listener.hasNext()) {
 591             final OnPhaseFinished next = listener.next();
 592             if (next.phaseFinished(this, phase)) {
 593                 listener.remove();
 594             }
 595         }
 596
 597         if (listeners.isEmpty()) {
 598             phaseListeners.removeAll(phase);
 599             if (phaseListeners.isEmpty()) {
 600                 phaseListeners = ImmutableMultimap.of();
 601             }
 602         }
 603     }
 604
 605     @Override
 606     final StatementDefinitionContext<A, D, E> definition() {
 607         return definition;
 608     }
 609
 610     final <K, V, N extends ParserNamespace<K, V>> void onNamespaceItemAddedAction(final Class<N> type, final K key,
 611             final OnNamespaceItemAdded listener) {
 612         final Object potential = getFromNamespace(type, key);
 613         if (potential != null) {
 614             LOG.trace("Listener on {} key {} satisfied immediately", type, key);
 615             listener.namespaceItemAdded(this, type, key, potential);
 616             return;
 617         }
 618
 619         getBehaviour(type).addListener(new KeyedValueAddedListener<>(this, key) {
 620             @Override
 621             void onValueAdded(final Object value) {
 622                 listener.namespaceItemAdded(StatementContextBase.this, type, key, value);
 623             }
 624         });
 625     }
 626
 627     final <K, V, N extends ParserNamespace<K, V>> void onNamespaceItemAddedAction(final Class<N> type,
 628             final ModelProcessingPhase phase, final NamespaceKeyCriterion<K> criterion,
 629             final OnNamespaceItemAdded listener) {
 630         final Optional<Entry<K, V>> existing = getFromNamespace(type, criterion);
 631         if (existing.isPresent()) {
 632             final Entry<K, V> entry = existing.get();
 633             LOG.debug("Listener on {} criterion {} found a pre-existing match: {}", type, criterion, entry);
 634             waitForPhase(entry.getValue(), type, phase, criterion, listener);
 635             return;
 636         }
 637
 638         final NamespaceBehaviourWithListeners<K, V, N> behaviour = getBehaviour(type);
 639         behaviour.addListener(new PredicateValueAddedListener<K, V>(this) {
 640             @Override
 641             boolean onValueAdded(final K key, final V value) {
 642                 if (criterion.match(key)) {
 643                     LOG.debug("Listener on {} criterion {} matched added key {}", type, criterion, key);
 644                     waitForPhase(value, type, phase, criterion, listener);
 645                     return true;
 646                 }
 647
 648                 return false;
 649             }
 650         });
 651     }
 652
 653     final <K, V, N extends ParserNamespace<K, V>> void selectMatch(final Class<N> type,
 654             final NamespaceKeyCriterion<K> criterion, final OnNamespaceItemAdded listener) {
 655         final Optional<Entry<K, V>> optMatch = getFromNamespace(type, criterion);
 656         checkState(optMatch.isPresent(), "Failed to find a match for criterion %s in namespace %s node %s", criterion,
 657             type, this);
 658         final Entry<K, V> match = optMatch.get();
 659         listener.namespaceItemAdded(StatementContextBase.this, type, match.getKey(), match.getValue());
 660     }
 661
 662     final <K, V, N extends ParserNamespace<K, V>> void waitForPhase(final Object value, final Class<N> type,
 663             final ModelProcessingPhase phase, final NamespaceKeyCriterion<K> criterion,
 664             final OnNamespaceItemAdded listener) {
 665         ((StatementContextBase<?, ? ,?>) value).addPhaseCompletedListener(phase,
 666             (context, phaseCompleted) -> {
 667                 selectMatch(type, criterion, listener);
 668                 return true;
 669             });
 670     }
 671
 672     private <K, V, N extends ParserNamespace<K, V>> NamespaceBehaviourWithListeners<K, V, N> getBehaviour(
 673             final Class<N> type) {
 674         final NamespaceBehaviour<K, V, N> behaviour = getBehaviourRegistry().getNamespaceBehaviour(type);
 675         checkArgument(behaviour instanceof NamespaceBehaviourWithListeners, "Namespace %s does not support listeners",
 676             type);
 677
 678         return (NamespaceBehaviourWithListeners<K, V, N>) behaviour;
 679     }
 680
 681     private static <T> Multimap<ModelProcessingPhase, T> newMultimap() {
 682         return Multimaps.newListMultimap(new EnumMap<>(ModelProcessingPhase.class), () -> new ArrayList<>(1));
 683     }
 684
 685     /**
 686      * Adds {@link OnPhaseFinished} listener for a {@link ModelProcessingPhase} end. If the base has already completed
 687      * the listener is notified immediately.
 688      *
 689      * @param phase requested completion phase
 690      * @param listener listener to invoke
 691      * @throws NullPointerException if any of the arguments is null
 692      */
 693     void addPhaseCompletedListener(final ModelProcessingPhase phase, final OnPhaseFinished listener) {
 694         requireNonNull(phase, "Statement context processing phase cannot be null");
 695         requireNonNull(listener, "Statement context phase listener cannot be null");
 696
 697         ModelProcessingPhase finishedPhase = ModelProcessingPhase.ofExecutionOrder(executionOrder);
 698         while (finishedPhase != null) {
 699             if (phase.equals(finishedPhase)) {
 700                 listener.phaseFinished(this, finishedPhase);
 701                 return;
 702             }
 703             finishedPhase = finishedPhase.getPreviousPhase();
 704         }
 705         if (phaseListeners.isEmpty()) {
 706             phaseListeners = newMultimap();
 707         }
 708
 709         phaseListeners.put(phase, listener);
 710     }
 711
 712     /**
 713      * Adds a {@link ContextMutation} to a {@link ModelProcessingPhase}.
 714      *
 715      * @throws IllegalStateException when the mutation was registered after phase was completed
 716      */
 717     final void addMutation(final ModelProcessingPhase phase, final ContextMutation mutation) {
 718         checkState(executionOrder < phase.executionOrder(), "Mutation registered after phase was completed at: %s",
 719             sourceReference());
 720
 721         if (phaseMutation.isEmpty()) {
 722             phaseMutation = newMultimap();
 723         }
 724         phaseMutation.put(phase, mutation);
 725     }
 726
 727     final void removeMutation(final ModelProcessingPhase phase, final ContextMutation mutation) {
 728         if (!phaseMutation.isEmpty()) {
 729             phaseMutation.remove(phase, mutation);
 730             cleanupPhaseMutation();
 731         }
 732     }
 733
 734     @Override
 735     public final <K, KT extends K, N extends StatementNamespace<K, ?, ?>> void addContext(
 736             final Class<@NonNull N> namespace, final KT key,final StmtContext<?, ?, ?> stmt) {
 737         addContextToNamespace(namespace, key, stmt);
 738     }
 739
 740     @Override
 741     public final Optional<? extends Mutable<?, ?, ?>> copyAsChildOf(final Mutable<?, ?, ?> parent, final CopyType type,
 742             final QNameModule targetModule) {
 743         checkEffectiveModelCompleted(this);
 744         return Optional.ofNullable(copyAsChildOfImpl(parent, type, targetModule));
 745     }
 746
 747     private @Nullable ReactorStmtCtx<A, D, E> copyAsChildOfImpl(final Mutable<?, ?, ?> parent, final CopyType type,
 748             final QNameModule targetModule) {
 749         final StatementSupport<A, D, E> support = definition.support();
 750         final CopyPolicy policy = support.copyPolicy();
 751         switch (policy) {
 752             case EXACT_REPLICA:
 753                 return replicaAsChildOf(parent);
 754             case CONTEXT_INDEPENDENT:
 755                 if (allSubstatementsContextIndependent()) {
 756                     return replicaAsChildOf(parent);
 757                 }
 758
 759                 // fall through
 760             case DECLARED_COPY:
 761                 // FIXME: ugly cast
 762                 return (ReactorStmtCtx<A, D, E>) parent.childCopyOf(this, type, targetModule);
 763             case IGNORE:
 764                 return null;
 765             case REJECT:
 766                 throw new IllegalStateException("Statement " + support.getPublicView() + " should never be copied");
 767             default:
 768                 throw new IllegalStateException("Unhandled policy " + policy);
 769         }
 770     }
 771
 772     @Override
 773     final ReactorStmtCtx<?, ?, ?> asEffectiveChildOf(final StatementContextBase<?, ?, ?> parent, final CopyType type,
 774             final QNameModule targetModule) {
 775         final ReactorStmtCtx<A, D, E> copy = copyAsChildOfImpl(parent, type, targetModule);
 776         if (copy == null) {
 777             // The statement fizzled, this should never happen, perhaps a verify()?
 778             return null;
 779         }
 780
 781         parent.ensureCompletedPhase(copy);
 782         return canReuseCurrent(copy) ? this : copy;
 783     }
 784
 785     private boolean canReuseCurrent(final @NonNull ReactorStmtCtx<A, D, E> copy) {
 786         // Defer to statement factory to see if we can reuse this object. If we can and have only context-independent
 787         // substatements we can reuse the object. More complex cases are handled indirectly via the copy.
 788         return definition.getFactory().canReuseCurrent(copy, this, buildEffective().effectiveSubstatements())
 789             && allSubstatementsContextIndependent();
 790     }
 791
 792     @Override
 793     public final Mutable<?, ?, ?> childCopyOf(final StmtContext<?, ?, ?> stmt, final CopyType type,
 794             final QNameModule targetModule) {
 795         checkEffectiveModelCompleted(stmt);
 796         if (stmt instanceof StatementContextBase) {
 797             return childCopyOf((StatementContextBase<?, ?, ?>) stmt, type, targetModule);
 798         } else if (stmt instanceof ReplicaStatementContext) {
 799             return ((ReplicaStatementContext<?, ?, ?>) stmt).replicaAsChildOf(this);
 800         } else {
 801             throw new IllegalArgumentException("Unsupported statement " + stmt);
 802         }
 803     }
 804
 805     private <X, Y extends DeclaredStatement<X>, Z extends EffectiveStatement<X, Y>> Mutable<X, Y, Z> childCopyOf(
 806             final StatementContextBase<X, Y, Z> original, final CopyType type, final QNameModule targetModule) {
 807         final var implicitParent = definition.getImplicitParentFor(this, original.publicDefinition());
 808
 809         final StatementContextBase<X, Y, Z> result;
 810         final InferredStatementContext<X, Y, Z> copy;
 811
 812         if (implicitParent.isPresent()) {
 813             result = new UndeclaredStmtCtx(this, implicitParent.orElseThrow(), original, type);
 814
 815             final CopyType childCopyType;
 816             switch (type) {
 817                 case ADDED_BY_AUGMENTATION:
 818                     childCopyType = CopyType.ORIGINAL;
 819                     break;
 820                 case ADDED_BY_USES_AUGMENTATION:
 821                     childCopyType = CopyType.ADDED_BY_USES;
 822                     break;
 823                 case ADDED_BY_USES:
 824                 case ORIGINAL:
 825                 default:
 826                     childCopyType = type;
 827             }
 828
 829             copy = new InferredStatementContext<>(result, original, childCopyType, type, targetModule);
 830             result.addEffectiveSubstatement(copy);
 831         } else {
 832             result = copy = new InferredStatementContext<>(this, original, type, type, targetModule);
 833         }
 834
 835         original.definition.onStatementAdded(copy);
 836         return result;
 837     }
 838
 839     @Override
 840     final ReplicaStatementContext<A, D, E> replicaAsChildOf(final StatementContextBase<?, ?, ?> parent) {
 841         return new ReplicaStatementContext<>(parent, this);
 842     }
 843
 844     private static void checkEffectiveModelCompleted(final StmtContext<?, ?, ?> stmt) {
 845         final ModelProcessingPhase phase = stmt.getCompletedPhase();
 846         checkState(phase == ModelProcessingPhase.EFFECTIVE_MODEL,
 847                 "Attempted to copy statement %s which has completed phase %s", stmt, phase);
 848     }
 849
 850     @Override
 851     public final boolean hasImplicitParentSupport() {
 852         return definition.getFactory() instanceof ImplicitParentAwareStatementSupport;
 853     }
 854
 855     @Override
 856     public final StmtContext<?, ?, ?> wrapWithImplicit(final StmtContext<?, ?, ?> original) {
 857         final var optImplicit = definition.getImplicitParentFor(this, original.publicDefinition());
 858         if (optImplicit.isEmpty()) {
 859             return original;
 860         }
 861
 862         checkArgument(original instanceof StatementContextBase, "Unsupported original %s", original);
 863         final var origBase = (StatementContextBase<?, ?, ?>)original;
 864
 865         @SuppressWarnings({ "rawtypes", "unchecked" })
 866         final UndeclaredStmtCtx<?, ?, ?> result = new UndeclaredStmtCtx(origBase, optImplicit.orElseThrow());
 867         result.addEffectiveSubstatement(origBase.reparent(result));
 868         result.setCompletedPhase(original.getCompletedPhase());
 869         return result;
 870     }
 871
 872     abstract StatementContextBase<A, D, E> reparent(StatementContextBase<?, ?, ?> newParent);
 873
 874     /**
 875      * Indicate that the set of substatements is empty. This is a preferred shortcut to substatement stream filtering.
 876      *
 877      * @return True if {@link #allSubstatements()} and {@link #allSubstatementsStream()} would return an empty stream.
 878      */
 879     abstract boolean hasEmptySubstatements();
 880
 881     // Note: these two are exposed for AbstractResumedStatement only
 882     final boolean getImplicitDeclaredFlag() {
 883         return implicitDeclaredFlag;
 884     }
 885
 886     final void setImplicitDeclaredFlag() {
 887         implicitDeclaredFlag = true;
 888     }
 889 }