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%2Fbuilder%2Fimpl%2FBuilderUtils.java;h=759e779eed26e29a079b7e37681515022e8a160a;hb=0082208025b5bb78e648cf20a31ac78b8b9e204c;hp=5ca8f83120380af67c4f38453f3d8f9d2f29f24b;hpb=93e8c16d8deff8cd2935d09c445d2d7082503cb4;p=yangtools.git diff --git a/yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/builder/impl/BuilderUtils.java b/yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/builder/impl/BuilderUtils.java index 5ca8f83120..759e779eed 100644 --- a/yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/builder/impl/BuilderUtils.java +++ b/yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/builder/impl/BuilderUtils.java @@ -12,8 +12,8 @@ import com.google.common.base.Optional; import com.google.common.base.Preconditions; import com.google.common.base.Splitter; import com.google.common.collect.Collections2; +import com.google.common.collect.Iterables; import com.google.common.io.ByteSource; - import java.io.ByteArrayOutputStream; import java.io.File; import java.io.FileNotFoundException; @@ -23,13 +23,23 @@ import java.net.URI; import java.util.ArrayList; import java.util.Collection; import java.util.Date; +import java.util.HashMap; import java.util.HashSet; import java.util.Iterator; +import java.util.LinkedHashSet; import java.util.List; import java.util.Map; import java.util.Set; import java.util.TreeMap; +import org.antlr.v4.runtime.tree.ParseTree; import org.apache.commons.io.IOUtils; +import org.opendaylight.yangtools.antlrv4.code.gen.YangParser.Belongs_to_stmtContext; +import org.opendaylight.yangtools.antlrv4.code.gen.YangParser.Module_header_stmtsContext; +import org.opendaylight.yangtools.antlrv4.code.gen.YangParser.Module_stmtContext; +import org.opendaylight.yangtools.antlrv4.code.gen.YangParser.Namespace_stmtContext; +import org.opendaylight.yangtools.antlrv4.code.gen.YangParser.Revision_stmtsContext; +import org.opendaylight.yangtools.antlrv4.code.gen.YangParser.Submodule_header_stmtsContext; +import org.opendaylight.yangtools.antlrv4.code.gen.YangParser.Submodule_stmtContext; import org.opendaylight.yangtools.yang.common.QName; import org.opendaylight.yangtools.yang.model.api.AnyXmlSchemaNode; import org.opendaylight.yangtools.yang.model.api.ChoiceCaseNode; @@ -57,7 +67,10 @@ import org.opendaylight.yangtools.yang.parser.builder.api.GroupingBuilder; import org.opendaylight.yangtools.yang.parser.builder.api.GroupingMember; import org.opendaylight.yangtools.yang.parser.builder.api.SchemaNodeBuilder; import org.opendaylight.yangtools.yang.parser.builder.api.TypeDefinitionBuilder; +import org.opendaylight.yangtools.yang.parser.builder.api.UnknownSchemaNodeBuilder; import org.opendaylight.yangtools.yang.parser.builder.api.UsesNodeBuilder; +import org.opendaylight.yangtools.yang.parser.impl.ParserListenerUtils; +import org.opendaylight.yangtools.yang.parser.impl.util.YangModelDependencyInfo; import org.opendaylight.yangtools.yang.parser.util.NamedByteArrayInputStream; import org.opendaylight.yangtools.yang.parser.util.NamedFileInputStream; import org.opendaylight.yangtools.yang.parser.util.YangParseException; @@ -67,8 +80,8 @@ import org.slf4j.LoggerFactory; public final class BuilderUtils { private static final Logger LOG = LoggerFactory.getLogger(BuilderUtils.class); - private static final Splitter SLASH_SPLITTER = Splitter.on('/'); private static final Splitter COLON_SPLITTER = Splitter.on(':'); + private static final Date NULL_DATE = new Date(0L); private static final String INPUT = "input"; private static final String OUTPUT = "output"; @@ -123,25 +136,6 @@ public final class BuilderUtils { return schemaPath.createChild(qname); } - /** - * Get module import referenced by given prefix. - * - * @param builder - * module to search - * @param prefix - * prefix associated with import - * @return ModuleImport based on given prefix - */ - private static ModuleImport getModuleImport(final ModuleBuilder builder, final String prefix) { - for (ModuleImport mi : builder.getModuleImports()) { - if (mi.getPrefix().equals(prefix)) { - return mi; - - } - } - return null; - } - /** * Find dependent module based on given prefix * @@ -165,7 +159,7 @@ public final class BuilderUtils { } else if (prefix.equals(module.getPrefix())) { dependentModule = module; } else { - ModuleImport dependentModuleImport = getModuleImport(module, prefix); + ModuleImport dependentModuleImport = module.getImport(prefix); if (dependentModuleImport == null) { throw new YangParseException(module.getName(), line, "No import found with prefix '" + prefix + "'."); } @@ -185,6 +179,26 @@ public final class BuilderUtils { return dependentModule; } + public static ModuleBuilder findModuleFromBuilders(ModuleImport imp, Iterable modules) { + String name = imp.getModuleName(); + Date revision = imp.getRevision(); + TreeMap map = new TreeMap<>(); + for (ModuleBuilder module : modules) { + if (module != null) { + if (module.getName().equals(name)) { + map.put(module.getRevision(), module); + } + } + } + if (map.isEmpty()) { + return null; + } + if (revision == null) { + return map.lastEntry().getValue(); + } + return map.get(revision); + } + /** * Find module from context based on prefix. * @@ -193,20 +207,19 @@ public final class BuilderUtils { * @param currentModule * current module * @param prefix - * current prefix used to reference dependent module + * prefix used to reference dependent module * @param line * current line in yang model - * @return module based on given prefix if found in context, null otherwise + * @return module based on import with given prefix if found in context, + * null otherwise + * @throws YangParseException + * if no import found with given prefix */ public static Module findModuleFromContext(final SchemaContext context, final ModuleBuilder currentModule, final String prefix, final int line) { - if (context == null) { - throw new YangParseException(currentModule.getName(), line, "Cannot find module with prefix '" + prefix - + "'."); - } TreeMap modulesByRevision = new TreeMap<>(); - ModuleImport dependentModuleImport = BuilderUtils.getModuleImport(currentModule, prefix); + ModuleImport dependentModuleImport = currentModule.getImport(prefix); if (dependentModuleImport == null) { throw new YangParseException(currentModule.getName(), line, "No import found with prefix '" + prefix + "'."); } @@ -217,7 +230,7 @@ public final class BuilderUtils { if (contextModule.getName().equals(dependentModuleName)) { Date revision = contextModule.getRevision(); if (revision == null) { - revision = new Date(0L); + revision = NULL_DATE; } modulesByRevision.put(revision, contextModule); } @@ -229,35 +242,11 @@ public final class BuilderUtils { } else { result = modulesByRevision.get(dependentModuleRevision); } - return result; - } - - /** - * Parse XPath string. - * - * @param xpathString - * XPath as String - * @return SchemaPath from given String - */ - public static SchemaPath parseXPathString(final String xpathString) { - final boolean absolute = xpathString.indexOf('/') == 0; - - final List path = new ArrayList<>(); - for (String pathElement : SLASH_SPLITTER.split(xpathString)) { - if (pathElement.length() > 0) { - final Iterator it = COLON_SPLITTER.split(pathElement).iterator(); - final String s = it.next(); - - final QName name; - if (it.hasNext()) { - name = new QName(null, null, s, it.next()); - } else { - name = new QName(null, null, null, s); - } - path.add(name); - } + if (result == null) { + throw new YangParseException(currentModule.getName(), line, "Module not found for prefix " + prefix); } - return SchemaPath.create(path, absolute); + + return result; } /** @@ -372,56 +361,38 @@ public final class BuilderUtils { } } - /** - * Set config flag to new value. - * - * @param node - * node to update - * @param config - * new config value - */ - private static void setNodeConfig(final DataSchemaNodeBuilder node, final Boolean config) { - if (node instanceof ContainerSchemaNodeBuilder || node instanceof LeafSchemaNodeBuilder - || node instanceof LeafListSchemaNodeBuilder || node instanceof ListSchemaNodeBuilder - || node instanceof ChoiceBuilder || node instanceof AnyXmlBuilder) { - node.setConfiguration(config); - } - if (node instanceof DataNodeContainerBuilder) { - DataNodeContainerBuilder dataNodeChild = (DataNodeContainerBuilder) node; - for (DataSchemaNodeBuilder inner : dataNodeChild.getChildNodeBuilders()) { - setNodeConfig(inner, config); - } - } else if (node instanceof ChoiceBuilder) { - ChoiceBuilder choiceChild = (ChoiceBuilder) node; - for (ChoiceCaseBuilder inner : choiceChild.getCases()) { - setNodeConfig(inner, config); - } - } - } - - public static DataSchemaNodeBuilder findSchemaNode(final List path, final SchemaNodeBuilder parentNode) { - DataSchemaNodeBuilder node = null; + public static SchemaNodeBuilder findSchemaNode(final Iterable path, final SchemaNodeBuilder parentNode) { + SchemaNodeBuilder node = null; SchemaNodeBuilder parent = parentNode; + int size = Iterables.size(path); int i = 0; - while (i < path.size()) { - String name = path.get(i).getLocalName(); + for (QName qname : path) { + String name = qname.getLocalName(); if (parent instanceof DataNodeContainerBuilder) { node = ((DataNodeContainerBuilder) parent).getDataChildByName(name); + if (node == null) { + node = findUnknownNode(name, parent); + } } else if (parent instanceof ChoiceBuilder) { node = ((ChoiceBuilder) parent).getCaseNodeByName(name); + if (node == null) { + node = findUnknownNode(name, parent); + } } else if (parent instanceof RpcDefinitionBuilder) { if ("input".equals(name)) { node = ((RpcDefinitionBuilder) parent).getInput(); } else if ("output".equals(name)) { node = ((RpcDefinitionBuilder) parent).getOutput(); } else { - return null; + if (node == null) { + node = findUnknownNode(name, parent); + } } } else { - return null; + node = findUnknownNode(name, parent); } - if (i < path.size() - 1) { + if (i < size - 1) { parent = node; } i = i + 1; @@ -430,6 +401,15 @@ public final class BuilderUtils { return node; } + private static UnknownSchemaNodeBuilder findUnknownNode(final String name, final Builder parent) { + for (UnknownSchemaNodeBuilder un : parent.getUnknownNodes()) { + if (un.getQName().getLocalName().equals(name)) { + return un; + } + } + return null; + } + /** * * Find a builder for node in data namespace of YANG module. @@ -456,7 +436,16 @@ public final class BuilderUtils { Optional currentNode = getDataNamespaceChild(module, first); while (currentNode.isPresent() && path.hasNext()) { - currentNode = findDataChild(currentNode.get(), path.next()); + SchemaNodeBuilder currentParent = currentNode.get(); + QName currentPath = path.next(); + currentNode = findDataChild(currentParent, currentPath); + if (!currentNode.isPresent()) { + for (SchemaNodeBuilder un : currentParent.getUnknownNodes()) { + if (un.getQName().equals(currentPath)) { + currentNode = Optional.of(un); + } + } + } } return currentNode; } @@ -483,7 +472,7 @@ public final class BuilderUtils { * Class to be checked * @param optional * Original value - * @return + * @return Optional object with type argument casted as cls */ private static Optional castOptional(final Class cls, final Optional optional) { if (optional.isPresent()) { @@ -498,6 +487,7 @@ public final class BuilderUtils { return Optional.absent(); } + // FIXME: if rpc does not define input or output, this method creates it /** * * Gets input / output container from {@link RpcDefinitionBuilder} if QName @@ -511,10 +501,27 @@ public final class BuilderUtils { * @return Optional of input/output if defined and QName is input/output. * Otherwise {@link Optional#absent()}. */ - private static Optional findContainerInRpc(final RpcDefinitionBuilder parent, final QName child) { + private static Optional findContainerInRpc(final RpcDefinitionBuilder parent, + final QName child) { if (INPUT.equals(child.getLocalName())) { + if (parent.getInput() == null) { + QName qname = QName.create(parent.getQName().getModule(), "input"); + final ContainerSchemaNodeBuilder inputBuilder = new ContainerSchemaNodeBuilder(parent.getModuleName(), + parent.getLine(), qname, parent.getPath().createChild(qname)); + inputBuilder.setParent(parent); + parent.setInput(inputBuilder); + return Optional.of(inputBuilder); + } return Optional.of(parent.getInput()); } else if (OUTPUT.equals(child.getLocalName())) { + if (parent.getOutput() == null) { + QName qname = QName.create(parent.getQName().getModule(), "output"); + final ContainerSchemaNodeBuilder outputBuilder = new ContainerSchemaNodeBuilder(parent.getModuleName(), + parent.getLine(), qname, parent.getPath().createChild(qname)); + outputBuilder.setParent(parent); + parent.setOutput(outputBuilder); + return Optional.of(outputBuilder); + } return Optional.of(parent.getOutput()); } LOG.trace("Child {} not found in node {}", child, parent); @@ -627,18 +634,20 @@ public final class BuilderUtils { * Find augment target node and perform augmentation. * * @param augment + * augment builder to process * @param firstNodeParent * parent of first node in path - * @param path - * path to augment target * @return true if augmentation process succeed, false otherwise */ public static boolean processAugmentation(final AugmentationSchemaBuilder augment, final ModuleBuilder firstNodeParent) { - Optional potentialTargetNode = findSchemaNodeInModule(augment.getTargetNodeSchemaPath(), + Optional potentialTargetNode = findSchemaNodeInModule(augment.getTargetPath(), firstNodeParent); if (!potentialTargetNode.isPresent()) { return false; + } else if (potentialTargetNode.get() instanceof UnknownSchemaNodeBuilder) { + LOG.warn("Error in augment parsing: unsupported augment target: {}", potentialTargetNode.get()); + return true; } SchemaNodeBuilder targetNode = potentialTargetNode.get(); fillAugmentTarget(augment, targetNode); @@ -649,8 +658,8 @@ public final class BuilderUtils { return true; } - public static IdentitySchemaNodeBuilder findBaseIdentity(final Map> modules, - final ModuleBuilder module, final String baseString, final int line) { + public static IdentitySchemaNodeBuilder findBaseIdentity(final ModuleBuilder module, final String baseString, + final int line) { // FIXME: optimize indexOf() away? if (baseString.indexOf(':') != -1) { @@ -662,7 +671,7 @@ public final class BuilderUtils { throw new YangParseException(module.getName(), line, "Failed to parse identityref base: " + baseString); } - ModuleBuilder dependentModule = findModuleFromBuilders(modules, module, prefix, line); + ModuleBuilder dependentModule = getModuleByPrefix(module, prefix); if (dependentModule == null) { return null; } @@ -705,12 +714,11 @@ public final class BuilderUtils { } public static Set wrapChildNodes(final String moduleName, final int line, - final Set nodes, final SchemaPath parentPath, final URI ns, final Date rev, - final String pref) { - Set result = new HashSet<>(); + final Collection nodes, final SchemaPath parentPath, final QName parentQName) { + Set result = new LinkedHashSet<>(nodes.size()); for (DataSchemaNode node : nodes) { - QName qname = new QName(ns, rev, pref, node.getQName().getLocalName()); + QName qname = QName.create(parentQName, node.getQName().getLocalName()); DataSchemaNodeBuilder wrapped = wrapChildNode(moduleName, line, node, parentPath, qname); result.add(wrapped); } @@ -743,11 +751,10 @@ public final class BuilderUtils { } public static Set wrapGroupings(final String moduleName, final int line, - final Set nodes, final SchemaPath parentPath, final URI ns, final Date rev, - final String pref) { + final Set nodes, final SchemaPath parentPath, final QName parentQName) { Set result = new HashSet<>(); for (GroupingDefinition node : nodes) { - QName qname = new QName(ns, rev, pref, node.getQName().getLocalName()); + QName qname = QName.create(parentQName, node.getQName().getLocalName()); SchemaPath schemaPath = parentPath.createChild(qname); result.add(new GroupingBuilderImpl(moduleName, line, qname, schemaPath, node)); } @@ -755,12 +762,11 @@ public final class BuilderUtils { } public static Set wrapTypedefs(final String moduleName, final int line, - final DataNodeContainer dataNode, final SchemaPath parentPath, final URI ns, final Date rev, - final String pref) { + final DataNodeContainer dataNode, final SchemaPath parentPath, final QName parentQName) { Set> nodes = dataNode.getTypeDefinitions(); Set result = new HashSet<>(); for (TypeDefinition node : nodes) { - QName qname = new QName(ns, rev, pref, node.getQName().getLocalName()); + QName qname = QName.create(parentQName, node.getQName().getLocalName()); SchemaPath schemaPath = parentPath.createChild(qname); result.add(new TypeDefinitionBuilderImpl(moduleName, line, qname, schemaPath, ((ExtendedType) node))); } @@ -768,11 +774,10 @@ public final class BuilderUtils { } public static List wrapUnknownNodes(final String moduleName, final int line, - final List nodes, final SchemaPath parentPath, final URI ns, final Date rev, - final String pref) { + final List nodes, final SchemaPath parentPath, final QName parentQName) { List result = new ArrayList<>(); for (UnknownSchemaNode node : nodes) { - QName qname = new QName(ns, rev, pref, node.getQName().getLocalName()); + QName qname = QName.create(parentQName, node.getQName().getLocalName()); SchemaPath schemaPath = parentPath.createChild(qname); result.add(new UnknownSchemaNodeBuilderImpl(moduleName, line, qname, schemaPath, node)); } @@ -794,4 +799,115 @@ public final class BuilderUtils { } } + public static ModuleBuilder getModuleByPrefix(final ModuleBuilder module, final String prefix) { + if (prefix == null || prefix.isEmpty() || prefix.equals(module.getPrefix())) { + return module; + } else { + return module.getImportedModule(prefix); + } + } + + public static ModuleBuilder findModule(final QName qname, final Map> modules) { + TreeMap map = modules.get(qname.getNamespace()); + if (map == null) { + return null; + } + if (qname.getRevision() == null) { + return map.lastEntry().getValue(); + } + return map.get(qname.getRevision()); + } + + public static Map> createYangNamespaceContext( + final Collection modules, final Optional context) { + Map> namespaceContext = new HashMap<>(); + Set submodules = new HashSet<>(); + // first read ParseTree collection and separate modules and submodules + for (ParseTree module : modules) { + for (int i = 0; i < module.getChildCount(); i++) { + ParseTree moduleTree = module.getChild(i); + if (moduleTree instanceof Submodule_stmtContext) { + // put submodule context to separate collection + submodules.add((Submodule_stmtContext) moduleTree); + } else if (moduleTree instanceof Module_stmtContext) { + // get name, revision and namespace from module + Module_stmtContext moduleCtx = (Module_stmtContext) moduleTree; + final String moduleName = ParserListenerUtils.stringFromNode(moduleCtx); + Date rev = null; + URI namespace = null; + for (int j = 0; j < moduleCtx.getChildCount(); j++) { + ParseTree moduleCtxChildTree = moduleCtx.getChild(j); + if (moduleCtxChildTree instanceof Revision_stmtsContext) { + String revisionDateStr = YangModelDependencyInfo + .getLatestRevision((Revision_stmtsContext) moduleCtxChildTree); + if (revisionDateStr == null) { + rev = new Date(0); + } else { + rev = QName.parseRevision(revisionDateStr); + } + } + if (moduleCtxChildTree instanceof Module_header_stmtsContext) { + Module_header_stmtsContext headerCtx = (Module_header_stmtsContext) moduleCtxChildTree; + for (int k = 0; k < headerCtx.getChildCount(); k++) { + ParseTree ctx = headerCtx.getChild(k); + if (ctx instanceof Namespace_stmtContext) { + final String namespaceStr = ParserListenerUtils.stringFromNode(ctx); + namespace = URI.create(namespaceStr); + break; + } + } + } + } + // update namespaceContext + TreeMap revToNs = namespaceContext.get(moduleName); + if (revToNs == null) { + revToNs = new TreeMap<>(); + revToNs.put(rev, namespace); + namespaceContext.put(moduleName, revToNs); + } + revToNs.put(rev, namespace); + } + } + } + // after all ParseTree-s are parsed update namespaceContext with modules + // from SchemaContext + if (context.isPresent()) { + for (Module module : context.get().getModules()) { + TreeMap revToNs = namespaceContext.get(module.getName()); + if (revToNs == null) { + revToNs = new TreeMap<>(); + revToNs.put(module.getRevision(), module.getNamespace()); + namespaceContext.put(module.getName(), revToNs); + } + revToNs.put(module.getRevision(), module.getNamespace()); + } + } + // when all modules are processed, traverse submodules and update + // namespaceContext with mapping for submodules + for (Submodule_stmtContext submodule : submodules) { + final String moduleName = ParserListenerUtils.stringFromNode(submodule); + for (int i = 0; i < submodule.getChildCount(); i++) { + ParseTree subHeaderCtx = submodule.getChild(i); + if (subHeaderCtx instanceof Submodule_header_stmtsContext) { + for (int j = 0; j < subHeaderCtx.getChildCount(); j++) { + ParseTree belongsCtx = subHeaderCtx.getChild(j); + if (belongsCtx instanceof Belongs_to_stmtContext) { + final String belongsTo = ParserListenerUtils.stringFromNode(belongsCtx); + TreeMap ns = namespaceContext.get(belongsTo); + if (ns == null) { + throw new YangParseException(moduleName, submodule.getStart().getLine(), String.format( + "Unresolved belongs-to statement: %s", belongsTo)); + } + // submodule get namespace and revision from module + TreeMap subNs = new TreeMap<>(); + subNs.put(ns.firstKey(), ns.firstEntry().getValue()); + namespaceContext.put(moduleName, subNs); + } + } + } + } + } + return namespaceContext; + } + }