-/**
+/*
* Copyright (c) 2015 Cisco Systems, Inc. and others. All rights reserved.
*
* This program and the accompanying materials are made available under the
*/
package org.opendaylight.yangtools.yang.parser.stmt.rfc6020;
-import org.opendaylight.yangtools.yang.parser.spi.source.ModuleCtxToModuleQName;
-
-import org.opendaylight.yangtools.yang.parser.stmt.reactor.RootStatementContext;
-import org.opendaylight.yangtools.yang.parser.spi.validation.ValidationBundlesNamespace.ValidationBundleType;
-import org.opendaylight.yangtools.yang.parser.spi.validation.ValidationBundlesNamespace;
-import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier;
-import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.TypeOfCopy;
+import com.google.common.base.Preconditions;
+import com.google.common.collect.ImmutableSet;
import java.util.Collection;
-import java.util.HashSet;
import java.util.Set;
import org.opendaylight.yangtools.yang.common.QName;
import org.opendaylight.yangtools.yang.common.QNameModule;
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.RefineStatement;
+import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier;
import org.opendaylight.yangtools.yang.model.api.stmt.UsesStatement;
+import org.opendaylight.yangtools.yang.parser.spi.meta.CopyType;
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.ModuleCtxToModuleQName;
import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
+import org.opendaylight.yangtools.yang.parser.spi.validation.ValidationBundlesNamespace;
+import org.opendaylight.yangtools.yang.parser.spi.validation.ValidationBundlesNamespace.ValidationBundleType;
import org.opendaylight.yangtools.yang.parser.stmt.reactor.StatementContextBase;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
public final class GroupingUtils {
+ private static final Logger LOG = LoggerFactory.getLogger(GroupingUtils.class);
+
private GroupingUtils() {
+ throw new UnsupportedOperationException();
}
/**
- * @param sourceGrpStmtCtx source grouping statement context
- * @param targetCtx target context
- * @param usesNode uses node
- * @throws SourceException instance of SourceException
+ * @param sourceGrpStmtCtx
+ * source grouping statement context
+ * @param targetCtx
+ * target context
+ * @param usesNode
+ * uses node
+ * @throws SourceException
+ * instance of SourceException
*/
- public static void copyFromSourceToTarget(
- StatementContextBase<?, ?, ?> sourceGrpStmtCtx,
- StatementContextBase<?, ?, ?> targetCtx,
- StmtContext.Mutable<QName, UsesStatement, EffectiveStatement<QName, UsesStatement>> usesNode)
- throws SourceException {
-
- QNameModule newQNameModule = getNewQNameModule(targetCtx,
- sourceGrpStmtCtx);
- copyDeclaredStmts(sourceGrpStmtCtx, targetCtx, usesNode, newQNameModule);
- copyEffectiveStmts(sourceGrpStmtCtx, targetCtx, usesNode,
- newQNameModule);
-
- }
-
- public static void copyDeclaredStmts(
- StatementContextBase<?, ?, ?> sourceGrpStmtCtx,
- StatementContextBase<?, ?, ?> targetCtx,
- StmtContext.Mutable<QName, UsesStatement, EffectiveStatement<QName, UsesStatement>> usesNode,
- QNameModule newQNameModule) throws SourceException {
- Collection<? extends StatementContextBase<?, ?, ?>> declaredSubstatements = sourceGrpStmtCtx
- .declaredSubstatements();
- for (StatementContextBase<?, ?, ?> originalStmtCtx : declaredSubstatements) {
- if (needToCopyByUses(originalStmtCtx)) {
- StatementContextBase<?, ?, ?> copy = originalStmtCtx
- .createCopy(newQNameModule, targetCtx,
- TypeOfCopy.ADDED_BY_USES);
- targetCtx.addEffectiveSubstatement(copy);
- usesNode.addAsEffectOfStatement(copy);
- } else if (isReusedByUsesOnTop(originalStmtCtx)) {
- targetCtx.addEffectiveSubstatement(originalStmtCtx);
- usesNode.addAsEffectOfStatement(originalStmtCtx);
+ public static void copyFromSourceToTarget(final StatementContextBase<?, ?, ?> sourceGrpStmtCtx,
+ final StatementContextBase<?, ?, ?> targetCtx,
+ final StmtContext.Mutable<QName, UsesStatement, EffectiveStatement<QName, UsesStatement>> usesNode) {
+
+ final QNameModule newQNameModule = getNewQNameModule(targetCtx, sourceGrpStmtCtx);
+ for (final StatementContextBase<?, ?, ?> original : sourceGrpStmtCtx.declaredSubstatements()) {
+ if (StmtContextUtils.areFeaturesSupported(original)) {
+ copyStatement(original, targetCtx, usesNode, newQNameModule);
}
}
- }
- public static void copyEffectiveStmts(
- StatementContextBase<?, ?, ?> sourceGrpStmtCtx,
- StatementContextBase<?, ?, ?> targetCtx,
- StmtContext.Mutable<QName, UsesStatement, EffectiveStatement<QName, UsesStatement>> usesNode,
- QNameModule newQNameModule) throws SourceException {
- Collection<? extends StatementContextBase<?, ?, ?>> effectiveSubstatements = sourceGrpStmtCtx
- .effectiveSubstatements();
- for (StatementContextBase<?, ?, ?> originalStmtCtx : effectiveSubstatements) {
- if (needToCopyByUses(originalStmtCtx)) {
- StatementContextBase<?, ?, ?> copy = originalStmtCtx
- .createCopy(newQNameModule, targetCtx,
- TypeOfCopy.ADDED_BY_USES);
- targetCtx.addEffectiveSubstatement(copy);
- usesNode.addAsEffectOfStatement(copy);
- } else if (isReusedByUsesOnTop(originalStmtCtx)) {
- targetCtx.addEffectiveSubstatement(originalStmtCtx);
- usesNode.addAsEffectOfStatement(originalStmtCtx);
- }
+ for (final StatementContextBase<?, ?, ?> original : sourceGrpStmtCtx.effectiveSubstatements()) {
+ copyStatement(original, targetCtx, usesNode, newQNameModule);
}
}
- public static QNameModule getNewQNameModule(
- StatementContextBase<?, ?, ?> targetCtx,
- StmtContext<?, ?, ?> stmtContext) {
- if (needToCreateNewQName(stmtContext.getPublicDefinition())) {
- if (targetCtx.isRootContext()) {
- return targetCtx.getFromNamespace(
- ModuleCtxToModuleQName.class,
- targetCtx);
- }
- if(targetCtx.getPublicDefinition() == Rfc6020Mapping.AUGMENT) {
- RootStatementContext<?, ?, ?> root = targetCtx.getRoot();
- return targetCtx.getFromNamespace(
- ModuleCtxToModuleQName.class,
- root);
- }
-
- Object targetStmtArgument = targetCtx.getStatementArgument();
- Object sourceStmtArgument = stmtContext.getStatementArgument();
- if (targetStmtArgument instanceof QName
- && sourceStmtArgument instanceof QName) {
- QName targetQName = (QName) targetStmtArgument;
- QNameModule targetQNameModule = targetQName.getModule();
-
- return targetQNameModule;
- } else {
- return null;
- }
- } else {
- return null;
+ private static void copyStatement(final StatementContextBase<?, ?, ?> original,
+ final StatementContextBase<?, ?, ?> targetCtx,
+ final StmtContext.Mutable<QName, UsesStatement, EffectiveStatement<QName, UsesStatement>> targetUses,
+ final QNameModule targetModule) {
+ if (needToCopyByUses(original)) {
+ final StatementContextBase<?, ?, ?> copy = original.createCopy(targetModule, targetCtx,
+ CopyType.ADDED_BY_USES);
+ targetCtx.addEffectiveSubstatement(copy);
+ targetUses.addAsEffectOfStatement(copy);
+ } else if (isReusedByUsesOnTop(original)) {
+ targetCtx.addEffectiveSubstatement(original);
+ targetUses.addAsEffectOfStatement(original);
}
}
- public static boolean needToCreateNewQName(
- StatementDefinition publicDefinition) {
- return true;
- }
-
- public static boolean needToCopyByUses(StmtContext<?, ?, ?> stmtContext) {
-
- Set<StatementDefinition> noCopyDefSet = new HashSet<>();
- noCopyDefSet.add(Rfc6020Mapping.USES);
- noCopyDefSet.add(Rfc6020Mapping.TYPEDEF);
- noCopyDefSet.add(Rfc6020Mapping.TYPE);
-
- final Set<StatementDefinition> noCopyFromGroupingSet = new HashSet<>();
- noCopyFromGroupingSet.add(Rfc6020Mapping.DESCRIPTION);
- noCopyFromGroupingSet.add(Rfc6020Mapping.REFERENCE);
+ public static QNameModule getNewQNameModule(final StatementContextBase<?, ?, ?> targetCtx,
+ final StmtContext<?, ?, ?> stmtContext) {
+ if (targetCtx.isRootContext()) {
+ return targetCtx.getFromNamespace(ModuleCtxToModuleQName.class, targetCtx);
+ }
+ if (targetCtx.getPublicDefinition() == Rfc6020Mapping.AUGMENT) {
+ return targetCtx.getFromNamespace(ModuleCtxToModuleQName.class, targetCtx.getRoot());
+ }
- StatementDefinition def = stmtContext.getPublicDefinition();
- boolean dontCopyFromParentGrouping = noCopyFromGroupingSet.contains(def) && stmtContext.getParentContext()
- .getPublicDefinition().equals(Rfc6020Mapping.GROUPING);
+ final Object targetStmtArgument = targetCtx.getStatementArgument();
+ final Object sourceStmtArgument = stmtContext.getStatementArgument();
+ if (targetStmtArgument instanceof QName && sourceStmtArgument instanceof QName) {
+ return ((QName) targetStmtArgument).getModule();
+ }
- return !noCopyDefSet.contains(def) && !dontCopyFromParentGrouping;
+ return null;
}
- public static boolean isReusedByUses(StmtContext<?, ?, ?> stmtContext) {
+ private static final Set<Rfc6020Mapping> NOCOPY_DEF_SET = ImmutableSet.of(Rfc6020Mapping.USES,
+ Rfc6020Mapping.TYPEDEF, Rfc6020Mapping.TYPE);
+ private static final Set<Rfc6020Mapping> NOCOPY_FROM_GROUPING_SET = ImmutableSet.of(Rfc6020Mapping.DESCRIPTION,
+ Rfc6020Mapping.REFERENCE, Rfc6020Mapping.STATUS);
+ private static final Set<Rfc6020Mapping> REUSED_DEF_SET = ImmutableSet.of(Rfc6020Mapping.TYPEDEF,
+ Rfc6020Mapping.TYPE, Rfc6020Mapping.USES);
+ private static final Set<Rfc6020Mapping> TOP_REUSED_DEF_SET = ImmutableSet.of(Rfc6020Mapping.TYPEDEF,
+ Rfc6020Mapping.TYPE);
- Set<StatementDefinition> reusedDefSet = new HashSet<>();
- reusedDefSet.add(Rfc6020Mapping.TYPEDEF);
- reusedDefSet.add(Rfc6020Mapping.TYPE);
- reusedDefSet.add(Rfc6020Mapping.USES);
+ public static boolean needToCopyByUses(final StmtContext<?, ?, ?> stmtContext) {
+ final StatementDefinition def = stmtContext.getPublicDefinition();
- StatementDefinition def = stmtContext.getPublicDefinition();
- return reusedDefSet.contains(def);
+ return !(NOCOPY_DEF_SET.contains(def) || (NOCOPY_FROM_GROUPING_SET.contains(def) && Rfc6020Mapping.GROUPING
+ .equals(stmtContext.getParentContext().getPublicDefinition())));
}
- public static boolean isReusedByUsesOnTop(StmtContext<?, ?, ?> stmtContext) {
-
- Set<StatementDefinition> reusedDefSet = new HashSet<>();
- reusedDefSet.add(Rfc6020Mapping.TYPEDEF);
- reusedDefSet.add(Rfc6020Mapping.TYPE);
+ public static boolean isReusedByUses(final StmtContext<?, ?, ?> stmtContext) {
+ return REUSED_DEF_SET.contains(stmtContext.getPublicDefinition());
+ }
- StatementDefinition def = stmtContext.getPublicDefinition();
- return reusedDefSet.contains(def);
+ public static boolean isReusedByUsesOnTop(final StmtContext<?, ?, ?> stmtContext) {
+ return TOP_REUSED_DEF_SET.contains(stmtContext.getPublicDefinition());
}
public static void resolveUsesNode(
- Mutable<QName, UsesStatement, EffectiveStatement<QName, UsesStatement>> usesNode,
- StatementContextBase<?, ?, ?> targetNodeStmtCtx)
- throws SourceException {
-
- Collection<StatementContextBase<?, ?, ?>> declaredSubstatements = usesNode
- .declaredSubstatements();
- for (StatementContextBase<?, ?, ?> subStmtCtx : declaredSubstatements) {
- if (StmtContextUtils.producesDeclared(subStmtCtx,
- RefineStatement.class)) {
+ final Mutable<QName, UsesStatement, EffectiveStatement<QName, UsesStatement>> usesNode,
+ final StatementContextBase<?, ?, ?> targetNodeStmtCtx) {
+ for (final StatementContextBase<?, ?, ?> subStmtCtx : usesNode.declaredSubstatements()) {
+ if (StmtContextUtils.producesDeclared(subStmtCtx, RefineStatement.class)) {
performRefine(subStmtCtx, targetNodeStmtCtx);
}
}
}
- private static void performRefine(StatementContextBase<?, ?, ?> refineCtx,
- StatementContextBase<?, ?, ?> usesParentCtx) {
-
- Object refineArgument = refineCtx.getStatementArgument();
-
- SchemaNodeIdentifier refineTargetNodeIdentifier;
- if (refineArgument instanceof SchemaNodeIdentifier) {
- refineTargetNodeIdentifier = (SchemaNodeIdentifier) refineArgument;
- } else {
- throw new IllegalArgumentException(
- "Invalid refine argument. It must be instance of SchemaNodeIdentifier");
- }
-
- StatementContextBase<?, ?, ?> refineTargetNodeCtx = Utils.findNode(
- usesParentCtx, refineTargetNodeIdentifier);
-
- if (refineTargetNodeCtx == null) {
- throw new IllegalArgumentException(
- "Refine target node not found. Path: "
- + refineTargetNodeIdentifier);
+ private static void performRefine(final StatementContextBase<?, ?, ?> refineCtx,
+ final StatementContextBase<?, ?, ?> usesParentCtx) {
+
+ final Object refineArgument = refineCtx.getStatementArgument();
+ Preconditions.checkArgument(refineArgument instanceof SchemaNodeIdentifier,
+ "Invalid refine argument %s. It must be instance of SchemaNodeIdentifier. At %s", refineArgument,
+ refineCtx.getStatementSourceReference());
+
+ final SchemaNodeIdentifier refineTargetNodeIdentifier = (SchemaNodeIdentifier) refineArgument;
+ final StatementContextBase<?, ?, ?> refineTargetNodeCtx = Utils.findNode(usesParentCtx,
+ refineTargetNodeIdentifier);
+ Preconditions.checkArgument(refineTargetNodeCtx != null, "Refine target node %s not found. At %s",
+ refineTargetNodeIdentifier, refineCtx.getStatementSourceReference());
+ if (StmtContextUtils.isUnknownStatement(refineTargetNodeCtx)) {
+ LOG.debug(
+ "Refine node '{}' in uses '{}' has target node unknown statement '{}'. Refine has been skipped. At line: {}",
+ refineCtx.getStatementArgument(), refineCtx.getParentContext().getStatementArgument(),
+ refineTargetNodeCtx.getStatementArgument(), refineCtx.getStatementSourceReference());
+ refineCtx.addAsEffectOfStatement(refineTargetNodeCtx);
+ return;
}
addOrReplaceNodes(refineCtx, refineTargetNodeCtx);
refineCtx.addAsEffectOfStatement(refineTargetNodeCtx);
-
}
- private static void addOrReplaceNodes(
- StatementContextBase<?, ?, ?> refineCtx,
- StatementContextBase<?, ?, ?> refineTargetNodeCtx) {
-
- Collection<StatementContextBase<?, ?, ?>> declaredSubstatements = refineCtx
- .declaredSubstatements();
- for (StatementContextBase<?, ?, ?> refineSubstatementCtx : declaredSubstatements) {
+ private static void addOrReplaceNodes(final StatementContextBase<?, ?, ?> refineCtx,
+ final StatementContextBase<?, ?, ?> refineTargetNodeCtx) {
+ for (final StatementContextBase<?, ?, ?> refineSubstatementCtx : refineCtx.declaredSubstatements()) {
if (isSupportedRefineSubstatement(refineSubstatementCtx)) {
addOrReplaceNode(refineSubstatementCtx, refineTargetNodeCtx);
}
}
}
- private static void addOrReplaceNode(
- StatementContextBase<?, ?, ?> refineSubstatementCtx,
- StatementContextBase<?, ?, ?> refineTargetNodeCtx) {
-
- StatementDefinition refineSubstatementDef = refineSubstatementCtx
- .getPublicDefinition();
- StatementDefinition refineTargetNodeDef = refineTargetNodeCtx
- .getPublicDefinition();
-
- if (!isSupportedRefineTarget(refineSubstatementCtx, refineTargetNodeCtx)) {
- throw new SourceException("Error in module '"
- + refineSubstatementCtx.getRoot().getStatementArgument()
- + "' in the refine of uses '"
- + refineSubstatementCtx.getParentContext()
- .getStatementArgument()
- + "': can not perform refine of '"
- + refineSubstatementCtx.getPublicDefinition()
- + "' for the target '"
- + refineTargetNodeCtx.getPublicDefinition() + "'.",
- refineSubstatementCtx.getStatementSourceReference());
- }
+ private static void addOrReplaceNode(final StatementContextBase<?, ?, ?> refineSubstatementCtx,
+ final StatementContextBase<?, ?, ?> refineTargetNodeCtx) {
+
+ final StatementDefinition refineSubstatementDef = refineSubstatementCtx.getPublicDefinition();
+
+ SourceException.throwIf(!isSupportedRefineTarget(refineSubstatementCtx, refineTargetNodeCtx),
+ refineSubstatementCtx.getStatementSourceReference(),
+ "Error in module '%s' in the refine of uses '%s': can not perform refine of '%s' for the target '%s'.",
+ refineSubstatementCtx.getRoot().getStatementArgument(), refineSubstatementCtx.getParentContext()
+ .getStatementArgument(), refineSubstatementCtx.getPublicDefinition(), refineTargetNodeCtx
+ .getPublicDefinition());
if (isAllowedToAddByRefine(refineSubstatementDef)) {
refineTargetNodeCtx.addEffectiveSubstatement(refineSubstatementCtx);
}
}
- private static boolean isAllowedToAddByRefine(
- StatementDefinition publicDefinition) {
- Set<StatementDefinition> allowedToAddByRefineDefSet = new HashSet<>();
- allowedToAddByRefineDefSet.add(Rfc6020Mapping.MUST);
+ private static final Set<Rfc6020Mapping> ALLOWED_TO_ADD_BY_REFINE_DEF_SET = ImmutableSet.of(Rfc6020Mapping.MUST);
- return allowedToAddByRefineDefSet.contains(publicDefinition);
+ private static boolean isAllowedToAddByRefine(final StatementDefinition publicDefinition) {
+ return ALLOWED_TO_ADD_BY_REFINE_DEF_SET.contains(publicDefinition);
}
- private static boolean isSupportedRefineSubstatement(
- StatementContextBase<?, ?, ?> refineSubstatementCtx) {
-
- Collection<?> supportedRefineSubstatements = refineSubstatementCtx
- .getFromNamespace(ValidationBundlesNamespace.class,
- ValidationBundleType.SUPPORTED_REFINE_SUBSTATEMENTS);
+ private static boolean isSupportedRefineSubstatement(final StatementContextBase<?, ?, ?> refineSubstatementCtx) {
+ final Collection<?> supportedRefineSubstatements = refineSubstatementCtx.getFromNamespace(
+ ValidationBundlesNamespace.class, ValidationBundleType.SUPPORTED_REFINE_SUBSTATEMENTS);
- return supportedRefineSubstatements == null
- || supportedRefineSubstatements.isEmpty()
- || supportedRefineSubstatements.contains(refineSubstatementCtx
- .getPublicDefinition())
+ return supportedRefineSubstatements == null || supportedRefineSubstatements.isEmpty()
+ || supportedRefineSubstatements.contains(refineSubstatementCtx.getPublicDefinition())
|| StmtContextUtils.isUnknownStatement(refineSubstatementCtx);
}
- private static boolean isSupportedRefineTarget(
- StatementContextBase<?, ?, ?> refineSubstatementCtx,
- StatementContextBase<?, ?, ?> refineTargetNodeCtx) {
+ private static boolean isSupportedRefineTarget(final StatementContextBase<?, ?, ?> refineSubstatementCtx,
+ final StatementContextBase<?, ?, ?> refineTargetNodeCtx) {
- Collection<?> supportedRefineTargets = YangValidationBundles.SUPPORTED_REFINE_TARGETS
+ final Collection<?> supportedRefineTargets = YangValidationBundles.SUPPORTED_REFINE_TARGETS
.get(refineSubstatementCtx.getPublicDefinition());
- return supportedRefineTargets == null
- || supportedRefineTargets.isEmpty()
- || supportedRefineTargets.contains(refineTargetNodeCtx
- .getPublicDefinition());
+ return supportedRefineTargets == null || supportedRefineTargets.isEmpty()
+ || supportedRefineTargets.contains(refineTargetNodeCtx.getPublicDefinition());
}
-
}
Code Review / yangtools.git / blobdiff