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%2Fimpl%2FParserListenerUtils.java;h=fadb1a23536237d29688e11c8da6a42b340ee92f;hb=42abb28b99a02f9580f4676ce5c315628e5bcd24;hp=933ac6b6d4f17f489efb3fa878ea868bbf7bfb94;hpb=45f6ab2104c6d9c650d3c1c21f237b269f412292;p=yangtools.git diff --git a/yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/impl/ParserListenerUtils.java b/yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/impl/ParserListenerUtils.java index 933ac6b6d4..fadb1a2353 100644 --- a/yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/impl/ParserListenerUtils.java +++ b/yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/impl/ParserListenerUtils.java @@ -3,25 +3,28 @@ * * This program and the accompanying materials are made available under the * terms of the Eclipse Public License v1.0 which accompanies this distribution, - * and is available at http://www.eclipse.org/legal/eplv10.html + * and is available at http://www.eclipse.org/legal/epl-v10.html */ + package org.opendaylight.yangtools.yang.parser.impl; import static com.google.common.base.Preconditions.checkState; - import com.google.common.base.CharMatcher; import com.google.common.base.Optional; -import com.google.common.base.Preconditions; import com.google.common.base.Splitter; -import com.google.common.collect.Lists; - +import com.google.common.collect.ImmutableSet; +import com.google.common.collect.Sets; import java.math.BigDecimal; import java.math.BigInteger; import java.util.ArrayList; import java.util.Collections; import java.util.Iterator; import java.util.List; - +import java.util.Objects; +import java.util.Set; +import java.util.regex.Matcher; +import java.util.regex.Pattern; +import java.util.regex.PatternSyntaxException; import org.antlr.v4.runtime.ParserRuleContext; import org.antlr.v4.runtime.tree.ParseTree; import org.antlr.v4.runtime.tree.TerminalNode; @@ -140,12 +143,224 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; public final class ParserListenerUtils { + private static final int UNICODE_SCRIPT_FIX_COUNTER = 30; private static final Logger LOG = LoggerFactory.getLogger(ParserListenerUtils.class); private static final Splitter KEYDEF_SPLITTER = Splitter.on(' ').omitEmptyStrings(); private static final Splitter PIPE_SPLITTER = Splitter.on('|').trimResults(); private static final Splitter DOT_DOT_SPLITTER = Splitter.on("..").trimResults(); private static final CharMatcher DOUBLE_QUOTE_MATCHER = CharMatcher.is('"'); private static final CharMatcher SINGLE_QUOTE_MATCHER = CharMatcher.is('\''); + 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 ParserListenerUtils() { } @@ -183,13 +398,13 @@ public final class ParserListenerUtils { continue; } /* - * + * * It is safe not to check last argument to be same * grammars enforces that. - * + * * FIXME: Introduce proper escaping and translation of escaped * characters here. - * + * */ sb.append(quoteMatcher.removeFrom(str.substring(1, str.length()-1))); } @@ -221,7 +436,9 @@ public final class ParserListenerUtils { * context to parse * @param builder * builder to fill in with parsed statements + * @deprecated Pre-Beryllium implementation, scheduled for removal. */ + @Deprecated public static void parseSchemaNodeArgs(final ParseTree ctx, final SchemaNodeBuilder builder) { for (int i = 0; i < ctx.getChildCount(); i++) { final ParseTree child = ctx.getChild(i); @@ -306,15 +523,15 @@ public final class ParserListenerUtils { } /** - * Create java.util.List of key node names. + * Create java.util.LinkedHashSet of key node names. * * @param ctx * Key_stmtContext context - * @return YANG list key as java.util.List of key node names + * @return YANG list key as java.util.LinkedHashSet of key node names */ - public static List createListKey(final Key_stmtContext ctx) { - String keyDefinition = stringFromNode(ctx); - return Lists.newArrayList(KEYDEF_SPLITTER.split(keyDefinition)); + public static Set createListKey(final Key_stmtContext ctx) { + final String keyDefinition = stringFromNode(ctx); + return Sets.newLinkedHashSet(KEYDEF_SPLITTER.split(keyDefinition)); } /** @@ -378,7 +595,15 @@ public final class ParserListenerUtils { ParseTree child = ctx.getChild(i); if (child instanceof Value_stmtContext) { String valueStr = stringFromNode(child); - value = Integer.valueOf(valueStr); + try { + // yang enum value has same restrictions as JAVA Integer + value = Integer.valueOf(valueStr); + } catch (NumberFormatException e) { + String err = String + .format("Error on enum '%s': the enum value MUST be in the range from -2147483648 to 2147483647, but was: %s", + name, valueStr); + throw new YangParseException(moduleName, ctx.getStart().getLine(), err, e); + } } else if (child instanceof Description_stmtContext) { description = stringFromNode(child); } else if (child instanceof Reference_stmtContext) { @@ -391,10 +616,6 @@ public final class ParserListenerUtils { if (value == null) { value = highestValue + 1; } - if (value < -2147483648 || value > 2147483647) { - throw new YangParseException(moduleName, ctx.getStart().getLine(), "Error on enum '" + name - + "': the enum value MUST be in the range from -2147483648 to 2147483647, but was: " + value); - } EnumPairImpl result = new EnumPairImpl(); result.qname = path.getPathTowardsRoot().iterator().next(); @@ -464,11 +685,11 @@ public final class ParserListenerUtils { public int hashCode() { final int prime = 31; int result = 1; - result = prime * result + ((qname == null) ? 0 : qname.hashCode()); - result = prime * result + ((path == null) ? 0 : path.hashCode()); - result = prime * result + ((unknownNodes == null) ? 0 : unknownNodes.hashCode()); - result = prime * result + ((name == null) ? 0 : name.hashCode()); - result = prime * result + ((value == null) ? 0 : value.hashCode()); + result = prime * result + Objects.hashCode(qname); + result = prime * result + Objects.hashCode(path); + result = prime * result + Objects.hashCode(unknownNodes); + result = prime * result + Objects.hashCode(name); + result = prime * result + Objects.hashCode(value); return result; } @@ -716,7 +937,7 @@ public final class ParserListenerUtils { * type body * @return list of pattern constraints */ - private static List getPatternConstraint(final Type_body_stmtsContext ctx) { + private static List getPatternConstraint(final Type_body_stmtsContext ctx, final String moduleName) { List patterns = new ArrayList<>(); for (int i = 0; i < ctx.getChildCount(); i++) { @@ -725,7 +946,11 @@ public final class ParserListenerUtils { for (int j = 0; j < stringRestrChild.getChildCount(); j++) { ParseTree lengthChild = stringRestrChild.getChild(j); if (lengthChild instanceof Pattern_stmtContext) { - patterns.add(parsePatternConstraint((Pattern_stmtContext) lengthChild)); + final PatternConstraint constraint = parsePatternConstraint((Pattern_stmtContext) lengthChild, + moduleName); + if (constraint != null) { + patterns.add(constraint); + } } } } @@ -740,7 +965,7 @@ public final class ParserListenerUtils { * pattern context * @return PatternConstraint object */ - private static PatternConstraint parsePatternConstraint(final Pattern_stmtContext ctx) { + private static PatternConstraint parsePatternConstraint(final Pattern_stmtContext ctx, final String moduleName) { Optional description = Optional.absent(); Optional reference = Optional.absent(); for (int i = 0; i < ctx.getChildCount(); i++) { @@ -751,8 +976,64 @@ public final class ParserListenerUtils { reference = Optional.of(stringFromNode(child)); } } - String pattern = parsePatternString(ctx); - return BaseConstraints.newPatternConstraint(pattern, description, reference); + final String rawPattern = parsePatternString(ctx); + final String fixedRawPattern = fixUnicodeScriptPattern(rawPattern); + final String pattern = wrapPattern(fixedRawPattern); + if (isValidPattern(pattern, ctx, moduleName)) { + return BaseConstraints.newPatternConstraint(pattern, description, reference); + } + return null; + } + + private static String fixUnicodeScriptPattern(String rawPattern) { + for (int i = 0; i < UNICODE_SCRIPT_FIX_COUNTER; i++) { + try { + Pattern.compile(rawPattern); + return rawPattern; + } catch(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; + } + } + } + + LOG.warn("Regex pattern could not be fixed: {}", rawPattern); + return rawPattern; + } + + private static String fixUnknownScripts(final String exMessage, final String rawPattern) { + StringBuilder result = new StringBuilder(rawPattern); + Matcher matcher = BETWEEN_CURLY_BRACES_PATTERN.matcher(exMessage); + if (matcher.find()) { + String capturedGroup = matcher.group(1); + if (JAVA_UNICODE_BLOCKS.contains(capturedGroup)) { + int idx = rawPattern.indexOf("Is" + capturedGroup); + result = result.replace(idx, idx + 2, "In"); + } + } + return result.toString(); + } + + private static String wrapPattern(final String rawPattern) { + final StringBuilder wrapPatternBuilder = new StringBuilder(rawPattern.length() + 2); + wrapPatternBuilder.append('^'); + wrapPatternBuilder.append(rawPattern); + wrapPatternBuilder.append('$'); + return wrapPatternBuilder.toString(); + } + + private static boolean isValidPattern(final String pattern, final Pattern_stmtContext ctx, final String moduleName) { + try { + Pattern.compile(pattern); + return true; + } catch (PatternSyntaxException ex) { + LOG.warn("Unable to compile pattern defined in module {} at line {}. Error message: {}", + moduleName, ctx.getStart().getLine(), ex.getMessage()); + } + return false; } /** @@ -955,7 +1236,9 @@ public final class ParserListenerUtils { * @param line * line in current module * @return config statement parsed from given context + * @deprecated Pre-Beryllium implementation, scheduled for removal. */ + @Deprecated public static boolean getConfig(final ParseTree ctx, final Builder node, final String moduleName, final int line) { boolean result; // parse configuration statement @@ -986,6 +1269,10 @@ public final class ParserListenerUtils { return result; } + /** + * @deprecated Pre-Beryllium implementation, scheduled for removal. + */ + @Deprecated private static boolean getParentConfig(final Builder node) { Builder parent = node.getParent(); boolean config; @@ -1049,14 +1336,17 @@ public final class ParserListenerUtils { * current module qname * @param actualPath * actual path in model + * + * @deprecated Pre-Beryllium implementation, scheduled for removal. */ - public static void parseUnknownTypeWithBody(Type_body_stmtsContext typeBody, TypeAwareBuilder parent, - QName prefixedQName, ModuleBuilder moduleBuilder, QName moduleQName, SchemaPath actualPath) { + @Deprecated + public static void parseUnknownTypeWithBody(final Type_body_stmtsContext typeBody, final TypeAwareBuilder parent, + final QName prefixedQName, final ModuleBuilder moduleBuilder, final QName moduleQName, final SchemaPath actualPath) { final int line = typeBody.getStart().getLine(); List rangeStatements = getRangeConstraints(typeBody, moduleBuilder.getName()); List lengthStatements = getLengthConstraints(typeBody, moduleBuilder.getName()); - List patternStatements = getPatternConstraint(typeBody); + List patternStatements = getPatternConstraint(typeBody, moduleBuilder.getName()); Integer fractionDigits = getFractionDigits(typeBody, moduleBuilder.getName()); if (parent instanceof TypeDefinitionBuilder && !(parent instanceof UnionTypeBuilder)) { @@ -1096,7 +1386,10 @@ public final class ParserListenerUtils { * @param parent * parent builder * @return TypeDefinition object based on parsed values. + * + * @deprecated Pre-Beryllium implementation, scheduled for removal. */ + @Deprecated public static TypeDefinition parseTypeWithBody(final String typeName, final Type_body_stmtsContext typeBody, final SchemaPath actualPath, final QName moduleQName, final Builder parent) { @@ -1106,7 +1399,7 @@ public final class ParserListenerUtils { Integer fractionDigits = getFractionDigits(typeBody, moduleName); List lengthStatements = getLengthConstraints(typeBody, moduleName); - List patternStatements = getPatternConstraint(typeBody); + List patternStatements = getPatternConstraint(typeBody, moduleName); List rangeStatements = getRangeConstraints(typeBody, moduleName); TypeConstraints constraints = new TypeConstraints(moduleName, line); @@ -1361,7 +1654,10 @@ public final class ParserListenerUtils { * context to parse * @param constraints * ConstraintsBuilder to fill + * + * @deprecated Pre-Beryllium implementation, scheduled for removal. */ + @Deprecated public static void parseConstraints(final ParseTree ctx, final ConstraintsBuilder constraints) { for (int i = 0; i < ctx.getChildCount(); ++i) { final ParseTree childNode = ctx.getChild(i); @@ -1496,7 +1792,10 @@ public final class ParserListenerUtils { * @param moduleName * name of current module * @return RefineHolder object representing this refine statement + * + * @deprecated Pre-Beryllium implementation, scheduled for removal. */ + @Deprecated public static RefineHolderImpl parseRefine(final Refine_stmtContext refineCtx, final String moduleName) { final String refineTarget = stringFromNode(refineCtx); final RefineHolderImpl refine = new RefineHolderImpl(moduleName, refineCtx.getStart().getLine(), refineTarget); @@ -1526,6 +1825,10 @@ public final class ParserListenerUtils { return refine; } + /** + * @deprecated Pre-Beryllium implementation, scheduled for removal. + */ + @Deprecated private static void parseRefineDefault(final RefineHolderImpl refine, final ParseTree refineStmt) { for (int i = 0; i < refineStmt.getChildCount(); i++) { ParseTree refineArg = refineStmt.getChild(i); @@ -1542,6 +1845,10 @@ public final class ParserListenerUtils { } } + /** + * @deprecated Pre-Beryllium implementation, scheduled for removal. + */ + @Deprecated private static RefineBuilder parseRefine(final RefineHolderImpl refine, final Refine_leaf_stmtsContext refineStmt) { for (int i = 0; i < refineStmt.getChildCount(); i++) { ParseTree refineArg = refineStmt.getChild(i); @@ -1565,6 +1872,10 @@ public final class ParserListenerUtils { return refine; } + /** + * @deprecated Pre-Beryllium implementation, scheduled for removal. + */ + @Deprecated private static RefineBuilder parseRefine(final RefineBuilder refine, final Refine_container_stmtsContext refineStmt) { for (int i = 0; i < refineStmt.getChildCount(); i++) { ParseTree refineArg = refineStmt.getChild(i); @@ -1578,6 +1889,10 @@ public final class ParserListenerUtils { return refine; } + /** + * @deprecated Pre-Beryllium implementation, scheduled for removal. + */ + @Deprecated private static RefineBuilder parseRefine(final RefineHolderImpl refine, final Refine_list_stmtsContext refineStmt) { for (int i = 0; i < refineStmt.getChildCount(); i++) { ParseTree refineArg = refineStmt.getChild(i); @@ -1595,6 +1910,10 @@ public final class ParserListenerUtils { return refine; } + /** + * @deprecated Pre-Beryllium implementation, scheduled for removal. + */ + @Deprecated private static RefineBuilder parseRefine(final RefineHolderImpl refine, final Refine_leaf_list_stmtsContext refineStmt) { for (int i = 0; i < refineStmt.getChildCount(); i++) { ParseTree refineArg = refineStmt.getChild(i); @@ -1612,6 +1931,10 @@ public final class ParserListenerUtils { return refine; } + /** + * @deprecated Pre-Beryllium implementation, scheduled for removal. + */ + @Deprecated private static RefineBuilder parseRefine(final RefineHolderImpl refine, final Refine_choice_stmtsContext refineStmt) { for (int i = 0; i < refineStmt.getChildCount(); i++) { ParseTree refineArg = refineStmt.getChild(i); @@ -1631,6 +1954,10 @@ public final class ParserListenerUtils { return refine; } + /** + * @deprecated Pre-Beryllium implementation, scheduled for removal. + */ + @Deprecated private static RefineBuilder parseRefine(final RefineBuilder refine, final Refine_anyxml_stmtsContext refineStmt) { for (int i = 0; i < refineStmt.getChildCount(); i++) { ParseTree refineArg = refineStmt.getChild(i);