2 * Copyright (c) 2015 Cisco Systems, Inc. and others. All rights reserved.
4 * This program and the accompanying materials are made available under the
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
8 package org.opendaylight.yangtools.yang.parser.stmt.reactor;
10 import static com.google.common.base.Preconditions.checkArgument;
11 import static com.google.common.base.Preconditions.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;
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;
32 import java.util.Map.Entry;
33 import java.util.Objects;
34 import java.util.Optional;
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;
81 * Core reactor statement implementation of {@link Mutable}.
83 * @param <A> Argument type
84 * @param <D> Declared Statement representation
85 * @param <E> Effective Statement representation
87 public abstract class StatementContextBase<A, D extends DeclaredStatement<A>, E extends EffectiveStatement<A, D>>
88 extends NamespaceStorageSupport implements Mutable<A, D, E> {
90 * Event listener when an item is added to model namespace.
92 interface OnNamespaceItemAdded extends EventListener {
94 * Invoked whenever a new item is added to a namespace.
96 void namespaceItemAdded(StatementContextBase<?, ?, ?> context, Class<?> namespace, Object key, Object value);
100 * Event listener when a parsing {@link ModelProcessingPhase} is completed.
102 interface OnPhaseFinished extends EventListener {
104 * Invoked whenever a processing phase has finished.
106 boolean phaseFinished(StatementContextBase<?, ?, ?> context, ModelProcessingPhase finishedPhase);
110 * Interface for all mutations within an {@link ModelActionBuilder.InferenceAction}.
112 interface ContextMutation {
114 boolean isFinished();
117 private static final Logger LOG = LoggerFactory.getLogger(StatementContextBase.class);
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;
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;
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;
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();
147 private @Nullable ModelProcessingPhase completedPhase;
148 private @Nullable E effectiveInstance;
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;
155 // Flag for use with AbstractResumedStatement. This is hiding in the alignment shadow created by above boolean
156 private boolean fullyDefined;
158 // Flags for use with SubstatementContext. These are hiding in the alignment shadow created by above boolean and
159 // hence improve memory layout.
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;
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;
171 this.isSupportedToBuildEffective = original.isSupportedToBuildEffective;
172 this.fullyDefined = original.fullyDefined;
173 this.completedPhase = original.completedPhase;
174 this.flags = original.flags;
177 StatementContextBase(final StatementDefinitionContext<A, D, E> def) {
178 this.definition = requireNonNull(def);
179 this.copyHistory = CopyHistory.original();
182 StatementContextBase(final StatementDefinitionContext<A, D, E> def, final CopyHistory copyHistory) {
183 this.definition = requireNonNull(def);
184 this.copyHistory = requireNonNull(copyHistory);
188 public Collection<? extends StmtContext<?, ?, ?>> getEffectOfStatement() {
189 return effectOfStatement;
193 public void addAsEffectOfStatement(final StmtContext<?, ?, ?> ctx) {
194 if (effectOfStatement.isEmpty()) {
195 effectOfStatement = new ArrayList<>(1);
197 effectOfStatement.add(ctx);
201 public void addAsEffectOfStatement(final Collection<? extends StmtContext<?, ?, ?>> ctxs) {
202 if (ctxs.isEmpty()) {
206 if (effectOfStatement.isEmpty()) {
207 effectOfStatement = new ArrayList<>(ctxs.size());
209 effectOfStatement.addAll(ctxs);
213 public boolean isSupportedByFeatures() {
214 final int fl = flags & SET_SUPPORTED_BY_FEATURES;
216 return fl == SET_SUPPORTED_BY_FEATURES;
218 if (isIgnoringIfFeatures()) {
219 flags |= SET_SUPPORTED_BY_FEATURES;
224 * If parent is supported, we need to check if-features statements of this context.
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;
236 // Either parent is not supported or this statement is not supported
237 flags |= HAVE_SUPPORTED_BY_FEATURES;
241 protected abstract boolean isParentSupportedByFeatures();
244 public boolean isSupportedToBuildEffective() {
245 return isSupportedToBuildEffective;
249 public void setIsSupportedToBuildEffective(final boolean isSupportedToBuildEffective) {
250 this.isSupportedToBuildEffective = isSupportedToBuildEffective;
254 public CopyHistory getCopyHistory() {
259 public ModelProcessingPhase getCompletedPhase() {
260 return completedPhase;
263 // FIXME: this should be propagated through a correct constructor
265 final void setCompletedPhase(final ModelProcessingPhase completedPhase) {
266 this.completedPhase = completedPhase;
270 public abstract StatementContextBase<?, ?, ?> getParentContext();
273 * Returns the model root for this statement.
275 * @return root context of statement
278 public abstract RootStatementContext<?, ?, ?> getRoot();
281 public final @NonNull Registry getBehaviourRegistry() {
282 return getRoot().getBehaviourRegistryImpl();
286 public final YangVersion getRootVersion() {
287 return getRoot().getRootVersionImpl();
291 public final void setRootVersion(final YangVersion version) {
292 getRoot().setRootVersionImpl(version);
296 public final void addMutableStmtToSeal(final MutableStatement mutableStatement) {
297 getRoot().addMutableStmtToSealImpl(mutableStatement);
301 public final void addRequiredSource(final SourceIdentifier dependency) {
302 getRoot().addRequiredSourceImpl(dependency);
306 public final void setRootIdentifier(final SourceIdentifier identifier) {
307 getRoot().setRootIdentifierImpl(identifier);
311 public final boolean isEnabledSemanticVersioning() {
312 return getRoot().isEnabledSemanticVersioningImpl();
316 public StatementSource getStatementSource() {
317 return getStatementSourceReference().getStatementSource();
321 public final <K, V, N extends IdentifierNamespace<K, V>> Map<K, V> getAllFromCurrentStmtCtxNamespace(
322 final Class<N> type) {
323 return getLocalNamespace(type);
327 public final <K, V, N extends IdentifierNamespace<K, V>> Map<K, V> getAllFromNamespace(final Class<N> type) {
328 return getNamespace(type);
332 * Associate a value with a key within a namespace.
334 * @param type Namespace type
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.
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);
351 public abstract Collection<? extends StatementContextBase<?, ?, ?>> mutableDeclaredSubstatements();
354 * Return a value associated with specified key within a namespace.
356 * @param type Namespace type
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.
366 public final <K, V, T extends K, N extends IdentifierNamespace<K, V>> V getFromNamespace(final Class<N> type,
368 return getBehaviourRegistry().getNamespaceBehaviour(type).getFrom(this, key);
372 public Collection<? extends Mutable<?, ?, ?>> mutableEffectiveSubstatements() {
373 if (effective instanceof ImmutableCollection) {
377 return Collections.unmodifiableCollection(effective);
380 private void shrinkEffective() {
381 if (effective.isEmpty()) {
382 effective = ImmutableList.of();
386 public void removeStatementFromEffectiveSubstatements(final StatementDefinition statementDef) {
387 if (effective.isEmpty()) {
391 final Iterator<? extends StmtContext<?, ?, ?>> iterator = effective.iterator();
392 while (iterator.hasNext()) {
393 final StmtContext<?, ?, ?> next = iterator.next();
394 if (statementDef.equals(next.getPublicDefinition())) {
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
409 * If the statementArg parameter is null, the statement context is removed based only on its statement definition.
411 * @param statementDef statement definition of the statement context to remove
412 * @param statementArg statement argument of the statement context to remove
414 public void removeStatementFromEffectiveSubstatements(final StatementDefinition statementDef,
415 final String statementArg) {
416 if (statementArg == null) {
417 removeStatementFromEffectiveSubstatements(statementDef);
420 if (effective.isEmpty()) {
424 final Iterator<Mutable<?, ?, ?>> iterator = effective.iterator();
425 while (iterator.hasNext()) {
426 final Mutable<?, ?, ?> next = iterator.next();
427 if (statementDef.equals(next.getPublicDefinition()) && statementArg.equals(next.rawStatementArgument())) {
435 // YANG example: RPC/action statements always have 'input' and 'output' defined
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);
449 * Adds an effective statement to collection of substatements.
451 * @param substatement substatement
452 * @throws IllegalStateException
453 * if added in declared phase
454 * @throws NullPointerException
455 * if statement parameter is null
457 public void addEffectiveSubstatement(final Mutable<?, ?, ?> substatement) {
458 beforeAddEffectiveStatement(1);
459 effective.add(substatement);
463 * Adds an effective statement to collection of substatements.
465 * @param statements substatements
466 * @throws IllegalStateException
467 * if added in declared phase
468 * @throws NullPointerException
469 * if statement parameter is null
471 public void addEffectiveSubstatements(final Collection<? extends Mutable<?, ?, ?>> statements) {
472 if (statements.isEmpty()) {
476 statements.forEach(Objects::requireNonNull);
477 beforeAddEffectiveStatement(statements.size());
478 effective.addAll(statements);
481 private void beforeAddEffectiveStatement(final int toAdd) {
482 final ModelProcessingPhase inProgressPhase = getRoot().getSourceContext().getInProgressPhase();
483 checkState(inProgressPhase == ModelProcessingPhase.FULL_DECLARATION
484 || inProgressPhase == ModelProcessingPhase.EFFECTIVE_MODEL,
485 "Effective statement cannot be added in declared phase at: %s", getStatementSourceReference());
487 if (effective.isEmpty()) {
488 effective = new ArrayList<>(toAdd);
492 // Exists only due to memory optimization
493 final boolean fullyDefined() {
497 // Exists only due to memory optimization, should live in AbstractResumedStatement
498 final void setFullyDefined() {
503 public E buildEffective() {
504 final E existing = effectiveInstance;
505 return existing != null ? existing : (effectiveInstance = definition.getFactory().createEffective(this));
509 * tries to execute current {@link ModelProcessingPhase} of source parsing.
512 * to be executed (completed)
513 * @return if phase was successfully completed
514 * @throws SourceException
515 * when an error occurred in source parsing
517 boolean tryToCompletePhase(final ModelProcessingPhase phase) {
519 boolean finished = true;
520 final Collection<ContextMutation> openMutations = phaseMutation.get(phase);
521 if (!openMutations.isEmpty()) {
522 final Iterator<ContextMutation> it = openMutations.iterator();
523 while (it.hasNext()) {
524 final ContextMutation current = it.next();
525 if (current.isFinished()) {
532 if (openMutations.isEmpty()) {
533 phaseMutation.removeAll(phase);
534 if (phaseMutation.isEmpty()) {
535 phaseMutation = ImmutableMultimap.of();
540 for (final StatementContextBase<?, ?, ?> child : mutableDeclaredSubstatements()) {
541 finished &= child.tryToCompletePhase(phase);
543 for (final Mutable<?, ?, ?> child : effective) {
544 if (child instanceof StatementContextBase) {
545 finished &= ((StatementContextBase<?, ?, ?>) child).tryToCompletePhase(phase);
550 onPhaseCompleted(phase);
557 * Occurs on end of {@link ModelProcessingPhase} of source parsing.
560 * that was to be completed (finished)
561 * @throws SourceException
562 * when an error occurred in source parsing
564 private void onPhaseCompleted(final ModelProcessingPhase phase) {
565 completedPhase = phase;
567 final Collection<OnPhaseFinished> listeners = phaseListeners.get(phase);
568 if (listeners.isEmpty()) {
572 final Iterator<OnPhaseFinished> listener = listeners.iterator();
573 while (listener.hasNext()) {
574 final OnPhaseFinished next = listener.next();
575 if (next.phaseFinished(this, phase)) {
580 if (listeners.isEmpty()) {
581 phaseListeners.removeAll(phase);
582 if (phaseListeners.isEmpty()) {
583 phaseListeners = ImmutableMultimap.of();
589 * Ends declared section of current node.
591 void endDeclared(final ModelProcessingPhase phase) {
592 definition.onDeclarationFinished(this, phase);
596 * Return the context in which this statement was defined.
598 * @return statement definition
600 protected final @NonNull StatementDefinitionContext<A, D, E> definition() {
605 protected void checkLocalNamespaceAllowed(final Class<? extends IdentifierNamespace<?, ?>> type) {
606 definition.checkNamespaceAllowed(type);
610 protected <K, V, N extends IdentifierNamespace<K, V>> void onNamespaceElementAdded(final Class<N> type, final K key,
612 // definition().onNamespaceElementAdded(this, type, key, value);
615 final <K, V, N extends IdentifierNamespace<K, V>> void onNamespaceItemAddedAction(final Class<N> type, final K key,
616 final OnNamespaceItemAdded listener) {
617 final Object potential = getFromNamespace(type, key);
618 if (potential != null) {
619 LOG.trace("Listener on {} key {} satisfied immediately", type, key);
620 listener.namespaceItemAdded(this, type, key, potential);
624 getBehaviour(type).addListener(new KeyedValueAddedListener<>(this, key) {
626 void onValueAdded(final Object value) {
627 listener.namespaceItemAdded(StatementContextBase.this, type, key, value);
632 final <K, V, N extends IdentifierNamespace<K, V>> void onNamespaceItemAddedAction(final Class<N> type,
633 final ModelProcessingPhase phase, final NamespaceKeyCriterion<K> criterion,
634 final OnNamespaceItemAdded listener) {
635 final Optional<Entry<K, V>> existing = getFromNamespace(type, criterion);
636 if (existing.isPresent()) {
637 final Entry<K, V> entry = existing.get();
638 LOG.debug("Listener on {} criterion {} found a pre-existing match: {}", type, criterion, entry);
639 waitForPhase(entry.getValue(), type, phase, criterion, listener);
643 final NamespaceBehaviourWithListeners<K, V, N> behaviour = getBehaviour(type);
644 behaviour.addListener(new PredicateValueAddedListener<K, V>(this) {
646 boolean onValueAdded(final K key, final V value) {
647 if (criterion.match(key)) {
648 LOG.debug("Listener on {} criterion {} matched added key {}", type, criterion, key);
649 waitForPhase(value, type, phase, criterion, listener);
658 final <K, V, N extends IdentifierNamespace<K, V>> void selectMatch(final Class<N> type,
659 final NamespaceKeyCriterion<K> criterion, final OnNamespaceItemAdded listener) {
660 final Optional<Entry<K, V>> optMatch = getFromNamespace(type, criterion);
661 checkState(optMatch.isPresent(), "Failed to find a match for criterion %s in namespace %s node %s", criterion,
663 final Entry<K, V> match = optMatch.get();
664 listener.namespaceItemAdded(StatementContextBase.this, type, match.getKey(), match.getValue());
667 final <K, V, N extends IdentifierNamespace<K, V>> void waitForPhase(final Object value, final Class<N> type,
668 final ModelProcessingPhase phase, final NamespaceKeyCriterion<K> criterion,
669 final OnNamespaceItemAdded listener) {
670 ((StatementContextBase<?, ? ,?>) value).addPhaseCompletedListener(phase,
671 (context, phaseCompleted) -> {
672 selectMatch(type, criterion, listener);
677 private <K, V, N extends IdentifierNamespace<K, V>> NamespaceBehaviourWithListeners<K, V, N> getBehaviour(
678 final Class<N> type) {
679 final NamespaceBehaviour<K, V, N> behaviour = getBehaviourRegistry().getNamespaceBehaviour(type);
680 checkArgument(behaviour instanceof NamespaceBehaviourWithListeners, "Namespace %s does not support listeners",
683 return (NamespaceBehaviourWithListeners<K, V, N>) behaviour;
687 public StatementDefinition getPublicDefinition() {
688 return definition.getPublicView();
692 public ModelActionBuilder newInferenceAction(final ModelProcessingPhase phase) {
693 return getRoot().getSourceContext().newInferenceAction(phase);
696 private static <T> Multimap<ModelProcessingPhase, T> newMultimap() {
697 return Multimaps.newListMultimap(new EnumMap<>(ModelProcessingPhase.class), () -> new ArrayList<>(1));
701 * Adds {@link OnPhaseFinished} listener for a {@link ModelProcessingPhase} end. If the base has already completed
702 * the listener is notified immediately.
704 * @param phase requested completion phase
705 * @param listener listener to invoke
706 * @throws NullPointerException if any of the arguments is null
708 void addPhaseCompletedListener(final ModelProcessingPhase phase, final OnPhaseFinished listener) {
709 checkNotNull(phase, "Statement context processing phase cannot be null at: %s", getStatementSourceReference());
710 checkNotNull(listener, "Statement context phase listener cannot be null at: %s", getStatementSourceReference());
712 ModelProcessingPhase finishedPhase = completedPhase;
713 while (finishedPhase != null) {
714 if (phase.equals(finishedPhase)) {
715 listener.phaseFinished(this, finishedPhase);
718 finishedPhase = finishedPhase.getPreviousPhase();
720 if (phaseListeners.isEmpty()) {
721 phaseListeners = newMultimap();
724 phaseListeners.put(phase, listener);
728 * Adds a {@link ContextMutation} to a {@link ModelProcessingPhase}.
730 * @throws IllegalStateException
731 * when the mutation was registered after phase was completed
733 void addMutation(final ModelProcessingPhase phase, final ContextMutation mutation) {
734 ModelProcessingPhase finishedPhase = completedPhase;
735 while (finishedPhase != null) {
736 checkState(!phase.equals(finishedPhase), "Mutation registered after phase was completed at: %s",
737 getStatementSourceReference());
738 finishedPhase = finishedPhase.getPreviousPhase();
741 if (phaseMutation.isEmpty()) {
742 phaseMutation = newMultimap();
744 phaseMutation.put(phase, mutation);
748 public <K, KT extends K, N extends StatementNamespace<K, ?, ?>> void addContext(final Class<N> namespace,
749 final KT key,final StmtContext<?, ?, ?> stmt) {
750 addContextToNamespace(namespace, key, stmt);
754 public Optional<? extends Mutable<?, ?, ?>> copyAsChildOf(final Mutable<?, ?, ?> parent, final CopyType type,
755 final QNameModule targetModule) {
756 checkEffectiveModelCompleted(this);
758 final StatementSupport<A, D, E> support = definition.support();
759 final CopyPolicy policy = support.applyCopyPolicy(this, parent, type, targetModule);
761 case CONTEXT_INDEPENDENT:
762 if (hasEmptySubstatements()) {
763 // This statement is context-independent and has no substatements -- hence it can be freely shared.
764 return Optional.of(this);
766 // FIXME: YANGTOOLS-694: filter out all context-independent substatements, eliminate fall-through
769 // FIXME: YANGTOOLS-694: this is still to eager, we really want to copy as a lazily-instantiated
770 // context, so that we can support building an effective statement without copying
771 // anything -- we will typically end up not being inferred against. In that case,
772 // this slim context should end up dealing with differences at buildContext()
773 // time. This is a YANGTOOLS-1067 prerequisite (which will deal with what can and
774 // cannot be shared across instances).
775 return Optional.of(parent.childCopyOf(this, type, targetModule));
777 return Optional.empty();
779 throw new IllegalStateException("Statement " + support.getPublicView() + " should never be copied");
781 throw new IllegalStateException("Unhandled policy " + policy);
786 public final Mutable<?, ?, ?> childCopyOf(final StmtContext<?, ?, ?> stmt, final CopyType type,
787 final QNameModule targetModule) {
788 checkEffectiveModelCompleted(stmt);
789 checkArgument(stmt instanceof StatementContextBase, "Unsupported statement %s", stmt);
790 return childCopyOf((StatementContextBase<?, ?, ?>) stmt, type, targetModule);
793 private <X, Y extends DeclaredStatement<X>, Z extends EffectiveStatement<X, Y>> Mutable<X, Y, Z> childCopyOf(
794 final StatementContextBase<X, Y, Z> original, final CopyType type, final QNameModule targetModule) {
795 final Optional<StatementSupport<?, ?, ?>> implicitParent = definition.getImplicitParentFor(
796 original.getPublicDefinition());
798 final StatementContextBase<X, Y, Z> result;
799 final InferredStatementContext<X, Y, Z> copy;
801 if (implicitParent.isPresent()) {
802 final StatementDefinitionContext<?, ?, ?> def = new StatementDefinitionContext<>(implicitParent.get());
803 result = new SubstatementContext(this, def, original.getStatementSourceReference(),
804 original.rawStatementArgument(), original.getStatementArgument(), type);
806 final CopyType childCopyType;
808 case ADDED_BY_AUGMENTATION:
809 childCopyType = CopyType.ORIGINAL;
811 case ADDED_BY_USES_AUGMENTATION:
812 childCopyType = CopyType.ADDED_BY_USES;
817 childCopyType = type;
820 copy = new InferredStatementContext<>(result, original, childCopyType, type, targetModule);
821 result.addEffectiveSubstatement(copy);
823 result = copy = new InferredStatementContext<>(this, original, type, type, targetModule);
826 original.definition.onStatementAdded(copy);
830 private static void checkEffectiveModelCompleted(final StmtContext<?, ?, ?> stmt) {
831 final ModelProcessingPhase phase = stmt.getCompletedPhase();
832 checkState(phase == ModelProcessingPhase.EFFECTIVE_MODEL,
833 "Attempted to copy statement %s which has completed phase %s", stmt, phase);
837 public final boolean hasImplicitParentSupport() {
838 return definition.getFactory() instanceof ImplicitParentAwareStatementSupport;
842 public final StatementContextBase<?, ?, ?> wrapWithImplicit(final StatementContextBase<?, ?, ?> original) {
843 final Optional<StatementSupport<?, ?, ?>> optImplicit = definition.getImplicitParentFor(
844 original.getPublicDefinition());
845 if (optImplicit.isEmpty()) {
849 final StatementDefinitionContext<?, ?, ?> def = new StatementDefinitionContext<>(optImplicit.get());
850 final CopyType type = original.getCopyHistory().getLastOperation();
851 final SubstatementContext<?, ?, ?> result = new SubstatementContext(original.getParentContext(), def,
852 original.getStatementSourceReference(), original.rawStatementArgument(), original.getStatementArgument(),
855 result.addEffectiveSubstatement(original.reparent(result));
856 result.setCompletedPhase(original.getCompletedPhase());
860 abstract StatementContextBase<A, D, E> reparent(StatementContextBase<?, ?, ?> newParent);
863 * Indicate that the set of substatements is empty. This is a preferred shortcut to substatement stream filtering.
865 * @return True if {@link #allSubstatements()} and {@link #allSubstatementsStream()} would return an empty stream.
867 abstract boolean hasEmptySubstatements();
869 final boolean hasEmptyEffectiveSubstatements() {
870 return effective.isEmpty();
874 * Config statements are not all that common which means we are performing a recursive search towards the root
875 * every time {@link #isConfiguration()} is invoked. This is quite expensive because it causes a linear search
876 * for the (usually non-existent) config statement.
879 * This method maintains a resolution cache, so once we have returned a result, we will keep on returning the same
880 * result without performing any lookups, solely to support {@link SubstatementContext#isConfiguration()}.
883 * Note: use of this method implies that {@link #isIgnoringConfig()} is realized with
884 * {@link #isIgnoringConfig(StatementContextBase)}.
886 final boolean isConfiguration(final StatementContextBase<?, ?, ?> parent) {
887 final int fl = flags & SET_CONFIGURATION;
889 return fl == SET_CONFIGURATION;
891 if (isIgnoringConfig(parent)) {
892 // Note: SET_CONFIGURATION has been stored in flags
896 final StmtContext<Boolean, ?, ?> configStatement = StmtContextUtils.findFirstSubstatement(this,
897 ConfigStatement.class);
898 final boolean isConfig;
899 if (configStatement != null) {
900 isConfig = configStatement.coerceStatementArgument();
902 // Validity check: if parent is config=false this cannot be a config=true
903 InferenceException.throwIf(!parent.isConfiguration(), getStatementSourceReference(),
904 "Parent node has config=false, this node must not be specifed as config=true");
907 // If "config" statement is not specified, the default is the same as the parent's "config" value.
908 isConfig = parent.isConfiguration();
911 // Resolved, make sure we cache this return
912 flags |= isConfig ? SET_CONFIGURATION : HAVE_CONFIGURATION;
916 protected abstract boolean isIgnoringConfig();
919 * This method maintains a resolution cache for ignore config, so once we have returned a result, we will
920 * keep on returning the same result without performing any lookups. Exists only to support
921 * {@link SubstatementContext#isIgnoringConfig()}.
924 * Note: use of this method implies that {@link #isConfiguration()} is realized with
925 * {@link #isConfiguration(StatementContextBase)}.
927 final boolean isIgnoringConfig(final StatementContextBase<?, ?, ?> parent) {
928 final int fl = flags & SET_IGNORE_CONFIG;
930 return fl == SET_IGNORE_CONFIG;
932 if (definition.support().isIgnoringConfig() || parent.isIgnoringConfig()) {
933 flags |= SET_IGNORE_CONFIG;
937 flags |= HAVE_IGNORE_CONFIG;
941 protected abstract boolean isIgnoringIfFeatures();
944 * This method maintains a resolution cache for ignore if-feature, so once we have returned a result, we will
945 * keep on returning the same result without performing any lookups. Exists only to support
946 * {@link SubstatementContext#isIgnoringIfFeatures()}.
948 final boolean isIgnoringIfFeatures(final StatementContextBase<?, ?, ?> parent) {
949 final int fl = flags & SET_IGNORE_IF_FEATURE;
951 return fl == SET_IGNORE_IF_FEATURE;
953 if (definition.support().isIgnoringIfFeatures() || parent.isIgnoringIfFeatures()) {
954 flags |= SET_IGNORE_IF_FEATURE;
958 flags |= HAVE_IGNORE_IF_FEATURE;
962 // Exists only to support SubstatementContext/InferredStatementContext
963 final @NonNull Optional<SchemaPath> substatementGetSchemaPath() {
964 SchemaPath local = schemaPath;
966 synchronized (this) {
969 local = createSchemaPath(coerceParentContext());
975 return Optional.ofNullable(local);
978 private SchemaPath createSchemaPath(final Mutable<?, ?, ?> parent) {
979 final Optional<SchemaPath> maybeParentPath = parent.getSchemaPath();
980 verify(maybeParentPath.isPresent(), "Parent %s does not have a SchemaPath", parent);
981 final SchemaPath parentPath = maybeParentPath.get();
983 if (StmtContextUtils.isUnknownStatement(this)) {
984 return parentPath.createChild(getPublicDefinition().getStatementName());
986 final Object argument = getStatementArgument();
987 if (argument instanceof QName) {
988 final QName qname = (QName) argument;
989 if (StmtContextUtils.producesDeclared(this, UsesStatement.class)) {
990 return maybeParentPath.orElse(null);
993 return parentPath.createChild(qname);
995 if (argument instanceof String) {
996 // FIXME: This may yield illegal argument exceptions
997 final Optional<StmtContext<A, D, E>> originalCtx = getOriginalCtx();
998 final QName qname = StmtContextUtils.qnameFromArgument(originalCtx.orElse(this), (String) argument);
999 return parentPath.createChild(qname);
1001 if (argument instanceof SchemaNodeIdentifier
1002 && (StmtContextUtils.producesDeclared(this, AugmentStatement.class)
1003 || StmtContextUtils.producesDeclared(this, RefineStatement.class)
1004 || StmtContextUtils.producesDeclared(this, DeviationStatement.class))) {
1006 return parentPath.createChild(((SchemaNodeIdentifier) argument).getPathFromRoot());
1009 // FIXME: this does not look right
1010 return maybeParentPath.orElse(null);
1014 public final String toString() {
1015 return addToStringAttributes(MoreObjects.toStringHelper(this).omitNullValues()).toString();
1018 protected ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) {
1019 return toStringHelper.add("definition", definition).add("rawArgument", rawStatementArgument());