2 * Copyright (c) 2017 Pantheon Technologies, s.r.o. 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.stmt.import_;
10 import static java.util.Objects.requireNonNull;
11 import static org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase.SOURCE_LINKAGE;
12 import static org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils.firstAttributeOf;
14 import com.google.common.base.MoreObjects.ToStringHelper;
15 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
17 import java.util.Collection;
18 import java.util.Optional;
19 import org.opendaylight.yangtools.concepts.SemVer;
20 import org.opendaylight.yangtools.yang.common.QNameModule;
21 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
22 import org.opendaylight.yangtools.yang.model.api.stmt.ImportStatement;
23 import org.opendaylight.yangtools.yang.model.api.stmt.NamespaceStatement;
24 import org.opendaylight.yangtools.yang.model.api.stmt.PrefixStatement;
25 import org.opendaylight.yangtools.yang.model.repo.api.SemVerSourceIdentifier;
26 import org.opendaylight.yangtools.yang.model.repo.api.SourceIdentifier;
27 import org.opendaylight.yangtools.yang.parser.rfc7950.namespace.ModuleQNameToPrefix;
28 import org.opendaylight.yangtools.yang.parser.rfc7950.namespace.URIStringToImportPrefix;
29 import org.opendaylight.yangtools.yang.parser.spi.meta.InferenceException;
30 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder;
31 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.InferenceAction;
32 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.InferenceContext;
33 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.Prerequisite;
34 import org.opendaylight.yangtools.yang.parser.spi.meta.NamespaceKeyCriterion;
35 import org.opendaylight.yangtools.yang.parser.spi.meta.SemanticVersionModuleNamespace;
36 import org.opendaylight.yangtools.yang.parser.spi.meta.SemanticVersionNamespace;
37 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
38 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
39 import org.opendaylight.yangtools.yang.parser.spi.source.ImportPrefixToModuleCtx;
40 import org.opendaylight.yangtools.yang.parser.spi.source.ImportPrefixToSemVerSourceIdentifier;
41 import org.opendaylight.yangtools.yang.parser.spi.source.ImportedModuleContext;
42 import org.opendaylight.yangtools.yang.parser.spi.source.ModuleCtxToModuleQName;
43 import org.opendaylight.yangtools.yang.parser.spi.source.ModuleCtxToSourceIdentifier;
45 final class SemanticVersionImport {
47 private abstract static class CompatibleCriterion extends NamespaceKeyCriterion<SemVerSourceIdentifier> {
48 private final String moduleName;
50 CompatibleCriterion(final String moduleName) {
51 this.moduleName = requireNonNull(moduleName);
55 public boolean match(final SemVerSourceIdentifier key) {
56 return moduleName.equals(key.getName());
60 protected ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) {
61 return toStringHelper.add("moduleName", moduleName);
65 private static final class NoVerCompatibleCriterion extends SemanticVersionImport.CompatibleCriterion {
66 NoVerCompatibleCriterion(final String moduleName) {
71 public SemVerSourceIdentifier select(final SemVerSourceIdentifier first,
72 final SemVerSourceIdentifier second) {
73 // TODO Auto-generated method stub
78 private static final class SemVerCompatibleCriterion extends SemanticVersionImport.CompatibleCriterion {
79 private final SemVer semVer;
81 SemVerCompatibleCriterion(final String moduleName, final SemVer semVer) {
83 this.semVer = requireNonNull(semVer);
87 public boolean match(final SemVerSourceIdentifier key) {
88 if (!super.match(key)) {
91 final Optional<SemVer> optKeyVer = key.getSemanticVersion();
92 if (!optKeyVer.isPresent()) {
96 final SemVer keyVer = optKeyVer.get();
97 if (semVer.getMajor() != keyVer.getMajor()) {
100 if (semVer.getMinor() > keyVer.getMinor()) {
103 return semVer.getMinor() < keyVer.getMinor() || semVer.getPatch() <= keyVer.getPatch();
107 public SemVerSourceIdentifier select(final SemVerSourceIdentifier first,
108 final SemVerSourceIdentifier second) {
109 return first.getSemanticVersion().get().compareTo(second.getSemanticVersion().get()) >= 0 ? first
114 protected ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) {
115 return super.addToStringAttributes(toStringHelper).add("version", semVer);
119 private SemanticVersionImport() {
123 static void onLinkageDeclared(
124 final Mutable<String, ImportStatement, EffectiveStatement<String, ImportStatement>> stmt) {
125 final ModelActionBuilder importAction = stmt.newInferenceAction(SOURCE_LINKAGE);
126 final String moduleName = stmt.coerceStatementArgument();
127 final SemVer semanticVersion = stmt.getFromNamespace(SemanticVersionNamespace.class, stmt);
128 final SemanticVersionImport.CompatibleCriterion criterion = semanticVersion == null
129 ? new NoVerCompatibleCriterion(moduleName)
130 : new SemVerCompatibleCriterion(moduleName, semanticVersion);
132 final Prerequisite<StmtContext<?, ?, ?>> imported = importAction.requiresCtx(stmt,
133 SemanticVersionModuleNamespace.class, criterion, SOURCE_LINKAGE);
134 final Prerequisite<Mutable<?, ?, ?>> linkageTarget = importAction.mutatesCtx(stmt.getRoot(),
137 importAction.apply(new InferenceAction() {
139 public void apply(final InferenceContext ctx) {
140 final StmtContext<?, ?, ?> importedModule = imported.resolve(ctx);
141 final SemVer importedVersion = stmt.getFromNamespace(SemanticVersionNamespace.class, stmt);
142 final SourceIdentifier importedModuleIdentifier = importedModule.getFromNamespace(
143 ModuleCtxToSourceIdentifier.class, importedModule);
144 final SemVerSourceIdentifier semVerModuleIdentifier = createSemVerModuleIdentifier(
145 importedModuleIdentifier, importedVersion);
147 linkageTarget.resolve(ctx).addToNs(ImportedModuleContext.class, importedModuleIdentifier,
149 final String impPrefix = firstAttributeOf(stmt.declaredSubstatements(), PrefixStatement.class);
150 stmt.addToNs(ImportPrefixToModuleCtx.class, impPrefix, importedModule);
151 stmt.addToNs(ImportPrefixToSemVerSourceIdentifier.class, impPrefix, semVerModuleIdentifier);
153 final QNameModule mod = InferenceException.throwIfNull(stmt.getFromNamespace(
154 ModuleCtxToModuleQName.class, importedModule), stmt.getStatementSourceReference(),
155 "Failed to find module of %s", importedModule);
157 final URI modNs = firstAttributeOf(importedModule.declaredSubstatements(),
158 NamespaceStatement.class);
159 stmt.addToNs(ModuleQNameToPrefix.class, mod, impPrefix);
160 stmt.addToNs(URIStringToImportPrefix.class, modNs.toString(), impPrefix);
164 public void prerequisiteFailed(final Collection<? extends Prerequisite<?>> failed) {
165 if (failed.contains(imported)) {
166 throw new InferenceException(stmt.getStatementSourceReference(),
167 "Unable to find module compatible with requested import [%s(%s)].", moduleName,
168 getRequestedImportVersionString(stmt));
174 private static Optional<SemVer> getRequestedImportVersion(final StmtContext<?, ?, ?> stmt) {
175 return Optional.ofNullable(stmt.getFromNamespace(SemanticVersionNamespace.class, stmt));
178 @SuppressFBWarnings(value = "UPM_UNCALLED_PRIVATE_METHOD",
179 justification = "https://github.com/spotbugs/spotbugs/issues/811")
180 private static String getRequestedImportVersionString(final StmtContext<?, ?, ?> stmt) {
181 return getRequestedImportVersion(stmt).map(SemVer::toString).orElse("<any>");
184 @SuppressFBWarnings(value = "UPM_UNCALLED_PRIVATE_METHOD",
185 justification = "https://github.com/spotbugs/spotbugs/issues/811")
186 private static SemVerSourceIdentifier createSemVerModuleIdentifier(
187 final SourceIdentifier importedModuleIdentifier, final SemVer semVer) {
188 return SemVerSourceIdentifier.create(importedModuleIdentifier.getName(),
189 importedModuleIdentifier.getRevision(), semVer);