2 * Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved.
4 * This program and the accompanying materials are made available under the
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
8 package org.opendaylight.yangtools.yang.parser.rfc7950.repo;
10 import static com.google.common.base.Preconditions.checkArgument;
11 import static java.util.Objects.requireNonNull;
13 import com.google.common.annotations.VisibleForTesting;
14 import com.google.common.base.Splitter;
15 import com.google.common.base.Strings;
16 import com.google.common.collect.ImmutableSet;
17 import java.io.IOException;
18 import java.util.HashSet;
19 import java.util.List;
20 import java.util.Objects;
21 import java.util.Optional;
23 import org.antlr.v4.runtime.ParserRuleContext;
24 import org.eclipse.jdt.annotation.NonNull;
25 import org.eclipse.jdt.annotation.Nullable;
26 import org.opendaylight.yangtools.concepts.SemVer;
27 import org.opendaylight.yangtools.openconfig.model.api.OpenConfigStatements;
28 import org.opendaylight.yangtools.yang.common.QName;
29 import org.opendaylight.yangtools.yang.common.Revision;
30 import org.opendaylight.yangtools.yang.model.api.ModuleImport;
31 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
32 import org.opendaylight.yangtools.yang.model.parser.api.YangSyntaxErrorException;
33 import org.opendaylight.yangtools.yang.model.repo.api.SourceIdentifier;
34 import org.opendaylight.yangtools.yang.model.repo.api.YangTextSchemaSource;
35 import org.opendaylight.yangtools.yang.parser.antlr.YangStatementParser.ArgumentContext;
36 import org.opendaylight.yangtools.yang.parser.antlr.YangStatementParser.StatementContext;
37 import org.opendaylight.yangtools.yang.parser.spi.source.DeclarationInTextSource;
38 import org.opendaylight.yangtools.yang.parser.spi.source.StatementSourceReference;
41 * Helper transfer object which holds basic and dependency information for YANG
45 * There are two concrete implementations of this interface:
47 * <li>{@link ModuleDependencyInfo} - Dependency information for module</li>
48 * <li>{@link SubmoduleDependencyInfo} - Dependency information for submodule</li>
51 * @see ModuleDependencyInfo
52 * @see SubmoduleDependencyInfo
54 public abstract class YangModelDependencyInfo {
55 private static final String BELONGS_TO = YangStmtMapping.BELONGS_TO.getStatementName().getLocalName();
56 private static final String IMPORT = YangStmtMapping.IMPORT.getStatementName().getLocalName();
57 private static final String INCLUDE = YangStmtMapping.INCLUDE.getStatementName().getLocalName();
58 private static final String MODULE = YangStmtMapping.MODULE.getStatementName().getLocalName();
59 private static final String REVISION = YangStmtMapping.REVISION.getStatementName().getLocalName();
60 private static final String REVISION_DATE = YangStmtMapping.REVISION_DATE.getStatementName().getLocalName();
61 private static final String SUBMODULE = YangStmtMapping.SUBMODULE.getStatementName().getLocalName();
63 private static final String OPENCONFIG_VERSION = OpenConfigStatements.OPENCONFIG_VERSION.getStatementName()
65 private static final Splitter COLON_SPLITTER = Splitter.on(":").omitEmptyStrings().trimResults();
67 private final String name;
68 private final Revision revision;
69 private final SemVer semVer;
70 private final ImmutableSet<ModuleImport> submoduleIncludes;
71 private final ImmutableSet<ModuleImport> moduleImports;
72 private final ImmutableSet<ModuleImport> dependencies;
74 YangModelDependencyInfo(final String name, final String formattedRevision,
75 final ImmutableSet<ModuleImport> imports,
76 final ImmutableSet<ModuleImport> includes) {
77 this(name, formattedRevision, imports, includes, Optional.empty());
80 YangModelDependencyInfo(final String name, final String formattedRevision,
81 final ImmutableSet<ModuleImport> imports,
82 final ImmutableSet<ModuleImport> includes,
83 final Optional<SemVer> semVer) {
85 this.revision = Revision.ofNullable(formattedRevision).orElse(null);
86 this.moduleImports = imports;
87 this.submoduleIncludes = includes;
88 this.dependencies = ImmutableSet.<ModuleImport>builder()
89 .addAll(moduleImports).addAll(submoduleIncludes).build();
90 this.semVer = semVer.orElse(null);
94 * Returns immutable collection of all module imports. This collection contains both <code>import</code> statements
95 * and <code>include</code> statements for submodules.
97 * @return Immutable collection of imports.
99 public ImmutableSet<ModuleImport> getDependencies() {
104 * Returns model name.
108 public String getName() {
113 * Returns formatted revision string.
115 * @return formatted revision string
117 public String getFormattedRevision() {
118 return revision != null ? revision.toString() : null;
124 * @return revision, potentially null
126 public Optional<Revision> getRevision() {
127 return Optional.ofNullable(revision);
131 * Returns semantic version of module.
133 * @return semantic version
135 public Optional<SemVer> getSemanticVersion() {
136 return Optional.ofNullable(semVer);
140 public int hashCode() {
141 final int prime = 31;
143 result = prime * result + Objects.hashCode(name);
144 result = prime * result + Objects.hashCode(revision);
145 result = prime * result + Objects.hashCode(semVer);
150 public boolean equals(final Object obj) {
157 if (!(obj instanceof YangModelDependencyInfo)) {
160 final YangModelDependencyInfo other = (YangModelDependencyInfo) obj;
161 return Objects.equals(name, other.name) && Objects.equals(revision, other.revision)
162 && Objects.equals(semVer, other.semVer);
166 * Extracts {@link YangModelDependencyInfo} from an abstract syntax tree of a YANG model.
168 * @param source Source identifier
169 * @param tree Abstract syntax tree
170 * @return {@link YangModelDependencyInfo}
171 * @throws YangSyntaxErrorException If the AST is not a valid YANG module/submodule
173 static @NonNull YangModelDependencyInfo fromAST(final SourceIdentifier source, final ParserRuleContext tree)
174 throws YangSyntaxErrorException {
176 if (tree instanceof StatementContext) {
177 final StatementContext rootStatement = (StatementContext) tree;
178 return parseAST(rootStatement, source);
181 throw new YangSyntaxErrorException(source, 0, 0, "Unknown YANG text type");
184 private static @NonNull YangModelDependencyInfo parseAST(final StatementContext rootStatement,
185 final SourceIdentifier source) {
186 final String keyWordText = rootStatement.keyword().getText();
187 if (MODULE.equals(keyWordText)) {
188 return parseModuleContext(rootStatement, source);
190 if (SUBMODULE.equals(keyWordText)) {
191 return parseSubmoduleContext(rootStatement, source);
193 throw new IllegalArgumentException("Root of parsed AST must be either module or submodule");
197 * Extracts {@link YangModelDependencyInfo} from input stream containing a YANG model. This parsing does not
198 * validate full YANG module, only parses header up to the revisions and imports.
200 * @param refClass Base search class
201 * @param resourceName resource name, relative to refClass
202 * @return {@link YangModelDependencyInfo}
203 * @throws YangSyntaxErrorException If the resource does not pass syntactic analysis
204 * @throws IOException When the resource cannot be read
205 * @throws IllegalArgumentException
206 * If input stream is not valid YANG stream
209 public static YangModelDependencyInfo forResource(final Class<?> refClass, final String resourceName)
210 throws IOException, YangSyntaxErrorException {
211 final YangStatementStreamSource source = YangStatementStreamSource.create(
212 YangTextSchemaSource.forResource(refClass, resourceName));
213 return parseAST(source.statementContext(), source.getIdentifier());
216 private static @NonNull YangModelDependencyInfo parseModuleContext(final StatementContext module,
217 final SourceIdentifier source) {
218 final String name = safeStringArgument(source, module, "module name");
219 final String latestRevision = getLatestRevision(module, source);
220 final Optional<SemVer> semVer = Optional.ofNullable(findSemanticVersion(module, source));
221 final ImmutableSet<ModuleImport> imports = parseImports(module, source);
222 final ImmutableSet<ModuleImport> includes = parseIncludes(module, source);
224 return new ModuleDependencyInfo(name, latestRevision, imports, includes, semVer);
227 private static ImmutableSet<ModuleImport> parseImports(final StatementContext module,
228 final SourceIdentifier source) {
229 final Set<ModuleImport> result = new HashSet<>();
230 for (final StatementContext subStatementContext : module.statement()) {
231 if (IMPORT.equals(subStatementContext.keyword().getText())) {
232 final String importedModuleName = safeStringArgument(source, subStatementContext,
233 "imported module name");
234 final String revisionDateStr = getRevisionDateString(subStatementContext, source);
235 final Revision revisionDate = Revision.ofNullable(revisionDateStr).orElse(null);
236 final SemVer importSemVer = findSemanticVersion(subStatementContext, source);
237 result.add(new ModuleImportImpl(importedModuleName, revisionDate, importSemVer));
240 return ImmutableSet.copyOf(result);
243 private static SemVer findSemanticVersion(final StatementContext statement, final SourceIdentifier source) {
244 String semVerString = null;
245 for (final StatementContext subStatement : statement.statement()) {
246 final String subStatementName = trimPrefix(subStatement.keyword().getText());
247 if (OPENCONFIG_VERSION.equals(subStatementName)) {
248 semVerString = safeStringArgument(source, subStatement, "version string");
253 return Strings.isNullOrEmpty(semVerString) ? null : SemVer.valueOf(semVerString);
257 private static String trimPrefix(final String identifier) {
258 final List<String> namesParts = COLON_SPLITTER.splitToList(identifier);
259 if (namesParts.size() == 2) {
260 return namesParts.get(1);
266 private static ImmutableSet<ModuleImport> parseIncludes(final StatementContext module,
267 final SourceIdentifier source) {
268 final Set<ModuleImport> result = new HashSet<>();
269 for (final StatementContext subStatementContext : module.statement()) {
270 if (INCLUDE.equals(subStatementContext.keyword().getText())) {
271 final String revisionDateStr = getRevisionDateString(subStatementContext, source);
272 final String IncludeModuleName = safeStringArgument(source, subStatementContext,
273 "included submodule name");
274 final Revision revisionDate = Revision.ofNullable(revisionDateStr).orElse(null);
275 result.add(new ModuleImportImpl(IncludeModuleName, revisionDate));
278 return ImmutableSet.copyOf(result);
281 private static String getRevisionDateString(final StatementContext importStatement, final SourceIdentifier source) {
282 String revisionDateStr = null;
283 for (final StatementContext importSubStatement : importStatement.statement()) {
284 if (REVISION_DATE.equals(importSubStatement.keyword().getText())) {
285 revisionDateStr = safeStringArgument(source, importSubStatement, "imported module revision-date");
288 return revisionDateStr;
291 public static String getLatestRevision(final StatementContext module, final SourceIdentifier source) {
292 String latestRevision = null;
293 for (final StatementContext subStatementContext : module.statement()) {
294 if (REVISION.equals(subStatementContext.keyword().getText())) {
295 final String currentRevision = safeStringArgument(source, subStatementContext, "revision date");
296 if (latestRevision == null || latestRevision.compareTo(currentRevision) < 0) {
297 latestRevision = currentRevision;
301 return latestRevision;
304 private static @NonNull YangModelDependencyInfo parseSubmoduleContext(final StatementContext submodule,
305 final SourceIdentifier source) {
306 final String name = safeStringArgument(source, submodule, "submodule name");
307 final String belongsTo = parseBelongsTo(submodule, source);
309 final String latestRevision = getLatestRevision(submodule, source);
310 final ImmutableSet<ModuleImport> imports = parseImports(submodule, source);
311 final ImmutableSet<ModuleImport> includes = parseIncludes(submodule, source);
313 return new SubmoduleDependencyInfo(name, latestRevision, belongsTo, imports, includes);
316 private static String parseBelongsTo(final StatementContext submodule, final SourceIdentifier source) {
317 for (final StatementContext subStatementContext : submodule.statement()) {
318 if (BELONGS_TO.equals(subStatementContext.keyword().getText())) {
319 return safeStringArgument(source, subStatementContext, "belongs-to module name");
325 private static String safeStringArgument(final SourceIdentifier source, final StatementContext stmt,
327 final StatementSourceReference ref = getReference(source, stmt);
328 final ArgumentContext arg = stmt.argument();
329 checkArgument(arg != null, "Missing %s at %s", desc, ref);
330 // TODO: we probably need to understand yang version first....
331 return ArgumentContextUtils.rfc6020().stringFromStringContext(arg, ref);
334 private static StatementSourceReference getReference(final SourceIdentifier source,
335 final StatementContext context) {
336 return DeclarationInTextSource.atPosition(source.getName(), context.getStart().getLine(),
337 context.getStart().getCharPositionInLine());
341 * Dependency information for YANG module.
343 public static final class ModuleDependencyInfo extends YangModelDependencyInfo {
344 ModuleDependencyInfo(final String name, final String latestRevision, final ImmutableSet<ModuleImport> imports,
345 final ImmutableSet<ModuleImport> includes, final Optional<SemVer> semVer) {
346 super(name, latestRevision, imports, includes, semVer);
350 public String toString() {
351 return "Module [name=" + getName() + ", revision=" + getRevision()
352 + ", semanticVersion=" + getSemanticVersion().orElse(null)
353 + ", dependencies=" + getDependencies()
359 * Dependency information for submodule, also provides name for parent module.
361 public static final class SubmoduleDependencyInfo extends YangModelDependencyInfo {
362 private final String belongsTo;
364 private SubmoduleDependencyInfo(final String name, final String latestRevision, final String belongsTo,
365 final ImmutableSet<ModuleImport> imports, final ImmutableSet<ModuleImport> includes) {
366 super(name, latestRevision, imports, includes);
367 this.belongsTo = belongsTo;
371 * Returns name of parent module.
373 public String getParentModule() {
378 public String toString() {
379 return "Submodule [name=" + getName() + ", revision="
380 + getRevision() + ", dependencies=" + getDependencies()
386 * Utility implementation of {@link ModuleImport} to be used by {@link YangModelDependencyInfo}.
388 private static final class ModuleImportImpl implements ModuleImport {
390 private final Revision revision;
391 private final SemVer semVer;
392 private final String name;
394 ModuleImportImpl(final @NonNull String moduleName, final @Nullable Revision revision) {
395 this(moduleName, revision, null);
398 ModuleImportImpl(final @NonNull String moduleName, final @Nullable Revision revision,
399 final @Nullable SemVer semVer) {
400 this.name = requireNonNull(moduleName, "Module name must not be null.");
401 this.revision = revision;
402 this.semVer = semVer;
406 public String getModuleName() {
411 public Optional<Revision> getRevision() {
412 return Optional.ofNullable(revision);
416 public Optional<SemVer> getSemanticVersion() {
417 return Optional.ofNullable(semVer);
421 public String getPrefix() {
426 public Optional<String> getDescription() {
427 return Optional.empty();
431 public Optional<String> getReference() {
432 return Optional.empty();
436 public int hashCode() {
437 final int prime = 31;
439 result = prime * result + Objects.hashCode(name);
440 result = prime * result + Objects.hashCode(revision);
441 result = prime * result + Objects.hashCode(semVer);
446 public boolean equals(final Object obj) {
450 if (!(obj instanceof ModuleImportImpl)) {
453 final ModuleImportImpl other = (ModuleImportImpl) obj;
454 return name.equals(other.name) && Objects.equals(revision, other.revision)
455 && Objects.equals(getSemanticVersion(), other.getSemanticVersion());
459 public String toString() {
460 return "ModuleImportImpl [name=" + name + ", revision="
461 + QName.formattedRevision(Optional.ofNullable(revision)) + ", semanticVersion=" + semVer + "]";