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=792db8d9c84b8a1a677df8511343fa097565845b;hb=42abb28b99a02f9580f4676ce5c315628e5bcd24;hp=4a61d7b0f6d0eef9458a16fbc1c3becd97d3976c;hpb=752f127fb427346655185457d6c38f289595ab2d;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 4a61d7b0f6..792db8d9c8 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 @@ -14,14 +14,12 @@ 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 com.google.common.io.ByteStreams; import java.io.File; import java.io.FileNotFoundException; import java.io.IOException; import java.io.InputStream; import java.net.URI; -import java.text.DateFormat; -import java.text.SimpleDateFormat; import java.util.ArrayList; import java.util.Collection; import java.util.Date; @@ -31,18 +29,22 @@ import java.util.Iterator; import java.util.LinkedHashSet; import java.util.List; import java.util.Map; +import java.util.Map.Entry; +import java.util.NavigableMap; 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; -import org.opendaylight.yangtools.yang.model.api.ChoiceNode; +import org.opendaylight.yangtools.yang.model.api.ChoiceSchemaNode; import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode; import org.opendaylight.yangtools.yang.model.api.DataNodeContainer; import org.opendaylight.yangtools.yang.model.api.DataSchemaNode; @@ -76,15 +78,18 @@ import org.opendaylight.yangtools.yang.parser.util.YangParseException; import org.slf4j.Logger; import org.slf4j.LoggerFactory; +/** + * @deprecated Pre-Beryllium implementation, scheduled for removal. + */ +@Deprecated public final class BuilderUtils { - private static final DateFormat SIMPLE_DATE_FORMAT = new SimpleDateFormat("yyyy-MM-dd"); private static final Logger LOG = LoggerFactory.getLogger(BuilderUtils.class); - private static final Splitter SLASH_SPLITTER = Splitter.on('/').omitEmptyStrings(); 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"; + private static final String CHILD_NOT_FOUND_IN_NODE_STR = "Child {} not found in node {}"; private BuilderUtils() { } @@ -121,22 +126,6 @@ public final class BuilderUtils { }); } - /** - * Create new SchemaPath from given path and qname. - * - * @param schemaPath - * base path - * @param qname - * one or more qnames added to base path - * @return new SchemaPath from given path and qname - * - * @deprecated Use {@link SchemaPath#createChild(QName...)} instead. - */ - @Deprecated - public static SchemaPath createSchemaPath(final SchemaPath schemaPath, final QName... qname) { - return schemaPath.createChild(qname); - } - /** * Find dependent module based on given prefix * @@ -150,7 +139,7 @@ public final class BuilderUtils { * current line in yang model * @return module builder if found, null otherwise */ - public static ModuleBuilder findModuleFromBuilders(final Map> modules, + public static ModuleBuilder findModuleFromBuilders(final Map> modules, final ModuleBuilder module, final String prefix, final int line) { ModuleBuilder dependentModule; Date dependentModuleRevision; @@ -167,7 +156,7 @@ public final class BuilderUtils { String dependentModuleName = dependentModuleImport.getModuleName(); dependentModuleRevision = dependentModuleImport.getRevision(); - TreeMap moduleBuildersByRevision = modules.get(dependentModuleName); + NavigableMap moduleBuildersByRevision = modules.get(dependentModuleName); if (moduleBuildersByRevision == null) { return null; } @@ -180,15 +169,13 @@ public final class BuilderUtils { return dependentModule; } - public static ModuleBuilder findModuleFromBuilders(ModuleImport imp, Iterable modules) { + public static ModuleBuilder findModuleFromBuilders(final ModuleImport imp, final Iterable modules) { String name = imp.getModuleName(); Date revision = imp.getRevision(); - TreeMap map = new TreeMap<>(); + NavigableMap map = new TreeMap<>(); for (ModuleBuilder module : modules) { - if (module != null) { - if (module.getName().equals(name)) { - map.put(module.getRevision(), module); - } + if (module != null && module.getName().equals(name)) { + map.put(module.getRevision(), module); } } if (map.isEmpty()) { @@ -218,7 +205,7 @@ public final class BuilderUtils { */ public static Module findModuleFromContext(final SchemaContext context, final ModuleBuilder currentModule, final String prefix, final int line) { - TreeMap modulesByRevision = new TreeMap<>(); + NavigableMap modulesByRevision = new TreeMap<>(); ModuleImport dependentModuleImport = currentModule.getImport(prefix); if (dependentModuleImport == null) { @@ -345,7 +332,7 @@ public final class BuilderUtils { /** * Set addedByUses flag to true for node and all its child nodes. * - * @param node + * @param node grouping member node */ public static void setNodeAddedByUses(final GroupingMember node) { node.setAddedByUses(true); @@ -362,6 +349,41 @@ public final class BuilderUtils { } } + /** + * Find builder of schema node under parent builder (including under + * AugmentationSchemaBuilder). + * + * @param path + * - path of target schema node builder + * @param parent + * - base data node container builder under which the target + * schema node builder should be found + * @return builder of schema node + */ + public static SchemaNodeBuilder findTargetNode(final Iterable path, + final DataNodeContainerBuilder parent) { + + Preconditions.checkNotNull(parent); + Preconditions.checkNotNull(path); + + SchemaNodeBuilder foundNode = null; + + final Iterator pathIterator = path.iterator(); + if (pathIterator.hasNext()) { + String name = pathIterator.next().getLocalName(); + foundNode = parent.getDataChildByName(name); + if (foundNode == null) { + foundNode = findUnknownNode(name, parent); + } + } + + if (pathIterator.hasNext() && foundNode != null) { + return findSchemaNode(Iterables.skip(path, 1), foundNode); + } else { + return foundNode; + } + } + public static SchemaNodeBuilder findSchemaNode(final Iterable path, final SchemaNodeBuilder parentNode) { SchemaNodeBuilder node = null; SchemaNodeBuilder parent = parentNode; @@ -380,9 +402,9 @@ public final class BuilderUtils { node = findUnknownNode(name, parent); } } else if (parent instanceof RpcDefinitionBuilder) { - if ("input".equals(name)) { + if (INPUT.equals(name)) { node = ((RpcDefinitionBuilder) parent).getInput(); - } else if ("output".equals(name)) { + } else if (OUTPUT.equals(name)) { node = ((RpcDefinitionBuilder) parent).getOutput(); } else { if (node == null) { @@ -459,9 +481,8 @@ public final class BuilderUtils { return castOptional(SchemaNodeBuilder.class, findCaseInChoice((ChoiceBuilder) parent, child)); } else if (parent instanceof RpcDefinitionBuilder) { return castOptional(SchemaNodeBuilder.class, findContainerInRpc((RpcDefinitionBuilder) parent, child)); - } else { - LOG.trace("Child {} not found in node {}", child, parent); + LOG.trace(CHILD_NOT_FOUND_IN_NODE_STR, child, parent); return Optional.absent(); } } @@ -473,7 +494,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()) { @@ -506,7 +527,7 @@ public final class BuilderUtils { final QName child) { if (INPUT.equals(child.getLocalName())) { if (parent.getInput() == null) { - QName qname = QName.create(parent.getQName().getModule(), "input"); + 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); @@ -516,7 +537,7 @@ public final class BuilderUtils { return Optional.of(parent.getInput()); } else if (OUTPUT.equals(child.getLocalName())) { if (parent.getOutput() == null) { - QName qname = QName.create(parent.getQName().getModule(), "output"); + 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); @@ -525,7 +546,7 @@ public final class BuilderUtils { } return Optional.of(parent.getOutput()); } - LOG.trace("Child {} not found in node {}", child, parent); + LOG.trace(CHILD_NOT_FOUND_IN_NODE_STR, child, parent); return Optional.absent(); } @@ -546,7 +567,7 @@ public final class BuilderUtils { return Optional.of(caze); } } - LOG.trace("Child {} not found in node {}", child, parent); + LOG.trace(CHILD_NOT_FOUND_IN_NODE_STR, child, parent); return Optional.absent(); } @@ -567,7 +588,7 @@ public final class BuilderUtils { return Optional.of(childNode); } } - LOG.trace("Child {} not found in node {}", child, parent); + LOG.trace(CHILD_NOT_FOUND_IN_NODE_STR, child, parent); return Optional.absent(); } @@ -627,7 +648,7 @@ public final class BuilderUtils { return Optional. of(childNode); } } - LOG.trace("Child {} not found in node {}", child, builder); + LOG.trace(CHILD_NOT_FOUND_IN_NODE_STR, child, builder); return Optional.absent(); } @@ -635,10 +656,9 @@ 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, @@ -697,7 +717,7 @@ public final class BuilderUtils { /** * Get module in which this node is defined. * - * @param node + * @param node node * @return builder of module where this node is defined */ public static ModuleBuilder getParentModule(final Builder node) { @@ -733,19 +753,19 @@ public final class BuilderUtils { final SchemaPath schemaPath = parentPath.createChild(qname); if (node instanceof AnyXmlSchemaNode) { - return new AnyXmlBuilder(moduleName, line, qname, schemaPath, ((AnyXmlSchemaNode) node)); - } else if (node instanceof ChoiceNode) { - return new ChoiceBuilder(moduleName, line, qname, schemaPath, ((ChoiceNode) node)); + return new AnyXmlBuilder(moduleName, line, qname, schemaPath, (AnyXmlSchemaNode) node); + } else if (node instanceof ChoiceSchemaNode) { + return new ChoiceBuilder(moduleName, line, qname, schemaPath, (ChoiceSchemaNode) node); } else if (node instanceof ContainerSchemaNode) { - return new ContainerSchemaNodeBuilder(moduleName, line, qname, schemaPath, ((ContainerSchemaNode) node)); + return new ContainerSchemaNodeBuilder(moduleName, line, qname, schemaPath, (ContainerSchemaNode) node); } else if (node instanceof LeafSchemaNode) { - return new LeafSchemaNodeBuilder(moduleName, line, qname, schemaPath, ((LeafSchemaNode) node)); + return new LeafSchemaNodeBuilder(moduleName, line, qname, schemaPath, (LeafSchemaNode) node); } else if (node instanceof LeafListSchemaNode) { - return new LeafListSchemaNodeBuilder(moduleName, line, qname, schemaPath, ((LeafListSchemaNode) node)); + return new LeafListSchemaNodeBuilder(moduleName, line, qname, schemaPath, (LeafListSchemaNode) node); } else if (node instanceof ListSchemaNode) { - return new ListSchemaNodeBuilder(moduleName, line, qname, schemaPath, ((ListSchemaNode) node)); + return new ListSchemaNodeBuilder(moduleName, line, qname, schemaPath, (ListSchemaNode) node); } else if (node instanceof ChoiceCaseNode) { - return new ChoiceCaseBuilder(moduleName, line, qname, schemaPath, ((ChoiceCaseNode) node)); + return new ChoiceCaseBuilder(moduleName, line, qname, schemaPath, (ChoiceCaseNode) node); } else { throw new YangParseException(moduleName, line, "Failed to copy node: Unknown type of DataSchemaNode: " + node); @@ -770,7 +790,7 @@ public final class BuilderUtils { for (TypeDefinition node : nodes) { QName qname = QName.create(parentQName, node.getQName().getLocalName()); SchemaPath schemaPath = parentPath.createChild(qname); - result.add(new TypeDefinitionBuilderImpl(moduleName, line, qname, schemaPath, ((ExtendedType) node))); + result.add(new TypeDefinitionBuilderImpl(moduleName, line, qname, schemaPath, (ExtendedType) node)); } return result; } @@ -788,16 +808,16 @@ public final class BuilderUtils { private static final class ByteSourceImpl extends ByteSource { private final String toString; - private final ByteArrayOutputStream output = new ByteArrayOutputStream(); + private final byte[] data; private ByteSourceImpl(final InputStream input) throws IOException { toString = input.toString(); - IOUtils.copy(input, output); + data = ByteStreams.toByteArray(input); } @Override public InputStream openStream() throws IOException { - return new NamedByteArrayInputStream(output.toByteArray(), toString); + return new NamedByteArrayInputStream(data, toString); } } @@ -809,24 +829,50 @@ public final class BuilderUtils { } } - public static ModuleBuilder findModule(final QName qname, final Map> modules) { - TreeMap map = modules.get(qname.getNamespace()); + public static ModuleBuilder findModule(final QName qname, final Map> modules) { + NavigableMap map = modules.get(qname.getNamespace()); if (map == null) { return null; } if (qname.getRevision() == null) { return map.lastEntry().getValue(); } + + final Entry lastEntry = map.lastEntry(); + if (qname.getRevision().compareTo(lastEntry.getKey()) > 0) { + /* + * We are trying to find more recent revision of module than is in + * the map. Most probably the yang models are not referenced + * correctly and the revision of a base module or submodule has not + * been updated along with revision of a referenced module or + * submodule. However, we should return the most recent entry in the + * map, otherwise the null pointer exception occurs (see Bug3799). + */ + LOG.warn(String + .format("Attempt to find more recent revision of module than is available. " + + "The requested revision is [%s], but the most recent available revision of module is [%s]." + + " Most probably some of Yang models do not have updated revision or they are not " + + "referenced correctly.", + qname.getRevision(), lastEntry.getKey())); + return lastEntry.getValue(); + } + return map.get(qname.getRevision()); } - public static Map> createYangNamespaceContext( + public static Map> createYangNamespaceContext( final Collection modules, final Optional context) { - Map> map = new HashMap<>(); + 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 Module_stmtContext) { + 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; @@ -854,28 +900,56 @@ public final class BuilderUtils { } } } - TreeMap revToNs = map.get(moduleName); + // update namespaceContext + NavigableMap revToNs = namespaceContext.get(moduleName); if (revToNs == null) { revToNs = new TreeMap<>(); revToNs.put(rev, namespace); - map.put(moduleName, revToNs); + 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 = map.get(module.getName()); + NavigableMap revToNs = namespaceContext.get(module.getName()); if (revToNs == null) { revToNs = new TreeMap<>(); revToNs.put(module.getRevision(), module.getNamespace()); - map.put(module.getName(), revToNs); + namespaceContext.put(module.getName(), revToNs); } revToNs.put(module.getRevision(), module.getNamespace()); } } - return map; + // 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); + NavigableMap 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 + NavigableMap subNs = new TreeMap<>(); + subNs.put(ns.firstKey(), ns.firstEntry().getValue()); + namespaceContext.put(moduleName, subNs); + } + } + } + } + } + return namespaceContext; } }