X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=yang%2Fyang-parser-impl%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fyangtools%2Fyang%2Fparser%2Fstmt%2Frfc6020%2FUtils.java;h=3123445b478574bee0f9ac12a10eed0f48218abf;hb=04fa25a4fe8957f6492618aa9a1e9a4f9af39df4;hp=806857fabfa3e04637cbe79ff997bbd9cb14695a;hpb=ae9af9e65c08648c6308184ce3c8c8273e2b5c25;p=yangtools.git diff --git a/yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/stmt/rfc6020/Utils.java b/yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/stmt/rfc6020/Utils.java index 806857fabf..3123445b47 100644 --- a/yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/stmt/rfc6020/Utils.java +++ b/yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/stmt/rfc6020/Utils.java @@ -12,16 +12,16 @@ import com.google.common.base.CharMatcher; import com.google.common.base.Preconditions; import com.google.common.base.Splitter; import com.google.common.base.Strings; +import com.google.common.collect.ImmutableMap; +import com.google.common.collect.ImmutableMap.Builder; import com.google.common.collect.Iterables; import java.util.ArrayList; import java.util.Arrays; import java.util.Collection; import java.util.Date; import java.util.HashSet; -import java.util.Iterator; -import java.util.LinkedList; import java.util.List; -import java.util.Objects; +import java.util.Map; import java.util.Set; import java.util.regex.Pattern; import javax.annotation.Nullable; @@ -33,23 +33,19 @@ import org.opendaylight.yangtools.antlrv4.code.gen.YangStatementParser; import org.opendaylight.yangtools.yang.common.QName; import org.opendaylight.yangtools.yang.common.QNameModule; import org.opendaylight.yangtools.yang.common.SimpleDateFormatUtil; -import org.opendaylight.yangtools.yang.common.YangConstants; import org.opendaylight.yangtools.yang.model.api.Deviation; +import org.opendaylight.yangtools.yang.model.api.Deviation.Deviate; import org.opendaylight.yangtools.yang.model.api.ModuleIdentifier; import org.opendaylight.yangtools.yang.model.api.RevisionAwareXPath; -import org.opendaylight.yangtools.yang.model.api.SchemaPath; import org.opendaylight.yangtools.yang.model.api.Status; -import org.opendaylight.yangtools.yang.model.api.stmt.AugmentStatement; import org.opendaylight.yangtools.yang.model.api.stmt.BelongsToStatement; -import org.opendaylight.yangtools.yang.model.api.stmt.ChoiceStatement; import org.opendaylight.yangtools.yang.model.api.stmt.ModuleStatement; -import org.opendaylight.yangtools.yang.model.api.stmt.RefineStatement; import org.opendaylight.yangtools.yang.model.api.stmt.RevisionStatement; import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier; import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier.Relative; import org.opendaylight.yangtools.yang.model.api.stmt.SubmoduleStatement; -import org.opendaylight.yangtools.yang.model.api.stmt.UsesStatement; import org.opendaylight.yangtools.yang.model.util.RevisionAwareXPathImpl; +import org.opendaylight.yangtools.yang.parser.spi.meta.QNameCacheNamespace; import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext; import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils; import org.opendaylight.yangtools.yang.parser.spi.source.BelongsToPrefixToModuleName; @@ -59,22 +55,32 @@ import org.opendaylight.yangtools.yang.parser.spi.source.ModuleIdentifierToModul import org.opendaylight.yangtools.yang.parser.spi.source.ModuleNameToModuleQName; import org.opendaylight.yangtools.yang.parser.spi.source.PrefixToModule; import org.opendaylight.yangtools.yang.parser.spi.source.QNameToStatementDefinition; -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.RootStatementContext; +import org.opendaylight.yangtools.yang.parser.spi.source.SourceException; import org.opendaylight.yangtools.yang.parser.stmt.reactor.StatementContextBase; import org.slf4j.Logger; import org.slf4j.LoggerFactory; public final class Utils { - private static final Logger LOG = LoggerFactory.getLogger(Utils.class); private static final CharMatcher DOUBLE_QUOTE_MATCHER = CharMatcher.is('"'); private static final CharMatcher SINGLE_QUOTE_MATCHER = CharMatcher.is('\''); + private static final CharMatcher LEFT_PARENTHESIS_MATCHER = CharMatcher.is('('); + private static final CharMatcher RIGHT_PARENTHESIS_MATCHER = CharMatcher.is(')'); + private static final CharMatcher AMPERSAND_MATCHER = CharMatcher.is('&'); + private static final CharMatcher QUESTION_MARK_MATCHER = CharMatcher.is('?'); private static final Splitter SLASH_SPLITTER = Splitter.on('/').omitEmptyStrings().trimResults(); private static final Splitter SPACE_SPLITTER = Splitter.on(' ').omitEmptyStrings().trimResults(); private static final Pattern PATH_ABS = Pattern.compile("/[^/].*"); + private static final Map KEYWORD_TO_DEVIATE_MAP; + static { + Builder keywordToDeviateMapBuilder = ImmutableMap.builder(); + for (Deviate deviate : Deviation.Deviate.values()) { + keywordToDeviateMapBuilder.put(deviate.getKeyword(), deviate); + } + KEYWORD_TO_DEVIATE_MAP = keywordToDeviateMapBuilder.build(); + } + private static final ThreadLocal XPATH_FACTORY = new ThreadLocal() { @Override protected XPathFactory initialValue() { @@ -101,7 +107,7 @@ public final class Utils { // to detect if key contains duplicates if ((new HashSet<>(keyTokens)).size() < keyTokens.size()) { // FIXME: report all duplicate keys - throw new IllegalArgumentException(); + throw new SourceException(ctx.getStatementSourceReference(), "Duplicate value in list key: %s", value); } Set keyNodes = new HashSet<>(); @@ -117,7 +123,7 @@ public final class Utils { } private static String trimSingleLastSlashFromXPath(final String path) { - return path.replaceAll("/$", ""); + return path.endsWith("/") ? path.substring(0, path.length() - 1) : path; } static RevisionAwareXPath parseXPath(final StmtContext ctx, final String path) { @@ -147,18 +153,22 @@ public final class Utils { return identifier; } - public static String getPrefixFromArgument(final String prefixedLocalName) { - String[] namesParts = prefixedLocalName.split(":"); - if (namesParts.length == 2) { - return namesParts[0]; - } - return null; - } - - public static boolean isValidStatementDefinition(final PrefixToModule prefixes, final QNameToStatementDefinition stmtDef, - final QName identifier) { + /** + * + * Based on identifier read from source and collections of relevant prefixes and statement definitions mappings + * provided for actual phase, method resolves and returns valid QName for declared statement to be written. + * This applies to any declared statement, including unknown statements. + * + * @param prefixes - collection of all relevant prefix mappings supplied for actual parsing phase + * @param stmtDef - collection of all relevant statement definition mappings provided for actual parsing phase + * @param identifier - statement to parse from source + * @return valid QName for declared statement to be written + * + */ + public static QName getValidStatementDefinition(final PrefixToModule prefixes, final QNameToStatementDefinition + stmtDef, final QName identifier) { if (stmtDef.get(identifier) != null) { - return true; + return stmtDef.get(identifier).getStatementName(); } else { String prefixedLocalName = identifier.getLocalName(); String[] namesParts = prefixedLocalName.split(":"); @@ -167,16 +177,12 @@ public final class Utils { String prefix = namesParts[0]; String localName = namesParts[1]; if (prefixes != null && prefixes.get(prefix) != null - && stmtDef.get(QName.create(YangConstants.RFC6020_YIN_MODULE, localName)) != null) { - return true; - } else { - if (stmtDef.get(QName.create(YangConstants.RFC6020_YIN_MODULE, localName)) != null) { - return true; - } + && stmtDef.get(QName.create(prefixes.get(prefix), localName)) != null) { + return QName.create(prefixes.get(prefix), localName); } } } - return false; + return null; } static SchemaNodeIdentifier nodeIdentifierFromPath(final StmtContext ctx, final String path) { @@ -252,46 +258,54 @@ public final class Utils { break; } - Preconditions.checkArgument(qNameModule != null, "Error in module '%s': can not resolve QNameModule for '%s'.", - ctx.getRoot().rawStatementArgument(), value); - - QNameModule resultQNameModule = qNameModule.getRevision() == null ? QNameModule.create( - qNameModule.getNamespace(), SimpleDateFormatUtil.DEFAULT_DATE_REV) : qNameModule; + Preconditions.checkArgument(qNameModule != null, + "Error in module '%s': can not resolve QNameModule for '%s'. Statement source at %s", + ctx.getRoot().rawStatementArgument(), value, ctx.getStatementSourceReference()); + final QNameModule resultQNameModule; + if (qNameModule.getRevision() == null) { + resultQNameModule = QNameModule.create(qNameModule.getNamespace(), SimpleDateFormatUtil.DEFAULT_DATE_REV) + .intern(); + } else { + resultQNameModule = qNameModule; + } - return QName.create(resultQNameModule, localName); + return ctx.getFromNamespace(QNameCacheNamespace.class, QName.create(resultQNameModule, localName)); } public static QNameModule getModuleQNameByPrefix(final StmtContext ctx, final String prefix) { - QNameModule qNameModule; - ModuleIdentifier impModIdentifier = ctx.getRoot().getFromNamespace(ImpPrefixToModuleIdentifier.class, prefix); - qNameModule = ctx.getFromNamespace(ModuleIdentifierToModuleQName.class, impModIdentifier); + final ModuleIdentifier modId = ctx.getRoot().getFromNamespace(ImpPrefixToModuleIdentifier.class, prefix); + final QNameModule qNameModule = ctx.getFromNamespace(ModuleIdentifierToModuleQName.class, modId); if (qNameModule == null && StmtContextUtils.producesDeclared(ctx.getRoot(), SubmoduleStatement.class)) { String moduleName = ctx.getRoot().getFromNamespace(BelongsToPrefixToModuleName.class, prefix); - qNameModule = ctx.getFromNamespace(ModuleNameToModuleQName.class, moduleName); + return ctx.getFromNamespace(ModuleNameToModuleQName.class, moduleName); } return qNameModule; } public static QNameModule getRootModuleQName(final StmtContext ctx) { - if (ctx == null) { return null; } - StmtContext rootCtx = ctx.getRoot(); - QNameModule qNameModule = null; + final StmtContext rootCtx = ctx.getRoot(); + final QNameModule qNameModule; if (StmtContextUtils.producesDeclared(rootCtx, ModuleStatement.class)) { qNameModule = rootCtx.getFromNamespace(ModuleCtxToModuleQName.class, rootCtx); } else if (StmtContextUtils.producesDeclared(rootCtx, SubmoduleStatement.class)) { - String belongsToModuleName = firstAttributeOf(rootCtx.substatements(), - BelongsToStatement.class); + final String belongsToModuleName = firstAttributeOf(rootCtx.substatements(), BelongsToStatement.class); qNameModule = rootCtx.getFromNamespace(ModuleNameToModuleQName.class, belongsToModuleName); + } else { + qNameModule = null; } - return qNameModule.getRevision() == null ? QNameModule.create(qNameModule.getNamespace(), - SimpleDateFormatUtil.DEFAULT_DATE_REV) : qNameModule; + Preconditions.checkArgument(qNameModule != null, "Failed to look up root QNameModule for %s", ctx); + if (qNameModule.getRevision() != null) { + return qNameModule; + } + + return QNameModule.create(qNameModule.getNamespace(), SimpleDateFormatUtil.DEFAULT_DATE_REV).intern(); } @Nullable @@ -300,113 +314,29 @@ public final class Utils { return (StatementContextBase) rootStmtCtx.getFromNamespace(SchemaNodeIdentifierBuildNamespace.class, node); } - public static SchemaPath getSchemaPath(final StmtContext ctx) { - - if (ctx == null) { - return null; - } - - final Iterator> iteratorFromRoot = ctx.getStmtContextsFromRoot().iterator(); - // skip root argument - if (iteratorFromRoot.hasNext()) { - iteratorFromRoot.next(); - } - - List qNamesFromRoot = new LinkedList<>(); - while (iteratorFromRoot.hasNext()) { - StmtContext nextStmtCtx = iteratorFromRoot.next(); - Object nextStmtArgument = nextStmtCtx.getStatementArgument(); - if (nextStmtArgument instanceof QName) { - QName qname = (QName) nextStmtArgument; - if (StmtContextUtils.producesDeclared(nextStmtCtx, UsesStatement.class)) { - continue; - } - if (StmtContextUtils.producesDeclared(nextStmtCtx.getParentContext(), ChoiceStatement.class) - && isSupportedAsShorthandCase(nextStmtCtx)) { - qNamesFromRoot.add(qname); - } - qNamesFromRoot.add(qname); - } else if (nextStmtArgument instanceof String) { - // FIXME: This may yield illegal argument exceptions - StatementContextBase originalCtx = ctx - .getOriginalCtx(); - final QName qName = (originalCtx != null) ? qNameFromArgument( - originalCtx, (String) nextStmtArgument) - : qNameFromArgument(ctx, (String) nextStmtArgument); - qNamesFromRoot.add(qName); - } else if ((StmtContextUtils.producesDeclared(nextStmtCtx, AugmentStatement.class) - || StmtContextUtils.producesDeclared(nextStmtCtx, RefineStatement.class)) - && nextStmtArgument instanceof SchemaNodeIdentifier) { - addQNamesFromSchemaNodeIdentifierToList(qNamesFromRoot, (SchemaNodeIdentifier) nextStmtArgument); - } else if (isUnknownNode(nextStmtCtx)) { - qNamesFromRoot.add(nextStmtCtx.getPublicDefinition().getStatementName()); - } else { - return SchemaPath.SAME; - } - } - - final SchemaPath schemaPath = SchemaPath.create(qNamesFromRoot, true); - return schemaPath; - } - public static boolean isUnknownNode(final StmtContext stmtCtx) { return stmtCtx.getPublicDefinition().getDeclaredRepresentationClass() .isAssignableFrom(UnknownStatementImpl.class); } - private static boolean isSupportedAsShorthandCase(final StmtContext statementCtx) { - - Collection supportedCaseShorthands = statementCtx.getFromNamespace(ValidationBundlesNamespace.class, - ValidationBundleType.SUPPORTED_CASE_SHORTHANDS); - - return supportedCaseShorthands == null || supportedCaseShorthands.contains(statementCtx.getPublicDefinition()); - } - - private static void addQNamesFromSchemaNodeIdentifierToList(final List qNamesFromRoot, - final SchemaNodeIdentifier augmentTargetPath) { - for (QName qname : augmentTargetPath.getPathFromRoot()) { - qNamesFromRoot.add(qname); - } - } - - public static Deviation.Deviate parseDeviateFromString(final String deviate) { - - // Yang constants should be lowercase so we have throw if value does not - // suit this - String deviateUpper = deviate.toUpperCase(); - Preconditions.checkArgument(!Objects.equals(deviate, deviateUpper), - "String %s is not valid deviate argument", deviate); - - // but Java enum is uppercase so we cannot use lowercase here - try { - return Deviation.Deviate.valueOf(deviateUpper); - } catch (IllegalArgumentException e) { - throw new IllegalArgumentException(String.format("String %s is not valid deviate argument", deviate), e); - } + public static Deviation.Deviate parseDeviateFromString(final StmtContext ctx, final String deviateKeyword) { + return Preconditions.checkNotNull(KEYWORD_TO_DEVIATE_MAP.get(deviateKeyword), + "String '%s' is not valid deviate argument. Statement source at %s", deviateKeyword, + ctx.getStatementSourceReference()); } public static Status parseStatus(final String value) { - - Status status = null; switch (value) { case "current": - status = Status.CURRENT; - break; + return Status.CURRENT; case "deprecated": - status = Status.DEPRECATED; - break; + return Status.DEPRECATED; case "obsolete": - status = Status.OBSOLETE; - break; + return Status.OBSOLETE; default: - LOG.warn("Invalid 'status' statement: " + value); + LOG.warn("Invalid 'status' statement: {}", value); + return null; } - - return status; - } - - public static Date getLatestRevision(final RootStatementContext root) { - return getLatestRevision(root.declaredSubstatements()); } public static Date getLatestRevision(final Iterable> subStmts) { @@ -427,7 +357,24 @@ public final class Utils { public static boolean isModuleIdentifierWithoutSpecifiedRevision(final Object o) { return (o instanceof ModuleIdentifier) - && (((ModuleIdentifier) o).getRevision() == SimpleDateFormatUtil.DEFAULT_DATE_IMP || - ((ModuleIdentifier) o).getRevision() == SimpleDateFormatUtil.DEFAULT_BELONGS_TO_DATE); + && (((ModuleIdentifier) o).getRevision() == SimpleDateFormatUtil.DEFAULT_DATE_IMP || ((ModuleIdentifier) o) + .getRevision() == SimpleDateFormatUtil.DEFAULT_BELONGS_TO_DATE); + } + + /** + * Replaces illegal characters of QName by the name of the character (e.g. + * '?' is replaced by "QuestionMark" etc.). + * + * @param string + * input String + * @return result String + */ + public static String replaceIllegalCharsForQName(String string) { + string = LEFT_PARENTHESIS_MATCHER.replaceFrom(string, "LeftParenthesis"); + string = RIGHT_PARENTHESIS_MATCHER.replaceFrom(string, "RightParenthesis"); + string = AMPERSAND_MATCHER.replaceFrom(string, "Ampersand"); + string = QUESTION_MARK_MATCHER.replaceFrom(string, "QuestionMark"); + + return string; } }