yang/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.checkNotNull;
  12 import static com.google.common.base.Preconditions.checkState;
  13 import static com.google.common.base.Verify.verify;
  14 import static java.util.Objects.requireNonNull;
  15
  16 import com.google.common.annotations.Beta;
  17 import com.google.common.base.MoreObjects;
  18 import com.google.common.base.MoreObjects.ToStringHelper;
  19 import com.google.common.collect.ImmutableCollection;
  20 import com.google.common.collect.ImmutableList;
  21 import com.google.common.collect.ImmutableMultimap;
  22 import com.google.common.collect.Multimap;
  23 import com.google.common.collect.Multimaps;
  24 import java.util.ArrayList;
  25 import java.util.Collection;
  26 import java.util.Collections;
  27 import java.util.EnumMap;
  28 import java.util.EventListener;
  29 import java.util.Iterator;
  30 import java.util.List;
  31 import java.util.Map;
  32 import java.util.Map.Entry;
  33 import java.util.Optional;
  34 import java.util.Set;
  35 import org.eclipse.jdt.annotation.NonNull;
  36 import org.eclipse.jdt.annotation.Nullable;
  37 import org.opendaylight.yangtools.yang.common.QName;
  38 import org.opendaylight.yangtools.yang.common.QNameModule;
  39 import org.opendaylight.yangtools.yang.common.YangVersion;
  40 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  41 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
  42 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  43 import org.opendaylight.yangtools.yang.model.api.meta.IdentifierNamespace;
  44 import org.opendaylight.yangtools.yang.model.api.meta.StatementDefinition;
  45 import org.opendaylight.yangtools.yang.model.api.meta.StatementSource;
  46 import org.opendaylight.yangtools.yang.model.api.stmt.AugmentStatement;
  47 import org.opendaylight.yangtools.yang.model.api.stmt.ConfigStatement;
  48 import org.opendaylight.yangtools.yang.model.api.stmt.DeviationStatement;
  49 import org.opendaylight.yangtools.yang.model.api.stmt.RefineStatement;
  50 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier;
  51 import org.opendaylight.yangtools.yang.model.api.stmt.UsesStatement;
  52 import org.opendaylight.yangtools.yang.model.repo.api.SourceIdentifier;
  53 import org.opendaylight.yangtools.yang.parser.spi.meta.CopyHistory;
  54 import org.opendaylight.yangtools.yang.parser.spi.meta.CopyType;
  55 import org.opendaylight.yangtools.yang.parser.spi.meta.ImplicitParentAwareStatementSupport;
  56 import org.opendaylight.yangtools.yang.parser.spi.meta.InferenceException;
  57 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder;
  58 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase;
  59 import org.opendaylight.yangtools.yang.parser.spi.meta.MutableStatement;
  60 import org.opendaylight.yangtools.yang.parser.spi.meta.NamespaceBehaviour;
  61 import org.opendaylight.yangtools.yang.parser.spi.meta.NamespaceBehaviour.Registry;
  62 import org.opendaylight.yangtools.yang.parser.spi.meta.NamespaceKeyCriterion;
  63 import org.opendaylight.yangtools.yang.parser.spi.meta.NamespaceNotAvailableException;
  64 import org.opendaylight.yangtools.yang.parser.spi.meta.StatementNamespace;
  65 import org.opendaylight.yangtools.yang.parser.spi.meta.StatementSupport;
  66 import org.opendaylight.yangtools.yang.parser.spi.meta.StatementSupport.CopyPolicy;
  67 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  68 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
  69 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
  70 import org.opendaylight.yangtools.yang.parser.spi.source.ImplicitSubstatement;
  71 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
  72 import org.opendaylight.yangtools.yang.parser.spi.source.StatementSourceReference;
  73 import org.opendaylight.yangtools.yang.parser.spi.source.SupportedFeaturesNamespace;
  74 import org.opendaylight.yangtools.yang.parser.spi.source.SupportedFeaturesNamespace.SupportedFeatures;
  75 import org.opendaylight.yangtools.yang.parser.stmt.reactor.NamespaceBehaviourWithListeners.KeyedValueAddedListener;
  76 import org.opendaylight.yangtools.yang.parser.stmt.reactor.NamespaceBehaviourWithListeners.PredicateValueAddedListener;
  77 import org.slf4j.Logger;
  78 import org.slf4j.LoggerFactory;
  79
  80 /**
  81  * Core reactor statement implementation of {@link Mutable}.
  82  *
  83  * @param <A> Argument type
  84  * @param <D> Declared Statement representation
  85  * @param <E> Effective Statement representation
  86  */
  87 public abstract class StatementContextBase<A, D extends DeclaredStatement<A>, E extends EffectiveStatement<A, D>>
  88         extends NamespaceStorageSupport implements Mutable<A, D, E> {
  89     /**
  90      * Event listener when an item is added to model namespace.
  91      */
  92     interface OnNamespaceItemAdded extends EventListener {
  93         /**
  94          * Invoked whenever a new item is added to a namespace.
  95          */
  96         void namespaceItemAdded(StatementContextBase<?, ?, ?> context, Class<?> namespace, Object key, Object value);
  97     }
  98
  99     /**
 100      * Event listener when a parsing {@link ModelProcessingPhase} is completed.
 101      */
 102     interface OnPhaseFinished extends EventListener {
 103         /**
 104          * Invoked whenever a processing phase has finished.
 105          */
 106         boolean phaseFinished(StatementContextBase<?, ?, ?> context, ModelProcessingPhase finishedPhase);
 107     }
 108
 109     /**
 110      * Interface for all mutations within an {@link ModelActionBuilder.InferenceAction}.
 111      */
 112     interface ContextMutation {
 113
 114         boolean isFinished();
 115     }
 116
 117     private static final Logger LOG = LoggerFactory.getLogger(StatementContextBase.class);
 118
 119     // Flag bit assignments
 120     private static final int IS_SUPPORTED_BY_FEATURES    = 0x01;
 121     private static final int HAVE_SUPPORTED_BY_FEATURES  = 0x02;
 122     private static final int IS_IGNORE_IF_FEATURE        = 0x04;
 123     private static final int HAVE_IGNORE_IF_FEATURE      = 0x08;
 124     // Note: these four are related
 125     private static final int IS_IGNORE_CONFIG            = 0x10;
 126     private static final int HAVE_IGNORE_CONFIG          = 0x20;
 127     private static final int IS_CONFIGURATION            = 0x40;
 128     private static final int HAVE_CONFIGURATION          = 0x80;
 129
 130     // Have-and-set flag constants, also used as masks
 131     private static final int SET_SUPPORTED_BY_FEATURES = HAVE_SUPPORTED_BY_FEATURES | IS_SUPPORTED_BY_FEATURES;
 132     private static final int SET_CONFIGURATION = HAVE_CONFIGURATION | IS_CONFIGURATION;
 133     // Note: implies SET_CONFIGURATION, allowing fewer bit operations to be performed
 134     private static final int SET_IGNORE_CONFIG = HAVE_IGNORE_CONFIG | IS_IGNORE_CONFIG | SET_CONFIGURATION;
 135     private static final int SET_IGNORE_IF_FEATURE = HAVE_IGNORE_IF_FEATURE | IS_IGNORE_IF_FEATURE;
 136
 137     private final CopyHistory copyHistory;
 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     private Multimap<ModelProcessingPhase, OnPhaseFinished> phaseListeners = ImmutableMultimap.of();
 143     private Multimap<ModelProcessingPhase, ContextMutation> phaseMutation = ImmutableMultimap.of();
 144     private List<StatementContextBase<?, ?, ?>> effective = ImmutableList.of();
 145     private List<StmtContext<?, ?, ?>> effectOfStatement = ImmutableList.of();
 146
 147     private @Nullable ModelProcessingPhase completedPhase;
 148     private @Nullable E effectiveInstance;
 149
 150     // Master flag controlling whether this context can yield an effective statement
 151     // FIXME: investigate the mechanics that are being supported by this, as it would be beneficial if we can get rid
 152     //        of this flag -- eliminating the initial alignment shadow used by below gap-filler fields.
 153     private boolean isSupportedToBuildEffective = true;
 154
 155     // Flag for use with AbstractResumedStatement. This is hiding in the alignment shadow created by above boolean
 156     private boolean fullyDefined;
 157
 158     // Flags for use with SubstatementContext. These are hiding in the alignment shadow created by above boolean and
 159     // hence improve memory layout.
 160     private byte flags;
 161
 162     // SchemaPath cache for use with SubstatementContext and InferredStatementContext. This hurts RootStatementContext
 163     // a bit in terms of size -- but those are only a few and SchemaPath is on its way out anyway.
 164     private volatile SchemaPath schemaPath;
 165
 166     // Copy constructor used by subclasses to implement reparent()
 167     StatementContextBase(final StatementContextBase<A, D, E> original) {
 168         this.copyHistory = original.copyHistory;
 169         this.definition = original.definition;
 170
 171         this.isSupportedToBuildEffective = original.isSupportedToBuildEffective;
 172         this.fullyDefined = original.fullyDefined;
 173         this.completedPhase = original.completedPhase;
 174         this.flags = original.flags;
 175     }
 176
 177     StatementContextBase(final StatementDefinitionContext<A, D, E> def) {
 178         this.definition = requireNonNull(def);
 179         this.copyHistory = CopyHistory.original();
 180     }
 181
 182     StatementContextBase(final StatementDefinitionContext<A, D, E> def, final CopyHistory copyHistory) {
 183         this.definition = requireNonNull(def);
 184         this.copyHistory = requireNonNull(copyHistory);
 185     }
 186
 187     @Override
 188     public Collection<? extends StmtContext<?, ?, ?>> getEffectOfStatement() {
 189         return effectOfStatement;
 190     }
 191
 192     @Override
 193     public void addAsEffectOfStatement(final StmtContext<?, ?, ?> ctx) {
 194         if (effectOfStatement.isEmpty()) {
 195             effectOfStatement = new ArrayList<>(1);
 196         }
 197         effectOfStatement.add(ctx);
 198     }
 199
 200     @Override
 201     public void addAsEffectOfStatement(final Collection<? extends StmtContext<?, ?, ?>> ctxs) {
 202         if (ctxs.isEmpty()) {
 203             return;
 204         }
 205
 206         if (effectOfStatement.isEmpty()) {
 207             effectOfStatement = new ArrayList<>(ctxs.size());
 208         }
 209         effectOfStatement.addAll(ctxs);
 210     }
 211
 212     @Override
 213     public boolean isSupportedByFeatures() {
 214         final int fl = flags & SET_SUPPORTED_BY_FEATURES;
 215         if (fl != 0) {
 216             return fl == SET_SUPPORTED_BY_FEATURES;
 217         }
 218         if (isIgnoringIfFeatures()) {
 219             flags |= SET_SUPPORTED_BY_FEATURES;
 220             return true;
 221         }
 222
 223         /*
 224          * If parent is supported, we need to check if-features statements of this context.
 225          */
 226         if (isParentSupportedByFeatures()) {
 227             // If the set of supported features has not been provided, all features are supported by default.
 228             final Set<QName> supportedFeatures = getFromNamespace(SupportedFeaturesNamespace.class,
 229                     SupportedFeatures.SUPPORTED_FEATURES);
 230             if (supportedFeatures == null || StmtContextUtils.checkFeatureSupport(this, supportedFeatures)) {
 231                 flags |= SET_SUPPORTED_BY_FEATURES;
 232                 return true;
 233             }
 234         }
 235
 236         // Either parent is not supported or this statement is not supported
 237         flags |= HAVE_SUPPORTED_BY_FEATURES;
 238         return false;
 239     }
 240
 241     protected abstract boolean isParentSupportedByFeatures();
 242
 243     @Override
 244     public boolean isSupportedToBuildEffective() {
 245         return isSupportedToBuildEffective;
 246     }
 247
 248     @Override
 249     public void setIsSupportedToBuildEffective(final boolean isSupportedToBuildEffective) {
 250         this.isSupportedToBuildEffective = isSupportedToBuildEffective;
 251     }
 252
 253     @Override
 254     public CopyHistory getCopyHistory() {
 255         return copyHistory;
 256     }
 257
 258     @Override
 259     public ModelProcessingPhase getCompletedPhase() {
 260         return completedPhase;
 261     }
 262
 263     // FIXME: this should be propagated through a correct constructor
 264     @Deprecated
 265     final void setCompletedPhase(final ModelProcessingPhase completedPhase) {
 266         this.completedPhase = completedPhase;
 267     }
 268
 269     @Override
 270     public abstract StatementContextBase<?, ?, ?> getParentContext();
 271
 272     /**
 273      * Returns the model root for this statement.
 274      *
 275      * @return root context of statement
 276      */
 277     @Override
 278     public abstract RootStatementContext<?, ?, ?> getRoot();
 279
 280     @Override
 281     public final @NonNull Registry getBehaviourRegistry() {
 282         return getRoot().getBehaviourRegistryImpl();
 283     }
 284
 285     @Override
 286     public final YangVersion getRootVersion() {
 287         return getRoot().getRootVersionImpl();
 288     }
 289
 290     @Override
 291     public final void setRootVersion(final YangVersion version) {
 292         getRoot().setRootVersionImpl(version);
 293     }
 294
 295     @Override
 296     public final void addMutableStmtToSeal(final MutableStatement mutableStatement) {
 297         getRoot().addMutableStmtToSealImpl(mutableStatement);
 298     }
 299
 300     @Override
 301     public final void addRequiredSource(final SourceIdentifier dependency) {
 302         getRoot().addRequiredSourceImpl(dependency);
 303     }
 304
 305     @Override
 306     public final void setRootIdentifier(final SourceIdentifier identifier) {
 307         getRoot().setRootIdentifierImpl(identifier);
 308     }
 309
 310     @Override
 311     public final boolean isEnabledSemanticVersioning() {
 312         return getRoot().isEnabledSemanticVersioningImpl();
 313     }
 314
 315     @Override
 316     public StatementSource getStatementSource() {
 317         return getStatementSourceReference().getStatementSource();
 318     }
 319
 320     @Override
 321     public final <K, V, N extends IdentifierNamespace<K, V>> Map<K, V> getAllFromCurrentStmtCtxNamespace(
 322             final Class<N> type) {
 323         return getLocalNamespace(type);
 324     }
 325
 326     @Override
 327     public final <K, V, N extends IdentifierNamespace<K, V>> Map<K, V> getAllFromNamespace(final Class<N> type) {
 328         return getNamespace(type);
 329     }
 330
 331     /**
 332      * Associate a value with a key within a namespace.
 333      *
 334      * @param type Namespace type
 335      * @param key Key
 336      * @param value value
 337      * @param <K> namespace key type
 338      * @param <V> namespace value type
 339      * @param <N> namespace type
 340      * @param <T> key type
 341      * @param <U> value type
 342      * @throws NamespaceNotAvailableException when the namespace is not available.
 343      */
 344     @Override
 345     public final <K, V, T extends K, U extends V, N extends IdentifierNamespace<K, V>> void addToNs(
 346             final Class<N> type, final T key, final U value) {
 347         addToNamespace(type, key, value);
 348     }
 349
 350     @Override
 351     public abstract Collection<? extends StatementContextBase<?, ?, ?>> mutableDeclaredSubstatements();
 352
 353     /**
 354      * Return a value associated with specified key within a namespace.
 355      *
 356      * @param type Namespace type
 357      * @param key Key
 358      * @param <K> namespace key type
 359      * @param <V> namespace value type
 360      * @param <N> namespace type
 361      * @param <T> key type
 362      * @return Value, or null if there is no element
 363      * @throws NamespaceNotAvailableException when the namespace is not available.
 364      */
 365     @Override
 366     public final <K, V, T extends K, N extends IdentifierNamespace<K, V>> V getFromNamespace(final Class<N> type,
 367             final T key) {
 368         return getBehaviourRegistry().getNamespaceBehaviour(type).getFrom(this, key);
 369     }
 370
 371     @Override
 372     public Collection<? extends Mutable<?, ?, ?>> mutableEffectiveSubstatements() {
 373         if (effective instanceof ImmutableCollection) {
 374             return effective;
 375         }
 376
 377         return Collections.unmodifiableCollection(effective);
 378     }
 379
 380     private void shrinkEffective() {
 381         if (effective.isEmpty()) {
 382             effective = ImmutableList.of();
 383         }
 384     }
 385
 386     public void removeStatementFromEffectiveSubstatements(final StatementDefinition statementDef) {
 387         if (effective.isEmpty()) {
 388             return;
 389         }
 390
 391         final Iterator<? extends StmtContext<?, ?, ?>> iterator = effective.iterator();
 392         while (iterator.hasNext()) {
 393             final StmtContext<?, ?, ?> next = iterator.next();
 394             if (statementDef.equals(next.getPublicDefinition())) {
 395                 iterator.remove();
 396             }
 397         }
 398
 399         shrinkEffective();
 400     }
 401
 402     /**
 403      * Removes a statement context from the effective substatements based on its statement definition (i.e statement
 404      * keyword) and raw (in String form) statement argument. The statement context is removed only if both statement
 405      * definition and statement argument match with one of the effective substatements' statement definition
 406      * and argument.
 407      *
 408      * <p>
 409      * If the statementArg parameter is null, the statement context is removed based only on its statement definition.
 410      *
 411      * @param statementDef statement definition of the statement context to remove
 412      * @param statementArg statement argument of the statement context to remove
 413      */
 414     public void removeStatementFromEffectiveSubstatements(final StatementDefinition statementDef,
 415             final String statementArg) {
 416         if (statementArg == null) {
 417             removeStatementFromEffectiveSubstatements(statementDef);
 418         }
 419
 420         if (effective.isEmpty()) {
 421             return;
 422         }
 423
 424         final Iterator<StatementContextBase<?, ?, ?>> iterator = effective.iterator();
 425         while (iterator.hasNext()) {
 426             final Mutable<?, ?, ?> next = iterator.next();
 427             if (statementDef.equals(next.getPublicDefinition()) && statementArg.equals(next.rawStatementArgument())) {
 428                 iterator.remove();
 429             }
 430         }
 431
 432         shrinkEffective();
 433     }
 434
 435     // YANG example: RPC/action statements always have 'input' and 'output' defined
 436     @Beta
 437     public <X, Y extends DeclaredStatement<X>, Z extends EffectiveStatement<X, Y>> @NonNull Mutable<X, Y, Z>
 438             appendImplicitSubstatement(final StatementSupport<X, Y, Z> support, final String rawArg) {
 439         // FIXME: YANGTOOLS-652: This does not need to be a SubstatementContext, in can be a specialized
 440         //                       StatementContextBase subclass.
 441         final Mutable<X, Y, Z> ret = new SubstatementContext<>(this, new StatementDefinitionContext<>(support),
 442                 ImplicitSubstatement.of(getStatementSourceReference()), rawArg);
 443         support.onStatementAdded(ret);
 444         addEffectiveSubstatement(ret);
 445         return ret;
 446     }
 447
 448     /**
 449      * Adds an effective statement to collection of substatements.
 450      *
 451      * @param substatement substatement
 452      * @throws IllegalStateException
 453      *             if added in declared phase
 454      * @throws NullPointerException
 455      *             if statement parameter is null
 456      */
 457     public void addEffectiveSubstatement(final Mutable<?, ?, ?> substatement) {
 458         verifyStatement(substatement);
 459         beforeAddEffectiveStatement(1);
 460
 461         final StatementContextBase<?, ?, ?> stmt = (StatementContextBase<?, ?, ?>) substatement;
 462         final ModelProcessingPhase phase = completedPhase;
 463         if (phase != null) {
 464             ensureCompletedPhase(stmt, phase);
 465         }
 466         effective.add(stmt);
 467     }
 468
 469     /**
 470      * Adds an effective statement to collection of substatements.
 471      *
 472      * @param statements substatements
 473      * @throws IllegalStateException
 474      *             if added in declared phase
 475      * @throws NullPointerException
 476      *             if statement parameter is null
 477      */
 478     public void addEffectiveSubstatements(final Collection<? extends Mutable<?, ?, ?>> statements) {
 479         if (!statements.isEmpty()) {
 480             statements.forEach(StatementContextBase::verifyStatement);
 481             beforeAddEffectiveStatement(statements.size());
 482
 483             final Collection<? extends StatementContextBase<?, ?, ?>> casted =
 484                     (Collection<? extends StatementContextBase<?, ?, ?>>) statements;
 485             final ModelProcessingPhase phase = completedPhase;
 486             if (phase != null) {
 487                 for (StatementContextBase<?, ?, ?> stmt : casted) {
 488                     ensureCompletedPhase(stmt, phase);
 489                 }
 490             }
 491
 492             effective.addAll(casted);
 493         }
 494     }
 495
 496     // Make sure target statement has transitioned at least to specified phase. This method is just before we take
 497     // allow a statement to become our substatement. This is needed to ensure that every statement tree does not contain
 498     // any statements which did not complete the same phase as the root statement.
 499     private static void ensureCompletedPhase(final StatementContextBase<?, ?, ?> stmt,
 500             final ModelProcessingPhase phase) {
 501         verify(stmt.tryToCompletePhase(phase), "Statement %s cannot complete phase %s", stmt, phase);
 502     }
 503
 504     private static void verifyStatement(final Mutable<?, ?, ?> stmt) {
 505         verify(stmt instanceof StatementContextBase, "Unexpected statement %s", stmt);
 506     }
 507
 508     private void beforeAddEffectiveStatement(final int toAdd) {
 509         // We cannot allow statement to be further mutated
 510         final StatementSourceReference ref = getStatementSourceReference();
 511         verify(completedPhase != ModelProcessingPhase.EFFECTIVE_MODEL, "Cannot modify finished statement at %s", ref);
 512
 513         final ModelProcessingPhase inProgressPhase = getRoot().getSourceContext().getInProgressPhase();
 514         checkState(inProgressPhase == ModelProcessingPhase.FULL_DECLARATION
 515                 || inProgressPhase == ModelProcessingPhase.EFFECTIVE_MODEL,
 516                 "Effective statement cannot be added in declared phase at: %s", ref);
 517
 518         if (effective.isEmpty()) {
 519             effective = new ArrayList<>(toAdd);
 520         }
 521     }
 522
 523     // Exists only due to memory optimization
 524     final boolean fullyDefined() {
 525         return fullyDefined;
 526     }
 527
 528     // Exists only due to memory optimization, should live in AbstractResumedStatement
 529     final void setFullyDefined() {
 530         fullyDefined = true;
 531     }
 532
 533     @Override
 534     public E buildEffective() {
 535         final E existing = effectiveInstance;
 536         return existing != null ? existing : (effectiveInstance = definition.getFactory().createEffective(this));
 537     }
 538
 539     /**
 540      * Try to execute current {@link ModelProcessingPhase} of source parsing. If the phase has already been executed,
 541      * this method does nothing.
 542      *
 543      * @param phase to be executed (completed)
 544      * @return true if phase was successfully completed
 545      * @throws SourceException when an error occurred in source parsing
 546      */
 547     final boolean tryToCompletePhase(final ModelProcessingPhase phase) {
 548         return phase.isCompletedBy(completedPhase) || doTryToCompletePhase(phase);
 549     }
 550
 551     private boolean doTryToCompletePhase(final ModelProcessingPhase phase) {
 552         final boolean finished = phaseMutation.isEmpty() ? true : runMutations(phase);
 553         if (completeChildren(phase) && finished) {
 554             onPhaseCompleted(phase);
 555             return true;
 556         }
 557         return false;
 558     }
 559
 560     private boolean completeChildren(final ModelProcessingPhase phase) {
 561         boolean finished = true;
 562         for (final StatementContextBase<?, ?, ?> child : mutableDeclaredSubstatements()) {
 563             finished &= child.tryToCompletePhase(phase);
 564         }
 565         for (final StatementContextBase<?, ?, ?> child : effective) {
 566             finished &= child.tryToCompletePhase(phase);
 567         }
 568         return finished;
 569     }
 570
 571     private boolean runMutations(final ModelProcessingPhase phase) {
 572         final Collection<ContextMutation> openMutations = phaseMutation.get(phase);
 573         return openMutations.isEmpty() ? true : runMutations(phase, openMutations);
 574     }
 575
 576     private boolean runMutations(final ModelProcessingPhase phase, final Collection<ContextMutation> openMutations) {
 577         boolean finished = true;
 578         final Iterator<ContextMutation> it = openMutations.iterator();
 579         while (it.hasNext()) {
 580             final ContextMutation current = it.next();
 581             if (current.isFinished()) {
 582                 it.remove();
 583             } else {
 584                 finished = false;
 585             }
 586         }
 587
 588         if (openMutations.isEmpty()) {
 589             phaseMutation.removeAll(phase);
 590             if (phaseMutation.isEmpty()) {
 591                 phaseMutation = ImmutableMultimap.of();
 592             }
 593         }
 594         return finished;
 595     }
 596
 597     /**
 598      * Occurs on end of {@link ModelProcessingPhase} of source parsing.
 599      *
 600      * @param phase
 601      *            that was to be completed (finished)
 602      * @throws SourceException
 603      *             when an error occurred in source parsing
 604      */
 605     private void onPhaseCompleted(final ModelProcessingPhase phase) {
 606         completedPhase = phase;
 607
 608         final Collection<OnPhaseFinished> listeners = phaseListeners.get(phase);
 609         if (!listeners.isEmpty()) {
 610             runPhaseListeners(phase, listeners);
 611         }
 612     }
 613
 614     private void runPhaseListeners(final ModelProcessingPhase phase, final Collection<OnPhaseFinished> listeners) {
 615         final Iterator<OnPhaseFinished> listener = listeners.iterator();
 616         while (listener.hasNext()) {
 617             final OnPhaseFinished next = listener.next();
 618             if (next.phaseFinished(this, phase)) {
 619                 listener.remove();
 620             }
 621         }
 622
 623         if (listeners.isEmpty()) {
 624             phaseListeners.removeAll(phase);
 625             if (phaseListeners.isEmpty()) {
 626                 phaseListeners = ImmutableMultimap.of();
 627             }
 628         }
 629     }
 630
 631     /**
 632      * Ends declared section of current node.
 633      */
 634     void endDeclared(final ModelProcessingPhase phase) {
 635         definition.onDeclarationFinished(this, phase);
 636     }
 637
 638     /**
 639      * Return the context in which this statement was defined.
 640      *
 641      * @return statement definition
 642      */
 643     protected final @NonNull StatementDefinitionContext<A, D, E> definition() {
 644         return definition;
 645     }
 646
 647     @Override
 648     protected void checkLocalNamespaceAllowed(final Class<? extends IdentifierNamespace<?, ?>> type) {
 649         definition.checkNamespaceAllowed(type);
 650     }
 651
 652     @Override
 653     protected <K, V, N extends IdentifierNamespace<K, V>> void onNamespaceElementAdded(final Class<N> type, final K key,
 654             final V value) {
 655         // definition().onNamespaceElementAdded(this, type, key, value);
 656     }
 657
 658     final <K, V, N extends IdentifierNamespace<K, V>> void onNamespaceItemAddedAction(final Class<N> type, final K key,
 659             final OnNamespaceItemAdded listener) {
 660         final Object potential = getFromNamespace(type, key);
 661         if (potential != null) {
 662             LOG.trace("Listener on {} key {} satisfied immediately", type, key);
 663             listener.namespaceItemAdded(this, type, key, potential);
 664             return;
 665         }
 666
 667         getBehaviour(type).addListener(new KeyedValueAddedListener<>(this, key) {
 668             @Override
 669             void onValueAdded(final Object value) {
 670                 listener.namespaceItemAdded(StatementContextBase.this, type, key, value);
 671             }
 672         });
 673     }
 674
 675     final <K, V, N extends IdentifierNamespace<K, V>> void onNamespaceItemAddedAction(final Class<N> type,
 676             final ModelProcessingPhase phase, final NamespaceKeyCriterion<K> criterion,
 677             final OnNamespaceItemAdded listener) {
 678         final Optional<Entry<K, V>> existing = getFromNamespace(type, criterion);
 679         if (existing.isPresent()) {
 680             final Entry<K, V> entry = existing.get();
 681             LOG.debug("Listener on {} criterion {} found a pre-existing match: {}", type, criterion, entry);
 682             waitForPhase(entry.getValue(), type, phase, criterion, listener);
 683             return;
 684         }
 685
 686         final NamespaceBehaviourWithListeners<K, V, N> behaviour = getBehaviour(type);
 687         behaviour.addListener(new PredicateValueAddedListener<K, V>(this) {
 688             @Override
 689             boolean onValueAdded(final K key, final V value) {
 690                 if (criterion.match(key)) {
 691                     LOG.debug("Listener on {} criterion {} matched added key {}", type, criterion, key);
 692                     waitForPhase(value, type, phase, criterion, listener);
 693                     return true;
 694                 }
 695
 696                 return false;
 697             }
 698         });
 699     }
 700
 701     final <K, V, N extends IdentifierNamespace<K, V>> void selectMatch(final Class<N> type,
 702             final NamespaceKeyCriterion<K> criterion, final OnNamespaceItemAdded listener) {
 703         final Optional<Entry<K, V>> optMatch = getFromNamespace(type, criterion);
 704         checkState(optMatch.isPresent(), "Failed to find a match for criterion %s in namespace %s node %s", criterion,
 705             type, this);
 706         final Entry<K, V> match = optMatch.get();
 707         listener.namespaceItemAdded(StatementContextBase.this, type, match.getKey(), match.getValue());
 708     }
 709
 710     final <K, V, N extends IdentifierNamespace<K, V>> void waitForPhase(final Object value, final Class<N> type,
 711             final ModelProcessingPhase phase, final NamespaceKeyCriterion<K> criterion,
 712             final OnNamespaceItemAdded listener) {
 713         ((StatementContextBase<?, ? ,?>) value).addPhaseCompletedListener(phase,
 714             (context, phaseCompleted) -> {
 715                 selectMatch(type, criterion, listener);
 716                 return true;
 717             });
 718     }
 719
 720     private <K, V, N extends IdentifierNamespace<K, V>> NamespaceBehaviourWithListeners<K, V, N> getBehaviour(
 721             final Class<N> type) {
 722         final NamespaceBehaviour<K, V, N> behaviour = getBehaviourRegistry().getNamespaceBehaviour(type);
 723         checkArgument(behaviour instanceof NamespaceBehaviourWithListeners, "Namespace %s does not support listeners",
 724             type);
 725
 726         return (NamespaceBehaviourWithListeners<K, V, N>) behaviour;
 727     }
 728
 729     @Override
 730     public StatementDefinition getPublicDefinition() {
 731         return definition.getPublicView();
 732     }
 733
 734     @Override
 735     public ModelActionBuilder newInferenceAction(final ModelProcessingPhase phase) {
 736         return getRoot().getSourceContext().newInferenceAction(phase);
 737     }
 738
 739     private static <T> Multimap<ModelProcessingPhase, T> newMultimap() {
 740         return Multimaps.newListMultimap(new EnumMap<>(ModelProcessingPhase.class), () -> new ArrayList<>(1));
 741     }
 742
 743     /**
 744      * Adds {@link OnPhaseFinished} listener for a {@link ModelProcessingPhase} end. If the base has already completed
 745      * the listener is notified immediately.
 746      *
 747      * @param phase requested completion phase
 748      * @param listener listener to invoke
 749      * @throws NullPointerException if any of the arguments is null
 750      */
 751     void addPhaseCompletedListener(final ModelProcessingPhase phase, final OnPhaseFinished listener) {
 752         checkNotNull(phase, "Statement context processing phase cannot be null at: %s", getStatementSourceReference());
 753         checkNotNull(listener, "Statement context phase listener cannot be null at: %s", getStatementSourceReference());
 754
 755         ModelProcessingPhase finishedPhase = completedPhase;
 756         while (finishedPhase != null) {
 757             if (phase.equals(finishedPhase)) {
 758                 listener.phaseFinished(this, finishedPhase);
 759                 return;
 760             }
 761             finishedPhase = finishedPhase.getPreviousPhase();
 762         }
 763         if (phaseListeners.isEmpty()) {
 764             phaseListeners = newMultimap();
 765         }
 766
 767         phaseListeners.put(phase, listener);
 768     }
 769
 770     /**
 771      * Adds a {@link ContextMutation} to a {@link ModelProcessingPhase}.
 772      *
 773      * @throws IllegalStateException
 774      *             when the mutation was registered after phase was completed
 775      */
 776     void addMutation(final ModelProcessingPhase phase, final ContextMutation mutation) {
 777         ModelProcessingPhase finishedPhase = completedPhase;
 778         while (finishedPhase != null) {
 779             checkState(!phase.equals(finishedPhase), "Mutation registered after phase was completed at: %s",
 780                 getStatementSourceReference());
 781             finishedPhase = finishedPhase.getPreviousPhase();
 782         }
 783
 784         if (phaseMutation.isEmpty()) {
 785             phaseMutation = newMultimap();
 786         }
 787         phaseMutation.put(phase, mutation);
 788     }
 789
 790     @Override
 791     public <K, KT extends K, N extends StatementNamespace<K, ?, ?>> void addContext(final Class<N> namespace,
 792             final KT key,final StmtContext<?, ?, ?> stmt) {
 793         addContextToNamespace(namespace, key, stmt);
 794     }
 795
 796     @Override
 797     public Optional<? extends Mutable<?, ?, ?>> copyAsChildOf(final Mutable<?, ?, ?> parent, final CopyType type,
 798             final QNameModule targetModule) {
 799         checkEffectiveModelCompleted(this);
 800
 801         final StatementSupport<A, D, E> support = definition.support();
 802         final CopyPolicy policy = support.applyCopyPolicy(this, parent, type, targetModule);
 803         switch (policy) {
 804             case CONTEXT_INDEPENDENT:
 805                 if (hasEmptySubstatements()) {
 806                     // This statement is context-independent and has no substatements -- hence it can be freely shared.
 807                     return Optional.of(this);
 808                 }
 809                 // FIXME: YANGTOOLS-694: filter out all context-independent substatements, eliminate fall-through
 810                 // fall through
 811             case DECLARED_COPY:
 812                 // FIXME: YANGTOOLS-694: this is still to eager, we really want to copy as a lazily-instantiated
 813                 //                       context, so that we can support building an effective statement without copying
 814                 //                       anything -- we will typically end up not being inferred against. In that case,
 815                 //                       this slim context should end up dealing with differences at buildContext()
 816                 //                       time. This is a YANGTOOLS-1067 prerequisite (which will deal with what can and
 817                 //                       cannot be shared across instances).
 818                 return Optional.of(parent.childCopyOf(this, type, targetModule));
 819             case IGNORE:
 820                 return Optional.empty();
 821             case REJECT:
 822                 throw new IllegalStateException("Statement " + support.getPublicView() + " should never be copied");
 823             default:
 824                 throw new IllegalStateException("Unhandled policy " + policy);
 825         }
 826     }
 827
 828     @Override
 829     public final Mutable<?, ?, ?> childCopyOf(final StmtContext<?, ?, ?> stmt, final CopyType type,
 830             final QNameModule targetModule) {
 831         checkEffectiveModelCompleted(stmt);
 832         checkArgument(stmt instanceof StatementContextBase, "Unsupported statement %s", stmt);
 833         return childCopyOf((StatementContextBase<?, ?, ?>) stmt, type, targetModule);
 834     }
 835
 836     private <X, Y extends DeclaredStatement<X>, Z extends EffectiveStatement<X, Y>> Mutable<X, Y, Z> childCopyOf(
 837             final StatementContextBase<X, Y, Z> original, final CopyType type, final QNameModule targetModule) {
 838         final Optional<StatementSupport<?, ?, ?>> implicitParent = definition.getImplicitParentFor(
 839             original.getPublicDefinition());
 840
 841         final StatementContextBase<X, Y, Z> result;
 842         final InferredStatementContext<X, Y, Z> copy;
 843
 844         if (implicitParent.isPresent()) {
 845             final StatementDefinitionContext<?, ?, ?> def = new StatementDefinitionContext<>(implicitParent.get());
 846             result = new SubstatementContext(this, def, original.getStatementSourceReference(),
 847                 original.rawStatementArgument(), original.getStatementArgument(), type);
 848
 849             final CopyType childCopyType;
 850             switch (type) {
 851                 case ADDED_BY_AUGMENTATION:
 852                     childCopyType = CopyType.ORIGINAL;
 853                     break;
 854                 case ADDED_BY_USES_AUGMENTATION:
 855                     childCopyType = CopyType.ADDED_BY_USES;
 856                     break;
 857                 case ADDED_BY_USES:
 858                 case ORIGINAL:
 859                 default:
 860                     childCopyType = type;
 861             }
 862
 863             copy = new InferredStatementContext<>(result, original, childCopyType, type, targetModule);
 864             result.addEffectiveSubstatement(copy);
 865         } else {
 866             result = copy = new InferredStatementContext<>(this, original, type, type, targetModule);
 867         }
 868
 869         original.definition.onStatementAdded(copy);
 870         return result;
 871     }
 872
 873     private static void checkEffectiveModelCompleted(final StmtContext<?, ?, ?> stmt) {
 874         final ModelProcessingPhase phase = stmt.getCompletedPhase();
 875         checkState(phase == ModelProcessingPhase.EFFECTIVE_MODEL,
 876                 "Attempted to copy statement %s which has completed phase %s", stmt, phase);
 877     }
 878
 879     @Beta
 880     public final boolean hasImplicitParentSupport() {
 881         return definition.getFactory() instanceof ImplicitParentAwareStatementSupport;
 882     }
 883
 884     @Beta
 885     public final StatementContextBase<?, ?, ?> wrapWithImplicit(final StatementContextBase<?, ?, ?> original) {
 886         final Optional<StatementSupport<?, ?, ?>> optImplicit = definition.getImplicitParentFor(
 887             original.getPublicDefinition());
 888         if (optImplicit.isEmpty()) {
 889             return original;
 890         }
 891
 892         final StatementDefinitionContext<?, ?, ?> def = new StatementDefinitionContext<>(optImplicit.get());
 893         final CopyType type = original.getCopyHistory().getLastOperation();
 894         final SubstatementContext<?, ?, ?> result = new SubstatementContext(original.getParentContext(), def,
 895             original.getStatementSourceReference(), original.rawStatementArgument(), original.getStatementArgument(),
 896             type);
 897
 898         result.addEffectiveSubstatement(original.reparent(result));
 899         result.setCompletedPhase(original.getCompletedPhase());
 900         return result;
 901     }
 902
 903     abstract StatementContextBase<A, D, E> reparent(StatementContextBase<?, ?, ?> newParent);
 904
 905     /**
 906      * Indicate that the set of substatements is empty. This is a preferred shortcut to substatement stream filtering.
 907      *
 908      * @return True if {@link #allSubstatements()} and {@link #allSubstatementsStream()} would return an empty stream.
 909      */
 910     abstract boolean hasEmptySubstatements();
 911
 912     final boolean hasEmptyEffectiveSubstatements() {
 913         return effective.isEmpty();
 914     }
 915
 916     /**
 917      * Config statements are not all that common which means we are performing a recursive search towards the root
 918      * every time {@link #isConfiguration()} is invoked. This is quite expensive because it causes a linear search
 919      * for the (usually non-existent) config statement.
 920      *
 921      * <p>
 922      * This method maintains a resolution cache, so once we have returned a result, we will keep on returning the same
 923      * result without performing any lookups, solely to support {@link SubstatementContext#isConfiguration()}.
 924      *
 925      * <p>
 926      * Note: use of this method implies that {@link #isIgnoringConfig()} is realized with
 927      *       {@link #isIgnoringConfig(StatementContextBase)}.
 928      */
 929     final boolean isConfiguration(final StatementContextBase<?, ?, ?> parent) {
 930         final int fl = flags & SET_CONFIGURATION;
 931         if (fl != 0) {
 932             return fl == SET_CONFIGURATION;
 933         }
 934         if (isIgnoringConfig(parent)) {
 935             // Note: SET_CONFIGURATION has been stored in flags
 936             return true;
 937         }
 938
 939         final StmtContext<Boolean, ?, ?> configStatement = StmtContextUtils.findFirstSubstatement(this,
 940             ConfigStatement.class);
 941         final boolean isConfig;
 942         if (configStatement != null) {
 943             isConfig = configStatement.coerceStatementArgument();
 944             if (isConfig) {
 945                 // Validity check: if parent is config=false this cannot be a config=true
 946                 InferenceException.throwIf(!parent.isConfiguration(), getStatementSourceReference(),
 947                         "Parent node has config=false, this node must not be specifed as config=true");
 948             }
 949         } else {
 950             // If "config" statement is not specified, the default is the same as the parent's "config" value.
 951             isConfig = parent.isConfiguration();
 952         }
 953
 954         // Resolved, make sure we cache this return
 955         flags |= isConfig ? SET_CONFIGURATION : HAVE_CONFIGURATION;
 956         return isConfig;
 957     }
 958
 959     protected abstract boolean isIgnoringConfig();
 960
 961     /**
 962      * This method maintains a resolution cache for ignore config, so once we have returned a result, we will
 963      * keep on returning the same result without performing any lookups. Exists only to support
 964      * {@link SubstatementContext#isIgnoringConfig()}.
 965      *
 966      * <p>
 967      * Note: use of this method implies that {@link #isConfiguration()} is realized with
 968      *       {@link #isConfiguration(StatementContextBase)}.
 969      */
 970     final boolean isIgnoringConfig(final StatementContextBase<?, ?, ?> parent) {
 971         final int fl = flags & SET_IGNORE_CONFIG;
 972         if (fl != 0) {
 973             return fl == SET_IGNORE_CONFIG;
 974         }
 975         if (definition.support().isIgnoringConfig() || parent.isIgnoringConfig()) {
 976             flags |= SET_IGNORE_CONFIG;
 977             return true;
 978         }
 979
 980         flags |= HAVE_IGNORE_CONFIG;
 981         return false;
 982     }
 983
 984     protected abstract boolean isIgnoringIfFeatures();
 985
 986     /**
 987      * This method maintains a resolution cache for ignore if-feature, so once we have returned a result, we will
 988      * keep on returning the same result without performing any lookups. Exists only to support
 989      * {@link SubstatementContext#isIgnoringIfFeatures()}.
 990      */
 991     final boolean isIgnoringIfFeatures(final StatementContextBase<?, ?, ?> parent) {
 992         final int fl = flags & SET_IGNORE_IF_FEATURE;
 993         if (fl != 0) {
 994             return fl == SET_IGNORE_IF_FEATURE;
 995         }
 996         if (definition.support().isIgnoringIfFeatures() || parent.isIgnoringIfFeatures()) {
 997             flags |= SET_IGNORE_IF_FEATURE;
 998             return true;
 999         }
1000
1001         flags |= HAVE_IGNORE_IF_FEATURE;
1002         return false;
1003     }
1004
1005     // Exists only to support SubstatementContext/InferredStatementContext
1006     final @NonNull Optional<SchemaPath> substatementGetSchemaPath() {
1007         SchemaPath local = schemaPath;
1008         if (local == null) {
1009             synchronized (this) {
1010                 local = schemaPath;
1011                 if (local == null) {
1012                     local = createSchemaPath(coerceParentContext());
1013                     schemaPath = local;
1014                 }
1015             }
1016         }
1017
1018         return Optional.ofNullable(local);
1019     }
1020
1021     private SchemaPath createSchemaPath(final Mutable<?, ?, ?> parent) {
1022         final Optional<SchemaPath> maybeParentPath = parent.getSchemaPath();
1023         verify(maybeParentPath.isPresent(), "Parent %s does not have a SchemaPath", parent);
1024         final SchemaPath parentPath = maybeParentPath.get();
1025
1026         if (StmtContextUtils.isUnknownStatement(this)) {
1027             return parentPath.createChild(getPublicDefinition().getStatementName());
1028         }
1029         final Object argument = getStatementArgument();
1030         if (argument instanceof QName) {
1031             final QName qname = (QName) argument;
1032             if (StmtContextUtils.producesDeclared(this, UsesStatement.class)) {
1033                 return maybeParentPath.orElse(null);
1034             }
1035
1036             return parentPath.createChild(qname);
1037         }
1038         if (argument instanceof String) {
1039             // FIXME: This may yield illegal argument exceptions
1040             final Optional<StmtContext<A, D, E>> originalCtx = getOriginalCtx();
1041             final QName qname = StmtContextUtils.qnameFromArgument(originalCtx.orElse(this), (String) argument);
1042             return parentPath.createChild(qname);
1043         }
1044         if (argument instanceof SchemaNodeIdentifier
1045                 && (StmtContextUtils.producesDeclared(this, AugmentStatement.class)
1046                         || StmtContextUtils.producesDeclared(this, RefineStatement.class)
1047                         || StmtContextUtils.producesDeclared(this, DeviationStatement.class))) {
1048
1049             return parentPath.createChild(((SchemaNodeIdentifier) argument).getPathFromRoot());
1050         }
1051
1052         // FIXME: this does not look right
1053         return maybeParentPath.orElse(null);
1054     }
1055
1056     @Override
1057     public final String toString() {
1058         return addToStringAttributes(MoreObjects.toStringHelper(this).omitNullValues()).toString();
1059     }
1060
1061     protected ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) {
1062         return toStringHelper.add("definition", definition).add("rawArgument", rawStatementArgument());
1063     }
1064 }