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 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;
-import com.google.common.collect.ImmutableSet;
import com.google.common.collect.Multimap;
import com.google.common.collect.Multimaps;
import java.util.ArrayList;
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.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 <A> Argument type
+ * @param <D> Declared Statement representation
+ * @param <E> Effective Statement representation
+ */
public abstract class StatementContextBase<A, D extends DeclaredStatement<A>, E extends EffectiveStatement<A, D>>
- extends NamespaceStorageSupport implements Mutable<A, D, E>, ResumedStatement {
+ extends ReactorStmtCtx<A, D, E> {
/**
* Event listener when an item is added to model namespace.
*/
private static final Logger LOG = LoggerFactory.getLogger(StatementContextBase.class);
- private final @NonNull StatementDefinitionContext<A, D, E> definition;
- private final @NonNull StatementSourceReference statementDeclSource;
- private final StmtContext<?, ?, ?> originalCtx;
- private final StmtContext<?, ?, ?> prevCopyCtx;
private final CopyHistory copyHistory;
- private final String rawArgument;
+ // 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<A, D, E> definition;
private Multimap<ModelProcessingPhase, OnPhaseFinished> phaseListeners = ImmutableMultimap.of();
private Multimap<ModelProcessingPhase, ContextMutation> phaseMutation = ImmutableMultimap.of();
- private List<Mutable<?, ?, ?>> effective = ImmutableList.of();
+
private List<StmtContext<?, ?, ?>> effectOfStatement = ImmutableList.of();
- private StatementMap substatements = StatementMap.empty();
- private boolean isSupportedToBuildEffective = true;
private @Nullable ModelProcessingPhase completedPhase;
- private @Nullable D declaredInstance;
- private @Nullable E effectiveInstance;
- // BooleanFields value
- private byte supportedByFeatures;
-
- private boolean fullyDefined;
+ // Copy constructor used by subclasses to implement reparent()
+ StatementContextBase(final StatementContextBase<A, D, E> original) {
+ super(original);
+ this.copyHistory = original.copyHistory;
+ this.definition = original.definition;
+ this.completedPhase = original.completedPhase;
+ }
- StatementContextBase(final StatementDefinitionContext<A, D, E> def, final StatementSourceReference ref,
- final String rawArgument) {
+ StatementContextBase(final StatementDefinitionContext<A, D, E> def) {
this.definition = requireNonNull(def);
- this.statementDeclSource = requireNonNull(ref);
- this.rawArgument = def.internArgument(rawArgument);
this.copyHistory = CopyHistory.original();
- this.originalCtx = null;
- this.prevCopyCtx = null;
}
- StatementContextBase(final StatementDefinitionContext<A, D, E> def, final StatementSourceReference ref,
- final String rawArgument, final CopyType copyType) {
+ StatementContextBase(final StatementDefinitionContext<A, D, E> def, final CopyHistory copyHistory) {
this.definition = requireNonNull(def);
- this.statementDeclSource = requireNonNull(ref);
- this.rawArgument = rawArgument;
- this.copyHistory = CopyHistory.of(copyType, CopyHistory.original());
- this.originalCtx = null;
- this.prevCopyCtx = null;
- }
-
- StatementContextBase(final StatementContextBase<A, D, E> 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<A, D, E> 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;
+ this.copyHistory = requireNonNull(copyHistory);
}
@Override
return effectOfStatement;
}
- @Override
- public void addAsEffectOfStatement(final StmtContext<?, ?, ?> ctx) {
- if (effectOfStatement.isEmpty()) {
- effectOfStatement = new ArrayList<>(1);
- }
- effectOfStatement.add(ctx);
- }
-
@Override
public void addAsEffectOfStatement(final Collection<? extends StmtContext<?, ?, ?>> ctxs) {
if (ctxs.isEmpty()) {
}
@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<QName> 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();
-
- @Override
- public boolean isSupportedToBuildEffective() {
- return isSupportedToBuildEffective;
- }
-
- @Override
- public void setIsSupportedToBuildEffective(final boolean isSupportedToBuildEffective) {
- this.isSupportedToBuildEffective = isSupportedToBuildEffective;
- }
-
- @Override
- public CopyHistory getCopyHistory() {
+ public final CopyHistory history() {
return copyHistory;
}
@Override
- public Optional<StmtContext<?, ?, ?>> getOriginalCtx() {
- return Optional.ofNullable(originalCtx);
- }
-
- @Override
- public Optional<? extends StmtContext<?, ?, ?>> getPreviousCopyCtx() {
- return Optional.ofNullable(prevCopyCtx);
- }
-
- @Override
- public ModelProcessingPhase getCompletedPhase() {
+ public final ModelProcessingPhase getCompletedPhase() {
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();
-
- /**
- * Returns the origin of the statement.
- *
- * @return origin of statement
- */
- @Override
- public StatementSource getStatementSource() {
- return statementDeclSource.getStatementSource();
+ public final <K, V, T extends K, U extends V, N extends ParserNamespace<K, V>> 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<? extends Mutable<?, ?, ?>> mutableEffectiveSubstatements(
+ final List<ReactorStmtCtx<?, ?, ?>> effective) {
+ return effective instanceof ImmutableCollection ? effective : Collections.unmodifiableCollection(effective);
}
- @Override
- public final String rawStatementArgument() {
- return rawArgument;
+ private static List<ReactorStmtCtx<?, ?, ?>> shrinkEffective(final List<ReactorStmtCtx<?, ?, ?>> effective) {
+ return effective.isEmpty() ? ImmutableList.of() : effective;
}
- @Override
- public Collection<? extends StmtContext<?, ?, ?>> declaredSubstatements() {
- return substatements.values();
- }
+ public abstract void removeStatementFromEffectiveSubstatements(StatementDefinition statementDef);
- @Override
- public Collection<? extends Mutable<?, ?, ?>> mutableDeclaredSubstatements() {
- return substatements.values();
- }
-
- @Override
- public Collection<? extends StmtContext<?, ?, ?>> effectiveSubstatements() {
- return mutableEffectiveSubstatements();
- }
-
- @Override
- public Collection<? extends Mutable<?, ?, ?>> 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<? extends StmtContext<?, ?, ?>> statements) {
- if (!effective.isEmpty()) {
- effective.removeAll(statements);
- shrinkEffective();
- }
- }
-
- private void shrinkEffective() {
- if (effective.isEmpty()) {
- effective = ImmutableList.of();
- }
- }
-
- public void removeStatementFromEffectiveSubstatements(final StatementDefinition statementDef) {
+ static final List<ReactorStmtCtx<?, ?, ?>> removeStatementFromEffectiveSubstatements(
+ final List<ReactorStmtCtx<?, ?, ?>> effective, final StatementDefinition statementDef) {
if (effective.isEmpty()) {
- return;
+ return effective;
}
final Iterator<? extends StmtContext<?, ?, ?>> 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);
}
/**
* @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<ReactorStmtCtx<?, ?, ?>> removeStatementFromEffectiveSubstatements(
+ final List<ReactorStmtCtx<?, ?, ?>> effective, final StatementDefinition statementDef,
final String statementArg) {
if (statementArg == null) {
- removeStatementFromEffectiveSubstatements(statementDef);
+ return removeStatementFromEffectiveSubstatements(effective, statementDef);
}
if (effective.isEmpty()) {
- return;
+ return effective;
}
- final Iterator<Mutable<?, ?, ?>> iterator = effective.iterator();
+ final Iterator<ReactorStmtCtx<?, ?, ?>> 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 <X, Y extends DeclaredStatement<X>, Z extends EffectiveStatement<X, Y>> @NonNull Mutable<X, Y, Z>
+ appendImplicitSubstatement(final StatementSupport<X, Y, Z> support, final String rawArg) {
+ // FIXME: YANGTOOLS-652: This does not need to be a SubstatementContext, in can be a specialized
+ // StatementContextBase subclass.
+ final Mutable<X, Y, Z> 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<ReactorStmtCtx<?, ?, ?>> addEffectiveSubstatement(final List<ReactorStmtCtx<?, ?, ?>> effective,
+ final Mutable<?, ?, ?> substatement) {
+ verifyStatement(substatement);
+
+ final List<ReactorStmtCtx<?, ?, ?>> resized = beforeAddEffectiveStatement(effective, 1);
+ final ReactorStmtCtx<?, ?, ?> stmt = (ReactorStmtCtx<?, ?, ?>) substatement;
+ final ModelProcessingPhase phase = completedPhase;
+ if (phase != null) {
+ ensureCompletedPhase(stmt, phase);
+ }
+ resized.add(stmt);
+ return resized;
}
/**
* @throws NullPointerException
* if statement parameter is null
*/
- public void addEffectiveSubstatements(final Collection<? extends Mutable<?, ?, ?>> statements) {
- if (statements.isEmpty()) {
- return;
+ public final void addEffectiveSubstatements(final Collection<? extends Mutable<?, ?, ?>> 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<? extends Mutable<?, ?, ?>> statements);
- if (effective.isEmpty()) {
- effective = new ArrayList<>(toAdd);
+ final List<ReactorStmtCtx<?, ?, ?>> addEffectiveSubstatementsImpl(final List<ReactorStmtCtx<?, ?, ?>> effective,
+ final Collection<? extends Mutable<?, ?, ?>> statements) {
+ final List<ReactorStmtCtx<?, ?, ?>> resized = beforeAddEffectiveStatement(effective, statements.size());
+ final Collection<? extends ReactorStmtCtx<?, ?, ?>> casted =
+ (Collection<? extends ReactorStmtCtx<?, ?, ?>>) statements;
+ final ModelProcessingPhase phase = completedPhase;
+ if (phase != null) {
+ for (ReactorStmtCtx<?, ?, ?> stmt : casted) {
+ ensureCompletedPhase(stmt, phase);
+ }
}
+
+ 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 <X> new substatement argument type
- * @param <Y> new substatement declared type
- * @param <Z> new substatement effective type
- * @return A new substatement
- */
- @SuppressWarnings("checkstyle:methodTypeParameterName")
- public final <X, Y extends DeclaredStatement<X>, Z extends EffectiveStatement<X, Y>>
- StatementContextBase<X, Y, Z> createSubstatement(final int offset,
- final StatementDefinitionContext<X, Y, Z> 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<ReactorStmtCtx<?, ?, ?>> effectiveChildrenToComplete();
- final Optional<StatementSupport<?, ?, ?>> implicitParent = definition.getImplicitParentFor(def.getPublicView());
- if (implicitParent.isPresent()) {
- return createImplicitParent(offset, implicitParent.get(), ref, argument).createSubstatement(offset, def,
- ref, argument);
+ // exposed for InferredStatementContext only
+ final void ensureCompletedPhase(final Mutable<?, ?, ?> stmt) {
+ verifyStatement(stmt);
+ final ModelProcessingPhase phase = completedPhase;
+ if (phase != null) {
+ ensureCompletedPhase((ReactorStmtCtx<?, ?, ?>) stmt, phase);
}
-
- final StatementContextBase<X, Y, Z> ret = new SubstatementContext<>(this, def, ref, argument);
- substatements = substatements.put(offset, ret);
- def.onStatementAdded(ret);
- return ret;
- }
-
- 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);
}
- public void appendImplicitStatement(final StatementSupport<?, ?, ?> statementToAdd) {
- createSubstatement(substatements.capacity(), new StatementDefinitionContext<>(statementToAdd),
- ImplicitSubstatement.of(getStatementSourceReference()), null);
+ // 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 ReactorStmtCtx<?, ?, ?> stmt, final ModelProcessingPhase phase) {
+ verify(stmt.tryToCompletePhase(phase), "Statement %s cannot complete phase %s", stmt, phase);
}
- /**
- * 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<ReactorStmtCtx<?, ?, ?>> beforeAddEffectiveStatement(final List<ReactorStmtCtx<?, ?, ?>> 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 void resizeSubstatements(final int expectedSize) {
- substatements = substatements.ensureCapacity(expectedSize);
- }
+ final List<ReactorStmtCtx<?, ?, ?>> beforeAddEffectiveStatementUnsafe(final List<ReactorStmtCtx<?, ?, ?>> 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<A, D, E> factory) {
+ return createEffective(factory, this);
+ }
+
+ // Creates EffectiveStatement through full materialization
+ static <A, D extends DeclaredStatement<A>, E extends EffectiveStatement<A, D>> @NonNull E createEffective(
+ final StatementFactory<A, D, E> factory, final StatementContextBase<A, D, E> 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.
*
- * @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 declared statements.
*/
- boolean tryToCompletePhase(final ModelProcessingPhase phase) {
+ // FIXME: we really want to unify this with streamEffective(), under its name
+ abstract Stream<? extends @NonNull StmtContext<?, ?, ?>> streamDeclared();
- boolean finished = true;
- final Collection<ContextMutation> openMutations = phaseMutation.get(phase);
- if (!openMutations.isEmpty()) {
- final Iterator<ContextMutation> it = openMutations.iterator();
- while (it.hasNext()) {
- final ContextMutation current = it.next();
- if (current.isFinished()) {
- it.remove();
- } else {
- finished = false;
- }
- }
+ /**
+ * Return a stream of inferred statements which can be built into an {@link EffectiveStatement}, as per
+ * {@link StmtContext#buildEffective()} contract.
+ *
+ * @return Stream of supported effective statements.
+ */
+ // FIXME: this method is currently a misnomer, but unifying with streamDeclared() would make this accurate again
+ abstract Stream<? extends @NonNull StmtContext<?, ?, ?>> streamEffective();
- if (openMutations.isEmpty()) {
- phaseMutation.removeAll(phase);
- if (phaseMutation.isEmpty()) {
- phaseMutation = ImmutableMultimap.of();
- }
- }
+ @Override
+ final boolean doTryToCompletePhase(final ModelProcessingPhase phase) {
+ final boolean finished = phaseMutation.isEmpty() ? true : runMutations(phase);
+ if (completeChildren(phase) && finished) {
+ onPhaseCompleted(phase);
+ return true;
}
+ return false;
+ }
- for (final StatementContextBase<?, ?, ?> child : substatements.values()) {
+ private boolean completeChildren(final ModelProcessingPhase phase) {
+ boolean finished = true;
+ for (final StatementContextBase<?, ?, ?> child : mutableDeclaredSubstatements()) {
+ finished &= child.tryToCompletePhase(phase);
+ }
+ for (final ReactorStmtCtx<?, ?, ?> child : effectiveChildrenToComplete()) {
finished &= child.tryToCompletePhase(phase);
}
- for (final Mutable<?, ?, ?> child : effective) {
- if (child instanceof StatementContextBase) {
- finished &= ((StatementContextBase<?, ?, ?>) child).tryToCompletePhase(phase);
+ return finished;
+ }
+
+ private boolean runMutations(final ModelProcessingPhase phase) {
+ final Collection<ContextMutation> openMutations = phaseMutation.get(phase);
+ return openMutations.isEmpty() ? true : runMutations(phase, openMutations);
+ }
+
+ private boolean runMutations(final ModelProcessingPhase phase, final Collection<ContextMutation> openMutations) {
+ boolean finished = true;
+ final Iterator<ContextMutation> 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;
}
/**
*/
private void onPhaseCompleted(final ModelProcessingPhase phase) {
completedPhase = phase;
+ if (phase == ModelProcessingPhase.EFFECTIVE_MODEL) {
+ summarizeSubstatementPolicy();
+ }
final Collection<OnPhaseFinished> 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.
+ *
+ * <p>
+ * 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<? extends ReactorStmtCtx<?, ?, ?>> 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<OnPhaseFinished> listeners) {
final Iterator<OnPhaseFinished> listener = listeners.iterator();
while (listener.hasNext()) {
final OnPhaseFinished next = listener.next();
* 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<A, D, E> definition() {
- return definition;
- }
-
- @Override
- protected void checkLocalNamespaceAllowed(final Class<? extends IdentifierNamespace<?, ?>> type) {
- definition().checkNamespaceAllowed(type);
+ definition.onDeclarationFinished(this, phase);
}
@Override
- protected <K, V, N extends IdentifierNamespace<K, V>> void onNamespaceElementAdded(final Class<N> type, final K key,
- final V value) {
- // definition().onNamespaceElementAdded(this, type, key, value);
+ final StatementDefinitionContext<A, D, E> definition() {
+ return definition;
}
- final <K, V, N extends IdentifierNamespace<K, V>> void onNamespaceItemAddedAction(final Class<N> type, final K key,
+ final <K, V, N extends ParserNamespace<K, V>> void onNamespaceItemAddedAction(final Class<N> type, final K key,
final OnNamespaceItemAdded listener) {
final Object potential = getFromNamespace(type, key);
if (potential != null) {
});
}
- final <K, V, N extends IdentifierNamespace<K, V>> void onNamespaceItemAddedAction(final Class<N> type,
+ final <K, V, N extends ParserNamespace<K, V>> void onNamespaceItemAddedAction(final Class<N> type,
final ModelProcessingPhase phase, final NamespaceKeyCriterion<K> criterion,
final OnNamespaceItemAdded listener) {
final Optional<Entry<K, V>> existing = getFromNamespace(type, criterion);
});
}
- final <K, V, N extends IdentifierNamespace<K, V>> void selectMatch(final Class<N> type,
+ final <K, V, N extends ParserNamespace<K, V>> void selectMatch(final Class<N> type,
final NamespaceKeyCriterion<K> criterion, final OnNamespaceItemAdded listener) {
final Optional<Entry<K, V>> optMatch = getFromNamespace(type, criterion);
checkState(optMatch.isPresent(), "Failed to find a match for criterion %s in namespace %s node %s", criterion,
listener.namespaceItemAdded(StatementContextBase.this, type, match.getKey(), match.getValue());
}
- final <K, V, N extends IdentifierNamespace<K, V>> void waitForPhase(final Object value, final Class<N> type,
+ final <K, V, N extends ParserNamespace<K, V>> void waitForPhase(final Object value, final Class<N> type,
final ModelProcessingPhase phase, final NamespaceKeyCriterion<K> criterion,
final OnNamespaceItemAdded listener) {
((StatementContextBase<?, ? ,?>) value).addPhaseCompletedListener(phase,
});
}
- private <K, V, N extends IdentifierNamespace<K, V>> NamespaceBehaviourWithListeners<K, V, N> getBehaviour(
+ private <K, V, N extends ParserNamespace<K, V>> NamespaceBehaviourWithListeners<K, V, N> getBehaviour(
final Class<N> type) {
final NamespaceBehaviour<K, V, N> behaviour = getBehaviourRegistry().getNamespaceBehaviour(type);
checkArgument(behaviour instanceof NamespaceBehaviourWithListeners, "Namespace %s does not support listeners",
return (NamespaceBehaviourWithListeners<K, V, N>) 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 <T> Multimap<ModelProcessingPhase, T> newMultimap() {
return Multimaps.newListMultimap(new EnumMap<>(ModelProcessingPhase.class), () -> new ArrayList<>(1));
}
* @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;
while (finishedPhase != null) {
/**
* 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();
}
phaseMutation.put(phase, mutation);
}
+ final void removeMutation(final ModelProcessingPhase phase, final ContextMutation mutation) {
+ if (!phaseMutation.isEmpty()) {
+ phaseMutation.remove(phase, mutation);
+ cleanupPhaseMutation();
+ }
+ }
+
@Override
- public <K, KT extends K, N extends StatementNamespace<K, ?, ?>> void addContext(final Class<N> namespace,
+ public <K, KT extends K, N extends StatementNamespace<K, ?, ?>> void addContext(final Class<@NonNull N> namespace,
final KT key,final StmtContext<?, ?, ?> stmt) {
addContextToNamespace(namespace, key, stmt);
}
@Override
- public <X, Y extends DeclaredStatement<X>, Z extends EffectiveStatement<X, Y>> Mutable<X, Y, Z> childCopyOf(
- final StmtContext<X, Y, Z> 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());
+ public Optional<? extends Mutable<?, ?, ?>> copyAsChildOf(final Mutable<?, ?, ?> parent, final CopyType type,
+ final QNameModule targetModule) {
+ checkEffectiveModelCompleted(this);
+ return Optional.ofNullable(copyAsChildOfImpl(parent, type, targetModule));
+ }
+
+ private ReactorStmtCtx<A, D, E> copyAsChildOfImpl(final Mutable<?, ?, ?> parent, final CopyType type,
+ final QNameModule targetModule) {
+ final StatementSupport<A, D, E> 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<A, D, E>) 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<A, D, E> 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;
+ }
- checkArgument(stmt instanceof SubstatementContext, "Unsupported statement %s", stmt);
+ private boolean canReuseCurrent(final ReactorStmtCtx<A, D, E> 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);
+ }
- final SubstatementContext<X, Y, Z> original = (SubstatementContext<X, Y, Z>)stmt;
+ private <X, Y extends DeclaredStatement<X>, Z extends EffectiveStatement<X, Y>> Mutable<X, Y, Z> childCopyOf(
+ final StatementContextBase<X, Y, Z> original, final CopyType type, final QNameModule targetModule) {
final Optional<StatementSupport<?, ?, ?>> implicitParent = definition.getImplicitParentFor(
- original.getPublicDefinition());
+ original.publicDefinition());
- final SubstatementContext<X, Y, Z> result;
- final SubstatementContext<X, Y, Z> copy;
+ final StatementContextBase<X, Y, Z> result;
+ final InferredStatementContext<X, Y, Z> 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) {
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();
+ final ReplicaStatementContext<A, D, E> replicaAsChildOf(final StatementContextBase<?, ?, ?> parent) {
+ return new ReplicaStatementContext<>(parent, this);
}
- @Override
- public @NonNull StatementSourceReference getSourceReference() {
- return getStatementSourceReference();
- }
-
- @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
@Beta
public final StatementContextBase<?, ?, ?> wrapWithImplicit(final StatementContextBase<?, ?, ?> original) {
final Optional<StatementSupport<?, ?, ?>> 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<Mutable<?, ?, ?>> 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<Mutable<?, ?, ?>> 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<YangStmtMapping> NOCOPY_FROM_GROUPING_SET = ImmutableSet.of(
- YangStmtMapping.DESCRIPTION,
- YangStmtMapping.REFERENCE,
- YangStmtMapping.STATUS);
- private static final ImmutableSet<YangStmtMapping> REUSED_DEF_SET = ImmutableSet.of(
- YangStmtMapping.TYPE,
- YangStmtMapping.TYPEDEF,
- YangStmtMapping.USES);
-
- 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();
- }
+ abstract StatementContextBase<A, D, E> reparent(StatementContextBase<?, ?, ?> newParent);
- 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();
}
Code Review / yangtools.git / blobdiff