*/
package org.opendaylight.yangtools.yang.parser.rfc7950.stmt.uses;
-import com.google.common.base.Verify;
+import static com.google.common.base.Verify.verify;
+import static com.google.common.base.Verify.verifyNotNull;
+
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
import java.util.Map;
import java.util.Optional;
import org.eclipse.jdt.annotation.NonNull;
+import org.opendaylight.yangtools.yang.common.Empty;
import org.opendaylight.yangtools.yang.common.QName;
import org.opendaylight.yangtools.yang.common.QNameModule;
import org.opendaylight.yangtools.yang.common.YangVersion;
import org.opendaylight.yangtools.yang.model.api.GroupingDefinition;
import org.opendaylight.yangtools.yang.model.api.SchemaNode;
import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
+import org.opendaylight.yangtools.yang.model.api.meta.DeclarationReference;
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.StatementDefinition;
import org.opendaylight.yangtools.yang.model.api.stmt.SchemaTreeEffectiveStatement;
import org.opendaylight.yangtools.yang.model.api.stmt.UsesEffectiveStatement;
import org.opendaylight.yangtools.yang.model.api.stmt.UsesStatement;
+import org.opendaylight.yangtools.yang.model.parser.api.YangParserConfiguration;
+import org.opendaylight.yangtools.yang.model.ri.stmt.DeclaredStatementDecorators;
+import org.opendaylight.yangtools.yang.model.ri.stmt.DeclaredStatements;
+import org.opendaylight.yangtools.yang.model.spi.meta.EffectiveStatementMixins;
import org.opendaylight.yangtools.yang.parser.rfc7950.reactor.YangValidationBundles;
-import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.BaseQNameStatementSupport;
import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.refine.RefineEffectiveStatementImpl;
+import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.refine.RefineTargetNamespace;
import org.opendaylight.yangtools.yang.parser.spi.GroupingNamespace;
import org.opendaylight.yangtools.yang.parser.spi.SchemaTreeNamespace;
+import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractQNameStatementSupport;
import org.opendaylight.yangtools.yang.parser.spi.meta.CopyType;
+import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
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.ModelActionBuilder.InferenceAction;
import org.slf4j.LoggerFactory;
public final class UsesStatementSupport
- extends BaseQNameStatementSupport<UsesStatement, UsesEffectiveStatement> {
+ extends AbstractQNameStatementSupport<UsesStatement, UsesEffectiveStatement> {
private static final Logger LOG = LoggerFactory.getLogger(UsesStatementSupport.class);
private static final SubstatementValidator SUBSTATEMENT_VALIDATOR = SubstatementValidator.builder(YangStmtMapping
.USES)
.addOptional(YangStmtMapping.STATUS)
.addOptional(YangStmtMapping.WHEN)
.build();
- private static final UsesStatementSupport INSTANCE = new UsesStatementSupport();
-
- private UsesStatementSupport() {
- super(YangStmtMapping.USES);
- }
- public static UsesStatementSupport getInstance() {
- return INSTANCE;
+ public UsesStatementSupport(final YangParserConfiguration config) {
+ super(YangStmtMapping.USES, StatementPolicy.exactReplica(), config);
}
@Override
super.onFullDefinitionDeclared(usesNode);
final ModelActionBuilder usesAction = usesNode.newInferenceAction(ModelProcessingPhase.EFFECTIVE_MODEL);
- final QName groupingName = usesNode.getStatementArgument();
+ final QName groupingName = usesNode.argument();
final Prerequisite<StmtContext<?, ?, ?>> sourceGroupingPre = usesAction.requiresCtx(usesNode,
GroupingNamespace.class, groupingName, ModelProcessingPhase.EFFECTIVE_MODEL);
copyFromSourceToTarget(sourceGrpStmtCtx, targetNodeStmtCtx, usesNode);
resolveUsesNode(usesNode, targetNodeStmtCtx);
StmtContextUtils.validateIfFeatureAndWhenOnListKeys(usesNode);
+ usesNode.addToNs(SourceGroupingNamespace.class, Empty.getInstance(), sourceGrpStmtCtx);
}
@Override
public void prerequisiteFailed(final Collection<? extends Prerequisite<?>> failed) {
- InferenceException.throwIf(failed.contains(sourceGroupingPre),
- usesNode.getStatementSourceReference(), "Grouping '%s' was not resolved.", groupingName);
- throw new InferenceException("Unknown error occurred.", usesNode.getStatementSourceReference());
+ InferenceException.throwIf(failed.contains(sourceGroupingPre), usesNode,
+ "Grouping '%s' was not resolved.", groupingName);
+ throw new InferenceException("Unknown error occurred.", usesNode);
}
});
}
@Override
protected UsesStatement createDeclared(final StmtContext<QName, UsesStatement, ?> ctx,
final ImmutableList<? extends DeclaredStatement<?>> substatements) {
- return new RegularUsesStatement(ctx, substatements);
+ return DeclaredStatements.createUses(ctx.getRawArgument(), ctx.getArgument(), substatements);
}
@Override
- protected UsesStatement createEmptyDeclared(final StmtContext<QName, UsesStatement, ?> ctx) {
- return new EmptyUsesStatement(ctx);
+ protected UsesStatement attachDeclarationReference(final UsesStatement stmt, final DeclarationReference reference) {
+ return DeclaredStatementDecorators.decorateUses(stmt, reference);
}
@Override
- protected UsesEffectiveStatement createEffective(
- final StmtContext<QName, UsesStatement, UsesEffectiveStatement> ctx, final UsesStatement declared,
+ protected UsesEffectiveStatement createEffective(final Current<QName, UsesStatement> stmt,
final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
- final GroupingDefinition sourceGrouping = getSourceGrouping(ctx);
- final int flags = historyAndStatusFlags(ctx, substatements);
- final QName argument = ctx.coerceStatementArgument();
+ final EffectiveStatement<?, ?> source =
+ verifyNotNull(stmt.getFromNamespace(SourceGroupingNamespace.class, Empty.getInstance())).buildEffective();
+ verify(source instanceof GroupingDefinition, "Unexpected source %s", source);
+ final GroupingDefinition sourceGrouping = (GroupingDefinition) source;
+
+ final int flags = EffectiveStatementMixins.historyAndStatusFlags(stmt.history(), substatements);
+ final QName argument = stmt.getArgument();
+ final UsesStatement declared = stmt.declared();
+
+ if (substatements.isEmpty()) {
+ return argument.equals(declared.argument())
+ ? new EmptyLocalUsesEffectiveStatement(declared, sourceGrouping, flags)
+ : new SimpleCopiedUsesEffectiveStatement(declared, argument, sourceGrouping, flags);
+ }
+
if (declared.argument().equals(argument)) {
return new RegularLocalUsesEffectiveStatement(declared, sourceGrouping, flags, substatements);
}
return new FullCopiedUsesEffectiveStatement(declared, argument, sourceGrouping, flags, substatements);
}
- @Override
- protected UsesEffectiveStatement createEmptyEffective(
- final StmtContext<QName, UsesStatement, UsesEffectiveStatement> ctx, final UsesStatement declared) {
- final GroupingDefinition sourceGrouping = getSourceGrouping(ctx);
- final int flags = historyAndStatusFlags(ctx, ImmutableList.of());
- final QName argument = ctx.coerceStatementArgument();
- return argument.equals(declared.argument())
- ? new EmptyLocalUsesEffectiveStatement(declared, sourceGrouping, flags)
- : new SimpleCopiedUsesEffectiveStatement(declared, argument, sourceGrouping, flags);
- }
-
static @NonNull ImmutableMap<Descendant, SchemaNode> indexRefines(
final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
final Map<Descendant, SchemaNode> refines = new LinkedHashMap<>();
return ImmutableMap.copyOf(refines);
}
- private static GroupingDefinition getSourceGrouping(final StmtContext<QName, ?, ?> ctx) {
- return (GroupingDefinition) ctx.getFromNamespace(GroupingNamespace.class, ctx.coerceStatementArgument())
- .buildEffective();
- }
-
/**
* Copy statements from a grouping to a target node.
*
// This means that the statement that is about to be copied (and can be subjected to buildEffective() I think)
// is actually a SchemaTreeEffectiveStatement
if (SchemaTreeEffectiveStatement.class.isAssignableFrom(
- stmt.getPublicDefinition().getEffectiveRepresentationClass())) {
+ stmt.publicDefinition().getEffectiveRepresentationClass())) {
return true;
}
if (targetCtx.getParentContext() == null) {
return targetCtx.getFromNamespace(ModuleCtxToModuleQName.class, targetCtx);
}
- if (targetCtx.getPublicDefinition() == YangStmtMapping.AUGMENT) {
+ if (targetCtx.publicDefinition() == YangStmtMapping.AUGMENT) {
return StmtContextUtils.getRootModuleQName(targetCtx);
}
- final Object targetStmtArgument = targetCtx.getStatementArgument();
- final Object sourceStmtArgument = stmtContext.getStatementArgument();
+ final Object targetStmtArgument = targetCtx.argument();
+ final Object sourceStmtArgument = stmtContext.argument();
if (targetStmtArgument instanceof QName && sourceStmtArgument instanceof QName) {
return ((QName) targetStmtArgument).getModule();
}
/*
* In case of Yang 1.1, checks whether features are supported.
*/
- return !YangVersion.VERSION_1_1.equals(subStmtCtx.getRootVersion()) || subStmtCtx.isSupportedByFeatures();
+ return !YangVersion.VERSION_1_1.equals(subStmtCtx.yangVersion()) || subStmtCtx.isSupportedByFeatures();
}
private static void performRefine(final Mutable<?, ?, ?> subStmtCtx, final StmtContext<?, ?, ?> usesParentCtx) {
- final Object refineArgument = subStmtCtx.getStatementArgument();
- InferenceException.throwIf(!(refineArgument instanceof SchemaNodeIdentifier),
- subStmtCtx.getStatementSourceReference(),
+ final Object refineArgument = subStmtCtx.argument();
+ InferenceException.throwIf(!(refineArgument instanceof SchemaNodeIdentifier), subStmtCtx,
"Invalid refine argument %s. It must be instance of SchemaNodeIdentifier.", refineArgument);
final Optional<StmtContext<?, ?, ?>> optRefineTargetCtx = SchemaTreeNamespace.findNode(
usesParentCtx, (SchemaNodeIdentifier) refineArgument);
- InferenceException.throwIf(!optRefineTargetCtx.isPresent(), subStmtCtx.getStatementSourceReference(),
- "Refine target node %s not found.", refineArgument);
+ InferenceException.throwIf(!optRefineTargetCtx.isPresent(), subStmtCtx, "Refine target node %s not found.",
+ refineArgument);
+ // FIXME: This communicates the looked-up target node to RefineStatementSupport.buildEffective(). We should do
+ // this trick through a shared namespace or similar reactor-agnostic meeting place. It really feels like
+ // an inference action RefineStatementSupport should be doing.
final StmtContext<?, ?, ?> refineTargetNodeCtx = optRefineTargetCtx.get();
if (StmtContextUtils.isUnknownStatement(refineTargetNodeCtx)) {
LOG.trace("Refine node '{}' in uses '{}' has target node unknown statement '{}'. "
- + "Refine has been skipped. At line: {}", subStmtCtx.getStatementArgument(),
- subStmtCtx.coerceParentContext().getStatementArgument(),
- refineTargetNodeCtx.getStatementArgument(), subStmtCtx.getStatementSourceReference());
- subStmtCtx.addAsEffectOfStatement(refineTargetNodeCtx);
- return;
+ + "Refine has been skipped. At line: {}", subStmtCtx.argument(),
+ subStmtCtx.coerceParentContext().argument(), refineTargetNodeCtx.argument(),
+ subStmtCtx.sourceReference());
+ } else {
+ verify(refineTargetNodeCtx instanceof StatementContextBase);
+ addOrReplaceNodes(subStmtCtx, (StatementContextBase<?, ?, ?>) refineTargetNodeCtx);
}
- Verify.verify(refineTargetNodeCtx instanceof StatementContextBase);
- addOrReplaceNodes(subStmtCtx, (StatementContextBase<?, ?, ?>) refineTargetNodeCtx);
- subStmtCtx.addAsEffectOfStatement(refineTargetNodeCtx);
+ // Target is a prerequisite for the 'refine', hence if the target is not supported, the refine is not supported
+ // as well. Otherwise add a pointer to the target into refine's local namespace.
+ if (refineTargetNodeCtx.isSupportedToBuildEffective()) {
+ subStmtCtx.addToNs(RefineTargetNamespace.class, Empty.getInstance(), refineTargetNodeCtx);
+ } else {
+ subStmtCtx.setIsSupportedToBuildEffective(false);
+ }
}
private static void addOrReplaceNodes(final Mutable<?, ?, ?> subStmtCtx,
private static void addOrReplaceNode(final Mutable<?, ?, ?> refineSubstatementCtx,
final StatementContextBase<?, ?, ?> refineTargetNodeCtx) {
- final StatementDefinition refineSubstatementDef = refineSubstatementCtx.getPublicDefinition();
+ final StatementDefinition refineSubstatementDef = refineSubstatementCtx.publicDefinition();
SourceException.throwIf(!isSupportedRefineTarget(refineSubstatementCtx, refineTargetNodeCtx),
- refineSubstatementCtx.getStatementSourceReference(),
+ refineSubstatementCtx,
"Error in module '%s' in the refine of uses '%s': can not perform refine of '%s' for the target '%s'.",
- refineSubstatementCtx.getRoot().rawStatementArgument(),
- refineSubstatementCtx.coerceParentContext().getStatementArgument(),
- refineSubstatementCtx.getPublicDefinition(), refineTargetNodeCtx.getPublicDefinition());
+ refineSubstatementCtx.getRoot().rawArgument(), refineSubstatementCtx.coerceParentContext().argument(),
+ refineSubstatementCtx.publicDefinition(), refineTargetNodeCtx.publicDefinition());
- if (isAllowedToAddByRefine(refineSubstatementDef)) {
- refineTargetNodeCtx.addEffectiveSubstatement(refineSubstatementCtx);
- } else {
+ if (!isAllowedToAddByRefine(refineSubstatementDef)) {
refineTargetNodeCtx.removeStatementFromEffectiveSubstatements(refineSubstatementDef);
- refineTargetNodeCtx.addEffectiveSubstatement(refineSubstatementCtx);
}
+ refineTargetNodeCtx.addEffectiveSubstatement(refineSubstatementCtx.replicaAsChildOf(refineTargetNodeCtx));
}
+ // FIXME: clarify this and inline into single caller
private static boolean isAllowedToAddByRefine(final StatementDefinition publicDefinition) {
return YangStmtMapping.MUST.equals(publicDefinition);
}
ValidationBundlesNamespace.class, ValidationBundleType.SUPPORTED_REFINE_SUBSTATEMENTS);
return supportedRefineSubstatements == null || supportedRefineSubstatements.isEmpty()
- || supportedRefineSubstatements.contains(refineSubstatementCtx.getPublicDefinition())
+ || supportedRefineSubstatements.contains(refineSubstatementCtx.publicDefinition())
|| StmtContextUtils.isUnknownStatement(refineSubstatementCtx);
}
private static boolean isSupportedRefineTarget(final StmtContext<?, ?, ?> refineSubstatementCtx,
final StmtContext<?, ?, ?> refineTargetNodeCtx) {
final Collection<?> supportedRefineTargets = YangValidationBundles.SUPPORTED_REFINE_TARGETS.get(
- refineSubstatementCtx.getPublicDefinition());
+ refineSubstatementCtx.publicDefinition());
return supportedRefineTargets == null || supportedRefineTargets.isEmpty()
- || supportedRefineTargets.contains(refineTargetNodeCtx.getPublicDefinition());
+ || supportedRefineTargets.contains(refineTargetNodeCtx.publicDefinition());
}
}
Code Review / yangtools.git / blobdiff