2 * Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved.
3 * This program and the accompanying materials are made available under the
4 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
5 * and is available at http://www.eclipse.org/legal/epl-v10.html
7 package org.opendaylight.yangtools.yang.parser.impl;
9 import static com.google.common.base.Preconditions.checkNotNull;
10 import static org.opendaylight.yangtools.yang.parser.util.ParserUtils.fillAugmentTarget;
11 import static org.opendaylight.yangtools.yang.parser.util.ParserUtils.findBaseIdentity;
12 import static org.opendaylight.yangtools.yang.parser.util.ParserUtils.findModuleFromBuilders;
13 import static org.opendaylight.yangtools.yang.parser.util.ParserUtils.findModuleFromContext;
14 import static org.opendaylight.yangtools.yang.parser.util.ParserUtils.findSchemaNode;
15 import static org.opendaylight.yangtools.yang.parser.util.ParserUtils.findSchemaNodeInModule;
16 import static org.opendaylight.yangtools.yang.parser.util.ParserUtils.processAugmentation;
17 import static org.opendaylight.yangtools.yang.parser.util.ParserUtils.setNodeAddedByUses;
18 import static org.opendaylight.yangtools.yang.parser.util.ParserUtils.wrapChildNode;
19 import static org.opendaylight.yangtools.yang.parser.util.ParserUtils.wrapChildNodes;
20 import static org.opendaylight.yangtools.yang.parser.util.ParserUtils.wrapGroupings;
21 import static org.opendaylight.yangtools.yang.parser.util.ParserUtils.wrapTypedefs;
22 import static org.opendaylight.yangtools.yang.parser.util.ParserUtils.wrapUnknownNodes;
23 import static org.opendaylight.yangtools.yang.parser.util.TypeUtils.resolveType;
24 import static org.opendaylight.yangtools.yang.parser.util.TypeUtils.resolveTypeUnion;
25 import static org.opendaylight.yangtools.yang.parser.util.TypeUtils.resolveTypeUnionWithContext;
26 import static org.opendaylight.yangtools.yang.parser.util.TypeUtils.resolveTypeWithContext;
29 import java.io.IOException;
30 import java.io.InputStream;
32 import java.util.ArrayList;
33 import java.util.Collection;
34 import java.util.Collections;
35 import java.util.Date;
36 import java.util.HashMap;
37 import java.util.HashSet;
38 import java.util.LinkedHashMap;
39 import java.util.LinkedHashSet;
40 import java.util.List;
43 import java.util.TreeMap;
45 import org.antlr.v4.runtime.ANTLRInputStream;
46 import org.antlr.v4.runtime.CommonTokenStream;
47 import org.antlr.v4.runtime.tree.ParseTree;
48 import org.antlr.v4.runtime.tree.ParseTreeWalker;
49 import org.opendaylight.yangtools.antlrv4.code.gen.YangLexer;
50 import org.opendaylight.yangtools.antlrv4.code.gen.YangParser;
51 import org.opendaylight.yangtools.antlrv4.code.gen.YangParser.YangContext;
52 import org.opendaylight.yangtools.yang.common.QName;
53 import org.opendaylight.yangtools.yang.common.QNameModule;
54 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
55 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
56 import org.opendaylight.yangtools.yang.model.api.ExtensionDefinition;
57 import org.opendaylight.yangtools.yang.model.api.GroupingDefinition;
58 import org.opendaylight.yangtools.yang.model.api.Module;
59 import org.opendaylight.yangtools.yang.model.api.ModuleIdentifier;
60 import org.opendaylight.yangtools.yang.model.api.ModuleImport;
61 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
62 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
63 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
64 import org.opendaylight.yangtools.yang.model.parser.api.YangContextParser;
65 import org.opendaylight.yangtools.yang.model.parser.api.YangSyntaxErrorException;
66 import org.opendaylight.yangtools.yang.parser.builder.api.AugmentationSchemaBuilder;
67 import org.opendaylight.yangtools.yang.parser.builder.api.AugmentationTargetBuilder;
68 import org.opendaylight.yangtools.yang.parser.builder.api.Builder;
69 import org.opendaylight.yangtools.yang.parser.builder.api.DataNodeContainerBuilder;
70 import org.opendaylight.yangtools.yang.parser.builder.api.DataSchemaNodeBuilder;
71 import org.opendaylight.yangtools.yang.parser.builder.api.GroupingBuilder;
72 import org.opendaylight.yangtools.yang.parser.builder.api.SchemaNodeBuilder;
73 import org.opendaylight.yangtools.yang.parser.builder.api.TypeAwareBuilder;
74 import org.opendaylight.yangtools.yang.parser.builder.api.TypeDefinitionBuilder;
75 import org.opendaylight.yangtools.yang.parser.builder.api.UsesNodeBuilder;
76 import org.opendaylight.yangtools.yang.parser.builder.impl.ChoiceBuilder;
77 import org.opendaylight.yangtools.yang.parser.builder.impl.ChoiceCaseBuilder;
78 import org.opendaylight.yangtools.yang.parser.builder.impl.DeviationBuilder;
79 import org.opendaylight.yangtools.yang.parser.builder.impl.ExtensionBuilder;
80 import org.opendaylight.yangtools.yang.parser.builder.impl.IdentitySchemaNodeBuilder;
81 import org.opendaylight.yangtools.yang.parser.builder.impl.IdentityrefTypeBuilder;
82 import org.opendaylight.yangtools.yang.parser.builder.impl.ModuleBuilder;
83 import org.opendaylight.yangtools.yang.parser.builder.impl.ModuleBuilder.ModuleImpl;
84 import org.opendaylight.yangtools.yang.parser.builder.impl.UnionTypeBuilder;
85 import org.opendaylight.yangtools.yang.parser.builder.impl.UnknownSchemaNodeBuilder;
86 import org.opendaylight.yangtools.yang.parser.util.Comparators;
87 import org.opendaylight.yangtools.yang.parser.util.GroupingSort;
88 import org.opendaylight.yangtools.yang.parser.util.GroupingUtils;
89 import org.opendaylight.yangtools.yang.parser.util.ModuleDependencySort;
90 import org.opendaylight.yangtools.yang.parser.util.NamedByteArrayInputStream;
91 import org.opendaylight.yangtools.yang.parser.util.NamedFileInputStream;
92 import org.opendaylight.yangtools.yang.parser.util.NamedInputStream;
93 import org.opendaylight.yangtools.yang.parser.util.ParserUtils;
94 import org.opendaylight.yangtools.yang.parser.util.YangParseException;
95 import org.opendaylight.yangtools.yang.validator.YangModelBasicValidator;
96 import org.slf4j.Logger;
97 import org.slf4j.LoggerFactory;
99 import com.google.common.base.Optional;
100 import com.google.common.base.Preconditions;
101 import com.google.common.collect.HashBiMap;
102 import com.google.common.io.ByteSource;
104 public final class YangParserImpl implements YangContextParser {
105 private static final Logger LOG = LoggerFactory.getLogger(YangParserImpl.class);
107 private static final String FAIL_DEVIATION_TARGET = "Failed to find deviation target.";
111 public Set<Module> parseYangModels(final File yangFile, final File directory) {
113 return parseFile(yangFile, directory).getModules();
114 } catch (IOException | YangSyntaxErrorException e) {
115 throw new YangParseException("Failed to parse yang data", e);
120 public SchemaContext parseFile(final File yangFile, final File directory) throws IOException,
121 YangSyntaxErrorException {
122 Preconditions.checkState(yangFile.exists(), yangFile + " does not exists");
123 Preconditions.checkState(directory.exists(), directory + " does not exists");
124 Preconditions.checkState(directory.isDirectory(), directory + " is not a directory");
126 final String yangFileName = yangFile.getName();
127 final String[] fileList = checkNotNull(directory.list(), directory + " not found or is not a directory");
129 Map<ByteSource, File> sourceToFile = new LinkedHashMap<>();
130 ByteSource mainFileSource = ParserUtils.fileToByteSource(yangFile);
131 sourceToFile.put(mainFileSource, yangFile);
133 for (String fileName : fileList) {
134 if (fileName.equals(yangFileName)) {
137 File dependency = new File(directory, fileName);
138 if (dependency.isFile()) {
139 sourceToFile.put(ParserUtils.fileToByteSource(dependency), dependency);
143 Map<ByteSource, ModuleBuilder> sourceToBuilder = parseSourcesToBuilders(sourceToFile.keySet());
144 ModuleBuilder main = sourceToBuilder.get(mainFileSource);
146 List<ModuleBuilder> moduleBuilders = new ArrayList<>();
147 moduleBuilders.add(main);
148 filterImports(main, new ArrayList<>(sourceToBuilder.values()), moduleBuilders);
149 Collection<ModuleBuilder> resolved = resolveSubmodules(moduleBuilders);
151 // module builders sorted by dependencies
152 List<ModuleBuilder> sortedBuilders = ModuleDependencySort.sort(resolved);
153 LinkedHashMap<String, TreeMap<Date, ModuleBuilder>> modules = orderModules(sortedBuilders);
154 Collection<Module> unsorted = build(modules).values();
155 Set<Module> result = new LinkedHashSet<>(
156 ModuleDependencySort.sort(unsorted.toArray(new Module[unsorted.size()])));
157 return resolveSchemaContext(result);
162 public Set<Module> parseYangModels(final List<File> yangFiles) {
163 return parseFiles(yangFiles).getModules();
167 public SchemaContext parseFiles(final Collection<File> yangFiles) {
168 Collection<Module> unsorted = parseYangModelsMapped(yangFiles).values();
169 Set<Module> sorted = new LinkedHashSet<>(
170 ModuleDependencySort.sort(unsorted.toArray(new Module[unsorted.size()])));
171 return resolveSchemaContext(sorted);
176 public Set<Module> parseYangModels(final List<File> yangFiles, final SchemaContext context) {
178 return parseFiles(yangFiles, context).getModules();
179 } catch (IOException | YangSyntaxErrorException e) {
180 throw new YangParseException("Failed to parse yang data", e);
185 public SchemaContext parseFiles(final Collection<File> yangFiles, final SchemaContext context) throws IOException,
186 YangSyntaxErrorException {
187 if (yangFiles == null) {
188 return resolveSchemaContext(Collections.<Module> emptySet());
191 Collection<ByteSource> sources = ParserUtils.filesToByteSources(yangFiles);
192 SchemaContext result = parseSources(sources, context);
198 public Set<Module> parseYangModelsFromStreams(final List<InputStream> yangModelStreams) {
200 Collection<ByteSource> sources = ParserUtils.streamsToByteSources(yangModelStreams);
201 return parseSources(sources).getModules();
202 } catch (IOException | YangSyntaxErrorException e) {
203 throw new YangParseException("Failed to parse yang data", e);
208 public SchemaContext parseSources(final Collection<ByteSource> sources) throws IOException,
209 YangSyntaxErrorException {
210 Collection<Module> unsorted = parseYangModelSources(sources).values();
211 Set<Module> sorted = new LinkedHashSet<>(
212 ModuleDependencySort.sort(unsorted.toArray(new Module[unsorted.size()])));
213 return resolveSchemaContext(sorted);
218 public Set<Module> parseYangModelsFromStreams(final List<InputStream> yangModelStreams, final SchemaContext context) {
220 Collection<ByteSource> sources = ParserUtils.streamsToByteSources(yangModelStreams);
221 return parseSources(sources, context).getModules();
222 } catch (IOException | YangSyntaxErrorException e) {
223 throw new YangParseException("Failed to parse yang data", e);
228 public SchemaContext parseSources(final Collection<ByteSource> sources, final SchemaContext context)
229 throws IOException, YangSyntaxErrorException {
230 if (sources == null) {
231 return resolveSchemaContext(Collections.<Module> emptySet());
234 final Map<String, TreeMap<Date, ModuleBuilder>> modules = resolveModuleBuilders(sources, context);
235 final Set<Module> unsorted = new LinkedHashSet<>(buildWithContext(modules, context).values());
236 if (context != null) {
237 for (Module m : context.getModules()) {
238 if (!unsorted.contains(m)) {
243 Set<Module> result = new LinkedHashSet<>(
244 ModuleDependencySort.sort(unsorted.toArray(new Module[unsorted.size()])));
245 return resolveSchemaContext(result);
249 public Map<File, Module> parseYangModelsMapped(final Collection<File> yangFiles) {
250 if (yangFiles == null || yangFiles.isEmpty()) {
251 return Collections.emptyMap();
254 Map<ByteSource, File> byteSourceToFile = new HashMap<>();
255 for (final File file : yangFiles) {
256 ByteSource source = new ByteSource() {
258 public InputStream openStream() throws IOException {
259 return new NamedFileInputStream(file, file.getPath());
262 byteSourceToFile.put(source, file);
265 Map<ByteSource, Module> byteSourceToModule;
267 byteSourceToModule = parseYangModelSources(byteSourceToFile.keySet());
268 } catch (IOException | YangSyntaxErrorException e) {
269 throw new YangParseException("Failed to parse yang data", e);
271 Map<File, Module> result = new LinkedHashMap<>();
272 for (Map.Entry<ByteSource, Module> entry : byteSourceToModule.entrySet()) {
273 result.put(byteSourceToFile.get(entry.getKey()), entry.getValue());
279 public Map<InputStream, Module> parseYangModelsFromStreamsMapped(final Collection<InputStream> yangModelStreams) {
280 if (yangModelStreams == null || yangModelStreams.isEmpty()) {
281 return Collections.emptyMap();
284 Map<ByteSource, InputStream> sourceToStream = new HashMap<>();
285 for (final InputStream stream : yangModelStreams) {
286 ByteSource source = new ByteSource() {
288 public InputStream openStream() throws IOException {
289 return NamedByteArrayInputStream.create(stream);
292 sourceToStream.put(source, stream);
295 Map<ByteSource, Module> sourceToModule;
297 sourceToModule = parseYangModelSources(sourceToStream.keySet());
298 } catch (IOException | YangSyntaxErrorException e) {
299 throw new YangParseException("Failed to parse yang data", e);
301 Map<InputStream, Module> result = new LinkedHashMap<>();
302 for (Map.Entry<ByteSource, Module> entry : sourceToModule.entrySet()) {
303 result.put(sourceToStream.get(entry.getKey()), entry.getValue());
309 public SchemaContext resolveSchemaContext(final Set<Module> modules) {
310 // after merging parse method with this one, add support for getting
311 // submodule sources.
312 Map<ModuleIdentifier, String> identifiersToSources = new HashMap<>();
313 for (Module module : modules) {
314 ModuleImpl moduleImpl = (ModuleImpl) module;
315 identifiersToSources.put(module, moduleImpl.getSource());
317 return new SchemaContextImpl(modules, identifiersToSources);
320 private Map<ByteSource, Module> parseYangModelSources(final Collection<ByteSource> sources) throws IOException,
321 YangSyntaxErrorException {
322 if (sources == null || sources.isEmpty()) {
323 return Collections.emptyMap();
326 Map<ByteSource, ModuleBuilder> sourceToBuilder = resolveSources(sources);
327 // sort and check for duplicates
328 List<ModuleBuilder> sorted = ModuleDependencySort.sort(sourceToBuilder.values());
329 ParserUtils.setSourceToBuilder(sourceToBuilder);
330 Map<String, TreeMap<Date, ModuleBuilder>> modules = orderModules(sorted);
331 Map<ModuleBuilder, Module> builderToModule = build(modules);
332 Map<ModuleBuilder, ByteSource> builderToSource = HashBiMap.create(sourceToBuilder).inverse();
333 sorted = ModuleDependencySort.sort(builderToModule.keySet());
335 Map<ByteSource, Module> result = new LinkedHashMap<>();
336 for (ModuleBuilder moduleBuilder : sorted) {
337 Module value = checkNotNull(builderToModule.get(moduleBuilder), "Cannot get module for %s", moduleBuilder);
338 result.put(builderToSource.get(moduleBuilder), value);
345 * Parse streams and resolve submodules.
348 * collection of streams to parse
349 * @return map, where key is source stream and value is module builder
351 * @throws YangSyntaxErrorException
353 private Map<ByteSource, ModuleBuilder> resolveSources(final Collection<ByteSource> streams) throws IOException,
354 YangSyntaxErrorException {
355 Map<ByteSource, ModuleBuilder> builders = parseSourcesToBuilders(streams);
356 Map<ByteSource, ModuleBuilder> result = resolveSubmodules(builders);
360 private Map<ByteSource, ModuleBuilder> parseSourcesToBuilders(final Collection<ByteSource> sources)
361 throws IOException, YangSyntaxErrorException {
362 final ParseTreeWalker walker = new ParseTreeWalker();
363 final Map<ByteSource, ParseTree> sourceToTree = parseYangSources(sources);
364 final Map<ByteSource, ModuleBuilder> sourceToBuilder = new LinkedHashMap<>();
367 new YangModelBasicValidator(walker).validate(sourceToTree.values());
369 YangParserListenerImpl yangModelParser;
370 for (Map.Entry<ByteSource, ParseTree> entry : sourceToTree.entrySet()) {
371 ByteSource source = entry.getKey();
373 InputStream stream = source.openStream();
374 if (stream instanceof NamedInputStream) {
375 path = stream.toString();
379 } catch (IOException e) {
380 LOG.warn("Failed to close stream {}", stream);
383 yangModelParser = new YangParserListenerImpl(path);
384 walker.walk(yangModelParser, entry.getValue());
385 ModuleBuilder moduleBuilder = yangModelParser.getModuleBuilder();
386 sourceToBuilder.put(source, moduleBuilder);
389 ParserUtils.setSourceToBuilder(sourceToBuilder);
390 return sourceToBuilder;
393 private Map<ByteSource, ModuleBuilder> resolveSubmodules(final Map<ByteSource, ModuleBuilder> builders) {
394 Map<ByteSource, ModuleBuilder> modules = new HashMap<>();
395 Set<ModuleBuilder> submodules = new HashSet<>();
396 for (Map.Entry<ByteSource, ModuleBuilder> entry : builders.entrySet()) {
397 ModuleBuilder moduleBuilder = entry.getValue();
398 if (moduleBuilder.isSubmodule()) {
399 submodules.add(moduleBuilder);
401 modules.put(entry.getKey(), moduleBuilder);
405 Collection<ModuleBuilder> values = modules.values();
406 for (ModuleBuilder submodule : submodules) {
407 for (ModuleBuilder module : values) {
408 if (module.getName().equals(submodule.getBelongsTo())) {
409 addSubmoduleToModule(submodule, module);
417 * Traverse collection of builders, find builders representing submodule and
418 * add this submodule to its parent module.
421 * collection of builders containing modules and submodules
422 * @return collection of module builders
424 private Collection<ModuleBuilder> resolveSubmodules(final Collection<ModuleBuilder> builders) {
425 Collection<ModuleBuilder> modules = new HashSet<>();
426 Set<ModuleBuilder> submodules = new HashSet<>();
427 for (ModuleBuilder moduleBuilder : builders) {
428 if (moduleBuilder.isSubmodule()) {
429 submodules.add(moduleBuilder);
431 modules.add(moduleBuilder);
435 for (ModuleBuilder submodule : submodules) {
436 for (ModuleBuilder module : modules) {
437 if (module.getName().equals(submodule.getBelongsTo())) {
438 addSubmoduleToModule(submodule, module);
445 private void addSubmoduleToModule(final ModuleBuilder submodule, final ModuleBuilder module) {
446 submodule.setParent(module);
447 module.getDirtyNodes().addAll(submodule.getDirtyNodes());
448 module.getModuleImports().addAll(submodule.getModuleImports());
449 module.getAugments().addAll(submodule.getAugments());
450 module.getAugmentBuilders().addAll(submodule.getAugmentBuilders());
451 module.getAllAugments().addAll(submodule.getAllAugments());
452 module.getChildNodeBuilders().addAll(submodule.getChildNodeBuilders());
453 module.getChildNodes().putAll(submodule.getChildNodes());
454 module.getGroupings().addAll(submodule.getGroupings());
455 module.getGroupingBuilders().addAll(submodule.getGroupingBuilders());
456 module.getTypeDefinitions().addAll(submodule.getTypeDefinitions());
457 module.getTypeDefinitionBuilders().addAll(submodule.getTypeDefinitionBuilders());
458 module.getUsesNodes().addAll(submodule.getUsesNodes());
459 module.getUsesNodeBuilders().addAll(submodule.getUsesNodeBuilders());
460 module.getAllGroupings().addAll(submodule.getAllGroupings());
461 module.getAllUsesNodes().addAll(submodule.getAllUsesNodes());
462 module.getRpcs().addAll(submodule.getRpcs());
463 module.getAddedRpcs().addAll(submodule.getAddedRpcs());
464 module.getNotifications().addAll(submodule.getNotifications());
465 module.getAddedNotifications().addAll(submodule.getAddedNotifications());
466 module.getIdentities().addAll(submodule.getIdentities());
467 module.getAddedIdentities().addAll(submodule.getAddedIdentities());
468 module.getFeatures().addAll(submodule.getFeatures());
469 module.getAddedFeatures().addAll(submodule.getAddedFeatures());
470 module.getDeviations().addAll(submodule.getDeviations());
471 module.getDeviationBuilders().addAll(submodule.getDeviationBuilders());
472 module.getExtensions().addAll(submodule.getExtensions());
473 module.getAddedExtensions().addAll(submodule.getAddedExtensions());
474 module.getUnknownNodes().addAll(submodule.getUnknownNodes());
475 module.getAllUnknownNodes().addAll(submodule.getAllUnknownNodes());
478 private Map<String, TreeMap<Date, ModuleBuilder>> resolveModuleBuilders(
479 final Collection<ByteSource> yangFileStreams, final SchemaContext context) throws IOException,
480 YangSyntaxErrorException {
481 Map<ByteSource, ModuleBuilder> parsedBuilders = resolveSources(yangFileStreams);
482 ModuleBuilder[] builders = new ModuleBuilder[parsedBuilders.size()];
483 parsedBuilders.values().toArray(builders);
485 // module dependency graph sorted
486 List<ModuleBuilder> sorted;
487 if (context == null) {
488 sorted = ModuleDependencySort.sort(builders);
490 sorted = ModuleDependencySort.sortWithContext(context, builders);
492 return orderModules(sorted);
496 * Order modules by name and revision.
500 * @return modules ordered by name and revision
502 private LinkedHashMap<String, TreeMap<Date, ModuleBuilder>> orderModules(final List<ModuleBuilder> modules) {
503 final LinkedHashMap<String, TreeMap<Date, ModuleBuilder>> result = new LinkedHashMap<>();
504 for (final ModuleBuilder builder : modules) {
505 if (builder == null) {
508 final String builderName = builder.getName();
509 Date builderRevision = builder.getRevision();
510 if (builderRevision == null) {
511 builderRevision = new Date(0L);
513 TreeMap<Date, ModuleBuilder> builderByRevision = result.get(builderName);
514 if (builderByRevision == null) {
515 builderByRevision = new TreeMap<>();
517 builderByRevision.put(builderRevision, builder);
518 result.put(builderName, builderByRevision);
524 * Find {@code main} dependencies from {@code other} and add them to
532 * collection to fill up
534 private void filterImports(final ModuleBuilder main, final Collection<ModuleBuilder> other,
535 final Collection<ModuleBuilder> filtered) {
536 Set<ModuleImport> imports = main.getModuleImports();
538 // if this is submodule, add parent to filtered and pick its imports
539 if (main.isSubmodule()) {
540 TreeMap<Date, ModuleBuilder> dependencies = new TreeMap<>();
541 for (ModuleBuilder mb : other) {
542 if (mb.getName().equals(main.getBelongsTo())) {
543 dependencies.put(mb.getRevision(), mb);
546 ModuleBuilder parent = dependencies.get(dependencies.firstKey());
547 filtered.add(parent);
548 imports.addAll(parent.getModuleImports());
551 for (ModuleImport mi : imports) {
552 for (ModuleBuilder builder : other) {
553 if (mi.getModuleName().equals(builder.getModuleName())) {
554 if (mi.getRevision() == null) {
555 if (!filtered.contains(builder)) {
556 filtered.add(builder);
557 filterImports(builder, other, filtered);
560 if (mi.getRevision().equals(builder.getRevision())) {
561 if (!filtered.contains(builder)) {
562 filtered.add(builder);
563 filterImports(builder, other, filtered);
572 private Map<ByteSource, ParseTree> parseYangSources(final Collection<ByteSource> sources) throws IOException,
573 YangSyntaxErrorException {
574 final Map<ByteSource, ParseTree> trees = new HashMap<>();
575 for (ByteSource source : sources) {
576 trees.put(source, parseYangSource(source));
581 private YangContext parseYangSource(final ByteSource source) throws IOException, YangSyntaxErrorException {
582 try (InputStream stream = source.openStream()) {
583 final ANTLRInputStream input = new ANTLRInputStream(stream);
584 final YangLexer lexer = new YangLexer(input);
585 final CommonTokenStream tokens = new CommonTokenStream(lexer);
586 final YangParser parser = new YangParser(tokens);
587 parser.removeErrorListeners();
589 final YangErrorListener errorListener = new YangErrorListener();
590 parser.addErrorListener(errorListener);
592 final YangContext result = parser.yang();
593 errorListener.validate();
599 public static YangContext parseStreamWithoutErrorListeners(final InputStream yangStream) {
600 YangContext result = null;
602 final ANTLRInputStream input = new ANTLRInputStream(yangStream);
603 final YangLexer lexer = new YangLexer(input);
604 final CommonTokenStream tokens = new CommonTokenStream(lexer);
605 final YangParser parser = new YangParser(tokens);
606 parser.removeErrorListeners();
607 result = parser.yang();
608 } catch (IOException e) {
609 LOG.warn("Exception while reading yang file: " + yangStream, e);
615 * Creates builder-to-module map based on given modules. Method first
616 * resolve unresolved type references, instantiate groupings through uses
617 * statements and perform augmentation.
619 * Node resolving must be performed in following order:
622 * unresolved type references</li>
624 * uses in groupings</li>
626 * uses in other nodes</li>
633 * @return modules mapped on their builders
635 private Map<ModuleBuilder, Module> build(final Map<String, TreeMap<Date, ModuleBuilder>> modules) {
636 resolveDirtyNodes(modules);
637 resolveAugmentsTargetPath(modules, null);
638 resolveUsesTargetGrouping(modules, null);
639 resolveUsesForGroupings(modules, null);
640 resolveUsesForNodes(modules, null);
641 resolveAugments(modules, null);
642 resolveIdentities(modules);
643 resolveDeviations(modules);
646 final Map<ModuleBuilder, Module> result = new LinkedHashMap<>();
647 for (Map.Entry<String, TreeMap<Date, ModuleBuilder>> entry : modules.entrySet()) {
648 for (Map.Entry<Date, ModuleBuilder> childEntry : entry.getValue().entrySet()) {
649 final ModuleBuilder moduleBuilder = childEntry.getValue();
650 final Module module = moduleBuilder.build();
651 result.put(moduleBuilder, module);
658 * Creates builder-to-module map based on given modules. Method first
659 * resolve unresolved type references, instantiate groupings through uses
660 * statements and perform augmentation.
662 * Node resolving must be performed in following order:
665 * unresolved type references</li>
667 * uses in groupings</li>
669 * uses in other nodes</li>
677 * SchemaContext containing already resolved modules
678 * @return modules mapped on their builders
680 private Map<ModuleBuilder, Module> buildWithContext(final Map<String, TreeMap<Date, ModuleBuilder>> modules,
681 final SchemaContext context) {
682 resolvedDirtyNodesWithContext(modules, context);
683 resolveAugmentsTargetPath(modules, context);
684 resolveUsesTargetGrouping(modules, context);
685 resolveUsesForGroupings(modules, context);
686 resolveUsesForNodes(modules, context);
687 resolveAugments(modules, context);
688 resolveIdentitiesWithContext(modules, context);
689 resolveDeviationsWithContext(modules, context);
692 final Map<ModuleBuilder, Module> result = new LinkedHashMap<>();
693 for (Map.Entry<String, TreeMap<Date, ModuleBuilder>> entry : modules.entrySet()) {
694 for (Map.Entry<Date, ModuleBuilder> childEntry : entry.getValue().entrySet()) {
695 final ModuleBuilder moduleBuilder = childEntry.getValue();
696 final Module module = moduleBuilder.build();
697 result.put(moduleBuilder, module);
704 * Resolve all unresolved type references.
709 private void resolveDirtyNodes(final Map<String, TreeMap<Date, ModuleBuilder>> modules) {
710 for (Map.Entry<String, TreeMap<Date, ModuleBuilder>> entry : modules.entrySet()) {
711 for (Map.Entry<Date, ModuleBuilder> childEntry : entry.getValue().entrySet()) {
712 final ModuleBuilder module = childEntry.getValue();
713 resolveUnknownNodes(modules, module);
714 resolveDirtyNodes(modules, module);
720 * Resolve all unresolved type references.
725 * SchemaContext containing already resolved modules
727 private void resolvedDirtyNodesWithContext(final Map<String, TreeMap<Date, ModuleBuilder>> modules,
728 final SchemaContext context) {
729 for (Map.Entry<String, TreeMap<Date, ModuleBuilder>> entry : modules.entrySet()) {
730 for (Map.Entry<Date, ModuleBuilder> childEntry : entry.getValue().entrySet()) {
731 final ModuleBuilder module = childEntry.getValue();
732 resolveUnknownNodesWithContext(modules, module, context);
733 resolveDirtyNodesWithContext(modules, module, context);
739 * Search for dirty nodes (node which contains UnknownType) and resolve
743 * all available modules
747 private void resolveDirtyNodes(final Map<String, TreeMap<Date, ModuleBuilder>> modules, final ModuleBuilder module) {
748 final Set<TypeAwareBuilder> dirtyNodes = module.getDirtyNodes();
749 if (!dirtyNodes.isEmpty()) {
750 for (TypeAwareBuilder nodeToResolve : dirtyNodes) {
751 if (nodeToResolve instanceof UnionTypeBuilder) {
752 // special handling for union types
753 resolveTypeUnion((UnionTypeBuilder) nodeToResolve, modules, module);
754 } else if (nodeToResolve.getTypedef() instanceof IdentityrefTypeBuilder) {
755 // special handling for identityref types
756 IdentityrefTypeBuilder idref = (IdentityrefTypeBuilder) nodeToResolve.getTypedef();
757 IdentitySchemaNodeBuilder identity = findBaseIdentity(modules, module, idref.getBaseString(),
759 if (identity == null) {
760 throw new YangParseException(module.getName(), idref.getLine(), "Failed to find base identity");
762 idref.setBaseIdentity(identity);
763 nodeToResolve.setType(idref.build());
765 resolveType(nodeToResolve, modules, module);
771 private void resolveDirtyNodesWithContext(final Map<String, TreeMap<Date, ModuleBuilder>> modules,
772 final ModuleBuilder module, final SchemaContext context) {
773 final Set<TypeAwareBuilder> dirtyNodes = module.getDirtyNodes();
774 if (!dirtyNodes.isEmpty()) {
775 for (TypeAwareBuilder nodeToResolve : dirtyNodes) {
776 if (nodeToResolve instanceof UnionTypeBuilder) {
777 // special handling for union types
778 resolveTypeUnionWithContext((UnionTypeBuilder) nodeToResolve, modules, module, context);
779 } else if (nodeToResolve.getTypedef() instanceof IdentityrefTypeBuilder) {
780 // special handling for identityref types
781 IdentityrefTypeBuilder idref = (IdentityrefTypeBuilder) nodeToResolve.getTypedef();
782 IdentitySchemaNodeBuilder identity = findBaseIdentity(modules, module, idref.getBaseString(),
784 idref.setBaseIdentity(identity);
785 nodeToResolve.setType(idref.build());
787 resolveTypeWithContext(nodeToResolve, modules, module, context);
794 * Traverse through augmentations of modules and fix their child nodes
800 * SchemaContext containing already resolved modules
802 private void resolveAugmentsTargetPath(final Map<String, TreeMap<Date, ModuleBuilder>> modules,
803 final SchemaContext context) {
804 // collect augments from all loaded modules
805 final List<AugmentationSchemaBuilder> allAugments = new ArrayList<>();
806 for (Map.Entry<String, TreeMap<Date, ModuleBuilder>> entry : modules.entrySet()) {
807 for (Map.Entry<Date, ModuleBuilder> inner : entry.getValue().entrySet()) {
808 allAugments.addAll(inner.getValue().getAllAugments());
812 for (AugmentationSchemaBuilder augment : allAugments) {
813 setCorrectAugmentTargetPath(modules, augment, context);
818 * Find augment target and set correct schema path for all its child nodes.
825 * SchemaContext containing already resolved modules
827 private void setCorrectAugmentTargetPath(final Map<String, TreeMap<Date, ModuleBuilder>> modules,
828 final AugmentationSchemaBuilder augment, final SchemaContext context) {
829 ModuleBuilder module = ParserUtils.getParentModule(augment);
830 SchemaPath oldSchemaPath = augment.getTargetPath();
831 List<QName> oldPath = oldSchemaPath.getPath();
832 List<QName> newPath = new ArrayList<>();
834 Builder parent = augment.getParent();
835 if (parent instanceof UsesNodeBuilder) {
836 DataNodeContainerBuilder usesParent = ((UsesNodeBuilder) parent).getParent();
837 newPath.addAll(usesParent.getPath().getPath());
842 QName baseQName = usesParent.getQName();
843 if (baseQName == null) {
844 ModuleBuilder m = ParserUtils.getParentModule(usesParent);
845 ns = m.getNamespace();
846 revision = m.getRevision();
847 prefix = m.getPrefix();
849 ns = baseQName.getNamespace();
850 revision = baseQName.getRevision();
851 prefix = baseQName.getPrefix();
854 final QNameModule qm = QNameModule.create(ns, revision);
855 for (QName qn : oldSchemaPath.getPath()) {
856 newPath.add(QName.create(qm, prefix, qn.getLocalName()));
859 for (QName qn : oldPath) {
860 URI ns = module.getNamespace();
861 Date rev = module.getRevision();
862 String localPrefix = qn.getPrefix();
863 if (localPrefix != null && !("".equals(localPrefix))) {
864 ModuleBuilder currentModule = ParserUtils.findModuleFromBuilders(modules, module, localPrefix,
866 if (currentModule == null) {
867 Module m = ParserUtils.findModuleFromContext(context, module, localPrefix, augment.getLine());
869 throw new YangParseException(module.getName(), augment.getLine(), "Module with prefix "
870 + localPrefix + " not found.");
872 ns = m.getNamespace();
873 rev = m.getRevision();
875 ns = currentModule.getNamespace();
876 rev = currentModule.getRevision();
879 newPath.add(new QName(ns, rev, localPrefix, qn.getLocalName()));
882 augment.setTargetNodeSchemaPath(SchemaPath.create(newPath, true));
884 for (DataSchemaNodeBuilder childNode : augment.getChildNodeBuilders()) {
885 correctPathForAugmentNodes(childNode, augment.getTargetNodeSchemaPath());
890 * Set new schema path to node and all its child nodes based on given parent
891 * path. This method do not change the namespace.
894 * node which schema path should be updated
896 * schema path of parent node
898 private void correctPathForAugmentNodes(final DataSchemaNodeBuilder node, final SchemaPath parentPath) {
899 SchemaPath newPath = parentPath.createChild(node.getQName());
900 node.setPath(newPath);
901 if (node instanceof DataNodeContainerBuilder) {
902 for (DataSchemaNodeBuilder child : ((DataNodeContainerBuilder) node).getChildNodeBuilders()) {
903 correctPathForAugmentNodes(child, node.getPath());
906 if (node instanceof ChoiceBuilder) {
907 for (ChoiceCaseBuilder child : ((ChoiceBuilder) node).getCases()) {
908 correctPathForAugmentNodes(child, node.getPath());
914 * Check augments for mandatory nodes. If the target node is in another
915 * module, then nodes added by the augmentation MUST NOT be mandatory nodes.
916 * If mandatory node is found, throw an exception.
921 private void checkAugmentMandatoryNodes(final Collection<AugmentationSchemaBuilder> augments) {
922 for (AugmentationSchemaBuilder augment : augments) {
923 String augmentPrefix = augment.getTargetPath().getPathFromRoot().iterator().next().getPrefix();
924 ModuleBuilder module = ParserUtils.getParentModule(augment);
925 String modulePrefix = module.getPrefix();
927 if (augmentPrefix == null || augmentPrefix.isEmpty() || augmentPrefix.equals(modulePrefix)) {
931 for (DataSchemaNodeBuilder childNode : augment.getChildNodeBuilders()) {
932 if (childNode.getConstraints().isMandatory()) {
933 throw new YangParseException(augment.getModuleName(), augment.getLine(),
934 "Error in augment parsing: cannot augment mandatory node "
935 + childNode.getQName().getLocalName());
942 * Go through all augment definitions and resolve them.
947 * SchemaContext containing already resolved modules
949 private void resolveAugments(final Map<String, TreeMap<Date, ModuleBuilder>> modules, final SchemaContext context) {
950 List<ModuleBuilder> all = new ArrayList<>();
951 for (Map.Entry<String, TreeMap<Date, ModuleBuilder>> entry : modules.entrySet()) {
952 for (Map.Entry<Date, ModuleBuilder> inner : entry.getValue().entrySet()) {
953 all.add(inner.getValue());
957 List<ModuleBuilder> sorted;
958 if (context == null) {
959 sorted = ModuleDependencySort.sort(all.toArray(new ModuleBuilder[all.size()]));
961 sorted = ModuleDependencySort.sortWithContext(context, all.toArray(new ModuleBuilder[all.size()]));
964 for (ModuleBuilder mb : sorted) {
966 List<AugmentationSchemaBuilder> augments = mb.getAllAugments();
967 checkAugmentMandatoryNodes(augments);
968 Collections.sort(augments, Comparators.AUGMENT_COMP);
969 for (AugmentationSchemaBuilder augment : augments) {
970 if (!(augment.isResolved())) {
971 boolean resolved = resolveAugment(augment, mb, modules, context);
973 throw new YangParseException(augment.getModuleName(), augment.getLine(),
974 "Error in augment parsing: failed to find augment target: " + augment);
983 * Perform augmentation defined under uses statement.
992 * SchemaContext containing already resolved modules
993 * @return true if augment process succeed
995 private boolean resolveUsesAugment(final AugmentationSchemaBuilder augment, final ModuleBuilder module,
996 final Map<String, TreeMap<Date, ModuleBuilder>> modules, final SchemaContext context) {
997 if (augment.isResolved()) {
1001 UsesNodeBuilder usesNode = (UsesNodeBuilder) augment.getParent();
1002 DataNodeContainerBuilder parentNode = usesNode.getParent();
1003 Optional<SchemaNodeBuilder> potentialTargetNode;
1004 SchemaPath resolvedTargetPath = augment.getTargetNodeSchemaPath();
1005 if (parentNode instanceof ModuleBuilder && resolvedTargetPath.isAbsolute()) {
1006 // Uses is directly used in module body, we lookup
1007 // We lookup in data namespace to find correct augmentation target
1008 potentialTargetNode = findSchemaNodeInModule(resolvedTargetPath, (ModuleBuilder) parentNode);
1010 // Uses is used in local context (be it data namespace or grouping namespace,
1011 // since all nodes via uses are imported to localName, it is safe to
1012 // to proceed only with local names.
1014 // Conflicting elements in other namespaces are still not present
1015 // since resolveUsesAugment occurs before augmenting from external modules.
1016 potentialTargetNode = Optional.<SchemaNodeBuilder> fromNullable(findSchemaNode(augment.getTargetPath()
1017 .getPath(), (SchemaNodeBuilder) parentNode));
1020 if (potentialTargetNode.isPresent()) {
1021 SchemaNodeBuilder targetNode = potentialTargetNode.get();
1022 if (targetNode instanceof AugmentationTargetBuilder) {
1023 fillAugmentTarget(augment, targetNode);
1024 ((AugmentationTargetBuilder) targetNode).addAugmentation(augment);
1025 augment.setResolved(true);
1028 throw new YangParseException(module.getName(), augment.getLine(), String.format(
1029 "Failed to resolve augment in uses. Invalid augment target: %s", potentialTargetNode));
1032 throw new YangParseException(module.getName(), augment.getLine(), String.format(
1033 "Failed to resolve augment in uses. Invalid augment target path: %s", augment.getTargetPath()));
1039 * Find augment target module and perform augmentation.
1042 * augment to resolve
1046 * all loaded modules
1048 * SchemaContext containing already resolved modules
1049 * @return true if augment process succeed
1051 private boolean resolveAugment(final AugmentationSchemaBuilder augment, final ModuleBuilder module,
1052 final Map<String, TreeMap<Date, ModuleBuilder>> modules, final SchemaContext context) {
1053 if (augment.isResolved()) {
1057 QName targetPath = augment.getTargetPath().getPathFromRoot().iterator().next();
1058 ModuleBuilder targetModule = findTargetModule(targetPath, module, modules, context, augment.getLine());
1059 if (targetModule == null) {
1060 throw new YangParseException(module.getModuleName(), augment.getLine(), "Failed to resolve augment "
1064 return processAugmentation(augment, targetModule);
1068 * Find module from loaded modules or from context based on given qname. If
1069 * module is found in context, create wrapper over this module and add it to
1070 * collection of loaded modules.
1076 * all loaded modules
1083 private ModuleBuilder findTargetModule(final QName qname, final ModuleBuilder module,
1084 final Map<String, TreeMap<Date, ModuleBuilder>> modules, final SchemaContext context, final int line) {
1085 ModuleBuilder targetModule = null;
1087 String prefix = qname.getPrefix();
1088 if (prefix == null || prefix.equals("")) {
1089 targetModule = module;
1091 targetModule = findModuleFromBuilders(modules, module, qname.getPrefix(), line);
1094 if (targetModule == null && context != null) {
1095 Module m = findModuleFromContext(context, module, prefix, line);
1096 targetModule = new ModuleBuilder(m);
1097 DataSchemaNode firstNode = m.getDataChildByName(qname.getLocalName());
1098 DataSchemaNodeBuilder firstNodeWrapped = wrapChildNode(targetModule.getModuleName(), line, firstNode,
1099 targetModule.getPath(), firstNode.getQName());
1100 targetModule.addChildNode(firstNodeWrapped);
1102 TreeMap<Date, ModuleBuilder> map = new TreeMap<>();
1103 map.put(targetModule.getRevision(), targetModule);
1104 modules.put(targetModule.getModuleName(), map);
1107 return targetModule;
1110 private ModuleBuilder findTargetModule(final String prefix, final ModuleBuilder module,
1111 final Map<String, TreeMap<Date, ModuleBuilder>> modules, final SchemaContext context, final int line) {
1112 ModuleBuilder targetModule = null;
1114 if (prefix == null || prefix.equals("")) {
1115 targetModule = module;
1117 targetModule = findModuleFromBuilders(modules, module, prefix, line);
1120 if (targetModule == null && context != null) {
1121 Module m = findModuleFromContext(context, module, prefix, line);
1123 targetModule = new ModuleBuilder(m);
1124 TreeMap<Date, ModuleBuilder> map = new TreeMap<>();
1125 map.put(targetModule.getRevision(), targetModule);
1126 modules.put(targetModule.getModuleName(), map);
1130 return targetModule;
1134 * Go through identity statements defined in current module and resolve
1135 * their 'base' statement if present.
1140 * module being resolved
1142 private void resolveIdentities(final Map<String, TreeMap<Date, ModuleBuilder>> modules) {
1143 for (Map.Entry<String, TreeMap<Date, ModuleBuilder>> entry : modules.entrySet()) {
1144 for (Map.Entry<Date, ModuleBuilder> inner : entry.getValue().entrySet()) {
1145 ModuleBuilder module = inner.getValue();
1146 final Set<IdentitySchemaNodeBuilder> identities = module.getAddedIdentities();
1147 for (IdentitySchemaNodeBuilder identity : identities) {
1148 final String baseIdentityName = identity.getBaseIdentityName();
1149 final int line = identity.getLine();
1150 if (baseIdentityName != null) {
1151 IdentitySchemaNodeBuilder baseIdentity = findBaseIdentity(modules, module, baseIdentityName,
1153 if (baseIdentity == null) {
1154 throw new YangParseException(module.getName(), identity.getLine(),
1155 "Failed to find base identity");
1157 identity.setBaseIdentity(baseIdentity);
1167 * Go through identity statements defined in current module and resolve
1168 * their 'base' statement. Method tries to find base identity in given
1169 * modules. If base identity is not found, method will search it in context.
1172 * all loaded modules
1176 * SchemaContext containing already resolved modules
1178 private void resolveIdentitiesWithContext(final Map<String, TreeMap<Date, ModuleBuilder>> modules,
1179 final SchemaContext context) {
1180 for (Map.Entry<String, TreeMap<Date, ModuleBuilder>> entry : modules.entrySet()) {
1181 for (Map.Entry<Date, ModuleBuilder> inner : entry.getValue().entrySet()) {
1182 ModuleBuilder module = inner.getValue();
1183 final Set<IdentitySchemaNodeBuilder> identities = module.getAddedIdentities();
1184 for (IdentitySchemaNodeBuilder identity : identities) {
1185 final String baseIdentityName = identity.getBaseIdentityName();
1186 final int line = identity.getLine();
1187 if (baseIdentityName != null) {
1189 IdentitySchemaNodeBuilder result = null;
1190 if (baseIdentityName.contains(":")) {
1191 String[] splittedBase = baseIdentityName.split(":");
1192 if (splittedBase.length > 2) {
1193 throw new YangParseException(module.getName(), line,
1194 "Failed to parse identityref base: " + baseIdentityName);
1196 String prefix = splittedBase[0];
1197 String name = splittedBase[1];
1198 ModuleBuilder dependentModule = findTargetModule(prefix, module, modules, context, line);
1199 if (dependentModule != null) {
1200 result = ParserUtils.findIdentity(dependentModule.getAddedIdentities(), name);
1203 result = ParserUtils.findIdentity(module.getAddedIdentities(), baseIdentityName);
1205 identity.setBaseIdentity(result);
1213 * Find and add reference of uses target grouping.
1216 * all loaded modules
1218 * SchemaContext containing already resolved modules or null if
1219 * context is not available
1221 private void resolveUsesTargetGrouping(final Map<String, TreeMap<Date, ModuleBuilder>> modules,
1222 final SchemaContext context) {
1223 final List<UsesNodeBuilder> allUses = new ArrayList<>();
1224 for (Map.Entry<String, TreeMap<Date, ModuleBuilder>> entry : modules.entrySet()) {
1225 for (Map.Entry<Date, ModuleBuilder> inner : entry.getValue().entrySet()) {
1226 allUses.addAll(inner.getValue().getAllUsesNodes());
1229 for (UsesNodeBuilder usesNode : allUses) {
1230 ModuleBuilder module = ParserUtils.getParentModule(usesNode);
1231 final GroupingBuilder targetGroupingBuilder = GroupingUtils.getTargetGroupingFromModules(usesNode, modules,
1233 if (targetGroupingBuilder == null) {
1234 if (context == null) {
1235 throw new YangParseException(module.getName(), usesNode.getLine(), "Referenced grouping '"
1236 + usesNode.getGroupingPathAsString() + "' not found.");
1238 GroupingDefinition targetGroupingDefinition = GroupingUtils.getTargetGroupingFromContext(usesNode,
1240 usesNode.setGroupingDefinition(targetGroupingDefinition);
1243 usesNode.setGrouping(targetGroupingBuilder);
1249 * Resolve uses statements defined in groupings.
1252 * all loaded modules
1254 * SchemaContext containing already resolved modules
1256 private void resolveUsesForGroupings(final Map<String, TreeMap<Date, ModuleBuilder>> modules,
1257 final SchemaContext context) {
1258 final Set<GroupingBuilder> allGroupings = new HashSet<>();
1259 for (Map.Entry<String, TreeMap<Date, ModuleBuilder>> entry : modules.entrySet()) {
1260 for (Map.Entry<Date, ModuleBuilder> inner : entry.getValue().entrySet()) {
1261 ModuleBuilder module = inner.getValue();
1262 allGroupings.addAll(module.getAllGroupings());
1265 final List<GroupingBuilder> sorted = GroupingSort.sort(allGroupings);
1266 for (GroupingBuilder gb : sorted) {
1267 List<UsesNodeBuilder> usesNodes = new ArrayList<>(GroupingSort.getAllUsesNodes(gb));
1268 Collections.sort(usesNodes, new GroupingUtils.UsesComparator());
1269 for (UsesNodeBuilder usesNode : usesNodes) {
1270 resolveUses(usesNode, modules, context);
1276 * Resolve uses statements.
1279 * all loaded modules
1281 * SchemaContext containing already resolved modules
1283 private void resolveUsesForNodes(final Map<String, TreeMap<Date, ModuleBuilder>> modules,
1284 final SchemaContext context) {
1285 for (Map.Entry<String, TreeMap<Date, ModuleBuilder>> entry : modules.entrySet()) {
1286 for (Map.Entry<Date, ModuleBuilder> inner : entry.getValue().entrySet()) {
1287 ModuleBuilder module = inner.getValue();
1288 List<UsesNodeBuilder> usesNodes = module.getAllUsesNodes();
1289 Collections.sort(usesNodes, new GroupingUtils.UsesComparator());
1290 for (UsesNodeBuilder usesNode : usesNodes) {
1291 resolveUses(usesNode, modules, context);
1298 * Find target grouping and copy its child nodes to current location with
1302 * uses node to resolve
1304 * all loaded modules
1306 * SchemaContext containing already resolved modules
1308 private void resolveUses(final UsesNodeBuilder usesNode, final Map<String, TreeMap<Date, ModuleBuilder>> modules,
1309 final SchemaContext context) {
1310 if (!usesNode.isResolved()) {
1311 DataNodeContainerBuilder parent = usesNode.getParent();
1312 ModuleBuilder module = ParserUtils.getParentModule(parent);
1313 GroupingBuilder target = GroupingUtils.getTargetGroupingFromModules(usesNode, modules, module);
1314 if (target == null) {
1315 resolveUsesWithContext(usesNode);
1316 usesNode.setResolved(true);
1317 for (AugmentationSchemaBuilder augment : usesNode.getAugmentations()) {
1318 resolveUsesAugment(augment, module, modules, context);
1321 parent.getChildNodeBuilders().addAll(target.instantiateChildNodes(parent));
1322 parent.getTypeDefinitionBuilders().addAll(target.instantiateTypedefs(parent));
1323 parent.getGroupingBuilders().addAll(target.instantiateGroupings(parent));
1324 parent.getUnknownNodes().addAll(target.instantiateUnknownNodes(parent));
1325 usesNode.setResolved(true);
1326 for (AugmentationSchemaBuilder augment : usesNode.getAugmentations()) {
1327 resolveUsesAugment(augment, module, modules, context);
1330 GroupingUtils.performRefine(usesNode);
1335 * Copy target grouping child nodes to current location with new namespace.
1338 * uses node to resolve
1340 * all loaded modules
1342 * SchemaContext containing already resolved modules
1344 private void resolveUsesWithContext(final UsesNodeBuilder usesNode) {
1345 final int line = usesNode.getLine();
1346 DataNodeContainerBuilder parent = usesNode.getParent();
1347 ModuleBuilder module = ParserUtils.getParentModule(parent);
1348 SchemaPath parentPath;
1352 if (parent instanceof AugmentationSchemaBuilder || parent instanceof ModuleBuilder) {
1353 ns = module.getNamespace();
1354 rev = module.getRevision();
1355 pref = module.getPrefix();
1356 if (parent instanceof AugmentationSchemaBuilder) {
1357 parentPath = ((AugmentationSchemaBuilder) parent).getTargetNodeSchemaPath();
1359 parentPath = ((ModuleBuilder) parent).getPath();
1362 ns = ((DataSchemaNodeBuilder) parent).getQName().getNamespace();
1363 rev = ((DataSchemaNodeBuilder) parent).getQName().getRevision();
1364 pref = ((DataSchemaNodeBuilder) parent).getQName().getPrefix();
1365 parentPath = ((DataSchemaNodeBuilder) parent).getPath();
1368 GroupingDefinition gd = usesNode.getGroupingDefinition();
1370 Set<DataSchemaNodeBuilder> childNodes = wrapChildNodes(module.getModuleName(), line, gd.getChildNodes(),
1371 parentPath, ns, rev, pref);
1372 parent.getChildNodeBuilders().addAll(childNodes);
1373 for (DataSchemaNodeBuilder childNode : childNodes) {
1374 setNodeAddedByUses(childNode);
1377 Set<TypeDefinitionBuilder> typedefs = wrapTypedefs(module.getModuleName(), line, gd, parentPath, ns, rev, pref);
1378 parent.getTypeDefinitionBuilders().addAll(typedefs);
1379 for (TypeDefinitionBuilder typedef : typedefs) {
1380 setNodeAddedByUses(typedef);
1383 Set<GroupingBuilder> groupings = wrapGroupings(module.getModuleName(), line, usesNode.getGroupingDefinition()
1384 .getGroupings(), parentPath, ns, rev, pref);
1385 parent.getGroupingBuilders().addAll(groupings);
1386 for (GroupingBuilder gb : groupings) {
1387 setNodeAddedByUses(gb);
1390 List<UnknownSchemaNodeBuilder> unknownNodes = wrapUnknownNodes(module.getModuleName(), line,
1391 gd.getUnknownSchemaNodes(), parentPath, ns, rev, pref);
1392 parent.getUnknownNodes().addAll(unknownNodes);
1393 for (UnknownSchemaNodeBuilder un : unknownNodes) {
1394 un.setAddedByUses(true);
1399 * Try to find extension builder describing this unknown node and assign it
1400 * to unknown node builder.
1403 * all loaded modules
1407 private void resolveUnknownNodes(final Map<String, TreeMap<Date, ModuleBuilder>> modules, final ModuleBuilder module) {
1408 for (UnknownSchemaNodeBuilder usnb : module.getAllUnknownNodes()) {
1409 QName nodeType = usnb.getNodeType();
1411 ModuleBuilder dependentModule = findModuleFromBuilders(modules, module, nodeType.getPrefix(),
1413 for (ExtensionBuilder extension : dependentModule.getAddedExtensions()) {
1414 if (extension.getQName().getLocalName().equals(nodeType.getLocalName())) {
1415 usnb.setNodeType(extension.getQName());
1416 usnb.setExtensionBuilder(extension);
1420 } catch (YangParseException e) {
1421 throw new YangParseException(module.getName(), usnb.getLine(), "Failed to resolve node " + usnb
1422 + ": no such extension definition found.", e);
1428 * Try to find extension builder describing this unknown node and assign it
1429 * to unknown node builder. If extension is not found in loaded modules, try
1430 * to find it in context.
1433 * all loaded modules
1437 * SchemaContext containing already resolved modules
1439 private void resolveUnknownNodesWithContext(final Map<String, TreeMap<Date, ModuleBuilder>> modules,
1440 final ModuleBuilder module, final SchemaContext context) {
1441 for (UnknownSchemaNodeBuilder usnb : module.getAllUnknownNodes()) {
1442 QName nodeType = usnb.getNodeType();
1444 ModuleBuilder dependentModuleBuilder = findModuleFromBuilders(modules, module, nodeType.getPrefix(),
1447 if (dependentModuleBuilder == null) {
1448 Module dependentModule = findModuleFromContext(context, module, nodeType.getPrefix(),
1450 for (ExtensionDefinition e : dependentModule.getExtensionSchemaNodes()) {
1451 if (e.getQName().getLocalName().equals(nodeType.getLocalName())) {
1452 usnb.setNodeType(new QName(e.getQName().getNamespace(), e.getQName().getRevision(),
1453 nodeType.getPrefix(), e.getQName().getLocalName()));
1454 usnb.setExtensionDefinition(e);
1459 for (ExtensionBuilder extension : dependentModuleBuilder.getAddedExtensions()) {
1460 if (extension.getQName().getLocalName().equals(nodeType.getLocalName())) {
1461 usnb.setExtensionBuilder(extension);
1467 } catch (YangParseException e) {
1468 throw new YangParseException(module.getName(), usnb.getLine(), "Failed to resolve node " + usnb
1469 + ": no such extension definition found.", e);
1476 * Traverse through modules and resolve their deviation statements.
1479 * all loaded modules
1481 private void resolveDeviations(final Map<String, TreeMap<Date, ModuleBuilder>> modules) {
1482 for (Map.Entry<String, TreeMap<Date, ModuleBuilder>> entry : modules.entrySet()) {
1483 for (Map.Entry<Date, ModuleBuilder> inner : entry.getValue().entrySet()) {
1484 ModuleBuilder b = inner.getValue();
1485 resolveDeviation(modules, b);
1491 * Traverse through module and resolve its deviation statements.
1494 * all loaded modules
1496 * module in which resolve deviations
1498 private void resolveDeviation(final Map<String, TreeMap<Date, ModuleBuilder>> modules, final ModuleBuilder module) {
1499 for (DeviationBuilder dev : module.getDeviationBuilders()) {
1500 int line = dev.getLine();
1501 SchemaPath targetPath = dev.getTargetPath();
1502 Iterable<QName> path = targetPath.getPathFromRoot();
1503 QName q0 = path.iterator().next();
1504 String prefix = q0.getPrefix();
1505 if (prefix == null) {
1506 prefix = module.getPrefix();
1509 ModuleBuilder dependentModuleBuilder = findModuleFromBuilders(modules, module, prefix, line);
1510 processDeviation(dev, dependentModuleBuilder, path, module);
1515 * Traverse through modules and resolve their deviation statements with
1519 * all loaded modules
1521 * already resolved context
1523 private void resolveDeviationsWithContext(final Map<String, TreeMap<Date, ModuleBuilder>> modules,
1524 final SchemaContext context) {
1525 for (Map.Entry<String, TreeMap<Date, ModuleBuilder>> entry : modules.entrySet()) {
1526 for (Map.Entry<Date, ModuleBuilder> inner : entry.getValue().entrySet()) {
1527 ModuleBuilder b = inner.getValue();
1528 resolveDeviationWithContext(modules, b, context);
1534 * Traverse through module and resolve its deviation statements with given
1538 * all loaded modules
1540 * module in which resolve deviations
1542 * already resolved context
1544 private void resolveDeviationWithContext(final Map<String, TreeMap<Date, ModuleBuilder>> modules,
1545 final ModuleBuilder module, final SchemaContext context) {
1546 for (DeviationBuilder dev : module.getDeviationBuilders()) {
1547 int line = dev.getLine();
1548 SchemaPath targetPath = dev.getTargetPath();
1549 Iterable<QName> path = targetPath.getPathFromRoot();
1550 QName q0 = path.iterator().next();
1551 String prefix = q0.getPrefix();
1552 if (prefix == null) {
1553 prefix = module.getPrefix();
1556 ModuleBuilder dependentModuleBuilder = findModuleFromBuilders(modules, module, prefix, line);
1557 if (dependentModuleBuilder == null) {
1558 Object currentParent = findModuleFromContext(context, module, prefix, line);
1560 for (QName q : path) {
1561 if (currentParent == null) {
1562 throw new YangParseException(module.getName(), line, FAIL_DEVIATION_TARGET);
1564 String name = q.getLocalName();
1565 if (currentParent instanceof DataNodeContainer) {
1566 currentParent = ((DataNodeContainer) currentParent).getDataChildByName(name);
1570 if (currentParent == null) {
1571 throw new YangParseException(module.getName(), line, FAIL_DEVIATION_TARGET);
1573 if (currentParent instanceof SchemaNode) {
1574 dev.setTargetPath(((SchemaNode) currentParent).getPath());
1578 processDeviation(dev, dependentModuleBuilder, path, module);
1584 * Correct deviation target path in deviation builder.
1588 * @param dependentModuleBuilder
1589 * module containing deviation target
1591 * current deviation target path
1595 private void processDeviation(final DeviationBuilder dev, final ModuleBuilder dependentModuleBuilder,
1596 final Iterable<QName> path, final ModuleBuilder module) {
1597 final int line = dev.getLine();
1598 Builder currentParent = dependentModuleBuilder;
1600 for (QName q : path) {
1601 if (currentParent == null) {
1602 throw new YangParseException(module.getName(), line, FAIL_DEVIATION_TARGET);
1604 String name = q.getLocalName();
1605 if (currentParent instanceof DataNodeContainerBuilder) {
1606 currentParent = ((DataNodeContainerBuilder) currentParent).getDataChildByName(name);
1610 if (!(currentParent instanceof SchemaNodeBuilder)) {
1611 throw new YangParseException(module.getName(), line, FAIL_DEVIATION_TARGET);
1613 dev.setTargetPath(((SchemaNodeBuilder) currentParent).getPath());