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=65656d4efa5ba85c3e4541b6cf033756f4170547;hb=5ef3027640586a5e291c18414cade544a89953f7;hp=06ade461682bbfcee45ece66f5ae4661357e062a;hpb=95f33976ec03033944c68fda72ee014c52a0444f;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 06ade46168..65656d4efa 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 @@ -8,17 +8,16 @@ package org.opendaylight.yangtools.yang.parser.stmt.reactor; import static com.google.common.base.Preconditions.checkArgument; -import static com.google.common.base.Preconditions.checkNotNull; import static com.google.common.base.Preconditions.checkState; +import static com.google.common.base.Verify.verify; +import static com.google.common.base.Verify.verifyNotNull; 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.base.VerifyException; import com.google.common.collect.ImmutableCollection; import com.google.common.collect.ImmutableList; import com.google.common.collect.ImmutableMultimap; -import com.google.common.collect.ImmutableSet; import com.google.common.collect.Multimap; import com.google.common.collect.Multimaps; import java.util.ArrayList; @@ -29,45 +28,44 @@ 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.util.OptionalBoolean; -import org.opendaylight.yangtools.yang.common.QName; import org.opendaylight.yangtools.yang.common.QNameModule; -import org.opendaylight.yangtools.yang.model.api.YangStmtMapping; 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.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.ModelActionBuilder; import org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase; +import org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase.ExecutionOrder; +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.NamespaceKeyCriterion; +import org.opendaylight.yangtools.yang.parser.spi.meta.ParserNamespace; +import org.opendaylight.yangtools.yang.parser.spi.meta.StatementFactory; 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.StatementSourceReference; -import org.opendaylight.yangtools.yang.parser.spi.source.StatementWriter.ResumedStatement; -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; import org.slf4j.LoggerFactory; +/** + * Core reactor statement implementation of {@link Mutable}. + * + * @param Argument type + * @param Declared Statement representation + * @param Effective Statement representation + */ public abstract class StatementContextBase, E extends EffectiveStatement> - extends NamespaceStorageSupport implements Mutable, ResumedStatement { + extends ReactorStmtCtx implements CopyHistory { /** * Event listener when an item is added to model namespace. */ @@ -98,80 +96,82 @@ public abstract class StatementContextBase, E private static final Logger LOG = LoggerFactory.getLogger(StatementContextBase.class); + // + // {@link CopyHistory} encoded as a single byte. We still have 4 bits unused. + // + private static final byte COPY_LAST_TYPE_MASK = 0x03; + private static final byte COPY_ADDED_BY_USES = 0x04; + private static final byte COPY_ADDED_BY_AUGMENTATION = 0x08; + private static final byte COPY_ORIGINAL = 0x00; + + private final byte copyHistory; + + static { + final int copyTypes = CopyType.values().length; + // This implies CopyType.ordinal() is <= COPY_TYPE_MASK + verify(copyTypes == COPY_LAST_TYPE_MASK + 1, "Unexpected %s CopyType values", copyTypes); + } + + // 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. private final @NonNull StatementDefinitionContext definition; - private final @NonNull StatementSourceReference statementDeclSource; - private final StmtContext originalCtx; - private final StmtContext prevCopyCtx; - private final CopyHistory copyHistory; - private final String rawArgument; + // TODO: consider keying by Byte equivalent of ExecutionOrder private Multimap phaseListeners = ImmutableMultimap.of(); private Multimap phaseMutation = ImmutableMultimap.of(); - private List> effective = ImmutableList.of(); - private List> effectOfStatement = ImmutableList.of(); - private StatementMap substatements = StatementMap.empty(); - private boolean isSupportedToBuildEffective = true; - private @Nullable ModelProcessingPhase completedPhase; - private @Nullable D declaredInstance; - private @Nullable E effectiveInstance; + private List> effectOfStatement = ImmutableList.of(); - // BooleanFields value - private byte supportedByFeatures; + /** + * {@link ModelProcessingPhase.ExecutionOrder} value of current {@link ModelProcessingPhase} of this statement. + */ + private byte executionOrder; - private boolean fullyDefined; + // Copy constructor used by subclasses to implement reparent() + StatementContextBase(final StatementContextBase original) { + super(original); + this.copyHistory = original.copyHistory; + this.definition = original.definition; + this.executionOrder = original.executionOrder; + } - StatementContextBase(final StatementDefinitionContext def, final StatementSourceReference ref, - final String rawArgument) { + StatementContextBase(final StatementDefinitionContext def) { this.definition = requireNonNull(def); - this.statementDeclSource = requireNonNull(ref); - this.rawArgument = def.internArgument(rawArgument); - this.copyHistory = CopyHistory.original(); - this.originalCtx = null; - this.prevCopyCtx = null; + this.copyHistory = COPY_ORIGINAL; } - StatementContextBase(final StatementDefinitionContext def, final StatementSourceReference ref, - final String rawArgument, final CopyType copyType) { + StatementContextBase(final StatementDefinitionContext def, final CopyType copyType) { this.definition = requireNonNull(def); - this.statementDeclSource = requireNonNull(ref); - this.rawArgument = rawArgument; - this.copyHistory = CopyHistory.of(copyType, CopyHistory.original()); - this.originalCtx = null; - this.prevCopyCtx = null; + this.copyHistory = (byte) copyFlags(copyType); } - StatementContextBase(final StatementContextBase original, final CopyType copyType) { - this.definition = original.definition; - this.statementDeclSource = original.statementDeclSource; - this.rawArgument = original.rawArgument; - this.copyHistory = CopyHistory.of(copyType, original.getCopyHistory()); - this.originalCtx = original.getOriginalCtx().orElse(original); - this.prevCopyCtx = original; + StatementContextBase(final StatementContextBase prototype, final CopyType copyType) { + this.definition = prototype.definition; + this.copyHistory = (byte) (copyFlags(copyType) | prototype.copyHistory & ~COPY_LAST_TYPE_MASK); } - StatementContextBase(final StatementContextBase original) { - this.definition = original.definition; - this.statementDeclSource = original.statementDeclSource; - this.rawArgument = original.rawArgument; - this.copyHistory = original.getCopyHistory(); - this.originalCtx = original.getOriginalCtx().orElse(original); - this.prevCopyCtx = original; - this.substatements = original.substatements; - this.effective = original.effective; + private static int copyFlags(final CopyType copyType) { + return historyFlags(copyType) | copyType.ordinal(); } - @Override - public Collection> getEffectOfStatement() { - return effectOfStatement; + private static byte historyFlags(final CopyType copyType) { + switch (copyType) { + case ADDED_BY_AUGMENTATION: + return COPY_ADDED_BY_AUGMENTATION; + case ADDED_BY_USES: + return COPY_ADDED_BY_USES; + case ADDED_BY_USES_AUGMENTATION: + return COPY_ADDED_BY_AUGMENTATION | COPY_ADDED_BY_USES; + case ORIGINAL: + return COPY_ORIGINAL; + default: + throw new VerifyException("Unhandled type " + copyType); + } } @Override - public void addAsEffectOfStatement(final StmtContext ctx) { - if (effectOfStatement.isEmpty()) { - effectOfStatement = new ArrayList<>(1); - } - effectOfStatement.add(ctx); + public Collection> getEffectOfStatement() { + return effectOfStatement; } @Override @@ -186,178 +186,77 @@ public abstract class StatementContextBase, E effectOfStatement.addAll(ctxs); } - @Override - public boolean isSupportedByFeatures() { - if (OptionalBoolean.isPresent(supportedByFeatures)) { - return OptionalBoolean.get(supportedByFeatures); - } - - if (isIgnoringIfFeatures()) { - supportedByFeatures = OptionalBoolean.of(true); - return true; - } - - final boolean isParentSupported = isParentSupportedByFeatures(); - /* - * If parent is not supported, then this context is also not supported. - * So we do not need to check if-features statements of this context and - * we can return false immediately. - */ - if (!isParentSupported) { - supportedByFeatures = OptionalBoolean.of(false); - return false; - } - - /* - * If parent is supported, we need to check if-features statements of - * this context. - */ - // 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); - final boolean ret = supportedFeatures == null || StmtContextUtils.checkFeatureSupport(this, supportedFeatures); - supportedByFeatures = OptionalBoolean.of(ret); - return ret; - } - - protected abstract boolean isParentSupportedByFeatures(); - - protected abstract boolean isIgnoringIfFeatures(); - - protected abstract boolean isIgnoringConfig(); + // + // CopyHistory integration + // @Override - public boolean isSupportedToBuildEffective() { - return isSupportedToBuildEffective; + public final CopyHistory history() { + return this; } @Override - public void setIsSupportedToBuildEffective(final boolean isSupportedToBuildEffective) { - this.isSupportedToBuildEffective = isSupportedToBuildEffective; + public final boolean isAddedByUses() { + return (copyHistory & COPY_ADDED_BY_USES) != 0; } @Override - public CopyHistory getCopyHistory() { - return copyHistory; + public final boolean isAugmenting() { + return (copyHistory & COPY_ADDED_BY_AUGMENTATION) != 0; } @Override - public Optional> getOriginalCtx() { - return Optional.ofNullable(originalCtx); + public final CopyType getLastOperation() { + return CopyType.values()[copyHistory & COPY_LAST_TYPE_MASK]; } - @Override - public Optional> getPreviousCopyCtx() { - return Optional.ofNullable(prevCopyCtx); - } + // + // Inference completion tracking + // @Override - public ModelProcessingPhase getCompletedPhase() { - return completedPhase; + final byte executionOrder() { + return executionOrder; } - @Override - public void setCompletedPhase(final ModelProcessingPhase completedPhase) { - this.completedPhase = completedPhase; + // FIXME: this should be propagated through a correct constructor + @Deprecated + final void setCompletedPhase(final ModelProcessingPhase completedPhase) { + this.executionOrder = completedPhase.executionOrder(); } @Override - public abstract StatementContextBase getParentContext(); - - /** - * Returns the model root for this statement. - * - * @return root context of statement - */ - @Override - public abstract RootStatementContext getRoot(); - - /** - * Returns the origin of the statement. - * - * @return origin of statement - */ - @Override - public StatementSource getStatementSource() { - return statementDeclSource.getStatementSource(); + public final > void addToNs( + final Class<@NonNull N> type, final T key, final U value) { + addToNamespace(type, key, value); } - /** - * Returns a reference to statement source. - * - * @return reference of statement source - */ - @Override - public StatementSourceReference getStatementSourceReference() { - return statementDeclSource; + static final Collection> mutableEffectiveSubstatements( + final List> effective) { + return effective instanceof ImmutableCollection ? effective : Collections.unmodifiableCollection(effective); } - @Override - public final String rawStatementArgument() { - return rawArgument; + private static List> shrinkEffective(final List> effective) { + return effective.isEmpty() ? ImmutableList.of() : effective; } - @Override - public Collection> declaredSubstatements() { - return substatements.values(); - } + public abstract void removeStatementFromEffectiveSubstatements(StatementDefinition statementDef); - @Override - public Collection> mutableDeclaredSubstatements() { - return substatements.values(); - } - - @Override - public Collection> effectiveSubstatements() { - return mutableEffectiveSubstatements(); - } - - @Override - public Collection> mutableEffectiveSubstatements() { - if (effective instanceof ImmutableCollection) { - return effective; - } - - return Collections.unmodifiableCollection(effective); - } - - /** - * Remove a set of statements from effective statements. - * - * @param statements statements to be removed - * @deprecated This method was used by EffectiveStatementBase to restore proper order of effects of uses statements. - * It is no longer used in that capacity and slated for removal. - */ - // FIXME: 5.0.0: remove this method - @Deprecated(forRemoval = true) - public void removeStatementsFromEffectiveSubstatements( - final Collection> statements) { - if (!effective.isEmpty()) { - effective.removeAll(statements); - shrinkEffective(); - } - } - - private void shrinkEffective() { + static final List> removeStatementFromEffectiveSubstatements( + final List> effective, final StatementDefinition statementDef) { if (effective.isEmpty()) { - effective = ImmutableList.of(); - } - } - - public void removeStatementFromEffectiveSubstatements(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); } /** @@ -372,39 +271,62 @@ 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 + @Beta + public , Z extends EffectiveStatement> @NonNull Mutable + appendImplicitSubstatement(final StatementSupport support, final String rawArg) { + // 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(sourceReference()), rawArg); + support.onStatementAdded(ret); + addEffectiveSubstatement(ret); + return ret; } /** * 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 ReactorStmtCtx stmt = (ReactorStmtCtx) substatement; + ensureCompletedExecution(stmt); + resized.add(stmt); + return resized; } /** @@ -416,179 +338,233 @@ 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); } - - statements.forEach(Objects::requireNonNull); - beforeAddEffectiveStatement(statements.size()); - effective.addAll(statements); } - 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 void addEffectiveSubstatementsImpl(Collection> statements); - if (effective.isEmpty()) { - effective = new ArrayList<>(toAdd); + final List> addEffectiveSubstatementsImpl(final List> effective, + final Collection> statements) { + final List> resized = beforeAddEffectiveStatement(effective, statements.size()); + final Collection> casted = + (Collection>) statements; + if (executionOrder != ExecutionOrder.NULL) { + for (ReactorStmtCtx stmt : casted) { + ensureCompletedExecution(stmt, executionOrder); + } } + + resized.addAll(casted); + return resized; } - /** - * Create a new substatement at the specified offset. - * - * @param offset Substatement offset - * @param def definition context - * @param ref source reference - * @param argument statement argument - * @param new substatement argument type - * @param new substatement declared type - * @param new substatement effective type - * @return A new substatement - */ - @SuppressWarnings("checkstyle:methodTypeParameterName") - public final , Z extends EffectiveStatement> - StatementContextBase createSubstatement(final int offset, - final StatementDefinitionContext def, final StatementSourceReference ref, - final String argument) { - final ModelProcessingPhase inProgressPhase = getRoot().getSourceContext().getInProgressPhase(); - checkState(inProgressPhase != ModelProcessingPhase.EFFECTIVE_MODEL, - "Declared statement cannot be added in effective phase at: %s", getStatementSourceReference()); + abstract Iterable> effectiveChildrenToComplete(); - final Optional> implicitParent = definition.getImplicitParentFor(def.getPublicView()); - if (implicitParent.isPresent()) { - return createImplicitParent(offset, implicitParent.get(), ref, argument).createSubstatement(offset, def, - ref, argument); - } - - final StatementContextBase ret = new SubstatementContext<>(this, def, ref, argument); - substatements = substatements.put(offset, ret); - def.onStatementAdded(ret); - return ret; + // exposed for InferredStatementContext only + final void ensureCompletedPhase(final Mutable stmt) { + verifyStatement(stmt); + ensureCompletedExecution((ReactorStmtCtx) stmt); } - private StatementContextBase createImplicitParent(final int offset, - final StatementSupport implicitParent, final StatementSourceReference ref, final String argument) { - final StatementDefinitionContext def = new StatementDefinitionContext<>(implicitParent); - return createSubstatement(offset, def, ImplicitSubstatement.of(ref), argument); + // Make sure target statement has transitioned at least to our phase (if we have one). 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 void ensureCompletedExecution(final ReactorStmtCtx stmt) { + if (executionOrder != ExecutionOrder.NULL) { + ensureCompletedExecution(stmt, executionOrder); + } } - public void appendImplicitStatement(final StatementSupport statementToAdd) { - createSubstatement(substatements.capacity(), new StatementDefinitionContext<>(statementToAdd), - ImplicitSubstatement.of(getStatementSourceReference()), null); + private static void ensureCompletedExecution(final ReactorStmtCtx stmt, final byte executionOrder) { + verify(stmt.tryToCompletePhase(executionOrder), "Statement %s cannot complete phase %s", stmt, executionOrder); } - /** - * Lookup substatement by its offset in this statement. - * - * @param offset Substatement offset - * @return Substatement, or null if substatement does not exist. - */ - final StatementContextBase lookupSubstatement(final int offset) { - return substatements.get(offset); + private static void verifyStatement(final Mutable stmt) { + verify(stmt instanceof ReactorStmtCtx, "Unexpected statement %s", stmt); } - final void setFullyDefined() { - this.fullyDefined = true; + private List> beforeAddEffectiveStatement(final List> effective, + final int toAdd) { + // We cannot allow statement to be further mutated. + // TODO: we really want to say 'not NULL and not at or after EFFECTIVE_MODEL here. This will matter if we have + // a phase after EFFECTIVE_MODEL + verify(executionOrder != ExecutionOrder.EFFECTIVE_MODEL, "Cannot modify finished statement at %s", + sourceReference()); + return beforeAddEffectiveStatementUnsafe(effective, toAdd); } - final void resizeSubstatements(final int expectedSize) { - substatements = substatements.ensureCapacity(expectedSize); - } + 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()); - final void walkChildren(final ModelProcessingPhase phase) { - checkState(fullyDefined); - substatements.values().forEach(stmt -> { - stmt.walkChildren(phase); - stmt.endDeclared(phase); - }); + return effective.isEmpty() ? new ArrayList<>(toAdd) : effective; } @Override - public D buildDeclared() { - checkArgument(completedPhase == ModelProcessingPhase.FULL_DECLARATION - || completedPhase == ModelProcessingPhase.EFFECTIVE_MODEL); - if (declaredInstance == null) { - declaredInstance = definition().getFactory().createDeclared(this); + final E createEffective() { + final E result = createEffective(definition.getFactory()); + if (result instanceof MutableStatement) { + getRoot().addMutableStmtToSeal((MutableStatement) result); } - return declaredInstance; + return result; } - @Override - public E buildEffective() { - if (effectiveInstance == null) { - effectiveInstance = definition().getFactory().createEffective(this); - } - return effectiveInstance; + @NonNull E createEffective(final StatementFactory factory) { + return createEffective(factory, this); + } + + // Creates EffectiveStatement through full materialization + static , E extends EffectiveStatement> @NonNull E createEffective( + final StatementFactory factory, final StatementContextBase ctx) { + return factory.createEffective(ctx, ctx.streamDeclared(), ctx.streamEffective()); } /** - * tries to execute current {@link ModelProcessingPhase} of source parsing. + * Return a stream of declared statements which can be built into an {@link EffectiveStatement}, as per + * {@link StmtContext#buildEffective()} contract. + * + * @return Stream of supported declared statements. + */ + // FIXME: we really want to unify this with streamEffective(), under its name + abstract Stream> streamDeclared(); + + /** + * Return a stream of inferred statements which can be built into an {@link EffectiveStatement}, as per + * {@link StmtContext#buildEffective()} contract. * - * @param phase - * to be executed (completed) - * @return if phase was successfully completed - * @throws SourceException - * when an error occurred in source parsing + * @return Stream of supported effective statements. */ - boolean tryToCompletePhase(final ModelProcessingPhase phase) { + // FIXME: this method is currently a misnomer, but unifying with streamDeclared() would make this accurate again + abstract Stream> streamEffective(); + + @Override + final boolean doTryToCompletePhase(final byte targetOrder) { + final boolean finished = phaseMutation.isEmpty() ? true : runMutations(targetOrder); + if (completeChildren(targetOrder) && finished) { + onPhaseCompleted(targetOrder); + return true; + } + return false; + } + private boolean completeChildren(final byte targetOrder) { boolean finished = true; + for (final StatementContextBase child : mutableDeclaredSubstatements()) { + finished &= child.tryToCompletePhase(targetOrder); + } + for (final ReactorStmtCtx child : effectiveChildrenToComplete()) { + finished &= child.tryToCompletePhase(targetOrder); + } + return finished; + } + + private boolean runMutations(final byte targetOrder) { + final ModelProcessingPhase phase = verifyNotNull(ModelProcessingPhase.ofExecutionOrder(targetOrder)); 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; - } - } + return openMutations.isEmpty() ? true : runMutations(phase, openMutations); + } - if (openMutations.isEmpty()) { - phaseMutation.removeAll(phase); - if (phaseMutation.isEmpty()) { - phaseMutation = ImmutableMultimap.of(); - } + 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; } } - for (final StatementContextBase child : substatements.values()) { - finished &= child.tryToCompletePhase(phase); - } - for (final Mutable child : effective) { - if (child instanceof StatementContextBase) { - finished &= ((StatementContextBase) child).tryToCompletePhase(phase); - } + if (openMutations.isEmpty()) { + phaseMutation.removeAll(phase); + cleanupPhaseMutation(); } + return finished; + } - if (finished) { - onPhaseCompleted(phase); - return true; + private void cleanupPhaseMutation() { + if (phaseMutation.isEmpty()) { + phaseMutation = ImmutableMultimap.of(); } - return false; } /** - * Occurs on end of {@link ModelProcessingPhase} of source parsing. + * Occurs on end of {@link ModelProcessingPhase} of source parsing. This method must not be called with + * {@code executionOrder} equal to {@link ExecutionOrder#NULL}. * - * @param phase - * that was to be completed (finished) - * @throws SourceException - * when an error occurred in source parsing + * @param phase that was to be completed (finished) + * @throws SourceException when an error occurred in source parsing */ - private void onPhaseCompleted(final ModelProcessingPhase phase) { - completedPhase = phase; + private void onPhaseCompleted(final byte completedOrder) { + executionOrder = completedOrder; + if (completedOrder == ExecutionOrder.EFFECTIVE_MODEL) { + // We have completed effective model, substatements are guaranteed not to change + summarizeSubstatementPolicy(); + } + final ModelProcessingPhase phase = verifyNotNull(ModelProcessingPhase.ofExecutionOrder(completedOrder)); final Collection listeners = phaseListeners.get(phase); - if (listeners.isEmpty()) { - return; + if (!listeners.isEmpty()) { + runPhaseListeners(phase, listeners); } + } + private void summarizeSubstatementPolicy() { + if (definition().support().copyPolicy() == CopyPolicy.EXACT_REPLICA || noSensitiveSubstatements()) { + setAllSubstatementsContextIndependent(); + } + } + + /** + * Determine whether any substatements are copy-sensitive as determined by {@link StatementSupport#copyPolicy()}. + * Only {@link CopyPolicy#CONTEXT_INDEPENDENT}, {@link CopyPolicy#EXACT_REPLICA} and {@link CopyPolicy#IGNORE} are + * copy-insensitive. Note that statements which are not {@link StmtContext#isSupportedToBuildEffective()} are all + * considered copy-insensitive. + * + *

+ * Implementations are expected to call {@link #noSensitiveSubstatements()} to actually traverse substatement sets. + * + * @return True if no substatements require copy-sensitive handling + */ + abstract boolean noSensitiveSubstatements(); + + /** + * Determine whether any of the provided substatements are context-sensitive for purposes of implementing + * {@link #noSensitiveSubstatements()}. + * + * @param substatements Substatements to check + * @return True if no substatements require context-sensitive handling + */ + static boolean noSensitiveSubstatements(final Collection> substatements) { + for (ReactorStmtCtx stmt : substatements) { + if (stmt.isSupportedToBuildEffective()) { + if (!stmt.allSubstatementsContextIndependent()) { + // This is a recursive property + return false; + } + + switch (stmt.definition().support().copyPolicy()) { + case CONTEXT_INDEPENDENT: + case EXACT_REPLICA: + case IGNORE: + break; + default: + return false; + } + } + } + return true; + } + + private void runPhaseListeners(final ModelProcessingPhase phase, final Collection listeners) { final Iterator listener = listeners.iterator(); while (listener.hasNext()) { final OnPhaseFinished next = listener.next(); @@ -609,30 +585,15 @@ public abstract class StatementContextBase, E * Ends declared section of current node. */ void endDeclared(final ModelProcessingPhase phase) { - definition().onDeclarationFinished(this, phase); - } - - /** - * Return the context in which this statement was defined. - * - * @return statement definition - */ - protected final @NonNull StatementDefinitionContext definition() { - return definition; + definition.onDeclarationFinished(this, phase); } @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, + final > void onNamespaceItemAddedAction(final Class type, final K key, final OnNamespaceItemAdded listener) { final Object potential = getFromNamespace(type, key); if (potential != null) { @@ -649,7 +610,7 @@ public abstract class StatementContextBase, E }); } - final > void onNamespaceItemAddedAction(final Class type, + final > void onNamespaceItemAddedAction(final Class type, final ModelProcessingPhase phase, final NamespaceKeyCriterion criterion, final OnNamespaceItemAdded listener) { final Optional> existing = getFromNamespace(type, criterion); @@ -675,7 +636,7 @@ public abstract class StatementContextBase, E }); } - final > void selectMatch(final Class type, + final > void selectMatch(final Class type, final NamespaceKeyCriterion criterion, final OnNamespaceItemAdded listener) { final Optional> optMatch = getFromNamespace(type, criterion); checkState(optMatch.isPresent(), "Failed to find a match for criterion %s in namespace %s node %s", criterion, @@ -684,7 +645,7 @@ public abstract class StatementContextBase, E listener.namespaceItemAdded(StatementContextBase.this, type, match.getKey(), match.getValue()); } - final > void waitForPhase(final Object value, final Class type, + final > void waitForPhase(final Object value, final Class type, final ModelProcessingPhase phase, final NamespaceKeyCriterion criterion, final OnNamespaceItemAdded listener) { ((StatementContextBase) value).addPhaseCompletedListener(phase, @@ -694,7 +655,7 @@ public abstract class StatementContextBase, E }); } - private > NamespaceBehaviourWithListeners getBehaviour( + private > NamespaceBehaviourWithListeners getBehaviour( final Class type) { final NamespaceBehaviour behaviour = getBehaviourRegistry().getNamespaceBehaviour(type); checkArgument(behaviour instanceof NamespaceBehaviourWithListeners, "Namespace %s does not support listeners", @@ -703,19 +664,6 @@ public abstract class StatementContextBase, E return (NamespaceBehaviourWithListeners) behaviour; } - /** - * See {@link StatementSupport#getPublicView()}. - */ - @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)); } @@ -729,10 +677,10 @@ 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()); + requireNonNull(phase, "Statement context processing phase cannot be null"); + requireNonNull(listener, "Statement context phase listener cannot be null"); - ModelProcessingPhase finishedPhase = completedPhase; + ModelProcessingPhase finishedPhase = ModelProcessingPhase.ofExecutionOrder(executionOrder); while (finishedPhase != null) { if (phase.equals(finishedPhase)) { listener.phaseFinished(this, finishedPhase); @@ -750,16 +698,11 @@ 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) { - ModelProcessingPhase finishedPhase = completedPhase; - while (finishedPhase != null) { - checkState(!phase.equals(finishedPhase), "Mutation registered after phase was completed at: %s", - getStatementSourceReference()); - finishedPhase = finishedPhase.getPreviousPhase(); - } + final void addMutation(final ModelProcessingPhase phase, final ContextMutation mutation) { + checkState(executionOrder < phase.executionOrder(), "Mutation registered after phase was completed at: %s", + sourceReference()); if (phaseMutation.isEmpty()) { phaseMutation = newMultimap(); @@ -767,33 +710,91 @@ 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 Mutable childCopyOf(final StmtContext stmt, final CopyType type, + public Optional> copyAsChildOf(final Mutable parent, 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()); - checkArgument(stmt instanceof SubstatementContext, "Unsupported statement %s", stmt); - return childCopyOf((SubstatementContext) stmt, type, targetModule); + checkEffectiveModelCompleted(this); + return Optional.ofNullable(copyAsChildOfImpl(parent, type, targetModule)); + } + + private ReactorStmtCtx copyAsChildOfImpl(final Mutable parent, final CopyType type, + final QNameModule targetModule) { + final StatementSupport support = definition.support(); + final CopyPolicy policy = support.copyPolicy(); + switch (policy) { + case EXACT_REPLICA: + return replicaAsChildOf(parent); + case CONTEXT_INDEPENDENT: + if (allSubstatementsContextIndependent()) { + return replicaAsChildOf(parent); + } + + // fall through + case DECLARED_COPY: + // FIXME: ugly cast + return (ReactorStmtCtx) parent.childCopyOf(this, type, targetModule); + case IGNORE: + return null; + case REJECT: + throw new IllegalStateException("Statement " + support.getPublicView() + " should never be copied"); + default: + throw new IllegalStateException("Unhandled policy " + policy); + } + } + + @Override + final ReactorStmtCtx asEffectiveChildOf(final StatementContextBase parent, final CopyType type, + final QNameModule targetModule) { + final ReactorStmtCtx copy = copyAsChildOfImpl(parent, type, targetModule); + if (copy == null) { + // The statement fizzled, this should never happen, perhaps a verify()? + return null; + } + + parent.ensureCompletedPhase(copy); + return canReuseCurrent(copy) ? this : copy; + } + + private boolean canReuseCurrent(final ReactorStmtCtx copy) { + // Defer to statement factory to see if we can reuse this object. If we can and have only context-independent + // substatements we can reuse the object. More complex cases are handled indirectly via the copy. + return definition.getFactory().canReuseCurrent(copy, this, buildEffective().effectiveSubstatements()) + && allSubstatementsContextIndependent(); + } + + @Override + public final Mutable childCopyOf(final StmtContext stmt, final CopyType type, + final QNameModule targetModule) { + checkEffectiveModelCompleted(stmt); + checkArgument(stmt instanceof StatementContextBase, "Unsupported statement %s", stmt); + return childCopyOf((StatementContextBase) stmt, type, targetModule); } private , Z extends EffectiveStatement> Mutable childCopyOf( - final SubstatementContext original, final CopyType type, final QNameModule targetModule) { + final StatementContextBase original, final CopyType type, final QNameModule targetModule) { final Optional> implicitParent = definition.getImplicitParentFor( - original.getPublicDefinition()); + original.publicDefinition()); - final SubstatementContext result; - final SubstatementContext copy; + final StatementContextBase result; + final InferredStatementContext copy; if (implicitParent.isPresent()) { final StatementDefinitionContext def = new StatementDefinitionContext<>(implicitParent.get()); - result = new SubstatementContext(this, def, original.getSourceReference(), - original.rawStatementArgument(), original.getStatementArgument(), type); + result = new SubstatementContext(this, def, original.sourceReference(), original.rawArgument(), + original.argument(), type); final CopyType childCopyType; switch (type) { @@ -809,34 +810,29 @@ public abstract class StatementContextBase, E childCopyType = type; } - copy = new SubstatementContext<>(original, result, childCopyType, targetModule); + copy = new InferredStatementContext<>(result, original, childCopyType, type, targetModule); result.addEffectiveSubstatement(copy); - original.definition().onStatementAdded(copy); } else { - result = copy = new SubstatementContext<>(original, this, type, targetModule); - original.definition().onStatementAdded(copy); + result = copy = new InferredStatementContext<>(this, original, type, type, targetModule); } - original.copyTo(copy, type, targetModule); + original.definition.onStatementAdded(copy); return result; } @Override - public @NonNull StatementDefinition getDefinition() { - return getPublicDefinition(); - } - - @Override - public @NonNull StatementSourceReference getSourceReference() { - return getStatementSourceReference(); + final ReplicaStatementContext replicaAsChildOf(final StatementContextBase parent) { + return new ReplicaStatementContext<>(parent, this); } - @Override - public boolean isFullyDefined() { - return fullyDefined; + 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 + // FIXME: this information should be exposed as a well-known Namespace public final boolean hasImplicitParentSupport() { return definition.getFactory() instanceof ImplicitParentAwareStatementSupport; } @@ -844,87 +840,27 @@ 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; } final StatementDefinitionContext def = new StatementDefinitionContext<>(optImplicit.get()); - final CopyType type = original.getCopyHistory().getLastOperation(); + final CopyType type = original.history().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(new SubstatementContext<>(original, result)); + result.addEffectiveSubstatement(original.reparent(result)); result.setCompletedPhase(original.getCompletedPhase()); return result; } - final void copyTo(final StatementContextBase target, final CopyType typeOfCopy, - @Nullable final QNameModule targetModule) { - final Collection> buffer = new ArrayList<>(substatements.size() + effective.size()); - - for (final Mutable stmtContext : substatements.values()) { - if (stmtContext.isSupportedByFeatures()) { - copySubstatement(stmtContext, target, typeOfCopy, targetModule, buffer); - } - } - - for (final Mutable stmtContext : effective) { - copySubstatement(stmtContext, target, typeOfCopy, targetModule, buffer); - } - - target.addEffectiveSubstatements(buffer); - } - - private void copySubstatement(final Mutable stmtContext, final Mutable target, - final CopyType typeOfCopy, final QNameModule newQNameModule, final Collection> buffer) { - if (needToCopyByUses(stmtContext)) { - final Mutable copy = target.childCopyOf(stmtContext, typeOfCopy, newQNameModule); - LOG.debug("Copying substatement {} for {} as {}", stmtContext, this, copy); - buffer.add(copy); - } else if (isReusedByUses(stmtContext)) { - LOG.debug("Reusing substatement {} for {}", stmtContext, this); - buffer.add(stmtContext); - } else { - LOG.debug("Skipping statement {}", stmtContext); - } - } - - // FIXME: revise this, as it seems to be wrong - private static final ImmutableSet NOCOPY_FROM_GROUPING_SET = ImmutableSet.of( - YangStmtMapping.DESCRIPTION, - YangStmtMapping.REFERENCE, - YangStmtMapping.STATUS); - private static final ImmutableSet REUSED_DEF_SET = ImmutableSet.of( - YangStmtMapping.TYPE, - YangStmtMapping.TYPEDEF, - YangStmtMapping.USES); + abstract StatementContextBase reparent(StatementContextBase newParent); - private static boolean needToCopyByUses(final StmtContext stmtContext) { - final StatementDefinition def = stmtContext.getPublicDefinition(); - if (REUSED_DEF_SET.contains(def)) { - LOG.debug("Will reuse {} statement {}", def, stmtContext); - return false; - } - if (NOCOPY_FROM_GROUPING_SET.contains(def)) { - return !YangStmtMapping.GROUPING.equals(stmtContext.coerceParentContext().getPublicDefinition()); - } - - LOG.debug("Will copy {} statement {}", def, stmtContext); - return true; - } - - private static boolean isReusedByUses(final StmtContext stmtContext) { - return REUSED_DEF_SET.contains(stmtContext.getPublicDefinition()); - } - - @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", rawArgument); - } + /** + * Indicate that the set of substatements is empty. This is a preferred shortcut to substatement stream filtering. + * + * @return True if {@link #allSubstatements()} and {@link #allSubstatementsStream()} would return an empty stream. + */ + abstract boolean hasEmptySubstatements(); }