yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/impl/YangParserImpl.java

   1 /*
   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
   6  */
   7 package org.opendaylight.yangtools.yang.parser.impl;
   8
   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.findModuleFromContext;
  13 import static org.opendaylight.yangtools.yang.parser.builder.impl.BuilderUtils.findSchemaNode;
  14 import static org.opendaylight.yangtools.yang.parser.builder.impl.BuilderUtils.findSchemaNodeInModule;
  15 import static org.opendaylight.yangtools.yang.parser.builder.impl.BuilderUtils.processAugmentation;
  16 import static org.opendaylight.yangtools.yang.parser.builder.impl.TypeUtils.resolveType;
  17 import static org.opendaylight.yangtools.yang.parser.builder.impl.TypeUtils.resolveTypeUnion;
  18
  19 import com.google.common.base.Optional;
  20 import com.google.common.base.Preconditions;
  21 import com.google.common.base.Splitter;
  22 import com.google.common.collect.HashBiMap;
  23 import com.google.common.io.ByteSource;
  24 import java.io.File;
  25 import java.io.IOException;
  26 import java.io.InputStream;
  27 import java.net.URI;
  28 import java.util.ArrayList;
  29 import java.util.Collection;
  30 import java.util.Collections;
  31 import java.util.Date;
  32 import java.util.HashMap;
  33 import java.util.HashSet;
  34 import java.util.LinkedHashMap;
  35 import java.util.LinkedHashSet;
  36 import java.util.List;
  37 import java.util.Map;
  38 import java.util.Set;
  39 import java.util.TreeMap;
  40 import javax.annotation.concurrent.Immutable;
  41 import org.antlr.v4.runtime.ANTLRInputStream;
  42 import org.antlr.v4.runtime.CommonTokenStream;
  43 import org.antlr.v4.runtime.tree.ParseTree;
  44 import org.antlr.v4.runtime.tree.ParseTreeWalker;
  45 import org.opendaylight.yangtools.antlrv4.code.gen.YangLexer;
  46 import org.opendaylight.yangtools.antlrv4.code.gen.YangParser;
  47 import org.opendaylight.yangtools.antlrv4.code.gen.YangParser.YangContext;
  48 import org.opendaylight.yangtools.yang.common.QName;
  49 import org.opendaylight.yangtools.yang.common.QNameModule;
  50 import org.opendaylight.yangtools.yang.model.api.ExtensionDefinition;
  51 import org.opendaylight.yangtools.yang.model.api.Module;
  52 import org.opendaylight.yangtools.yang.model.api.ModuleIdentifier;
  53 import org.opendaylight.yangtools.yang.model.api.ModuleImport;
  54 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  55 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  56 import org.opendaylight.yangtools.yang.model.parser.api.YangContextParser;
  57 import org.opendaylight.yangtools.yang.model.parser.api.YangSyntaxErrorException;
  58 import org.opendaylight.yangtools.yang.parser.builder.api.AugmentationSchemaBuilder;
  59 import org.opendaylight.yangtools.yang.parser.builder.api.AugmentationTargetBuilder;
  60 import org.opendaylight.yangtools.yang.parser.builder.api.Builder;
  61 import org.opendaylight.yangtools.yang.parser.builder.api.DataNodeContainerBuilder;
  62 import org.opendaylight.yangtools.yang.parser.builder.api.DataSchemaNodeBuilder;
  63 import org.opendaylight.yangtools.yang.parser.builder.api.ExtensionBuilder;
  64 import org.opendaylight.yangtools.yang.parser.builder.api.GroupingBuilder;
  65 import org.opendaylight.yangtools.yang.parser.builder.api.SchemaNodeBuilder;
  66 import org.opendaylight.yangtools.yang.parser.builder.api.TypeAwareBuilder;
  67 import org.opendaylight.yangtools.yang.parser.builder.api.UnknownSchemaNodeBuilder;
  68 import org.opendaylight.yangtools.yang.parser.builder.api.UsesNodeBuilder;
  69 import org.opendaylight.yangtools.yang.parser.builder.impl.BuilderUtils;
  70 import org.opendaylight.yangtools.yang.parser.builder.impl.ChoiceBuilder;
  71 import org.opendaylight.yangtools.yang.parser.builder.impl.ChoiceCaseBuilder;
  72 import org.opendaylight.yangtools.yang.parser.builder.impl.GroupingUtils;
  73 import org.opendaylight.yangtools.yang.parser.builder.impl.IdentitySchemaNodeBuilder;
  74 import org.opendaylight.yangtools.yang.parser.builder.impl.IdentityrefTypeBuilder;
  75 import org.opendaylight.yangtools.yang.parser.builder.impl.ModuleBuilder;
  76 import org.opendaylight.yangtools.yang.parser.builder.impl.ModuleImpl;
  77 import org.opendaylight.yangtools.yang.parser.builder.impl.UnionTypeBuilder;
  78 import org.opendaylight.yangtools.yang.parser.builder.util.Comparators;
  79 import org.opendaylight.yangtools.yang.parser.util.ModuleDependencySort;
  80 import org.opendaylight.yangtools.yang.parser.util.NamedByteArrayInputStream;
  81 import org.opendaylight.yangtools.yang.parser.util.NamedFileInputStream;
  82 import org.opendaylight.yangtools.yang.parser.util.NamedInputStream;
  83 import org.opendaylight.yangtools.yang.parser.util.YangParseException;
  84 import org.slf4j.Logger;
  85 import org.slf4j.LoggerFactory;
  86
  87 @Immutable
  88 public final class YangParserImpl implements YangContextParser {
  89     private static final Logger LOG = LoggerFactory.getLogger(YangParserImpl.class);
  90     private static final Splitter COLON_SPLITTER = Splitter.on(':');
  91     private static final YangParserImpl INSTANCE = new YangParserImpl();
  92
  93     public static YangParserImpl getInstance() {
  94         return INSTANCE;
  95     }
  96
  97     @Override
  98     @Deprecated
  99     public Set<Module> parseYangModels(final File yangFile, final File directory) {
 100         try {
 101             return parseFile(yangFile, directory).getModules();
 102         } catch (IOException | YangSyntaxErrorException e) {
 103             throw new YangParseException("Failed to parse yang data", e);
 104         }
 105     }
 106
 107     @Override
 108     public SchemaContext parseFile(final File yangFile, final File directory) throws IOException, YangSyntaxErrorException {
 109         Preconditions.checkState(yangFile.exists(), yangFile + " does not exists");
 110         Preconditions.checkState(directory.exists(), directory + " does not exists");
 111         Preconditions.checkState(directory.isDirectory(), directory + " is not a directory");
 112
 113         final String yangFileName = yangFile.getName();
 114         final String[] fileList = checkNotNull(directory.list(), directory + " not found or is not a directory");
 115
 116         Map<ByteSource, File> sourceToFile = new LinkedHashMap<>();
 117         ByteSource mainFileSource = BuilderUtils.fileToByteSource(yangFile);
 118         sourceToFile.put(mainFileSource, yangFile);
 119
 120         for (String fileName : fileList) {
 121             if (fileName.equals(yangFileName)) {
 122                 continue;
 123             }
 124             File dependency = new File(directory, fileName);
 125             if (dependency.isFile()) {
 126                 sourceToFile.put(BuilderUtils.fileToByteSource(dependency), dependency);
 127             }
 128         }
 129
 130         Map<ByteSource, ModuleBuilder> sourceToBuilder = parseSourcesToBuilders(sourceToFile.keySet(), null);
 131         ModuleBuilder main = sourceToBuilder.get(mainFileSource);
 132
 133         List<ModuleBuilder> moduleBuilders = new ArrayList<>();
 134         moduleBuilders.add(main);
 135         filterImports(main, new ArrayList<>(sourceToBuilder.values()), moduleBuilders);
 136         Collection<ModuleBuilder> resolved = resolveSubmodules(moduleBuilders);
 137
 138         // module builders sorted by dependencies
 139         List<ModuleBuilder> sortedBuilders = ModuleDependencySort.sort(resolved);
 140         LinkedHashMap<URI, TreeMap<Date, ModuleBuilder>> modules = resolveModulesWithImports(sortedBuilders, null);
 141         Collection<Module> unsorted = build(modules).values();
 142         Set<Module> result = new LinkedHashSet<>(
 143                 ModuleDependencySort.sort(unsorted.toArray(new Module[unsorted.size()])));
 144         return resolveSchemaContext(result);
 145     }
 146
 147     @Override
 148     @Deprecated
 149     public Set<Module> parseYangModels(final List<File> yangFiles) {
 150         return parseFiles(yangFiles).getModules();
 151     }
 152
 153     @Override
 154     public SchemaContext parseFiles(final Collection<File> yangFiles) {
 155         Collection<Module> unsorted = parseYangModelsMapped(yangFiles).values();
 156         Set<Module> sorted = new LinkedHashSet<>(
 157                 ModuleDependencySort.sort(unsorted.toArray(new Module[unsorted.size()])));
 158         return resolveSchemaContext(sorted);
 159     }
 160
 161     @Override
 162     @Deprecated
 163     public Set<Module> parseYangModels(final List<File> yangFiles, final SchemaContext context) {
 164         try {
 165             return parseFiles(yangFiles, context).getModules();
 166         } catch (IOException | YangSyntaxErrorException e) {
 167             throw new YangParseException("Failed to parse yang data", e);
 168         }
 169     }
 170
 171     @Override
 172     public SchemaContext parseFiles(final Collection<File> yangFiles, final SchemaContext context) throws IOException,
 173     YangSyntaxErrorException {
 174         if (yangFiles == null) {
 175             return resolveSchemaContext(Collections.<Module> emptySet());
 176         }
 177
 178         Collection<ByteSource> sources = BuilderUtils.filesToByteSources(yangFiles);
 179         return parseSources(sources, context);
 180     }
 181
 182     @Override
 183     @Deprecated
 184     public Set<Module> parseYangModelsFromStreams(final List<InputStream> yangModelStreams) {
 185         try {
 186             Collection<ByteSource> sources = BuilderUtils.streamsToByteSources(yangModelStreams);
 187             return parseSources(sources).getModules();
 188         } catch (IOException | YangSyntaxErrorException e) {
 189             throw new YangParseException("Failed to parse yang data", e);
 190         }
 191     }
 192
 193     @Override
 194     public SchemaContext parseSources(final Collection<ByteSource> sources) throws IOException,YangSyntaxErrorException {
 195         return assembleContext(parseYangModelSources(sources, null).values());
 196     }
 197
 198     @Override
 199     @Deprecated
 200     public Set<Module> parseYangModelsFromStreams(final List<InputStream> yangModelStreams, final SchemaContext context) {
 201         try {
 202             Collection<ByteSource> sources = BuilderUtils.streamsToByteSources(yangModelStreams);
 203             return parseSources(sources, context).getModules();
 204         } catch (IOException | YangSyntaxErrorException e) {
 205             throw new YangParseException("Failed to parse yang data", e);
 206         }
 207     }
 208
 209     @Override
 210     public SchemaContext parseSources(final Collection<ByteSource> sources, final SchemaContext context)
 211             throws IOException, YangSyntaxErrorException {
 212         if (sources == null) {
 213             return resolveSchemaContext(Collections.<Module> emptySet());
 214         }
 215
 216         final List<ModuleBuilder> sorted = resolveModuleBuilders(sources, context);
 217         final Map<URI, TreeMap<Date, ModuleBuilder>> modules = resolveModulesWithImports(sorted, context);
 218
 219         final Set<Module> unsorted = new LinkedHashSet<>(build(modules).values());
 220         if (context != null) {
 221             for (Module m : context.getModules()) {
 222                 if (!unsorted.contains(m)) {
 223                     unsorted.add(m);
 224                 }
 225             }
 226         }
 227         Set<Module> result = new LinkedHashSet<>(
 228                 ModuleDependencySort.sort(unsorted.toArray(new Module[unsorted.size()])));
 229         return resolveSchemaContext(result);
 230     }
 231
 232     private static LinkedHashMap<URI, TreeMap<Date, ModuleBuilder>> resolveModulesWithImports(final List<ModuleBuilder> sorted,
 233             final SchemaContext context) {
 234         final LinkedHashMap<URI, TreeMap<Date, ModuleBuilder>> modules = orderModules(sorted);
 235         for (ModuleBuilder module : sorted) {
 236             if (module != null) {
 237                 for (ModuleImport imp : module.getImports().values()) {
 238                     String prefix = imp.getPrefix();
 239                     ModuleBuilder targetModule = BuilderUtils.findModuleFromBuilders(imp, sorted);
 240                     if (targetModule == null) {
 241                         Module result = findModuleFromContext(context, module, prefix, 0);
 242                         targetModule = new ModuleBuilder(result);
 243                         TreeMap<Date, ModuleBuilder> map = modules.get(prefix);
 244                         if (map == null) {
 245                             map = new TreeMap<>();
 246                             map.put(targetModule.getRevision(), targetModule);
 247                             modules.put(targetModule.getNamespace(), map);
 248                         } else {
 249                             map.put(targetModule.getRevision(), targetModule);
 250                         }
 251                     }
 252                     module.addImportedModule(prefix, targetModule);
 253                 }
 254             }
 255         }
 256         return modules;
 257     }
 258
 259     @Override
 260     public Map<File, Module> parseYangModelsMapped(final Collection<File> yangFiles) {
 261         if (yangFiles == null || yangFiles.isEmpty()) {
 262             return Collections.emptyMap();
 263         }
 264
 265         Map<ByteSource, File> byteSourceToFile = new HashMap<>();
 266         for (final File file : yangFiles) {
 267             ByteSource source = new ByteSource() {
 268                 @Override
 269                 public InputStream openStream() throws IOException {
 270                     return new NamedFileInputStream(file, file.getPath());
 271                 }
 272             };
 273             byteSourceToFile.put(source, file);
 274         }
 275
 276         Map<ByteSource, Module> byteSourceToModule;
 277         try {
 278             byteSourceToModule = parseYangModelSources(byteSourceToFile.keySet(), null);
 279         } catch (IOException | YangSyntaxErrorException e) {
 280             throw new YangParseException("Failed to parse yang data", e);
 281         }
 282         Map<File, Module> result = new LinkedHashMap<>();
 283         for (Map.Entry<ByteSource, Module> entry : byteSourceToModule.entrySet()) {
 284             result.put(byteSourceToFile.get(entry.getKey()), entry.getValue());
 285         }
 286         return result;
 287     }
 288
 289     @Override
 290     public Map<InputStream, Module> parseYangModelsFromStreamsMapped(final Collection<InputStream> yangModelStreams) {
 291         if (yangModelStreams == null || yangModelStreams.isEmpty()) {
 292             return Collections.emptyMap();
 293         }
 294
 295         Map<ByteSource, InputStream> sourceToStream = new HashMap<>();
 296         for (final InputStream stream : yangModelStreams) {
 297             ByteSource source = new ByteSource() {
 298                 @Override
 299                 public InputStream openStream() throws IOException {
 300                     return NamedByteArrayInputStream.create(stream);
 301                 }
 302             };
 303             sourceToStream.put(source, stream);
 304         }
 305
 306         Map<ByteSource, Module> sourceToModule;
 307         try {
 308             sourceToModule = parseYangModelSources(sourceToStream.keySet(), null);
 309         } catch (IOException | YangSyntaxErrorException e) {
 310             throw new YangParseException("Failed to parse yang data", e);
 311         }
 312         Map<InputStream, Module> result = new LinkedHashMap<>();
 313         for (Map.Entry<ByteSource, Module> entry : sourceToModule.entrySet()) {
 314             result.put(sourceToStream.get(entry.getKey()), entry.getValue());
 315         }
 316         return result;
 317     }
 318
 319     @Override
 320     public SchemaContext resolveSchemaContext(final Set<Module> modules) {
 321         // after merging parse method with this one, add support for getting
 322         // submodule sources.
 323         Map<ModuleIdentifier, String> identifiersToSources = new HashMap<>();
 324         for (Module module : modules) {
 325             ModuleImpl moduleImpl = (ModuleImpl) module;
 326             identifiersToSources.put(module, moduleImpl.getSource());
 327         }
 328         return new SchemaContextImpl(modules, identifiersToSources);
 329     }
 330
 331     public Collection<Module> buildModules(final Collection<ModuleBuilder> builders) {
 332         List<ModuleBuilder> sorted = ModuleDependencySort.sort(builders);
 333         Map<URI, TreeMap<Date, ModuleBuilder>> modules = resolveModulesWithImports(sorted, null);
 334         Map<ModuleBuilder, Module> builderToModule = build(modules);
 335
 336         return builderToModule.values();
 337     }
 338
 339     public SchemaContext assembleContext(final Collection<Module> modules) {
 340         final Set<Module> sorted = new LinkedHashSet<>(
 341                 ModuleDependencySort.sort(modules.toArray(new Module[modules.size()])));
 342         return resolveSchemaContext(sorted);
 343     }
 344
 345     private Map<ByteSource, Module> parseYangModelSources(final Collection<ByteSource> sources, final SchemaContext context) throws IOException, YangSyntaxErrorException {
 346         if (sources == null || sources.isEmpty()) {
 347             return Collections.emptyMap();
 348         }
 349
 350         Map<ByteSource, ModuleBuilder> sourceToBuilder = resolveSources(sources, context);
 351         // sort and check for duplicates
 352         List<ModuleBuilder> sorted = ModuleDependencySort.sort(sourceToBuilder.values());
 353         Map<URI, TreeMap<Date, ModuleBuilder>> modules = resolveModulesWithImports(sorted, null);
 354         Map<ModuleBuilder, Module> builderToModule = build(modules);
 355         Map<ModuleBuilder, ByteSource> builderToSource = HashBiMap.create(sourceToBuilder).inverse();
 356         sorted = ModuleDependencySort.sort(builderToModule.keySet());
 357
 358         Map<ByteSource, Module> result = new LinkedHashMap<>();
 359         for (ModuleBuilder moduleBuilder : sorted) {
 360             Module value = checkNotNull(builderToModule.get(moduleBuilder), "Cannot get module for %s", moduleBuilder);
 361             result.put(builderToSource.get(moduleBuilder), value);
 362         }
 363
 364         return result;
 365     }
 366
 367     /**
 368      * Parse streams and resolve submodules.
 369      *
 370      * @param streams
 371      *            collection of streams to parse
 372      * @return map, where key is source stream and value is module builder
 373      *         parsed from stream
 374      * @throws YangSyntaxErrorException
 375      */
 376     // TODO: remove ByteSource result after removing YangModelParser
 377     private Map<ByteSource, ModuleBuilder> resolveSources(final Collection<ByteSource> streams, final SchemaContext context) throws IOException, YangSyntaxErrorException {
 378         Map<ByteSource, ModuleBuilder> builders = parseSourcesToBuilders(streams, context);
 379         return resolveSubmodules(builders);
 380     }
 381
 382     private Map<ByteSource, ModuleBuilder> parseSourcesToBuilders(final Collection<ByteSource> sources,
 383             final SchemaContext context) throws IOException, YangSyntaxErrorException {
 384         final ParseTreeWalker walker = new ParseTreeWalker();
 385         final Map<ByteSource, ParseTree> sourceToTree = parseYangSources(sources);
 386         final Map<ByteSource, ModuleBuilder> sourceToBuilder = new LinkedHashMap<>();
 387
 388         // validate yang
 389         new YangModelBasicValidator(walker).validate(sourceToTree.values());
 390
 391         Map<String, TreeMap<Date, URI>> namespaceContext = BuilderUtils.createYangNamespaceContext(
 392                 sourceToTree.values(), Optional.fromNullable(context));
 393         YangParserListenerImpl yangModelParser;
 394         for (Map.Entry<ByteSource, ParseTree> entry : sourceToTree.entrySet()) {
 395             ByteSource source = entry.getKey();
 396             String path = null; // TODO refactor to Optional
 397             // TODO refactor so that path can be retrieved without opening
 398             // stream: NamedInputStream -> NamedByteSource ?
 399             try (InputStream stream = source.openStream()) {
 400                 if (stream instanceof NamedInputStream) {
 401                     path = stream.toString();
 402                 }
 403             }
 404             yangModelParser = new YangParserListenerImpl(namespaceContext, path);
 405             walker.walk(yangModelParser, entry.getValue());
 406             ModuleBuilder moduleBuilder = yangModelParser.getModuleBuilder();
 407             moduleBuilder.setSource(source);
 408             sourceToBuilder.put(source, moduleBuilder);
 409         }
 410         return sourceToBuilder;
 411     }
 412
 413     private Map<ByteSource, ModuleBuilder> resolveSubmodules(final Map<ByteSource, ModuleBuilder> builders) {
 414         Map<ByteSource, ModuleBuilder> modules = new HashMap<>();
 415         Set<ModuleBuilder> submodules = new HashSet<>();
 416         for (Map.Entry<ByteSource, ModuleBuilder> entry : builders.entrySet()) {
 417             ModuleBuilder moduleBuilder = entry.getValue();
 418             if (moduleBuilder.isSubmodule()) {
 419                 submodules.add(moduleBuilder);
 420             } else {
 421                 modules.put(entry.getKey(), moduleBuilder);
 422             }
 423         }
 424
 425         Collection<ModuleBuilder> values = modules.values();
 426         for (ModuleBuilder submodule : submodules) {
 427             for (ModuleBuilder module : values) {
 428                 if (module.getName().equals(submodule.getBelongsTo())) {
 429                     addSubmoduleToModule(submodule, module);
 430                 }
 431             }
 432         }
 433         return modules;
 434     }
 435
 436     /**
 437      * Traverse collection of builders, find builders representing submodule and
 438      * add this submodule to its parent module.
 439      *
 440      * @param builders
 441      *            collection of builders containing modules and submodules
 442      * @return collection of module builders
 443      */
 444     private Collection<ModuleBuilder> resolveSubmodules(final Collection<ModuleBuilder> builders) {
 445         Collection<ModuleBuilder> modules = new HashSet<>();
 446         Set<ModuleBuilder> submodules = new HashSet<>();
 447         for (ModuleBuilder moduleBuilder : builders) {
 448             if (moduleBuilder.isSubmodule()) {
 449                 submodules.add(moduleBuilder);
 450             } else {
 451                 modules.add(moduleBuilder);
 452             }
 453         }
 454
 455         for (ModuleBuilder submodule : submodules) {
 456             for (ModuleBuilder module : modules) {
 457                 if (module.getName().equals(submodule.getBelongsTo())) {
 458                     addSubmoduleToModule(submodule, module);
 459                 }
 460             }
 461         }
 462         return modules;
 463     }
 464
 465     private void addSubmoduleToModule(final ModuleBuilder submodule, final ModuleBuilder module) {
 466         submodule.setParent(module);
 467         module.getDirtyNodes().addAll(submodule.getDirtyNodes());
 468         module.getImports().putAll(submodule.getImports());
 469         module.getAugments().addAll(submodule.getAugments());
 470         module.getAugmentBuilders().addAll(submodule.getAugmentBuilders());
 471         module.getAllAugments().addAll(submodule.getAllAugments());
 472         module.getChildNodeBuilders().addAll(submodule.getChildNodeBuilders());
 473         module.getChildNodes().putAll(submodule.getChildNodes());
 474         module.getGroupings().addAll(submodule.getGroupings());
 475         module.getGroupingBuilders().addAll(submodule.getGroupingBuilders());
 476         module.getTypeDefinitions().addAll(submodule.getTypeDefinitions());
 477         module.getTypeDefinitionBuilders().addAll(submodule.getTypeDefinitionBuilders());
 478         module.getUsesNodes().addAll(submodule.getUsesNodes());
 479         module.getUsesNodeBuilders().addAll(submodule.getUsesNodeBuilders());
 480         module.getAllGroupings().addAll(submodule.getAllGroupings());
 481         module.getAllUsesNodes().addAll(submodule.getAllUsesNodes());
 482         module.getRpcs().addAll(submodule.getRpcs());
 483         module.getAddedRpcs().addAll(submodule.getAddedRpcs());
 484         module.getNotifications().addAll(submodule.getNotifications());
 485         module.getAddedNotifications().addAll(submodule.getAddedNotifications());
 486         module.getIdentities().addAll(submodule.getIdentities());
 487         module.getAddedIdentities().addAll(submodule.getAddedIdentities());
 488         module.getFeatures().addAll(submodule.getFeatures());
 489         module.getAddedFeatures().addAll(submodule.getAddedFeatures());
 490         module.getDeviations().addAll(submodule.getDeviations());
 491         module.getDeviationBuilders().addAll(submodule.getDeviationBuilders());
 492         module.getExtensions().addAll(submodule.getExtensions());
 493         module.getAddedExtensions().addAll(submodule.getAddedExtensions());
 494         module.getUnknownNodes().addAll(submodule.getUnknownNodes());
 495         module.getAllUnknownNodes().addAll(submodule.getAllUnknownNodes());
 496     }
 497
 498     private List<ModuleBuilder> resolveModuleBuilders(final Collection<ByteSource> yangFileStreams,
 499             final SchemaContext context) throws IOException, YangSyntaxErrorException {
 500         Map<ByteSource, ModuleBuilder> parsedBuilders = resolveSources(yangFileStreams, context);
 501         ModuleBuilder[] builders = new ModuleBuilder[parsedBuilders.size()];
 502         parsedBuilders.values().toArray(builders);
 503
 504         // module dependency graph sorted
 505         List<ModuleBuilder> sorted;
 506         if (context == null) {
 507             sorted = ModuleDependencySort.sort(builders);
 508         } else {
 509             sorted = ModuleDependencySort.sortWithContext(context, builders);
 510         }
 511         return sorted;
 512     }
 513
 514     /**
 515      * Order modules by namespace and revision.
 516      *
 517      * @param modules
 518      *            topologically sorted modules
 519      * @return modules ordered by namespace and revision
 520      */
 521     private static LinkedHashMap<URI, TreeMap<Date, ModuleBuilder>> orderModules(final List<ModuleBuilder> modules) {
 522         final LinkedHashMap<URI, TreeMap<Date, ModuleBuilder>> result = new LinkedHashMap<>();
 523         for (final ModuleBuilder builder : modules) {
 524             if (builder == null) {
 525                 continue;
 526             }
 527
 528             URI ns = builder.getNamespace();
 529             Date rev = builder.getRevision();
 530             if (rev == null) {
 531                 rev = new Date(0);
 532             }
 533
 534             TreeMap<Date, ModuleBuilder> builderByRevision = result.get(ns);
 535             if (builderByRevision == null) {
 536                 builderByRevision = new TreeMap<>();
 537                 builderByRevision.put(rev, builder);
 538                 result.put(ns, builderByRevision);
 539             } else {
 540                 builderByRevision.put(rev, builder);
 541             }
 542
 543         }
 544         return result;
 545     }
 546
 547     /**
 548      * Find {@code main} dependencies from {@code other} and add them to
 549      * {@code filtered}.
 550      *
 551      * @param main
 552      *            main yang module
 553      * @param other
 554      *            all loaded modules
 555      * @param filtered
 556      *            collection to fill up
 557      */
 558     private void filterImports(final ModuleBuilder main, final Collection<ModuleBuilder> other,
 559             final Collection<ModuleBuilder> filtered) {
 560         Map<String, ModuleImport> imports = main.getImports();
 561
 562         // if this is submodule, add parent to filtered and pick its imports
 563         if (main.isSubmodule()) {
 564             TreeMap<Date, ModuleBuilder> dependencies = new TreeMap<>();
 565             for (ModuleBuilder mb : other) {
 566                 if (mb.getName().equals(main.getBelongsTo())) {
 567                     dependencies.put(mb.getRevision(), mb);
 568                 }
 569             }
 570             ModuleBuilder parent = dependencies.get(dependencies.firstKey());
 571             filtered.add(parent);
 572             imports.putAll(parent.getImports());
 573         }
 574
 575         for (ModuleImport mi : imports.values()) {
 576             for (ModuleBuilder builder : other) {
 577                 if (mi.getModuleName().equals(builder.getModuleName())) {
 578                     if (mi.getRevision() == null) {
 579                         if (!filtered.contains(builder)) {
 580                             filtered.add(builder);
 581                             filterImports(builder, other, filtered);
 582                         }
 583                     } else {
 584                         if (mi.getRevision().equals(builder.getRevision())) {
 585                             if (!filtered.contains(builder)) {
 586                                 filtered.add(builder);
 587                                 filterImports(builder, other, filtered);
 588                             }
 589                         }
 590                     }
 591                 }
 592             }
 593         }
 594     }
 595
 596     private Map<ByteSource, ParseTree> parseYangSources(final Collection<ByteSource> sources) throws IOException, YangSyntaxErrorException {
 597         final Map<ByteSource, ParseTree> trees = new HashMap<>();
 598         for (ByteSource source : sources) {
 599             try (InputStream stream = source.openStream()) {
 600                 trees.put(source, parseYangSource(stream));
 601             }
 602         }
 603         return trees;
 604     }
 605
 606     public static YangContext parseYangSource(final InputStream stream) throws IOException, YangSyntaxErrorException {
 607         final YangLexer lexer = new YangLexer(new ANTLRInputStream(stream));
 608         final CommonTokenStream tokens = new CommonTokenStream(lexer);
 609         final YangParser parser = new YangParser(tokens);
 610         parser.removeErrorListeners();
 611
 612         final YangErrorListener errorListener = new YangErrorListener();
 613         parser.addErrorListener(errorListener);
 614
 615         final YangContext result = parser.yang();
 616         errorListener.validate();
 617
 618         return result;
 619     }
 620
 621     /**
 622      * Mini parser: This parsing context does not validate full YANG module,
 623      * only parses header up to the revisions and imports.
 624      *
 625      * @see org.opendaylight.yangtools.yang.parser.impl.util.YangModelDependencyInfo
 626      */
 627     public static YangContext parseStreamWithoutErrorListeners(final InputStream yangStream) {
 628         YangContext result = null;
 629         try {
 630             final ANTLRInputStream input = new ANTLRInputStream(yangStream);
 631             final YangLexer lexer = new YangLexer(input);
 632             final CommonTokenStream tokens = new CommonTokenStream(lexer);
 633             final YangParser parser = new YangParser(tokens);
 634             parser.removeErrorListeners();
 635             result = parser.yang();
 636         } catch (IOException e) {
 637             LOG.warn("Exception while reading yang file: " + yangStream, e);
 638         }
 639         return result;
 640     }
 641
 642     /**
 643      * Creates builder-to-module map based on given modules. Method first
 644      * resolve unresolved type references, instantiate groupings through uses
 645      * statements and perform augmentation.
 646      *
 647      * Node resolving must be performed in following order:
 648      * <ol>
 649      * <li>
 650      * unresolved type references</li>
 651      * <li>
 652      * uses in groupings</li>
 653      * <li>
 654      * uses in other nodes</li>
 655      * <li>
 656      * augments</li>
 657      * </ol>
 658      *
 659      * @param modules
 660      *            all loaded modules
 661      * @return modules mapped on their builders
 662      */
 663     private Map<ModuleBuilder, Module> build(final Map<URI, TreeMap<Date, ModuleBuilder>> modules) {
 664         resolveDirtyNodes(modules);
 665         resolveAugmentsTargetPath(modules);
 666         resolveUsesTargetGrouping(modules);
 667         resolveUsesForGroupings(modules);
 668         resolveUsesForNodes(modules);
 669         resolveAugments(modules);
 670         resolveIdentities(modules);
 671
 672         // build
 673         final Map<ModuleBuilder, Module> result = new LinkedHashMap<>();
 674         for (Map.Entry<URI, TreeMap<Date, ModuleBuilder>> entry : modules.entrySet()) {
 675             for (Map.Entry<Date, ModuleBuilder> childEntry : entry.getValue().entrySet()) {
 676                 final ModuleBuilder moduleBuilder = childEntry.getValue();
 677                 final Module module = moduleBuilder.build();
 678                 result.put(moduleBuilder, module);
 679             }
 680         }
 681         return result;
 682     }
 683
 684     /**
 685      * Resolve all unresolved type references.
 686      *
 687      * @param modules
 688      *            all loaded modules
 689      */
 690     private void resolveDirtyNodes(final Map<URI, TreeMap<Date, ModuleBuilder>> modules) {
 691         for (Map.Entry<URI, TreeMap<Date, ModuleBuilder>> entry : modules.entrySet()) {
 692             for (Map.Entry<Date, ModuleBuilder> childEntry : entry.getValue().entrySet()) {
 693                 final ModuleBuilder module = childEntry.getValue();
 694                 resolveUnknownNodes(modules, module);
 695                 resolveDirtyNodes(modules, module);
 696             }
 697         }
 698     }
 699
 700     /**
 701      * Search for dirty nodes (node which contains UnknownType) and resolve
 702      * unknown types.
 703      *
 704      * @param modules
 705      *            all available modules
 706      * @param module
 707      *            current module
 708      */
 709     private void resolveDirtyNodes(final Map<URI, TreeMap<Date, ModuleBuilder>> modules, final ModuleBuilder module) {
 710         final Set<TypeAwareBuilder> dirtyNodes = module.getDirtyNodes();
 711         if (!dirtyNodes.isEmpty()) {
 712             for (TypeAwareBuilder nodeToResolve : dirtyNodes) {
 713                 if (nodeToResolve instanceof UnionTypeBuilder) {
 714                     // special handling for union types
 715                     resolveTypeUnion((UnionTypeBuilder) nodeToResolve, modules, module);
 716                 } else if (nodeToResolve.getTypedef() instanceof IdentityrefTypeBuilder) {
 717                     // special handling for identityref types
 718                     IdentityrefTypeBuilder idref = (IdentityrefTypeBuilder) nodeToResolve.getTypedef();
 719                     IdentitySchemaNodeBuilder identity = findBaseIdentity(module, idref.getBaseString(),
 720                             idref.getLine());
 721                     if (identity == null) {
 722                         throw new YangParseException(module.getName(), idref.getLine(), "Failed to find base identity");
 723                     }
 724                     idref.setBaseIdentity(identity);
 725                     nodeToResolve.setType(idref.build());
 726                 } else {
 727                     resolveType(nodeToResolve, modules, module);
 728                 }
 729             }
 730         }
 731     }
 732
 733     /**
 734      * Traverse through augmentations of modules and fix their child nodes
 735      * schema path.
 736      *
 737      * @param modules
 738      *            all loaded modules
 739      */
 740     private void resolveAugmentsTargetPath(final Map<URI, TreeMap<Date, ModuleBuilder>> modules) {
 741         // collect augments from all loaded modules
 742         final List<AugmentationSchemaBuilder> allAugments = new ArrayList<>();
 743         for (Map.Entry<URI, TreeMap<Date, ModuleBuilder>> entry : modules.entrySet()) {
 744             for (Map.Entry<Date, ModuleBuilder> inner : entry.getValue().entrySet()) {
 745                 allAugments.addAll(inner.getValue().getAllAugments());
 746             }
 747         }
 748
 749         for (AugmentationSchemaBuilder augment : allAugments) {
 750             setCorrectAugmentTargetPath(augment);
 751         }
 752     }
 753
 754     /**
 755      * Find augment target and set correct schema path for all its child nodes.
 756      *
 757      * @param augment
 758      *            augment to resolve
 759      */
 760     private void setCorrectAugmentTargetPath(final AugmentationSchemaBuilder augment) {
 761         Builder parent = augment.getParent();
 762         final SchemaPath targetNodeSchemaPath;
 763
 764         if (parent instanceof UsesNodeBuilder) {
 765             targetNodeSchemaPath = findUsesAugmentTargetNodePath(((UsesNodeBuilder) parent).getParent(), augment);
 766         } else {
 767             targetNodeSchemaPath = augment.getTargetPath();
 768         }
 769
 770         for (DataSchemaNodeBuilder childNode : augment.getChildNodeBuilders()) {
 771             correctPathForAugmentNodes(childNode, targetNodeSchemaPath);
 772         }
 773     }
 774
 775     private SchemaPath findUsesAugmentTargetNodePath(DataNodeContainerBuilder usesParent,
 776             AugmentationSchemaBuilder augment) {
 777         QName parentQName = usesParent.getQName();
 778         final QNameModule qnm;
 779         if (parentQName == null) {
 780             ModuleBuilder m = BuilderUtils.getParentModule(usesParent);
 781             qnm = m.getQNameModule();
 782         } else {
 783             qnm = parentQName.getModule();
 784         }
 785
 786         SchemaPath path = usesParent.getPath();
 787         for (QName qname : augment.getTargetPath().getPathFromRoot()) {
 788             path = path.createChild(QName.create(qnm, qname.getLocalName()));
 789         }
 790
 791         return path;
 792     }
 793
 794     /**
 795      * Set new schema path to node and all its child nodes based on given parent
 796      * path. This method do not change the namespace.
 797      *
 798      * @param node
 799      *            node which schema path should be updated
 800      * @param parentPath
 801      *            schema path of parent node
 802      */
 803     private void correctPathForAugmentNodes(final DataSchemaNodeBuilder node, final SchemaPath parentPath) {
 804         SchemaPath newPath = parentPath.createChild(node.getQName());
 805         node.setPath(newPath);
 806         if (node instanceof DataNodeContainerBuilder) {
 807             for (DataSchemaNodeBuilder child : ((DataNodeContainerBuilder) node).getChildNodeBuilders()) {
 808                 correctPathForAugmentNodes(child, node.getPath());
 809             }
 810         }
 811         if (node instanceof ChoiceBuilder) {
 812             for (ChoiceCaseBuilder child : ((ChoiceBuilder) node).getCases()) {
 813                 correctPathForAugmentNodes(child, node.getPath());
 814             }
 815         }
 816     }
 817
 818     /**
 819      * Check augments for mandatory nodes. If the target node is in another
 820      * module, then nodes added by the augmentation MUST NOT be mandatory nodes.
 821      * If mandatory node is found, throw an exception.
 822      *
 823      * @param augments
 824      *            augments to check
 825      */
 826     private void checkAugmentMandatoryNodes(final Collection<AugmentationSchemaBuilder> augments) {
 827         for (AugmentationSchemaBuilder augment : augments) {
 828             URI augmentTargetNs = augment.getTargetPath().getPathFromRoot().iterator().next().getNamespace();
 829             Date augmentTargetRev = augment.getTargetPath().getPathFromRoot().iterator().next().getRevision();
 830             ModuleBuilder module = BuilderUtils.getParentModule(augment);
 831
 832             if (augmentTargetNs.equals(module.getNamespace()) && augmentTargetRev.equals(module.getRevision())) {
 833                 continue;
 834             }
 835
 836             for (DataSchemaNodeBuilder childNode : augment.getChildNodeBuilders()) {
 837                 if (childNode.getConstraints().isMandatory()) {
 838                     throw new YangParseException(augment.getModuleName(), augment.getLine(),
 839                             "Error in augment parsing: cannot augment mandatory node "
 840                                     + childNode.getQName().getLocalName());
 841                 }
 842             }
 843         }
 844     }
 845
 846     /**
 847      * Go through all augment definitions and resolve them.
 848      *
 849      * @param modules
 850      *            all loaded modules topologically sorted (based on dependencies
 851      *            between each other)
 852      */
 853     private void resolveAugments(final Map<URI, TreeMap<Date, ModuleBuilder>> modules) {
 854         List<ModuleBuilder> all = new ArrayList<>();
 855         for (Map.Entry<URI, TreeMap<Date, ModuleBuilder>> entry : modules.entrySet()) {
 856             for (Map.Entry<Date, ModuleBuilder> inner : entry.getValue().entrySet()) {
 857                 all.add(inner.getValue());
 858             }
 859         }
 860
 861         for (ModuleBuilder mb : all) {
 862             if (mb != null) {
 863                 List<AugmentationSchemaBuilder> augments = mb.getAllAugments();
 864                 checkAugmentMandatoryNodes(augments);
 865                 Collections.sort(augments, Comparators.AUGMENT_BUILDER_COMP);
 866                 for (AugmentationSchemaBuilder augment : augments) {
 867                     if (!(augment.isResolved())) {
 868                         boolean resolved = resolveAugment(augment, mb, modules);
 869                         if (!resolved) {
 870                             throw new YangParseException(augment.getModuleName(), augment.getLine(),
 871                                     "Error in augment parsing: failed to find augment target: " + augment);
 872                         }
 873                     }
 874                 }
 875             }
 876         }
 877     }
 878
 879     /**
 880      * Perform augmentation defined under uses statement.
 881      *
 882      * @param augment
 883      *            augment to resolve
 884      * @param module
 885      *            current module
 886      * @param modules
 887      *            all loaded modules
 888      * @return true if augment process succeed
 889      */
 890     private boolean resolveUsesAugment(final AugmentationSchemaBuilder augment, final ModuleBuilder module,
 891             final Map<URI, TreeMap<Date, ModuleBuilder>> modules) {
 892         if (augment.isResolved()) {
 893             return true;
 894         }
 895
 896         UsesNodeBuilder usesNode = (UsesNodeBuilder) augment.getParent();
 897         DataNodeContainerBuilder parentNode = usesNode.getParent();
 898         Optional<SchemaNodeBuilder> potentialTargetNode;
 899         SchemaPath resolvedTargetPath = findUsesAugmentTargetNodePath(parentNode, augment);
 900         if (parentNode instanceof ModuleBuilder && resolvedTargetPath.isAbsolute()) {
 901             // Uses is directly used in module body, we lookup
 902             // We lookup in data namespace to find correct augmentation target
 903             potentialTargetNode = findSchemaNodeInModule(resolvedTargetPath, (ModuleBuilder) parentNode);
 904         } else {
 905             // Uses is used in local context (be it data namespace or grouping
 906             // namespace,
 907             // since all nodes via uses are imported to localName, it is safe to
 908             // to proceed only with local names.
 909             //
 910             // Conflicting elements in other namespaces are still not present
 911             // since resolveUsesAugment occurs before augmenting from external
 912             // modules.
 913             potentialTargetNode = Optional.<SchemaNodeBuilder> fromNullable(findSchemaNode(augment.getTargetPath()
 914                     .getPathFromRoot(), (SchemaNodeBuilder) parentNode));
 915         }
 916
 917         if (potentialTargetNode.isPresent()) {
 918             SchemaNodeBuilder targetNode = potentialTargetNode.get();
 919             if (targetNode instanceof AugmentationTargetBuilder) {
 920                 fillAugmentTarget(augment, targetNode);
 921                 ((AugmentationTargetBuilder) targetNode).addAugmentation(augment);
 922                 augment.setResolved(true);
 923                 return true;
 924             } else {
 925                 throw new YangParseException(module.getName(), augment.getLine(), String.format(
 926                         "Failed to resolve augment in uses. Invalid augment target: %s", potentialTargetNode));
 927             }
 928         } else {
 929             throw new YangParseException(module.getName(), augment.getLine(), String.format(
 930                     "Failed to resolve augment in uses. Invalid augment target path: %s", augment.getTargetPath()));
 931         }
 932
 933     }
 934
 935     /**
 936      * Find augment target module and perform augmentation.
 937      *
 938      * @param augment
 939      *            augment to resolve
 940      * @param module
 941      *            current module
 942      * @param modules
 943      *            all loaded modules
 944      * @return true if augment process succeed
 945      */
 946     private boolean resolveAugment(final AugmentationSchemaBuilder augment, final ModuleBuilder module,
 947             final Map<URI, TreeMap<Date, ModuleBuilder>> modules) {
 948         if (augment.isResolved()) {
 949             return true;
 950         }
 951
 952         QName targetModuleName = augment.getTargetPath().getPathFromRoot().iterator().next();
 953         ModuleBuilder targetModule = BuilderUtils.findModule(targetModuleName, modules);
 954         if (targetModule == null) {
 955             throw new YangParseException(module.getModuleName(), augment.getLine(), "Failed to resolve augment "
 956                     + augment);
 957         }
 958
 959         return processAugmentation(augment, targetModule);
 960     }
 961
 962     /**
 963      * Go through identity statements defined in current module and resolve
 964      * their 'base' statement.
 965      *
 966      * @param modules
 967      *            all loaded modules
 968      */
 969     private void resolveIdentities(final Map<URI, TreeMap<Date, ModuleBuilder>> modules) {
 970         for (Map.Entry<URI, TreeMap<Date, ModuleBuilder>> entry : modules.entrySet()) {
 971             for (Map.Entry<Date, ModuleBuilder> inner : entry.getValue().entrySet()) {
 972                 ModuleBuilder module = inner.getValue();
 973                 final Set<IdentitySchemaNodeBuilder> identities = module.getAddedIdentities();
 974                 for (IdentitySchemaNodeBuilder identity : identities) {
 975                     resolveIdentity(module, identity);
 976                 }
 977             }
 978         }
 979     }
 980
 981     private void resolveIdentity(final ModuleBuilder module, final IdentitySchemaNodeBuilder identity) {
 982         final String baseIdentityName = identity.getBaseIdentityName();
 983         if (baseIdentityName != null) {
 984             IdentitySchemaNodeBuilder result = null;
 985             if (baseIdentityName.contains(":")) {
 986                 final int line = identity.getLine();
 987                 String[] splittedBase = baseIdentityName.split(":");
 988                 if (splittedBase.length > 2) {
 989                     throw new YangParseException(module.getName(), line, "Failed to parse identityref base: "
 990                             + baseIdentityName);
 991                 }
 992                 String prefix = splittedBase[0];
 993                 String name = splittedBase[1];
 994                 ModuleBuilder dependentModule = BuilderUtils.getModuleByPrefix(module, prefix);
 995                 result = BuilderUtils.findIdentity(dependentModule.getAddedIdentities(), name);
 996             } else {
 997                 result = BuilderUtils.findIdentity(module.getAddedIdentities(), baseIdentityName);
 998             }
 999             identity.setBaseIdentity(result);
1000         }
1001     }
1002
1003     /**
1004      * Find and add reference of uses target grouping.
1005      *
1006      * @param modules
1007      *            all loaded modules
1008      */
1009     private void resolveUsesTargetGrouping(final Map<URI, TreeMap<Date, ModuleBuilder>> modules) {
1010         final List<UsesNodeBuilder> allUses = new ArrayList<>();
1011         for (Map.Entry<URI, TreeMap<Date, ModuleBuilder>> entry : modules.entrySet()) {
1012             for (Map.Entry<Date, ModuleBuilder> inner : entry.getValue().entrySet()) {
1013                 allUses.addAll(inner.getValue().getAllUsesNodes());
1014             }
1015         }
1016         for (UsesNodeBuilder usesNode : allUses) {
1017             ModuleBuilder module = BuilderUtils.getParentModule(usesNode);
1018             final GroupingBuilder targetGroupingBuilder = GroupingUtils.getTargetGroupingFromModules(usesNode, modules,
1019                     module);
1020             if (targetGroupingBuilder == null) {
1021                 throw new YangParseException(module.getName(), usesNode.getLine(), "Referenced grouping '"
1022                         + usesNode.getGroupingPath() + "' not found.");
1023             }
1024             usesNode.setGrouping(targetGroupingBuilder);
1025         }
1026     }
1027
1028     /**
1029      * Resolve uses statements defined in groupings.
1030      *
1031      * @param modules
1032      *            all loaded modules
1033      */
1034     private void resolveUsesForGroupings(final Map<URI, TreeMap<Date, ModuleBuilder>> modules) {
1035         final Set<GroupingBuilder> allGroupings = new HashSet<>();
1036         for (Map.Entry<URI, TreeMap<Date, ModuleBuilder>> entry : modules.entrySet()) {
1037             for (Map.Entry<Date, ModuleBuilder> inner : entry.getValue().entrySet()) {
1038                 ModuleBuilder module = inner.getValue();
1039                 allGroupings.addAll(module.getAllGroupings());
1040             }
1041         }
1042         final List<GroupingBuilder> sorted = GroupingSort.sort(allGroupings);
1043         for (GroupingBuilder gb : sorted) {
1044             List<UsesNodeBuilder> usesNodes = new ArrayList<>(GroupingSort.getAllUsesNodes(gb));
1045             Collections.sort(usesNodes, new GroupingUtils.UsesComparator());
1046             for (UsesNodeBuilder usesNode : usesNodes) {
1047                 resolveUses(usesNode, modules);
1048             }
1049         }
1050     }
1051
1052     /**
1053      * Resolve uses statements.
1054      *
1055      * @param modules
1056      *            all loaded modules
1057      */
1058     private void resolveUsesForNodes(final Map<URI, TreeMap<Date, ModuleBuilder>> modules) {
1059         for (Map.Entry<URI, TreeMap<Date, ModuleBuilder>> entry : modules.entrySet()) {
1060             for (Map.Entry<Date, ModuleBuilder> inner : entry.getValue().entrySet()) {
1061                 ModuleBuilder module = inner.getValue();
1062                 List<UsesNodeBuilder> usesNodes = module.getAllUsesNodes();
1063                 Collections.sort(usesNodes, new GroupingUtils.UsesComparator());
1064                 for (UsesNodeBuilder usesNode : usesNodes) {
1065                     resolveUses(usesNode, modules);
1066                 }
1067             }
1068         }
1069     }
1070
1071     /**
1072      * Find target grouping and copy its child nodes to current location with
1073      * new namespace.
1074      *
1075      * @param usesNode
1076      *            uses node to resolve
1077      * @param modules
1078      *            all loaded modules
1079      */
1080     private void resolveUses(final UsesNodeBuilder usesNode, final Map<URI, TreeMap<Date, ModuleBuilder>> modules) {
1081         if (!usesNode.isResolved()) {
1082             DataNodeContainerBuilder parent = usesNode.getParent();
1083             ModuleBuilder module = BuilderUtils.getParentModule(parent);
1084             GroupingBuilder target = GroupingUtils.getTargetGroupingFromModules(usesNode, modules, module);
1085
1086             int index = nodeAfterUsesIndex(usesNode);
1087             List<DataSchemaNodeBuilder> targetNodes = target.instantiateChildNodes(parent);
1088             for (DataSchemaNodeBuilder targetNode : targetNodes) {
1089                 parent.addChildNode(index++, targetNode);
1090             }
1091             parent.getTypeDefinitionBuilders().addAll(target.instantiateTypedefs(parent));
1092             parent.getGroupingBuilders().addAll(target.instantiateGroupings(parent));
1093             parent.getUnknownNodes().addAll(target.instantiateUnknownNodes(parent));
1094             usesNode.setResolved(true);
1095             for (AugmentationSchemaBuilder augment : usesNode.getAugmentations()) {
1096                 resolveUsesAugment(augment, module, modules);
1097             }
1098
1099             GroupingUtils.performRefine(usesNode);
1100         }
1101     }
1102
1103     private int nodeAfterUsesIndex(final UsesNodeBuilder usesNode) {
1104         DataNodeContainerBuilder parent = usesNode.getParent();
1105         int usesLine = usesNode.getLine();
1106
1107         List<DataSchemaNodeBuilder> childNodes = parent.getChildNodeBuilders();
1108         if (childNodes.isEmpty()) {
1109             return 0;
1110         }
1111
1112         DataSchemaNodeBuilder nextNodeAfterUses = null;
1113         for (DataSchemaNodeBuilder childNode : childNodes) {
1114             if (!(childNode.isAddedByUses()) && !(childNode.isAugmenting())) {
1115                 if (childNode.getLine() > usesLine) {
1116                     nextNodeAfterUses = childNode;
1117                     break;
1118                 }
1119             }
1120         }
1121
1122         // uses is declared after child nodes
1123         if (nextNodeAfterUses == null) {
1124             return childNodes.size();
1125         }
1126
1127         return parent.getChildNodeBuilders().indexOf(nextNodeAfterUses);
1128     }
1129
1130     /**
1131      * Try to find extension describing this unknown node and assign it to
1132      * unknown node builder.
1133      *
1134      * @param modules
1135      *            all loaded modules
1136      * @param module
1137      *            current module
1138      */
1139     private void resolveUnknownNodes(final Map<URI, TreeMap<Date, ModuleBuilder>> modules, final ModuleBuilder module) {
1140         for (UnknownSchemaNodeBuilder usnb : module.getAllUnknownNodes()) {
1141             QName nodeType = usnb.getNodeType();
1142             String localName = usnb.getNodeType().getLocalName();
1143             ModuleBuilder dependentModule = BuilderUtils.findModule(nodeType, modules);
1144
1145             if (dependentModule == null) {
1146                 LOG.warn(
1147                         "Error in module {} at line {}: Failed to resolve node {}: no such extension definition found.",
1148                         module.getName(), usnb.getLine(), usnb);
1149                 continue;
1150             }
1151
1152             ExtensionBuilder extBuilder = findExtBuilder(localName, dependentModule.getAddedExtensions());
1153             if (extBuilder == null) {
1154                 ExtensionDefinition extDef = findExtDef(localName, dependentModule.getExtensions());
1155                 if (extDef == null) {
1156                     LOG.warn(
1157                             "Error in module {} at line {}: Failed to resolve node {}: no such extension definition found.",
1158                             module.getName(), usnb.getLine(), usnb);
1159                 } else {
1160                     usnb.setExtensionDefinition(extDef);
1161                 }
1162             } else {
1163                 usnb.setExtensionBuilder(extBuilder);
1164             }
1165         }
1166     }
1167
1168     private ExtensionBuilder findExtBuilder(final String name, final Collection<ExtensionBuilder> extensions) {
1169         for (ExtensionBuilder extension : extensions) {
1170             if (extension.getQName().getLocalName().equals(name)) {
1171                 return extension;
1172             }
1173         }
1174         return null;
1175     }
1176
1177     private ExtensionDefinition findExtDef(final String name, final Collection<ExtensionDefinition> extensions) {
1178         for (ExtensionDefinition extension : extensions) {
1179             if (extension.getQName().getLocalName().equals(name)) {
1180                 return extension;
1181             }
1182         }
1183         return null;
1184     }
1185
1186 }