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(targetModule.getNamespace());
 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         Collection<ModuleBuilder> unsorted = resolveSubmodules(builders);
 333         List<ModuleBuilder> sorted = ModuleDependencySort.sort(unsorted);
 334         Map<URI, TreeMap<Date, ModuleBuilder>> modules = resolveModulesWithImports(sorted, null);
 335         Map<ModuleBuilder, Module> builderToModule = build(modules);
 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         Map<String, TreeMap<Date, ModuleBuilder>> submodules = new HashMap<>();
 416         for (Map.Entry<ByteSource, ModuleBuilder> entry : builders.entrySet()) {
 417             ModuleBuilder builder = entry.getValue();
 418             if (builder.isSubmodule()) {
 419                 String submoduleName = builder.getName();
 420                 TreeMap<Date, ModuleBuilder> map = submodules.get(submoduleName);
 421                 if (map == null) {
 422                     map = new TreeMap<>();
 423                     map.put(builder.getRevision(), builder);
 424                     submodules.put(submoduleName, map);
 425                 } else {
 426                     map.put(builder.getRevision(), builder);
 427                 }
 428             } else {
 429                 modules.put(entry.getKey(), builder);
 430             }
 431         }
 432
 433         for (ModuleBuilder module : modules.values()) {
 434             resolveSubmodules(module, submodules);
 435         }
 436
 437         return modules;
 438     }
 439
 440     private Collection<ModuleBuilder> resolveSubmodules(final Collection<ModuleBuilder> builders) {
 441         Collection<ModuleBuilder> modules = new HashSet<>();
 442         Map<String, TreeMap<Date, ModuleBuilder>> submodules = new HashMap<>();
 443         for (ModuleBuilder builder : builders) {
 444             if (builder.isSubmodule()) {
 445                 String submoduleName = builder.getName();
 446                 TreeMap<Date, ModuleBuilder> map = submodules.get(submoduleName);
 447                 if (map == null) {
 448                     map = new TreeMap<>();
 449                     map.put(builder.getRevision(), builder);
 450                     submodules.put(submoduleName, map);
 451                 } else {
 452                     map.put(builder.getRevision(), builder);
 453                 }
 454             } else {
 455                 modules.add(builder);
 456             }
 457         }
 458
 459         for (ModuleBuilder module : modules) {
 460             resolveSubmodules(module, submodules);
 461         }
 462
 463         return modules;
 464     }
 465
 466     /**
 467      * Traverse collection of builders, find builders representing submodule and
 468      * add this submodule to its parent module.
 469      *
 470      * @param module
 471      *            current module
 472      * @param submodules
 473      *            collection all loaded submodules
 474      * @return collection of module builders with resolved submodules
 475      */
 476     private void resolveSubmodules(final ModuleBuilder module,
 477             final Map<String, TreeMap<Date, ModuleBuilder>> submodules) {
 478         Map<String, Date> includes = module.getIncludedModules();
 479         for (Map.Entry<String, Date> entry : includes.entrySet()) {
 480             TreeMap<Date, ModuleBuilder> subs = submodules.get(entry.getKey());
 481             if (subs == null) {
 482                 throw new YangParseException("Failed to find references submodule " + entry.getKey() + " in module "
 483                         + module.getName());
 484             }
 485             Date rev = entry.getValue();
 486             ModuleBuilder submodule;
 487             if (rev == null) {
 488                 submodule = subs.lastEntry().getValue();
 489             } else {
 490                 submodule = subs.get(rev);
 491                 // FIXME an exception should be thrown after issue with
 492                 // submodule's revisions and namespaces will be resolved
 493                 if (submodule == null) {
 494                     submodule = subs.lastEntry().getValue();
 495                 }
 496             }
 497
 498             if (submodule.getIncludedModules().size() > 0) {
 499                 resolveSubmodules(submodule, submodules);
 500             }
 501             addSubmoduleToModule(submodule, module);
 502         }
 503     }
 504
 505     private void addSubmoduleToModule(final ModuleBuilder submodule, final ModuleBuilder module) {
 506         module.addSubmodule(submodule);
 507         submodule.setParent(module);
 508         module.getDirtyNodes().addAll(submodule.getDirtyNodes());
 509         module.getImports().putAll(submodule.getImports());
 510         module.getAugments().addAll(submodule.getAugments());
 511         module.getAugmentBuilders().addAll(submodule.getAugmentBuilders());
 512         module.getAllAugments().addAll(submodule.getAllAugments());
 513         module.getChildNodeBuilders().addAll(submodule.getChildNodeBuilders());
 514         module.getChildNodes().putAll(submodule.getChildNodes());
 515         module.getGroupings().addAll(submodule.getGroupings());
 516         module.getGroupingBuilders().addAll(submodule.getGroupingBuilders());
 517         module.getTypeDefinitions().addAll(submodule.getTypeDefinitions());
 518         module.getTypeDefinitionBuilders().addAll(submodule.getTypeDefinitionBuilders());
 519         module.getUsesNodes().addAll(submodule.getUsesNodes());
 520         module.getUsesNodeBuilders().addAll(submodule.getUsesNodeBuilders());
 521         module.getAllGroupings().addAll(submodule.getAllGroupings());
 522         module.getAllUsesNodes().addAll(submodule.getAllUsesNodes());
 523         module.getRpcs().addAll(submodule.getRpcs());
 524         module.getAddedRpcs().addAll(submodule.getAddedRpcs());
 525         module.getNotifications().addAll(submodule.getNotifications());
 526         module.getAddedNotifications().addAll(submodule.getAddedNotifications());
 527         module.getIdentities().addAll(submodule.getIdentities());
 528         module.getAddedIdentities().addAll(submodule.getAddedIdentities());
 529         module.getFeatures().addAll(submodule.getFeatures());
 530         module.getAddedFeatures().addAll(submodule.getAddedFeatures());
 531         module.getDeviations().addAll(submodule.getDeviations());
 532         module.getDeviationBuilders().addAll(submodule.getDeviationBuilders());
 533         module.getExtensions().addAll(submodule.getExtensions());
 534         module.getAddedExtensions().addAll(submodule.getAddedExtensions());
 535         module.getUnknownNodes().addAll(submodule.getUnknownNodes());
 536         module.getAllUnknownNodes().addAll(submodule.getAllUnknownNodes());
 537     }
 538
 539     private List<ModuleBuilder> resolveModuleBuilders(final Collection<ByteSource> yangFileStreams,
 540             final SchemaContext context) throws IOException, YangSyntaxErrorException {
 541         Map<ByteSource, ModuleBuilder> parsedBuilders = resolveSources(yangFileStreams, context);
 542         ModuleBuilder[] builders = new ModuleBuilder[parsedBuilders.size()];
 543         parsedBuilders.values().toArray(builders);
 544
 545         // module dependency graph sorted
 546         List<ModuleBuilder> sorted;
 547         if (context == null) {
 548             sorted = ModuleDependencySort.sort(builders);
 549         } else {
 550             sorted = ModuleDependencySort.sortWithContext(context, builders);
 551         }
 552         return sorted;
 553     }
 554
 555     /**
 556      * Order modules by namespace and revision.
 557      *
 558      * @param modules
 559      *            topologically sorted modules
 560      * @return modules ordered by namespace and revision
 561      */
 562     private static LinkedHashMap<URI, TreeMap<Date, ModuleBuilder>> orderModules(final List<ModuleBuilder> modules) {
 563         final LinkedHashMap<URI, TreeMap<Date, ModuleBuilder>> result = new LinkedHashMap<>();
 564         for (final ModuleBuilder builder : modules) {
 565             if (builder == null) {
 566                 continue;
 567             }
 568
 569             URI ns = builder.getNamespace();
 570             Date rev = builder.getRevision();
 571             if (rev == null) {
 572                 rev = new Date(0);
 573             }
 574
 575             TreeMap<Date, ModuleBuilder> builderByRevision = result.get(ns);
 576             if (builderByRevision == null) {
 577                 builderByRevision = new TreeMap<>();
 578                 builderByRevision.put(rev, builder);
 579                 result.put(ns, builderByRevision);
 580             } else {
 581                 builderByRevision.put(rev, builder);
 582             }
 583
 584         }
 585         return result;
 586     }
 587
 588     /**
 589      * Find {@code main} dependencies from {@code other} and add them to
 590      * {@code filtered}.
 591      *
 592      * @param main
 593      *            main yang module
 594      * @param other
 595      *            all loaded modules
 596      * @param filtered
 597      *            collection to fill up
 598      */
 599     private void filterImports(final ModuleBuilder main, final Collection<ModuleBuilder> other,
 600             final Collection<ModuleBuilder> filtered) {
 601         Map<String, ModuleImport> imports = main.getImports();
 602
 603         // if this is submodule, add parent to filtered and pick its imports
 604         if (main.isSubmodule()) {
 605             TreeMap<Date, ModuleBuilder> dependencies = new TreeMap<>();
 606             for (ModuleBuilder mb : other) {
 607                 if (mb.getName().equals(main.getBelongsTo())) {
 608                     dependencies.put(mb.getRevision(), mb);
 609                 }
 610             }
 611             ModuleBuilder parent = dependencies.get(dependencies.firstKey());
 612             filtered.add(parent);
 613             imports.putAll(parent.getImports());
 614         }
 615
 616         for (ModuleImport mi : imports.values()) {
 617             for (ModuleBuilder builder : other) {
 618                 if (mi.getModuleName().equals(builder.getModuleName())) {
 619                     if (mi.getRevision() == null) {
 620                         if (!filtered.contains(builder)) {
 621                             filtered.add(builder);
 622                             filterImports(builder, other, filtered);
 623                         }
 624                     } else {
 625                         if (mi.getRevision().equals(builder.getRevision())) {
 626                             if (!filtered.contains(builder)) {
 627                                 filtered.add(builder);
 628                                 filterImports(builder, other, filtered);
 629                             }
 630                         }
 631                     }
 632                 }
 633             }
 634         }
 635     }
 636
 637     private Map<ByteSource, ParseTree> parseYangSources(final Collection<ByteSource> sources) throws IOException, YangSyntaxErrorException {
 638         final Map<ByteSource, ParseTree> trees = new HashMap<>();
 639         for (ByteSource source : sources) {
 640             try (InputStream stream = source.openStream()) {
 641                 trees.put(source, parseYangSource(stream));
 642             }
 643         }
 644         return trees;
 645     }
 646
 647     public static YangContext parseYangSource(final InputStream stream) throws IOException, YangSyntaxErrorException {
 648         final YangLexer lexer = new YangLexer(new ANTLRInputStream(stream));
 649         final CommonTokenStream tokens = new CommonTokenStream(lexer);
 650         final YangParser parser = new YangParser(tokens);
 651         parser.removeErrorListeners();
 652
 653         final YangErrorListener errorListener = new YangErrorListener();
 654         parser.addErrorListener(errorListener);
 655
 656         final YangContext result = parser.yang();
 657         errorListener.validate();
 658
 659         return result;
 660     }
 661
 662     /**
 663      * Mini parser: This parsing context does not validate full YANG module,
 664      * only parses header up to the revisions and imports.
 665      *
 666      * @see org.opendaylight.yangtools.yang.parser.impl.util.YangModelDependencyInfo
 667      */
 668     public static YangContext parseStreamWithoutErrorListeners(final InputStream yangStream) {
 669         YangContext result = null;
 670         try {
 671             final ANTLRInputStream input = new ANTLRInputStream(yangStream);
 672             final YangLexer lexer = new YangLexer(input);
 673             final CommonTokenStream tokens = new CommonTokenStream(lexer);
 674             final YangParser parser = new YangParser(tokens);
 675             parser.removeErrorListeners();
 676             result = parser.yang();
 677         } catch (IOException e) {
 678             LOG.warn("Exception while reading yang file: " + yangStream, e);
 679         }
 680         return result;
 681     }
 682
 683     /**
 684      * Creates builder-to-module map based on given modules. Method first
 685      * resolve unresolved type references, instantiate groupings through uses
 686      * statements and perform augmentation.
 687      *
 688      * Node resolving must be performed in following order:
 689      * <ol>
 690      * <li>
 691      * unresolved type references</li>
 692      * <li>
 693      * uses in groupings</li>
 694      * <li>
 695      * uses in other nodes</li>
 696      * <li>
 697      * augments</li>
 698      * </ol>
 699      *
 700      * @param modules
 701      *            all loaded modules
 702      * @return modules mapped on their builders
 703      */
 704     private Map<ModuleBuilder, Module> build(final Map<URI, TreeMap<Date, ModuleBuilder>> modules) {
 705         resolveDirtyNodes(modules);
 706         resolveAugmentsTargetPath(modules);
 707         resolveUsesTargetGrouping(modules);
 708         resolveUsesForGroupings(modules);
 709         resolveUsesForNodes(modules);
 710         resolveAugments(modules);
 711         resolveIdentities(modules);
 712
 713         // build
 714         final Map<ModuleBuilder, Module> result = new LinkedHashMap<>();
 715         for (Map.Entry<URI, TreeMap<Date, ModuleBuilder>> entry : modules.entrySet()) {
 716             for (Map.Entry<Date, ModuleBuilder> childEntry : entry.getValue().entrySet()) {
 717                 final ModuleBuilder moduleBuilder = childEntry.getValue();
 718                 final Module module = moduleBuilder.build();
 719                 result.put(moduleBuilder, module);
 720             }
 721         }
 722         return result;
 723     }
 724
 725     /**
 726      * Resolve all unresolved type references.
 727      *
 728      * @param modules
 729      *            all loaded modules
 730      */
 731     private void resolveDirtyNodes(final Map<URI, TreeMap<Date, ModuleBuilder>> modules) {
 732         for (Map.Entry<URI, TreeMap<Date, ModuleBuilder>> entry : modules.entrySet()) {
 733             for (Map.Entry<Date, ModuleBuilder> childEntry : entry.getValue().entrySet()) {
 734                 final ModuleBuilder module = childEntry.getValue();
 735                 resolveUnknownNodes(modules, module);
 736                 resolveDirtyNodes(modules, module);
 737             }
 738         }
 739     }
 740
 741     /**
 742      * Search for dirty nodes (node which contains UnknownType) and resolve
 743      * unknown types.
 744      *
 745      * @param modules
 746      *            all available modules
 747      * @param module
 748      *            current module
 749      */
 750     private void resolveDirtyNodes(final Map<URI, TreeMap<Date, ModuleBuilder>> modules, final ModuleBuilder module) {
 751         final Set<TypeAwareBuilder> dirtyNodes = module.getDirtyNodes();
 752         if (!dirtyNodes.isEmpty()) {
 753             for (TypeAwareBuilder nodeToResolve : dirtyNodes) {
 754                 if (nodeToResolve instanceof UnionTypeBuilder) {
 755                     // special handling for union types
 756                     resolveTypeUnion((UnionTypeBuilder) nodeToResolve, modules, module);
 757                 } else if (nodeToResolve.getTypedef() instanceof IdentityrefTypeBuilder) {
 758                     // special handling for identityref types
 759                     IdentityrefTypeBuilder idref = (IdentityrefTypeBuilder) nodeToResolve.getTypedef();
 760                     IdentitySchemaNodeBuilder identity = findBaseIdentity(module, idref.getBaseString(),
 761                             idref.getLine());
 762                     if (identity == null) {
 763                         throw new YangParseException(module.getName(), idref.getLine(), "Failed to find base identity");
 764                     }
 765                     idref.setBaseIdentity(identity);
 766                     nodeToResolve.setType(idref.build());
 767                 } else {
 768                     resolveType(nodeToResolve, modules, module);
 769                 }
 770             }
 771         }
 772     }
 773
 774     /**
 775      * Traverse through augmentations of modules and fix their child nodes
 776      * schema path.
 777      *
 778      * @param modules
 779      *            all loaded modules
 780      */
 781     private void resolveAugmentsTargetPath(final Map<URI, TreeMap<Date, ModuleBuilder>> modules) {
 782         // collect augments from all loaded modules
 783         final List<AugmentationSchemaBuilder> allAugments = new ArrayList<>();
 784         for (Map.Entry<URI, TreeMap<Date, ModuleBuilder>> entry : modules.entrySet()) {
 785             for (Map.Entry<Date, ModuleBuilder> inner : entry.getValue().entrySet()) {
 786                 allAugments.addAll(inner.getValue().getAllAugments());
 787             }
 788         }
 789
 790         for (AugmentationSchemaBuilder augment : allAugments) {
 791             setCorrectAugmentTargetPath(augment);
 792         }
 793     }
 794
 795     /**
 796      * Find augment target and set correct schema path for all its child nodes.
 797      *
 798      * @param augment
 799      *            augment to resolve
 800      */
 801     private void setCorrectAugmentTargetPath(final AugmentationSchemaBuilder augment) {
 802         Builder parent = augment.getParent();
 803         final SchemaPath targetNodeSchemaPath;
 804
 805         if (parent instanceof UsesNodeBuilder) {
 806             targetNodeSchemaPath = findUsesAugmentTargetNodePath(((UsesNodeBuilder) parent).getParent(), augment);
 807         } else {
 808             targetNodeSchemaPath = augment.getTargetPath();
 809         }
 810
 811         for (DataSchemaNodeBuilder childNode : augment.getChildNodeBuilders()) {
 812             correctPathForAugmentNodes(childNode, targetNodeSchemaPath);
 813         }
 814     }
 815
 816     private SchemaPath findUsesAugmentTargetNodePath(DataNodeContainerBuilder usesParent,
 817             AugmentationSchemaBuilder augment) {
 818         QName parentQName = usesParent.getQName();
 819         final QNameModule qnm;
 820         if (parentQName == null) {
 821             ModuleBuilder m = BuilderUtils.getParentModule(usesParent);
 822             qnm = m.getQNameModule();
 823         } else {
 824             qnm = parentQName.getModule();
 825         }
 826
 827         SchemaPath path = usesParent.getPath();
 828         for (QName qname : augment.getTargetPath().getPathFromRoot()) {
 829             path = path.createChild(QName.create(qnm, qname.getLocalName()));
 830         }
 831
 832         return path;
 833     }
 834
 835     /**
 836      * Set new schema path to node and all its child nodes based on given parent
 837      * path. This method do not change the namespace.
 838      *
 839      * @param node
 840      *            node which schema path should be updated
 841      * @param parentPath
 842      *            schema path of parent node
 843      */
 844     private void correctPathForAugmentNodes(final DataSchemaNodeBuilder node, final SchemaPath parentPath) {
 845         SchemaPath newPath = parentPath.createChild(node.getQName());
 846         node.setPath(newPath);
 847         if (node instanceof DataNodeContainerBuilder) {
 848             for (DataSchemaNodeBuilder child : ((DataNodeContainerBuilder) node).getChildNodeBuilders()) {
 849                 correctPathForAugmentNodes(child, node.getPath());
 850             }
 851         }
 852         if (node instanceof ChoiceBuilder) {
 853             for (ChoiceCaseBuilder child : ((ChoiceBuilder) node).getCases()) {
 854                 correctPathForAugmentNodes(child, node.getPath());
 855             }
 856         }
 857     }
 858
 859     /**
 860      * Check augments for mandatory nodes. If the target node is in another
 861      * module, then nodes added by the augmentation MUST NOT be mandatory nodes.
 862      * If mandatory node is found, throw an exception.
 863      *
 864      * @param augments
 865      *            augments to check
 866      */
 867     private void checkAugmentMandatoryNodes(final Collection<AugmentationSchemaBuilder> augments) {
 868         for (AugmentationSchemaBuilder augment : augments) {
 869             URI augmentTargetNs = augment.getTargetPath().getPathFromRoot().iterator().next().getNamespace();
 870             Date augmentTargetRev = augment.getTargetPath().getPathFromRoot().iterator().next().getRevision();
 871             ModuleBuilder module = BuilderUtils.getParentModule(augment);
 872
 873             if (augmentTargetNs.equals(module.getNamespace()) && augmentTargetRev.equals(module.getRevision())) {
 874                 continue;
 875             }
 876
 877             for (DataSchemaNodeBuilder childNode : augment.getChildNodeBuilders()) {
 878                 if (childNode.getConstraints().isMandatory()) {
 879                     throw new YangParseException(augment.getModuleName(), augment.getLine(),
 880                             "Error in augment parsing: cannot augment mandatory node "
 881                                     + childNode.getQName().getLocalName());
 882                 }
 883             }
 884         }
 885     }
 886
 887     /**
 888      * Go through all augment definitions and resolve them.
 889      *
 890      * @param modules
 891      *            all loaded modules topologically sorted (based on dependencies
 892      *            between each other)
 893      */
 894     private void resolveAugments(final Map<URI, TreeMap<Date, ModuleBuilder>> modules) {
 895         List<ModuleBuilder> all = new ArrayList<>();
 896         for (Map.Entry<URI, TreeMap<Date, ModuleBuilder>> entry : modules.entrySet()) {
 897             for (Map.Entry<Date, ModuleBuilder> inner : entry.getValue().entrySet()) {
 898                 all.add(inner.getValue());
 899             }
 900         }
 901
 902         for (ModuleBuilder mb : all) {
 903             if (mb != null) {
 904                 List<AugmentationSchemaBuilder> augments = mb.getAllAugments();
 905                 checkAugmentMandatoryNodes(augments);
 906                 Collections.sort(augments, Comparators.AUGMENT_BUILDER_COMP);
 907                 for (AugmentationSchemaBuilder augment : augments) {
 908                     if (!(augment.isResolved())) {
 909                         boolean resolved = resolveAugment(augment, mb, modules);
 910                         if (!resolved) {
 911                             throw new YangParseException(augment.getModuleName(), augment.getLine(),
 912                                     "Error in augment parsing: failed to find augment target: " + augment);
 913                         }
 914                     }
 915                 }
 916             }
 917         }
 918     }
 919
 920     /**
 921      * Perform augmentation defined under uses statement.
 922      *
 923      * @param augment
 924      *            augment to resolve
 925      * @param module
 926      *            current module
 927      * @param modules
 928      *            all loaded modules
 929      * @return true if augment process succeed
 930      */
 931     private boolean resolveUsesAugment(final AugmentationSchemaBuilder augment, final ModuleBuilder module,
 932             final Map<URI, TreeMap<Date, ModuleBuilder>> modules) {
 933         if (augment.isResolved()) {
 934             return true;
 935         }
 936
 937         UsesNodeBuilder usesNode = (UsesNodeBuilder) augment.getParent();
 938         DataNodeContainerBuilder parentNode = usesNode.getParent();
 939         Optional<SchemaNodeBuilder> potentialTargetNode;
 940         SchemaPath resolvedTargetPath = findUsesAugmentTargetNodePath(parentNode, augment);
 941         if (parentNode instanceof ModuleBuilder && resolvedTargetPath.isAbsolute()) {
 942             // Uses is directly used in module body, we lookup
 943             // We lookup in data namespace to find correct augmentation target
 944             potentialTargetNode = findSchemaNodeInModule(resolvedTargetPath, (ModuleBuilder) parentNode);
 945         } else {
 946             // Uses is used in local context (be it data namespace or grouping
 947             // namespace,
 948             // since all nodes via uses are imported to localName, it is safe to
 949             // to proceed only with local names.
 950             //
 951             // Conflicting elements in other namespaces are still not present
 952             // since resolveUsesAugment occurs before augmenting from external
 953             // modules.
 954             potentialTargetNode = Optional.<SchemaNodeBuilder> fromNullable(findSchemaNode(augment.getTargetPath()
 955                     .getPathFromRoot(), (SchemaNodeBuilder) parentNode));
 956         }
 957
 958         if (potentialTargetNode.isPresent()) {
 959             SchemaNodeBuilder targetNode = potentialTargetNode.get();
 960             if (targetNode instanceof AugmentationTargetBuilder) {
 961                 fillAugmentTarget(augment, targetNode);
 962                 ((AugmentationTargetBuilder) targetNode).addAugmentation(augment);
 963                 augment.setResolved(true);
 964                 return true;
 965             } else {
 966                 LOG.warn(
 967                         "Error in module {} at line {}: Unsupported augment target: {}. Augmentation process skipped.",
 968                         module.getName(), augment.getLine(), potentialTargetNode);
 969                 augment.setResolved(true);
 970                 return true;
 971             }
 972         } else {
 973             throw new YangParseException(module.getName(), augment.getLine(), String.format(
 974                     "Failed to resolve augment in uses. Invalid augment target path: %s", augment.getTargetPath()));
 975         }
 976
 977     }
 978
 979     /**
 980      * Find augment target module and perform augmentation.
 981      *
 982      * @param augment
 983      *            augment to resolve
 984      * @param module
 985      *            current module
 986      * @param modules
 987      *            all loaded modules
 988      * @return true if augment process succeed
 989      */
 990     private boolean resolveAugment(final AugmentationSchemaBuilder augment, final ModuleBuilder module,
 991             final Map<URI, TreeMap<Date, ModuleBuilder>> modules) {
 992         if (augment.isResolved()) {
 993             return true;
 994         }
 995
 996         QName targetModuleName = augment.getTargetPath().getPathFromRoot().iterator().next();
 997         ModuleBuilder targetModule = BuilderUtils.findModule(targetModuleName, modules);
 998         if (targetModule == null) {
 999             throw new YangParseException(module.getModuleName(), augment.getLine(), "Failed to resolve augment "
1000                     + augment);
1001         }
1002
1003         return processAugmentation(augment, targetModule);
1004     }
1005
1006     /**
1007      * Go through identity statements defined in current module and resolve
1008      * their 'base' statement.
1009      *
1010      * @param modules
1011      *            all loaded modules
1012      */
1013     private void resolveIdentities(final Map<URI, TreeMap<Date, ModuleBuilder>> modules) {
1014         for (Map.Entry<URI, TreeMap<Date, ModuleBuilder>> entry : modules.entrySet()) {
1015             for (Map.Entry<Date, ModuleBuilder> inner : entry.getValue().entrySet()) {
1016                 ModuleBuilder module = inner.getValue();
1017                 final Set<IdentitySchemaNodeBuilder> identities = module.getAddedIdentities();
1018                 for (IdentitySchemaNodeBuilder identity : identities) {
1019                     resolveIdentity(module, identity);
1020                 }
1021             }
1022         }
1023     }
1024
1025     private void resolveIdentity(final ModuleBuilder module, final IdentitySchemaNodeBuilder identity) {
1026         final String baseIdentityName = identity.getBaseIdentityName();
1027         if (baseIdentityName != null) {
1028             IdentitySchemaNodeBuilder result = null;
1029             if (baseIdentityName.contains(":")) {
1030                 final int line = identity.getLine();
1031                 String[] splittedBase = baseIdentityName.split(":");
1032                 if (splittedBase.length > 2) {
1033                     throw new YangParseException(module.getName(), line, "Failed to parse identityref base: "
1034                             + baseIdentityName);
1035                 }
1036                 String prefix = splittedBase[0];
1037                 String name = splittedBase[1];
1038                 ModuleBuilder dependentModule = BuilderUtils.getModuleByPrefix(module, prefix);
1039                 result = BuilderUtils.findIdentity(dependentModule.getAddedIdentities(), name);
1040             } else {
1041                 result = BuilderUtils.findIdentity(module.getAddedIdentities(), baseIdentityName);
1042             }
1043             identity.setBaseIdentity(result);
1044         }
1045     }
1046
1047     /**
1048      * Find and add reference of uses target grouping.
1049      *
1050      * @param modules
1051      *            all loaded modules
1052      */
1053     private void resolveUsesTargetGrouping(final Map<URI, TreeMap<Date, ModuleBuilder>> modules) {
1054         final List<UsesNodeBuilder> allUses = new ArrayList<>();
1055         for (Map.Entry<URI, TreeMap<Date, ModuleBuilder>> entry : modules.entrySet()) {
1056             for (Map.Entry<Date, ModuleBuilder> inner : entry.getValue().entrySet()) {
1057                 allUses.addAll(inner.getValue().getAllUsesNodes());
1058             }
1059         }
1060         for (UsesNodeBuilder usesNode : allUses) {
1061             ModuleBuilder module = BuilderUtils.getParentModule(usesNode);
1062             final GroupingBuilder targetGroupingBuilder = GroupingUtils.getTargetGroupingFromModules(usesNode, modules,
1063                     module);
1064             usesNode.setGrouping(targetGroupingBuilder);
1065         }
1066     }
1067
1068     /**
1069      * Resolve uses statements defined in groupings.
1070      *
1071      * @param modules
1072      *            all loaded modules
1073      */
1074     private void resolveUsesForGroupings(final Map<URI, TreeMap<Date, ModuleBuilder>> modules) {
1075         final Set<GroupingBuilder> allGroupings = new HashSet<>();
1076         for (Map.Entry<URI, TreeMap<Date, ModuleBuilder>> entry : modules.entrySet()) {
1077             for (Map.Entry<Date, ModuleBuilder> inner : entry.getValue().entrySet()) {
1078                 ModuleBuilder module = inner.getValue();
1079                 allGroupings.addAll(module.getAllGroupings());
1080             }
1081         }
1082         final List<GroupingBuilder> sorted = GroupingSort.sort(allGroupings);
1083         for (GroupingBuilder gb : sorted) {
1084             List<UsesNodeBuilder> usesNodes = new ArrayList<>(GroupingSort.getAllUsesNodes(gb));
1085             Collections.sort(usesNodes, new GroupingUtils.UsesComparator());
1086             for (UsesNodeBuilder usesNode : usesNodes) {
1087                 resolveUses(usesNode, modules);
1088             }
1089         }
1090     }
1091
1092     /**
1093      * Resolve uses statements.
1094      *
1095      * @param modules
1096      *            all loaded modules
1097      */
1098     private void resolveUsesForNodes(final Map<URI, TreeMap<Date, ModuleBuilder>> modules) {
1099         for (Map.Entry<URI, TreeMap<Date, ModuleBuilder>> entry : modules.entrySet()) {
1100             for (Map.Entry<Date, ModuleBuilder> inner : entry.getValue().entrySet()) {
1101                 ModuleBuilder module = inner.getValue();
1102                 List<UsesNodeBuilder> usesNodes = module.getAllUsesNodes();
1103                 Collections.sort(usesNodes, new GroupingUtils.UsesComparator());
1104                 for (UsesNodeBuilder usesNode : usesNodes) {
1105                     resolveUses(usesNode, modules);
1106                 }
1107             }
1108         }
1109     }
1110
1111     /**
1112      * Find target grouping and copy its child nodes to current location with
1113      * new namespace.
1114      *
1115      * @param usesNode
1116      *            uses node to resolve
1117      * @param modules
1118      *            all loaded modules
1119      */
1120     private void resolveUses(final UsesNodeBuilder usesNode, final Map<URI, TreeMap<Date, ModuleBuilder>> modules) {
1121         if (!usesNode.isResolved()) {
1122             DataNodeContainerBuilder parent = usesNode.getParent();
1123             ModuleBuilder module = BuilderUtils.getParentModule(parent);
1124             GroupingBuilder target = GroupingUtils.getTargetGroupingFromModules(usesNode, modules, module);
1125
1126             int index = nodeAfterUsesIndex(usesNode);
1127             List<DataSchemaNodeBuilder> targetNodes = target.instantiateChildNodes(parent);
1128             for (DataSchemaNodeBuilder targetNode : targetNodes) {
1129                 parent.addChildNode(index++, targetNode);
1130             }
1131             parent.getTypeDefinitionBuilders().addAll(target.instantiateTypedefs(parent));
1132             parent.getGroupingBuilders().addAll(target.instantiateGroupings(parent));
1133             parent.getUnknownNodes().addAll(target.instantiateUnknownNodes(parent));
1134             usesNode.setResolved(true);
1135             for (AugmentationSchemaBuilder augment : usesNode.getAugmentations()) {
1136                 resolveUsesAugment(augment, module, modules);
1137             }
1138
1139             GroupingUtils.performRefine(usesNode);
1140         }
1141     }
1142
1143     private int nodeAfterUsesIndex(final UsesNodeBuilder usesNode) {
1144         DataNodeContainerBuilder parent = usesNode.getParent();
1145         int usesLine = usesNode.getLine();
1146
1147         List<DataSchemaNodeBuilder> childNodes = parent.getChildNodeBuilders();
1148         if (childNodes.isEmpty()) {
1149             return 0;
1150         }
1151
1152         DataSchemaNodeBuilder nextNodeAfterUses = null;
1153         for (DataSchemaNodeBuilder childNode : childNodes) {
1154             if (!(childNode.isAddedByUses()) && !(childNode.isAugmenting())) {
1155                 if (childNode.getLine() > usesLine) {
1156                     nextNodeAfterUses = childNode;
1157                     break;
1158                 }
1159             }
1160         }
1161
1162         // uses is declared after child nodes
1163         if (nextNodeAfterUses == null) {
1164             return childNodes.size();
1165         }
1166
1167         return parent.getChildNodeBuilders().indexOf(nextNodeAfterUses);
1168     }
1169
1170     /**
1171      * Try to find extension describing this unknown node and assign it to
1172      * unknown node builder.
1173      *
1174      * @param modules
1175      *            all loaded modules
1176      * @param module
1177      *            current module
1178      */
1179     private void resolveUnknownNodes(final Map<URI, TreeMap<Date, ModuleBuilder>> modules, final ModuleBuilder module) {
1180         for (UnknownSchemaNodeBuilder usnb : module.getAllUnknownNodes()) {
1181             QName nodeType = usnb.getNodeType();
1182             String localName = usnb.getNodeType().getLocalName();
1183             ModuleBuilder dependentModule = BuilderUtils.findModule(nodeType, modules);
1184
1185             if (dependentModule == null) {
1186                 LOG.warn(
1187                         "Error in module {} at line {}: Failed to resolve node {}: no such extension definition found.",
1188                         module.getName(), usnb.getLine(), usnb);
1189                 continue;
1190             }
1191
1192             ExtensionBuilder extBuilder = findExtBuilder(localName, dependentModule.getAddedExtensions());
1193             if (extBuilder == null) {
1194                 ExtensionDefinition extDef = findExtDef(localName, dependentModule.getExtensions());
1195                 if (extDef == null) {
1196                     LOG.warn(
1197                             "Error in module {} at line {}: Failed to resolve node {}: no such extension definition found.",
1198                             module.getName(), usnb.getLine(), usnb);
1199                 } else {
1200                     usnb.setExtensionDefinition(extDef);
1201                 }
1202             } else {
1203                 usnb.setExtensionBuilder(extBuilder);
1204             }
1205         }
1206     }
1207
1208     private ExtensionBuilder findExtBuilder(final String name, final Collection<ExtensionBuilder> extensions) {
1209         for (ExtensionBuilder extension : extensions) {
1210             if (extension.getQName().getLocalName().equals(name)) {
1211                 return extension;
1212             }
1213         }
1214         return null;
1215     }
1216
1217     private ExtensionDefinition findExtDef(final String name, final Collection<ExtensionDefinition> extensions) {
1218         for (ExtensionDefinition extension : extensions) {
1219             if (extension.getQName().getLocalName().equals(name)) {
1220                 return extension;
1221             }
1222         }
1223         return null;
1224     }
1225
1226 }