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.builder.impl.BuilderUtils.fillAugmentTarget;
11 import static org.opendaylight.yangtools.yang.parser.builder.impl.BuilderUtils.findBaseIdentity;
12 import static org.opendaylight.yangtools.yang.parser.builder.impl.BuilderUtils.findModuleFromBuilders;
13 import static org.opendaylight.yangtools.yang.parser.builder.impl.BuilderUtils.findModuleFromContext;
14 import static org.opendaylight.yangtools.yang.parser.builder.impl.BuilderUtils.findSchemaNode;
15 import static org.opendaylight.yangtools.yang.parser.builder.impl.BuilderUtils.findSchemaNodeInModule;
16 import static org.opendaylight.yangtools.yang.parser.builder.impl.BuilderUtils.processAugmentation;
17 import static org.opendaylight.yangtools.yang.parser.builder.impl.BuilderUtils.setNodeAddedByUses;
18 import static org.opendaylight.yangtools.yang.parser.builder.impl.BuilderUtils.wrapChildNode;
19 import static org.opendaylight.yangtools.yang.parser.builder.impl.BuilderUtils.wrapChildNodes;
20 import static org.opendaylight.yangtools.yang.parser.builder.impl.BuilderUtils.wrapGroupings;
21 import static org.opendaylight.yangtools.yang.parser.builder.impl.BuilderUtils.wrapTypedefs;
22 import static org.opendaylight.yangtools.yang.parser.builder.impl.BuilderUtils.wrapUnknownNodes;
23 import static org.opendaylight.yangtools.yang.parser.builder.impl.TypeUtils.resolveType;
24 import static org.opendaylight.yangtools.yang.parser.builder.impl.TypeUtils.resolveTypeUnion;
25 import static org.opendaylight.yangtools.yang.parser.builder.impl.TypeUtils.resolveTypeUnionWithContext;
26 import static org.opendaylight.yangtools.yang.parser.builder.impl.TypeUtils.resolveTypeWithContext;
28 import com.google.common.base.Optional;
29 import com.google.common.base.Preconditions;
30 import com.google.common.base.Splitter;
31 import com.google.common.collect.HashBiMap;
32 import com.google.common.io.ByteSource;
35 import java.io.IOException;
36 import java.io.InputStream;
37 import java.util.ArrayList;
38 import java.util.Collection;
39 import java.util.Collections;
40 import java.util.Date;
41 import java.util.HashMap;
42 import java.util.HashSet;
43 import java.util.Iterator;
44 import java.util.LinkedHashMap;
45 import java.util.LinkedHashSet;
46 import java.util.List;
49 import java.util.TreeMap;
51 import javax.annotation.concurrent.Immutable;
53 import org.antlr.v4.runtime.ANTLRInputStream;
54 import org.antlr.v4.runtime.CommonTokenStream;
55 import org.antlr.v4.runtime.tree.ParseTree;
56 import org.antlr.v4.runtime.tree.ParseTreeWalker;
57 import org.opendaylight.yangtools.antlrv4.code.gen.YangLexer;
58 import org.opendaylight.yangtools.antlrv4.code.gen.YangParser;
59 import org.opendaylight.yangtools.antlrv4.code.gen.YangParser.YangContext;
60 import org.opendaylight.yangtools.yang.common.QName;
61 import org.opendaylight.yangtools.yang.common.QNameModule;
62 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
63 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
64 import org.opendaylight.yangtools.yang.model.api.ExtensionDefinition;
65 import org.opendaylight.yangtools.yang.model.api.GroupingDefinition;
66 import org.opendaylight.yangtools.yang.model.api.Module;
67 import org.opendaylight.yangtools.yang.model.api.ModuleIdentifier;
68 import org.opendaylight.yangtools.yang.model.api.ModuleImport;
69 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
70 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
71 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
72 import org.opendaylight.yangtools.yang.model.parser.api.YangContextParser;
73 import org.opendaylight.yangtools.yang.model.parser.api.YangSyntaxErrorException;
74 import org.opendaylight.yangtools.yang.parser.builder.api.AugmentationSchemaBuilder;
75 import org.opendaylight.yangtools.yang.parser.builder.api.AugmentationTargetBuilder;
76 import org.opendaylight.yangtools.yang.parser.builder.api.Builder;
77 import org.opendaylight.yangtools.yang.parser.builder.api.DataNodeContainerBuilder;
78 import org.opendaylight.yangtools.yang.parser.builder.api.DataSchemaNodeBuilder;
79 import org.opendaylight.yangtools.yang.parser.builder.api.ExtensionBuilder;
80 import org.opendaylight.yangtools.yang.parser.builder.api.GroupingBuilder;
81 import org.opendaylight.yangtools.yang.parser.builder.api.SchemaNodeBuilder;
82 import org.opendaylight.yangtools.yang.parser.builder.api.TypeAwareBuilder;
83 import org.opendaylight.yangtools.yang.parser.builder.api.TypeDefinitionBuilder;
84 import org.opendaylight.yangtools.yang.parser.builder.api.UnknownSchemaNodeBuilder;
85 import org.opendaylight.yangtools.yang.parser.builder.api.UsesNodeBuilder;
86 import org.opendaylight.yangtools.yang.parser.builder.impl.BuilderUtils;
87 import org.opendaylight.yangtools.yang.parser.builder.impl.ChoiceBuilder;
88 import org.opendaylight.yangtools.yang.parser.builder.impl.ChoiceCaseBuilder;
89 import org.opendaylight.yangtools.yang.parser.builder.impl.DeviationBuilder;
90 import org.opendaylight.yangtools.yang.parser.builder.impl.GroupingUtils;
91 import org.opendaylight.yangtools.yang.parser.builder.impl.IdentitySchemaNodeBuilder;
92 import org.opendaylight.yangtools.yang.parser.builder.impl.IdentityrefTypeBuilder;
93 import org.opendaylight.yangtools.yang.parser.builder.impl.ModuleBuilder;
94 import org.opendaylight.yangtools.yang.parser.builder.impl.ModuleImpl;
95 import org.opendaylight.yangtools.yang.parser.builder.impl.UnionTypeBuilder;
96 import org.opendaylight.yangtools.yang.parser.builder.impl.UnknownSchemaNodeBuilderImpl;
97 import org.opendaylight.yangtools.yang.parser.builder.util.Comparators;
98 import org.opendaylight.yangtools.yang.parser.util.ModuleDependencySort;
99 import org.opendaylight.yangtools.yang.parser.util.NamedByteArrayInputStream;
100 import org.opendaylight.yangtools.yang.parser.util.NamedFileInputStream;
101 import org.opendaylight.yangtools.yang.parser.util.NamedInputStream;
102 import org.opendaylight.yangtools.yang.parser.util.YangParseException;
103 import org.slf4j.Logger;
104 import org.slf4j.LoggerFactory;
107 public final class YangParserImpl implements YangContextParser {
108 private static final Logger LOG = LoggerFactory.getLogger(YangParserImpl.class);
109 private static final String FAIL_DEVIATION_TARGET = "Failed to find deviation target.";
110 private static final Splitter COLON_SPLITTER = Splitter.on(':');
111 private static final YangParserImpl INSTANCE = new YangParserImpl();
113 public static YangParserImpl getInstance() {
119 public Set<Module> parseYangModels(final File yangFile, final File directory) {
121 return parseFile(yangFile, directory).getModules();
122 } catch (IOException | YangSyntaxErrorException e) {
123 throw new YangParseException("Failed to parse yang data", e);
128 public SchemaContext parseFile(final File yangFile, final File directory) throws IOException,
129 YangSyntaxErrorException {
130 Preconditions.checkState(yangFile.exists(), yangFile + " does not exists");
131 Preconditions.checkState(directory.exists(), directory + " does not exists");
132 Preconditions.checkState(directory.isDirectory(), directory + " is not a directory");
134 final String yangFileName = yangFile.getName();
135 final String[] fileList = checkNotNull(directory.list(), directory + " not found or is not a directory");
137 Map<ByteSource, File> sourceToFile = new LinkedHashMap<>();
138 ByteSource mainFileSource = BuilderUtils.fileToByteSource(yangFile);
139 sourceToFile.put(mainFileSource, yangFile);
141 for (String fileName : fileList) {
142 if (fileName.equals(yangFileName)) {
145 File dependency = new File(directory, fileName);
146 if (dependency.isFile()) {
147 sourceToFile.put(BuilderUtils.fileToByteSource(dependency), dependency);
151 Map<ByteSource, ModuleBuilder> sourceToBuilder = parseSourcesToBuilders(sourceToFile.keySet());
152 ModuleBuilder main = sourceToBuilder.get(mainFileSource);
154 List<ModuleBuilder> moduleBuilders = new ArrayList<>();
155 moduleBuilders.add(main);
156 filterImports(main, new ArrayList<>(sourceToBuilder.values()), moduleBuilders);
157 Collection<ModuleBuilder> resolved = resolveSubmodules(moduleBuilders);
159 // module builders sorted by dependencies
160 List<ModuleBuilder> sortedBuilders = ModuleDependencySort.sort(resolved);
161 LinkedHashMap<String, TreeMap<Date, ModuleBuilder>> modules = orderModules(sortedBuilders);
162 Collection<Module> unsorted = build(modules).values();
163 Set<Module> result = new LinkedHashSet<>(
164 ModuleDependencySort.sort(unsorted.toArray(new Module[unsorted.size()])));
165 return resolveSchemaContext(result);
170 public Set<Module> parseYangModels(final List<File> yangFiles) {
171 return parseFiles(yangFiles).getModules();
175 public SchemaContext parseFiles(final Collection<File> yangFiles) {
176 Collection<Module> unsorted = parseYangModelsMapped(yangFiles).values();
177 Set<Module> sorted = new LinkedHashSet<>(
178 ModuleDependencySort.sort(unsorted.toArray(new Module[unsorted.size()])));
179 return resolveSchemaContext(sorted);
184 public Set<Module> parseYangModels(final List<File> yangFiles, final SchemaContext context) {
186 return parseFiles(yangFiles, context).getModules();
187 } catch (IOException | YangSyntaxErrorException e) {
188 throw new YangParseException("Failed to parse yang data", e);
193 public SchemaContext parseFiles(final Collection<File> yangFiles, final SchemaContext context) throws IOException,
194 YangSyntaxErrorException {
195 if (yangFiles == null) {
196 return resolveSchemaContext(Collections.<Module> emptySet());
199 Collection<ByteSource> sources = BuilderUtils.filesToByteSources(yangFiles);
200 return parseSources(sources, context);
205 public Set<Module> parseYangModelsFromStreams(final List<InputStream> yangModelStreams) {
207 Collection<ByteSource> sources = BuilderUtils.streamsToByteSources(yangModelStreams);
208 return parseSources(sources).getModules();
209 } catch (IOException | YangSyntaxErrorException e) {
210 throw new YangParseException("Failed to parse yang data", e);
215 public SchemaContext parseSources(final Collection<ByteSource> sources) throws IOException,
216 YangSyntaxErrorException {
217 Collection<Module> unsorted = parseYangModelSources(sources).values();
218 Set<Module> sorted = new LinkedHashSet<>(
219 ModuleDependencySort.sort(unsorted.toArray(new Module[unsorted.size()])));
220 return resolveSchemaContext(sorted);
225 public Set<Module> parseYangModelsFromStreams(final List<InputStream> yangModelStreams, final SchemaContext context) {
227 Collection<ByteSource> sources = BuilderUtils.streamsToByteSources(yangModelStreams);
228 return parseSources(sources, context).getModules();
229 } catch (IOException | YangSyntaxErrorException e) {
230 throw new YangParseException("Failed to parse yang data", e);
235 public SchemaContext parseSources(final Collection<ByteSource> sources, final SchemaContext context)
236 throws IOException, YangSyntaxErrorException {
237 if (sources == null) {
238 return resolveSchemaContext(Collections.<Module> emptySet());
241 final Map<String, TreeMap<Date, ModuleBuilder>> modules = resolveModuleBuilders(sources, context);
242 final Set<Module> unsorted = new LinkedHashSet<>(buildWithContext(modules, context).values());
243 if (context != null) {
244 for (Module m : context.getModules()) {
245 if (!unsorted.contains(m)) {
250 Set<Module> result = new LinkedHashSet<>(
251 ModuleDependencySort.sort(unsorted.toArray(new Module[unsorted.size()])));
252 return resolveSchemaContext(result);
256 public Map<File, Module> parseYangModelsMapped(final Collection<File> yangFiles) {
257 if (yangFiles == null || yangFiles.isEmpty()) {
258 return Collections.emptyMap();
261 Map<ByteSource, File> byteSourceToFile = new HashMap<>();
262 for (final File file : yangFiles) {
263 ByteSource source = new ByteSource() {
265 public InputStream openStream() throws IOException {
266 return new NamedFileInputStream(file, file.getPath());
269 byteSourceToFile.put(source, file);
272 Map<ByteSource, Module> byteSourceToModule;
274 byteSourceToModule = parseYangModelSources(byteSourceToFile.keySet());
275 } catch (IOException | YangSyntaxErrorException e) {
276 throw new YangParseException("Failed to parse yang data", e);
278 Map<File, Module> result = new LinkedHashMap<>();
279 for (Map.Entry<ByteSource, Module> entry : byteSourceToModule.entrySet()) {
280 result.put(byteSourceToFile.get(entry.getKey()), entry.getValue());
286 public Map<InputStream, Module> parseYangModelsFromStreamsMapped(final Collection<InputStream> yangModelStreams) {
287 if (yangModelStreams == null || yangModelStreams.isEmpty()) {
288 return Collections.emptyMap();
291 Map<ByteSource, InputStream> sourceToStream = new HashMap<>();
292 for (final InputStream stream : yangModelStreams) {
293 ByteSource source = new ByteSource() {
295 public InputStream openStream() throws IOException {
296 return NamedByteArrayInputStream.create(stream);
299 sourceToStream.put(source, stream);
302 Map<ByteSource, Module> sourceToModule;
304 sourceToModule = parseYangModelSources(sourceToStream.keySet());
305 } catch (IOException | YangSyntaxErrorException e) {
306 throw new YangParseException("Failed to parse yang data", e);
308 Map<InputStream, Module> result = new LinkedHashMap<>();
309 for (Map.Entry<ByteSource, Module> entry : sourceToModule.entrySet()) {
310 result.put(sourceToStream.get(entry.getKey()), entry.getValue());
316 public SchemaContext resolveSchemaContext(final Set<Module> modules) {
317 // after merging parse method with this one, add support for getting
318 // submodule sources.
319 Map<ModuleIdentifier, String> identifiersToSources = new HashMap<>();
320 for (Module module : modules) {
321 ModuleImpl moduleImpl = (ModuleImpl) module;
322 identifiersToSources.put(module, moduleImpl.getSource());
324 return new SchemaContextImpl(modules, identifiersToSources);
327 private Map<ByteSource, Module> parseYangModelSources(final Collection<ByteSource> sources) throws IOException,
328 YangSyntaxErrorException {
329 if (sources == null || sources.isEmpty()) {
330 return Collections.emptyMap();
333 Map<ByteSource, ModuleBuilder> sourceToBuilder = resolveSources(sources);
334 // sort and check for duplicates
335 List<ModuleBuilder> sorted = ModuleDependencySort.sort(sourceToBuilder.values());
336 Map<String, TreeMap<Date, ModuleBuilder>> modules = orderModules(sorted);
337 Map<ModuleBuilder, Module> builderToModule = build(modules);
338 Map<ModuleBuilder, ByteSource> builderToSource = HashBiMap.create(sourceToBuilder).inverse();
339 sorted = ModuleDependencySort.sort(builderToModule.keySet());
341 Map<ByteSource, Module> result = new LinkedHashMap<>();
342 for (ModuleBuilder moduleBuilder : sorted) {
343 Module value = checkNotNull(builderToModule.get(moduleBuilder), "Cannot get module for %s", moduleBuilder);
344 result.put(builderToSource.get(moduleBuilder), value);
351 * Parse streams and resolve submodules.
354 * collection of streams to parse
355 * @return map, where key is source stream and value is module builder
357 * @throws YangSyntaxErrorException
359 // TODO: remove ByteSource result after removing YangModelParser
360 private Map<ByteSource, ModuleBuilder> resolveSources(final Collection<ByteSource> streams)
361 throws IOException, YangSyntaxErrorException {
362 Map<ByteSource, ModuleBuilder> builders = parseSourcesToBuilders(streams);
363 return resolveSubmodules(builders);
366 private Map<ByteSource, ModuleBuilder> parseSourcesToBuilders(final Collection<ByteSource> sources)
367 throws IOException, YangSyntaxErrorException {
368 final ParseTreeWalker walker = new ParseTreeWalker();
369 final Map<ByteSource, ParseTree> sourceToTree = parseYangSources(sources);
370 final Map<ByteSource, ModuleBuilder> sourceToBuilder = new LinkedHashMap<>();
373 new YangModelBasicValidator(walker).validate(sourceToTree.values());
375 YangParserListenerImpl yangModelParser;
376 for (Map.Entry<ByteSource, ParseTree> entry : sourceToTree.entrySet()) {
377 ByteSource source = entry.getKey();
378 String path = null; // TODO refactor to Optional
379 //TODO refactor so that path can be retrieved without opening stream: NamedInputStream -> NamedByteSource ?
380 try(InputStream stream = source.openStream()) {
381 if (stream instanceof NamedInputStream) {
382 path = stream.toString();
385 yangModelParser = new YangParserListenerImpl(path);
386 walker.walk(yangModelParser, entry.getValue());
387 ModuleBuilder moduleBuilder = yangModelParser.getModuleBuilder();
388 moduleBuilder.setSource(source);
389 sourceToBuilder.put(source, moduleBuilder);
391 return sourceToBuilder;
394 private Map<ByteSource, ModuleBuilder> resolveSubmodules(final Map<ByteSource, ModuleBuilder> builders) {
395 Map<ByteSource, ModuleBuilder> modules = new HashMap<>();
396 Set<ModuleBuilder> submodules = new HashSet<>();
397 for (Map.Entry<ByteSource, ModuleBuilder> entry : builders.entrySet()) {
398 ModuleBuilder moduleBuilder = entry.getValue();
399 if (moduleBuilder.isSubmodule()) {
400 submodules.add(moduleBuilder);
402 modules.put(entry.getKey(), moduleBuilder);
406 Collection<ModuleBuilder> values = modules.values();
407 for (ModuleBuilder submodule : submodules) {
408 for (ModuleBuilder module : values) {
409 if (module.getName().equals(submodule.getBelongsTo())) {
410 addSubmoduleToModule(submodule, module);
418 * Traverse collection of builders, find builders representing submodule and
419 * add this submodule to its parent module.
422 * collection of builders containing modules and submodules
423 * @return collection of module builders
425 private Collection<ModuleBuilder> resolveSubmodules(final Collection<ModuleBuilder> builders) {
426 Collection<ModuleBuilder> modules = new HashSet<>();
427 Set<ModuleBuilder> submodules = new HashSet<>();
428 for (ModuleBuilder moduleBuilder : builders) {
429 if (moduleBuilder.isSubmodule()) {
430 submodules.add(moduleBuilder);
432 modules.add(moduleBuilder);
436 for (ModuleBuilder submodule : submodules) {
437 for (ModuleBuilder module : modules) {
438 if (module.getName().equals(submodule.getBelongsTo())) {
439 addSubmoduleToModule(submodule, module);
446 private void addSubmoduleToModule(final ModuleBuilder submodule, final ModuleBuilder module) {
447 submodule.setParent(module);
448 module.getDirtyNodes().addAll(submodule.getDirtyNodes());
449 module.getModuleImports().addAll(submodule.getModuleImports());
450 module.getAugments().addAll(submodule.getAugments());
451 module.getAugmentBuilders().addAll(submodule.getAugmentBuilders());
452 module.getAllAugments().addAll(submodule.getAllAugments());
453 module.getChildNodeBuilders().addAll(submodule.getChildNodeBuilders());
454 module.getChildNodes().putAll(submodule.getChildNodes());
455 module.getGroupings().addAll(submodule.getGroupings());
456 module.getGroupingBuilders().addAll(submodule.getGroupingBuilders());
457 module.getTypeDefinitions().addAll(submodule.getTypeDefinitions());
458 module.getTypeDefinitionBuilders().addAll(submodule.getTypeDefinitionBuilders());
459 module.getUsesNodes().addAll(submodule.getUsesNodes());
460 module.getUsesNodeBuilders().addAll(submodule.getUsesNodeBuilders());
461 module.getAllGroupings().addAll(submodule.getAllGroupings());
462 module.getAllUsesNodes().addAll(submodule.getAllUsesNodes());
463 module.getRpcs().addAll(submodule.getRpcs());
464 module.getAddedRpcs().addAll(submodule.getAddedRpcs());
465 module.getNotifications().addAll(submodule.getNotifications());
466 module.getAddedNotifications().addAll(submodule.getAddedNotifications());
467 module.getIdentities().addAll(submodule.getIdentities());
468 module.getAddedIdentities().addAll(submodule.getAddedIdentities());
469 module.getFeatures().addAll(submodule.getFeatures());
470 module.getAddedFeatures().addAll(submodule.getAddedFeatures());
471 module.getDeviations().addAll(submodule.getDeviations());
472 module.getDeviationBuilders().addAll(submodule.getDeviationBuilders());
473 module.getExtensions().addAll(submodule.getExtensions());
474 module.getAddedExtensions().addAll(submodule.getAddedExtensions());
475 module.getUnknownNodes().addAll(submodule.getUnknownNodes());
476 module.getAllUnknownNodes().addAll(submodule.getAllUnknownNodes());
479 private Map<String, TreeMap<Date, ModuleBuilder>> resolveModuleBuilders(
480 final Collection<ByteSource> yangFileStreams, final SchemaContext context) throws IOException,
481 YangSyntaxErrorException {
482 Map<ByteSource, ModuleBuilder> parsedBuilders = resolveSources(yangFileStreams);
483 ModuleBuilder[] builders = new ModuleBuilder[parsedBuilders.size()];
484 parsedBuilders.values().toArray(builders);
486 // module dependency graph sorted
487 List<ModuleBuilder> sorted;
488 if (context == null) {
489 sorted = ModuleDependencySort.sort(builders);
491 sorted = ModuleDependencySort.sortWithContext(context, builders);
493 return orderModules(sorted);
497 * Order modules by name and revision.
501 * @return modules ordered by name and revision
503 private LinkedHashMap<String, TreeMap<Date, ModuleBuilder>> orderModules(final List<ModuleBuilder> modules) {
504 final LinkedHashMap<String, TreeMap<Date, ModuleBuilder>> result = new LinkedHashMap<>();
505 for (final ModuleBuilder builder : modules) {
506 if (builder == null) {
509 final String builderName = builder.getName();
510 Date builderRevision = builder.getRevision();
511 if (builderRevision == null) {
512 builderRevision = new Date(0L);
514 TreeMap<Date, ModuleBuilder> builderByRevision = result.get(builderName);
515 if (builderByRevision == null) {
516 builderByRevision = new TreeMap<>();
518 builderByRevision.put(builderRevision, builder);
519 result.put(builderName, builderByRevision);
525 * Find {@code main} dependencies from {@code other} and add them to
533 * collection to fill up
535 private void filterImports(final ModuleBuilder main, final Collection<ModuleBuilder> other,
536 final Collection<ModuleBuilder> filtered) {
537 Set<ModuleImport> imports = main.getModuleImports();
539 // if this is submodule, add parent to filtered and pick its imports
540 if (main.isSubmodule()) {
541 TreeMap<Date, ModuleBuilder> dependencies = new TreeMap<>();
542 for (ModuleBuilder mb : other) {
543 if (mb.getName().equals(main.getBelongsTo())) {
544 dependencies.put(mb.getRevision(), mb);
547 ModuleBuilder parent = dependencies.get(dependencies.firstKey());
548 filtered.add(parent);
549 imports.addAll(parent.getModuleImports());
552 for (ModuleImport mi : imports) {
553 for (ModuleBuilder builder : other) {
554 if (mi.getModuleName().equals(builder.getModuleName())) {
555 if (mi.getRevision() == null) {
556 if (!filtered.contains(builder)) {
557 filtered.add(builder);
558 filterImports(builder, other, filtered);
561 if (mi.getRevision().equals(builder.getRevision())) {
562 if (!filtered.contains(builder)) {
563 filtered.add(builder);
564 filterImports(builder, other, filtered);
573 private Map<ByteSource, ParseTree> parseYangSources(final Collection<ByteSource> sources) throws IOException,
574 YangSyntaxErrorException {
575 final Map<ByteSource, ParseTree> trees = new HashMap<>();
576 for (ByteSource source : sources) {
577 trees.put(source, parseYangSource(source));
582 private YangContext parseYangSource(final ByteSource source) throws IOException, YangSyntaxErrorException {
583 try (InputStream stream = source.openStream()) {
584 final ANTLRInputStream input = new ANTLRInputStream(stream);
585 final YangLexer lexer = new YangLexer(input);
586 final CommonTokenStream tokens = new CommonTokenStream(lexer);
587 final YangParser parser = new YangParser(tokens);
588 parser.removeErrorListeners();
590 final YangErrorListener errorListener = new YangErrorListener();
591 parser.addErrorListener(errorListener);
593 final YangContext result = parser.yang();
594 errorListener.validate();
601 * Mini parser: This parsing context does not validate full YANG module, only
602 * parses header up to the revisions and imports.
603 * @see org.opendaylight.yangtools.yang.parser.impl.util.YangModelDependencyInfo
605 public static YangContext parseStreamWithoutErrorListeners(final InputStream yangStream) {
606 YangContext result = null;
608 final ANTLRInputStream input = new ANTLRInputStream(yangStream);
609 final YangLexer lexer = new YangLexer(input);
610 final CommonTokenStream tokens = new CommonTokenStream(lexer);
611 final YangParser parser = new YangParser(tokens);
612 parser.removeErrorListeners();
613 result = parser.yang();
614 } catch (IOException e) {
615 LOG.warn("Exception while reading yang file: " + yangStream, e);
621 * Creates builder-to-module map based on given modules. Method first
622 * resolve unresolved type references, instantiate groupings through uses
623 * statements and perform augmentation.
625 * Node resolving must be performed in following order:
628 * unresolved type references</li>
630 * uses in groupings</li>
632 * uses in other nodes</li>
639 * @return modules mapped on their builders
641 private Map<ModuleBuilder, Module> build(final Map<String, TreeMap<Date, ModuleBuilder>> modules) {
642 resolveDirtyNodes(modules);
643 resolveAugmentsTargetPath(modules, null);
644 resolveUsesTargetGrouping(modules, null);
645 resolveUsesForGroupings(modules, null);
646 resolveUsesForNodes(modules, null);
647 resolveAugments(modules, null);
648 resolveIdentities(modules);
649 resolveDeviations(modules);
652 final Map<ModuleBuilder, Module> result = new LinkedHashMap<>();
653 for (Map.Entry<String, TreeMap<Date, ModuleBuilder>> entry : modules.entrySet()) {
654 for (Map.Entry<Date, ModuleBuilder> childEntry : entry.getValue().entrySet()) {
655 final ModuleBuilder moduleBuilder = childEntry.getValue();
656 final Module module = moduleBuilder.build();
657 result.put(moduleBuilder, module);
664 * Creates builder-to-module map based on given modules. Method first
665 * resolve unresolved type references, instantiate groupings through uses
666 * statements and perform augmentation.
668 * Node resolving must be performed in following order:
671 * unresolved type references</li>
673 * uses in groupings</li>
675 * uses in other nodes</li>
683 * SchemaContext containing already resolved modules
684 * @return modules mapped on their builders
686 private Map<ModuleBuilder, Module> buildWithContext(final Map<String, TreeMap<Date, ModuleBuilder>> modules,
687 final SchemaContext context) {
688 resolvedDirtyNodesWithContext(modules, context);
689 resolveAugmentsTargetPath(modules, context);
690 resolveUsesTargetGrouping(modules, context);
691 resolveUsesForGroupings(modules, context);
692 resolveUsesForNodes(modules, context);
693 resolveAugments(modules, context);
694 resolveIdentitiesWithContext(modules, context);
695 resolveDeviationsWithContext(modules, context);
698 final Map<ModuleBuilder, Module> result = new LinkedHashMap<>();
699 for (Map.Entry<String, TreeMap<Date, ModuleBuilder>> entry : modules.entrySet()) {
700 for (Map.Entry<Date, ModuleBuilder> childEntry : entry.getValue().entrySet()) {
701 final ModuleBuilder moduleBuilder = childEntry.getValue();
702 final Module module = moduleBuilder.build();
703 result.put(moduleBuilder, module);
710 * Resolve all unresolved type references.
715 private void resolveDirtyNodes(final Map<String, TreeMap<Date, ModuleBuilder>> modules) {
716 for (Map.Entry<String, TreeMap<Date, ModuleBuilder>> entry : modules.entrySet()) {
717 for (Map.Entry<Date, ModuleBuilder> childEntry : entry.getValue().entrySet()) {
718 final ModuleBuilder module = childEntry.getValue();
719 resolveUnknownNodes(modules, module);
720 resolveDirtyNodes(modules, module);
726 * Resolve all unresolved type references.
731 * SchemaContext containing already resolved modules
733 private void resolvedDirtyNodesWithContext(final Map<String, TreeMap<Date, ModuleBuilder>> modules,
734 final SchemaContext context) {
735 for (Map.Entry<String, TreeMap<Date, ModuleBuilder>> entry : modules.entrySet()) {
736 for (Map.Entry<Date, ModuleBuilder> childEntry : entry.getValue().entrySet()) {
737 final ModuleBuilder module = childEntry.getValue();
738 resolveUnknownNodesWithContext(modules, module, context);
739 resolveDirtyNodesWithContext(modules, module, context);
745 * Search for dirty nodes (node which contains UnknownType) and resolve
749 * all available modules
753 private void resolveDirtyNodes(final Map<String, TreeMap<Date, ModuleBuilder>> modules, final ModuleBuilder module) {
754 final Set<TypeAwareBuilder> dirtyNodes = module.getDirtyNodes();
755 if (!dirtyNodes.isEmpty()) {
756 for (TypeAwareBuilder nodeToResolve : dirtyNodes) {
757 if (nodeToResolve instanceof UnionTypeBuilder) {
758 // special handling for union types
759 resolveTypeUnion((UnionTypeBuilder) nodeToResolve, modules, module);
760 } else if (nodeToResolve.getTypedef() instanceof IdentityrefTypeBuilder) {
761 // special handling for identityref types
762 IdentityrefTypeBuilder idref = (IdentityrefTypeBuilder) nodeToResolve.getTypedef();
763 IdentitySchemaNodeBuilder identity = findBaseIdentity(modules, module, idref.getBaseString(),
765 if (identity == null) {
766 throw new YangParseException(module.getName(), idref.getLine(), "Failed to find base identity");
768 idref.setBaseIdentity(identity);
769 nodeToResolve.setType(idref.build());
771 resolveType(nodeToResolve, modules, module);
777 private void resolveDirtyNodesWithContext(final Map<String, TreeMap<Date, ModuleBuilder>> modules,
778 final ModuleBuilder module, final SchemaContext context) {
779 final Set<TypeAwareBuilder> dirtyNodes = module.getDirtyNodes();
780 if (!dirtyNodes.isEmpty()) {
781 for (TypeAwareBuilder nodeToResolve : dirtyNodes) {
782 if (nodeToResolve instanceof UnionTypeBuilder) {
783 // special handling for union types
784 resolveTypeUnionWithContext((UnionTypeBuilder) nodeToResolve, modules, module, context);
785 } else if (nodeToResolve.getTypedef() instanceof IdentityrefTypeBuilder) {
786 // special handling for identityref types
787 IdentityrefTypeBuilder idref = (IdentityrefTypeBuilder) nodeToResolve.getTypedef();
788 IdentitySchemaNodeBuilder identity = findBaseIdentity(modules, module, idref.getBaseString(),
790 idref.setBaseIdentity(identity);
791 nodeToResolve.setType(idref.build());
793 resolveTypeWithContext(nodeToResolve, modules, module, context);
800 * Traverse through augmentations of modules and fix their child nodes
806 * SchemaContext containing already resolved modules
808 private void resolveAugmentsTargetPath(final Map<String, TreeMap<Date, ModuleBuilder>> modules,
809 final SchemaContext context) {
810 // collect augments from all loaded modules
811 final List<AugmentationSchemaBuilder> allAugments = new ArrayList<>();
812 for (Map.Entry<String, TreeMap<Date, ModuleBuilder>> entry : modules.entrySet()) {
813 for (Map.Entry<Date, ModuleBuilder> inner : entry.getValue().entrySet()) {
814 allAugments.addAll(inner.getValue().getAllAugments());
818 for (AugmentationSchemaBuilder augment : allAugments) {
819 setCorrectAugmentTargetPath(modules, augment, context);
824 * Find augment target and set correct schema path for all its child nodes.
831 * SchemaContext containing already resolved modules
833 private void setCorrectAugmentTargetPath(final Map<String, TreeMap<Date, ModuleBuilder>> modules,
834 final AugmentationSchemaBuilder augment, final SchemaContext context) {
835 ModuleBuilder module = BuilderUtils.getParentModule(augment);
836 SchemaPath oldSchemaPath = augment.getTargetPath();
837 List<QName> newPath = new ArrayList<>();
839 Builder parent = augment.getParent();
840 if (parent instanceof UsesNodeBuilder) {
841 DataNodeContainerBuilder usesParent = ((UsesNodeBuilder) parent).getParent();
842 newPath.addAll(usesParent.getPath().getPath());
844 final QName baseQName = usesParent.getQName();
845 final QNameModule qnm;
847 if (baseQName == null) {
848 ModuleBuilder m = BuilderUtils.getParentModule(usesParent);
849 qnm = m.getQNameModule();
850 prefix = m.getPrefix();
852 qnm = baseQName.getModule();
853 prefix = baseQName.getPrefix();
856 for (QName qn : oldSchemaPath.getPathFromRoot()) {
857 newPath.add(QName.create(qnm, prefix, qn.getLocalName()));
860 Iterable<QName> oldPath = oldSchemaPath.getPathFromRoot();
861 for (QName qn : oldPath) {
862 QNameModule qnm = module.getQNameModule();
863 String localPrefix = qn.getPrefix();
864 if (localPrefix != null && !localPrefix.isEmpty()) {
865 ModuleBuilder currentModule = BuilderUtils.findModuleFromBuilders(modules, module, localPrefix,
867 if (currentModule == null) {
868 Module m = BuilderUtils.findModuleFromContext(context, module, localPrefix, augment.getLine());
870 throw new YangParseException(module.getName(), augment.getLine(), "Module with prefix "
871 + localPrefix + " not found.");
873 qnm = m.getQNameModule();
875 qnm = currentModule.getQNameModule();
878 newPath.add(new QName(qnm.getNamespace(), qnm.getRevision(), localPrefix, qn.getLocalName()));
881 augment.setTargetNodeSchemaPath(SchemaPath.create(newPath, true));
883 for (DataSchemaNodeBuilder childNode : augment.getChildNodeBuilders()) {
884 correctPathForAugmentNodes(childNode, augment.getTargetNodeSchemaPath());
889 * Set new schema path to node and all its child nodes based on given parent
890 * path. This method do not change the namespace.
893 * node which schema path should be updated
895 * schema path of parent node
897 private void correctPathForAugmentNodes(final DataSchemaNodeBuilder node, final SchemaPath parentPath) {
898 SchemaPath newPath = parentPath.createChild(node.getQName());
899 node.setPath(newPath);
900 if (node instanceof DataNodeContainerBuilder) {
901 for (DataSchemaNodeBuilder child : ((DataNodeContainerBuilder) node).getChildNodeBuilders()) {
902 correctPathForAugmentNodes(child, node.getPath());
905 if (node instanceof ChoiceBuilder) {
906 for (ChoiceCaseBuilder child : ((ChoiceBuilder) node).getCases()) {
907 correctPathForAugmentNodes(child, node.getPath());
913 * Check augments for mandatory nodes. If the target node is in another
914 * module, then nodes added by the augmentation MUST NOT be mandatory nodes.
915 * If mandatory node is found, throw an exception.
920 private void checkAugmentMandatoryNodes(final Collection<AugmentationSchemaBuilder> augments) {
921 for (AugmentationSchemaBuilder augment : augments) {
922 String augmentPrefix = augment.getTargetPath().getPathFromRoot().iterator().next().getPrefix();
923 ModuleBuilder module = BuilderUtils.getParentModule(augment);
924 String modulePrefix = module.getPrefix();
926 if (augmentPrefix == null || augmentPrefix.isEmpty() || augmentPrefix.equals(modulePrefix)) {
930 for (DataSchemaNodeBuilder childNode : augment.getChildNodeBuilders()) {
931 if (childNode.getConstraints().isMandatory()) {
932 throw new YangParseException(augment.getModuleName(), augment.getLine(),
933 "Error in augment parsing: cannot augment mandatory node "
934 + childNode.getQName().getLocalName());
941 * Go through all augment definitions and resolve them.
946 * SchemaContext containing already resolved modules
948 private void resolveAugments(final Map<String, TreeMap<Date, ModuleBuilder>> modules, final SchemaContext context) {
949 List<ModuleBuilder> all = new ArrayList<>();
950 for (Map.Entry<String, TreeMap<Date, ModuleBuilder>> entry : modules.entrySet()) {
951 for (Map.Entry<Date, ModuleBuilder> inner : entry.getValue().entrySet()) {
952 all.add(inner.getValue());
956 List<ModuleBuilder> sorted;
957 if (context == null) {
958 sorted = ModuleDependencySort.sort(all.toArray(new ModuleBuilder[all.size()]));
960 sorted = ModuleDependencySort.sortWithContext(context, all.toArray(new ModuleBuilder[all.size()]));
963 for (ModuleBuilder mb : sorted) {
965 List<AugmentationSchemaBuilder> augments = mb.getAllAugments();
966 checkAugmentMandatoryNodes(augments);
967 Collections.sort(augments, Comparators.AUGMENT_COMP);
968 for (AugmentationSchemaBuilder augment : augments) {
969 if (!(augment.isResolved())) {
970 boolean resolved = resolveAugment(augment, mb, modules, context);
972 throw new YangParseException(augment.getModuleName(), augment.getLine(),
973 "Error in augment parsing: failed to find augment target: " + augment);
982 * Perform augmentation defined under uses statement.
991 * SchemaContext containing already resolved modules
992 * @return true if augment process succeed
994 private boolean resolveUsesAugment(final AugmentationSchemaBuilder augment, final ModuleBuilder module,
995 final Map<String, TreeMap<Date, ModuleBuilder>> modules, final SchemaContext context) {
996 if (augment.isResolved()) {
1000 UsesNodeBuilder usesNode = (UsesNodeBuilder) augment.getParent();
1001 DataNodeContainerBuilder parentNode = usesNode.getParent();
1002 Optional<SchemaNodeBuilder> potentialTargetNode;
1003 SchemaPath resolvedTargetPath = augment.getTargetNodeSchemaPath();
1004 if (parentNode instanceof ModuleBuilder && resolvedTargetPath.isAbsolute()) {
1005 // Uses is directly used in module body, we lookup
1006 // We lookup in data namespace to find correct augmentation target
1007 potentialTargetNode = findSchemaNodeInModule(resolvedTargetPath, (ModuleBuilder) parentNode);
1009 // Uses is used in local context (be it data namespace or grouping namespace,
1010 // since all nodes via uses are imported to localName, it is safe to
1011 // to proceed only with local names.
1013 // Conflicting elements in other namespaces are still not present
1014 // since resolveUsesAugment occurs before augmenting from external modules.
1015 potentialTargetNode = Optional.<SchemaNodeBuilder> fromNullable(findSchemaNode(augment.getTargetPath()
1016 .getPath(), (SchemaNodeBuilder) parentNode));
1019 if (potentialTargetNode.isPresent()) {
1020 SchemaNodeBuilder targetNode = potentialTargetNode.get();
1021 if (targetNode instanceof AugmentationTargetBuilder) {
1022 fillAugmentTarget(augment, targetNode);
1023 ((AugmentationTargetBuilder) targetNode).addAugmentation(augment);
1024 augment.setResolved(true);
1027 throw new YangParseException(module.getName(), augment.getLine(), String.format(
1028 "Failed to resolve augment in uses. Invalid augment target: %s", potentialTargetNode));
1031 throw new YangParseException(module.getName(), augment.getLine(), String.format(
1032 "Failed to resolve augment in uses. Invalid augment target path: %s", augment.getTargetPath()));
1038 * Find augment target module and perform augmentation.
1041 * augment to resolve
1045 * all loaded modules
1047 * SchemaContext containing already resolved modules
1048 * @return true if augment process succeed
1050 private boolean resolveAugment(final AugmentationSchemaBuilder augment, final ModuleBuilder module,
1051 final Map<String, TreeMap<Date, ModuleBuilder>> modules, final SchemaContext context) {
1052 if (augment.isResolved()) {
1056 QName targetPath = augment.getTargetPath().getPathFromRoot().iterator().next();
1057 ModuleBuilder targetModule = findTargetModule(targetPath, module, modules, context, augment.getLine());
1058 if (targetModule == null) {
1059 throw new YangParseException(module.getModuleName(), augment.getLine(), "Failed to resolve augment "
1063 return processAugmentation(augment, targetModule);
1067 * Find module from loaded modules or from context based on given qname. If
1068 * module is found in context, create wrapper over this module and add it to
1069 * collection of loaded modules.
1075 * all loaded modules
1082 private ModuleBuilder findTargetModule(final QName qname, final ModuleBuilder module,
1083 final Map<String, TreeMap<Date, ModuleBuilder>> modules, final SchemaContext context, final int line) {
1084 ModuleBuilder targetModule;
1086 String prefix = qname.getPrefix();
1087 if (prefix == null || prefix.isEmpty()) {
1088 targetModule = module;
1090 targetModule = findModuleFromBuilders(modules, module, qname.getPrefix(), line);
1093 if (targetModule == null && context != null) {
1094 Module m = findModuleFromContext(context, module, prefix, line);
1095 targetModule = new ModuleBuilder(m);
1096 DataSchemaNode firstNode = m.getDataChildByName(qname.getLocalName());
1097 DataSchemaNodeBuilder firstNodeWrapped = wrapChildNode(targetModule.getModuleName(), line, firstNode,
1098 targetModule.getPath(), firstNode.getQName());
1099 targetModule.addChildNode(firstNodeWrapped);
1101 TreeMap<Date, ModuleBuilder> map = new TreeMap<>();
1102 map.put(targetModule.getRevision(), targetModule);
1103 modules.put(targetModule.getModuleName(), map);
1106 return targetModule;
1109 private ModuleBuilder findTargetModule(final String prefix, final ModuleBuilder module,
1110 final Map<String, TreeMap<Date, ModuleBuilder>> modules, final SchemaContext context, final int line) {
1111 ModuleBuilder targetModule;
1113 if (prefix == null || prefix.equals("")) {
1114 targetModule = module;
1116 targetModule = findModuleFromBuilders(modules, module, prefix, line);
1119 if (targetModule == null && context != null) {
1120 Module m = findModuleFromContext(context, module, prefix, line);
1122 targetModule = new ModuleBuilder(m);
1123 TreeMap<Date, ModuleBuilder> map = new TreeMap<>();
1124 map.put(targetModule.getRevision(), targetModule);
1125 modules.put(targetModule.getModuleName(), map);
1129 return targetModule;
1133 * Go through identity statements defined in current module and resolve
1134 * their 'base' statement if present.
1139 * module being resolved
1141 private void resolveIdentities(final Map<String, TreeMap<Date, ModuleBuilder>> modules) {
1142 for (Map.Entry<String, TreeMap<Date, ModuleBuilder>> entry : modules.entrySet()) {
1143 for (Map.Entry<Date, ModuleBuilder> inner : entry.getValue().entrySet()) {
1144 ModuleBuilder module = inner.getValue();
1145 final Set<IdentitySchemaNodeBuilder> identities = module.getAddedIdentities();
1146 for (IdentitySchemaNodeBuilder identity : identities) {
1147 final String baseIdentityName = identity.getBaseIdentityName();
1148 final int line = identity.getLine();
1149 if (baseIdentityName != null) {
1150 IdentitySchemaNodeBuilder baseIdentity = findBaseIdentity(modules, module, baseIdentityName,
1152 if (baseIdentity == null) {
1153 throw new YangParseException(module.getName(), identity.getLine(),
1154 "Failed to find base identity");
1156 identity.setBaseIdentity(baseIdentity);
1166 * Go through identity statements defined in current module and resolve
1167 * their 'base' statement. Method tries to find base identity in given
1168 * modules. If base identity is not found, method will search it in context.
1171 * all loaded modules
1175 * SchemaContext containing already resolved modules
1177 private void resolveIdentitiesWithContext(final Map<String, TreeMap<Date, ModuleBuilder>> modules,
1178 final SchemaContext context) {
1179 for (Map.Entry<String, TreeMap<Date, ModuleBuilder>> entry : modules.entrySet()) {
1180 for (Map.Entry<Date, ModuleBuilder> inner : entry.getValue().entrySet()) {
1181 ModuleBuilder module = inner.getValue();
1182 final Set<IdentitySchemaNodeBuilder> identities = module.getAddedIdentities();
1183 for (IdentitySchemaNodeBuilder identity : identities) {
1184 final String baseIdentityName = identity.getBaseIdentityName();
1185 final int line = identity.getLine();
1186 if (baseIdentityName != null) {
1188 IdentitySchemaNodeBuilder result = null;
1189 if (baseIdentityName.indexOf(':') != -1) {
1190 final Iterator<String> split = COLON_SPLITTER.split(baseIdentityName).iterator();
1191 final String prefix = split.next();
1192 final String name = split.next();
1193 if (split.hasNext()) {
1194 throw new YangParseException(module.getName(), line,
1195 "Failed to parse identityref base: " + baseIdentityName);
1198 ModuleBuilder dependentModule = findTargetModule(prefix, module, modules, context, line);
1199 if (dependentModule != null) {
1200 result = BuilderUtils.findIdentity(dependentModule.getAddedIdentities(), name);
1203 result = BuilderUtils.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 = BuilderUtils.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 = BuilderUtils.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 = BuilderUtils.getParentModule(parent);
1348 SchemaPath parentPath;
1350 final QName parentQName;
1351 if (parent instanceof AugmentationSchemaBuilder || parent instanceof ModuleBuilder) {
1352 parentQName = QName.create(module.getQNameModule(), module.getPrefix(), "dummy");
1353 if (parent instanceof AugmentationSchemaBuilder) {
1354 parentPath = ((AugmentationSchemaBuilder) parent).getTargetNodeSchemaPath();
1356 parentPath = parent.getPath();
1359 parentQName = parent.getQName();
1360 parentPath = parent.getPath();
1363 GroupingDefinition gd = usesNode.getGroupingDefinition();
1365 Set<DataSchemaNodeBuilder> childNodes = wrapChildNodes(module.getModuleName(), line, gd.getChildNodes(),
1366 parentPath, parentQName);
1367 parent.getChildNodeBuilders().addAll(childNodes);
1368 for (DataSchemaNodeBuilder childNode : childNodes) {
1369 setNodeAddedByUses(childNode);
1372 Set<TypeDefinitionBuilder> typedefs = wrapTypedefs(module.getModuleName(), line, gd, parentPath, parentQName);
1373 parent.getTypeDefinitionBuilders().addAll(typedefs);
1374 for (TypeDefinitionBuilder typedef : typedefs) {
1375 setNodeAddedByUses(typedef);
1378 Set<GroupingBuilder> groupings = wrapGroupings(module.getModuleName(), line, usesNode.getGroupingDefinition()
1379 .getGroupings(), parentPath, parentQName);
1380 parent.getGroupingBuilders().addAll(groupings);
1381 for (GroupingBuilder gb : groupings) {
1382 setNodeAddedByUses(gb);
1385 List<UnknownSchemaNodeBuilderImpl> unknownNodes = wrapUnknownNodes(module.getModuleName(), line,
1386 gd.getUnknownSchemaNodes(), parentPath, parentQName);
1387 parent.getUnknownNodes().addAll(unknownNodes);
1388 for (UnknownSchemaNodeBuilder un : unknownNodes) {
1389 un.setAddedByUses(true);
1394 * Try to find extension builder describing this unknown node and assign it
1395 * to unknown node builder.
1398 * all loaded modules
1402 private void resolveUnknownNodes(final Map<String, TreeMap<Date, ModuleBuilder>> modules, final ModuleBuilder module) {
1403 for (UnknownSchemaNodeBuilder usnb : module.getAllUnknownNodes()) {
1404 QName nodeType = usnb.getNodeType();
1406 ModuleBuilder dependentModule = findModuleFromBuilders(modules, module, nodeType.getPrefix(),
1408 for (ExtensionBuilder extension : dependentModule.getAddedExtensions()) {
1409 if (extension.getQName().getLocalName().equals(nodeType.getLocalName())) {
1410 usnb.setNodeType(extension.getQName());
1411 usnb.setExtensionBuilder(extension);
1415 } catch (YangParseException e) {
1416 throw new YangParseException(module.getName(), usnb.getLine(), "Failed to resolve node " + usnb
1417 + ": no such extension definition found.", e);
1423 * Try to find extension builder describing this unknown node and assign it
1424 * to unknown node builder. If extension is not found in loaded modules, try
1425 * to find it in context.
1428 * all loaded modules
1432 * SchemaContext containing already resolved modules
1434 private void resolveUnknownNodesWithContext(final Map<String, TreeMap<Date, ModuleBuilder>> modules,
1435 final ModuleBuilder module, final SchemaContext context) {
1436 for (UnknownSchemaNodeBuilder usnb : module.getAllUnknownNodes()) {
1437 QName nodeType = usnb.getNodeType();
1439 ModuleBuilder dependentModuleBuilder = findModuleFromBuilders(modules, module, nodeType.getPrefix(),
1442 if (dependentModuleBuilder == null) {
1443 Module dependentModule = findModuleFromContext(context, module, nodeType.getPrefix(),
1445 for (ExtensionDefinition e : dependentModule.getExtensionSchemaNodes()) {
1446 if (e.getQName().getLocalName().equals(nodeType.getLocalName())) {
1447 usnb.setNodeType(new QName(e.getQName().getNamespace(), e.getQName().getRevision(),
1448 nodeType.getPrefix(), e.getQName().getLocalName()));
1449 usnb.setExtensionDefinition(e);
1454 for (ExtensionBuilder extension : dependentModuleBuilder.getAddedExtensions()) {
1455 if (extension.getQName().getLocalName().equals(nodeType.getLocalName())) {
1456 usnb.setExtensionBuilder(extension);
1462 } catch (YangParseException e) {
1463 throw new YangParseException(module.getName(), usnb.getLine(), "Failed to resolve node " + usnb
1464 + ": no such extension definition found.", e);
1471 * Traverse through modules and resolve their deviation statements.
1474 * all loaded modules
1476 private void resolveDeviations(final Map<String, TreeMap<Date, ModuleBuilder>> modules) {
1477 for (Map.Entry<String, TreeMap<Date, ModuleBuilder>> entry : modules.entrySet()) {
1478 for (Map.Entry<Date, ModuleBuilder> inner : entry.getValue().entrySet()) {
1479 ModuleBuilder b = inner.getValue();
1480 resolveDeviation(modules, b);
1486 * Traverse through module and resolve its deviation statements.
1489 * all loaded modules
1491 * module in which resolve deviations
1493 private void resolveDeviation(final Map<String, TreeMap<Date, ModuleBuilder>> modules, final ModuleBuilder module) {
1494 for (DeviationBuilder dev : module.getDeviationBuilders()) {
1495 int line = dev.getLine();
1496 SchemaPath targetPath = dev.getTargetPath();
1497 Iterable<QName> path = targetPath.getPathFromRoot();
1498 QName q0 = path.iterator().next();
1499 String prefix = q0.getPrefix();
1500 if (prefix == null) {
1501 prefix = module.getPrefix();
1504 ModuleBuilder dependentModuleBuilder = findModuleFromBuilders(modules, module, prefix, line);
1505 processDeviation(dev, dependentModuleBuilder, path, module);
1510 * Traverse through modules and resolve their deviation statements with
1514 * all loaded modules
1516 * already resolved context
1518 private void resolveDeviationsWithContext(final Map<String, TreeMap<Date, ModuleBuilder>> modules,
1519 final SchemaContext context) {
1520 for (Map.Entry<String, TreeMap<Date, ModuleBuilder>> entry : modules.entrySet()) {
1521 for (Map.Entry<Date, ModuleBuilder> inner : entry.getValue().entrySet()) {
1522 ModuleBuilder b = inner.getValue();
1523 resolveDeviationWithContext(modules, b, context);
1529 * Traverse through module and resolve its deviation statements with given
1533 * all loaded modules
1535 * module in which resolve deviations
1537 * already resolved context
1539 private void resolveDeviationWithContext(final Map<String, TreeMap<Date, ModuleBuilder>> modules,
1540 final ModuleBuilder module, final SchemaContext context) {
1541 for (DeviationBuilder dev : module.getDeviationBuilders()) {
1542 int line = dev.getLine();
1543 SchemaPath targetPath = dev.getTargetPath();
1544 Iterable<QName> path = targetPath.getPathFromRoot();
1545 QName q0 = path.iterator().next();
1546 String prefix = q0.getPrefix();
1547 if (prefix == null) {
1548 prefix = module.getPrefix();
1551 ModuleBuilder dependentModuleBuilder = findModuleFromBuilders(modules, module, prefix, line);
1552 if (dependentModuleBuilder == null) {
1553 Object currentParent = findModuleFromContext(context, module, prefix, line);
1555 for (QName q : path) {
1556 if (currentParent == null) {
1557 throw new YangParseException(module.getName(), line, FAIL_DEVIATION_TARGET);
1559 String name = q.getLocalName();
1560 if (currentParent instanceof DataNodeContainer) {
1561 currentParent = ((DataNodeContainer) currentParent).getDataChildByName(name);
1565 if (currentParent == null) {
1566 throw new YangParseException(module.getName(), line, FAIL_DEVIATION_TARGET);
1568 if (currentParent instanceof SchemaNode) {
1569 dev.setTargetPath(((SchemaNode) currentParent).getPath());
1573 processDeviation(dev, dependentModuleBuilder, path, module);
1579 * Correct deviation target path in deviation builder.
1583 * @param dependentModuleBuilder
1584 * module containing deviation target
1586 * current deviation target path
1590 private void processDeviation(final DeviationBuilder dev, final ModuleBuilder dependentModuleBuilder,
1591 final Iterable<QName> path, final ModuleBuilder module) {
1592 final int line = dev.getLine();
1593 Builder currentParent = dependentModuleBuilder;
1595 for (QName q : path) {
1596 if (currentParent == null) {
1597 throw new YangParseException(module.getName(), line, FAIL_DEVIATION_TARGET);
1599 String name = q.getLocalName();
1600 if (currentParent instanceof DataNodeContainerBuilder) {
1601 currentParent = ((DataNodeContainerBuilder) currentParent).getDataChildByName(name);
1605 if (!(currentParent instanceof SchemaNodeBuilder)) {
1606 throw new YangParseException(module.getName(), line, FAIL_DEVIATION_TARGET);
1608 dev.setTargetPath(((SchemaNodeBuilder) currentParent).getPath());