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 java.util.Objects.requireNonNull;
13 import static org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase.SOURCE_PRE_LINKAGE;
14 import static org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils.firstAttributeOf;
16 import com.google.common.annotations.Beta;
17 import com.google.common.collect.ImmutableList;
18 import java.util.Collection;
19 import org.eclipse.jdt.annotation.NonNull;
20 import org.opendaylight.yangtools.openconfig.model.api.OpenConfigStatements;
21 import org.opendaylight.yangtools.yang.common.Empty;
22 import org.opendaylight.yangtools.yang.common.XMLNamespace;
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.stmt.ImportEffectiveStatement;
28 import org.opendaylight.yangtools.yang.model.api.stmt.ImportStatement;
29 import org.opendaylight.yangtools.yang.model.api.stmt.PrefixStatement;
30 import org.opendaylight.yangtools.yang.model.ri.stmt.DeclaredStatementDecorators;
31 import org.opendaylight.yangtools.yang.model.ri.stmt.DeclaredStatements;
32 import org.opendaylight.yangtools.yang.model.ri.stmt.EffectiveStatements;
33 import org.opendaylight.yangtools.yang.parser.api.ImportResolutionMode;
34 import org.opendaylight.yangtools.yang.parser.api.YangParserConfiguration;
35 import org.opendaylight.yangtools.yang.parser.spi.PreLinkageModuleNamespace;
36 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractStringStatementSupport;
37 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
38 import org.opendaylight.yangtools.yang.parser.spi.meta.InferenceException;
39 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder;
40 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.InferenceAction;
41 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.InferenceContext;
42 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.Prerequisite;
43 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
44 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
45 import org.opendaylight.yangtools.yang.parser.spi.meta.SubstatementValidator;
46 import org.opendaylight.yangtools.yang.parser.spi.source.ImpPrefixToNamespace;
47 import org.opendaylight.yangtools.yang.parser.spi.source.ModuleNameToNamespace;
48 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
51 public final class ImportStatementSupport
52 extends AbstractStringStatementSupport<ImportStatement, ImportEffectiveStatement> {
53 private static final SubstatementValidator RFC6020_VALIDATOR =
54 SubstatementValidator.builder(YangStmtMapping.IMPORT)
55 .addMandatory(YangStmtMapping.PREFIX)
56 .addOptional(YangStmtMapping.REVISION_DATE)
57 .addOptional(OpenConfigStatements.OPENCONFIG_VERSION)
59 private static final SubstatementValidator RFC7950_VALIDATOR =
60 SubstatementValidator.builder(YangStmtMapping.IMPORT)
61 .addMandatory(YangStmtMapping.PREFIX)
62 .addOptional(YangStmtMapping.REVISION_DATE)
63 .addOptional(OpenConfigStatements.OPENCONFIG_VERSION)
64 .addOptional(YangStmtMapping.DESCRIPTION)
65 .addOptional(YangStmtMapping.REFERENCE)
68 private final SubstatementValidator validator;
69 private final boolean semanticVersioning;
71 private ImportStatementSupport(final YangParserConfiguration config, final SubstatementValidator validator) {
72 super(YangStmtMapping.IMPORT, StatementPolicy.reject(), config);
73 this.validator = requireNonNull(validator);
74 semanticVersioning = config.importResolutionMode() == ImportResolutionMode.OPENCONFIG_SEMVER;
77 public static @NonNull ImportStatementSupport rfc6020Instance(final YangParserConfiguration config) {
78 return new ImportStatementSupport(config, RFC6020_VALIDATOR);
81 public static @NonNull ImportStatementSupport rfc7950Instance(final YangParserConfiguration config) {
82 return new ImportStatementSupport(config, RFC7950_VALIDATOR);
86 public void onPreLinkageDeclared(final Mutable<String, ImportStatement, ImportEffectiveStatement> stmt) {
88 * Add ModuleIdentifier of a module which is required by this module.
89 * Based on this information, required modules are searched from library
92 stmt.addRequiredSource(RevisionImport.getImportedSourceIdentifier(stmt));
94 final String moduleName = stmt.getArgument();
95 final ModelActionBuilder importAction = stmt.newInferenceAction(SOURCE_PRE_LINKAGE);
96 final Prerequisite<StmtContext<?, ?, ?>> imported = importAction.requiresCtx(stmt,
97 PreLinkageModuleNamespace.class, moduleName, SOURCE_PRE_LINKAGE);
98 importAction.mutatesCtx(stmt.getRoot(), SOURCE_PRE_LINKAGE);
100 importAction.apply(new InferenceAction() {
102 public void apply(final InferenceContext ctx) {
103 final StmtContext<?, ?, ?> importedModuleContext = imported.resolve(ctx);
104 verify(moduleName.equals(importedModuleContext.getRawArgument()));
105 final XMLNamespace importedModuleNamespace = verifyNotNull(
106 importedModuleContext.getFromNamespace(ModuleNameToNamespace.class, moduleName));
107 final String impPrefix = SourceException.throwIfNull(
108 firstAttributeOf(stmt.declaredSubstatements(), PrefixStatement.class), stmt,
109 "Missing prefix statement");
111 stmt.addToNs(ImpPrefixToNamespace.class, impPrefix, importedModuleNamespace);
115 public void prerequisiteFailed(final Collection<? extends Prerequisite<?>> failed) {
116 InferenceException.throwIf(failed.contains(imported), stmt, "Imported module [%s] was not found.",
123 public void onLinkageDeclared(final Mutable<String, ImportStatement, ImportEffectiveStatement> stmt) {
124 if (semanticVersioning) {
125 SemanticVersionImport.onLinkageDeclared(stmt);
127 RevisionImport.onLinkageDeclared(stmt);
132 protected SubstatementValidator getSubstatementValidator() {
137 protected ImportStatement createDeclared(final StmtContext<String, ImportStatement, ?> ctx,
138 final ImmutableList<? extends DeclaredStatement<?>> substatements) {
139 return DeclaredStatements.createImport(ctx.getRawArgument(), substatements);
143 protected ImportStatement attachDeclarationReference(final ImportStatement stmt,
144 final DeclarationReference reference) {
145 return DeclaredStatementDecorators.decorateImport(stmt, reference);
149 protected ImportEffectiveStatement createEffective(final Current<String, ImportStatement> stmt,
150 final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
151 InferenceException.throwIf(substatements.isEmpty(), stmt, "Unexpected empty effective import statement");
152 return EffectiveStatements.createImport(stmt.declared(), substatements,
153 verifyNotNull(stmt.getFromNamespace(ImportedVersionNamespace.class, Empty.getInstance())));