2 * Copyright (c) 2015 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.stmt.import_;
10 import static com.google.common.base.Verify.verify;
11 import static com.google.common.base.Verify.verifyNotNull;
12 import static org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase.SOURCE_PRE_LINKAGE;
13 import static org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils.firstAttributeOf;
15 import com.google.common.annotations.Beta;
16 import com.google.common.collect.ImmutableList;
17 import java.util.Collection;
18 import org.eclipse.jdt.annotation.NonNull;
19 import org.opendaylight.yangtools.yang.common.Empty;
20 import org.opendaylight.yangtools.yang.common.UnresolvedQName.Unqualified;
21 import org.opendaylight.yangtools.yang.common.XMLNamespace;
22 import org.opendaylight.yangtools.yang.common.YangVersion;
23 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
24 import org.opendaylight.yangtools.yang.model.api.meta.DeclarationReference;
25 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
26 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
27 import org.opendaylight.yangtools.yang.model.api.source.SourceIdentifier;
28 import org.opendaylight.yangtools.yang.model.api.stmt.ImportEffectiveStatement;
29 import org.opendaylight.yangtools.yang.model.api.stmt.ImportStatement;
30 import org.opendaylight.yangtools.yang.model.api.stmt.PrefixStatement;
31 import org.opendaylight.yangtools.yang.model.ri.stmt.DeclaredStatementDecorators;
32 import org.opendaylight.yangtools.yang.model.ri.stmt.DeclaredStatements;
33 import org.opendaylight.yangtools.yang.model.ri.stmt.EffectiveStatements;
34 import org.opendaylight.yangtools.yang.parser.api.YangParserConfiguration;
35 import org.opendaylight.yangtools.yang.parser.spi.ParserNamespaces;
36 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractUnqualifiedStatementSupport;
37 import org.opendaylight.yangtools.yang.parser.spi.meta.BoundStmtCtx;
38 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
39 import org.opendaylight.yangtools.yang.parser.spi.meta.InferenceException;
40 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder;
41 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.InferenceAction;
42 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.InferenceContext;
43 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.Prerequisite;
44 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
45 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
46 import org.opendaylight.yangtools.yang.parser.spi.meta.SubstatementValidator;
47 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
48 import org.opendaylight.yangtools.yang.parser.spi.source.YangVersionLinkageException;
51 public final class ImportStatementSupport
52 extends AbstractUnqualifiedStatementSupport<ImportStatement, ImportEffectiveStatement> {
53 private static final SubstatementValidator RFC6020_VALIDATOR =
54 SubstatementValidator.builder(YangStmtMapping.IMPORT)
55 .addMandatory(YangStmtMapping.PREFIX)
56 .addOptional(YangStmtMapping.REVISION_DATE)
58 private static final SubstatementValidator RFC7950_VALIDATOR =
59 SubstatementValidator.builder(YangStmtMapping.IMPORT)
60 .addMandatory(YangStmtMapping.PREFIX)
61 .addOptional(YangStmtMapping.REVISION_DATE)
62 .addOptional(YangStmtMapping.DESCRIPTION)
63 .addOptional(YangStmtMapping.REFERENCE)
66 private ImportStatementSupport(final YangParserConfiguration config, final SubstatementValidator validator) {
67 super(YangStmtMapping.IMPORT, StatementPolicy.reject(), config, validator);
70 public static @NonNull ImportStatementSupport rfc6020Instance(final YangParserConfiguration config) {
71 return new ImportStatementSupport(config, RFC6020_VALIDATOR);
74 public static @NonNull ImportStatementSupport rfc7950Instance(final YangParserConfiguration config) {
75 return new ImportStatementSupport(config, RFC7950_VALIDATOR);
79 public void onPreLinkageDeclared(final Mutable<Unqualified, ImportStatement, ImportEffectiveStatement> stmt) {
81 * Add ModuleIdentifier of a module which is required by this module.
82 * Based on this information, required modules are searched from library
85 final SourceIdentifier importId = RevisionImport.getImportedSourceIdentifier(stmt);
86 stmt.addRequiredSource(importId);
88 final Unqualified moduleName = stmt.getArgument();
89 final ModelActionBuilder importAction = stmt.newInferenceAction(SOURCE_PRE_LINKAGE);
90 final var imported = importAction.requiresCtx(stmt, ParserNamespaces.PRELINKAGE_MODULE, moduleName,
92 final Prerequisite<Mutable<?, ?, ?>> rootPrereq = importAction.mutatesCtx(stmt.getRoot(), SOURCE_PRE_LINKAGE);
94 importAction.apply(new InferenceAction() {
96 public void apply(final InferenceContext ctx) {
97 final StmtContext<?, ?, ?> importedModuleContext = imported.resolve(ctx);
98 verify(moduleName.equals(importedModuleContext.getArgument()));
99 final XMLNamespace importedModuleNamespace = verifyNotNull(importedModuleContext.namespaceItem(
100 ParserNamespaces.MODULE_NAME_TO_NAMESPACE, moduleName));
101 final String impPrefix = SourceException.throwIfNull(
102 firstAttributeOf(stmt.declaredSubstatements(), PrefixStatement.class), stmt,
103 "Missing prefix statement");
105 final Mutable<?, ?, ?> root = rootPrereq.resolve(ctx);
106 // Version 1 sources must not import-by-revision Version 1.1 modules
107 if (importId.revision() != null && root.yangVersion() == YangVersion.VERSION_1) {
108 final YangVersion importedVersion = importedModuleContext.yangVersion();
109 if (importedVersion != YangVersion.VERSION_1) {
110 throw new YangVersionLinkageException(stmt, "Cannot import by revision version %s module %s",
111 importedVersion, moduleName.getLocalName());
115 stmt.addToNs(ParserNamespaces.IMP_PREFIX_TO_NAMESPACE, impPrefix, importedModuleNamespace);
119 public void prerequisiteFailed(final Collection<? extends Prerequisite<?>> failed) {
120 InferenceException.throwIf(failed.contains(imported), stmt, "Imported module [%s] was not found.",
121 moduleName.getLocalName());
127 public void onLinkageDeclared(final Mutable<Unqualified, ImportStatement, ImportEffectiveStatement> stmt) {
128 RevisionImport.onLinkageDeclared(stmt);
132 protected ImportStatement createDeclared(final BoundStmtCtx<Unqualified> ctx,
133 final ImmutableList<DeclaredStatement<?>> substatements) {
134 return DeclaredStatements.createImport(ctx.getArgument(), substatements);
138 protected ImportStatement attachDeclarationReference(final ImportStatement stmt,
139 final DeclarationReference reference) {
140 return DeclaredStatementDecorators.decorateImport(stmt, reference);
144 protected ImportEffectiveStatement createEffective(final Current<Unqualified, ImportStatement> stmt,
145 final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
146 InferenceException.throwIf(substatements.isEmpty(), stmt, "Unexpected empty effective import statement");
147 return EffectiveStatements.createImport(stmt.declared(), substatements,
148 verifyNotNull(stmt.namespaceItem(ImportedVersionNamespace.INSTANCE, Empty.value())));