> declaredSubstatements() {
- return Collections.unmodifiableCollection(declared);
+ public Collection extends StmtContext, ?, ?>> effectiveSubstatements() {
+ return mutableEffectiveSubstatements();
}
+ @Nonnull
@Override
- public Collection> effectiveSubstatements() {
+ public Collection extends Mutable, ?, ?>> mutableEffectiveSubstatements() {
+ if (effective instanceof ImmutableCollection) {
+ return effective;
+ }
+
return Collections.unmodifiableCollection(effective);
}
- public void addEffectiveSubstatement(StatementContextBase, ?, ?> substatement){
- effective.add(substatement);
+ public void removeStatementsFromEffectiveSubstatements(
+ final Collection extends StmtContext, ?, ?>> substatements) {
+ if (!effective.isEmpty()) {
+ effective.removeAll(substatements);
+ shrinkEffective();
+ }
}
- public void addDeclaredSubstatement(StatementContextBase, ?, ?> substatement){
- declared.add(substatement);
+ private void shrinkEffective() {
+ if (effective.isEmpty()) {
+ effective = ImmutableList.of();
+ }
}
- @SuppressWarnings({ "rawtypes", "unchecked" })
- public ContextBuilder, ?, ?> substatementBuilder(StatementDefinitionContext, ?, ?> def,
- StatementSourceReference ref) {
- return new ContextBuilder(def, ref) {
+ public void removeStatementFromEffectiveSubstatements(final StatementDefinition statementDef) {
+ if (effective.isEmpty()) {
+ return;
+ }
- @Override
- public StatementContextBase build() throws SourceException {
- StatementContextBase, ?, ?> potential = substatements.get(getIdentifier());
- if(potential == null) {
- potential = new SubstatementContext(StatementContextBase.this, this);
- substatements.put(getIdentifier(), potential);
- }
- potential.resetLists();
- switch (this.getStamementSource().getStatementSource()) {
- case DECLARATION:
- declared.add(potential);
- break;
- case CONTEXT:
- effective.add(potential);
- break;
- }
- return potential;
+ final Iterator extends StmtContext, ?, ?>> iterator = effective.iterator();
+ while (iterator.hasNext()) {
+ final StmtContext, ?, ?> next = iterator.next();
+ if (statementDef.equals(next.getPublicDefinition())) {
+ iterator.remove();
+ }
+ }
+
+ shrinkEffective();
+ }
+
+ /**
+ * Removes a statement context from the effective substatements based on its statement definition (i.e statement
+ * keyword) and raw (in String form) statement argument. The statement context is removed only if both statement
+ * definition and statement argument match with one of the effective substatements' statement definition
+ * and argument.
+ *
+ *
+ * If the statementArg parameter is null, the statement context is removed based only on its statement definition.
+ *
+ * @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,
+ final String statementArg) {
+ if (statementArg == null) {
+ removeStatementFromEffectiveSubstatements(statementDef);
+ }
+
+ if (effective.isEmpty()) {
+ return;
+ }
+
+ final Iterator> iterator = effective.iterator();
+ while (iterator.hasNext()) {
+ final Mutable, ?, ?> next = iterator.next();
+ if (statementDef.equals(next.getPublicDefinition()) && statementArg.equals(next.rawStatementArgument())) {
+ iterator.remove();
}
- };
+ }
+
+ shrinkEffective();
}
+ /**
+ * 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
+ */
+ public void addEffectiveSubstatement(final Mutable, ?, ?> substatement) {
+ beforeAddEffectiveStatement(1);
+ effective.add(substatement);
+ }
+ /**
+ * Adds an effective statement to collection of substatements.
+ *
+ * @param substatements substatements
+ * @throws IllegalStateException
+ * if added in declared phase
+ * @throws NullPointerException
+ * if statement parameter is null
+ */
+ public void addEffectiveSubstatements(final Collection extends Mutable, ?, ?>> substatements) {
+ if (substatements.isEmpty()) {
+ return;
+ }
- @Override
- public StorageNodeType getStorageNodeType() {
- return StorageNodeType.STATEMENT_LOCAL;
+ substatements.forEach(Preconditions::checkNotNull);
+ beforeAddEffectiveStatement(substatements.size());
+ effective.addAll(substatements);
+ }
+
+ private void beforeAddEffectiveStatement(final int toAdd) {
+ final ModelProcessingPhase inProgressPhase = getRoot().getSourceContext().getInProgressPhase();
+ Preconditions.checkState(inProgressPhase == ModelProcessingPhase.FULL_DECLARATION
+ || inProgressPhase == ModelProcessingPhase.EFFECTIVE_MODEL,
+ "Effective statement cannot be added in declared phase at: %s", getStatementSourceReference());
+
+ if (effective.isEmpty()) {
+ effective = new ArrayList<>(toAdd);
+ }
+ }
+
+ /**
+ * Create a new substatement at the specified offset.
+ *
+ * @param offset Substatement offset
+ * @param def definition context
+ * @param ref source reference
+ * @param argument statement argument
+ * @return A new substatement
+ */
+ @SuppressWarnings("checkstyle:methodTypeParameterName")
+ public final , CE extends EffectiveStatement>
+ StatementContextBase createSubstatement(final int offset,
+ final StatementDefinitionContext def, final StatementSourceReference ref,
+ final String argument) {
+ final ModelProcessingPhase inProgressPhase = getRoot().getSourceContext().getInProgressPhase();
+ Preconditions.checkState(inProgressPhase != ModelProcessingPhase.EFFECTIVE_MODEL,
+ "Declared statement cannot be added in effective phase at: %s", getStatementSourceReference());
+
+ 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;
+ }
+
+ 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);
+ }
+
+ /**
+ * 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);
}
@Override
public D buildDeclared() {
- Preconditions.checkArgument(completedPhase == ModelProcessingPhase.FULL_DECLARATION || completedPhase == ModelProcessingPhase.EFFECTIVE_MODEL);
+ Preconditions.checkArgument(completedPhase == ModelProcessingPhase.FULL_DECLARATION
+ || completedPhase == ModelProcessingPhase.EFFECTIVE_MODEL);
if (declaredInstance == null) {
declaredInstance = definition().getFactory().createDeclared(this);
}
@@ -219,139 +454,291 @@ public abstract class StatementContextBase, E
@Override
public E buildEffective() {
- Preconditions.checkArgument(completedPhase == ModelProcessingPhase.EFFECTIVE_MODEL);
if (effectiveInstance == null) {
effectiveInstance = definition().getFactory().createEffective(this);
}
return effectiveInstance;
}
+ /**
+ * 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 occured in source parsing
+ */
+ boolean tryToCompletePhase(final ModelProcessingPhase phase) {
- void resetLists() {
- declared.clear();
- }
-
- boolean tryToCompletePhase(ModelProcessingPhase phase) throws SourceException {
- if(phase.equals(completedPhase)) {
- return true;
- }
- Iterator openMutations = phaseMutation.get(phase).iterator();
boolean finished = true;
- while(openMutations.hasNext()) {
- ContextMutation current = openMutations.next();
- if(current.isFinished()) {
- openMutations.remove();
- } else {
- finished = false;
+ 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;
+ }
+ }
+
+ if (openMutations.isEmpty()) {
+ phaseMutation.removeAll(phase);
+ if (phaseMutation.isEmpty()) {
+ phaseMutation = ImmutableMultimap.of();
+ }
}
}
- for(StatementContextBase, ?, ?> child: declared) {
+
+ for (final StatementContextBase, ?, ?> child : substatements.values()) {
finished &= child.tryToCompletePhase(phase);
}
- for(StatementContextBase, ?, ?> child: effective) {
- finished &= child.tryToCompletePhase(phase);
+ for (final Mutable, ?, ?> child : effective) {
+ if (child instanceof StatementContextBase) {
+ finished &= ((StatementContextBase, ?, ?>) child).tryToCompletePhase(phase);
+ }
}
- if(finished) {
+
+ if (finished) {
onPhaseCompleted(phase);
return true;
}
return false;
}
-
- private void onPhaseCompleted(ModelProcessingPhase phase) throws SourceException {
+ /**
+ * Occurs on end of {@link ModelProcessingPhase} of 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;
- Iterator listener = phaseListeners.get(completedPhase).iterator();
- while(listener.hasNext()) {
- listener.next().phaseFinished(this, phase);
- listener.remove();
+
+ final Collection listeners = phaseListeners.get(phase);
+ if (listeners.isEmpty()) {
+ return;
+ }
+
+ final Iterator listener = listeners.iterator();
+ while (listener.hasNext()) {
+ final OnPhaseFinished next = listener.next();
+ if (next.phaseFinished(this, phase)) {
+ listener.remove();
+ }
+ }
+
+ if (listeners.isEmpty()) {
+ phaseListeners.removeAll(phase);
+ if (phaseListeners.isEmpty()) {
+ phaseListeners = ImmutableMultimap.of();
+ }
}
}
/**
- *
* Ends declared section of current node.
- *
- * @param ref
- * @throws SourceException
- *
*/
- void endDeclared(StatementSourceReference ref,ModelProcessingPhase phase) throws SourceException {
- definition().onDeclarationFinished(this,phase);
+ void endDeclared(final StatementSourceReference ref, final ModelProcessingPhase phase) {
+ definition().onDeclarationFinished(this, phase);
}
+ /**
+ * Return the context in which this statement was defined.
+ *
+ * @return statement definition
+ */
protected final StatementDefinitionContext definition() {
return definition;
}
@Override
- protected void checkLocalNamespaceAllowed(Class extends IdentifierNamespace, ?>> type) {
+ protected void checkLocalNamespaceAllowed(final Class extends IdentifierNamespace, ?>> type) {
definition().checkNamespaceAllowed(type);
}
@Override
- protected > void onNamespaceElementAdded(Class type, K key, V value) {
- //definition().onNamespaceElementAdded(this, type, key, value);
+ protected > void onNamespaceElementAdded(final Class type, final K key,
+ final V value) {
+ // definition().onNamespaceElementAdded(this, type, key, value);
}
- > void onNamespaceItemAddedAction(final Class type, K key, final OnNamespaceItemAdded listener) throws SourceException {
- Object potential = getFromNamespace(type, key);
- if(potential != null) {
+ > void onNamespaceItemAddedAction(final Class type, final K key,
+ final OnNamespaceItemAdded listener) throws SourceException {
+ final Object potential = getFromNamespace(type, key);
+ if (potential != null) {
+ LOG.trace("Listener on {} key {} satisfied immediately", type, key);
listener.namespaceItemAdded(this, type, key, potential);
return;
}
- NamespaceBehaviour behaviour = getBehaviourRegistry().getNamespaceBehaviour(type);
- if(behaviour instanceof NamespaceBehaviourWithListeners) {
- NamespaceBehaviourWithListeners casted = (NamespaceBehaviourWithListeners) behaviour;
- casted.addValueListener(key, new ValueAddedListener(this) {
- @Override
- void onValueAdded(Object key, Object value) {
- try {
- listener.namespaceItemAdded(StatementContextBase.this, type, key, value);
- } catch (SourceException e) {
- throw Throwables.propagate(e);
- }
- }
- });
- }
+
+ final NamespaceBehaviour behaviour = getBehaviourRegistry().getNamespaceBehaviour(type);
+ Preconditions.checkArgument(behaviour instanceof NamespaceBehaviourWithListeners,
+ "Namespace %s does not support listeners", type);
+
+ final NamespaceBehaviourWithListeners casted = (NamespaceBehaviourWithListeners) behaviour;
+ casted.addValueListener(new ValueAddedListener(this, key) {
+ @Override
+ void onValueAdded(final Object key, final Object value) {
+ listener.namespaceItemAdded(StatementContextBase.this, type, key, value);
+ }
+ });
}
+ /**
+ * See {@link StatementSupport#getPublicView()}.
+ */
+ @Nonnull
@Override
public StatementDefinition getPublicDefinition() {
return definition().getPublicView();
}
@Override
- public ModelActionBuilder newInferenceAction(ModelProcessingPhase phase) {
+ public ModelActionBuilder newInferenceAction(final ModelProcessingPhase phase) {
return getRoot().getSourceContext().newInferenceAction(phase);
}
- void addPhaseCompletedListener(ModelProcessingPhase phase, OnPhaseFinished listener) throws SourceException {
+ private static Multimap newMultimap() {
+ return Multimaps.newListMultimap(new EnumMap<>(ModelProcessingPhase.class), () -> new ArrayList<>(1));
+ }
+
+ /**
+ * Adds {@link OnPhaseFinished} listener for a {@link ModelProcessingPhase} end.
+ */
+ void addPhaseCompletedListener(final ModelProcessingPhase phase, final OnPhaseFinished listener) {
+ Preconditions.checkNotNull(phase, "Statement context processing phase cannot be null at: %s",
+ getStatementSourceReference());
+ Preconditions.checkNotNull(listener, "Statement context phase listener cannot be null at: %s",
+ getStatementSourceReference());
+
ModelProcessingPhase finishedPhase = completedPhase;
while (finishedPhase != null) {
- if(phase.equals(finishedPhase)) {
+ if (phase.equals(finishedPhase)) {
listener.phaseFinished(this, finishedPhase);
return;
}
finishedPhase = finishedPhase.getPreviousPhase();
}
+ if (phaseListeners.isEmpty()) {
+ phaseListeners = newMultimap();
+ }
+
phaseListeners.put(phase, listener);
}
- void addMutation(ModelProcessingPhase phase, ContextMutation mutation) {
+ /**
+ * Adds a {@link ContextMutation} to a {@link ModelProcessingPhase}.
+ *
+ * @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) {
- if(phase.equals(finishedPhase)) {
- throw new IllegalStateException("Mutation registered after phase was completed.");
- }
+ Preconditions.checkState(!phase.equals(finishedPhase),
+ "Mutation registered after phase was completed at: %s", getStatementSourceReference());
finishedPhase = finishedPhase.getPreviousPhase();
}
+
+ if (phaseMutation.isEmpty()) {
+ phaseMutation = newMultimap();
+ }
phaseMutation.put(phase, mutation);
}
@Override
- public > void addContext(
- Class namespace, KT key, StmtContext, ?, ?> stmt) {
- addContextToNamespace(namespace,(K) key, stmt);
+ public > void addContext(final Class namespace,
+ final KT key,final StmtContext, ?, ?> stmt) {
+ addContextToNamespace(namespace, key, stmt);
+ }
+
+ @Override
+ public , Z extends EffectiveStatement> Mutable childCopyOf(
+ final StmtContext stmt, final CopyType type, final QNameModule targetModule) {
+ Preconditions.checkState(stmt.getCompletedPhase() == ModelProcessingPhase.EFFECTIVE_MODEL,
+ "Attempted to copy statement %s which has completed phase %s", stmt, stmt.getCompletedPhase());
+
+ Preconditions.checkArgument(stmt instanceof SubstatementContext, "Unsupported statement %s", stmt);
+
+ final SubstatementContext original = (SubstatementContext)stmt;
+ final SubstatementContext copy = new SubstatementContext<>(original, this, type, targetModule);
+
+ original.definition().onStatementAdded(copy);
+ original.copyTo(copy, type, targetModule);
+
+ return copy;
+ }
+
+ 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 Set NOCOPY_FROM_GROUPING_SET = ImmutableSet.of(
+ YangStmtMapping.DESCRIPTION,
+ YangStmtMapping.REFERENCE,
+ YangStmtMapping.STATUS);
+ private static final Set 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.getParentContext().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);
}
}