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.util.ParserUtils.fillAugmentTarget;
  11 import static org.opendaylight.yangtools.yang.parser.util.ParserUtils.findBaseIdentity;
  12 import static org.opendaylight.yangtools.yang.parser.util.ParserUtils.findModuleFromBuilders;
  13 import static org.opendaylight.yangtools.yang.parser.util.ParserUtils.findModuleFromContext;
  14 import static org.opendaylight.yangtools.yang.parser.util.ParserUtils.findSchemaNode;
  15 import static org.opendaylight.yangtools.yang.parser.util.ParserUtils.findSchemaNodeInModule;
  16 import static org.opendaylight.yangtools.yang.parser.util.ParserUtils.processAugmentation;
  17 import static org.opendaylight.yangtools.yang.parser.util.ParserUtils.setNodeAddedByUses;
  18 import static org.opendaylight.yangtools.yang.parser.util.ParserUtils.wrapChildNode;
  19 import static org.opendaylight.yangtools.yang.parser.util.ParserUtils.wrapChildNodes;
  20 import static org.opendaylight.yangtools.yang.parser.util.ParserUtils.wrapGroupings;
  21 import static org.opendaylight.yangtools.yang.parser.util.ParserUtils.wrapTypedefs;
  22 import static org.opendaylight.yangtools.yang.parser.util.ParserUtils.wrapUnknownNodes;
  23 import static org.opendaylight.yangtools.yang.parser.util.TypeUtils.resolveType;
  24 import static org.opendaylight.yangtools.yang.parser.util.TypeUtils.resolveTypeUnion;
  25 import static org.opendaylight.yangtools.yang.parser.util.TypeUtils.resolveTypeUnionWithContext;
  26 import static org.opendaylight.yangtools.yang.parser.util.TypeUtils.resolveTypeWithContext;
  27
  28 import java.io.File;
  29 import java.io.IOException;
  30 import java.io.InputStream;
  31 import java.net.URI;
  32 import java.util.ArrayList;
  33 import java.util.Collection;
  34 import java.util.Collections;
  35 import java.util.Date;
  36 import java.util.HashMap;
  37 import java.util.HashSet;
  38 import java.util.LinkedHashMap;
  39 import java.util.LinkedHashSet;
  40 import java.util.List;
  41 import java.util.Map;
  42 import java.util.Set;
  43 import java.util.TreeMap;
  44
  45 import org.antlr.v4.runtime.ANTLRInputStream;
  46 import org.antlr.v4.runtime.CommonTokenStream;
  47 import org.antlr.v4.runtime.tree.ParseTree;
  48 import org.antlr.v4.runtime.tree.ParseTreeWalker;
  49 import org.opendaylight.yangtools.antlrv4.code.gen.YangLexer;
  50 import org.opendaylight.yangtools.antlrv4.code.gen.YangParser;
  51 import org.opendaylight.yangtools.antlrv4.code.gen.YangParser.YangContext;
  52 import org.opendaylight.yangtools.yang.common.QName;
  53 import org.opendaylight.yangtools.yang.common.QNameModule;
  54 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
  55 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  56 import org.opendaylight.yangtools.yang.model.api.ExtensionDefinition;
  57 import org.opendaylight.yangtools.yang.model.api.GroupingDefinition;
  58 import org.opendaylight.yangtools.yang.model.api.Module;
  59 import org.opendaylight.yangtools.yang.model.api.ModuleIdentifier;
  60 import org.opendaylight.yangtools.yang.model.api.ModuleImport;
  61 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  62 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
  63 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  64 import org.opendaylight.yangtools.yang.model.parser.api.YangContextParser;
  65 import org.opendaylight.yangtools.yang.model.parser.api.YangSyntaxErrorException;
  66 import org.opendaylight.yangtools.yang.parser.builder.api.AugmentationSchemaBuilder;
  67 import org.opendaylight.yangtools.yang.parser.builder.api.AugmentationTargetBuilder;
  68 import org.opendaylight.yangtools.yang.parser.builder.api.Builder;
  69 import org.opendaylight.yangtools.yang.parser.builder.api.DataNodeContainerBuilder;
  70 import org.opendaylight.yangtools.yang.parser.builder.api.DataSchemaNodeBuilder;
  71 import org.opendaylight.yangtools.yang.parser.builder.api.GroupingBuilder;
  72 import org.opendaylight.yangtools.yang.parser.builder.api.SchemaNodeBuilder;
  73 import org.opendaylight.yangtools.yang.parser.builder.api.TypeAwareBuilder;
  74 import org.opendaylight.yangtools.yang.parser.builder.api.TypeDefinitionBuilder;
  75 import org.opendaylight.yangtools.yang.parser.builder.api.UsesNodeBuilder;
  76 import org.opendaylight.yangtools.yang.parser.builder.impl.ChoiceBuilder;
  77 import org.opendaylight.yangtools.yang.parser.builder.impl.ChoiceCaseBuilder;
  78 import org.opendaylight.yangtools.yang.parser.builder.impl.DeviationBuilder;
  79 import org.opendaylight.yangtools.yang.parser.builder.impl.ExtensionBuilder;
  80 import org.opendaylight.yangtools.yang.parser.builder.impl.IdentitySchemaNodeBuilder;
  81 import org.opendaylight.yangtools.yang.parser.builder.impl.IdentityrefTypeBuilder;
  82 import org.opendaylight.yangtools.yang.parser.builder.impl.ModuleBuilder;
  83 import org.opendaylight.yangtools.yang.parser.builder.impl.ModuleBuilder.ModuleImpl;
  84 import org.opendaylight.yangtools.yang.parser.builder.impl.UnionTypeBuilder;
  85 import org.opendaylight.yangtools.yang.parser.builder.impl.UnknownSchemaNodeBuilder;
  86 import org.opendaylight.yangtools.yang.parser.util.Comparators;
  87 import org.opendaylight.yangtools.yang.parser.util.GroupingSort;
  88 import org.opendaylight.yangtools.yang.parser.util.GroupingUtils;
  89 import org.opendaylight.yangtools.yang.parser.util.ModuleDependencySort;
  90 import org.opendaylight.yangtools.yang.parser.util.NamedByteArrayInputStream;
  91 import org.opendaylight.yangtools.yang.parser.util.NamedFileInputStream;
  92 import org.opendaylight.yangtools.yang.parser.util.NamedInputStream;
  93 import org.opendaylight.yangtools.yang.parser.util.ParserUtils;
  94 import org.opendaylight.yangtools.yang.parser.util.YangParseException;
  95 import org.opendaylight.yangtools.yang.validator.YangModelBasicValidator;
  96 import org.slf4j.Logger;
  97 import org.slf4j.LoggerFactory;
  98
  99 import com.google.common.base.Optional;
 100 import com.google.common.base.Preconditions;
 101 import com.google.common.collect.HashBiMap;
 102 import com.google.common.io.ByteSource;
 103
 104 public final class YangParserImpl implements YangContextParser {
 105     private static final Logger LOG = LoggerFactory.getLogger(YangParserImpl.class);
 106
 107     private static final String FAIL_DEVIATION_TARGET = "Failed to find deviation target.";
 108
 109     @Override
 110     @Deprecated
 111     public Set<Module> parseYangModels(final File yangFile, final File directory) {
 112         try {
 113             return parseFile(yangFile, directory).getModules();
 114         } catch (IOException | YangSyntaxErrorException e) {
 115             throw new YangParseException("Failed to parse yang data", e);
 116         }
 117     }
 118
 119     @Override
 120     public SchemaContext parseFile(final File yangFile, final File directory) throws IOException,
 121     YangSyntaxErrorException {
 122         Preconditions.checkState(yangFile.exists(), yangFile + " does not exists");
 123         Preconditions.checkState(directory.exists(), directory + " does not exists");
 124         Preconditions.checkState(directory.isDirectory(), directory + " is not a directory");
 125
 126         final String yangFileName = yangFile.getName();
 127         final String[] fileList = checkNotNull(directory.list(), directory + " not found or is not a directory");
 128
 129         Map<ByteSource, File> sourceToFile = new LinkedHashMap<>();
 130         ByteSource mainFileSource = ParserUtils.fileToByteSource(yangFile);
 131         sourceToFile.put(mainFileSource, yangFile);
 132
 133         for (String fileName : fileList) {
 134             if (fileName.equals(yangFileName)) {
 135                 continue;
 136             }
 137             File dependency = new File(directory, fileName);
 138             if (dependency.isFile()) {
 139                 sourceToFile.put(ParserUtils.fileToByteSource(dependency), dependency);
 140             }
 141         }
 142
 143         Map<ByteSource, ModuleBuilder> sourceToBuilder = parseSourcesToBuilders(sourceToFile.keySet());
 144         ModuleBuilder main = sourceToBuilder.get(mainFileSource);
 145
 146         List<ModuleBuilder> moduleBuilders = new ArrayList<>();
 147         moduleBuilders.add(main);
 148         filterImports(main, new ArrayList<>(sourceToBuilder.values()), moduleBuilders);
 149         Collection<ModuleBuilder> resolved = resolveSubmodules(moduleBuilders);
 150
 151         // module builders sorted by dependencies
 152         List<ModuleBuilder> sortedBuilders = ModuleDependencySort.sort(resolved);
 153         LinkedHashMap<String, TreeMap<Date, ModuleBuilder>> modules = orderModules(sortedBuilders);
 154         Collection<Module> unsorted = build(modules).values();
 155         Set<Module> result = new LinkedHashSet<>(
 156                 ModuleDependencySort.sort(unsorted.toArray(new Module[unsorted.size()])));
 157         return resolveSchemaContext(result);
 158     }
 159
 160     @Override
 161     @Deprecated
 162     public Set<Module> parseYangModels(final List<File> yangFiles) {
 163         return parseFiles(yangFiles).getModules();
 164     }
 165
 166     @Override
 167     public SchemaContext parseFiles(final Collection<File> yangFiles) {
 168         Collection<Module> unsorted = parseYangModelsMapped(yangFiles).values();
 169         Set<Module> sorted = new LinkedHashSet<>(
 170                 ModuleDependencySort.sort(unsorted.toArray(new Module[unsorted.size()])));
 171         return resolveSchemaContext(sorted);
 172     }
 173
 174     @Override
 175     @Deprecated
 176     public Set<Module> parseYangModels(final List<File> yangFiles, final SchemaContext context) {
 177         try {
 178             return parseFiles(yangFiles, context).getModules();
 179         } catch (IOException | YangSyntaxErrorException e) {
 180             throw new YangParseException("Failed to parse yang data", e);
 181         }
 182     }
 183
 184     @Override
 185     public SchemaContext parseFiles(final Collection<File> yangFiles, final SchemaContext context) throws IOException,
 186     YangSyntaxErrorException {
 187         if (yangFiles == null) {
 188             return resolveSchemaContext(Collections.<Module> emptySet());
 189         }
 190
 191         Collection<ByteSource> sources = ParserUtils.filesToByteSources(yangFiles);
 192         SchemaContext result = parseSources(sources, context);
 193         return result;
 194     }
 195
 196     @Override
 197     @Deprecated
 198     public Set<Module> parseYangModelsFromStreams(final List<InputStream> yangModelStreams) {
 199         try {
 200             Collection<ByteSource> sources = ParserUtils.streamsToByteSources(yangModelStreams);
 201             return parseSources(sources).getModules();
 202         } catch (IOException | YangSyntaxErrorException e) {
 203             throw new YangParseException("Failed to parse yang data", e);
 204         }
 205     }
 206
 207     @Override
 208     public SchemaContext parseSources(final Collection<ByteSource> sources) throws IOException,
 209     YangSyntaxErrorException {
 210         Collection<Module> unsorted = parseYangModelSources(sources).values();
 211         Set<Module> sorted = new LinkedHashSet<>(
 212                 ModuleDependencySort.sort(unsorted.toArray(new Module[unsorted.size()])));
 213         return resolveSchemaContext(sorted);
 214     }
 215
 216     @Override
 217     @Deprecated
 218     public Set<Module> parseYangModelsFromStreams(final List<InputStream> yangModelStreams, final SchemaContext context) {
 219         try {
 220             Collection<ByteSource> sources = ParserUtils.streamsToByteSources(yangModelStreams);
 221             return parseSources(sources, context).getModules();
 222         } catch (IOException | YangSyntaxErrorException e) {
 223             throw new YangParseException("Failed to parse yang data", e);
 224         }
 225     }
 226
 227     @Override
 228     public SchemaContext parseSources(final Collection<ByteSource> sources, final SchemaContext context)
 229             throws IOException, YangSyntaxErrorException {
 230         if (sources == null) {
 231             return resolveSchemaContext(Collections.<Module> emptySet());
 232         }
 233
 234         final Map<String, TreeMap<Date, ModuleBuilder>> modules = resolveModuleBuilders(sources, context);
 235         final Set<Module> unsorted = new LinkedHashSet<>(buildWithContext(modules, context).values());
 236         if (context != null) {
 237             for (Module m : context.getModules()) {
 238                 if (!unsorted.contains(m)) {
 239                     unsorted.add(m);
 240                 }
 241             }
 242         }
 243         Set<Module> result = new LinkedHashSet<>(
 244                 ModuleDependencySort.sort(unsorted.toArray(new Module[unsorted.size()])));
 245         return resolveSchemaContext(result);
 246     }
 247
 248     @Override
 249     public Map<File, Module> parseYangModelsMapped(final Collection<File> yangFiles) {
 250         if (yangFiles == null || yangFiles.isEmpty()) {
 251             return Collections.emptyMap();
 252         }
 253
 254         Map<ByteSource, File> byteSourceToFile = new HashMap<>();
 255         for (final File file : yangFiles) {
 256             ByteSource source = new ByteSource() {
 257                 @Override
 258                 public InputStream openStream() throws IOException {
 259                     return new NamedFileInputStream(file, file.getPath());
 260                 }
 261             };
 262             byteSourceToFile.put(source, file);
 263         }
 264
 265         Map<ByteSource, Module> byteSourceToModule;
 266         try {
 267             byteSourceToModule = parseYangModelSources(byteSourceToFile.keySet());
 268         } catch (IOException | YangSyntaxErrorException e) {
 269             throw new YangParseException("Failed to parse yang data", e);
 270         }
 271         Map<File, Module> result = new LinkedHashMap<>();
 272         for (Map.Entry<ByteSource, Module> entry : byteSourceToModule.entrySet()) {
 273             result.put(byteSourceToFile.get(entry.getKey()), entry.getValue());
 274         }
 275         return result;
 276     }
 277
 278     @Override
 279     public Map<InputStream, Module> parseYangModelsFromStreamsMapped(final Collection<InputStream> yangModelStreams) {
 280         if (yangModelStreams == null || yangModelStreams.isEmpty()) {
 281             return Collections.emptyMap();
 282         }
 283
 284         Map<ByteSource, InputStream> sourceToStream = new HashMap<>();
 285         for (final InputStream stream : yangModelStreams) {
 286             ByteSource source = new ByteSource() {
 287                 @Override
 288                 public InputStream openStream() throws IOException {
 289                     return NamedByteArrayInputStream.create(stream);
 290                 }
 291             };
 292             sourceToStream.put(source, stream);
 293         }
 294
 295         Map<ByteSource, Module> sourceToModule;
 296         try {
 297             sourceToModule = parseYangModelSources(sourceToStream.keySet());
 298         } catch (IOException | YangSyntaxErrorException e) {
 299             throw new YangParseException("Failed to parse yang data", e);
 300         }
 301         Map<InputStream, Module> result = new LinkedHashMap<>();
 302         for (Map.Entry<ByteSource, Module> entry : sourceToModule.entrySet()) {
 303             result.put(sourceToStream.get(entry.getKey()), entry.getValue());
 304         }
 305         return result;
 306     }
 307
 308     @Override
 309     public SchemaContext resolveSchemaContext(final Set<Module> modules) {
 310         // after merging parse method with this one, add support for getting
 311         // submodule sources.
 312         Map<ModuleIdentifier, String> identifiersToSources = new HashMap<>();
 313         for (Module module : modules) {
 314             ModuleImpl moduleImpl = (ModuleImpl) module;
 315             identifiersToSources.put(module, moduleImpl.getSource());
 316         }
 317         return new SchemaContextImpl(modules, identifiersToSources);
 318     }
 319
 320     private Map<ByteSource, Module> parseYangModelSources(final Collection<ByteSource> sources) throws IOException,
 321     YangSyntaxErrorException {
 322         if (sources == null || sources.isEmpty()) {
 323             return Collections.emptyMap();
 324         }
 325
 326         Map<ByteSource, ModuleBuilder> sourceToBuilder = resolveSources(sources);
 327         // sort and check for duplicates
 328         List<ModuleBuilder> sorted = ModuleDependencySort.sort(sourceToBuilder.values());
 329         ParserUtils.setSourceToBuilder(sourceToBuilder);
 330         Map<String, TreeMap<Date, ModuleBuilder>> modules = orderModules(sorted);
 331         Map<ModuleBuilder, Module> builderToModule = build(modules);
 332         Map<ModuleBuilder, ByteSource> builderToSource = HashBiMap.create(sourceToBuilder).inverse();
 333         sorted = ModuleDependencySort.sort(builderToModule.keySet());
 334
 335         Map<ByteSource, Module> result = new LinkedHashMap<>();
 336         for (ModuleBuilder moduleBuilder : sorted) {
 337             Module value = checkNotNull(builderToModule.get(moduleBuilder), "Cannot get module for %s", moduleBuilder);
 338             result.put(builderToSource.get(moduleBuilder), value);
 339         }
 340
 341         return result;
 342     }
 343
 344     /**
 345      * Parse streams and resolve submodules.
 346      *
 347      * @param streams
 348      *            collection of streams to parse
 349      * @return map, where key is source stream and value is module builder
 350      *         parsed from stream
 351      * @throws YangSyntaxErrorException
 352      */
 353     private Map<ByteSource, ModuleBuilder> resolveSources(final Collection<ByteSource> streams) throws IOException,
 354     YangSyntaxErrorException {
 355         Map<ByteSource, ModuleBuilder> builders = parseSourcesToBuilders(streams);
 356         Map<ByteSource, ModuleBuilder> result = resolveSubmodules(builders);
 357         return result;
 358     }
 359
 360     private Map<ByteSource, ModuleBuilder> parseSourcesToBuilders(final Collection<ByteSource> sources)
 361             throws IOException, YangSyntaxErrorException {
 362         final ParseTreeWalker walker = new ParseTreeWalker();
 363         final Map<ByteSource, ParseTree> sourceToTree = parseYangSources(sources);
 364         final Map<ByteSource, ModuleBuilder> sourceToBuilder = new LinkedHashMap<>();
 365
 366         // validate yang
 367         new YangModelBasicValidator(walker).validate(sourceToTree.values());
 368
 369         YangParserListenerImpl yangModelParser;
 370         for (Map.Entry<ByteSource, ParseTree> entry : sourceToTree.entrySet()) {
 371             ByteSource source = entry.getKey();
 372             String path = null;
 373             InputStream stream = source.openStream();
 374             if (stream instanceof NamedInputStream) {
 375                 path = stream.toString();
 376             }
 377             try {
 378                 stream.close();
 379             } catch (IOException e) {
 380                 LOG.warn("Failed to close stream {}", stream);
 381             }
 382
 383             yangModelParser = new YangParserListenerImpl(path);
 384             walker.walk(yangModelParser, entry.getValue());
 385             ModuleBuilder moduleBuilder = yangModelParser.getModuleBuilder();
 386             sourceToBuilder.put(source, moduleBuilder);
 387         }
 388
 389         ParserUtils.setSourceToBuilder(sourceToBuilder);
 390         return sourceToBuilder;
 391     }
 392
 393     private Map<ByteSource, ModuleBuilder> resolveSubmodules(final Map<ByteSource, ModuleBuilder> builders) {
 394         Map<ByteSource, ModuleBuilder> modules = new HashMap<>();
 395         Set<ModuleBuilder> submodules = new HashSet<>();
 396         for (Map.Entry<ByteSource, ModuleBuilder> entry : builders.entrySet()) {
 397             ModuleBuilder moduleBuilder = entry.getValue();
 398             if (moduleBuilder.isSubmodule()) {
 399                 submodules.add(moduleBuilder);
 400             } else {
 401                 modules.put(entry.getKey(), moduleBuilder);
 402             }
 403         }
 404
 405         Collection<ModuleBuilder> values = modules.values();
 406         for (ModuleBuilder submodule : submodules) {
 407             for (ModuleBuilder module : values) {
 408                 if (module.getName().equals(submodule.getBelongsTo())) {
 409                     addSubmoduleToModule(submodule, module);
 410                 }
 411             }
 412         }
 413         return modules;
 414     }
 415
 416     /**
 417      * Traverse collection of builders, find builders representing submodule and
 418      * add this submodule to its parent module.
 419      *
 420      * @param builders
 421      *            collection of builders containing modules and submodules
 422      * @return collection of module builders
 423      */
 424     private Collection<ModuleBuilder> resolveSubmodules(final Collection<ModuleBuilder> builders) {
 425         Collection<ModuleBuilder> modules = new HashSet<>();
 426         Set<ModuleBuilder> submodules = new HashSet<>();
 427         for (ModuleBuilder moduleBuilder : builders) {
 428             if (moduleBuilder.isSubmodule()) {
 429                 submodules.add(moduleBuilder);
 430             } else {
 431                 modules.add(moduleBuilder);
 432             }
 433         }
 434
 435         for (ModuleBuilder submodule : submodules) {
 436             for (ModuleBuilder module : modules) {
 437                 if (module.getName().equals(submodule.getBelongsTo())) {
 438                     addSubmoduleToModule(submodule, module);
 439                 }
 440             }
 441         }
 442         return modules;
 443     }
 444
 445     private void addSubmoduleToModule(final ModuleBuilder submodule, final ModuleBuilder module) {
 446         submodule.setParent(module);
 447         module.getDirtyNodes().addAll(submodule.getDirtyNodes());
 448         module.getModuleImports().addAll(submodule.getModuleImports());
 449         module.getAugments().addAll(submodule.getAugments());
 450         module.getAugmentBuilders().addAll(submodule.getAugmentBuilders());
 451         module.getAllAugments().addAll(submodule.getAllAugments());
 452         module.getChildNodeBuilders().addAll(submodule.getChildNodeBuilders());
 453         module.getChildNodes().putAll(submodule.getChildNodes());
 454         module.getGroupings().addAll(submodule.getGroupings());
 455         module.getGroupingBuilders().addAll(submodule.getGroupingBuilders());
 456         module.getTypeDefinitions().addAll(submodule.getTypeDefinitions());
 457         module.getTypeDefinitionBuilders().addAll(submodule.getTypeDefinitionBuilders());
 458         module.getUsesNodes().addAll(submodule.getUsesNodes());
 459         module.getUsesNodeBuilders().addAll(submodule.getUsesNodeBuilders());
 460         module.getAllGroupings().addAll(submodule.getAllGroupings());
 461         module.getAllUsesNodes().addAll(submodule.getAllUsesNodes());
 462         module.getRpcs().addAll(submodule.getRpcs());
 463         module.getAddedRpcs().addAll(submodule.getAddedRpcs());
 464         module.getNotifications().addAll(submodule.getNotifications());
 465         module.getAddedNotifications().addAll(submodule.getAddedNotifications());
 466         module.getIdentities().addAll(submodule.getIdentities());
 467         module.getAddedIdentities().addAll(submodule.getAddedIdentities());
 468         module.getFeatures().addAll(submodule.getFeatures());
 469         module.getAddedFeatures().addAll(submodule.getAddedFeatures());
 470         module.getDeviations().addAll(submodule.getDeviations());
 471         module.getDeviationBuilders().addAll(submodule.getDeviationBuilders());
 472         module.getExtensions().addAll(submodule.getExtensions());
 473         module.getAddedExtensions().addAll(submodule.getAddedExtensions());
 474         module.getUnknownNodes().addAll(submodule.getUnknownNodes());
 475         module.getAllUnknownNodes().addAll(submodule.getAllUnknownNodes());
 476     }
 477
 478     private Map<String, TreeMap<Date, ModuleBuilder>> resolveModuleBuilders(
 479             final Collection<ByteSource> yangFileStreams, final SchemaContext context) throws IOException,
 480             YangSyntaxErrorException {
 481         Map<ByteSource, ModuleBuilder> parsedBuilders = resolveSources(yangFileStreams);
 482         ModuleBuilder[] builders = new ModuleBuilder[parsedBuilders.size()];
 483         parsedBuilders.values().toArray(builders);
 484
 485         // module dependency graph sorted
 486         List<ModuleBuilder> sorted;
 487         if (context == null) {
 488             sorted = ModuleDependencySort.sort(builders);
 489         } else {
 490             sorted = ModuleDependencySort.sortWithContext(context, builders);
 491         }
 492         return orderModules(sorted);
 493     }
 494
 495     /**
 496      * Order modules by name and revision.
 497      *
 498      * @param modules
 499      *            modules to order
 500      * @return modules ordered by name and revision
 501      */
 502     private LinkedHashMap<String, TreeMap<Date, ModuleBuilder>> orderModules(final List<ModuleBuilder> modules) {
 503         final LinkedHashMap<String, TreeMap<Date, ModuleBuilder>> result = new LinkedHashMap<>();
 504         for (final ModuleBuilder builder : modules) {
 505             if (builder == null) {
 506                 continue;
 507             }
 508             final String builderName = builder.getName();
 509             Date builderRevision = builder.getRevision();
 510             if (builderRevision == null) {
 511                 builderRevision = new Date(0L);
 512             }
 513             TreeMap<Date, ModuleBuilder> builderByRevision = result.get(builderName);
 514             if (builderByRevision == null) {
 515                 builderByRevision = new TreeMap<>();
 516             }
 517             builderByRevision.put(builderRevision, builder);
 518             result.put(builderName, builderByRevision);
 519         }
 520         return result;
 521     }
 522
 523     /**
 524      * Find {@code main} dependencies from {@code other} and add them to
 525      * {@code filtered}.
 526      *
 527      * @param main
 528      *            main yang module
 529      * @param other
 530      *            all loaded modules
 531      * @param filtered
 532      *            collection to fill up
 533      */
 534     private void filterImports(final ModuleBuilder main, final Collection<ModuleBuilder> other,
 535             final Collection<ModuleBuilder> filtered) {
 536         Set<ModuleImport> imports = main.getModuleImports();
 537
 538         // if this is submodule, add parent to filtered and pick its imports
 539         if (main.isSubmodule()) {
 540             TreeMap<Date, ModuleBuilder> dependencies = new TreeMap<>();
 541             for (ModuleBuilder mb : other) {
 542                 if (mb.getName().equals(main.getBelongsTo())) {
 543                     dependencies.put(mb.getRevision(), mb);
 544                 }
 545             }
 546             ModuleBuilder parent = dependencies.get(dependencies.firstKey());
 547             filtered.add(parent);
 548             imports.addAll(parent.getModuleImports());
 549         }
 550
 551         for (ModuleImport mi : imports) {
 552             for (ModuleBuilder builder : other) {
 553                 if (mi.getModuleName().equals(builder.getModuleName())) {
 554                     if (mi.getRevision() == null) {
 555                         if (!filtered.contains(builder)) {
 556                             filtered.add(builder);
 557                             filterImports(builder, other, filtered);
 558                         }
 559                     } else {
 560                         if (mi.getRevision().equals(builder.getRevision())) {
 561                             if (!filtered.contains(builder)) {
 562                                 filtered.add(builder);
 563                                 filterImports(builder, other, filtered);
 564                             }
 565                         }
 566                     }
 567                 }
 568             }
 569         }
 570     }
 571
 572     private Map<ByteSource, ParseTree> parseYangSources(final Collection<ByteSource> sources) throws IOException,
 573     YangSyntaxErrorException {
 574         final Map<ByteSource, ParseTree> trees = new HashMap<>();
 575         for (ByteSource source : sources) {
 576             trees.put(source, parseYangSource(source));
 577         }
 578         return trees;
 579     }
 580
 581     private YangContext parseYangSource(final ByteSource source) throws IOException, YangSyntaxErrorException {
 582         try (InputStream stream = source.openStream()) {
 583             final ANTLRInputStream input = new ANTLRInputStream(stream);
 584             final YangLexer lexer = new YangLexer(input);
 585             final CommonTokenStream tokens = new CommonTokenStream(lexer);
 586             final YangParser parser = new YangParser(tokens);
 587             parser.removeErrorListeners();
 588
 589             final YangErrorListener errorListener = new YangErrorListener();
 590             parser.addErrorListener(errorListener);
 591
 592             final YangContext result = parser.yang();
 593             errorListener.validate();
 594
 595             return result;
 596         }
 597     }
 598
 599     public static YangContext parseStreamWithoutErrorListeners(final InputStream yangStream) {
 600         YangContext result = null;
 601         try {
 602             final ANTLRInputStream input = new ANTLRInputStream(yangStream);
 603             final YangLexer lexer = new YangLexer(input);
 604             final CommonTokenStream tokens = new CommonTokenStream(lexer);
 605             final YangParser parser = new YangParser(tokens);
 606             parser.removeErrorListeners();
 607             result = parser.yang();
 608         } catch (IOException e) {
 609             LOG.warn("Exception while reading yang file: " + yangStream, e);
 610         }
 611         return result;
 612     }
 613
 614     /**
 615      * Creates builder-to-module map based on given modules. Method first
 616      * resolve unresolved type references, instantiate groupings through uses
 617      * statements and perform augmentation.
 618      *
 619      * Node resolving must be performed in following order:
 620      * <ol>
 621      * <li>
 622      * unresolved type references</li>
 623      * <li>
 624      * uses in groupings</li>
 625      * <li>
 626      * uses in other nodes</li>
 627      * <li>
 628      * augments</li>
 629      * </ol>
 630      *
 631      * @param modules
 632      *            all loaded modules
 633      * @return modules mapped on their builders
 634      */
 635     private Map<ModuleBuilder, Module> build(final Map<String, TreeMap<Date, ModuleBuilder>> modules) {
 636         resolveDirtyNodes(modules);
 637         resolveAugmentsTargetPath(modules, null);
 638         resolveUsesTargetGrouping(modules, null);
 639         resolveUsesForGroupings(modules, null);
 640         resolveUsesForNodes(modules, null);
 641         resolveAugments(modules, null);
 642         resolveIdentities(modules);
 643         resolveDeviations(modules);
 644
 645         // build
 646         final Map<ModuleBuilder, Module> result = new LinkedHashMap<>();
 647         for (Map.Entry<String, TreeMap<Date, ModuleBuilder>> entry : modules.entrySet()) {
 648             for (Map.Entry<Date, ModuleBuilder> childEntry : entry.getValue().entrySet()) {
 649                 final ModuleBuilder moduleBuilder = childEntry.getValue();
 650                 final Module module = moduleBuilder.build();
 651                 result.put(moduleBuilder, module);
 652             }
 653         }
 654         return result;
 655     }
 656
 657     /**
 658      * Creates builder-to-module map based on given modules. Method first
 659      * resolve unresolved type references, instantiate groupings through uses
 660      * statements and perform augmentation.
 661      *
 662      * Node resolving must be performed in following order:
 663      * <ol>
 664      * <li>
 665      * unresolved type references</li>
 666      * <li>
 667      * uses in groupings</li>
 668      * <li>
 669      * uses in other nodes</li>
 670      * <li>
 671      * augments</li>
 672      * </ol>
 673      *
 674      * @param modules
 675      *            all loaded modules
 676      * @param context
 677      *            SchemaContext containing already resolved modules
 678      * @return modules mapped on their builders
 679      */
 680     private Map<ModuleBuilder, Module> buildWithContext(final Map<String, TreeMap<Date, ModuleBuilder>> modules,
 681             final SchemaContext context) {
 682         resolvedDirtyNodesWithContext(modules, context);
 683         resolveAugmentsTargetPath(modules, context);
 684         resolveUsesTargetGrouping(modules, context);
 685         resolveUsesForGroupings(modules, context);
 686         resolveUsesForNodes(modules, context);
 687         resolveAugments(modules, context);
 688         resolveIdentitiesWithContext(modules, context);
 689         resolveDeviationsWithContext(modules, context);
 690
 691         // build
 692         final Map<ModuleBuilder, Module> result = new LinkedHashMap<>();
 693         for (Map.Entry<String, TreeMap<Date, ModuleBuilder>> entry : modules.entrySet()) {
 694             for (Map.Entry<Date, ModuleBuilder> childEntry : entry.getValue().entrySet()) {
 695                 final ModuleBuilder moduleBuilder = childEntry.getValue();
 696                 final Module module = moduleBuilder.build();
 697                 result.put(moduleBuilder, module);
 698             }
 699         }
 700         return result;
 701     }
 702
 703     /**
 704      * Resolve all unresolved type references.
 705      *
 706      * @param modules
 707      *            all loaded modules
 708      */
 709     private void resolveDirtyNodes(final Map<String, TreeMap<Date, ModuleBuilder>> modules) {
 710         for (Map.Entry<String, TreeMap<Date, ModuleBuilder>> entry : modules.entrySet()) {
 711             for (Map.Entry<Date, ModuleBuilder> childEntry : entry.getValue().entrySet()) {
 712                 final ModuleBuilder module = childEntry.getValue();
 713                 resolveUnknownNodes(modules, module);
 714                 resolveDirtyNodes(modules, module);
 715             }
 716         }
 717     }
 718
 719     /**
 720      * Resolve all unresolved type references.
 721      *
 722      * @param modules
 723      *            all loaded modules
 724      * @param context
 725      *            SchemaContext containing already resolved modules
 726      */
 727     private void resolvedDirtyNodesWithContext(final Map<String, TreeMap<Date, ModuleBuilder>> modules,
 728             final SchemaContext context) {
 729         for (Map.Entry<String, TreeMap<Date, ModuleBuilder>> entry : modules.entrySet()) {
 730             for (Map.Entry<Date, ModuleBuilder> childEntry : entry.getValue().entrySet()) {
 731                 final ModuleBuilder module = childEntry.getValue();
 732                 resolveUnknownNodesWithContext(modules, module, context);
 733                 resolveDirtyNodesWithContext(modules, module, context);
 734             }
 735         }
 736     }
 737
 738     /**
 739      * Search for dirty nodes (node which contains UnknownType) and resolve
 740      * unknown types.
 741      *
 742      * @param modules
 743      *            all available modules
 744      * @param module
 745      *            current module
 746      */
 747     private void resolveDirtyNodes(final Map<String, TreeMap<Date, ModuleBuilder>> modules, final ModuleBuilder module) {
 748         final Set<TypeAwareBuilder> dirtyNodes = module.getDirtyNodes();
 749         if (!dirtyNodes.isEmpty()) {
 750             for (TypeAwareBuilder nodeToResolve : dirtyNodes) {
 751                 if (nodeToResolve instanceof UnionTypeBuilder) {
 752                     // special handling for union types
 753                     resolveTypeUnion((UnionTypeBuilder) nodeToResolve, modules, module);
 754                 } else if (nodeToResolve.getTypedef() instanceof IdentityrefTypeBuilder) {
 755                     // special handling for identityref types
 756                     IdentityrefTypeBuilder idref = (IdentityrefTypeBuilder) nodeToResolve.getTypedef();
 757                     IdentitySchemaNodeBuilder identity = findBaseIdentity(modules, module, idref.getBaseString(),
 758                             idref.getLine());
 759                     if (identity == null) {
 760                         throw new YangParseException(module.getName(), idref.getLine(), "Failed to find base identity");
 761                     }
 762                     idref.setBaseIdentity(identity);
 763                     nodeToResolve.setType(idref.build());
 764                 } else {
 765                     resolveType(nodeToResolve, modules, module);
 766                 }
 767             }
 768         }
 769     }
 770
 771     private void resolveDirtyNodesWithContext(final Map<String, TreeMap<Date, ModuleBuilder>> modules,
 772             final ModuleBuilder module, final SchemaContext context) {
 773         final Set<TypeAwareBuilder> dirtyNodes = module.getDirtyNodes();
 774         if (!dirtyNodes.isEmpty()) {
 775             for (TypeAwareBuilder nodeToResolve : dirtyNodes) {
 776                 if (nodeToResolve instanceof UnionTypeBuilder) {
 777                     // special handling for union types
 778                     resolveTypeUnionWithContext((UnionTypeBuilder) nodeToResolve, modules, module, context);
 779                 } else if (nodeToResolve.getTypedef() instanceof IdentityrefTypeBuilder) {
 780                     // special handling for identityref types
 781                     IdentityrefTypeBuilder idref = (IdentityrefTypeBuilder) nodeToResolve.getTypedef();
 782                     IdentitySchemaNodeBuilder identity = findBaseIdentity(modules, module, idref.getBaseString(),
 783                             idref.getLine());
 784                     idref.setBaseIdentity(identity);
 785                     nodeToResolve.setType(idref.build());
 786                 } else {
 787                     resolveTypeWithContext(nodeToResolve, modules, module, context);
 788                 }
 789             }
 790         }
 791     }
 792
 793     /**
 794      * Traverse through augmentations of modules and fix their child nodes
 795      * schema path.
 796      *
 797      * @param modules
 798      *            all loaded modules
 799      * @param context
 800      *            SchemaContext containing already resolved modules
 801      */
 802     private void resolveAugmentsTargetPath(final Map<String, TreeMap<Date, ModuleBuilder>> modules,
 803             final SchemaContext context) {
 804         // collect augments from all loaded modules
 805         final List<AugmentationSchemaBuilder> allAugments = new ArrayList<>();
 806         for (Map.Entry<String, TreeMap<Date, ModuleBuilder>> entry : modules.entrySet()) {
 807             for (Map.Entry<Date, ModuleBuilder> inner : entry.getValue().entrySet()) {
 808                 allAugments.addAll(inner.getValue().getAllAugments());
 809             }
 810         }
 811
 812         for (AugmentationSchemaBuilder augment : allAugments) {
 813             setCorrectAugmentTargetPath(modules, augment, context);
 814         }
 815     }
 816
 817     /**
 818      * Find augment target and set correct schema path for all its child nodes.
 819      *
 820      * @param modules
 821      *            all loaded modules
 822      * @param augment
 823      *            augment to resolve
 824      * @param context
 825      *            SchemaContext containing already resolved modules
 826      */
 827     private void setCorrectAugmentTargetPath(final Map<String, TreeMap<Date, ModuleBuilder>> modules,
 828             final AugmentationSchemaBuilder augment, final SchemaContext context) {
 829         ModuleBuilder module = ParserUtils.getParentModule(augment);
 830         SchemaPath oldSchemaPath = augment.getTargetPath();
 831         List<QName> oldPath = oldSchemaPath.getPath();
 832         List<QName> newPath = new ArrayList<>();
 833
 834         Builder parent = augment.getParent();
 835         if (parent instanceof UsesNodeBuilder) {
 836             DataNodeContainerBuilder usesParent = ((UsesNodeBuilder) parent).getParent();
 837             newPath.addAll(usesParent.getPath().getPath());
 838
 839             URI ns;
 840             Date revision;
 841             String prefix;
 842             QName baseQName = usesParent.getQName();
 843             if (baseQName == null) {
 844                 ModuleBuilder m = ParserUtils.getParentModule(usesParent);
 845                 ns = m.getNamespace();
 846                 revision = m.getRevision();
 847                 prefix = m.getPrefix();
 848             } else {
 849                 ns = baseQName.getNamespace();
 850                 revision = baseQName.getRevision();
 851                 prefix = baseQName.getPrefix();
 852             }
 853
 854             final QNameModule qm = QNameModule.create(ns, revision);
 855             for (QName qn : oldSchemaPath.getPath()) {
 856                 newPath.add(QName.create(qm, prefix, qn.getLocalName()));
 857             }
 858         } else {
 859             for (QName qn : oldPath) {
 860                 URI ns = module.getNamespace();
 861                 Date rev = module.getRevision();
 862                 String localPrefix = qn.getPrefix();
 863                 if (localPrefix != null && !("".equals(localPrefix))) {
 864                     ModuleBuilder currentModule = ParserUtils.findModuleFromBuilders(modules, module, localPrefix,
 865                             augment.getLine());
 866                     if (currentModule == null) {
 867                         Module m = ParserUtils.findModuleFromContext(context, module, localPrefix, augment.getLine());
 868                         if (m == null) {
 869                             throw new YangParseException(module.getName(), augment.getLine(), "Module with prefix "
 870                                     + localPrefix + " not found.");
 871                         }
 872                         ns = m.getNamespace();
 873                         rev = m.getRevision();
 874                     } else {
 875                         ns = currentModule.getNamespace();
 876                         rev = currentModule.getRevision();
 877                     }
 878                 }
 879                 newPath.add(new QName(ns, rev, localPrefix, qn.getLocalName()));
 880             }
 881         }
 882         augment.setTargetNodeSchemaPath(SchemaPath.create(newPath, true));
 883
 884         for (DataSchemaNodeBuilder childNode : augment.getChildNodeBuilders()) {
 885             correctPathForAugmentNodes(childNode, augment.getTargetNodeSchemaPath());
 886         }
 887     }
 888
 889     /**
 890      * Set new schema path to node and all its child nodes based on given parent
 891      * path. This method do not change the namespace.
 892      *
 893      * @param node
 894      *            node which schema path should be updated
 895      * @param parentPath
 896      *            schema path of parent node
 897      */
 898     private void correctPathForAugmentNodes(final DataSchemaNodeBuilder node, final SchemaPath parentPath) {
 899         SchemaPath newPath = parentPath.createChild(node.getQName());
 900         node.setPath(newPath);
 901         if (node instanceof DataNodeContainerBuilder) {
 902             for (DataSchemaNodeBuilder child : ((DataNodeContainerBuilder) node).getChildNodeBuilders()) {
 903                 correctPathForAugmentNodes(child, node.getPath());
 904             }
 905         }
 906         if (node instanceof ChoiceBuilder) {
 907             for (ChoiceCaseBuilder child : ((ChoiceBuilder) node).getCases()) {
 908                 correctPathForAugmentNodes(child, node.getPath());
 909             }
 910         }
 911     }
 912
 913     /**
 914      * Check augments for mandatory nodes. If the target node is in another
 915      * module, then nodes added by the augmentation MUST NOT be mandatory nodes.
 916      * If mandatory node is found, throw an exception.
 917      *
 918      * @param augments
 919      *            augments to check
 920      */
 921     private void checkAugmentMandatoryNodes(final Collection<AugmentationSchemaBuilder> augments) {
 922         for (AugmentationSchemaBuilder augment : augments) {
 923             String augmentPrefix = augment.getTargetPath().getPathFromRoot().iterator().next().getPrefix();
 924             ModuleBuilder module = ParserUtils.getParentModule(augment);
 925             String modulePrefix = module.getPrefix();
 926
 927             if (augmentPrefix == null || augmentPrefix.isEmpty() || augmentPrefix.equals(modulePrefix)) {
 928                 continue;
 929             }
 930
 931             for (DataSchemaNodeBuilder childNode : augment.getChildNodeBuilders()) {
 932                 if (childNode.getConstraints().isMandatory()) {
 933                     throw new YangParseException(augment.getModuleName(), augment.getLine(),
 934                             "Error in augment parsing: cannot augment mandatory node "
 935                                     + childNode.getQName().getLocalName());
 936                 }
 937             }
 938         }
 939     }
 940
 941     /**
 942      * Go through all augment definitions and resolve them.
 943      *
 944      * @param modules
 945      *            all loaded modules
 946      * @param context
 947      *            SchemaContext containing already resolved modules
 948      */
 949     private void resolveAugments(final Map<String, TreeMap<Date, ModuleBuilder>> modules, final SchemaContext context) {
 950         List<ModuleBuilder> all = new ArrayList<>();
 951         for (Map.Entry<String, TreeMap<Date, ModuleBuilder>> entry : modules.entrySet()) {
 952             for (Map.Entry<Date, ModuleBuilder> inner : entry.getValue().entrySet()) {
 953                 all.add(inner.getValue());
 954             }
 955         }
 956
 957         List<ModuleBuilder> sorted;
 958         if (context == null) {
 959             sorted = ModuleDependencySort.sort(all.toArray(new ModuleBuilder[all.size()]));
 960         } else {
 961             sorted = ModuleDependencySort.sortWithContext(context, all.toArray(new ModuleBuilder[all.size()]));
 962         }
 963
 964         for (ModuleBuilder mb : sorted) {
 965             if (mb != null) {
 966                 List<AugmentationSchemaBuilder> augments = mb.getAllAugments();
 967                 checkAugmentMandatoryNodes(augments);
 968                 Collections.sort(augments, Comparators.AUGMENT_COMP);
 969                 for (AugmentationSchemaBuilder augment : augments) {
 970                     if (!(augment.isResolved())) {
 971                         boolean resolved = resolveAugment(augment, mb, modules, context);
 972                         if (!resolved) {
 973                             throw new YangParseException(augment.getModuleName(), augment.getLine(),
 974                                     "Error in augment parsing: failed to find augment target: " + augment);
 975                         }
 976                     }
 977                 }
 978             }
 979         }
 980     }
 981
 982     /**
 983      * Perform augmentation defined under uses statement.
 984      *
 985      * @param augment
 986      *            augment to resolve
 987      * @param module
 988      *            current module
 989      * @param modules
 990      *            all loaded modules
 991      * @param context
 992      *            SchemaContext containing already resolved modules
 993      * @return true if augment process succeed
 994      */
 995     private boolean resolveUsesAugment(final AugmentationSchemaBuilder augment, final ModuleBuilder module,
 996             final Map<String, TreeMap<Date, ModuleBuilder>> modules, final SchemaContext context) {
 997         if (augment.isResolved()) {
 998             return true;
 999         }
1000
1001         UsesNodeBuilder usesNode = (UsesNodeBuilder) augment.getParent();
1002         DataNodeContainerBuilder parentNode = usesNode.getParent();
1003         Optional<SchemaNodeBuilder> potentialTargetNode;
1004         SchemaPath resolvedTargetPath = augment.getTargetNodeSchemaPath();
1005         if (parentNode instanceof ModuleBuilder && resolvedTargetPath.isAbsolute()) {
1006             // Uses is directly used in module body, we lookup
1007             // We lookup in data namespace to find correct augmentation target
1008             potentialTargetNode = findSchemaNodeInModule(resolvedTargetPath, (ModuleBuilder) parentNode);
1009         } else {
1010             // Uses is used in local context (be it data namespace or grouping namespace,
1011             // since all nodes via uses are imported to localName, it is safe to
1012             // to proceed only with local names.
1013             //
1014             // Conflicting elements in other namespaces are still not present
1015             // since resolveUsesAugment occurs before augmenting from external modules.
1016             potentialTargetNode = Optional.<SchemaNodeBuilder> fromNullable(findSchemaNode(augment.getTargetPath()
1017                     .getPath(), (SchemaNodeBuilder) parentNode));
1018         }
1019
1020         if (potentialTargetNode.isPresent()) {
1021             SchemaNodeBuilder targetNode = potentialTargetNode.get();
1022             if (targetNode instanceof AugmentationTargetBuilder) {
1023                 fillAugmentTarget(augment, targetNode);
1024                 ((AugmentationTargetBuilder) targetNode).addAugmentation(augment);
1025                 augment.setResolved(true);
1026                 return true;
1027             } else {
1028                 throw new YangParseException(module.getName(), augment.getLine(), String.format(
1029                         "Failed to resolve augment in uses. Invalid augment target: %s", potentialTargetNode));
1030             }
1031         } else {
1032             throw new YangParseException(module.getName(), augment.getLine(), String.format(
1033                     "Failed to resolve augment in uses. Invalid augment target path: %s", augment.getTargetPath()));
1034         }
1035
1036     }
1037
1038     /**
1039      * Find augment target module and perform augmentation.
1040      *
1041      * @param augment
1042      *            augment to resolve
1043      * @param module
1044      *            current module
1045      * @param modules
1046      *            all loaded modules
1047      * @param context
1048      *            SchemaContext containing already resolved modules
1049      * @return true if augment process succeed
1050      */
1051     private boolean resolveAugment(final AugmentationSchemaBuilder augment, final ModuleBuilder module,
1052             final Map<String, TreeMap<Date, ModuleBuilder>> modules, final SchemaContext context) {
1053         if (augment.isResolved()) {
1054             return true;
1055         }
1056
1057         QName targetPath = augment.getTargetPath().getPathFromRoot().iterator().next();
1058         ModuleBuilder targetModule = findTargetModule(targetPath, module, modules, context, augment.getLine());
1059         if (targetModule == null) {
1060             throw new YangParseException(module.getModuleName(), augment.getLine(), "Failed to resolve augment "
1061                     + augment);
1062         }
1063
1064         return processAugmentation(augment, targetModule);
1065     }
1066
1067     /**
1068      * Find module from loaded modules or from context based on given qname. If
1069      * module is found in context, create wrapper over this module and add it to
1070      * collection of loaded modules.
1071      *
1072      * @param qname
1073      * @param module
1074      *            current module
1075      * @param modules
1076      *            all loaded modules
1077      * @param context
1078      *            schema context
1079      * @param line
1080      *            current line
1081      * @return
1082      */
1083     private ModuleBuilder findTargetModule(final QName qname, final ModuleBuilder module,
1084             final Map<String, TreeMap<Date, ModuleBuilder>> modules, final SchemaContext context, final int line) {
1085         ModuleBuilder targetModule = null;
1086
1087         String prefix = qname.getPrefix();
1088         if (prefix == null || prefix.equals("")) {
1089             targetModule = module;
1090         } else {
1091             targetModule = findModuleFromBuilders(modules, module, qname.getPrefix(), line);
1092         }
1093
1094         if (targetModule == null && context != null) {
1095             Module m = findModuleFromContext(context, module, prefix, line);
1096             targetModule = new ModuleBuilder(m);
1097             DataSchemaNode firstNode = m.getDataChildByName(qname.getLocalName());
1098             DataSchemaNodeBuilder firstNodeWrapped = wrapChildNode(targetModule.getModuleName(), line, firstNode,
1099                     targetModule.getPath(), firstNode.getQName());
1100             targetModule.addChildNode(firstNodeWrapped);
1101
1102             TreeMap<Date, ModuleBuilder> map = new TreeMap<>();
1103             map.put(targetModule.getRevision(), targetModule);
1104             modules.put(targetModule.getModuleName(), map);
1105         }
1106
1107         return targetModule;
1108     }
1109
1110     private ModuleBuilder findTargetModule(final String prefix, final ModuleBuilder module,
1111             final Map<String, TreeMap<Date, ModuleBuilder>> modules, final SchemaContext context, final int line) {
1112         ModuleBuilder targetModule = null;
1113
1114         if (prefix == null || prefix.equals("")) {
1115             targetModule = module;
1116         } else {
1117             targetModule = findModuleFromBuilders(modules, module, prefix, line);
1118         }
1119
1120         if (targetModule == null && context != null) {
1121             Module m = findModuleFromContext(context, module, prefix, line);
1122             if (m != null) {
1123                 targetModule = new ModuleBuilder(m);
1124                 TreeMap<Date, ModuleBuilder> map = new TreeMap<>();
1125                 map.put(targetModule.getRevision(), targetModule);
1126                 modules.put(targetModule.getModuleName(), map);
1127             }
1128         }
1129
1130         return targetModule;
1131     }
1132
1133     /**
1134      * Go through identity statements defined in current module and resolve
1135      * their 'base' statement if present.
1136      *
1137      * @param modules
1138      *            all modules
1139      * @param module
1140      *            module being resolved
1141      */
1142     private void resolveIdentities(final Map<String, TreeMap<Date, ModuleBuilder>> modules) {
1143         for (Map.Entry<String, TreeMap<Date, ModuleBuilder>> entry : modules.entrySet()) {
1144             for (Map.Entry<Date, ModuleBuilder> inner : entry.getValue().entrySet()) {
1145                 ModuleBuilder module = inner.getValue();
1146                 final Set<IdentitySchemaNodeBuilder> identities = module.getAddedIdentities();
1147                 for (IdentitySchemaNodeBuilder identity : identities) {
1148                     final String baseIdentityName = identity.getBaseIdentityName();
1149                     final int line = identity.getLine();
1150                     if (baseIdentityName != null) {
1151                         IdentitySchemaNodeBuilder baseIdentity = findBaseIdentity(modules, module, baseIdentityName,
1152                                 line);
1153                         if (baseIdentity == null) {
1154                             throw new YangParseException(module.getName(), identity.getLine(),
1155                                     "Failed to find base identity");
1156                         } else {
1157                             identity.setBaseIdentity(baseIdentity);
1158                         }
1159                     }
1160                 }
1161
1162             }
1163         }
1164     }
1165
1166     /**
1167      * Go through identity statements defined in current module and resolve
1168      * their 'base' statement. Method tries to find base identity in given
1169      * modules. If base identity is not found, method will search it in context.
1170      *
1171      * @param modules
1172      *            all loaded modules
1173      * @param module
1174      *            current module
1175      * @param context
1176      *            SchemaContext containing already resolved modules
1177      */
1178     private void resolveIdentitiesWithContext(final Map<String, TreeMap<Date, ModuleBuilder>> modules,
1179             final SchemaContext context) {
1180         for (Map.Entry<String, TreeMap<Date, ModuleBuilder>> entry : modules.entrySet()) {
1181             for (Map.Entry<Date, ModuleBuilder> inner : entry.getValue().entrySet()) {
1182                 ModuleBuilder module = inner.getValue();
1183                 final Set<IdentitySchemaNodeBuilder> identities = module.getAddedIdentities();
1184                 for (IdentitySchemaNodeBuilder identity : identities) {
1185                     final String baseIdentityName = identity.getBaseIdentityName();
1186                     final int line = identity.getLine();
1187                     if (baseIdentityName != null) {
1188
1189                         IdentitySchemaNodeBuilder result = null;
1190                         if (baseIdentityName.contains(":")) {
1191                             String[] splittedBase = baseIdentityName.split(":");
1192                             if (splittedBase.length > 2) {
1193                                 throw new YangParseException(module.getName(), line,
1194                                         "Failed to parse identityref base: " + baseIdentityName);
1195                             }
1196                             String prefix = splittedBase[0];
1197                             String name = splittedBase[1];
1198                             ModuleBuilder dependentModule = findTargetModule(prefix, module, modules, context, line);
1199                             if (dependentModule != null) {
1200                                 result = ParserUtils.findIdentity(dependentModule.getAddedIdentities(), name);
1201                             }
1202                         } else {
1203                             result = ParserUtils.findIdentity(module.getAddedIdentities(), baseIdentityName);
1204                         }
1205                         identity.setBaseIdentity(result);
1206                     }
1207                 }
1208             }
1209         }
1210     }
1211
1212     /**
1213      * Find and add reference of uses target grouping.
1214      *
1215      * @param modules
1216      *            all loaded modules
1217      * @param context
1218      *            SchemaContext containing already resolved modules or null if
1219      *            context is not available
1220      */
1221     private void resolveUsesTargetGrouping(final Map<String, TreeMap<Date, ModuleBuilder>> modules,
1222             final SchemaContext context) {
1223         final List<UsesNodeBuilder> allUses = new ArrayList<>();
1224         for (Map.Entry<String, TreeMap<Date, ModuleBuilder>> entry : modules.entrySet()) {
1225             for (Map.Entry<Date, ModuleBuilder> inner : entry.getValue().entrySet()) {
1226                 allUses.addAll(inner.getValue().getAllUsesNodes());
1227             }
1228         }
1229         for (UsesNodeBuilder usesNode : allUses) {
1230             ModuleBuilder module = ParserUtils.getParentModule(usesNode);
1231             final GroupingBuilder targetGroupingBuilder = GroupingUtils.getTargetGroupingFromModules(usesNode, modules,
1232                     module);
1233             if (targetGroupingBuilder == null) {
1234                 if (context == null) {
1235                     throw new YangParseException(module.getName(), usesNode.getLine(), "Referenced grouping '"
1236                             + usesNode.getGroupingPathAsString() + "' not found.");
1237                 } else {
1238                     GroupingDefinition targetGroupingDefinition = GroupingUtils.getTargetGroupingFromContext(usesNode,
1239                             module, context);
1240                     usesNode.setGroupingDefinition(targetGroupingDefinition);
1241                 }
1242             } else {
1243                 usesNode.setGrouping(targetGroupingBuilder);
1244             }
1245         }
1246     }
1247
1248     /**
1249      * Resolve uses statements defined in groupings.
1250      *
1251      * @param modules
1252      *            all loaded modules
1253      * @param context
1254      *            SchemaContext containing already resolved modules
1255      */
1256     private void resolveUsesForGroupings(final Map<String, TreeMap<Date, ModuleBuilder>> modules,
1257             final SchemaContext context) {
1258         final Set<GroupingBuilder> allGroupings = new HashSet<>();
1259         for (Map.Entry<String, TreeMap<Date, ModuleBuilder>> entry : modules.entrySet()) {
1260             for (Map.Entry<Date, ModuleBuilder> inner : entry.getValue().entrySet()) {
1261                 ModuleBuilder module = inner.getValue();
1262                 allGroupings.addAll(module.getAllGroupings());
1263             }
1264         }
1265         final List<GroupingBuilder> sorted = GroupingSort.sort(allGroupings);
1266         for (GroupingBuilder gb : sorted) {
1267             List<UsesNodeBuilder> usesNodes = new ArrayList<>(GroupingSort.getAllUsesNodes(gb));
1268             Collections.sort(usesNodes, new GroupingUtils.UsesComparator());
1269             for (UsesNodeBuilder usesNode : usesNodes) {
1270                 resolveUses(usesNode, modules, context);
1271             }
1272         }
1273     }
1274
1275     /**
1276      * Resolve uses statements.
1277      *
1278      * @param modules
1279      *            all loaded modules
1280      * @param context
1281      *            SchemaContext containing already resolved modules
1282      */
1283     private void resolveUsesForNodes(final Map<String, TreeMap<Date, ModuleBuilder>> modules,
1284             final SchemaContext context) {
1285         for (Map.Entry<String, TreeMap<Date, ModuleBuilder>> entry : modules.entrySet()) {
1286             for (Map.Entry<Date, ModuleBuilder> inner : entry.getValue().entrySet()) {
1287                 ModuleBuilder module = inner.getValue();
1288                 List<UsesNodeBuilder> usesNodes = module.getAllUsesNodes();
1289                 Collections.sort(usesNodes, new GroupingUtils.UsesComparator());
1290                 for (UsesNodeBuilder usesNode : usesNodes) {
1291                     resolveUses(usesNode, modules, context);
1292                 }
1293             }
1294         }
1295     }
1296
1297     /**
1298      * Find target grouping and copy its child nodes to current location with
1299      * new namespace.
1300      *
1301      * @param usesNode
1302      *            uses node to resolve
1303      * @param modules
1304      *            all loaded modules
1305      * @param context
1306      *            SchemaContext containing already resolved modules
1307      */
1308     private void resolveUses(final UsesNodeBuilder usesNode, final Map<String, TreeMap<Date, ModuleBuilder>> modules,
1309             final SchemaContext context) {
1310         if (!usesNode.isResolved()) {
1311             DataNodeContainerBuilder parent = usesNode.getParent();
1312             ModuleBuilder module = ParserUtils.getParentModule(parent);
1313             GroupingBuilder target = GroupingUtils.getTargetGroupingFromModules(usesNode, modules, module);
1314             if (target == null) {
1315                 resolveUsesWithContext(usesNode);
1316                 usesNode.setResolved(true);
1317                 for (AugmentationSchemaBuilder augment : usesNode.getAugmentations()) {
1318                     resolveUsesAugment(augment, module, modules, context);
1319                 }
1320             } else {
1321                 parent.getChildNodeBuilders().addAll(target.instantiateChildNodes(parent));
1322                 parent.getTypeDefinitionBuilders().addAll(target.instantiateTypedefs(parent));
1323                 parent.getGroupingBuilders().addAll(target.instantiateGroupings(parent));
1324                 parent.getUnknownNodes().addAll(target.instantiateUnknownNodes(parent));
1325                 usesNode.setResolved(true);
1326                 for (AugmentationSchemaBuilder augment : usesNode.getAugmentations()) {
1327                     resolveUsesAugment(augment, module, modules, context);
1328                 }
1329             }
1330             GroupingUtils.performRefine(usesNode);
1331         }
1332     }
1333
1334     /**
1335      * Copy target grouping child nodes to current location with new namespace.
1336      *
1337      * @param usesNode
1338      *            uses node to resolve
1339      * @param modules
1340      *            all loaded modules
1341      * @param context
1342      *            SchemaContext containing already resolved modules
1343      */
1344     private void resolveUsesWithContext(final UsesNodeBuilder usesNode) {
1345         final int line = usesNode.getLine();
1346         DataNodeContainerBuilder parent = usesNode.getParent();
1347         ModuleBuilder module = ParserUtils.getParentModule(parent);
1348         SchemaPath parentPath;
1349         URI ns = null;
1350         Date rev = null;
1351         String pref = null;
1352         if (parent instanceof AugmentationSchemaBuilder || parent instanceof ModuleBuilder) {
1353             ns = module.getNamespace();
1354             rev = module.getRevision();
1355             pref = module.getPrefix();
1356             if (parent instanceof AugmentationSchemaBuilder) {
1357                 parentPath = ((AugmentationSchemaBuilder) parent).getTargetNodeSchemaPath();
1358             } else {
1359                 parentPath = ((ModuleBuilder) parent).getPath();
1360             }
1361         } else {
1362             ns = ((DataSchemaNodeBuilder) parent).getQName().getNamespace();
1363             rev = ((DataSchemaNodeBuilder) parent).getQName().getRevision();
1364             pref = ((DataSchemaNodeBuilder) parent).getQName().getPrefix();
1365             parentPath = ((DataSchemaNodeBuilder) parent).getPath();
1366         }
1367
1368         GroupingDefinition gd = usesNode.getGroupingDefinition();
1369
1370         Set<DataSchemaNodeBuilder> childNodes = wrapChildNodes(module.getModuleName(), line, gd.getChildNodes(),
1371                 parentPath, ns, rev, pref);
1372         parent.getChildNodeBuilders().addAll(childNodes);
1373         for (DataSchemaNodeBuilder childNode : childNodes) {
1374             setNodeAddedByUses(childNode);
1375         }
1376
1377         Set<TypeDefinitionBuilder> typedefs = wrapTypedefs(module.getModuleName(), line, gd, parentPath, ns, rev, pref);
1378         parent.getTypeDefinitionBuilders().addAll(typedefs);
1379         for (TypeDefinitionBuilder typedef : typedefs) {
1380             setNodeAddedByUses(typedef);
1381         }
1382
1383         Set<GroupingBuilder> groupings = wrapGroupings(module.getModuleName(), line, usesNode.getGroupingDefinition()
1384                 .getGroupings(), parentPath, ns, rev, pref);
1385         parent.getGroupingBuilders().addAll(groupings);
1386         for (GroupingBuilder gb : groupings) {
1387             setNodeAddedByUses(gb);
1388         }
1389
1390         List<UnknownSchemaNodeBuilder> unknownNodes = wrapUnknownNodes(module.getModuleName(), line,
1391                 gd.getUnknownSchemaNodes(), parentPath, ns, rev, pref);
1392         parent.getUnknownNodes().addAll(unknownNodes);
1393         for (UnknownSchemaNodeBuilder un : unknownNodes) {
1394             un.setAddedByUses(true);
1395         }
1396     }
1397
1398     /**
1399      * Try to find extension builder describing this unknown node and assign it
1400      * to unknown node builder.
1401      *
1402      * @param modules
1403      *            all loaded modules
1404      * @param module
1405      *            current module
1406      */
1407     private void resolveUnknownNodes(final Map<String, TreeMap<Date, ModuleBuilder>> modules, final ModuleBuilder module) {
1408         for (UnknownSchemaNodeBuilder usnb : module.getAllUnknownNodes()) {
1409             QName nodeType = usnb.getNodeType();
1410             try {
1411                 ModuleBuilder dependentModule = findModuleFromBuilders(modules, module, nodeType.getPrefix(),
1412                         usnb.getLine());
1413                 for (ExtensionBuilder extension : dependentModule.getAddedExtensions()) {
1414                     if (extension.getQName().getLocalName().equals(nodeType.getLocalName())) {
1415                         usnb.setNodeType(extension.getQName());
1416                         usnb.setExtensionBuilder(extension);
1417                         break;
1418                     }
1419                 }
1420             } catch (YangParseException e) {
1421                 throw new YangParseException(module.getName(), usnb.getLine(), "Failed to resolve node " + usnb
1422                         + ": no such extension definition found.", e);
1423             }
1424         }
1425     }
1426
1427     /**
1428      * Try to find extension builder describing this unknown node and assign it
1429      * to unknown node builder. If extension is not found in loaded modules, try
1430      * to find it in context.
1431      *
1432      * @param modules
1433      *            all loaded modules
1434      * @param module
1435      *            current module
1436      * @param context
1437      *            SchemaContext containing already resolved modules
1438      */
1439     private void resolveUnknownNodesWithContext(final Map<String, TreeMap<Date, ModuleBuilder>> modules,
1440             final ModuleBuilder module, final SchemaContext context) {
1441         for (UnknownSchemaNodeBuilder usnb : module.getAllUnknownNodes()) {
1442             QName nodeType = usnb.getNodeType();
1443             try {
1444                 ModuleBuilder dependentModuleBuilder = findModuleFromBuilders(modules, module, nodeType.getPrefix(),
1445                         usnb.getLine());
1446
1447                 if (dependentModuleBuilder == null) {
1448                     Module dependentModule = findModuleFromContext(context, module, nodeType.getPrefix(),
1449                             usnb.getLine());
1450                     for (ExtensionDefinition e : dependentModule.getExtensionSchemaNodes()) {
1451                         if (e.getQName().getLocalName().equals(nodeType.getLocalName())) {
1452                             usnb.setNodeType(new QName(e.getQName().getNamespace(), e.getQName().getRevision(),
1453                                     nodeType.getPrefix(), e.getQName().getLocalName()));
1454                             usnb.setExtensionDefinition(e);
1455                             break;
1456                         }
1457                     }
1458                 } else {
1459                     for (ExtensionBuilder extension : dependentModuleBuilder.getAddedExtensions()) {
1460                         if (extension.getQName().getLocalName().equals(nodeType.getLocalName())) {
1461                             usnb.setExtensionBuilder(extension);
1462                             break;
1463                         }
1464                     }
1465                 }
1466
1467             } catch (YangParseException e) {
1468                 throw new YangParseException(module.getName(), usnb.getLine(), "Failed to resolve node " + usnb
1469                         + ": no such extension definition found.", e);
1470             }
1471
1472         }
1473     }
1474
1475     /**
1476      * Traverse through modules and resolve their deviation statements.
1477      *
1478      * @param modules
1479      *            all loaded modules
1480      */
1481     private void resolveDeviations(final Map<String, TreeMap<Date, ModuleBuilder>> modules) {
1482         for (Map.Entry<String, TreeMap<Date, ModuleBuilder>> entry : modules.entrySet()) {
1483             for (Map.Entry<Date, ModuleBuilder> inner : entry.getValue().entrySet()) {
1484                 ModuleBuilder b = inner.getValue();
1485                 resolveDeviation(modules, b);
1486             }
1487         }
1488     }
1489
1490     /**
1491      * Traverse through module and resolve its deviation statements.
1492      *
1493      * @param modules
1494      *            all loaded modules
1495      * @param module
1496      *            module in which resolve deviations
1497      */
1498     private void resolveDeviation(final Map<String, TreeMap<Date, ModuleBuilder>> modules, final ModuleBuilder module) {
1499         for (DeviationBuilder dev : module.getDeviationBuilders()) {
1500             int line = dev.getLine();
1501             SchemaPath targetPath = dev.getTargetPath();
1502             Iterable<QName> path = targetPath.getPathFromRoot();
1503             QName q0 = path.iterator().next();
1504             String prefix = q0.getPrefix();
1505             if (prefix == null) {
1506                 prefix = module.getPrefix();
1507             }
1508
1509             ModuleBuilder dependentModuleBuilder = findModuleFromBuilders(modules, module, prefix, line);
1510             processDeviation(dev, dependentModuleBuilder, path, module);
1511         }
1512     }
1513
1514     /**
1515      * Traverse through modules and resolve their deviation statements with
1516      * given context.
1517      *
1518      * @param modules
1519      *            all loaded modules
1520      * @param context
1521      *            already resolved context
1522      */
1523     private void resolveDeviationsWithContext(final Map<String, TreeMap<Date, ModuleBuilder>> modules,
1524             final SchemaContext context) {
1525         for (Map.Entry<String, TreeMap<Date, ModuleBuilder>> entry : modules.entrySet()) {
1526             for (Map.Entry<Date, ModuleBuilder> inner : entry.getValue().entrySet()) {
1527                 ModuleBuilder b = inner.getValue();
1528                 resolveDeviationWithContext(modules, b, context);
1529             }
1530         }
1531     }
1532
1533     /**
1534      * Traverse through module and resolve its deviation statements with given
1535      * context.
1536      *
1537      * @param modules
1538      *            all loaded modules
1539      * @param module
1540      *            module in which resolve deviations
1541      * @param context
1542      *            already resolved context
1543      */
1544     private void resolveDeviationWithContext(final Map<String, TreeMap<Date, ModuleBuilder>> modules,
1545             final ModuleBuilder module, final SchemaContext context) {
1546         for (DeviationBuilder dev : module.getDeviationBuilders()) {
1547             int line = dev.getLine();
1548             SchemaPath targetPath = dev.getTargetPath();
1549             Iterable<QName> path = targetPath.getPathFromRoot();
1550             QName q0 = path.iterator().next();
1551             String prefix = q0.getPrefix();
1552             if (prefix == null) {
1553                 prefix = module.getPrefix();
1554             }
1555
1556             ModuleBuilder dependentModuleBuilder = findModuleFromBuilders(modules, module, prefix, line);
1557             if (dependentModuleBuilder == null) {
1558                 Object currentParent = findModuleFromContext(context, module, prefix, line);
1559
1560                 for (QName q : path) {
1561                     if (currentParent == null) {
1562                         throw new YangParseException(module.getName(), line, FAIL_DEVIATION_TARGET);
1563                     }
1564                     String name = q.getLocalName();
1565                     if (currentParent instanceof DataNodeContainer) {
1566                         currentParent = ((DataNodeContainer) currentParent).getDataChildByName(name);
1567                     }
1568                 }
1569
1570                 if (currentParent == null) {
1571                     throw new YangParseException(module.getName(), line, FAIL_DEVIATION_TARGET);
1572                 }
1573                 if (currentParent instanceof SchemaNode) {
1574                     dev.setTargetPath(((SchemaNode) currentParent).getPath());
1575                 }
1576
1577             } else {
1578                 processDeviation(dev, dependentModuleBuilder, path, module);
1579             }
1580         }
1581     }
1582
1583     /**
1584      * Correct deviation target path in deviation builder.
1585      *
1586      * @param dev
1587      *            deviation
1588      * @param dependentModuleBuilder
1589      *            module containing deviation target
1590      * @param path
1591      *            current deviation target path
1592      * @param module
1593      *            current module
1594      */
1595     private void processDeviation(final DeviationBuilder dev, final ModuleBuilder dependentModuleBuilder,
1596             final Iterable<QName> path, final ModuleBuilder module) {
1597         final int line = dev.getLine();
1598         Builder currentParent = dependentModuleBuilder;
1599
1600         for (QName q : path) {
1601             if (currentParent == null) {
1602                 throw new YangParseException(module.getName(), line, FAIL_DEVIATION_TARGET);
1603             }
1604             String name = q.getLocalName();
1605             if (currentParent instanceof DataNodeContainerBuilder) {
1606                 currentParent = ((DataNodeContainerBuilder) currentParent).getDataChildByName(name);
1607             }
1608         }
1609
1610         if (!(currentParent instanceof SchemaNodeBuilder)) {
1611             throw new YangParseException(module.getName(), line, FAIL_DEVIATION_TARGET);
1612         }
1613         dev.setTargetPath(((SchemaNodeBuilder) currentParent).getPath());
1614     }
1615
1616 }