2 * Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved.
4 * This program and the accompanying materials are made available under the
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
8 package org.opendaylight.yangtools.yang.parser.util;
10 import java.util.ArrayList;
11 import java.util.Arrays;
12 import java.util.Date;
13 import java.util.List;
15 import java.util.TreeMap;
17 import org.opendaylight.yangtools.yang.common.QName;
18 import org.opendaylight.yangtools.yang.model.api.ChoiceNode;
19 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
20 import org.opendaylight.yangtools.yang.model.api.Module;
21 import org.opendaylight.yangtools.yang.model.api.ModuleImport;
22 import org.opendaylight.yangtools.yang.model.api.NotificationDefinition;
23 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
24 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
25 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
26 import org.opendaylight.yangtools.yang.parser.builder.api.AugmentationSchemaBuilder;
27 import org.opendaylight.yangtools.yang.parser.builder.api.AugmentationTargetBuilder;
28 import org.opendaylight.yangtools.yang.parser.builder.api.Builder;
29 import org.opendaylight.yangtools.yang.parser.builder.api.DataNodeContainerBuilder;
30 import org.opendaylight.yangtools.yang.parser.builder.api.DataSchemaNodeBuilder;
31 import org.opendaylight.yangtools.yang.parser.builder.api.SchemaNodeBuilder;
32 import org.opendaylight.yangtools.yang.parser.builder.api.UsesNodeBuilder;
33 import org.opendaylight.yangtools.yang.parser.builder.impl.ChoiceBuilder;
34 import org.opendaylight.yangtools.yang.parser.builder.impl.ChoiceBuilder.ChoiceNodeImpl;
35 import org.opendaylight.yangtools.yang.parser.builder.impl.ChoiceCaseBuilder;
36 import org.opendaylight.yangtools.yang.parser.builder.impl.ChoiceCaseBuilder.ChoiceCaseNodeImpl;
37 import org.opendaylight.yangtools.yang.parser.builder.impl.ContainerSchemaNodeBuilder.ContainerSchemaNodeImpl;
38 import org.opendaylight.yangtools.yang.parser.builder.impl.IdentityrefTypeBuilder;
39 import org.opendaylight.yangtools.yang.parser.builder.impl.ListSchemaNodeBuilder.ListSchemaNodeImpl;
40 import org.opendaylight.yangtools.yang.parser.builder.impl.ModuleBuilder;
41 import org.opendaylight.yangtools.yang.parser.builder.impl.NotificationBuilder.NotificationDefinitionImpl;
42 import org.opendaylight.yangtools.yang.model.api.AugmentationTarget
45 public final class ParserUtils {
51 * Create new SchemaPath from given path and qname.
57 public static def SchemaPath createSchemaPath(SchemaPath schemaPath, QName... qname) {
58 val path = new ArrayList<QName>(schemaPath.getPath());
59 path.addAll(Arrays.asList(qname));
60 return new SchemaPath(path, schemaPath.isAbsolute());
64 * Get module import referenced by given prefix.
69 * prefix associated with import
70 * @return ModuleImport based on given prefix
72 public static def ModuleImport getModuleImport(ModuleBuilder builder, String prefix) {
73 for (ModuleImport mi : builder.getModuleImports()) {
74 if (mi.getPrefix().equals(prefix)) {
83 * Find dependent module based on given prefix
86 * all available modules
90 * target module prefix
92 * current line in yang model
93 * @return module builder if found, null otherwise
95 public static def ModuleBuilder findDependentModuleBuilder(Map<String, TreeMap<Date, ModuleBuilder>> modules,
96 ModuleBuilder module, String prefix, int line) {
97 var ModuleBuilder dependentModule = null;
98 var Date dependentModuleRevision = null;
100 if (prefix.equals(module.getPrefix())) {
101 dependentModule = module;
103 val ModuleImport dependentModuleImport = getModuleImport(module, prefix);
104 if (dependentModuleImport === null) {
105 throw new YangParseException(module.getName(), line, "No import found with prefix '" + prefix + "'.");
107 val String dependentModuleName = dependentModuleImport.getModuleName();
108 dependentModuleRevision = dependentModuleImport.getRevision();
110 val TreeMap<Date, ModuleBuilder> moduleBuildersByRevision = modules.get(dependentModuleName);
111 if (moduleBuildersByRevision === null) {
114 if (dependentModuleRevision === null) {
115 dependentModule = moduleBuildersByRevision.lastEntry().getValue();
117 dependentModule = moduleBuildersByRevision.get(dependentModuleRevision);
120 return dependentModule;
124 * Find module from context based on prefix.
128 * @param currentModule
131 * current prefix used to reference dependent module
133 * current line in yang model
134 * @return module based on given prefix if found in context, null otherwise
136 public static def Module findModuleFromContext(SchemaContext context, ModuleBuilder currentModule,
137 String prefix, int line) {
138 val modulesByRevision = new TreeMap<Date, Module>();
140 val dependentModuleImport = ParserUtils.getModuleImport(currentModule, prefix);
141 if (dependentModuleImport === null) {
142 throw new YangParseException(currentModule.getName(), line, "No import found with prefix '" + prefix + "'.");
144 val dependentModuleName = dependentModuleImport.getModuleName();
145 val dependentModuleRevision = dependentModuleImport.getRevision();
147 for (Module contextModule : context.getModules()) {
148 if (contextModule.getName().equals(dependentModuleName)) {
149 var revision = contextModule.getRevision();
150 if (revision === null) {
151 revision = new Date(0L);
153 modulesByRevision.put(revision, contextModule);
157 var Module result = null;
158 if (dependentModuleRevision === null) {
159 result = modulesByRevision.get(modulesByRevision.firstKey());
161 result = modulesByRevision.get(dependentModuleRevision);
167 * Parse XPath string.
171 * @return SchemaPath from given String
173 public static def SchemaPath parseXPathString(String xpathString) {
174 val absolute = xpathString.startsWith("/");
175 val String[] splittedPath = xpathString.split("/");
176 val path = new ArrayList<QName>();
178 for (String pathElement : splittedPath) {
179 if (pathElement.length() > 0) {
180 val String[] splittedElement = pathElement.split(":");
181 if (splittedElement.length == 1) {
182 name = new QName(null, null, null, splittedElement.get(0));
184 name = new QName(null, null, splittedElement.get(0), splittedElement.get(1));
189 return new SchemaPath(path, absolute);
193 * Add all augment's child nodes to given target.
196 * builder of augment statement
198 * augmentation target node
200 public static def void fillAugmentTarget(AugmentationSchemaBuilder augment, DataNodeContainerBuilder target) {
201 for (DataSchemaNodeBuilder child : augment.getChildNodeBuilders()) {
202 val childCopy = CopyUtils.copy(child, target, false);
203 childCopy.setAugmenting(true);
204 correctNodePath(child, target.getPath());
205 correctNodePath(childCopy, target.getPath());
207 target.addChildNode(childCopy);
208 } catch (YangParseException e) {
210 // more descriptive message
211 throw new YangParseException(augment.getModuleName(), augment.getLine(),
212 "Failed to perform augmentation: " + e.getMessage());
216 for (UsesNodeBuilder usesNode : augment.getUsesNodes()) {
217 val copy = CopyUtils.copyUses(usesNode, target);
218 target.addUsesNode(copy);
223 * Add all augment's child nodes to given target.
226 * builder of augment statement
228 * augmentation target choice node
230 public static def void fillAugmentTarget(AugmentationSchemaBuilder augment, ChoiceBuilder target) {
231 for (DataSchemaNodeBuilder builder : augment.getChildNodeBuilders()) {
232 val childCopy = CopyUtils.copy(builder, target, false);
233 childCopy.setAugmenting(true);
234 correctNodePath(builder, target.getPath());
235 correctNodePath(childCopy, target.getPath());
236 target.addCase(childCopy);
238 for (UsesNodeBuilder usesNode : augment.getUsesNodes()) {
239 if (usesNode !== null) {
240 throw new YangParseException(augment.getModuleName(), augment.getLine(),
241 "Error in augment parsing: cannot augment uses to choice");
247 * Create new schema path of node based on parent node schema path.
251 * @param parentSchemaPath
252 * schema path of node parent
254 static def void correctNodePath(SchemaNodeBuilder node, SchemaPath parentSchemaPath) {
257 val targetNodePath = new ArrayList<QName>(parentSchemaPath.getPath());
258 targetNodePath.add(node.getQName());
259 node.setPath(new SchemaPath(targetNodePath, true));
261 // set correct path for all child nodes
262 if (node instanceof DataNodeContainerBuilder) {
263 val dataNodeContainer = node as DataNodeContainerBuilder;
264 for (DataSchemaNodeBuilder child : dataNodeContainer.getChildNodeBuilders()) {
265 correctNodePath(child, node.getPath());
269 // set correct path for all cases
270 if (node instanceof ChoiceBuilder) {
271 val choiceBuilder = node as ChoiceBuilder;
272 for (ChoiceCaseBuilder choiceCaseBuilder : choiceBuilder.getCases()) {
273 correctNodePath(choiceCaseBuilder, node.getPath());
280 private static def Builder findNode(Builder firstNodeParent, List<QName> path, String moduleName, int line) {
281 var currentName = "";
282 var currentParent = firstNodeParent;
284 val max = path.size();
287 var qname = path.get(i);
289 currentName = qname.getLocalName();
290 if (currentParent instanceof DataNodeContainerBuilder) {
291 var dataNodeContainerParent = currentParent as DataNodeContainerBuilder;
292 var nodeFound = dataNodeContainerParent.getDataChildByName(currentName);
293 // if not found as regular child, search in uses
294 if (nodeFound == null) {
295 var found = searchUses(dataNodeContainerParent, currentName);
299 currentParent = found;
302 currentParent = nodeFound;
304 } else if (currentParent instanceof ChoiceBuilder) {
305 val choiceParent = currentParent as ChoiceBuilder;
306 currentParent = choiceParent.getCaseNodeByName(currentName);
308 throw new YangParseException(moduleName, line,
309 "Error in augment parsing: failed to find node " + currentName);
312 // if node in path not found, return null
313 if (currentParent == null) {
318 return currentParent;
321 private static def searchUses(DataNodeContainerBuilder dataNodeContainerParent, String name) {
322 var currentName = name;
323 for (unb : dataNodeContainerParent.usesNodes) {
324 val result = findNodeInUses(currentName, unb);
325 if (result != null) {
326 var copy = CopyUtils.copy(result, unb.getParent(), true);
327 unb.getTargetChildren().add(copy);
334 public static def getRpc(ModuleBuilder module,String name) {
335 for(rpc : module.rpcs) {
336 if(name == rpc.QName.localName) {
343 public static def getNotification(ModuleBuilder module,String name) {
344 for(notification : module.notifications) {
345 if(name == notification.QName.localName) {
351 private static def nextLevel(List<QName> path){
352 return path.subList(1,path.size)
356 * Find augment target node and perform augmentation.
359 * @param firstNodeParent
360 * parent of first node in path
362 * path to augment target
363 * @return true if augmentation process succeed, false otherwise
365 public static def boolean processAugmentation(AugmentationSchemaBuilder augment, Builder firstNodeParent,
368 // traverse augment target path and try to reach target node
369 val currentParent = findNode(firstNodeParent,path,augment.moduleName,augment.line);
370 if (currentParent === null) return false;
372 if ((currentParent instanceof DataNodeContainerBuilder)) {
373 fillAugmentTarget(augment, currentParent as DataNodeContainerBuilder);
374 } else if (currentParent instanceof ChoiceBuilder) {
375 fillAugmentTarget(augment, currentParent as ChoiceBuilder);
377 throw new YangParseException(augment.getModuleName(), augment.getLine(),
378 "Error in augment parsing: The target node MUST be either a container, list, choice, case, input, output, or notification node.");
380 (currentParent as AugmentationTargetBuilder).addAugmentation(augment);
381 augment.setResolved(true);
386 * Find node with given name in uses target.
389 * name of node to find
391 * uses node which target grouping should be searched
392 * @return node with given name if found, null otherwise
394 private static def DataSchemaNodeBuilder findNodeInUses(String localName, UsesNodeBuilder uses) {
395 for(child : uses.targetChildren) {
396 if (child.getQName().getLocalName().equals(localName)) {
401 val target = uses.groupingBuilder;
402 for (child : target.childNodeBuilders) {
403 if (child.getQName().getLocalName().equals(localName)) {
407 for (usesNode : target.usesNodes) {
408 val result = findNodeInUses(localName, usesNode);
409 if (result != null) {
417 * Find augment target node in given context and perform augmentation.
421 * path to augment target
425 * current prefix of target module
427 * SchemaContext containing already resolved modules
428 * @return true if augment process succeed, false otherwise
430 public static def boolean processAugmentationOnContext(AugmentationSchemaBuilder augment, List<QName> path,
431 ModuleBuilder module, String prefix, SchemaContext context) {
432 val int line = augment.getLine();
433 val Module dependentModule = findModuleFromContext(context, module, prefix, line);
434 if (dependentModule === null) {
435 throw new YangParseException(module.getName(), line,
436 "Error in augment parsing: failed to find module with prefix " + prefix + ".");
439 var currentName = path.get(0).getLocalName();
440 var SchemaNode currentParent = dependentModule.getDataChildByName(currentName);
441 if (currentParent === null) {
442 val notifications = dependentModule.getNotifications();
443 for (NotificationDefinition ntf : notifications) {
444 if (ntf.getQName().getLocalName().equals(currentName)) {
449 if (currentParent === null) {
450 throw new YangParseException(module.getName(), line,
451 "Error in augment parsing: failed to find node " + currentName + ".");
454 for (qname : path.nextLevel) {
455 currentName = qname.getLocalName();
456 if (currentParent instanceof DataNodeContainer) {
457 currentParent = (currentParent as DataNodeContainer).getDataChildByName(currentName);
458 } else if (currentParent instanceof ChoiceNode) {
459 currentParent = (currentParent as ChoiceNode).getCaseNodeByName(currentName);
461 throw new YangParseException(augment.getModuleName(), line,
462 "Error in augment parsing: failed to find node " + currentName);
465 // if node in path not found, return false
466 if (currentParent === null) {
467 throw new YangParseException(module.getName(), line,
468 "Error in augment parsing: failed to find node " + currentName + ".");
472 val oldPath = currentParent.path;
474 if (!(currentParent instanceof AugmentationTarget)) {
475 throw new YangParseException(module.getName(), line,
476 "Target of type " + currentParent.class + " cannot be augmented.");
479 switch (currentParent) {
480 case (currentParent instanceof ContainerSchemaNodeImpl): {
482 // includes container, input and output statement
483 val c = currentParent as ContainerSchemaNodeImpl;
484 val cb = c.toBuilder();
485 fillAugmentTarget(augment, cb);
486 (cb as AugmentationTargetBuilder ).addAugmentation(augment);
489 case (currentParent instanceof ListSchemaNodeImpl): {
490 val l = currentParent as ListSchemaNodeImpl;
491 val lb = l.toBuilder();
492 fillAugmentTarget(augment, lb);
493 (lb as AugmentationTargetBuilder ).addAugmentation(augment);
495 augment.setTargetPath(new SchemaPath(oldPath.getPath(), oldPath.isAbsolute()));
496 augment.setResolved(true);
498 case (currentParent instanceof ChoiceNodeImpl): {
499 val ch = currentParent as ChoiceNodeImpl;
500 val chb = ch.toBuilder();
501 fillAugmentTarget(augment, chb);
502 (chb as AugmentationTargetBuilder ).addAugmentation(augment);
504 augment.setTargetPath(new SchemaPath(oldPath.getPath(), oldPath.isAbsolute()));
505 augment.setResolved(true);
507 case (currentParent instanceof ChoiceCaseNodeImpl): {
508 val chc = currentParent as ChoiceCaseNodeImpl;
509 val chcb = chc.toBuilder();
510 fillAugmentTarget(augment, chcb);
511 (chcb as AugmentationTargetBuilder ).addAugmentation(augment);
513 augment.setTargetPath(new SchemaPath(oldPath.getPath(), oldPath.isAbsolute()));
514 augment.setResolved(true);
516 case (currentParent instanceof NotificationDefinitionImpl): {
517 val nd = currentParent as NotificationDefinitionImpl;
518 val nb = nd.toBuilder();
519 fillAugmentTarget(augment, nb);
520 (nb as AugmentationTargetBuilder ).addAugmentation(augment);
522 augment.setTargetPath(new SchemaPath(oldPath.getPath(), oldPath.isAbsolute()));
523 augment.setResolved(true);
526 augment.setTargetPath(new SchemaPath(oldPath.getPath(), oldPath.isAbsolute()));
527 augment.setResolved(true);
531 public static def QName findFullQName(Map<String, TreeMap<Date, ModuleBuilder>> modules,
532 ModuleBuilder module, IdentityrefTypeBuilder idref) {
533 var QName result = null;
534 val String baseString = idref.getBaseString();
535 if (baseString.contains(":")) {
536 val String[] splittedBase = baseString.split(":");
537 if (splittedBase.length > 2) {
538 throw new YangParseException(module.getName(), idref.getLine(),
539 "Failed to parse identityref base: " + baseString);
541 val prefix = splittedBase.get(0);
542 val name = splittedBase.get(1);
543 val dependentModule = findDependentModuleBuilder(modules, module, prefix, idref.getLine());
544 result = new QName(dependentModule.getNamespace(), dependentModule.getRevision(), prefix, name);
546 result = new QName(module.getNamespace(), module.getRevision(), module.getPrefix(), baseString);
552 * Get module in which this node is defined.
555 * @return builder of module where this node is defined
557 public static def ModuleBuilder getParentModule(Builder node) {
558 if (node instanceof ModuleBuilder) {
559 return node as ModuleBuilder;
561 var parent = node.getParent();
562 while (!(parent instanceof ModuleBuilder)) {
563 parent = parent.getParent();
565 return parent as ModuleBuilder;