X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=yang%2Fyang-parser-reactor%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fyangtools%2Fyang%2Fparser%2Fstmt%2Freactor%2FStatementContextBase.java;h=aa0b2702142dbd0f6efc381208c53fb61f5c0025;hb=refs%2Fchanges%2F08%2F94008%2F2;hp=0d0a82fc2ea51885fcbcad116fd6cd7039c26748;hpb=3880c99eefb4d8104236fdd17da6d5014f61f63e;p=yangtools.git diff --git a/yang/yang-parser-reactor/src/main/java/org/opendaylight/yangtools/yang/parser/stmt/reactor/StatementContextBase.java b/yang/yang-parser-reactor/src/main/java/org/opendaylight/yangtools/yang/parser/stmt/reactor/StatementContextBase.java index 0d0a82fc2e..aa0b270214 100644 --- a/yang/yang-parser-reactor/src/main/java/org/opendaylight/yangtools/yang/parser/stmt/reactor/StatementContextBase.java +++ b/yang/yang-parser-reactor/src/main/java/org/opendaylight/yangtools/yang/parser/stmt/reactor/StatementContextBase.java @@ -14,8 +14,6 @@ import static com.google.common.base.Verify.verify; import static java.util.Objects.requireNonNull; import com.google.common.annotations.Beta; -import com.google.common.base.MoreObjects; -import com.google.common.base.MoreObjects.ToStringHelper; import com.google.common.collect.ImmutableCollection; import com.google.common.collect.ImmutableList; import com.google.common.collect.ImmutableMultimap; @@ -29,46 +27,28 @@ import java.util.EventListener; import java.util.Iterator; import java.util.List; import java.util.Map.Entry; -import java.util.Objects; import java.util.Optional; -import java.util.Set; +import java.util.stream.Stream; import org.eclipse.jdt.annotation.NonNull; import org.eclipse.jdt.annotation.Nullable; -import org.opendaylight.yangtools.yang.common.QName; import org.opendaylight.yangtools.yang.common.QNameModule; -import org.opendaylight.yangtools.yang.common.YangVersion; -import org.opendaylight.yangtools.yang.model.api.SchemaPath; import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement; import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement; import org.opendaylight.yangtools.yang.model.api.meta.IdentifierNamespace; import org.opendaylight.yangtools.yang.model.api.meta.StatementDefinition; -import org.opendaylight.yangtools.yang.model.api.meta.StatementSource; -import org.opendaylight.yangtools.yang.model.api.stmt.AugmentStatement; -import org.opendaylight.yangtools.yang.model.api.stmt.ConfigStatement; -import org.opendaylight.yangtools.yang.model.api.stmt.DeviationStatement; -import org.opendaylight.yangtools.yang.model.api.stmt.RefineStatement; -import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier; -import org.opendaylight.yangtools.yang.model.api.stmt.UsesStatement; -import org.opendaylight.yangtools.yang.model.repo.api.SourceIdentifier; import org.opendaylight.yangtools.yang.parser.spi.meta.CopyHistory; import org.opendaylight.yangtools.yang.parser.spi.meta.CopyType; import org.opendaylight.yangtools.yang.parser.spi.meta.ImplicitParentAwareStatementSupport; -import org.opendaylight.yangtools.yang.parser.spi.meta.InferenceException; import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder; import org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase; -import org.opendaylight.yangtools.yang.parser.spi.meta.MutableStatement; import org.opendaylight.yangtools.yang.parser.spi.meta.NamespaceBehaviour; -import org.opendaylight.yangtools.yang.parser.spi.meta.NamespaceBehaviour.Registry; import org.opendaylight.yangtools.yang.parser.spi.meta.NamespaceKeyCriterion; import org.opendaylight.yangtools.yang.parser.spi.meta.StatementNamespace; import org.opendaylight.yangtools.yang.parser.spi.meta.StatementSupport; +import org.opendaylight.yangtools.yang.parser.spi.meta.StatementSupport.CopyPolicy; import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext; -import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable; -import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils; import org.opendaylight.yangtools.yang.parser.spi.source.ImplicitSubstatement; import org.opendaylight.yangtools.yang.parser.spi.source.SourceException; -import org.opendaylight.yangtools.yang.parser.spi.source.SupportedFeaturesNamespace; -import org.opendaylight.yangtools.yang.parser.spi.source.SupportedFeaturesNamespace.SupportedFeatures; import org.opendaylight.yangtools.yang.parser.stmt.reactor.NamespaceBehaviourWithListeners.KeyedValueAddedListener; import org.opendaylight.yangtools.yang.parser.stmt.reactor.NamespaceBehaviourWithListeners.PredicateValueAddedListener; import org.slf4j.Logger; @@ -82,7 +62,7 @@ import org.slf4j.LoggerFactory; * @param Effective Statement representation */ public abstract class StatementContextBase, E extends EffectiveStatement> - extends NamespaceStorageSupport implements Mutable { + extends ReactorStmtCtx { /** * Event listener when an item is added to model namespace. */ @@ -113,24 +93,6 @@ public abstract class StatementContextBase, E private static final Logger LOG = LoggerFactory.getLogger(StatementContextBase.class); - // Flag bit assignments - private static final int IS_SUPPORTED_BY_FEATURES = 0x01; - private static final int HAVE_SUPPORTED_BY_FEATURES = 0x02; - private static final int IS_IGNORE_IF_FEATURE = 0x04; - private static final int HAVE_IGNORE_IF_FEATURE = 0x08; - // Note: these four are related - private static final int IS_IGNORE_CONFIG = 0x10; - private static final int HAVE_IGNORE_CONFIG = 0x20; - private static final int IS_CONFIGURATION = 0x40; - private static final int HAVE_CONFIGURATION = 0x80; - - // Have-and-set flag constants, also used as masks - private static final int SET_SUPPORTED_BY_FEATURES = HAVE_SUPPORTED_BY_FEATURES | IS_SUPPORTED_BY_FEATURES; - private static final int SET_CONFIGURATION = HAVE_CONFIGURATION | IS_CONFIGURATION; - // Note: implies SET_CONFIGURATION, allowing fewer bit operations to be performed - private static final int SET_IGNORE_CONFIG = HAVE_IGNORE_CONFIG | IS_IGNORE_CONFIG | SET_CONFIGURATION; - private static final int SET_IGNORE_IF_FEATURE = HAVE_IGNORE_IF_FEATURE | IS_IGNORE_IF_FEATURE; - private final CopyHistory copyHistory; // Note: this field can strictly be derived in InferredStatementContext, but it forms the basis of many of our // operations, hence we want to keep it close by. @@ -138,32 +100,17 @@ public abstract class StatementContextBase, E private Multimap phaseListeners = ImmutableMultimap.of(); private Multimap phaseMutation = ImmutableMultimap.of(); - private List> effective = ImmutableList.of(); + private List> effectOfStatement = ImmutableList.of(); private @Nullable ModelProcessingPhase completedPhase; - private @Nullable D declaredInstance; - private @Nullable E effectiveInstance; - - // Master flag controlling whether this context can yield an effective statement - // FIXME: investigate the mechanics that are being supported by this, as it would be beneficial if we can get rid - // of this flag -- eliminating the initial alignment shadow used by below gap-filler fields. - private boolean isSupportedToBuildEffective = true; - - // Flag for use with AbstractResumedStatement. This is hiding in the alignment shadow created by above boolean - private boolean fullyDefined; - - // Flags for use with SubstatementContext. These are hiding in the alignment shadow created by above boolean and - // hence improve memory layout. - private byte flags; - - // SchemaPath cache for use with SubstatementContext and InferredStatementContext. This hurts RootStatementContext - // a bit in terms of size -- but those are only a few and SchemaPath is on its way out anyway. - private volatile SchemaPath schemaPath; + // Copy constructor used by subclasses to implement reparent() StatementContextBase(final StatementContextBase original) { + super(original); this.copyHistory = original.copyHistory; this.definition = original.definition; + this.completedPhase = original.completedPhase; } StatementContextBase(final StatementDefinitionContext def) { @@ -201,47 +148,6 @@ public abstract class StatementContextBase, E effectOfStatement.addAll(ctxs); } - @Override - public boolean isSupportedByFeatures() { - final int fl = flags & SET_SUPPORTED_BY_FEATURES; - if (fl != 0) { - return fl == SET_SUPPORTED_BY_FEATURES; - } - if (isIgnoringIfFeatures()) { - flags |= SET_SUPPORTED_BY_FEATURES; - return true; - } - - /* - * If parent is supported, we need to check if-features statements of this context. - */ - if (isParentSupportedByFeatures()) { - // If the set of supported features has not been provided, all features are supported by default. - final Set supportedFeatures = getFromNamespace(SupportedFeaturesNamespace.class, - SupportedFeatures.SUPPORTED_FEATURES); - if (supportedFeatures == null || StmtContextUtils.checkFeatureSupport(this, supportedFeatures)) { - flags |= SET_SUPPORTED_BY_FEATURES; - return true; - } - } - - // Either parent is not supported or this statement is not supported - flags |= HAVE_SUPPORTED_BY_FEATURES; - return false; - } - - protected abstract boolean isParentSupportedByFeatures(); - - @Override - public boolean isSupportedToBuildEffective() { - return isSupportedToBuildEffective; - } - - @Override - public void setIsSupportedToBuildEffective(final boolean isSupportedToBuildEffective) { - this.isSupportedToBuildEffective = isSupportedToBuildEffective; - } - @Override public CopyHistory getCopyHistory() { return copyHistory; @@ -252,94 +158,45 @@ public abstract class StatementContextBase, E return completedPhase; } - @Override - public void setCompletedPhase(final ModelProcessingPhase completedPhase) { + // FIXME: this should be propagated through a correct constructor + @Deprecated + final void setCompletedPhase(final ModelProcessingPhase completedPhase) { this.completedPhase = completedPhase; } @Override - public abstract StatementContextBase getParentContext(); - - /** - * Returns the model root for this statement. - * - * @return root context of statement - */ - @Override - public abstract RootStatementContext getRoot(); - - @Override - public final @NonNull Registry getBehaviourRegistry() { - return getRoot().getBehaviourRegistryImpl(); - } - - @Override - public final YangVersion getRootVersion() { - return getRoot().getRootVersionImpl(); + public final > void addToNs( + final Class<@NonNull N> type, final T key, final U value) { + addToNamespace(type, key, value); } - @Override - public final void setRootVersion(final YangVersion version) { - getRoot().setRootVersionImpl(version); + static final Collection> mutableEffectiveSubstatements( + final List> effective) { + return effective instanceof ImmutableCollection ? effective : Collections.unmodifiableCollection(effective); } - @Override - public final void addMutableStmtToSeal(final MutableStatement mutableStatement) { - getRoot().addMutableStmtToSealImpl(mutableStatement); - } - - @Override - public final void addRequiredSource(final SourceIdentifier dependency) { - getRoot().addRequiredSourceImpl(dependency); - } - - @Override - public final void setRootIdentifier(final SourceIdentifier identifier) { - getRoot().setRootIdentifierImpl(identifier); - } - - @Override - public final boolean isEnabledSemanticVersioning() { - return getRoot().isEnabledSemanticVersioningImpl(); - } - - @Override - public StatementSource getStatementSource() { - return getStatementSourceReference().getStatementSource(); - } - - @Override - public abstract Collection> mutableDeclaredSubstatements(); - - @Override - public Collection> mutableEffectiveSubstatements() { - if (effective instanceof ImmutableCollection) { - return effective; - } - - return Collections.unmodifiableCollection(effective); + private static List> shrinkEffective( + final List> effective) { + return effective.isEmpty() ? ImmutableList.of() : effective; } - private void shrinkEffective() { - if (effective.isEmpty()) { - effective = ImmutableList.of(); - } - } + public abstract void removeStatementFromEffectiveSubstatements(StatementDefinition statementDef); - public void removeStatementFromEffectiveSubstatements(final StatementDefinition statementDef) { + static final List> removeStatementFromEffectiveSubstatements( + final List> effective, final StatementDefinition statementDef) { if (effective.isEmpty()) { - return; + return effective; } final Iterator> iterator = effective.iterator(); while (iterator.hasNext()) { final StmtContext next = iterator.next(); - if (statementDef.equals(next.getPublicDefinition())) { + if (statementDef.equals(next.publicDefinition())) { iterator.remove(); } } - shrinkEffective(); + return shrinkEffective(effective); } /** @@ -354,25 +211,29 @@ public abstract class StatementContextBase, E * @param statementDef statement definition of the statement context to remove * @param statementArg statement argument of the statement context to remove */ - public void removeStatementFromEffectiveSubstatements(final StatementDefinition statementDef, + public abstract void removeStatementFromEffectiveSubstatements(StatementDefinition statementDef, + String statementArg); + + static final List> removeStatementFromEffectiveSubstatements( + final List> effective, final StatementDefinition statementDef, final String statementArg) { if (statementArg == null) { - removeStatementFromEffectiveSubstatements(statementDef); + return removeStatementFromEffectiveSubstatements(effective, statementDef); } if (effective.isEmpty()) { - return; + return effective; } - final Iterator> iterator = effective.iterator(); + final Iterator> iterator = effective.iterator(); while (iterator.hasNext()) { final Mutable next = iterator.next(); - if (statementDef.equals(next.getPublicDefinition()) && statementArg.equals(next.rawStatementArgument())) { + if (statementDef.equals(next.publicDefinition()) && statementArg.equals(next.rawArgument())) { iterator.remove(); } } - shrinkEffective(); + return shrinkEffective(effective); } // YANG example: RPC/action statements always have 'input' and 'output' defined @@ -382,7 +243,7 @@ public abstract class StatementContextBase, E // FIXME: YANGTOOLS-652: This does not need to be a SubstatementContext, in can be a specialized // StatementContextBase subclass. final Mutable ret = new SubstatementContext<>(this, new StatementDefinitionContext<>(support), - ImplicitSubstatement.of(getStatementSourceReference()), rawArg); + ImplicitSubstatement.of(sourceReference()), rawArg); support.onStatementAdded(ret); addEffectiveSubstatement(ret); return ret; @@ -392,14 +253,23 @@ public abstract class StatementContextBase, E * Adds an effective statement to collection of substatements. * * @param substatement substatement - * @throws IllegalStateException - * if added in declared phase - * @throws NullPointerException - * if statement parameter is null + * @throws IllegalStateException if added in declared phase + * @throws NullPointerException if statement parameter is null */ - public void addEffectiveSubstatement(final Mutable substatement) { - beforeAddEffectiveStatement(1); - effective.add(substatement); + public abstract void addEffectiveSubstatement(Mutable substatement); + + final List> addEffectiveSubstatement( + final List> effective, final Mutable substatement) { + verifyStatement(substatement); + + final List> resized = beforeAddEffectiveStatement(effective, 1); + final StatementContextBase stmt = (StatementContextBase) substatement; + final ModelProcessingPhase phase = completedPhase; + if (phase != null) { + ensureCompletedPhase(stmt, phase); + } + resized.add(stmt); + return resized; } /** @@ -411,101 +281,144 @@ public abstract class StatementContextBase, E * @throws NullPointerException * if statement parameter is null */ - public void addEffectiveSubstatements(final Collection> statements) { - if (statements.isEmpty()) { - return; + public final void addEffectiveSubstatements(final Collection> statements) { + if (!statements.isEmpty()) { + statements.forEach(StatementContextBase::verifyStatement); + addEffectiveSubstatementsImpl(statements); + } + } + + abstract void addEffectiveSubstatementsImpl(Collection> statements); + + final List> addEffectiveSubstatementsImpl( + final List> effective, + final Collection> statements) { + final List> resized = beforeAddEffectiveStatement(effective, statements.size()); + final Collection> casted = + (Collection>) statements; + final ModelProcessingPhase phase = completedPhase; + if (phase != null) { + for (StatementContextBase stmt : casted) { + ensureCompletedPhase(stmt, phase); + } } - statements.forEach(Objects::requireNonNull); - beforeAddEffectiveStatement(statements.size()); - effective.addAll(statements); + resized.addAll(casted); + return resized; } - private void beforeAddEffectiveStatement(final int toAdd) { - final ModelProcessingPhase inProgressPhase = getRoot().getSourceContext().getInProgressPhase(); - checkState(inProgressPhase == ModelProcessingPhase.FULL_DECLARATION - || inProgressPhase == ModelProcessingPhase.EFFECTIVE_MODEL, - "Effective statement cannot be added in declared phase at: %s", getStatementSourceReference()); + abstract Iterable> effectiveChildrenToComplete(); - if (effective.isEmpty()) { - effective = new ArrayList<>(toAdd); + // exposed for InferredStatementContext only + final void ensureCompletedPhase(final Mutable stmt) { + verifyStatement(stmt); + final ModelProcessingPhase phase = completedPhase; + if (phase != null) { + ensureCompletedPhase((StatementContextBase) stmt, phase); } } - // Exists only due to memory optimization - final boolean fullyDefined() { - return fullyDefined; + // Make sure target statement has transitioned at least to specified phase. This method is just before we take + // allow a statement to become our substatement. This is needed to ensure that every statement tree does not contain + // any statements which did not complete the same phase as the root statement. + private static void ensureCompletedPhase(final StatementContextBase stmt, + final ModelProcessingPhase phase) { + verify(stmt.tryToCompletePhase(phase), "Statement %s cannot complete phase %s", stmt, phase); } - // Exists only due to memory optimization, should live in AbstractResumedStatement - final void setFullyDefined() { - fullyDefined = true; + private static void verifyStatement(final Mutable stmt) { + verify(stmt instanceof StatementContextBase, "Unexpected statement %s", stmt); } - @Override - public D buildDeclared() { - checkArgument(completedPhase == ModelProcessingPhase.FULL_DECLARATION - || completedPhase == ModelProcessingPhase.EFFECTIVE_MODEL); - if (declaredInstance == null) { - declaredInstance = definition.getFactory().createDeclared(this); - } - return declaredInstance; + private List> beforeAddEffectiveStatement( + final List> effective, final int toAdd) { + // We cannot allow statement to be further mutated + verify(completedPhase != ModelProcessingPhase.EFFECTIVE_MODEL, "Cannot modify finished statement at %s", + sourceReference()); + return beforeAddEffectiveStatementUnsafe(effective, toAdd); + } + + final List> beforeAddEffectiveStatementUnsafe( + final List> effective, final int toAdd) { + final ModelProcessingPhase inProgressPhase = getRoot().getSourceContext().getInProgressPhase(); + checkState(inProgressPhase == ModelProcessingPhase.FULL_DECLARATION + || inProgressPhase == ModelProcessingPhase.EFFECTIVE_MODEL, + "Effective statement cannot be added in declared phase at: %s", sourceReference()); + + return effective.isEmpty() ? new ArrayList<>(toAdd) : effective; } + // Exposed for ReplicaStatementContext @Override - public E buildEffective() { - if (effectiveInstance == null) { - effectiveInstance = definition.getFactory().createEffective(this); - } - return effectiveInstance; + E createEffective() { + return definition.getFactory().createEffective(new BaseCurrentEffectiveStmtCtx<>(this), streamDeclared(), + streamEffective()); } + abstract Stream> streamDeclared(); + + abstract Stream> streamEffective(); + /** - * tries to execute current {@link ModelProcessingPhase} of source parsing. + * Try to execute current {@link ModelProcessingPhase} of source parsing. If the phase has already been executed, + * this method does nothing. * - * @param phase - * to be executed (completed) - * @return if phase was successfully completed - * @throws SourceException - * when an error occurred in source parsing + * @param phase to be executed (completed) + * @return true if phase was successfully completed + * @throws SourceException when an error occurred in source parsing */ - boolean tryToCompletePhase(final ModelProcessingPhase phase) { - - boolean finished = true; - final Collection openMutations = phaseMutation.get(phase); - if (!openMutations.isEmpty()) { - final Iterator it = openMutations.iterator(); - while (it.hasNext()) { - final ContextMutation current = it.next(); - if (current.isFinished()) { - it.remove(); - } else { - finished = false; - } - } + final boolean tryToCompletePhase(final ModelProcessingPhase phase) { + return phase.isCompletedBy(completedPhase) || doTryToCompletePhase(phase); + } - if (openMutations.isEmpty()) { - phaseMutation.removeAll(phase); - if (phaseMutation.isEmpty()) { - phaseMutation = ImmutableMultimap.of(); - } - } + private boolean doTryToCompletePhase(final ModelProcessingPhase phase) { + final boolean finished = phaseMutation.isEmpty() ? true : runMutations(phase); + if (completeChildren(phase) && finished) { + onPhaseCompleted(phase); + return true; } + return false; + } + private boolean completeChildren(final ModelProcessingPhase phase) { + boolean finished = true; for (final StatementContextBase child : mutableDeclaredSubstatements()) { finished &= child.tryToCompletePhase(phase); } - for (final Mutable child : effective) { - if (child instanceof StatementContextBase) { - finished &= ((StatementContextBase) child).tryToCompletePhase(phase); + for (final StatementContextBase child : effectiveChildrenToComplete()) { + finished &= child.tryToCompletePhase(phase); + } + return finished; + } + + private boolean runMutations(final ModelProcessingPhase phase) { + final Collection openMutations = phaseMutation.get(phase); + return openMutations.isEmpty() ? true : runMutations(phase, openMutations); + } + + private boolean runMutations(final ModelProcessingPhase phase, final Collection openMutations) { + boolean finished = true; + final Iterator it = openMutations.iterator(); + while (it.hasNext()) { + final ContextMutation current = it.next(); + if (current.isFinished()) { + it.remove(); + } else { + finished = false; } } - if (finished) { - onPhaseCompleted(phase); - return true; + if (openMutations.isEmpty()) { + phaseMutation.removeAll(phase); + cleanupPhaseMutation(); + } + return finished; + } + + private void cleanupPhaseMutation() { + if (phaseMutation.isEmpty()) { + phaseMutation = ImmutableMultimap.of(); } - return false; } /** @@ -520,10 +433,12 @@ public abstract class StatementContextBase, E completedPhase = phase; final Collection listeners = phaseListeners.get(phase); - if (listeners.isEmpty()) { - return; + if (!listeners.isEmpty()) { + runPhaseListeners(phase, listeners); } + } + private void runPhaseListeners(final ModelProcessingPhase phase, final Collection listeners) { final Iterator listener = listeners.iterator(); while (listener.hasNext()) { final OnPhaseFinished next = listener.next(); @@ -547,24 +462,9 @@ public abstract class StatementContextBase, E definition.onDeclarationFinished(this, phase); } - /** - * Return the context in which this statement was defined. - * - * @return statement definition - */ - protected final @NonNull StatementDefinitionContext definition() { - return definition; - } - - @Override - protected void checkLocalNamespaceAllowed(final Class> type) { - definition.checkNamespaceAllowed(type); - } - @Override - protected > void onNamespaceElementAdded(final Class type, final K key, - final V value) { - // definition().onNamespaceElementAdded(this, type, key, value); + final StatementDefinitionContext definition() { + return definition; } final > void onNamespaceItemAddedAction(final Class type, final K key, @@ -638,16 +538,6 @@ public abstract class StatementContextBase, E return (NamespaceBehaviourWithListeners) behaviour; } - @Override - public StatementDefinition getPublicDefinition() { - return definition.getPublicView(); - } - - @Override - public ModelActionBuilder newInferenceAction(final ModelProcessingPhase phase) { - return getRoot().getSourceContext().newInferenceAction(phase); - } - private static Multimap newMultimap() { return Multimaps.newListMultimap(new EnumMap<>(ModelProcessingPhase.class), () -> new ArrayList<>(1)); } @@ -661,8 +551,8 @@ public abstract class StatementContextBase, E * @throws NullPointerException if any of the arguments is null */ void addPhaseCompletedListener(final ModelProcessingPhase phase, final OnPhaseFinished listener) { - checkNotNull(phase, "Statement context processing phase cannot be null at: %s", getStatementSourceReference()); - checkNotNull(listener, "Statement context phase listener cannot be null at: %s", getStatementSourceReference()); + checkNotNull(phase, "Statement context processing phase cannot be null at: %s", sourceReference()); + checkNotNull(listener, "Statement context phase listener cannot be null at: %s", sourceReference()); ModelProcessingPhase finishedPhase = completedPhase; while (finishedPhase != null) { @@ -682,14 +572,13 @@ public abstract class StatementContextBase, E /** * Adds a {@link ContextMutation} to a {@link ModelProcessingPhase}. * - * @throws IllegalStateException - * when the mutation was registered after phase was completed + * @throws IllegalStateException when the mutation was registered after phase was completed */ - void addMutation(final ModelProcessingPhase phase, final ContextMutation mutation) { + final void addMutation(final ModelProcessingPhase phase, final ContextMutation mutation) { ModelProcessingPhase finishedPhase = completedPhase; while (finishedPhase != null) { checkState(!phase.equals(finishedPhase), "Mutation registered after phase was completed at: %s", - getStatementSourceReference()); + sourceReference()); finishedPhase = finishedPhase.getPreviousPhase(); } @@ -699,17 +588,55 @@ public abstract class StatementContextBase, E phaseMutation.put(phase, mutation); } + final void removeMutation(final ModelProcessingPhase phase, final ContextMutation mutation) { + if (!phaseMutation.isEmpty()) { + phaseMutation.remove(phase, mutation); + cleanupPhaseMutation(); + } + } + @Override - public > void addContext(final Class namespace, + public > void addContext(final Class<@NonNull N> namespace, final KT key,final StmtContext stmt) { addContextToNamespace(namespace, key, stmt); } + @Override + public Optional> copyAsChildOf(final Mutable parent, final CopyType type, + final QNameModule targetModule) { + checkEffectiveModelCompleted(this); + + final StatementSupport support = definition.support(); + final CopyPolicy policy = support.applyCopyPolicy(this, parent, type, targetModule); + switch (policy) { + case CONTEXT_INDEPENDENT: + if (hasEmptySubstatements()) { + // This statement is context-independent and has no substatements -- hence it can be freely shared. + return Optional.of(replicaAsChildOf(parent)); + } + // FIXME: YANGTOOLS-694: filter out all context-independent substatements, eliminate fall-through + // fall through + case DECLARED_COPY: + // FIXME: YANGTOOLS-694: this is still to eager, we really want to copy as a lazily-instantiated + // context, so that we can support building an effective statement without copying + // anything -- we will typically end up not being inferred against. In that case, + // this slim context should end up dealing with differences at buildContext() + // time. This is a YANGTOOLS-1067 prerequisite (which will deal with what can and + // cannot be shared across instances). + return Optional.of(parent.childCopyOf(this, type, targetModule)); + case IGNORE: + return Optional.empty(); + case REJECT: + throw new IllegalStateException("Statement " + support.getPublicView() + " should never be copied"); + default: + throw new IllegalStateException("Unhandled policy " + policy); + } + } + @Override public final Mutable childCopyOf(final StmtContext stmt, final CopyType type, final QNameModule targetModule) { - checkState(stmt.getCompletedPhase() == ModelProcessingPhase.EFFECTIVE_MODEL, - "Attempted to copy statement %s which has completed phase %s", stmt, stmt.getCompletedPhase()); + checkEffectiveModelCompleted(stmt); checkArgument(stmt instanceof StatementContextBase, "Unsupported statement %s", stmt); return childCopyOf((StatementContextBase) stmt, type, targetModule); } @@ -717,15 +644,15 @@ public abstract class StatementContextBase, E private , Z extends EffectiveStatement> Mutable childCopyOf( final StatementContextBase original, final CopyType type, final QNameModule targetModule) { final Optional> implicitParent = definition.getImplicitParentFor( - original.getPublicDefinition()); + original.publicDefinition()); final StatementContextBase result; final InferredStatementContext copy; if (implicitParent.isPresent()) { final StatementDefinitionContext def = new StatementDefinitionContext<>(implicitParent.get()); - result = new SubstatementContext(this, def, original.getStatementSourceReference(), - original.rawStatementArgument(), original.getStatementArgument(), type); + result = new SubstatementContext(this, def, original.sourceReference(), original.rawArgument(), + original.argument(), type); final CopyType childCopyType; switch (type) { @@ -751,6 +678,22 @@ public abstract class StatementContextBase, E return result; } + @Override + public final StatementContextBase replicaAsChildOf(final Mutable parent) { + checkArgument(parent instanceof StatementContextBase, "Unsupported parent %s", parent); + return replicaAsChildOf((StatementContextBase) parent); + } + + final @NonNull StatementContextBase replicaAsChildOf(final StatementContextBase stmt) { + return new ReplicaStatementContext<>(stmt, this); + } + + private static void checkEffectiveModelCompleted(final StmtContext stmt) { + final ModelProcessingPhase phase = stmt.getCompletedPhase(); + checkState(phase == ModelProcessingPhase.EFFECTIVE_MODEL, + "Attempted to copy statement %s which has completed phase %s", stmt, phase); + } + @Beta public final boolean hasImplicitParentSupport() { return definition.getFactory() instanceof ImplicitParentAwareStatementSupport; @@ -759,7 +702,7 @@ public abstract class StatementContextBase, E @Beta public final StatementContextBase wrapWithImplicit(final StatementContextBase original) { final Optional> optImplicit = definition.getImplicitParentFor( - original.getPublicDefinition()); + original.publicDefinition()); if (optImplicit.isEmpty()) { return original; } @@ -767,8 +710,7 @@ public abstract class StatementContextBase, E final StatementDefinitionContext def = new StatementDefinitionContext<>(optImplicit.get()); final CopyType type = original.getCopyHistory().getLastOperation(); final SubstatementContext result = new SubstatementContext(original.getParentContext(), def, - original.getStatementSourceReference(), original.rawStatementArgument(), original.getStatementArgument(), - type); + original.sourceReference(), original.rawArgument(), original.argument(), type); result.addEffectiveSubstatement(original.reparent(result)); result.setCompletedPhase(original.getCompletedPhase()); @@ -778,151 +720,9 @@ public abstract class StatementContextBase, E abstract StatementContextBase reparent(StatementContextBase newParent); /** - * Config statements are not all that common which means we are performing a recursive search towards the root - * every time {@link #isConfiguration()} is invoked. This is quite expensive because it causes a linear search - * for the (usually non-existent) config statement. - * - *

- * This method maintains a resolution cache, so once we have returned a result, we will keep on returning the same - * result without performing any lookups, solely to support {@link SubstatementContext#isConfiguration()}. + * Indicate that the set of substatements is empty. This is a preferred shortcut to substatement stream filtering. * - *

- * Note: use of this method implies that {@link #isIgnoringConfig()} is realized with - * {@link #isIgnoringConfig(StatementContextBase)}. + * @return True if {@link #allSubstatements()} and {@link #allSubstatementsStream()} would return an empty stream. */ - final boolean isConfiguration(final StatementContextBase parent) { - final int fl = flags & SET_CONFIGURATION; - if (fl != 0) { - return fl == SET_CONFIGURATION; - } - if (isIgnoringConfig(parent)) { - // Note: SET_CONFIGURATION has been stored in flags - return true; - } - - final StmtContext configStatement = StmtContextUtils.findFirstSubstatement(this, - ConfigStatement.class); - final boolean isConfig; - if (configStatement != null) { - isConfig = configStatement.coerceStatementArgument(); - if (isConfig) { - // Validity check: if parent is config=false this cannot be a config=true - InferenceException.throwIf(!parent.isConfiguration(), getStatementSourceReference(), - "Parent node has config=false, this node must not be specifed as config=true"); - } - } else { - // If "config" statement is not specified, the default is the same as the parent's "config" value. - isConfig = parent.isConfiguration(); - } - - // Resolved, make sure we cache this return - flags |= isConfig ? SET_CONFIGURATION : HAVE_CONFIGURATION; - return isConfig; - } - - protected abstract boolean isIgnoringConfig(); - - /** - * This method maintains a resolution cache for ignore config, so once we have returned a result, we will - * keep on returning the same result without performing any lookups. Exists only to support - * {@link SubstatementContext#isIgnoringConfig()}. - * - *

- * Note: use of this method implies that {@link #isConfiguration()} is realized with - * {@link #isConfiguration(StatementContextBase)}. - */ - final boolean isIgnoringConfig(final StatementContextBase parent) { - final int fl = flags & SET_IGNORE_CONFIG; - if (fl != 0) { - return fl == SET_IGNORE_CONFIG; - } - if (definition.isIgnoringConfig() || parent.isIgnoringConfig()) { - flags |= SET_IGNORE_CONFIG; - return true; - } - - flags |= HAVE_IGNORE_CONFIG; - return false; - } - - protected abstract boolean isIgnoringIfFeatures(); - - /** - * This method maintains a resolution cache for ignore if-feature, so once we have returned a result, we will - * keep on returning the same result without performing any lookups. Exists only to support - * {@link SubstatementContext#isIgnoringIfFeatures()}. - */ - final boolean isIgnoringIfFeatures(final StatementContextBase parent) { - final int fl = flags & SET_IGNORE_IF_FEATURE; - if (fl != 0) { - return fl == SET_IGNORE_IF_FEATURE; - } - if (definition.isIgnoringIfFeatures() || parent.isIgnoringIfFeatures()) { - flags |= SET_IGNORE_IF_FEATURE; - return true; - } - - flags |= HAVE_IGNORE_IF_FEATURE; - return false; - } - - // Exists only to support SubstatementContext/InferredStatementContext - final @NonNull Optional substatementGetSchemaPath() { - SchemaPath local = schemaPath; - if (local == null) { - synchronized (this) { - local = schemaPath; - if (local == null) { - local = createSchemaPath(coerceParentContext()); - schemaPath = local; - } - } - } - - return Optional.ofNullable(local); - } - - private SchemaPath createSchemaPath(final Mutable parent) { - final Optional maybeParentPath = parent.getSchemaPath(); - verify(maybeParentPath.isPresent(), "Parent %s does not have a SchemaPath", parent); - final SchemaPath parentPath = maybeParentPath.get(); - - if (StmtContextUtils.isUnknownStatement(this)) { - return parentPath.createChild(getPublicDefinition().getStatementName()); - } - final Object argument = getStatementArgument(); - if (argument instanceof QName) { - final QName qname = (QName) argument; - if (StmtContextUtils.producesDeclared(this, UsesStatement.class)) { - return maybeParentPath.orElse(null); - } - - return parentPath.createChild(qname); - } - if (argument instanceof String) { - // FIXME: This may yield illegal argument exceptions - final Optional> originalCtx = getOriginalCtx(); - final QName qname = StmtContextUtils.qnameFromArgument(originalCtx.orElse(this), (String) argument); - return parentPath.createChild(qname); - } - if (argument instanceof SchemaNodeIdentifier - && (StmtContextUtils.producesDeclared(this, AugmentStatement.class) - || StmtContextUtils.producesDeclared(this, RefineStatement.class) - || StmtContextUtils.producesDeclared(this, DeviationStatement.class))) { - - return parentPath.createChild(((SchemaNodeIdentifier) argument).getPathFromRoot()); - } - - // FIXME: this does not look right - return maybeParentPath.orElse(null); - } - - @Override - public final String toString() { - return addToStringAttributes(MoreObjects.toStringHelper(this).omitNullValues()).toString(); - } - - protected ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) { - return toStringHelper.add("definition", definition).add("rawArgument", rawStatementArgument()); - } + abstract boolean hasEmptySubstatements(); }