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=442c7fdcfa9207ba4a36af78ed017def56546b9c;hb=5310106cd4db53a3033a085ff95545d4a2841db4;hp=48131623a15d624ca8715877ee1b1f244ac5eafc;hpb=beaf8f16074af36d2e822bbd3fc60d7a5ca66b98;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 48131623a1..442c7fdcfa 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 @@ -9,225 +9,651 @@ package org.opendaylight.yangtools.yang.parser.stmt.rfc6020; import static org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils.firstAttributeOf; -import java.net.URI; -import java.net.URISyntaxException; +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.ImmutableList; +import com.google.common.collect.ImmutableMap; +import com.google.common.collect.ImmutableMap.Builder; +import com.google.common.collect.ImmutableSet; +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.Iterator; -import java.util.LinkedList; +import java.util.HashSet; import java.util.List; - +import java.util.Map; +import java.util.Set; +import java.util.regex.Matcher; +import java.util.regex.Pattern; +import java.util.regex.PatternSyntaxException; import javax.annotation.Nullable; import javax.xml.xpath.XPath; import javax.xml.xpath.XPathExpressionException; import javax.xml.xpath.XPathFactory; - import org.antlr.v4.runtime.tree.TerminalNode; 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.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.SchemaPath; +import org.opendaylight.yangtools.yang.model.api.RevisionAwareXPath; +import org.opendaylight.yangtools.yang.model.api.Rfc6020Mapping; +import org.opendaylight.yangtools.yang.model.api.Status; import org.opendaylight.yangtools.yang.model.api.stmt.BelongsToStatement; import org.opendaylight.yangtools.yang.model.api.stmt.ModuleStatement; -import org.opendaylight.yangtools.yang.model.api.stmt.PrefixStatement; +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.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; import org.opendaylight.yangtools.yang.parser.spi.source.ImpPrefixToModuleIdentifier; +import org.opendaylight.yangtools.yang.parser.spi.source.ModuleCtxToModuleQName; import org.opendaylight.yangtools.yang.parser.spi.source.ModuleIdentifierToModuleQName; 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.source.SourceException; import org.opendaylight.yangtools.yang.parser.stmt.reactor.StatementContextBase; - -import com.google.common.base.CharMatcher; -import com.google.common.base.Splitter; import org.slf4j.Logger; import org.slf4j.LoggerFactory; public final class Utils { + private static final int UNICODE_SCRIPT_FIX_COUNTER = 30; + private static final Logger LOG = LoggerFactory.getLogger(Utils.class); + 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 Pattern BETWEEN_CURLY_BRACES_PATTERN = Pattern.compile("\\{(.+?)\\}"); + private static final Set JAVA_UNICODE_BLOCKS = ImmutableSet.builder() + .add("AegeanNumbers") + .add("AlchemicalSymbols") + .add("AlphabeticPresentationForms") + .add("AncientGreekMusicalNotation") + .add("AncientGreekNumbers") + .add("AncientSymbols") + .add("Arabic") + .add("ArabicPresentationForms-A") + .add("ArabicPresentationForms-B") + .add("ArabicSupplement") + .add("Armenian") + .add("Arrows") + .add("Avestan") + .add("Balinese") + .add("Bamum") + .add("BamumSupplement") + .add("BasicLatin") + .add("Batak") + .add("Bengali") + .add("BlockElements") + .add("Bopomofo") + .add("BopomofoExtended") + .add("BoxDrawing") + .add("Brahmi") + .add("BraillePatterns") + .add("Buginese") + .add("Buhid") + .add("ByzantineMusicalSymbols") + .add("Carian") + .add("Cham") + .add("Cherokee") + .add("CJKCompatibility") + .add("CJKCompatibilityForms") + .add("CJKCompatibilityIdeographs") + .add("CJKCompatibilityIdeographsSupplement") + .add("CJKRadicalsSupplement") + .add("CJKStrokes") + .add("CJKSymbolsandPunctuation") + .add("CJKUnifiedIdeographs") + .add("CJKUnifiedIdeographsExtensionA") + .add("CJKUnifiedIdeographsExtensionB") + .add("CJKUnifiedIdeographsExtensionC") + .add("CJKUnifiedIdeographsExtensionD") + .add("CombiningDiacriticalMarks") + .add("CombiningDiacriticalMarksSupplement") + .add("CombiningHalfMarks") + .add("CombiningDiacriticalMarksforSymbols") + .add("CommonIndicNumberForms") + .add("ControlPictures") + .add("Coptic") + .add("CountingRodNumerals") + .add("Cuneiform") + .add("CuneiformNumbersandPunctuation") + .add("CurrencySymbols") + .add("CypriotSyllabary") + .add("Cyrillic") + .add("CyrillicExtended-A") + .add("CyrillicExtended-B") + .add("CyrillicSupplementary") + .add("Deseret") + .add("Devanagari") + .add("DevanagariExtended") + .add("Dingbats") + .add("DominoTiles") + .add("EgyptianHieroglyphs") + .add("Emoticons") + .add("EnclosedAlphanumericSupplement") + .add("EnclosedAlphanumerics") + .add("EnclosedCJKLettersandMonths") + .add("EnclosedIdeographicSupplement") + .add("Ethiopic") + .add("EthiopicExtended") + .add("EthiopicExtended-A") + .add("EthiopicSupplement") + .add("GeneralPunctuation") + .add("GeometricShapes") + .add("Georgian") + .add("GeorgianSupplement") + .add("Glagolitic") + .add("Gothic") + .add("GreekandCoptic") + .add("GreekExtended") + .add("Gujarati") + .add("Gurmukhi") + .add("HalfwidthandFullwidthForms") + .add("HangulCompatibilityJamo") + .add("HangulJamo") + .add("HangulJamoExtended-A") + .add("HangulJamoExtended-B") + .add("HangulSyllables") + .add("Hanunoo") + .add("Hebrew") + .add("HighPrivateUseSurrogates") + .add("HighSurrogates") + .add("Hiragana") + .add("IdeographicDescriptionCharacters") + .add("ImperialAramaic") + .add("InscriptionalPahlavi") + .add("InscriptionalParthian") + .add("IPAExtensions") + .add("Javanese") + .add("Kaithi") + .add("KanaSupplement") + .add("Kanbun") + .add("Kangxi Radicals") + .add("Kannada") + .add("Katakana") + .add("KatakanaPhoneticExtensions") + .add("KayahLi") + .add("Kharoshthi") + .add("Khmer") + .add("KhmerSymbols") + .add("Lao") + .add("Latin-1Supplement") + .add("LatinExtended-A") + .add("LatinExtendedAdditional") + .add("LatinExtended-B") + .add("LatinExtended-C") + .add("LatinExtended-D") + .add("Lepcha") + .add("LetterlikeSymbols") + .add("Limbu") + .add("LinearBIdeograms") + .add("LinearBSyllabary") + .add("Lisu") + .add("LowSurrogates") + .add("Lycian") + .add("Lydian") + .add("MahjongTiles") + .add("Malayalam") + .add("Mandaic") + .add("MathematicalAlphanumericSymbols") + .add("MathematicalOperators") + .add("MeeteiMayek") + .add("MiscellaneousMathematicalSymbols-A") + .add("MiscellaneousMathematicalSymbols-B") + .add("MiscellaneousSymbols") + .add("MiscellaneousSymbolsandArrows") + .add("MiscellaneousSymbolsAndPictographs") + .add("MiscellaneousTechnical") + .add("ModifierToneLetters") + .add("Mongolian") + .add("MusicalSymbols") + .add("Myanmar") + .add("MyanmarExtended-A") + .add("NewTaiLue") + .add("NKo") + .add("NumberForms") + .add("Ogham") + .add("OlChiki") + .add("OldItalic") + .add("OldPersian") + .add("OldSouthArabian") + .add("OldTurkic") + .add("OpticalCharacterRecognition") + .add("Oriya") + .add("Osmanya") + .add("Phags-pa") + .add("PhaistosDisc") + .add("Phoenician") + .add("PhoneticExtensions") + .add("PhoneticExtensionsSupplement") + .add("PlayingCards") + .add("PrivateUseArea") + .add("Rejang") + .add("RumiNumeralSymbols") + .add("Runic") + .add("Samaritan") + .add("Saurashtra") + .add("Shavian") + .add("Sinhala") + .add("SmallFormVariants") + .add("SpacingModifierLetters") + .add("Specials") + .add("Sundanese") + .add("SuperscriptsandSubscripts") + .add("SupplementalArrows-A") + .add("SupplementalArrows-B") + .add("SupplementalMathematicalOperators") + .add("SupplementalPunctuation") + .add("SupplementaryPrivateUseArea-A") + .add("SupplementaryPrivateUseArea-B") + .add("SylotiNagri") + .add("Syriac") + .add("Tagalog") + .add("Tagbanwa") + .add("Tags") + .add("TaiLe") + .add("TaiTham") + .add("TaiViet") + .add("TaiXuanJingSymbols") + .add("Tamil") + .add("Telugu") + .add("Thaana") + .add("Thai") + .add("Tibetan") + .add("Tifinagh") + .add("TransportAndMapSymbols") + .add("Ugaritic") + .add("UnifiedCanadianAboriginalSyllabics") + .add("UnifiedCanadianAboriginalSyllabicsExtended") + .add("Vai") + .add("VariationSelectors") + .add("VariationSelectorsSupplement") + .add("VedicExtensions") + .add("VerticalForms") + .add("YiRadicals") + .add("YiSyllables") + .add("YijingHexagramSymbols").build(); + + private static final Map KEYWORD_TO_DEVIATE_MAP; + static { + final Builder keywordToDeviateMapBuilder = ImmutableMap.builder(); + for (final 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() { + return XPathFactory.newInstance(); + } + }; private Utils() { + throw new UnsupportedOperationException(); } - 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('\''); + /** + * Cleanup any resources attached to the current thread. Threads interacting with this class can cause thread-local + * caches to them. Invoke this method if you want to detach those resources. + */ + public static void detachFromCurrentThread() { + XPATH_FACTORY.remove(); + } - private static final char SEPARATOR_NODENAME = '/'; + public static Collection transformKeysStringToKeyNodes(final StmtContext ctx, + final String value) { + final List keyTokens = SPACE_SPLITTER.splitToList(value); - private static final String REGEX_PATH_ABS = "/[^/].+"; + // to detect if key contains duplicates + if ((new HashSet<>(keyTokens)).size() < keyTokens.size()) { + // FIXME: report all duplicate keys + throw new SourceException(ctx.getStatementSourceReference(), "Duplicate value in list key: %s", value); + } - public static List splitPathToNodeNames(String path) { + final Set keyNodes = new HashSet<>(); - Splitter keySplitter = Splitter.on(SEPARATOR_NODENAME).omitEmptyStrings().trimResults(); - return keySplitter.splitToList(path); + for (final String keyToken : keyTokens) { + + final SchemaNodeIdentifier.Relative keyNode = (Relative) SchemaNodeIdentifier.Relative.create(false, + Utils.qNameFromArgument(ctx, keyToken)); + keyNodes.add(keyNode); + } + + return keyNodes; } - public static void validateXPath(String path) { + private static String trimSingleLastSlashFromXPath(final String path) { + return path.endsWith("/") ? path.substring(0, path.length() - 1) : path; + } - final XPath xPath = XPathFactory.newInstance().newXPath(); + static RevisionAwareXPath parseXPath(final StmtContext ctx, final String path) { + final XPath xPath = XPATH_FACTORY.get().newXPath(); + xPath.setNamespaceContext(StmtNamespaceContext.create(ctx)); + final String trimmed = trimSingleLastSlashFromXPath(path); try { - xPath.compile(path); - } catch (XPathExpressionException e) { - throw new IllegalArgumentException("Argument is not valid XPath string", e); + // TODO: we could capture the result and expose its 'evaluate' method + xPath.compile(trimmed); + } catch (final XPathExpressionException e) { + LOG.warn("Argument \"{}\" is not valid XPath string at \"{}\"", path, ctx.getStatementSourceReference(), e); } + + return new RevisionAwareXPathImpl(path, PATH_ABS.matcher(path).matches()); } - public static boolean isXPathAbsolute(String path) { + public static QName trimPrefix(final QName identifier) { + final String prefixedLocalName = identifier.getLocalName(); + final String[] namesParts = prefixedLocalName.split(":"); - validateXPath(path); + if (namesParts.length == 2) { + final String localName = namesParts[1]; + return QName.create(identifier.getModule(), localName); + } - return path.matches(REGEX_PATH_ABS); + return identifier; } - public static Iterable parseXPath(StmtContext ctx, String path) { - - validateXPath(path); - - List nodeNames = splitPathToNodeNames(path); - List qNames = new ArrayList<>(); + /** + * + * 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 stmtDef.get(identifier).getStatementName(); + } else { + final String prefixedLocalName = identifier.getLocalName(); + final String[] namesParts = prefixedLocalName.split(":"); + + if (namesParts.length == 2) { + final String prefix = namesParts[0]; + final String localName = namesParts[1]; + if (prefixes != null && prefixes.get(prefix) != null + && stmtDef.get(QName.create(prefixes.get(prefix), localName)) != null) { + return QName.create(prefixes.get(prefix), localName); + } + } + } + return null; + } - for (String nodeName : nodeNames) { + static SchemaNodeIdentifier nodeIdentifierFromPath(final StmtContext ctx, final String path) { + // FIXME: is the path trimming really necessary?? + final List qNames = new ArrayList<>(); + for (final String nodeName : SLASH_SPLITTER.split(trimSingleLastSlashFromXPath(path))) { try { final QName qName = Utils.qNameFromArgument(ctx, nodeName); qNames.add(qName); - } catch (Exception e) { - throw new IllegalArgumentException(e); + } catch (final Exception e) { + throw new IllegalArgumentException( + String.format("Failed to parse node '%s' in path '%s'", nodeName, path), e); } } - return qNames; + return SchemaNodeIdentifier.create(qNames, PATH_ABS.matcher(path).matches()); } public static String stringFromStringContext(final YangStatementParser.ArgumentContext context) { - StringBuilder sb = new StringBuilder(); + final StringBuilder sb = new StringBuilder(); List strings = context.STRING(); - if (strings.size() == 0) { + if (strings.isEmpty()) { strings = Arrays.asList(context.IDENTIFIER()); } - for (TerminalNode stringNode : strings) { + for (final TerminalNode stringNode : strings) { final String str = stringNode.getText(); - char firstChar = str.charAt(0); - final CharMatcher quoteMatcher; - if (SINGLE_QUOTE_MATCHER.matches(firstChar)) { - quoteMatcher = SINGLE_QUOTE_MATCHER; - } else if (DOUBLE_QUOTE_MATCHER.matches(firstChar)) { - quoteMatcher = DOUBLE_QUOTE_MATCHER; + final char firstChar = str.charAt(0); + final char lastChar = str.charAt(str.length() - 1); + if (firstChar == '"' && lastChar == '"') { + final String innerStr = str.substring(1, str.length() - 1); + /* + * Unescape escaped double quotes, tabs, new line and backslash + * in the inner string and trim the result. + */ + sb.append(innerStr.replace("\\\"", "\"").replace("\\\\", "\\").replace("\\n", "\n") + .replace("\\t", "\t")); + } else if (firstChar == '\'' && lastChar == '\'') { + /* + * According to RFC6020 a single quote character cannot occur in + * a single-quoted string, even when preceded by a backslash. + */ + sb.append(str.substring(1, str.length() - 1)); } else { sb.append(str); - continue; } - sb.append(quoteMatcher.removeFrom(str.substring(1, str.length() - 1))); } return sb.toString(); } - public static QName qNameFromArgument(StmtContext ctx, String value) { + public static QName qNameFromArgument(StmtContext ctx, final String value) { + if (Strings.isNullOrEmpty(value)) { + return ctx.getPublicDefinition().getStatementName(); + } - String prefix = null; + String prefix; QNameModule qNameModule = null; - try { - qNameModule = QNameModule.create(new URI(""), new Date(0)); - } catch (URISyntaxException e) { - LOG.warn(e.getMessage(), e); - } String localName = null; - String[] namesParts = value.split(":"); + final String[] namesParts = value.split(":"); switch (namesParts.length) { case 1: localName = namesParts[0]; - - if (StmtContextUtils.producesDeclared(ctx.getRoot(), ModuleStatement.class)) { - prefix = firstAttributeOf(ctx.getRoot().declaredSubstatements(), PrefixStatement.class); - qNameModule = ctx.getFromNamespace(PrefixToModule.class, prefix); - - } else if (StmtContextUtils.producesDeclared(ctx.getRoot(), SubmoduleStatement.class)) { - String belongsToModuleName = firstAttributeOf(ctx.getRoot().declaredSubstatements(), - BelongsToStatement.class); - qNameModule = ctx.getFromNamespace(ModuleNameToModuleQName.class, belongsToModuleName); - } + qNameModule = getRootModuleQName(ctx); break; - case 2: + default: prefix = namesParts[0]; localName = namesParts[1]; + qNameModule = getModuleQNameByPrefix(ctx, prefix); + // in case of unknown statement argument, we're not going to parse it + if (qNameModule == null + && ctx.getPublicDefinition().getDeclaredRepresentationClass() + .isAssignableFrom(UnknownStatementImpl.class)) { + localName = value; + qNameModule = getRootModuleQName(ctx); + } + if (qNameModule == null + && Iterables.getLast(ctx.getCopyHistory()) == StmtContext.TypeOfCopy.ADDED_BY_AUGMENTATION) { + ctx = ctx.getOriginalCtx(); + qNameModule = getModuleQNameByPrefix(ctx, prefix); + } + break; + } - ModuleIdentifier impModIdentifier = ctx.getRoot().getFromNamespace(ImpPrefixToModuleIdentifier.class, - prefix); - qNameModule = ctx.getFromNamespace(ModuleIdentifierToModuleQName.class, impModIdentifier); + 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; + } - 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(QNameCacheNamespace.class, QName.create(resultQNameModule, localName)); + } - break; - default: - break; + public static QNameModule getModuleQNameByPrefix(final StmtContext ctx, final String prefix) { + 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)) { + final String moduleName = ctx.getRoot().getFromNamespace(BelongsToPrefixToModuleName.class, prefix); + return ctx.getFromNamespace(ModuleNameToModuleQName.class, moduleName); + } + return qNameModule; + } + + public static QNameModule getRootModuleQName(final StmtContext ctx) { + if (ctx == null) { + return null; } - return QName.create(qNameModule, localName); + 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)) { + final String belongsToModuleName = firstAttributeOf(rootCtx.substatements(), BelongsToStatement.class); + qNameModule = rootCtx.getFromNamespace(ModuleNameToModuleQName.class, belongsToModuleName); + } else { + qNameModule = null; + } + + 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 - public static StatementContextBase findCtxOfNodeInRoot(StatementContextBase rootStmtCtx, + public static StatementContextBase findNode(final StmtContext rootStmtCtx, final SchemaNodeIdentifier node) { + return (StatementContextBase) rootStmtCtx.getFromNamespace(SchemaNodeIdentifierBuildNamespace.class, node); + } - StatementContextBase parent = rootStmtCtx; - final Iterator pathIter = node.getPathFromRoot().iterator(); - - QName targetNode = pathIter.next(); + public static boolean isUnknownNode(final StmtContext stmtCtx) { + return stmtCtx.getPublicDefinition().getDeclaredRepresentationClass() + .isAssignableFrom(UnknownStatementImpl.class); + } - while (pathIter.hasNext()) { + 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()); + } - for (StatementContextBase child : parent.declaredSubstatements()) { + public static Status parseStatus(final String value) { + switch (value) { + case "current": + return Status.CURRENT; + case "deprecated": + return Status.DEPRECATED; + case "obsolete": + return Status.OBSOLETE; + default: + LOG.warn("Invalid 'status' statement: {}", value); + return null; + } + } - if (targetNode.equals(child.getStatementArgument())) { - parent = child; - targetNode = pathIter.next(); + public static Date getLatestRevision(final Iterable> subStmts) { + Date revision = null; + for (final StmtContext subStmt : subStmts) { + if (subStmt.getPublicDefinition().getDeclaredRepresentationClass().isAssignableFrom(RevisionStatement + .class)) { + if (revision == null && subStmt.getStatementArgument() != null) { + revision = (Date) subStmt.getStatementArgument(); + } else if (subStmt.getStatementArgument() != null && ((Date) subStmt.getStatementArgument()).compareTo + (revision) > 0) { + revision = (Date) subStmt.getStatementArgument(); } } - - if (parent.equals(rootStmtCtx)) { - - return null; - } } + return revision; + } - StatementContextBase targetCtx = null; + 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); + } - for (StatementContextBase child : parent.declaredSubstatements()) { + /** + * 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; + } - if (targetNode.equals(child.getStatementArgument())) { - targetCtx = child; + public static String fixUnicodeScriptPattern(String rawPattern) { + for (int i = 0; i < UNICODE_SCRIPT_FIX_COUNTER; i++) { + try { + Pattern.compile(rawPattern); + return rawPattern; + } catch(final PatternSyntaxException ex) { + LOG.debug("Invalid regex pattern syntax in: {}", rawPattern, ex); + if (ex.getMessage().contains("Unknown character script name")) { + rawPattern = fixUnknownScripts(ex.getMessage(), rawPattern); + } else { + return rawPattern; + } } } - return targetCtx; + LOG.warn("Regex pattern could not be fixed: {}", rawPattern); + return rawPattern; } - public static SchemaPath getSchemaPath(StmtContext ctx) { + private static String fixUnknownScripts(final String exMessage, final String rawPattern) { + StringBuilder result = new StringBuilder(rawPattern); + final Matcher matcher = BETWEEN_CURLY_BRACES_PATTERN.matcher(exMessage); + if (matcher.find()) { + final String capturedGroup = matcher.group(1); + if (JAVA_UNICODE_BLOCKS.contains(capturedGroup)) { + final int idx = rawPattern.indexOf("Is" + capturedGroup); + result = result.replace(idx, idx + 2, "In"); + } + } + return result.toString(); + } - Iterator argumentsIterator = ctx.getArgumentsFromRoot().iterator(); - argumentsIterator.next(); // skip root argument + public static boolean belongsToTheSameModule(final QName targetStmtQName, final QName sourceStmtQName) { + if (targetStmtQName.getModule().equals(sourceStmtQName.getModule())) { + return true; + } + return false; + } - List qNamesFromRoot = new LinkedList<>(); + public static boolean isPresenceContainer(final StatementContextBase targetCtx) { + if (!targetCtx.getPublicDefinition().equals(Rfc6020Mapping.CONTAINER)) { + return false; + } - while (argumentsIterator.hasNext()) { - Object argument = argumentsIterator.next(); - if (argument instanceof QName) { - QName qname = (QName) argument; - qNamesFromRoot.add(qname); - } else { - return SchemaPath.SAME; + final List> targetSubStatements = new ImmutableList.Builder>() + .addAll(targetCtx.declaredSubstatements()).addAll(targetCtx.effectiveSubstatements()).build(); + for (final StatementContextBase subStatement : targetSubStatements) { + if (subStatement.getPublicDefinition().equals(Rfc6020Mapping.PRESENCE)) { + return true; } } - return SchemaPath.create(qNamesFromRoot, true); + return false; } }