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.Objects;
  34 import java.util.Optional;
  35 import java.util.Set;
  36 import org.eclipse.jdt.annotation.NonNull;
  37 import org.eclipse.jdt.annotation.Nullable;
  38 import org.opendaylight.yangtools.yang.common.QName;
  39 import org.opendaylight.yangtools.yang.common.QNameModule;
  40 import org.opendaylight.yangtools.yang.common.YangVersion;
  41 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  42 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
  43 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  44 import org.opendaylight.yangtools.yang.model.api.meta.IdentifierNamespace;
  45 import org.opendaylight.yangtools.yang.model.api.meta.StatementDefinition;
  46 import org.opendaylight.yangtools.yang.model.api.meta.StatementSource;
  47 import org.opendaylight.yangtools.yang.model.api.stmt.AugmentStatement;
  48 import org.opendaylight.yangtools.yang.model.api.stmt.ConfigStatement;
  49 import org.opendaylight.yangtools.yang.model.api.stmt.DeviationStatement;
  50 import org.opendaylight.yangtools.yang.model.api.stmt.RefineStatement;
  51 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier;
  52 import org.opendaylight.yangtools.yang.model.api.stmt.UsesStatement;
  53 import org.opendaylight.yangtools.yang.model.repo.api.SourceIdentifier;
  54 import org.opendaylight.yangtools.yang.parser.spi.meta.CopyHistory;
  55 import org.opendaylight.yangtools.yang.parser.spi.meta.CopyType;
  56 import org.opendaylight.yangtools.yang.parser.spi.meta.ImplicitParentAwareStatementSupport;
  57 import org.opendaylight.yangtools.yang.parser.spi.meta.InferenceException;
  58 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder;
  59 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase;
  60 import org.opendaylight.yangtools.yang.parser.spi.meta.MutableStatement;
  61 import org.opendaylight.yangtools.yang.parser.spi.meta.NamespaceBehaviour;
  62 import org.opendaylight.yangtools.yang.parser.spi.meta.NamespaceBehaviour.Registry;
  63 import org.opendaylight.yangtools.yang.parser.spi.meta.NamespaceKeyCriterion;
  64 import org.opendaylight.yangtools.yang.parser.spi.meta.NamespaceNotAvailableException;
  65 import org.opendaylight.yangtools.yang.parser.spi.meta.StatementNamespace;
  66 import org.opendaylight.yangtools.yang.parser.spi.meta.StatementSupport;
  67 import org.opendaylight.yangtools.yang.parser.spi.meta.StatementSupport.CopyPolicy;
  68 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  69 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
  70 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
  71 import org.opendaylight.yangtools.yang.parser.spi.source.ImplicitSubstatement;
  72 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
  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<Mutable<?, ?, ?>> 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     @Override
 264     public void setCompletedPhase(final ModelProcessingPhase completedPhase) {
 265         this.completedPhase = completedPhase;
 266     }
 267
 268     @Override
 269     public abstract StatementContextBase<?, ?, ?> getParentContext();
 270
 271     /**
 272      * Returns the model root for this statement.
 273      *
 274      * @return root context of statement
 275      */
 276     @Override
 277     public abstract RootStatementContext<?, ?, ?> getRoot();
 278
 279     @Override
 280     public final @NonNull Registry getBehaviourRegistry() {
 281         return getRoot().getBehaviourRegistryImpl();
 282     }
 283
 284     @Override
 285     public final YangVersion getRootVersion() {
 286         return getRoot().getRootVersionImpl();
 287     }
 288
 289     @Override
 290     public final void setRootVersion(final YangVersion version) {
 291         getRoot().setRootVersionImpl(version);
 292     }
 293
 294     @Override
 295     public final void addMutableStmtToSeal(final MutableStatement mutableStatement) {
 296         getRoot().addMutableStmtToSealImpl(mutableStatement);
 297     }
 298
 299     @Override
 300     public final void addRequiredSource(final SourceIdentifier dependency) {
 301         getRoot().addRequiredSourceImpl(dependency);
 302     }
 303
 304     @Override
 305     public final void setRootIdentifier(final SourceIdentifier identifier) {
 306         getRoot().setRootIdentifierImpl(identifier);
 307     }
 308
 309     @Override
 310     public final boolean isEnabledSemanticVersioning() {
 311         return getRoot().isEnabledSemanticVersioningImpl();
 312     }
 313
 314     @Override
 315     public StatementSource getStatementSource() {
 316         return getStatementSourceReference().getStatementSource();
 317     }
 318
 319     @Override
 320     public final <K, V, N extends IdentifierNamespace<K, V>> Map<K, V> getAllFromCurrentStmtCtxNamespace(
 321             final Class<N> type) {
 322         return getLocalNamespace(type);
 323     }
 324
 325     @Override
 326     public final <K, V, N extends IdentifierNamespace<K, V>> Map<K, V> getAllFromNamespace(final Class<N> type) {
 327         return getNamespace(type);
 328     }
 329
 330     /**
 331      * Associate a value with a key within a namespace.
 332      *
 333      * @param type Namespace type
 334      * @param key Key
 335      * @param value value
 336      * @param <K> namespace key type
 337      * @param <V> namespace value type
 338      * @param <N> namespace type
 339      * @param <T> key type
 340      * @param <U> value type
 341      * @throws NamespaceNotAvailableException when the namespace is not available.
 342      */
 343     @Override
 344     public final <K, V, T extends K, U extends V, N extends IdentifierNamespace<K, V>> void addToNs(
 345             final Class<N> type, final T key, final U value) {
 346         addToNamespace(type, key, value);
 347     }
 348
 349     @Override
 350     public abstract Collection<? extends StatementContextBase<?, ?, ?>> mutableDeclaredSubstatements();
 351
 352     /**
 353      * Return a value associated with specified key within a namespace.
 354      *
 355      * @param type Namespace type
 356      * @param key Key
 357      * @param <K> namespace key type
 358      * @param <V> namespace value type
 359      * @param <N> namespace type
 360      * @param <T> key type
 361      * @return Value, or null if there is no element
 362      * @throws NamespaceNotAvailableException when the namespace is not available.
 363      */
 364     @Override
 365     public final <K, V, T extends K, N extends IdentifierNamespace<K, V>> V getFromNamespace(final Class<N> type,
 366             final T key) {
 367         return getBehaviourRegistry().getNamespaceBehaviour(type).getFrom(this, key);
 368     }
 369
 370     @Override
 371     public Collection<? extends Mutable<?, ?, ?>> mutableEffectiveSubstatements() {
 372         if (effective instanceof ImmutableCollection) {
 373             return effective;
 374         }
 375
 376         return Collections.unmodifiableCollection(effective);
 377     }
 378
 379     /**
 380      * Remove a set of statements from effective statements.
 381      *
 382      * @param statements statements to be removed
 383      * @deprecated This method was used by EffectiveStatementBase to restore proper order of effects of uses statements.
 384      *             It is no longer used in that capacity and slated for removal.
 385      */
 386     // FIXME: 5.0.0: remove this method
 387     @Deprecated(forRemoval = true)
 388     public void removeStatementsFromEffectiveSubstatements(
 389             final Collection<? extends StmtContext<?, ?, ?>> statements) {
 390         if (!effective.isEmpty()) {
 391             effective.removeAll(statements);
 392             shrinkEffective();
 393         }
 394     }
 395
 396     private void shrinkEffective() {
 397         if (effective.isEmpty()) {
 398             effective = ImmutableList.of();
 399         }
 400     }
 401
 402     public void removeStatementFromEffectiveSubstatements(final StatementDefinition statementDef) {
 403         if (effective.isEmpty()) {
 404             return;
 405         }
 406
 407         final Iterator<? extends StmtContext<?, ?, ?>> iterator = effective.iterator();
 408         while (iterator.hasNext()) {
 409             final StmtContext<?, ?, ?> next = iterator.next();
 410             if (statementDef.equals(next.getPublicDefinition())) {
 411                 iterator.remove();
 412             }
 413         }
 414
 415         shrinkEffective();
 416     }
 417
 418     /**
 419      * Removes a statement context from the effective substatements based on its statement definition (i.e statement
 420      * keyword) and raw (in String form) statement argument. The statement context is removed only if both statement
 421      * definition and statement argument match with one of the effective substatements' statement definition
 422      * and argument.
 423      *
 424      * <p>
 425      * If the statementArg parameter is null, the statement context is removed based only on its statement definition.
 426      *
 427      * @param statementDef statement definition of the statement context to remove
 428      * @param statementArg statement argument of the statement context to remove
 429      */
 430     public void removeStatementFromEffectiveSubstatements(final StatementDefinition statementDef,
 431             final String statementArg) {
 432         if (statementArg == null) {
 433             removeStatementFromEffectiveSubstatements(statementDef);
 434         }
 435
 436         if (effective.isEmpty()) {
 437             return;
 438         }
 439
 440         final Iterator<Mutable<?, ?, ?>> iterator = effective.iterator();
 441         while (iterator.hasNext()) {
 442             final Mutable<?, ?, ?> next = iterator.next();
 443             if (statementDef.equals(next.getPublicDefinition()) && statementArg.equals(next.rawStatementArgument())) {
 444                 iterator.remove();
 445             }
 446         }
 447
 448         shrinkEffective();
 449     }
 450
 451     // YANG example: RPC/action statements always have 'input' and 'output' defined
 452     @Beta
 453     public <X, Y extends DeclaredStatement<X>, Z extends EffectiveStatement<X, Y>> @NonNull Mutable<X, Y, Z>
 454             appendImplicitSubstatement(final StatementSupport<X, Y, Z> support, final String rawArg) {
 455         // FIXME: YANGTOOLS-652: This does not need to be a SubstatementContext, in can be a specialized
 456         //                       StatementContextBase subclass.
 457         final Mutable<X, Y, Z> ret = new SubstatementContext<>(this, new StatementDefinitionContext<>(support),
 458                 ImplicitSubstatement.of(getStatementSourceReference()), rawArg);
 459         support.onStatementAdded(ret);
 460         addEffectiveSubstatement(ret);
 461         return ret;
 462     }
 463
 464     /**
 465      * Adds an effective statement to collection of substatements.
 466      *
 467      * @param substatement substatement
 468      * @throws IllegalStateException
 469      *             if added in declared phase
 470      * @throws NullPointerException
 471      *             if statement parameter is null
 472      */
 473     public void addEffectiveSubstatement(final Mutable<?, ?, ?> substatement) {
 474         beforeAddEffectiveStatement(1);
 475         effective.add(substatement);
 476     }
 477
 478     /**
 479      * Adds an effective statement to collection of substatements.
 480      *
 481      * @param statements substatements
 482      * @throws IllegalStateException
 483      *             if added in declared phase
 484      * @throws NullPointerException
 485      *             if statement parameter is null
 486      */
 487     public void addEffectiveSubstatements(final Collection<? extends Mutable<?, ?, ?>> statements) {
 488         if (statements.isEmpty()) {
 489             return;
 490         }
 491
 492         statements.forEach(Objects::requireNonNull);
 493         beforeAddEffectiveStatement(statements.size());
 494         effective.addAll(statements);
 495     }
 496
 497     private void beforeAddEffectiveStatement(final int toAdd) {
 498         final ModelProcessingPhase inProgressPhase = getRoot().getSourceContext().getInProgressPhase();
 499         checkState(inProgressPhase == ModelProcessingPhase.FULL_DECLARATION
 500                 || inProgressPhase == ModelProcessingPhase.EFFECTIVE_MODEL,
 501                 "Effective statement cannot be added in declared phase at: %s", getStatementSourceReference());
 502
 503         if (effective.isEmpty()) {
 504             effective = new ArrayList<>(toAdd);
 505         }
 506     }
 507
 508     // Exists only due to memory optimization
 509     final boolean fullyDefined() {
 510         return fullyDefined;
 511     }
 512
 513     // Exists only due to memory optimization, should live in AbstractResumedStatement
 514     final void setFullyDefined() {
 515         fullyDefined = true;
 516     }
 517
 518     @Override
 519     public E buildEffective() {
 520         final E existing = effectiveInstance;
 521         return existing != null ? existing : (effectiveInstance = definition.getFactory().createEffective(this));
 522     }
 523
 524     /**
 525      * Try to execute current {@link ModelProcessingPhase} of source parsing.
 526      *
 527      * @param phase to be executed (completed)
 528      * @return if phase was successfully completed
 529      * @throws SourceException when an error occurred in source parsing
 530      */
 531     final boolean tryToCompletePhase(final ModelProcessingPhase phase) {
 532         final boolean finished = phaseMutation.isEmpty() ? true : runMutations(phase);
 533         if (completeChildren(phase) && finished) {
 534             onPhaseCompleted(phase);
 535             return true;
 536         }
 537         return false;
 538     }
 539
 540     private boolean completeChildren(final ModelProcessingPhase phase) {
 541         boolean finished = true;
 542         for (final StatementContextBase<?, ?, ?> child : mutableDeclaredSubstatements()) {
 543             finished &= child.tryToCompletePhase(phase);
 544         }
 545         for (final Mutable<?, ?, ?> child : effective) {
 546             if (child instanceof StatementContextBase) {
 547                 finished &= ((StatementContextBase<?, ?, ?>) child).tryToCompletePhase(phase);
 548             }
 549         }
 550         return finished;
 551     }
 552
 553     private boolean runMutations(final ModelProcessingPhase phase) {
 554         final Collection<ContextMutation> openMutations = phaseMutation.get(phase);
 555         return openMutations.isEmpty() ? true : runMutations(phase, openMutations);
 556     }
 557
 558     private boolean runMutations(final ModelProcessingPhase phase, final Collection<ContextMutation> openMutations) {
 559         boolean finished = true;
 560         final Iterator<ContextMutation> it = openMutations.iterator();
 561         while (it.hasNext()) {
 562             final ContextMutation current = it.next();
 563             if (current.isFinished()) {
 564                 it.remove();
 565             } else {
 566                 finished = false;
 567             }
 568         }
 569
 570         if (openMutations.isEmpty()) {
 571             phaseMutation.removeAll(phase);
 572             if (phaseMutation.isEmpty()) {
 573                 phaseMutation = ImmutableMultimap.of();
 574             }
 575         }
 576         return finished;
 577     }
 578
 579     /**
 580      * Occurs on end of {@link ModelProcessingPhase} of source parsing.
 581      *
 582      * @param phase
 583      *            that was to be completed (finished)
 584      * @throws SourceException
 585      *             when an error occurred in source parsing
 586      */
 587     private void onPhaseCompleted(final ModelProcessingPhase phase) {
 588         completedPhase = phase;
 589
 590         final Collection<OnPhaseFinished> listeners = phaseListeners.get(phase);
 591         if (listeners.isEmpty()) {
 592             return;
 593         }
 594
 595         final Iterator<OnPhaseFinished> listener = listeners.iterator();
 596         while (listener.hasNext()) {
 597             final OnPhaseFinished next = listener.next();
 598             if (next.phaseFinished(this, phase)) {
 599                 listener.remove();
 600             }
 601         }
 602
 603         if (listeners.isEmpty()) {
 604             phaseListeners.removeAll(phase);
 605             if (phaseListeners.isEmpty()) {
 606                 phaseListeners = ImmutableMultimap.of();
 607             }
 608         }
 609     }
 610
 611     /**
 612      * Ends declared section of current node.
 613      */
 614     void endDeclared(final ModelProcessingPhase phase) {
 615         definition.onDeclarationFinished(this, phase);
 616     }
 617
 618     /**
 619      * Return the context in which this statement was defined.
 620      *
 621      * @return statement definition
 622      */
 623     protected final @NonNull StatementDefinitionContext<A, D, E> definition() {
 624         return definition;
 625     }
 626
 627     @Override
 628     protected void checkLocalNamespaceAllowed(final Class<? extends IdentifierNamespace<?, ?>> type) {
 629         definition.checkNamespaceAllowed(type);
 630     }
 631
 632     @Override
 633     protected <K, V, N extends IdentifierNamespace<K, V>> void onNamespaceElementAdded(final Class<N> type, final K key,
 634             final V value) {
 635         // definition().onNamespaceElementAdded(this, type, key, value);
 636     }
 637
 638     final <K, V, N extends IdentifierNamespace<K, V>> void onNamespaceItemAddedAction(final Class<N> type, final K key,
 639             final OnNamespaceItemAdded listener) {
 640         final Object potential = getFromNamespace(type, key);
 641         if (potential != null) {
 642             LOG.trace("Listener on {} key {} satisfied immediately", type, key);
 643             listener.namespaceItemAdded(this, type, key, potential);
 644             return;
 645         }
 646
 647         getBehaviour(type).addListener(new KeyedValueAddedListener<>(this, key) {
 648             @Override
 649             void onValueAdded(final Object value) {
 650                 listener.namespaceItemAdded(StatementContextBase.this, type, key, value);
 651             }
 652         });
 653     }
 654
 655     final <K, V, N extends IdentifierNamespace<K, V>> void onNamespaceItemAddedAction(final Class<N> type,
 656             final ModelProcessingPhase phase, final NamespaceKeyCriterion<K> criterion,
 657             final OnNamespaceItemAdded listener) {
 658         final Optional<Entry<K, V>> existing = getFromNamespace(type, criterion);
 659         if (existing.isPresent()) {
 660             final Entry<K, V> entry = existing.get();
 661             LOG.debug("Listener on {} criterion {} found a pre-existing match: {}", type, criterion, entry);
 662             waitForPhase(entry.getValue(), type, phase, criterion, listener);
 663             return;
 664         }
 665
 666         final NamespaceBehaviourWithListeners<K, V, N> behaviour = getBehaviour(type);
 667         behaviour.addListener(new PredicateValueAddedListener<K, V>(this) {
 668             @Override
 669             boolean onValueAdded(final K key, final V value) {
 670                 if (criterion.match(key)) {
 671                     LOG.debug("Listener on {} criterion {} matched added key {}", type, criterion, key);
 672                     waitForPhase(value, type, phase, criterion, listener);
 673                     return true;
 674                 }
 675
 676                 return false;
 677             }
 678         });
 679     }
 680
 681     final <K, V, N extends IdentifierNamespace<K, V>> void selectMatch(final Class<N> type,
 682             final NamespaceKeyCriterion<K> criterion, final OnNamespaceItemAdded listener) {
 683         final Optional<Entry<K, V>> optMatch = getFromNamespace(type, criterion);
 684         checkState(optMatch.isPresent(), "Failed to find a match for criterion %s in namespace %s node %s", criterion,
 685             type, this);
 686         final Entry<K, V> match = optMatch.get();
 687         listener.namespaceItemAdded(StatementContextBase.this, type, match.getKey(), match.getValue());
 688     }
 689
 690     final <K, V, N extends IdentifierNamespace<K, V>> void waitForPhase(final Object value, final Class<N> type,
 691             final ModelProcessingPhase phase, final NamespaceKeyCriterion<K> criterion,
 692             final OnNamespaceItemAdded listener) {
 693         ((StatementContextBase<?, ? ,?>) value).addPhaseCompletedListener(phase,
 694             (context, phaseCompleted) -> {
 695                 selectMatch(type, criterion, listener);
 696                 return true;
 697             });
 698     }
 699
 700     private <K, V, N extends IdentifierNamespace<K, V>> NamespaceBehaviourWithListeners<K, V, N> getBehaviour(
 701             final Class<N> type) {
 702         final NamespaceBehaviour<K, V, N> behaviour = getBehaviourRegistry().getNamespaceBehaviour(type);
 703         checkArgument(behaviour instanceof NamespaceBehaviourWithListeners, "Namespace %s does not support listeners",
 704             type);
 705
 706         return (NamespaceBehaviourWithListeners<K, V, N>) behaviour;
 707     }
 708
 709     @Override
 710     public StatementDefinition getPublicDefinition() {
 711         return definition.getPublicView();
 712     }
 713
 714     @Override
 715     public ModelActionBuilder newInferenceAction(final ModelProcessingPhase phase) {
 716         return getRoot().getSourceContext().newInferenceAction(phase);
 717     }
 718
 719     private static <T> Multimap<ModelProcessingPhase, T> newMultimap() {
 720         return Multimaps.newListMultimap(new EnumMap<>(ModelProcessingPhase.class), () -> new ArrayList<>(1));
 721     }
 722
 723     /**
 724      * Adds {@link OnPhaseFinished} listener for a {@link ModelProcessingPhase} end. If the base has already completed
 725      * the listener is notified immediately.
 726      *
 727      * @param phase requested completion phase
 728      * @param listener listener to invoke
 729      * @throws NullPointerException if any of the arguments is null
 730      */
 731     void addPhaseCompletedListener(final ModelProcessingPhase phase, final OnPhaseFinished listener) {
 732         checkNotNull(phase, "Statement context processing phase cannot be null at: %s", getStatementSourceReference());
 733         checkNotNull(listener, "Statement context phase listener cannot be null at: %s", getStatementSourceReference());
 734
 735         ModelProcessingPhase finishedPhase = completedPhase;
 736         while (finishedPhase != null) {
 737             if (phase.equals(finishedPhase)) {
 738                 listener.phaseFinished(this, finishedPhase);
 739                 return;
 740             }
 741             finishedPhase = finishedPhase.getPreviousPhase();
 742         }
 743         if (phaseListeners.isEmpty()) {
 744             phaseListeners = newMultimap();
 745         }
 746
 747         phaseListeners.put(phase, listener);
 748     }
 749
 750     /**
 751      * Adds a {@link ContextMutation} to a {@link ModelProcessingPhase}.
 752      *
 753      * @throws IllegalStateException
 754      *             when the mutation was registered after phase was completed
 755      */
 756     void addMutation(final ModelProcessingPhase phase, final ContextMutation mutation) {
 757         ModelProcessingPhase finishedPhase = completedPhase;
 758         while (finishedPhase != null) {
 759             checkState(!phase.equals(finishedPhase), "Mutation registered after phase was completed at: %s",
 760                 getStatementSourceReference());
 761             finishedPhase = finishedPhase.getPreviousPhase();
 762         }
 763
 764         if (phaseMutation.isEmpty()) {
 765             phaseMutation = newMultimap();
 766         }
 767         phaseMutation.put(phase, mutation);
 768     }
 769
 770     @Override
 771     public <K, KT extends K, N extends StatementNamespace<K, ?, ?>> void addContext(final Class<N> namespace,
 772             final KT key,final StmtContext<?, ?, ?> stmt) {
 773         addContextToNamespace(namespace, key, stmt);
 774     }
 775
 776     @Override
 777     public Optional<? extends Mutable<?, ?, ?>> copyAsChildOf(final Mutable<?, ?, ?> parent, final CopyType type,
 778             final QNameModule targetModule) {
 779         checkEffectiveModelCompleted(this);
 780
 781         final StatementSupport<A, D, E> support = definition.support();
 782         final CopyPolicy policy = support.applyCopyPolicy(this, parent, type, targetModule);
 783         switch (policy) {
 784             case CONTEXT_INDEPENDENT:
 785                 if (hasEmptySubstatements()) {
 786                     // This statement is context-independent and has no substatements -- hence it can be freely shared.
 787                     return Optional.of(this);
 788                 }
 789                 // FIXME: YANGTOOLS-694: filter out all context-independent substatements, eliminate fall-through
 790                 // fall through
 791             case DECLARED_COPY:
 792                 // FIXME: YANGTOOLS-694: this is still to eager, we really want to copy as a lazily-instantiated
 793                 //                       context, so that we can support building an effective statement without copying
 794                 //                       anything -- we will typically end up not being inferred against. In that case,
 795                 //                       this slim context should end up dealing with differences at buildContext()
 796                 //                       time. This is a YANGTOOLS-1067 prerequisite (which will deal with what can and
 797                 //                       cannot be shared across instances).
 798                 return Optional.of(parent.childCopyOf(this, type, targetModule));
 799             case IGNORE:
 800                 return Optional.empty();
 801             case REJECT:
 802                 throw new IllegalStateException("Statement " + support.getPublicView() + " should never be copied");
 803             default:
 804                 throw new IllegalStateException("Unhandled policy " + policy);
 805         }
 806     }
 807
 808     @Override
 809     public <X, Y extends DeclaredStatement<X>, Z extends EffectiveStatement<X, Y>> Mutable<X, Y, Z> childCopyOf(
 810             final StmtContext<X, Y, Z> stmt, final CopyType type, final QNameModule targetModule) {
 811         checkEffectiveModelCompleted(stmt);
 812         checkArgument(stmt instanceof StatementContextBase, "Unsupported statement %s", stmt);
 813         return childCopyOf((StatementContextBase<X, Y, Z>)stmt, type, targetModule);
 814     }
 815
 816     private <X, Y extends DeclaredStatement<X>, Z extends EffectiveStatement<X, Y>> Mutable<X, Y, Z> childCopyOf(
 817             final StatementContextBase<X, Y, Z> original, final CopyType type, final QNameModule targetModule) {
 818         final Optional<StatementSupport<?, ?, ?>> implicitParent = definition.getImplicitParentFor(
 819             original.getPublicDefinition());
 820
 821         final StatementContextBase<X, Y, Z> result;
 822         final InferredStatementContext<X, Y, Z> copy;
 823
 824         if (implicitParent.isPresent()) {
 825             final StatementDefinitionContext<?, ?, ?> def = new StatementDefinitionContext<>(implicitParent.get());
 826             result = new SubstatementContext(this, def, original.getStatementSourceReference(),
 827                 original.rawStatementArgument(), original.getStatementArgument(), type);
 828
 829             final CopyType childCopyType;
 830             switch (type) {
 831                 case ADDED_BY_AUGMENTATION:
 832                     childCopyType = CopyType.ORIGINAL;
 833                     break;
 834                 case ADDED_BY_USES_AUGMENTATION:
 835                     childCopyType = CopyType.ADDED_BY_USES;
 836                     break;
 837                 case ADDED_BY_USES:
 838                 case ORIGINAL:
 839                 default:
 840                     childCopyType = type;
 841             }
 842
 843             copy = new InferredStatementContext<>(result, original, childCopyType, type, targetModule);
 844             result.addEffectiveSubstatement(copy);
 845         } else {
 846             result = copy = new InferredStatementContext<>(this, original, type, type, targetModule);
 847         }
 848
 849         original.definition.onStatementAdded(copy);
 850         return result;
 851     }
 852
 853     private static void checkEffectiveModelCompleted(final StmtContext<?, ?, ?> stmt) {
 854         final ModelProcessingPhase phase = stmt.getCompletedPhase();
 855         checkState(phase == ModelProcessingPhase.EFFECTIVE_MODEL,
 856                 "Attempted to copy statement %s which has completed phase %s", stmt, phase);
 857     }
 858
 859     @Beta
 860     public final boolean hasImplicitParentSupport() {
 861         return definition.getFactory() instanceof ImplicitParentAwareStatementSupport;
 862     }
 863
 864     @Beta
 865     public final StatementContextBase<?, ?, ?> wrapWithImplicit(final StatementContextBase<?, ?, ?> original) {
 866         final Optional<StatementSupport<?, ?, ?>> optImplicit = definition.getImplicitParentFor(
 867             original.getPublicDefinition());
 868         if (optImplicit.isEmpty()) {
 869             return original;
 870         }
 871
 872         final StatementDefinitionContext<?, ?, ?> def = new StatementDefinitionContext<>(optImplicit.get());
 873         final CopyType type = original.getCopyHistory().getLastOperation();
 874         final SubstatementContext<?, ?, ?> result = new SubstatementContext(original.getParentContext(), def,
 875             original.getStatementSourceReference(), original.rawStatementArgument(), original.getStatementArgument(),
 876             type);
 877
 878         result.addEffectiveSubstatement(original.reparent(result));
 879         result.setCompletedPhase(original.getCompletedPhase());
 880         return result;
 881     }
 882
 883     abstract StatementContextBase<A, D, E> reparent(StatementContextBase<?, ?, ?> newParent);
 884
 885     /**
 886      * Indicate that the set of substatements is empty. This is a preferred shortcut to substatement stream filtering.
 887      *
 888      * @return True if {@link #allSubstatements()} and {@link #allSubstatementsStream()} would return an empty stream.
 889      */
 890     abstract boolean hasEmptySubstatements();
 891
 892     final boolean hasEmptyEffectiveSubstatements() {
 893         return effective.isEmpty();
 894     }
 895
 896     /**
 897      * Config statements are not all that common which means we are performing a recursive search towards the root
 898      * every time {@link #isConfiguration()} is invoked. This is quite expensive because it causes a linear search
 899      * for the (usually non-existent) config statement.
 900      *
 901      * <p>
 902      * This method maintains a resolution cache, so once we have returned a result, we will keep on returning the same
 903      * result without performing any lookups, solely to support {@link SubstatementContext#isConfiguration()}.
 904      *
 905      * <p>
 906      * Note: use of this method implies that {@link #isIgnoringConfig()} is realized with
 907      *       {@link #isIgnoringConfig(StatementContextBase)}.
 908      */
 909     final boolean isConfiguration(final StatementContextBase<?, ?, ?> parent) {
 910         final int fl = flags & SET_CONFIGURATION;
 911         if (fl != 0) {
 912             return fl == SET_CONFIGURATION;
 913         }
 914         if (isIgnoringConfig(parent)) {
 915             // Note: SET_CONFIGURATION has been stored in flags
 916             return true;
 917         }
 918
 919         final StmtContext<Boolean, ?, ?> configStatement = StmtContextUtils.findFirstSubstatement(this,
 920             ConfigStatement.class);
 921         final boolean isConfig;
 922         if (configStatement != null) {
 923             isConfig = configStatement.coerceStatementArgument();
 924             if (isConfig) {
 925                 // Validity check: if parent is config=false this cannot be a config=true
 926                 InferenceException.throwIf(!parent.isConfiguration(), getStatementSourceReference(),
 927                         "Parent node has config=false, this node must not be specifed as config=true");
 928             }
 929         } else {
 930             // If "config" statement is not specified, the default is the same as the parent's "config" value.
 931             isConfig = parent.isConfiguration();
 932         }
 933
 934         // Resolved, make sure we cache this return
 935         flags |= isConfig ? SET_CONFIGURATION : HAVE_CONFIGURATION;
 936         return isConfig;
 937     }
 938
 939     protected abstract boolean isIgnoringConfig();
 940
 941     /**
 942      * This method maintains a resolution cache for ignore config, so once we have returned a result, we will
 943      * keep on returning the same result without performing any lookups. Exists only to support
 944      * {@link SubstatementContext#isIgnoringConfig()}.
 945      *
 946      * <p>
 947      * Note: use of this method implies that {@link #isConfiguration()} is realized with
 948      *       {@link #isConfiguration(StatementContextBase)}.
 949      */
 950     final boolean isIgnoringConfig(final StatementContextBase<?, ?, ?> parent) {
 951         final int fl = flags & SET_IGNORE_CONFIG;
 952         if (fl != 0) {
 953             return fl == SET_IGNORE_CONFIG;
 954         }
 955         if (definition.support().isIgnoringConfig() || parent.isIgnoringConfig()) {
 956             flags |= SET_IGNORE_CONFIG;
 957             return true;
 958         }
 959
 960         flags |= HAVE_IGNORE_CONFIG;
 961         return false;
 962     }
 963
 964     protected abstract boolean isIgnoringIfFeatures();
 965
 966     /**
 967      * This method maintains a resolution cache for ignore if-feature, so once we have returned a result, we will
 968      * keep on returning the same result without performing any lookups. Exists only to support
 969      * {@link SubstatementContext#isIgnoringIfFeatures()}.
 970      */
 971     final boolean isIgnoringIfFeatures(final StatementContextBase<?, ?, ?> parent) {
 972         final int fl = flags & SET_IGNORE_IF_FEATURE;
 973         if (fl != 0) {
 974             return fl == SET_IGNORE_IF_FEATURE;
 975         }
 976         if (definition.support().isIgnoringIfFeatures() || parent.isIgnoringIfFeatures()) {
 977             flags |= SET_IGNORE_IF_FEATURE;
 978             return true;
 979         }
 980
 981         flags |= HAVE_IGNORE_IF_FEATURE;
 982         return false;
 983     }
 984
 985     // Exists only to support SubstatementContext/InferredStatementContext
 986     final @NonNull Optional<SchemaPath> substatementGetSchemaPath() {
 987         SchemaPath local = schemaPath;
 988         if (local == null) {
 989             synchronized (this) {
 990                 local = schemaPath;
 991                 if (local == null) {
 992                     local = createSchemaPath(coerceParentContext());
 993                     schemaPath = local;
 994                 }
 995             }
 996         }
 997
 998         return Optional.ofNullable(local);
 999     }
1000
1001     private SchemaPath createSchemaPath(final Mutable<?, ?, ?> parent) {
1002         final Optional<SchemaPath> maybeParentPath = parent.getSchemaPath();
1003         verify(maybeParentPath.isPresent(), "Parent %s does not have a SchemaPath", parent);
1004         final SchemaPath parentPath = maybeParentPath.get();
1005
1006         if (StmtContextUtils.isUnknownStatement(this)) {
1007             return parentPath.createChild(getPublicDefinition().getStatementName());
1008         }
1009         final Object argument = getStatementArgument();
1010         if (argument instanceof QName) {
1011             final QName qname = (QName) argument;
1012             if (StmtContextUtils.producesDeclared(this, UsesStatement.class)) {
1013                 return maybeParentPath.orElse(null);
1014             }
1015
1016             return parentPath.createChild(qname);
1017         }
1018         if (argument instanceof String) {
1019             // FIXME: This may yield illegal argument exceptions
1020             final Optional<StmtContext<?, ?, ?>> originalCtx = getOriginalCtx();
1021             final QName qname = StmtContextUtils.qnameFromArgument(originalCtx.orElse(this), (String) argument);
1022             return parentPath.createChild(qname);
1023         }
1024         if (argument instanceof SchemaNodeIdentifier
1025                 && (StmtContextUtils.producesDeclared(this, AugmentStatement.class)
1026                         || StmtContextUtils.producesDeclared(this, RefineStatement.class)
1027                         || StmtContextUtils.producesDeclared(this, DeviationStatement.class))) {
1028
1029             return parentPath.createChild(((SchemaNodeIdentifier) argument).getPathFromRoot());
1030         }
1031
1032         // FIXME: this does not look right
1033         return maybeParentPath.orElse(null);
1034     }
1035
1036     @Override
1037     public final String toString() {
1038         return addToStringAttributes(MoreObjects.toStringHelper(this).omitNullValues()).toString();
1039     }
1040
1041     protected ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) {
1042         return toStringHelper.add("definition", definition).add("rawArgument", rawStatementArgument());
1043     }
1044 }