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.controller.yang.model.parser.impl;
11 import java.io.FileInputStream;
12 import java.io.FileNotFoundException;
13 import java.io.IOException;
14 import java.io.InputStream;
16 import java.util.ArrayList;
17 import java.util.Collections;
18 import java.util.Date;
19 import java.util.HashMap;
20 import java.util.HashSet;
21 import java.util.Iterator;
22 import java.util.List;
24 import java.util.NoSuchElementException;
26 import java.util.TreeMap;
28 import org.antlr.v4.runtime.ANTLRInputStream;
29 import org.antlr.v4.runtime.CommonTokenStream;
30 import org.antlr.v4.runtime.tree.ParseTree;
31 import org.antlr.v4.runtime.tree.ParseTreeWalker;
32 import org.opendaylight.controller.antlrv4.code.gen.YangLexer;
33 import org.opendaylight.controller.antlrv4.code.gen.YangParser;
34 import org.opendaylight.controller.yang.common.QName;
35 import org.opendaylight.controller.yang.model.api.DataSchemaNode;
36 import org.opendaylight.controller.yang.model.api.ExtensionDefinition;
37 import org.opendaylight.controller.yang.model.api.Module;
38 import org.opendaylight.controller.yang.model.api.ModuleImport;
39 import org.opendaylight.controller.yang.model.api.MustDefinition;
40 import org.opendaylight.controller.yang.model.api.NotificationDefinition;
41 import org.opendaylight.controller.yang.model.api.RpcDefinition;
42 import org.opendaylight.controller.yang.model.api.SchemaContext;
43 import org.opendaylight.controller.yang.model.api.SchemaPath;
44 import org.opendaylight.controller.yang.model.api.TypeDefinition;
45 import org.opendaylight.controller.yang.model.api.type.BinaryTypeDefinition;
46 import org.opendaylight.controller.yang.model.api.type.DecimalTypeDefinition;
47 import org.opendaylight.controller.yang.model.api.type.IntegerTypeDefinition;
48 import org.opendaylight.controller.yang.model.api.type.LengthConstraint;
49 import org.opendaylight.controller.yang.model.api.type.PatternConstraint;
50 import org.opendaylight.controller.yang.model.api.type.RangeConstraint;
51 import org.opendaylight.controller.yang.model.api.type.StringTypeDefinition;
52 import org.opendaylight.controller.yang.model.parser.api.YangModelParser;
53 import org.opendaylight.controller.yang.model.parser.builder.api.AugmentationSchemaBuilder;
54 import org.opendaylight.controller.yang.model.parser.builder.api.AugmentationTargetBuilder;
55 import org.opendaylight.controller.yang.model.parser.builder.api.Builder;
56 import org.opendaylight.controller.yang.model.parser.builder.api.ChildNodeBuilder;
57 import org.opendaylight.controller.yang.model.parser.builder.api.DataSchemaNodeBuilder;
58 import org.opendaylight.controller.yang.model.parser.builder.api.GroupingBuilder;
59 import org.opendaylight.controller.yang.model.parser.builder.api.TypeAwareBuilder;
60 import org.opendaylight.controller.yang.model.parser.builder.api.TypeDefinitionBuilder;
61 import org.opendaylight.controller.yang.model.parser.builder.api.UsesNodeBuilder;
62 import org.opendaylight.controller.yang.model.parser.builder.impl.AnyXmlBuilder;
63 import org.opendaylight.controller.yang.model.parser.builder.impl.ChoiceBuilder;
64 import org.opendaylight.controller.yang.model.parser.builder.impl.ContainerSchemaNodeBuilder;
65 import org.opendaylight.controller.yang.model.parser.builder.impl.IdentitySchemaNodeBuilder;
66 import org.opendaylight.controller.yang.model.parser.builder.impl.IdentityrefTypeBuilder;
67 import org.opendaylight.controller.yang.model.parser.builder.impl.LeafListSchemaNodeBuilder;
68 import org.opendaylight.controller.yang.model.parser.builder.impl.LeafSchemaNodeBuilder;
69 import org.opendaylight.controller.yang.model.parser.builder.impl.ListSchemaNodeBuilder;
70 import org.opendaylight.controller.yang.model.parser.builder.impl.ModuleBuilder;
71 import org.opendaylight.controller.yang.model.parser.builder.impl.TypedefBuilder;
72 import org.opendaylight.controller.yang.model.parser.builder.impl.UnionTypeBuilder;
73 import org.opendaylight.controller.yang.model.parser.builder.impl.UnknownSchemaNodeBuilder;
74 import org.opendaylight.controller.yang.model.parser.util.ModuleDependencySort;
75 import org.opendaylight.controller.yang.model.parser.util.ModuleDependencySort.ModuleSimple;
76 import org.opendaylight.controller.yang.model.parser.util.ParserUtils;
77 import org.opendaylight.controller.yang.model.parser.util.RefineHolder;
78 import org.opendaylight.controller.yang.model.parser.util.TypeConstraints;
79 import org.opendaylight.controller.yang.model.parser.util.YangParseException;
80 import org.opendaylight.controller.yang.model.util.ExtendedType;
81 import org.opendaylight.controller.yang.model.util.IdentityrefType;
82 import org.opendaylight.controller.yang.model.util.UnknownType;
83 import org.opendaylight.controller.yang.model.validator.YangModelBasicValidator;
84 import org.slf4j.Logger;
85 import org.slf4j.LoggerFactory;
87 public class YangModelParserImpl implements YangModelParser {
89 private static final Logger logger = LoggerFactory
90 .getLogger(YangModelParserImpl.class);
93 public Set<Module> parseYangModels(final List<File> yangFiles) {
94 if (yangFiles != null) {
95 final List<InputStream> inputStreams = new ArrayList<InputStream>();
97 for (final File yangFile : yangFiles) {
99 inputStreams.add(new FileInputStream(yangFile));
100 } catch (FileNotFoundException e) {
101 logger.warn("Exception while reading yang file: "
102 + yangFile.getName(), e);
105 final Map<String, TreeMap<Date, ModuleBuilder>> modules = resolveModuleBuilders(inputStreams);
106 return build(modules);
108 return Collections.emptySet();
112 public Set<Module> parseYangModelsFromStreams(
113 final List<InputStream> yangModelStreams) {
114 final Map<String, TreeMap<Date, ModuleBuilder>> modules = resolveModuleBuilders(yangModelStreams);
115 return build(modules);
119 public SchemaContext resolveSchemaContext(final Set<Module> modules) {
120 return new SchemaContextImpl(modules);
123 private Map<String, TreeMap<Date, ModuleBuilder>> resolveModuleBuilders(
124 final List<InputStream> yangFileStreams) {
125 final Map<String, TreeMap<Date, ModuleBuilder>> modules = new HashMap<String, TreeMap<Date, ModuleBuilder>>();
126 final ParseTreeWalker walker = new ParseTreeWalker();
127 final List<ParseTree> trees = parseStreams(yangFileStreams);
128 final ModuleBuilder[] builders = new ModuleBuilder[trees.size()];
131 new YangModelBasicValidator(walker).validate(trees);
133 YangModelParserListenerImpl yangModelParser = null;
134 for (int i = 0; i < trees.size(); i++) {
135 yangModelParser = new YangModelParserListenerImpl();
136 walker.walk(yangModelParser, trees.get(i));
137 builders[i] = yangModelParser.getModuleBuilder();
140 // module dependency graph sorted
141 List<ModuleSimple> sorted = new ModuleDependencySort(builders).sort();
143 for (ModuleBuilder builder : builders) {
144 final String builderName = builder.getName();
145 Date builderRevision = builder.getRevision();
146 if (builderRevision == null) {
147 builderRevision = new Date(0L);
149 TreeMap<Date, ModuleBuilder> builderByRevision = modules
151 if (builderByRevision == null) {
152 builderByRevision = new TreeMap<Date, ModuleBuilder>();
154 builderByRevision.put(builderRevision, builder);
155 modules.put(builderName, builderByRevision);
160 private List<ParseTree> parseStreams(final List<InputStream> yangStreams) {
161 final List<ParseTree> trees = new ArrayList<ParseTree>();
162 for (InputStream yangStream : yangStreams) {
163 trees.add(parseStream(yangStream));
168 private ParseTree parseStream(final InputStream yangStream) {
169 ParseTree result = null;
171 final ANTLRInputStream input = new ANTLRInputStream(yangStream);
172 final YangLexer lexer = new YangLexer(input);
173 final CommonTokenStream tokens = new CommonTokenStream(lexer);
174 final YangParser parser = new YangParser(tokens);
175 result = parser.yang();
176 } catch (IOException e) {
177 logger.warn("Exception while reading yang file: " + yangStream, e);
182 private Set<Module> build(
183 final Map<String, TreeMap<Date, ModuleBuilder>> modules) {
184 // fix unresolved nodes
185 for (Map.Entry<String, TreeMap<Date, ModuleBuilder>> entry : modules
187 for (Map.Entry<Date, ModuleBuilder> childEntry : entry.getValue()
189 final ModuleBuilder moduleBuilder = childEntry.getValue();
190 fixUnresolvedNodes(modules, moduleBuilder);
193 resolveAugments(modules);
196 final Set<Module> result = new HashSet<Module>();
197 for (Map.Entry<String, TreeMap<Date, ModuleBuilder>> entry : modules
199 final Map<Date, Module> modulesByRevision = new HashMap<Date, Module>();
200 for (Map.Entry<Date, ModuleBuilder> childEntry : entry.getValue()
202 final ModuleBuilder moduleBuilder = childEntry.getValue();
203 final Module module = moduleBuilder.build();
204 modulesByRevision.put(childEntry.getKey(), module);
211 private void fixUnresolvedNodes(
212 final Map<String, TreeMap<Date, ModuleBuilder>> modules,
213 final ModuleBuilder builder) {
214 resolveDirtyNodes(modules, builder);
215 resolveIdentities(modules, builder);
216 resolveUses(modules, builder);
217 resolveUnknownNodes(modules, builder);
221 * Search for dirty nodes (node which contains UnknownType) and resolve
225 * all available modules
229 private void resolveDirtyNodes(
230 final Map<String, TreeMap<Date, ModuleBuilder>> modules,
231 final ModuleBuilder module) {
232 final Map<List<String>, TypeAwareBuilder> dirtyNodes = module
234 if (!dirtyNodes.isEmpty()) {
235 for (Map.Entry<List<String>, TypeAwareBuilder> entry : dirtyNodes
238 final TypeAwareBuilder nodeToResolve = entry.getValue();
239 // different handling for union types
240 if (nodeToResolve instanceof UnionTypeBuilder) {
241 final UnionTypeBuilder union = (UnionTypeBuilder) nodeToResolve;
242 final List<TypeDefinition<?>> unionTypes = union.getTypes();
243 final List<UnknownType> toRemove = new ArrayList<UnknownType>();
244 for (TypeDefinition<?> td : unionTypes) {
245 if (td instanceof UnknownType) {
246 final UnknownType unknownType = (UnknownType) td;
247 final TypeDefinitionBuilder resolvedType = resolveTypeUnion(
248 nodeToResolve, unknownType, modules, module);
249 union.setType(resolvedType);
250 toRemove.add(unknownType);
253 unionTypes.removeAll(toRemove);
254 } else if (nodeToResolve.getTypedef() instanceof IdentityrefTypeBuilder) {
255 IdentityrefTypeBuilder idref = (IdentityrefTypeBuilder) nodeToResolve
257 nodeToResolve.setType(new IdentityrefType(findFullQName(
258 modules, module, idref), idref.getPath()));
260 final TypeDefinitionBuilder resolvedType = resolveType(
261 nodeToResolve, modules, module);
262 nodeToResolve.setType(resolvedType);
268 private TypeDefinitionBuilder resolveType(
269 final TypeAwareBuilder typeToResolve,
270 final Map<String, TreeMap<Date, ModuleBuilder>> modules,
271 final ModuleBuilder builder) {
272 final TypeConstraints constraints = new TypeConstraints();
274 final TypeDefinitionBuilder targetType = getTypedefBuilder(
275 typeToResolve, modules, builder);
276 final TypeConstraints tConstraints = findConstraints(typeToResolve,
277 constraints, modules, builder);
278 targetType.setRanges(tConstraints.getRange());
279 targetType.setLengths(tConstraints.getLength());
280 targetType.setPatterns(tConstraints.getPatterns());
281 targetType.setFractionDigits(tConstraints.getFractionDigits());
286 private TypeDefinitionBuilder resolveTypeUnion(
287 final TypeAwareBuilder typeToResolve,
288 final UnknownType unknownType,
289 final Map<String, TreeMap<Date, ModuleBuilder>> modules,
290 final ModuleBuilder builder) {
291 final TypeConstraints constraints = new TypeConstraints();
293 final TypeDefinitionBuilder targetType = getUnionBuilder(typeToResolve,
294 unknownType, modules, builder);
295 final TypeConstraints tConstraints = findConstraints(typeToResolve,
296 constraints, modules, builder);
297 targetType.setRanges(tConstraints.getRange());
298 targetType.setLengths(tConstraints.getLength());
299 targetType.setPatterns(tConstraints.getPatterns());
300 targetType.setFractionDigits(tConstraints.getFractionDigits());
305 private TypeDefinitionBuilder getTypedefBuilder(
306 final TypeAwareBuilder nodeToResolve,
307 final Map<String, TreeMap<Date, ModuleBuilder>> modules,
308 final ModuleBuilder builder) {
310 final TypeDefinition<?> nodeToResolveBase = nodeToResolve.getType();
311 if (nodeToResolveBase != null
312 && !(nodeToResolveBase instanceof UnknownType)) {
313 return (TypeDefinitionBuilder) nodeToResolve;
316 final UnknownType unknownType = (UnknownType) nodeToResolve.getType();
317 final QName unknownTypeQName = unknownType.getQName();
319 // search for module which contains referenced typedef
320 final ModuleBuilder dependentModule = findDependentModule(modules,
321 builder, unknownTypeQName.getPrefix(), nodeToResolve.getLine());
322 final TypeDefinitionBuilder lookedUpBuilder = findTypedefBuilderByName(
323 dependentModule, unknownTypeQName.getLocalName(),
324 builder.getName(), nodeToResolve.getLine());
326 final TypeDefinitionBuilder lookedUpBuilderCopy = copyTypedefBuilder(
327 lookedUpBuilder, nodeToResolve instanceof TypeDefinitionBuilder);
328 final TypeDefinitionBuilder resolvedCopy = resolveCopiedBuilder(
329 lookedUpBuilderCopy, modules, dependentModule);
333 private TypeDefinitionBuilder getUnionBuilder(
334 final TypeAwareBuilder nodeToResolve,
335 final UnknownType unknownType,
336 final Map<String, TreeMap<Date, ModuleBuilder>> modules,
337 final ModuleBuilder module) {
339 final TypeDefinition<?> baseTypeToResolve = nodeToResolve.getType();
340 if (baseTypeToResolve != null
341 && !(baseTypeToResolve instanceof UnknownType)) {
342 return (TypeDefinitionBuilder) nodeToResolve;
345 final QName unknownTypeQName = unknownType.getQName();
346 // search for module which contains referenced typedef
347 final ModuleBuilder dependentModule = findDependentModule(modules,
348 module, unknownTypeQName.getPrefix(), nodeToResolve.getLine());
349 final TypeDefinitionBuilder lookedUpBuilder = findTypedefBuilderByName(
350 dependentModule, unknownTypeQName.getLocalName(),
351 module.getName(), nodeToResolve.getLine());
353 final TypeDefinitionBuilder lookedUpBuilderCopy = copyTypedefBuilder(
354 lookedUpBuilder, nodeToResolve instanceof TypeDefinitionBuilder);
355 final TypeDefinitionBuilder resolvedCopy = resolveCopiedBuilder(
356 lookedUpBuilderCopy, modules, dependentModule);
360 private TypeDefinitionBuilder copyTypedefBuilder(
361 final TypeDefinitionBuilder old, final boolean seekByTypedefBuilder) {
362 if (old instanceof UnionTypeBuilder) {
363 final UnionTypeBuilder oldUnion = (UnionTypeBuilder) old;
364 final UnionTypeBuilder newUnion = new UnionTypeBuilder(
365 oldUnion.getActualPath(), oldUnion.getNamespace(),
366 oldUnion.getRevision(), old.getLine());
367 for (TypeDefinition<?> td : oldUnion.getTypes()) {
368 newUnion.setType(td);
370 for (TypeDefinitionBuilder tdb : oldUnion.getTypedefs()) {
371 newUnion.setType(copyTypedefBuilder(tdb, true));
376 final QName oldName = old.getQName();
377 final QName newName = new QName(oldName.getNamespace(),
378 oldName.getRevision(), oldName.getPrefix(),
379 oldName.getLocalName());
380 final TypeDefinitionBuilder tdb = new TypedefBuilder(newName,
383 tdb.setRanges(old.getRanges());
384 tdb.setLengths(old.getLengths());
385 tdb.setPatterns(old.getPatterns());
386 tdb.setFractionDigits(old.getFractionDigits());
387 tdb.setPath(old.getPath());
389 final TypeDefinition<?> oldType = old.getType();
390 if (oldType == null) {
391 tdb.setType(old.getTypedef());
393 tdb.setType(oldType);
396 if (!seekByTypedefBuilder) {
397 tdb.setDescription(old.getDescription());
398 tdb.setReference(old.getReference());
399 tdb.setStatus(old.getStatus());
400 tdb.setDefaultValue(old.getDefaultValue());
401 tdb.setUnits(old.getUnits());
406 private TypeDefinitionBuilder resolveCopiedBuilder(
407 final TypeDefinitionBuilder copy,
408 final Map<String, TreeMap<Date, ModuleBuilder>> modules,
409 final ModuleBuilder builder) {
411 if (copy instanceof UnionTypeBuilder) {
412 final UnionTypeBuilder union = (UnionTypeBuilder) copy;
413 final List<TypeDefinition<?>> unionTypes = union.getTypes();
414 final List<UnknownType> toRemove = new ArrayList<UnknownType>();
415 for (TypeDefinition<?> td : unionTypes) {
416 if (td instanceof UnknownType) {
417 final UnknownType unknownType = (UnknownType) td;
418 final TypeDefinitionBuilder resolvedType = resolveTypeUnion(
419 union, unknownType, modules, builder);
420 union.setType(resolvedType);
421 toRemove.add(unknownType);
424 unionTypes.removeAll(toRemove);
429 final TypeDefinition<?> base = copy.getType();
430 final TypeDefinitionBuilder baseTdb = copy.getTypedef();
431 if (base != null && !(base instanceof UnknownType)) {
433 } else if (base instanceof UnknownType) {
434 final UnknownType unknownType = (UnknownType) base;
435 final QName unknownTypeQName = unknownType.getQName();
436 final String unknownTypePrefix = unknownTypeQName.getPrefix();
437 final ModuleBuilder dependentModule = findDependentModule(modules,
438 builder, unknownTypePrefix, copy.getLine());
439 final TypeDefinitionBuilder utBuilder = getTypedefBuilder(copy,
440 modules, dependentModule);
441 copy.setType(utBuilder);
443 } else if (base == null && baseTdb != null) {
444 // make a copy of baseTypeDef and call again
445 final TypeDefinitionBuilder baseTdbCopy = copyTypedefBuilder(
447 final TypeDefinitionBuilder baseTdbCopyResolved = resolveCopiedBuilder(
448 baseTdbCopy, modules, builder);
449 copy.setType(baseTdbCopyResolved);
452 throw new IllegalStateException("Failed to resolve type "
453 + copy.getQName().getLocalName());
457 private TypeDefinitionBuilder findTypedefBuilder(
458 final QName unknownTypeQName,
459 final Map<String, TreeMap<Date, ModuleBuilder>> modules,
460 final ModuleBuilder builder, int line) {
461 // search for module which contains referenced typedef
462 final ModuleBuilder dependentModule = findDependentModule(modules,
463 builder, unknownTypeQName.getPrefix(), line);
464 final TypeDefinitionBuilder lookedUpBuilder = findTypedefBuilderByName(
465 dependentModule, unknownTypeQName.getLocalName(),
466 builder.getName(), line);
467 return copyTypedefBuilder(lookedUpBuilder, true);
470 private TypeConstraints findConstraints(
471 final TypeAwareBuilder nodeToResolve,
472 final TypeConstraints constraints,
473 final Map<String, TreeMap<Date, ModuleBuilder>> modules,
474 final ModuleBuilder builder) {
475 // union type cannot be restricted
476 if (nodeToResolve instanceof UnionTypeBuilder) {
480 // if referenced type is UnknownType again, search recursively with
481 // current constraints
482 final TypeDefinition<?> referencedType = nodeToResolve.getType();
483 List<RangeConstraint> ranges = Collections.emptyList();
484 List<LengthConstraint> lengths = Collections.emptyList();
485 List<PatternConstraint> patterns = Collections.emptyList();
486 Integer fractionDigits = null;
487 if (referencedType == null) {
488 final TypeDefinitionBuilder tdb = (TypeDefinitionBuilder) nodeToResolve;
489 ranges = tdb.getRanges();
490 constraints.addRanges(ranges);
491 lengths = tdb.getLengths();
492 constraints.addLengths(lengths);
493 patterns = tdb.getPatterns();
494 constraints.addPatterns(patterns);
495 fractionDigits = tdb.getFractionDigits();
496 constraints.setFractionDigits(fractionDigits);
498 } else if (referencedType instanceof ExtendedType) {
499 final ExtendedType ext = (ExtendedType) referencedType;
500 ranges = ext.getRanges();
501 constraints.addRanges(ranges);
502 lengths = ext.getLengths();
503 constraints.addLengths(lengths);
504 patterns = ext.getPatterns();
505 constraints.addPatterns(patterns);
506 fractionDigits = ext.getFractionDigits();
507 constraints.setFractionDigits(fractionDigits);
508 return findConstraints(
509 findTypedefBuilder(ext.getQName(), modules, builder,
510 nodeToResolve.getLine()), constraints, modules,
512 } else if (referencedType instanceof UnknownType) {
513 final UnknownType unknown = (UnknownType) referencedType;
514 ranges = unknown.getRangeStatements();
515 constraints.addRanges(ranges);
516 lengths = unknown.getLengthStatements();
517 constraints.addLengths(lengths);
518 patterns = unknown.getPatterns();
519 constraints.addPatterns(patterns);
520 fractionDigits = unknown.getFractionDigits();
521 constraints.setFractionDigits(fractionDigits);
523 String unknownTypePrefix = unknown.getQName().getPrefix();
524 if (unknownTypePrefix == null || "".equals(unknownTypePrefix)) {
525 unknownTypePrefix = builder.getPrefix();
527 final ModuleBuilder dependentModule = findDependentModule(modules,
528 builder, unknown.getQName().getPrefix(),
529 nodeToResolve.getLine());
530 final TypeDefinitionBuilder utBuilder = findTypedefBuilder(
531 unknown.getQName(), modules, builder,
532 nodeToResolve.getLine());
533 return findConstraints(utBuilder, constraints, modules,
536 // HANDLE BASE YANG TYPE
537 mergeConstraints(referencedType, constraints);
543 * Go through all typedef statements from given module and search for one
547 * typedef statements to search
549 * name of searched typedef
550 * @return typedef with name equals to given name
552 private TypeDefinitionBuilder findTypedefBuilderByName(
553 final ModuleBuilder dependentModule, final String name,
554 final String currentModuleName, final int line) {
555 TypeDefinitionBuilder result = null;
556 final Set<TypeDefinitionBuilder> typedefs = dependentModule
557 .getModuleTypedefs();
558 for (TypeDefinitionBuilder td : typedefs) {
559 if (td.getQName().getLocalName().equals(name)) {
564 if (result == null) {
565 throw new YangParseException(currentModuleName, line,
566 "Target module '" + dependentModule.getName()
567 + "' does not contain typedef '" + name + "'.");
573 * Pull restriction from referenced type and add them to given constraints
575 * @param referencedType
578 private void mergeConstraints(final TypeDefinition<?> referencedType,
579 final TypeConstraints constraints) {
581 if (referencedType instanceof DecimalTypeDefinition) {
582 constraints.addRanges(((DecimalTypeDefinition) referencedType)
583 .getRangeStatements());
585 .setFractionDigits(((DecimalTypeDefinition) referencedType)
586 .getFractionDigits());
587 } else if (referencedType instanceof IntegerTypeDefinition) {
588 constraints.addRanges(((IntegerTypeDefinition) referencedType)
589 .getRangeStatements());
590 } else if (referencedType instanceof StringTypeDefinition) {
591 constraints.addPatterns(((StringTypeDefinition) referencedType)
593 constraints.addLengths(((StringTypeDefinition) referencedType)
594 .getLengthStatements());
595 } else if (referencedType instanceof BinaryTypeDefinition) {
596 constraints.addLengths(((BinaryTypeDefinition) referencedType)
597 .getLengthConstraints());
602 * Go through all augmentation definitions and resolve them. This method
603 * also finds referenced node and add child nodes to it.
606 * all available modules
608 private void resolveAugments(
609 final Map<String, TreeMap<Date, ModuleBuilder>> modules) {
610 final List<ModuleBuilder> allModulesList = new ArrayList<ModuleBuilder>();
611 final Set<ModuleBuilder> allModulesSet = new HashSet<ModuleBuilder>();
612 for (Map.Entry<String, TreeMap<Date, ModuleBuilder>> entry : modules
614 for (Map.Entry<Date, ModuleBuilder> inner : entry.getValue()
616 allModulesList.add(inner.getValue());
617 allModulesSet.add(inner.getValue());
621 for (int i = 0; i < allModulesList.size(); i++) {
622 final ModuleBuilder module = allModulesList.get(i);
623 // try to resolve augments in module
624 resolveAugment(modules, module);
625 // while all augments are not resolved
626 final Iterator<ModuleBuilder> allModulesIterator = allModulesSet
628 while (!(module.getAugmentsResolved() == module.getAddedAugments()
630 ModuleBuilder nextModule = null;
631 // try resolve other module augments
633 nextModule = allModulesIterator.next();
634 resolveAugment(modules, nextModule);
635 } catch (NoSuchElementException e) {
636 throw new YangParseException(
637 "Failed to resolve augments in module '"
638 + module.getName() + "'.", e);
640 // then try to resolve first module again
641 resolveAugment(modules, module);
649 * all available modules
653 private void resolveAugment(
654 final Map<String, TreeMap<Date, ModuleBuilder>> modules,
655 final ModuleBuilder module) {
656 if (module.getAugmentsResolved() < module.getAddedAugments().size()) {
657 for (AugmentationSchemaBuilder augmentBuilder : module
658 .getAddedAugments()) {
659 final SchemaPath augmentTargetSchemaPath = augmentBuilder
661 final List<QName> path = augmentTargetSchemaPath.getPath();
664 final QName qname = path.get(i);
665 String prefix = qname.getPrefix();
666 if (prefix == null) {
667 prefix = module.getPrefix();
670 DataSchemaNodeBuilder currentParent = null;
671 final ModuleBuilder dependentModule = findDependentModule(
672 modules, module, prefix, augmentBuilder.getLine());
673 for (DataSchemaNodeBuilder child : dependentModule
675 final QName childQName = child.getQName();
676 if (childQName.getLocalName().equals(qname.getLocalName())) {
677 currentParent = child;
683 for (; i < path.size(); i++) {
684 final QName currentQName = path.get(i);
685 DataSchemaNodeBuilder newParent = null;
686 for (DataSchemaNodeBuilder child : ((ChildNodeBuilder) currentParent)
688 final QName childQName = child.getQName();
689 if (childQName.getLocalName().equals(
690 currentQName.getLocalName())) {
695 if (newParent == null) {
696 break; // node not found, quit search
698 currentParent = newParent;
702 final QName currentQName = currentParent.getQName();
703 final QName lastAugmentPathElement = path.get(path.size() - 1);
704 if (currentQName.getLocalName().equals(
705 lastAugmentPathElement.getLocalName())) {
706 ParserUtils.fillAugmentTarget(augmentBuilder,
707 (ChildNodeBuilder) currentParent);
708 ((AugmentationTargetBuilder) currentParent)
709 .addAugmentation(augmentBuilder);
710 module.augmentResolved();
717 * Go through identity statements defined in current module and resolve
718 * their 'base' statement if present.
723 * module being resolved
725 private void resolveIdentities(
726 final Map<String, TreeMap<Date, ModuleBuilder>> modules,
727 final ModuleBuilder module) {
728 final Set<IdentitySchemaNodeBuilder> identities = module
729 .getAddedIdentities();
730 for (IdentitySchemaNodeBuilder identity : identities) {
731 final String baseIdentityName = identity.getBaseIdentityName();
732 if (baseIdentityName != null) {
733 String baseIdentityPrefix = null;
734 String baseIdentityLocalName = null;
735 if (baseIdentityName.contains(":")) {
736 final String[] splitted = baseIdentityName.split(":");
737 baseIdentityPrefix = splitted[0];
738 baseIdentityLocalName = splitted[1];
740 baseIdentityPrefix = module.getPrefix();
741 baseIdentityLocalName = baseIdentityName;
743 final ModuleBuilder dependentModule = findDependentModule(
744 modules, module, baseIdentityPrefix, identity.getLine());
746 final Set<IdentitySchemaNodeBuilder> dependentModuleIdentities = dependentModule
747 .getAddedIdentities();
748 for (IdentitySchemaNodeBuilder idBuilder : dependentModuleIdentities) {
749 if (idBuilder.getQName().getLocalName()
750 .equals(baseIdentityLocalName)) {
751 identity.setBaseIdentity(idBuilder);
759 * Go through uses statements defined in current module and resolve their
765 * module being resolved
767 private void resolveUses(
768 final Map<String, TreeMap<Date, ModuleBuilder>> modules,
769 final ModuleBuilder module) {
770 final Map<List<String>, UsesNodeBuilder> moduleUses = module
771 .getAddedUsesNodes();
772 for (Map.Entry<List<String>, UsesNodeBuilder> entry : moduleUses
774 final List<String> key = entry.getKey();
775 final UsesNodeBuilder usesNode = entry.getValue();
777 final String groupingName = key.get(key.size() - 1);
779 for (RefineHolder refine : usesNode.getRefines()) {
781 final String defaultStr = refine.getDefaultStr();
782 final Boolean mandatory = refine.isMandatory();
783 final MustDefinition must = refine.getMust();
784 final Boolean presence = refine.isPresence();
785 final Integer min = refine.getMinElements();
786 final Integer max = refine.getMaxElements();
787 final List<UnknownSchemaNodeBuilder> unknownNodes = refine
790 Builder refineTarget = getRefineTargetBuilder(groupingName,
791 refine, modules, module);
792 if (refineTarget instanceof LeafSchemaNodeBuilder) {
793 final LeafSchemaNodeBuilder leaf = (LeafSchemaNodeBuilder) refineTarget;
794 if (defaultStr != null && !("".equals(defaultStr))) {
795 leaf.setDefaultStr(defaultStr);
797 if (mandatory != null) {
798 leaf.getConstraints().setMandatory(mandatory);
801 leaf.getConstraints().addMustDefinition(must);
803 if (unknownNodes != null) {
804 for (UnknownSchemaNodeBuilder unknown : unknownNodes) {
805 leaf.addUnknownSchemaNode(unknown);
808 usesNode.addRefineNode(leaf);
809 } else if (refineTarget instanceof ContainerSchemaNodeBuilder) {
810 final ContainerSchemaNodeBuilder container = (ContainerSchemaNodeBuilder) refineTarget;
811 if (presence != null) {
812 container.setPresence(presence);
815 container.getConstraints().addMustDefinition(must);
817 if (unknownNodes != null) {
818 for (UnknownSchemaNodeBuilder unknown : unknownNodes) {
819 container.addUnknownSchemaNode(unknown);
822 usesNode.addRefineNode(container);
823 } else if (refineTarget instanceof ListSchemaNodeBuilder) {
824 final ListSchemaNodeBuilder list = (ListSchemaNodeBuilder) refineTarget;
826 list.getConstraints().addMustDefinition(must);
829 list.getConstraints().setMinElements(min);
832 list.getConstraints().setMaxElements(max);
834 if (unknownNodes != null) {
835 for (UnknownSchemaNodeBuilder unknown : unknownNodes) {
836 list.addUnknownSchemaNode(unknown);
839 } else if (refineTarget instanceof LeafListSchemaNodeBuilder) {
840 final LeafListSchemaNodeBuilder leafList = (LeafListSchemaNodeBuilder) getRefineTargetBuilder(
841 groupingName, refine, modules, module);
843 leafList.getConstraints().addMustDefinition(must);
846 leafList.getConstraints().setMinElements(min);
849 leafList.getConstraints().setMaxElements(max);
851 if (unknownNodes != null) {
852 for (UnknownSchemaNodeBuilder unknown : unknownNodes) {
853 leafList.addUnknownSchemaNode(unknown);
856 } else if (refineTarget instanceof ChoiceBuilder) {
857 final ChoiceBuilder choice = (ChoiceBuilder) refineTarget;
858 if (defaultStr != null) {
859 choice.setDefaultCase(defaultStr);
861 if (mandatory != null) {
862 choice.getConstraints().setMandatory(mandatory);
864 if (unknownNodes != null) {
865 for (UnknownSchemaNodeBuilder unknown : unknownNodes) {
866 choice.addUnknownSchemaNode(unknown);
869 } else if (refineTarget instanceof AnyXmlBuilder) {
870 final AnyXmlBuilder anyXml = (AnyXmlBuilder) refineTarget;
871 if (mandatory != null) {
872 anyXml.getConstraints().setMandatory(mandatory);
875 anyXml.getConstraints().addMustDefinition(must);
877 if (unknownNodes != null) {
878 for (UnknownSchemaNodeBuilder unknown : unknownNodes) {
879 anyXml.addUnknownSchemaNode(unknown);
888 * Find original builder of refine node and return copy of this builder.
890 * @param groupingPath
891 * path to grouping which contains node to refine
893 * refine object containing informations about refine
898 * @return copy of Builder object of node to be refined if it is present in
899 * grouping, null otherwise
901 private Builder getRefineTargetBuilder(final String groupingPath,
902 final RefineHolder refine,
903 final Map<String, TreeMap<Date, ModuleBuilder>> modules,
904 final ModuleBuilder module) {
905 Builder result = null;
906 final Builder lookedUpBuilder = findRefineTargetBuilder(groupingPath,
907 refine, modules, module);
908 if (lookedUpBuilder instanceof LeafSchemaNodeBuilder) {
910 .copyLeafBuilder((LeafSchemaNodeBuilder) lookedUpBuilder);
911 } else if (lookedUpBuilder instanceof ContainerSchemaNodeBuilder) {
913 .copyContainerBuilder((ContainerSchemaNodeBuilder) lookedUpBuilder);
914 } else if (lookedUpBuilder instanceof ListSchemaNodeBuilder) {
916 .copyListBuilder((ListSchemaNodeBuilder) lookedUpBuilder);
917 } else if (lookedUpBuilder instanceof LeafListSchemaNodeBuilder) {
919 .copyLeafListBuilder((LeafListSchemaNodeBuilder) lookedUpBuilder);
920 } else if (lookedUpBuilder instanceof ChoiceBuilder) {
922 .copyChoiceBuilder((ChoiceBuilder) lookedUpBuilder);
923 } else if (lookedUpBuilder instanceof AnyXmlBuilder) {
925 .copyAnyXmlBuilder((AnyXmlBuilder) lookedUpBuilder);
927 throw new YangParseException(module.getName(), refine.getLine(),
928 "Target '" + refine.getName() + "' can not be refined");
934 * Find builder of refine node.
936 * @param groupingPath
937 * path to grouping which contains node to refine
938 * @param refineNodeName
939 * name of node to be refined
944 * @return Builder object of refine node if it is present in grouping, null
947 private Builder findRefineTargetBuilder(final String groupingPath,
948 final RefineHolder refine,
949 final Map<String, TreeMap<Date, ModuleBuilder>> modules,
950 final ModuleBuilder module) {
951 final SchemaPath path = ParserUtils.parseUsesPath(groupingPath);
952 final List<String> builderPath = new ArrayList<String>();
953 String prefix = null;
954 for (QName qname : path.getPath()) {
955 builderPath.add(qname.getLocalName());
956 prefix = qname.getPrefix();
958 if (prefix == null) {
959 prefix = module.getPrefix();
962 final ModuleBuilder dependentModule = findDependentModule(modules,
963 module, prefix, refine.getLine());
964 builderPath.add(0, "grouping");
965 builderPath.add(0, dependentModule.getName());
966 final GroupingBuilder builder = (GroupingBuilder) dependentModule
967 .getNode(builderPath);
969 return builder.getChildNode(refine.getName());
972 private QName findFullQName(
973 final Map<String, TreeMap<Date, ModuleBuilder>> modules,
974 final ModuleBuilder module, final IdentityrefTypeBuilder idref) {
976 String baseString = idref.getBaseString();
977 if (baseString.contains(":")) {
978 String[] splittedBase = baseString.split(":");
979 if (splittedBase.length > 2) {
980 throw new YangParseException(module.getName(), idref.getLine(),
981 "Failed to parse identityref base: " + baseString);
983 String prefix = splittedBase[0];
984 String name = splittedBase[1];
985 ModuleBuilder dependentModule = findDependentModule(modules,
986 module, prefix, idref.getLine());
987 result = new QName(dependentModule.getNamespace(),
988 dependentModule.getRevision(), prefix, name);
990 result = new QName(module.getNamespace(), module.getRevision(),
991 module.getPrefix(), baseString);
996 private void resolveUnknownNodes(
997 final Map<String, TreeMap<Date, ModuleBuilder>> modules,
998 final ModuleBuilder module) {
999 for (UnknownSchemaNodeBuilder usnb : module.getAddedUnknownNodes()) {
1000 QName nodeType = usnb.getNodeType();
1001 if (nodeType.getNamespace() == null
1002 || nodeType.getRevision() == null) {
1004 ModuleBuilder dependentModule = findDependentModule(
1005 modules, module, nodeType.getPrefix(),
1007 QName newNodeType = new QName(
1008 dependentModule.getNamespace(),
1009 dependentModule.getRevision(),
1010 nodeType.getPrefix(), nodeType.getLocalName());
1011 usnb.setNodeType(newNodeType);
1012 } catch (YangParseException e) {
1013 logger.debug(module.getName(), usnb.getLine(),
1014 "Failed to find unknown node type: " + nodeType);
1021 * Find dependent module based on given prefix
1024 * all available modules
1028 * target module prefix
1031 private ModuleBuilder findDependentModule(
1032 final Map<String, TreeMap<Date, ModuleBuilder>> modules,
1033 final ModuleBuilder module, final String prefix, final int line) {
1034 ModuleBuilder dependentModule = null;
1035 Date dependentModuleRevision = null;
1037 if (prefix.equals(module.getPrefix())) {
1038 dependentModule = module;
1040 final ModuleImport dependentModuleImport = ParserUtils
1041 .getModuleImport(module, prefix);
1042 if (dependentModuleImport == null) {
1043 throw new YangParseException(module.getName(), line,
1044 "No import found with prefix '" + prefix + "'.");
1046 final String dependentModuleName = dependentModuleImport
1048 dependentModuleRevision = dependentModuleImport.getRevision();
1050 final TreeMap<Date, ModuleBuilder> moduleBuildersByRevision = modules
1051 .get(dependentModuleName);
1052 if (moduleBuildersByRevision == null) {
1053 throw new YangParseException(module.getName(), line,
1054 "Failed to find dependent module '"
1055 + dependentModuleName + "'.");
1057 if (dependentModuleRevision == null) {
1058 dependentModule = moduleBuildersByRevision.lastEntry()
1061 dependentModule = moduleBuildersByRevision
1062 .get(dependentModuleRevision);
1066 if (dependentModule == null) {
1067 throw new YangParseException(module.getName(), line,
1068 "Failed to find dependent module with prefix '" + prefix
1069 + "' and revision '" + dependentModuleRevision
1072 return dependentModule;
1075 private static class SchemaContextImpl implements SchemaContext {
1076 private final Set<Module> modules;
1078 private SchemaContextImpl(final Set<Module> modules) {
1079 this.modules = modules;
1083 public Set<DataSchemaNode> getDataDefinitions() {
1084 final Set<DataSchemaNode> dataDefs = new HashSet<DataSchemaNode>();
1085 for (Module m : modules) {
1086 dataDefs.addAll(m.getChildNodes());
1092 public Set<Module> getModules() {
1097 public Set<NotificationDefinition> getNotifications() {
1098 final Set<NotificationDefinition> notifications = new HashSet<NotificationDefinition>();
1099 for (Module m : modules) {
1100 notifications.addAll(m.getNotifications());
1102 return notifications;
1106 public Set<RpcDefinition> getOperations() {
1107 final Set<RpcDefinition> rpcs = new HashSet<RpcDefinition>();
1108 for (Module m : modules) {
1109 rpcs.addAll(m.getRpcs());
1115 public Set<ExtensionDefinition> getExtensions() {
1116 final Set<ExtensionDefinition> extensions = new HashSet<ExtensionDefinition>();
1117 for (Module m : modules) {
1118 extensions.addAll(m.getExtensionSchemaNodes());
1124 public Module findModuleByName(final String name, final Date revision) {
1125 if ((name != null) && (revision != null)) {
1126 for (final Module module : modules) {
1127 if (module.getName().equals(name)
1128 && module.getRevision().equals(revision)) {
1137 public Module findModuleByNamespace(final URI namespace) {
1138 if (namespace != null) {
1139 for (final Module module : modules) {
1140 if (module.getNamespace().equals(namespace)) {