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.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.model.api.stmt.ConfigStatement;
import org.opendaylight.yangtools.yang.parser.spi.meta.CopyHistory;
import org.opendaylight.yangtools.yang.parser.spi.meta.CopyType;
import org.opendaylight.yangtools.yang.parser.spi.meta.ImplicitParentAwareStatementSupport;
-import org.opendaylight.yangtools.yang.parser.spi.meta.InferenceException;
import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder;
import org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase;
import org.opendaylight.yangtools.yang.parser.spi.meta.NamespaceBehaviour;
import org.opendaylight.yangtools.yang.parser.spi.meta.NamespaceKeyCriterion;
import org.opendaylight.yangtools.yang.parser.spi.meta.StatementNamespace;
import org.opendaylight.yangtools.yang.parser.spi.meta.StatementSupport;
+import org.opendaylight.yangtools.yang.parser.spi.meta.StatementSupport.CopyPolicy;
import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
-import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
-import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
import org.opendaylight.yangtools.yang.parser.spi.source.ImplicitSubstatement;
import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
-import org.opendaylight.yangtools.yang.parser.spi.source.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);
- // Flag bit assignments
- private static final int IS_SUPPORTED_BY_FEATURES = 0x01;
- private static final int HAVE_SUPPORTED_BY_FEATURES = 0x02;
- private static final int IS_CONFIGURATION = 0x04;
- private static final int HAVE_CONFIGURATION = 0x08;
- private static final int IS_IGNORE_CONFIG = 0x10;
- private static final int HAVE_IGNORE_CONFIG = 0x20;
- private static final int IS_IGNORE_IF_FEATURE = 0x40;
- private static final int HAVE_IGNORE_IF_FEATURE = 0x80;
-
- // Have-and-set flag constants, also used as masks
- private static final int SET_SUPPORTED_BY_FEATURES = HAVE_SUPPORTED_BY_FEATURES | IS_SUPPORTED_BY_FEATURES;
- private static final int SET_CONFIGURATION = HAVE_CONFIGURATION | IS_CONFIGURATION;
- private static final int SET_IGNORE_CONFIG = HAVE_IGNORE_CONFIG | IS_IGNORE_CONFIG;
- private static final int SET_IGNORE_IF_FEATURE = HAVE_IGNORE_IF_FEATURE | IS_IGNORE_IF_FEATURE;
-
- 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 @Nullable ModelProcessingPhase completedPhase;
- private @Nullable D declaredInstance;
- private @Nullable E effectiveInstance;
- // Common state bits
- private boolean isSupportedToBuildEffective = true;
- private boolean fullyDefined;
-
- // Flags for use with SubstatementContext. These are hiding in the alignment shadow created by above booleans and
- // hence improve memory layout.
- private byte flags;
+ // 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
}
@Override
- public boolean isSupportedByFeatures() {
- final int fl = flags & SET_SUPPORTED_BY_FEATURES;
- if (fl != 0) {
- return fl == SET_SUPPORTED_BY_FEATURES;
- }
- if (isIgnoringIfFeatures()) {
- flags |= SET_SUPPORTED_BY_FEATURES;
- return true;
- }
-
- /*
- * If parent is supported, we need to check if-features statements of this context.
- */
- if (isParentSupportedByFeatures()) {
- // If the set of supported features has not been provided, all features are supported by default.
- final Set<QName> supportedFeatures = getFromNamespace(SupportedFeaturesNamespace.class,
- SupportedFeatures.SUPPORTED_FEATURES);
- if (supportedFeatures == null || StmtContextUtils.checkFeatureSupport(this, supportedFeatures)) {
- flags |= SET_SUPPORTED_BY_FEATURES;
- return true;
- }
- }
-
- // Either parent is not supported or this statement is not supported
- flags |= HAVE_SUPPORTED_BY_FEATURES;
- return false;
- }
-
- protected abstract boolean isParentSupportedByFeatures();
-
- @Override
- public boolean isSupportedToBuildEffective() {
- return isSupportedToBuildEffective;
- }
-
- @Override
- public void setIsSupportedToBuildEffective(final boolean isSupportedToBuildEffective) {
- this.isSupportedToBuildEffective = isSupportedToBuildEffective;
- }
-
- @Override
- public CopyHistory getCopyHistory() {
+ 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();
-
- @Override
- public StatementSource getStatementSource() {
- return statementDeclSource.getStatementSource();
+ public final <K, V, T extends K, U extends V, N extends IdentifierNamespace<K, V>> void addToNs(
+ final Class<@NonNull N> type, final T key, final U value) {
+ addToNamespace(type, key, value);
}
- @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();
- }
-
- @Override
- public Collection<? extends Mutable<?, ?, ?>> mutableDeclaredSubstatements() {
- return substatements.values();
- }
+ public abstract void removeStatementFromEffectiveSubstatements(StatementDefinition statementDef);
- @Override
- public Collection<? extends StmtContext<?, ?, ?>> effectiveSubstatements() {
- return mutableEffectiveSubstatements();
- }
-
- @Override
- public Collection<? extends Mutable<?, ?, ?>> mutableEffectiveSubstatements() {
- if (effective instanceof ImmutableCollection) {
- return effective;
- }
-
- return Collections.unmodifiableCollection(effective);
- }
-
- private void shrinkEffective() {
+ static final List<ReactorStmtCtx<?, ?, ?>> removeStatementFromEffectiveSubstatements(
+ final List<ReactorStmtCtx<?, ?, ?>> effective, final StatementDefinition statementDef) {
if (effective.isEmpty()) {
- effective = ImmutableList.of();
- }
- }
-
- public void removeStatementFromEffectiveSubstatements(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 StatementContextBase<?, ?, ?>> casted =
+ (Collection<? extends StatementContextBase<?, ?, ?>>) statements;
+ final ModelProcessingPhase phase = completedPhase;
+ if (phase != null) {
+ for (StatementContextBase<?, ?, ?> 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);
+ // 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);
}
- public void appendImplicitStatement(final StatementSupport<?, ?, ?> statementToAdd) {
- createSubstatement(substatements.capacity(), new StatementDefinitionContext<>(statementToAdd),
- ImplicitSubstatement.of(getStatementSourceReference()), null);
+ private static void verifyStatement(final Mutable<?, ?, ?> stmt) {
+ verify(stmt instanceof ReactorStmtCtx, "Unexpected statement %s", stmt);
}
- /**
- * 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 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 setFullyDefined() {
- this.fullyDefined = true;
- }
+ 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 resizeSubstatements(final int expectedSize) {
- substatements = substatements.ensureCapacity(expectedSize);
+ return effective.isEmpty() ? new ArrayList<>(toAdd) : effective;
}
- final void walkChildren(final ModelProcessingPhase phase) {
- checkState(fullyDefined);
- substatements.values().forEach(stmt -> {
- stmt.walkChildren(phase);
- stmt.endDeclared(phase);
- });
+ // Exposed for ReplicaStatementContext
+ @Override
+ E createEffective() {
+ return definition.getFactory().createEffective(this, streamDeclared(), streamEffective());
}
+ abstract Stream<? extends StmtContext<?, ?, ?>> streamDeclared();
+
+ abstract Stream<? extends StmtContext<?, ?, ?>> streamEffective();
+
@Override
- public D buildDeclared() {
- checkArgument(completedPhase == ModelProcessingPhase.FULL_DECLARATION
- || completedPhase == ModelProcessingPhase.EFFECTIVE_MODEL);
- if (declaredInstance == null) {
- declaredInstance = definition().getFactory().createDeclared(this);
+ final boolean doTryToCompletePhase(final ModelProcessingPhase phase) {
+ final boolean finished = phaseMutation.isEmpty() ? true : runMutations(phase);
+ if (completeChildren(phase) && finished) {
+ onPhaseCompleted(phase);
+ return true;
}
- return declaredInstance;
+ return false;
}
- @Override
- public E buildEffective() {
- if (effectiveInstance == null) {
- effectiveInstance = definition().getFactory().createEffective(this);
+ private boolean completeChildren(final ModelProcessingPhase phase) {
+ boolean finished = true;
+ for (final StatementContextBase<?, ?, ?> child : mutableDeclaredSubstatements()) {
+ finished &= child.tryToCompletePhase(phase);
}
- return effectiveInstance;
+ for (final ReactorStmtCtx<?, ?, ?> child : effectiveChildrenToComplete()) {
+ finished &= child.tryToCompletePhase(phase);
+ }
+ return finished;
}
- /**
- * tries to execute current {@link ModelProcessingPhase} of source parsing.
- *
- * @param phase
- * to be executed (completed)
- * @return if phase was successfully completed
- * @throws SourceException
- * when an error occurred in source parsing
- */
- boolean tryToCompletePhase(final ModelProcessingPhase phase) {
-
- boolean finished = true;
+ private boolean runMutations(final ModelProcessingPhase phase) {
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 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<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;
}
}
- 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;
}
/**
completedPhase = phase;
final Collection<OnPhaseFinished> listeners = phaseListeners.get(phase);
- if (listeners.isEmpty()) {
- return;
+ if (!listeners.isEmpty()) {
+ runPhaseListeners(phase, listeners);
}
+ }
+ 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;
+ definition.onDeclarationFinished(this, phase);
}
@Override
- protected void checkLocalNamespaceAllowed(final Class<? extends IdentifierNamespace<?, ?>> type) {
- definition().checkNamespaceAllowed(type);
- }
-
- @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,
return (NamespaceBehaviourWithListeners<K, V, N>) behaviour;
}
- @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());
+ checkNotNull(phase, "Statement context processing phase cannot be null at: %s", sourceReference());
+ checkNotNull(listener, "Statement context phase listener cannot be null at: %s", sourceReference());
ModelProcessingPhase finishedPhase = completedPhase;
while (finishedPhase != null) {
/**
* 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 Optional<? extends Mutable<?, ?, ?>> copyAsChildOf(final Mutable<?, ?, ?> parent, final CopyType type,
+ final QNameModule targetModule) {
+ checkEffectiveModelCompleted(this);
+
+ final StatementSupport<A, D, E> support = definition.support();
+ final CopyPolicy policy = support.applyCopyPolicy(this, parent, type, targetModule);
+ switch (policy) {
+ case CONTEXT_INDEPENDENT:
+ if (hasEmptySubstatements()) {
+ // This statement is context-independent and has no substatements -- hence it can be freely shared.
+ return Optional.of(replicaAsChildOf(parent));
+ }
+ // ascertaining substatements could be quite costly, let's just fall through to declared copy and deal
+ // shortcut it when we build the statements.
+ // fall through
+ case DECLARED_COPY:
+ // FIXME: YANGTOOLS-694: this is still to eager, we really want to copy as a lazily-instantiated
+ // context, so that we can support building an effective statement without copying
+ // anything -- we will typically end up not being inferred against. In that case,
+ // this slim context should end up dealing with differences at buildContext()
+ // time. This is a YANGTOOLS-1067 prerequisite (which will deal with what can and
+ // cannot be shared across instances).
+ return Optional.of(parent.childCopyOf(this, type, targetModule));
+ case IGNORE:
+ return Optional.empty();
+ case REJECT:
+ throw new IllegalStateException("Statement " + support.getPublicView() + " should never be copied");
+ default:
+ throw new IllegalStateException("Unhandled policy " + policy);
+ }
+ }
+
@Override
public final Mutable<?, ?, ?> childCopyOf(final StmtContext<?, ?, ?> stmt, final CopyType type,
final QNameModule targetModule) {
- checkState(stmt.getCompletedPhase() == ModelProcessingPhase.EFFECTIVE_MODEL,
- "Attempted to copy statement %s which has completed phase %s", stmt, stmt.getCompletedPhase());
- checkArgument(stmt instanceof SubstatementContext, "Unsupported statement %s", stmt);
- return childCopyOf((SubstatementContext<?, ?, ?>) stmt, type, targetModule);
+ checkEffectiveModelCompleted(stmt);
+ checkArgument(stmt instanceof StatementContextBase, "Unsupported statement %s", stmt);
+ return childCopyOf((StatementContextBase<?, ?, ?>) stmt, type, targetModule);
}
private <X, Y extends DeclaredStatement<X>, Z extends EffectiveStatement<X, Y>> Mutable<X, Y, Z> childCopyOf(
- final SubstatementContext<X, Y, Z> original, final CopyType type, final QNameModule targetModule) {
+ 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);
} else {
- result = copy = new SubstatementContext<>(original, this, type, targetModule);
+ result = copy = new InferredStatementContext<>(this, original, type, type, targetModule);
}
- original.definition().onStatementAdded(copy);
- original.copyTo(copy, type, targetModule);
+ original.definition.onStatementAdded(copy);
return result;
}
@Override
- public @NonNull StatementDefinition getDefinition() {
- return getPublicDefinition();
+ public final ReactorStmtCtx<A, D, E> replicaAsChildOf(final Mutable<?, ?, ?> parent) {
+ checkArgument(parent instanceof StatementContextBase, "Unsupported parent %s", parent);
+ return replicaAsChildOf((StatementContextBase<?, ?, ?>) parent);
}
- @Override
- public @NonNull StatementSourceReference getSourceReference() {
- return getStatementSourceReference();
+ final @NonNull ReplicaStatementContext<A, D, E> replicaAsChildOf(final StatementContextBase<?, ?, ?> stmt) {
+ return new ReplicaStatementContext<>(stmt, 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
@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;
}
- /**
- * Config statements are not all that common which means we are performing a recursive search towards the root
- * every time {@link #isConfiguration()} is invoked. This is quite expensive because it causes a linear search
- * for the (usually non-existent) config statement.
- *
- * <p>
- * This method maintains a resolution cache, so once we have returned a result, we will keep on returning the same
- * result without performing any lookups, solely to support {@link SubstatementContext#isConfiguration()}.
- */
- final boolean isConfiguration(final StatementContextBase<?, ?, ?> parent) {
- if (isIgnoringConfig()) {
- return true;
- }
- final int fl = flags & SET_CONFIGURATION;
- if (fl != 0) {
- return fl == SET_CONFIGURATION;
- }
- final StmtContext<Boolean, ?, ?> configStatement = StmtContextUtils.findFirstSubstatement(this,
- ConfigStatement.class);
- final boolean parentIsConfig = parent.isConfiguration();
-
- final boolean isConfig;
- if (configStatement != null) {
- isConfig = configStatement.coerceStatementArgument();
-
- // Validity check: if parent is config=false this cannot be a config=true
- InferenceException.throwIf(isConfig && !parentIsConfig, getStatementSourceReference(),
- "Parent node has config=false, this node must not be specifed as config=true");
- } else {
- // If "config" statement is not specified, the default is the same as the parent's "config" value.
- isConfig = parentIsConfig;
- }
-
- // Resolved, make sure we cache this return
- flags |= isConfig ? SET_CONFIGURATION : HAVE_CONFIGURATION;
- return isConfig;
- }
-
- protected abstract boolean isIgnoringConfig();
-
- /**
- * This method maintains a resolution cache for ignore config, so once we have returned a result, we will
- * keep on returning the same result without performing any lookups. Exists only to support
- * {@link SubstatementContext#isIgnoringConfig()}.
- */
- final boolean isIgnoringConfig(final StatementContextBase<?, ?, ?> parent) {
- final int fl = flags & SET_IGNORE_CONFIG;
- if (fl != 0) {
- return fl == SET_IGNORE_CONFIG;
- }
- if (definition().isIgnoringConfig() || parent.isIgnoringConfig()) {
- flags |= SET_IGNORE_CONFIG;
- return true;
- }
-
- flags |= HAVE_IGNORE_CONFIG;
- return false;
- }
-
- protected abstract boolean isIgnoringIfFeatures();
+ abstract StatementContextBase<A, D, E> reparent(StatementContextBase<?, ?, ?> newParent);
/**
- * This method maintains a resolution cache for ignore if-feature, so once we have returned a result, we will
- * keep on returning the same result without performing any lookups. Exists only to support
- * {@link SubstatementContext#isIgnoringIfFeatures()}.
+ * 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.
*/
- final boolean isIgnoringIfFeatures(final StatementContextBase<?, ?, ?> parent) {
- final int fl = flags & SET_IGNORE_IF_FEATURE;
- if (fl != 0) {
- return fl == SET_IGNORE_IF_FEATURE;
- }
- if (definition().isIgnoringIfFeatures() || parent.isIgnoringIfFeatures()) {
- flags |= SET_IGNORE_IF_FEATURE;
- return true;
- }
-
- flags |= HAVE_IGNORE_IF_FEATURE;
- return false;
- }
-
- 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();
- }
-
- protected ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) {
- return toStringHelper.add("definition", definition).add("rawArgument", rawArgument);
- }
+ abstract boolean hasEmptySubstatements();
}