*/
package org.opendaylight.yangtools.yang.parser.stmt.rfc6020;
-import org.opendaylight.yangtools.yang.parser.spi.source.ModuleCtxToModuleQName;
-
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
+import com.google.common.base.Preconditions;
import com.google.common.collect.ImmutableList.Builder;
+import com.google.common.collect.ImmutableSet;
+import com.google.common.collect.Iterables;
+import java.util.ArrayList;
import java.util.Collection;
-import java.util.HashSet;
import java.util.Iterator;
-import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Set;
+import java.util.regex.Pattern;
import javax.annotation.Nullable;
import org.opendaylight.yangtools.yang.common.QName;
import org.opendaylight.yangtools.yang.common.QNameModule;
import org.opendaylight.yangtools.yang.model.api.Rfc6020Mapping;
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.AugmentStatement;
import org.opendaylight.yangtools.yang.model.api.stmt.DataDefinitionStatement;
import org.opendaylight.yangtools.yang.model.api.stmt.MandatoryStatement;
import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.TypeOfCopy;
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 AugmentUtils {
private static final Logger LOG = LoggerFactory.getLogger(AugmentUtils.class);
-
- private static final String REGEX_PATH_REL1 = "\\.\\.?\\s*/(.+)";
- private static final String REGEX_PATH_REL2 = "//.*";
+ private static final Pattern PATH_REL_PATTERN1 = Pattern.compile("\\.\\.?\\s*/(.+)");
+ private static final Pattern PATH_REL_PATTERN2 = Pattern.compile("//.*");
private AugmentUtils() {
+ throw new UnsupportedOperationException();
}
- public static Iterable<QName> parseAugmentPath(StmtContext<?, ?, ?> ctx,
- String path) {
-
- if (path.matches(REGEX_PATH_REL1) || path.matches(REGEX_PATH_REL2)) {
- throw new IllegalArgumentException(
- "An argument for augment can be only absolute path; or descendant if used in uses");
- }
+ public static Iterable<QName> parseAugmentPath(final StmtContext<?, ?, ?> ctx, final String path) {
+ Preconditions.checkArgument(!PATH_REL_PATTERN1.matcher(path).matches()
+ && !PATH_REL_PATTERN2.matcher(path).matches(),
+ "An argument for augment can be only absolute path; or descendant if used in uses");
return Utils.parseXPath(ctx, path);
}
- public static void copyFromSourceToTarget(
- StatementContextBase<?, ?, ?> sourceCtx,
- StatementContextBase<?, ?, ?> targetCtx) throws SourceException {
+ public static void copyFromSourceToTarget(final StatementContextBase<?, ?, ?> sourceCtx,
+ final StatementContextBase<?, ?, ?> targetCtx) throws SourceException {
copyDeclaredStmts(sourceCtx, targetCtx);
copyEffectiveStmts(sourceCtx, targetCtx);
}
- public static void copyDeclaredStmts(
- StatementContextBase<?, ?, ?> sourceCtx,
- StatementContextBase<?, ?, ?> targetCtx) throws SourceException {
+ public static void copyDeclaredStmts(final StatementContextBase<?, ?, ?> sourceCtx,
+ final StatementContextBase<?, ?, ?> targetCtx) throws SourceException {
- Collection<? extends StatementContextBase<?, ?, ?>> declaredSubStatements = sourceCtx
- .declaredSubstatements();
- final List<StatementContextBase> subStatements = new Builder<StatementContextBase>()
- .addAll(targetCtx.declaredSubstatements())
- .addAll(targetCtx.effectiveSubstatements()).build();
- boolean sourceAndTargetInSameModule = Utils.getRootModuleQName(
- sourceCtx).equals(Utils.getRootModuleQName(targetCtx));
+ final List<StatementContextBase<?, ?, ?>> subStatements = new Builder<StatementContextBase<?, ?, ?>>()
+ .addAll(targetCtx.declaredSubstatements()).addAll(targetCtx.effectiveSubstatements()).build();
+ boolean sourceAndTargetInSameModule = Utils.getRootModuleQName(sourceCtx).equals(
+ Utils.getRootModuleQName(targetCtx));
- TypeOfCopy typeOfCopy = sourceCtx.getParentContext()
- .getPublicDefinition().getDeclaredRepresentationClass()
- .equals(UsesStatement.class) ? TypeOfCopy.ADDED_BY_USES_AUGMENTATION
- : TypeOfCopy.ADDED_BY_AUGMENTATION;
+ TypeOfCopy typeOfCopy = sourceCtx.getParentContext().getPublicDefinition().getDeclaredRepresentationClass()
+ .equals(UsesStatement.class) ? TypeOfCopy.ADDED_BY_USES_AUGMENTATION : TypeOfCopy.ADDED_BY_AUGMENTATION;
- for (StatementContextBase<?, ?, ?> originalStmtCtx : declaredSubStatements) {
+ for (StatementContextBase<?, ?, ?> originalStmtCtx : sourceCtx.declaredSubstatements()) {
if (needToCopyByAugment(originalStmtCtx)) {
- validateNodeCanBeCopiedByAugment(originalStmtCtx,
- subStatements, sourceAndTargetInSameModule);
+ validateNodeCanBeCopiedByAugment(originalStmtCtx, subStatements, sourceAndTargetInSameModule);
- StatementContextBase<?, ?, ?> copy = originalStmtCtx
- .createCopy(targetCtx, typeOfCopy);
+ StatementContextBase<?, ?, ?> copy = originalStmtCtx.createCopy(targetCtx, typeOfCopy);
targetCtx.addEffectiveSubstatement(copy);
} else if (isReusedByAugment(originalStmtCtx)) {
targetCtx.addEffectiveSubstatement(originalStmtCtx);
}
}
- public static void copyEffectiveStmts(
- StatementContextBase<?, ?, ?> sourceCtx,
- StatementContextBase<?, ?, ?> targetCtx) throws SourceException {
+ public static void copyEffectiveStmts(final StatementContextBase<?, ?, ?> sourceCtx,
+ final StatementContextBase<?, ?, ?> targetCtx) throws SourceException {
- Collection<? extends StatementContextBase<?, ?, ?>> effectiveSubstatements = sourceCtx
- .effectiveSubstatements();
- final List<StatementContextBase> subStatements = new Builder<StatementContextBase>()
- .addAll(targetCtx.declaredSubstatements())
- .addAll(targetCtx.effectiveSubstatements()).build();
- boolean sourceAndTargetInSameModule = Utils.getRootModuleQName(
- sourceCtx).equals(Utils.getRootModuleQName(targetCtx));
+ final List<StatementContextBase<?, ?, ?>> subStatements = new Builder<StatementContextBase<?, ?, ?>>()
+ .addAll(targetCtx.declaredSubstatements()).addAll(targetCtx.effectiveSubstatements()).build();
+ boolean sourceAndTargetInSameModule = Utils.getRootModuleQName(sourceCtx).equals(
+ Utils.getRootModuleQName(targetCtx));
- TypeOfCopy typeOfCopy = sourceCtx.getParentContext()
- .getPublicDefinition().getDeclaredRepresentationClass()
- .equals(UsesStatement.class) ? TypeOfCopy.ADDED_BY_USES_AUGMENTATION
- : TypeOfCopy.ADDED_BY_AUGMENTATION;
+ TypeOfCopy typeOfCopy = sourceCtx.getParentContext().getPublicDefinition().getDeclaredRepresentationClass()
+ .equals(UsesStatement.class) ? TypeOfCopy.ADDED_BY_USES_AUGMENTATION : TypeOfCopy.ADDED_BY_AUGMENTATION;
- for (StatementContextBase<?, ?, ?> originalStmtCtx : effectiveSubstatements) {
+ for (StatementContextBase<?, ?, ?> originalStmtCtx : sourceCtx.effectiveSubstatements()) {
if (needToCopyByAugment(originalStmtCtx)) {
- validateNodeCanBeCopiedByAugment(originalStmtCtx,
- subStatements, sourceAndTargetInSameModule);
+ validateNodeCanBeCopiedByAugment(originalStmtCtx, subStatements, sourceAndTargetInSameModule);
- StatementContextBase<?, ?, ?> copy = originalStmtCtx
- .createCopy(targetCtx, typeOfCopy);
+ StatementContextBase<?, ?, ?> copy = originalStmtCtx.createCopy(targetCtx, typeOfCopy);
targetCtx.addEffectiveSubstatement(copy);
} else if (isReusedByAugment(originalStmtCtx)) {
targetCtx.addEffectiveSubstatement(originalStmtCtx);
}
}
- private static void validateNodeCanBeCopiedByAugment(
- final StatementContextBase<?, ?, ?> sourceCtx,
- final List<StatementContextBase> targetSubStatements,
- boolean sourceAndTargetInSameModule) {
+ private static void validateNodeCanBeCopiedByAugment(final StatementContextBase<?, ?, ?> sourceCtx,
+ final Iterable<StatementContextBase<?, ?, ?>> targetSubStatements,
+ final boolean sourceAndTargetInSameModule) {
- if (sourceCtx.getPublicDefinition().getDeclaredRepresentationClass()
- .equals(WhenStatement.class)) {
+ if (WhenStatement.class.equals(sourceCtx.getPublicDefinition().getDeclaredRepresentationClass())) {
return;
}
if (!sourceAndTargetInSameModule) {
- final List<StatementContextBase> sourceSubStatements = new Builder<StatementContextBase>()
- .addAll(sourceCtx.declaredSubstatements())
- .addAll(sourceCtx.effectiveSubstatements()).build();
-
- for (final StatementContextBase sourceSubStatement : sourceSubStatements) {
- if (sourceSubStatement.getPublicDefinition()
- .getDeclaredRepresentationClass()
- .equals(MandatoryStatement.class)) {
- throw new IllegalArgumentException(
- String.format(
- "An augment cannot add node '%s' because it is mandatory and in module different from target",
- sourceCtx.rawStatementArgument()));
- }
+ for (final StatementContextBase<?, ?, ?> sourceSubStatement :
+ Iterables.concat(sourceCtx.declaredSubstatements(), sourceCtx.effectiveSubstatements())) {
+ Preconditions.checkArgument(!MandatoryStatement.class.equals(
+ sourceSubStatement.getPublicDefinition().getDeclaredRepresentationClass()),
+ "An augment cannot add node '%s' because it is mandatory and in module different from target",
+ sourceCtx.rawStatementArgument());
}
}
- for (final StatementContextBase subStatement : targetSubStatements) {
-
- final boolean sourceIsDataNode = DataDefinitionStatement.class
- .isAssignableFrom(sourceCtx.getPublicDefinition()
- .getDeclaredRepresentationClass());
- final boolean targetIsDataNode = DataDefinitionStatement.class
- .isAssignableFrom(subStatement.getPublicDefinition()
- .getDeclaredRepresentationClass());
- boolean qNamesEqual = sourceIsDataNode
- && targetIsDataNode
- && Objects.equals(sourceCtx.getStatementArgument(),
- subStatement.getStatementArgument());
-
- if (qNamesEqual) {
- throw new IllegalStateException(
- String.format(
- "An augment cannot add node named '%s' because this name is already used in target",
- sourceCtx.rawStatementArgument()));
- }
+ for (final StatementContextBase<?, ?, ?> subStatement : targetSubStatements) {
+
+ final boolean sourceIsDataNode = DataDefinitionStatement.class.isAssignableFrom(
+ sourceCtx.getPublicDefinition().getDeclaredRepresentationClass());
+ final boolean targetIsDataNode = DataDefinitionStatement.class.isAssignableFrom(
+ subStatement.getPublicDefinition().getDeclaredRepresentationClass());
+ Preconditions.checkState(!sourceIsDataNode || !targetIsDataNode
+ || !Objects.equals(sourceCtx.getStatementArgument(), subStatement.getStatementArgument()),
+ "An augment cannot add node named '%s' because this name is already used in target",
+ sourceCtx.rawStatementArgument());
}
}
- public static QNameModule getNewQNameModule(
- StatementContextBase<?, ?, ?> targetCtx,
- StatementContextBase<?, ?, ?> sourceCtx) {
+ public static QNameModule getNewQNameModule(final StatementContextBase<?, ?, ?> targetCtx,
+ final StatementContextBase<?, ?, ?> sourceCtx) {
Object targetStmtArgument = targetCtx.getStatementArgument();
final StatementContextBase<?, ?, ?> root = sourceCtx.getRoot();
- final QNameModule sourceQNameModule = root.getFromNamespace(
- ModuleCtxToModuleQName.class, root);
+ final QNameModule sourceQNameModule = root.getFromNamespace(ModuleCtxToModuleQName.class, root);
if (targetStmtArgument instanceof QName) {
QName targetQName = (QName) targetStmtArgument;
}
}
- public static boolean needToCopyByAugment(StmtContext<?, ?, ?> stmtContext) {
+ private static final Set<Rfc6020Mapping> NOCOPY_DEV_SET = ImmutableSet.of(Rfc6020Mapping.USES);
- Set<StatementDefinition> noCopyDefSet = new HashSet<>();
- noCopyDefSet.add(Rfc6020Mapping.USES);
-
- StatementDefinition def = stmtContext.getPublicDefinition();
- return !noCopyDefSet.contains(def);
+ public static boolean needToCopyByAugment(final StmtContext<?, ?, ?> stmtContext) {
+ return !NOCOPY_DEV_SET.contains(stmtContext.getPublicDefinition());
}
- public static boolean isReusedByAugment(StmtContext<?, ?, ?> stmtContext) {
-
- Set<StatementDefinition> reusedDefSet = new HashSet<>();
- reusedDefSet.add(Rfc6020Mapping.TYPEDEF);
+ private static final Set<Rfc6020Mapping> REUSED_DEF_SET = ImmutableSet.of(Rfc6020Mapping.TYPEDEF);
- StatementDefinition def = stmtContext.getPublicDefinition();
-
- return reusedDefSet.contains(def);
+ public static boolean isReusedByAugment(final StmtContext<?, ?, ?> stmtContext) {
+ return REUSED_DEF_SET.contains(stmtContext.getPublicDefinition());
}
public static StatementContextBase<?, ?, ?> getAugmentTargetCtx(
final Mutable<SchemaNodeIdentifier, AugmentStatement, EffectiveStatement<SchemaNodeIdentifier, AugmentStatement>> augmentNode) {
- final SchemaNodeIdentifier augmentTargetNode = augmentNode
- .getStatementArgument();
- if (augmentTargetNode == null) {
- throw new IllegalArgumentException(
- "Augment argument null, something bad happened in some of previous parsing phases");
- }
+ final SchemaNodeIdentifier augmentTargetNode = augmentNode.getStatementArgument();
+ Preconditions.checkArgument(augmentTargetNode != null,
+ "Augment argument null, something bad happened in some of previous parsing phases");
- List<StatementContextBase<?, ?, ?>> rootStatementCtxList = new LinkedList<>();
+ List<StatementContextBase<?, ?, ?>> rootStatementCtxList = new ArrayList<>();
if (augmentTargetNode.isAbsolute()) {
- QNameModule module = augmentTargetNode.getPathFromRoot().iterator()
- .next().getModule();
+ QNameModule module = augmentTargetNode.getPathFromRoot().iterator().next().getModule();
- StatementContextBase<?, ?, ?> rootStatementCtx = (StatementContextBase<?, ?, ?>) augmentNode
- .getFromNamespace(NamespaceToModule.class, module);
+ StatementContextBase<?, ?, ?> rootStatementCtx =
+ (StatementContextBase<?, ?, ?>) augmentNode.getFromNamespace(NamespaceToModule.class, module);
rootStatementCtxList.add(rootStatementCtx);
- final Map<?, ?> subModules = rootStatementCtx
- .getAllFromNamespace(IncludedModuleContext.class);
+ final Map<?, ?> subModules = rootStatementCtx.getAllFromNamespace(IncludedModuleContext.class);
if (subModules != null) {
- rootStatementCtxList
- .addAll((Collection<? extends StatementContextBase<?, ?, ?>>) subModules
- .values());
+ rootStatementCtxList.addAll((Collection<? extends StatementContextBase<?, ?, ?>>) subModules.values());
}
} else {
- StatementContextBase<?, ?, ?> parent = (StatementContextBase<?, ?, ?>) augmentNode
- .getParentContext();
+ StatementContextBase<?, ?, ?> parent = (StatementContextBase<?, ?, ?>) augmentNode.getParentContext();
if (StmtContextUtils.producesDeclared(parent, UsesStatement.class)) {
rootStatementCtxList.add(parent.getParentContext());
} else {
StatementContextBase<?, ?, ?> augmentTargetCtx = null;
for (final StatementContextBase<?, ?, ?> rootStatementCtx : rootStatementCtxList) {
- augmentTargetCtx = findCtxOfNodeInRoot(rootStatementCtx,
- augmentTargetNode);
- if (augmentTargetCtx != null)
+ augmentTargetCtx = findCtxOfNodeInRoot(rootStatementCtx, augmentTargetNode);
+ if (augmentTargetCtx != null) {
break;
+ }
}
return augmentTargetCtx;
}
@Nullable
- public static StatementContextBase<?, ?, ?> findCtxOfNodeInSubstatements(
- StatementContextBase<?, ?, ?> rootStmtCtx,
+ public static StatementContextBase<?, ?, ?> findCtxOfNodeInSubstatements(final StatementContextBase<?, ?, ?> rootStmtCtx,
final Iterable<QName> path) {
StatementContextBase<?, ?, ?> parent = rootStmtCtx;
Iterator<QName> pathIter = path.iterator();
while (pathIter.hasNext()) {
QName nextPathQName = pathIter.next();
- StatementContextBase<?, ?, ?> foundSubstatement = getSubstatementByQName(
- parent, nextPathQName);
+ StatementContextBase<?, ?, ?> foundSubstatement = getSubstatementByQName(parent, nextPathQName);
if (foundSubstatement == null) {
return null;
return null;
}
- public static StatementContextBase<?, ?, ?> getSubstatementByQName(
- StatementContextBase<?, ?, ?> parent, QName nextPathQName) {
+ public static StatementContextBase<?, ?, ?> getSubstatementByQName(final StatementContextBase<?, ?, ?> parent,
+ final QName nextPathQName) {
- Collection<StatementContextBase<?, ?, ?>> declaredSubstatement = parent
- .declaredSubstatements();
- Collection<StatementContextBase<?, ?, ?>> effectiveSubstatement = parent
- .effectiveSubstatements();
+ Collection<StatementContextBase<?, ?, ?>> declaredSubstatement = parent.declaredSubstatements();
+ Collection<StatementContextBase<?, ?, ?>> effectiveSubstatement = parent.effectiveSubstatements();
- Collection<StatementContextBase<?, ?, ?>> allSubstatements = new LinkedList<>();
- allSubstatements.addAll(declaredSubstatement);
- allSubstatements.addAll(effectiveSubstatement);
-
- for (StatementContextBase<?, ?, ?> substatement : allSubstatements) {
+ for (StatementContextBase<?, ?, ?> substatement : Iterables.concat(declaredSubstatement, effectiveSubstatement)) {
Object substatementArgument = substatement.getStatementArgument();
QName substatementQName;
if (substatementArgument instanceof QName) {
substatementQName = (QName) substatementArgument;
- if (isSupportedAugmentTarget(substatement)
- && nextPathQName.getLocalName().equals(
- substatementQName.getLocalName())) {
- return substatement;
- }
- } // augment to extension
- else if (StmtContextUtils.producesDeclared(substatement,
- UnknownStatementImpl.class)
- && substatementArgument instanceof String) {
- if (nextPathQName.getLocalName().equals(substatementArgument)) {
- String message = "Module '"+substatement.getRoot().getStatementArgument()+"': augment into extension '"+substatementArgument+"'.";
- LOG.warn(message);
- return substatement;
+ if (nextPathQName.getLocalName().equals(
+ substatementQName.getLocalName())) {
+ if (isSupportedAugmentTarget(substatement)) {
+ return substatement;
+ } else if (Utils.isUnknownNode(substatement)) {
+ LOG.warn("Module '{}': augment into unknown node '{}'.",
+ substatement.getRoot().getStatementArgument(), substatementArgument);
+ return substatement;
+ }
}
}
}
return null;
}
- public static boolean isSupportedAugmentTarget(
- StatementContextBase<?, ?, ?> substatementCtx) {
+ public static boolean isSupportedAugmentTarget(final StatementContextBase<?, ?, ?> substatementCtx) {
/*
- * :TODO Substatement must be allowed augment target type e.g.
- * Container, etc... and must be not for example grouping, identity etc.
- * It is problem in case when more than one substatements have the same
- * QName, for example Grouping and Container are siblings and they have
- * the same QName. We must find the Container and the Grouping must be
- * ignored as disallowed augment target.
+ * :TODO Substatement must be allowed augment target type e.g. Container, etc... and must be not for example
+ * grouping, identity etc. It is problem in case when more than one substatements have the same QName, for
+ * example Grouping and Container are siblings and they have the same QName. We must find the Container and the
+ * Grouping must be ignored as disallowed augment target.
*/
- Collection<?> allowedAugmentTargets = substatementCtx.getFromNamespace(
- ValidationBundlesNamespace.class,
+ Collection<?> allowedAugmentTargets = substatementCtx.getFromNamespace(ValidationBundlesNamespace.class,
ValidationBundleType.SUPPORTED_AUGMENT_TARGETS);
// if no allowed target is returned we consider all targets allowed
}
@Nullable
- public static StatementContextBase<?, ?, ?> findCtxOfNodeInRoot(
- StatementContextBase<?, ?, ?> rootStmtCtx,
+ public static StatementContextBase<?, ?, ?> findCtxOfNodeInRoot(final StatementContextBase<?, ?, ?> rootStmtCtx,
final SchemaNodeIdentifier node) {
return findCtxOfNodeInSubstatements(rootStmtCtx, node.getPathFromRoot());
}
Code Review / yangtools.git / blobdiff