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%2FYangParserListenerImpl.java;h=fdaaf33d8865c085dec2ee0c34526962d7f67f14;hb=9a6e147af64a81b7987a6e9d0dac6d9d228295e2;hp=45bedd8c3a9b7da64a762d74a141549adc13065a;hpb=ac4b2ade2f614701d1ae44381b6c2963f15587bb;p=yangtools.git diff --git a/yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/impl/YangParserListenerImpl.java b/yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/impl/YangParserListenerImpl.java index 45bedd8c3a..fdaaf33d88 100644 --- a/yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/impl/YangParserListenerImpl.java +++ b/yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/impl/YangParserListenerImpl.java @@ -18,7 +18,6 @@ import static org.opendaylight.yangtools.yang.parser.impl.ParserListenerUtils.pa import static org.opendaylight.yangtools.yang.parser.impl.ParserListenerUtils.parseStatus; import static org.opendaylight.yangtools.yang.parser.impl.ParserListenerUtils.parseTypeWithBody; import static org.opendaylight.yangtools.yang.parser.impl.ParserListenerUtils.parseUnits; -import static org.opendaylight.yangtools.yang.parser.impl.ParserListenerUtils.parseUnknownTypeWithBody; import static org.opendaylight.yangtools.yang.parser.impl.ParserListenerUtils.parseUserOrdered; import static org.opendaylight.yangtools.yang.parser.impl.ParserListenerUtils.parseYinValue; import static org.opendaylight.yangtools.yang.parser.impl.ParserListenerUtils.stringFromNode; @@ -26,15 +25,16 @@ import static org.opendaylight.yangtools.yang.parser.impl.ParserListenerUtils.st import com.google.common.base.Splitter; import com.google.common.base.Strings; import com.google.common.collect.Iterables; - import java.net.URI; import java.text.DateFormat; import java.text.ParseException; import java.text.SimpleDateFormat; +import java.util.ArrayList; import java.util.Date; import java.util.Iterator; import java.util.List; - +import java.util.Map; +import java.util.TreeMap; import org.antlr.v4.runtime.tree.ParseTree; import org.antlr.v4.runtime.tree.ParseTreeWalker; import org.opendaylight.yangtools.antlrv4.code.gen.YangParser; @@ -71,6 +71,7 @@ import org.opendaylight.yangtools.antlrv4.code.gen.YangParser.Yang_version_stmtC import org.opendaylight.yangtools.antlrv4.code.gen.YangParserBaseListener; import org.opendaylight.yangtools.yang.common.QName; import org.opendaylight.yangtools.yang.common.QNameModule; +import org.opendaylight.yangtools.yang.model.api.ModuleImport; import org.opendaylight.yangtools.yang.model.api.SchemaPath; import org.opendaylight.yangtools.yang.model.api.TypeDefinition; import org.opendaylight.yangtools.yang.model.util.BaseTypes; @@ -78,6 +79,7 @@ import org.opendaylight.yangtools.yang.parser.builder.api.AugmentationSchemaBuil import org.opendaylight.yangtools.yang.parser.builder.api.Builder; import org.opendaylight.yangtools.yang.parser.builder.api.ExtensionBuilder; import org.opendaylight.yangtools.yang.parser.builder.api.GroupingBuilder; +import org.opendaylight.yangtools.yang.parser.builder.api.TypeAwareBuilder; import org.opendaylight.yangtools.yang.parser.builder.api.TypeDefinitionBuilder; import org.opendaylight.yangtools.yang.parser.builder.api.UsesNodeBuilder; import org.opendaylight.yangtools.yang.parser.builder.impl.AnyXmlBuilder; @@ -96,24 +98,29 @@ import org.opendaylight.yangtools.yang.parser.builder.impl.RefineHolderImpl; import org.opendaylight.yangtools.yang.parser.builder.impl.RpcDefinitionBuilder; import org.opendaylight.yangtools.yang.parser.builder.impl.UnionTypeBuilder; import org.opendaylight.yangtools.yang.parser.builder.impl.UnknownSchemaNodeBuilderImpl; +import org.opendaylight.yangtools.yang.parser.util.YangParseException; import org.slf4j.Logger; import org.slf4j.LoggerFactory; public final class YangParserListenerImpl extends YangParserBaseListener { private static final Logger LOG = LoggerFactory.getLogger(YangParserListenerImpl.class); + private static final Splitter SLASH_SPLITTER = Splitter.on('/').omitEmptyStrings(); private static final Splitter COLON_SPLITTER = Splitter.on(':'); private static final String AUGMENT_STR = "augment"; private final DateFormat SIMPLE_DATE_FORMAT = new SimpleDateFormat("yyyy-MM-dd"); private final SchemaPathStack stack = new SchemaPathStack(); + private final Map> namespaceContext; private final String sourcePath; private QName moduleQName = new QName(null, new Date(0L), null, "dummy"); private ModuleBuilder moduleBuilder; private String moduleName; private int augmentOrder; + private String yangModelPrefix; - public YangParserListenerImpl(final String sourcePath) { + public YangParserListenerImpl(final Map> namespaceContext, final String sourcePath) { + this.namespaceContext = namespaceContext; this.sourcePath = sourcePath; } @@ -121,20 +128,24 @@ public final class YangParserListenerImpl extends YangParserBaseListener { * Create a new instance. * * FIXME: the resulting type needs to be extracted, such that we can reuse - * the "BaseListener" aspect, which need not be exposed to the user. - * Maybe factor out a base class into repo.spi? + * the "BaseListener" aspect, which need not be exposed to the user. Maybe + * factor out a base class into repo.spi? * + * @param namespaceContext * @param sourcePath * @param walker * @param tree - * @return + * @return new instance of YangParserListenerImpl */ - public static YangParserListenerImpl create(final String sourcePath, final ParseTreeWalker walker, final ParseTree tree) { - final YangParserListenerImpl ret = new YangParserListenerImpl(sourcePath); + public static YangParserListenerImpl create(final Map> namespaceContext, + final String sourcePath, final ParseTreeWalker walker, final ParseTree tree) { + final YangParserListenerImpl ret = new YangParserListenerImpl(namespaceContext, sourcePath); walker.walk(ret, tree); return ret; } + + @Override public void enterModule_stmt(final YangParser.Module_stmtContext ctx) { moduleName = stringFromNode(ctx); @@ -203,7 +214,24 @@ public final class YangParserListenerImpl extends YangParserBaseListener { @Override public void enterBelongs_to_stmt(final YangParser.Belongs_to_stmtContext ctx) { - moduleBuilder.setBelongsTo(stringFromNode(ctx)); + final String belongsTo = stringFromNode(ctx); + TreeMap context = namespaceContext.get(belongsTo); + Map.Entry entry = context.firstEntry(); + // TODO + // Submodule will contain namespace and revision from module to which it + // belongs. If there are multiple modules with same name and different + // revisions, it will has revision from the newest one. + this.moduleQName = QName.create(entry.getValue(), entry.getKey(), moduleQName.getLocalName()); + moduleBuilder.setQNameModule(moduleQName.getModule()); + moduleBuilder.setBelongsTo(belongsTo); + for (int i = 0; i < ctx.getChildCount(); ++i) { + final ParseTree treeNode = ctx.getChild(i); + if (treeNode instanceof Prefix_stmtContext) { + yangModelPrefix = stringFromNode(treeNode); + moduleBuilder.setPrefix(yangModelPrefix); + setLog("prefix", yangModelPrefix); + } + } } @Override @@ -215,11 +243,11 @@ public final class YangParserListenerImpl extends YangParserBaseListener { if (treeNode instanceof Namespace_stmtContext) { final String namespaceStr = stringFromNode(treeNode); final URI namespace = URI.create(namespaceStr); - this.moduleQName = new QName(namespace, moduleQName.getRevision(), moduleQName.getPrefix(), moduleQName.getLocalName()); + this.moduleQName = QName.create(namespace, moduleQName.getRevision(), moduleQName.getLocalName()); moduleBuilder.setQNameModule(moduleQName.getModule()); setLog("namespace", namespaceStr); } else if (treeNode instanceof Prefix_stmtContext) { - final String yangModelPrefix = stringFromNode(treeNode); + yangModelPrefix = stringFromNode(treeNode); this.moduleQName = QName.create(moduleQName.getModule(), yangModelPrefix, moduleQName.getLocalName()); moduleBuilder.setPrefix(yangModelPrefix); setLog("prefix", yangModelPrefix); @@ -291,7 +319,7 @@ public final class YangParserListenerImpl extends YangParserBaseListener { try { final Date revisionDate = SIMPLE_DATE_FORMAT.parse(revisionDateStr); if ((revisionDate != null) && (this.moduleQName.getRevision().compareTo(revisionDate) < 0)) { - this.moduleQName = new QName(moduleQName.getNamespace(), revisionDate, moduleQName.getPrefix(), moduleQName.getLocalName()); + this.moduleQName = QName.create(moduleQName.getNamespace(), revisionDate, moduleQName.getLocalName()); moduleBuilder.setQNameModule(moduleQName.getModule()); setLog("revision", revisionDate.toString()); for (int i = 0; i < treeNode.getChildCount(); ++i) { @@ -319,8 +347,7 @@ public final class YangParserListenerImpl extends YangParserBaseListener { final ParseTree treeNode = ctx.getChild(i); if (treeNode instanceof Prefix_stmtContext) { importPrefix = stringFromNode(treeNode); - } - if (treeNode instanceof Revision_date_stmtContext) { + } else if (treeNode instanceof Revision_date_stmtContext) { String importRevisionStr = stringFromNode(treeNode); try { importRevision = SIMPLE_DATE_FORMAT.parse(importRevisionStr); @@ -338,6 +365,31 @@ public final class YangParserListenerImpl extends YangParserBaseListener { exitLog("import"); } + @Override + public void enterInclude_stmt(YangParser.Include_stmtContext ctx) { + final int line = ctx.getStart().getLine(); + final String includeName = stringFromNode(ctx); + enterLog("import", includeName, line); + + Date includeRevision = null; + for (int i = 0; i < ctx.getChildCount(); i++) { + ParseTree treeNode = ctx.getChild(i); + if (treeNode instanceof Revision_date_stmtContext) { + String importRevisionStr = stringFromNode(treeNode); + try { + includeRevision = SIMPLE_DATE_FORMAT.parse(importRevisionStr); + } catch (ParseException e) { + LOG.warn("Failed to parse import revision-date at line {}: {}", line, importRevisionStr, e); + } + } + } + moduleBuilder.addInclude(includeName, includeRevision); + } + + @Override public void exitInclude_stmt(YangParser.Include_stmtContext ctx) { + exitLog("include"); + } + @Override public void enterAugment_stmt(final YangParser.Augment_stmtContext ctx) { final int line = ctx.getStart().getLine(); @@ -345,7 +397,8 @@ public final class YangParserListenerImpl extends YangParserBaseListener { enterLog(AUGMENT_STR, augmentPath, line); stack.push(); - AugmentationSchemaBuilder builder = moduleBuilder.addAugment(line, augmentPath, augmentOrder++); + SchemaPath targetPath = parseXPathString(augmentPath, line); + AugmentationSchemaBuilder builder = moduleBuilder.addAugment(line, augmentPath, targetPath, augmentOrder++); for (int i = 0; i < ctx.getChildCount(); i++) { ParseTree child = ctx.getChild(i); @@ -431,7 +484,7 @@ public final class YangParserListenerImpl extends YangParserBaseListener { final String typeName = stringFromNode(ctx); enterLog("type", typeName, line); - final QName typeQName = parseQName(typeName); + final QName typeQName = parseQName(typeName, line); TypeDefinition type; Type_body_stmtsContext typeBody = null; @@ -468,36 +521,78 @@ public final class YangParserListenerImpl extends YangParserBaseListener { moduleBuilder.addIdentityrefType(line, path, getIdentityrefBase(typeBody)); break; default: - type = parseTypeWithBody(typeName, typeBody, stack.currentSchemaPath(), moduleQName, moduleBuilder.getActualNode()); + type = parseTypeWithBody(typeName, typeBody, stack.currentSchemaPath(), moduleQName, + moduleBuilder.getActualNode()); moduleBuilder.setType(type); stack.addNodeToPath(type.getQName()); } } } else { - type = parseUnknownTypeWithBody(typeQName, typeBody, stack.currentSchemaPath(), moduleQName, moduleBuilder.getActualNode()); - // add parent node of this type statement to dirty nodes - moduleBuilder.markActualNodeDirty(); - moduleBuilder.setType(type); - stack.addNodeToPath(type.getQName()); + TypeAwareBuilder parent = (TypeAwareBuilder) moduleBuilder.getActualNode(); + if (typeBody == null) { + parent.setTypeQName(typeQName); + moduleBuilder.markActualNodeDirty(); + } else { + ParserListenerUtils.parseUnknownTypeWithBody(typeBody, parent, typeQName, moduleBuilder, + moduleQName, stack.currentSchemaPath()); + } + stack.addNodeToPath(QName.create(moduleQName.getModule(), typeQName.getLocalName())); } - } - private QName parseQName(final String typeName) { - final QName typeQName; - if (typeName.indexOf(':') != -1) { - final Iterator split = COLON_SPLITTER.split(typeName).iterator(); + /** + * Method transforms string representation of yang element (i.e. leaf name, container name etc.) into QName. + * The namespace of QName is assigned from parent module same as revision date of module. If String qname parameter + * contains ":" the string is evaluated as prefix:name of element. In this case method will look into import map + * and extract correct ModuleImport. If such import is not present in import map the method will throw {@link YangParseException} + *
+ * If ModuleImport is present but the value of namespace in ModuleImport is null the method will throw {@link YangParseException} + * + * @param qnameString QName value as String + * @param line line in Yang model document where QName occur. + * @return transformed string qname parameter as QName structure. + * + * @throws YangParseException + */ + private QName parseQName(final String qnameString, final int line) { + final QName qname; + if (qnameString.indexOf(':') == -1) { + qname = QName.create(moduleQName, qnameString); + } else { + final Iterator split = COLON_SPLITTER.split(qnameString).iterator(); final String prefix = split.next(); final String name = split.next(); - if (prefix.equals(moduleQName.getPrefix())) { - typeQName = QName.create(moduleQName, name); + if (prefix.equals(moduleBuilder.getPrefix())) { + qname = QName.create(moduleQName, name); } else { - typeQName = QName.create(QNameModule.create(null, null), prefix, name); + ModuleImport imp = moduleBuilder.getImport(prefix); + if (imp == null) { + LOG.debug("Error in module {} at line {}: No import found with prefix {}", moduleName, line, prefix); + throw new YangParseException(moduleName, line, "Error in module " + moduleName + + " No import found with prefix " + prefix + " not found."); + } + Date revision = imp.getRevision(); + TreeMap namespaces = namespaceContext.get(imp.getModuleName()); + if (namespaces == null) { + throw new YangParseException(moduleName, line, String.format("Imported module %s not found", + imp.getModuleName())); + } + URI namespace; + if (revision == null) { + revision = namespaces.lastEntry().getKey(); + namespace = namespaces.lastEntry().getValue(); + } else { + // FIXME: this lookup does not look right, as we will end up with + // a qname which does not have a namespace. At any rate we + // should arrive at a QNameModule! + namespace = namespaces.get(revision); + } + + final QNameModule mod = QNameModule.cachedReference(QNameModule.create(namespace, revision)); + qname = QName.create(mod, name); } - } else { - typeQName = QName.create(moduleQName, typeName); } - return typeQName; + return qname; } @Override @@ -600,9 +695,10 @@ public final class YangParserListenerImpl extends YangParserBaseListener { public void enterUses_stmt(final YangParser.Uses_stmtContext ctx) { final int line = ctx.getStart().getLine(); final String groupingPathStr = stringFromNode(ctx); + final SchemaPath groupingPath = parseXPathString(groupingPathStr, line); enterLog("uses", groupingPathStr, line); - UsesNodeBuilder builder = moduleBuilder.addUsesNode(line, groupingPathStr); + UsesNodeBuilder builder = moduleBuilder.addUsesNode(line, groupingPath); moduleBuilder.enterNode(builder); } @@ -620,7 +716,8 @@ public final class YangParserListenerImpl extends YangParserBaseListener { enterLog(AUGMENT_STR, augmentPath, line); stack.push(); - AugmentationSchemaBuilder builder = moduleBuilder.addAugment(line, augmentPath, augmentOrder++); + SchemaPath targetPath = parseXPathString(augmentPath, line); + AugmentationSchemaBuilder builder = moduleBuilder.addAugment(line, augmentPath, targetPath, augmentOrder++); for (int i = 0; i < ctx.getChildCount(); i++) { ParseTree child = ctx.getChild(i); @@ -940,11 +1037,17 @@ public final class YangParserListenerImpl extends YangParserBaseListener { @Override public void enterDeviation_stmt(final YangParser.Deviation_stmtContext ctx) { final int line = ctx.getStart().getLine(); - final String targetPath = stringFromNode(ctx); - enterLog("deviation", targetPath, line); + final String targetPathStr = stringFromNode(ctx); + if (!targetPathStr.startsWith("/")) { + throw new YangParseException(moduleName, line, + "Deviation argument string must be an absolute schema node identifier."); + } + enterLog("deviation", targetPathStr, line); String reference = null; String deviate = null; + + SchemaPath targetPath = parseXPathString(targetPathStr, line); DeviationBuilder builder = moduleBuilder.addDeviation(line, targetPath); moduleBuilder.enterNode(builder); @@ -966,6 +1069,22 @@ public final class YangParserListenerImpl extends YangParserBaseListener { builder.setDeviate(deviate); } + public SchemaPath parseXPathString(final String xpathString, final int line) { + final boolean absolute = !xpathString.isEmpty() && xpathString.charAt(0) == '/'; + + final List path = new ArrayList<>(); + for (String pathElement : SLASH_SPLITTER.split(xpathString)) { + final Iterator it = COLON_SPLITTER.split(pathElement).iterator(); + final String s = it.next(); + if (it.hasNext()) { + path.add(parseQName(pathElement, line)); + } else { + path.add(QName.create(moduleQName, s)); + } + } + return SchemaPath.create(path, absolute); + } + @Override public void exitDeviation_stmt(final YangParser.Deviation_stmtContext ctx) { moduleBuilder.exitNode(); @@ -1026,39 +1145,35 @@ public final class YangParserListenerImpl extends YangParserBaseListener { enterLog("unknown-node", nodeParameter, line); final String nodeTypeStr = ctx.getChild(0).getText(); - final Iterator splittedElement = COLON_SPLITTER.split(nodeTypeStr).iterator(); - final String e0 = splittedElement.next(); - final QName nodeType; - if (splittedElement.hasNext()) { - nodeType = QName.create(moduleQName.getModule(), e0, splittedElement.next()); - } else { - nodeType = QName.create(moduleQName, e0); - } + QName nodeType = parseQName(nodeTypeStr, line); - QName qname; + QName qname = null; try { - if (!Strings.isNullOrEmpty(nodeParameter)) { + //FIXME: rewrite whole method to handle unknown nodes properly. + // This should be bugfix for bug https://bugs.opendaylight.org/show_bug.cgi?id=1539 + // After this fix bug https://bugs.opendaylight.org/show_bug.cgi?id=1538 MUST be fixed since + // they are dependent!!! + if (Strings.isNullOrEmpty(nodeParameter)) { + qname = nodeType; + } else { final Iterable splittedName = COLON_SPLITTER.split(nodeParameter); final Iterator it = splittedName.iterator(); - if (Iterables.size(splittedName) == 2) { - qname = QName.create(QNameModule.create(null, null), it.next(), it.next()); + qname = parseQName(nodeParameter, line); } else { qname = QName.create(moduleQName, it.next()); } - } else { - qname = nodeType; } - } catch (IllegalArgumentException e) { + } catch (IllegalArgumentException | YangParseException ex) { qname = nodeType; } + SchemaPath path = stack.addNodeToPath(qname); UnknownSchemaNodeBuilderImpl builder = moduleBuilder.addUnknownSchemaNode(line, qname, path); builder.setNodeType(nodeType); builder.setNodeParameter(nodeParameter); - parseSchemaNodeArgs(ctx, builder); moduleBuilder.enterNode(builder); }