2 * Copyright (c) 2014 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/eplv10.html
7 package org.opendaylight.yangtools.yang.parser.impl.util;
9 import static org.opendaylight.yangtools.yang.parser.impl.ParserListenerUtils.getArgumentString;
10 import static org.opendaylight.yangtools.yang.parser.impl.ParserListenerUtils.getFirstContext;
12 import java.io.InputStream;
13 import java.util.Date;
14 import java.util.List;
16 import org.opendaylight.yangtools.antlrv4.code.gen.YangParser.Belongs_to_stmtContext;
17 import org.opendaylight.yangtools.antlrv4.code.gen.YangParser.Import_stmtContext;
18 import org.opendaylight.yangtools.antlrv4.code.gen.YangParser.Include_stmtContext;
19 import org.opendaylight.yangtools.antlrv4.code.gen.YangParser.Module_stmtContext;
20 import org.opendaylight.yangtools.antlrv4.code.gen.YangParser.Revision_date_stmtContext;
21 import org.opendaylight.yangtools.antlrv4.code.gen.YangParser.Revision_stmtContext;
22 import org.opendaylight.yangtools.antlrv4.code.gen.YangParser.Revision_stmtsContext;
23 import org.opendaylight.yangtools.antlrv4.code.gen.YangParser.Submodule_stmtContext;
24 import org.opendaylight.yangtools.antlrv4.code.gen.YangParser.YangContext;
25 import org.opendaylight.yangtools.yang.common.QName;
26 import org.opendaylight.yangtools.yang.model.api.ModuleImport;
27 import org.opendaylight.yangtools.yang.parser.impl.YangParserImpl;
29 import com.google.common.base.Optional;
30 import com.google.common.collect.ImmutableSet;
33 * Helper transfer object which holds basic and dependency information for YANG
38 * There are two concrete implementations of this interface:
40 * <li>{@link ModuleDependencyInfo} - Dependency information for module</li>
41 * <li>{@link SubmoduleDependencyInfo} - Dependency information for submodule</li>
44 * @see ModuleDependencyInfo
45 * @see SubmoduleDependencyInfo
48 public abstract class YangModelDependencyInfo {
50 private final String name;
51 private final String formattedRevision;
52 private final Date revision;
53 private final ImmutableSet<ModuleImport> submoduleIncludes;
54 private final ImmutableSet<ModuleImport> moduleImports;
55 private final ImmutableSet<ModuleImport> dependencies;
57 protected YangModelDependencyInfo(final String name, final String formattedRevision,
58 final ImmutableSet<ModuleImport> imports, final ImmutableSet<ModuleImport> includes) {
60 this.formattedRevision = formattedRevision;
61 this.revision = QName.parseRevision(formattedRevision);
62 this.moduleImports = imports;
63 this.submoduleIncludes = includes;
64 this.dependencies = ImmutableSet.<ModuleImport> builder() //
65 .addAll(moduleImports) //
66 .addAll(submoduleIncludes) //
71 * Returns immutable collection of all module imports.
73 * This collection contains both <code>import</code> statements
74 * and <code>include</code> statements for submodules.
76 * @return Immutable collection of imports.
78 public ImmutableSet<ModuleImport> getDependencies() {
87 public String getName() {
92 * Returns formatted revision string
94 * @return formatted revision string
96 public String getFormattedRevision() {
97 return formattedRevision;
105 public Date getRevision() {
110 public int hashCode() {
111 final int prime = 31;
113 result = prime * result + ((formattedRevision == null) ? 0 : formattedRevision.hashCode());
114 result = prime * result + ((name == null) ? 0 : name.hashCode());
119 public boolean equals(final Object obj) {
126 if (!(obj instanceof YangModelDependencyInfo)) {
129 YangModelDependencyInfo other = (YangModelDependencyInfo) obj;
130 if (formattedRevision == null) {
131 if (other.formattedRevision != null) {
134 } else if (!formattedRevision.equals(other.formattedRevision)) {
138 if (other.name != null) {
141 } else if (!name.equals(other.name)) {
148 * Extracts {@link YangModelDependencyInfo} from input stream
149 * containing YANG model.
151 * This parsing does not validate full YANG module, only
152 * parses header up to the revisions and imports.
155 * Opened Input stream containing text source of YANG model
156 * @return {@link YangModelDependencyInfo}
157 * @throws IllegalArgumentException
158 * If input stream is not valid YANG stream
160 public static YangModelDependencyInfo fromInputStream(final InputStream yangStream) {
161 YangContext yangContext = YangParserImpl.parseStreamWithoutErrorListeners(yangStream);
163 Optional<Module_stmtContext> moduleCtx = getFirstContext(yangContext, Module_stmtContext.class);
164 if (moduleCtx.isPresent()) {
165 return parseModuleContext(moduleCtx.get());
167 Optional<Submodule_stmtContext> submoduleCtx = getFirstContext(yangContext, Submodule_stmtContext.class);
168 if (submoduleCtx.isPresent()) {
169 return parseSubmoduleContext(submoduleCtx.get());
171 throw new IllegalArgumentException("Supplied stream is not valid yang file.");
174 private static YangModelDependencyInfo parseModuleContext(final Module_stmtContext module) {
175 String name = getArgumentString(module);
177 // getArgumentString(module.module_header_stmts().prefix_stmt(0));
178 String namespace = getArgumentString(module.module_header_stmts().namespace_stmt(0));
179 String latestRevision = getLatestRevision(module.revision_stmts());
180 ImmutableSet<ModuleImport> imports = parseImports(module.linkage_stmts().import_stmt());
181 ImmutableSet<ModuleImport> includes = parseIncludes(module.linkage_stmts().include_stmt());
183 return new ModuleDependencyInfo(name, latestRevision, namespace, imports, includes);
186 private static ImmutableSet<ModuleImport> parseImports(final List<Import_stmtContext> importStatements) {
187 ImmutableSet.Builder<ModuleImport> builder = ImmutableSet.builder();
188 for (Import_stmtContext importStmt : importStatements) {
189 String moduleName = getArgumentString(importStmt);
190 Date revision = getRevision(importStmt.revision_date_stmt());
191 builder.add(new ModuleImportImpl(moduleName, revision));
193 return builder.build();
196 private static String getLatestRevision(final Revision_stmtsContext revision_stmts) {
197 List<Revision_stmtContext> revisions = revision_stmts.getRuleContexts(Revision_stmtContext.class);
198 String latestRevision = null;
199 for (Revision_stmtContext revisionStmt : revisions) {
200 String currentRevision = getArgumentString(revisionStmt);
201 if (latestRevision == null || latestRevision.compareTo(currentRevision) == -1) {
202 latestRevision = currentRevision;
205 return latestRevision;
208 private static YangModelDependencyInfo parseSubmoduleContext(final Submodule_stmtContext submodule) {
209 String name = getArgumentString(submodule);
210 Belongs_to_stmtContext belongsToStmt = submodule.submodule_header_stmts().belongs_to_stmt(0);
211 String belongsTo = getArgumentString(belongsToStmt);
213 String latestRevision = getLatestRevision(submodule.revision_stmts());
214 ImmutableSet<ModuleImport> imports = parseImports(submodule.linkage_stmts().import_stmt());
215 ImmutableSet<ModuleImport> includes = parseIncludes(submodule.linkage_stmts().include_stmt());
217 return new SubmoduleDependencyInfo(name, latestRevision, belongsTo, imports, includes);
220 private static ImmutableSet<ModuleImport> parseIncludes(final List<Include_stmtContext> importStatements) {
221 ImmutableSet.Builder<ModuleImport> builder = ImmutableSet.builder();
222 for (Include_stmtContext importStmt : importStatements) {
223 String moduleName = getArgumentString(importStmt);
224 Date revision = getRevision(importStmt.revision_date_stmt());
225 builder.add(new ModuleImportImpl(moduleName, revision));
227 return builder.build();
230 private static Date getRevision(final Revision_date_stmtContext revision_date_stmt) {
231 if (revision_date_stmt == null) {
234 String formatedDate = getArgumentString(revision_date_stmt);
235 return QName.parseRevision(formatedDate);
240 * Dependency information for YANG module.
243 public static final class ModuleDependencyInfo extends YangModelDependencyInfo {
245 private ModuleDependencyInfo(final String name, final String latestRevision, final String namespace,
246 final ImmutableSet<ModuleImport> imports, final ImmutableSet<ModuleImport> includes) {
247 super(name, latestRevision, imports, includes);
251 public String toString() {
252 return "Module [name=" + getName() + ", revision=" + getRevision() + ", dependencies=" + getDependencies()
259 * Dependency information for submodule, also provides name
263 public static final class SubmoduleDependencyInfo extends YangModelDependencyInfo {
265 private final String belongsTo;
268 * Returns name of parent module.
271 public String getParentModule() {
275 private SubmoduleDependencyInfo(final String name, final String latestRevision, final String belongsTo,
276 final ImmutableSet<ModuleImport> imports, final ImmutableSet<ModuleImport> includes) {
277 super(name, latestRevision, imports, includes);
278 this.belongsTo = belongsTo;
282 public String toString() {
283 return "Submodule [name=" + getName() + ", revision=" + getRevision() + ", dependencies="
284 + getDependencies() + "]";
289 * Utility implementation of {@link ModuleImport} to be used by
290 * {@link YangModelDependencyInfo}.
293 private static final class ModuleImportImpl implements ModuleImport {
295 private final Date revision;
296 private final String name;
298 public ModuleImportImpl(final String moduleName, final Date revision) {
299 this.name = moduleName;
300 this.revision = revision;
304 public String getModuleName() {
309 public Date getRevision() {
310 return this.revision;
314 public String getPrefix() {
319 public int hashCode() {
320 final int prime = 31;
322 result = prime * result + ((name == null) ? 0 : name.hashCode());
323 result = prime * result + ((revision == null) ? 0 : revision.hashCode());
328 public boolean equals(final Object obj) {
335 if (getClass() != obj.getClass()) {
338 ModuleImportImpl other = (ModuleImportImpl) obj;
340 if (other.name != null) {
343 } else if (!name.equals(other.name)) {
346 if (revision == null) {
347 if (other.revision != null) {
350 } else if (!revision.equals(other.revision)) {
357 public String toString() {
358 return "ModuleImportImpl [name=" + name + ", revision=" + QName.formattedRevision(revision) + "]";