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.meta;
10 import static org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase.SOURCE_LINKAGE;
11 import static org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils.findFirstDeclaredSubstatement;
13 import com.google.common.annotations.Beta;
14 import com.google.common.collect.ImmutableList;
15 import java.util.Collection;
16 import java.util.Optional;
17 import org.eclipse.jdt.annotation.NonNull;
18 import org.opendaylight.yangtools.yang.common.Revision;
19 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
20 import org.opendaylight.yangtools.yang.model.api.meta.DeclarationReference;
21 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
22 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
23 import org.opendaylight.yangtools.yang.model.api.stmt.IncludeEffectiveStatement;
24 import org.opendaylight.yangtools.yang.model.api.stmt.IncludeStatement;
25 import org.opendaylight.yangtools.yang.model.api.stmt.RevisionDateStatement;
26 import org.opendaylight.yangtools.yang.model.repo.api.RevisionSourceIdentifier;
27 import org.opendaylight.yangtools.yang.model.ri.stmt.DeclaredStatementDecorators;
28 import org.opendaylight.yangtools.yang.model.ri.stmt.DeclaredStatements;
29 import org.opendaylight.yangtools.yang.model.ri.stmt.EffectiveStatements;
30 import org.opendaylight.yangtools.yang.parser.api.YangParserConfiguration;
31 import org.opendaylight.yangtools.yang.parser.spi.SubmoduleNamespace;
32 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractStringStatementSupport;
33 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
34 import org.opendaylight.yangtools.yang.parser.spi.meta.InferenceException;
35 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder;
36 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.InferenceAction;
37 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.InferenceContext;
38 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.Prerequisite;
39 import org.opendaylight.yangtools.yang.parser.spi.meta.NamespaceKeyCriterion;
40 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
41 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
42 import org.opendaylight.yangtools.yang.parser.spi.meta.SubstatementValidator;
43 import org.opendaylight.yangtools.yang.parser.spi.source.IncludedModuleContext;
44 import org.opendaylight.yangtools.yang.parser.spi.source.IncludedSubmoduleNameToModuleCtx;
47 public final class IncludeStatementSupport
48 extends AbstractStringStatementSupport<IncludeStatement, IncludeEffectiveStatement> {
49 private static final SubstatementValidator RFC6020_VALIDATOR =
50 SubstatementValidator.builder(YangStmtMapping.INCLUDE)
51 .addOptional(YangStmtMapping.REVISION_DATE)
53 private static final SubstatementValidator RFC7950_VALIDATOR =
54 SubstatementValidator.builder(YangStmtMapping.INCLUDE)
55 .addOptional(YangStmtMapping.REVISION_DATE)
56 .addOptional(YangStmtMapping.DESCRIPTION)
57 .addOptional(YangStmtMapping.REFERENCE)
60 IncludeStatementSupport(final YangParserConfiguration config, final SubstatementValidator validator) {
61 super(YangStmtMapping.INCLUDE, StatementPolicy.reject(), config, validator);
64 public static @NonNull IncludeStatementSupport rfc6020Instance(final YangParserConfiguration config) {
65 return new IncludeStatementSupport(config, RFC6020_VALIDATOR);
68 public static @NonNull IncludeStatementSupport rfc7950Instance(final YangParserConfiguration config) {
69 return new IncludeStatementSupport(config, RFC7950_VALIDATOR);
73 public void onPreLinkageDeclared(final Mutable<String, IncludeStatement, IncludeEffectiveStatement> stmt) {
74 final StmtContext<Revision, ?, ?> revision = findFirstDeclaredSubstatement(stmt,
75 RevisionDateStatement.class);
76 stmt.addRequiredSource(revision == null ? RevisionSourceIdentifier.create(stmt.argument())
77 : RevisionSourceIdentifier.create(stmt.argument(), revision.argument()));
81 public void onLinkageDeclared(final Mutable<String, IncludeStatement, IncludeEffectiveStatement> stmt) {
82 final String submoduleName = stmt.getArgument();
83 final StmtContext<Revision, ?, ?> revision = findFirstDeclaredSubstatement(stmt, RevisionDateStatement.class);
85 final ModelActionBuilder includeAction = stmt.newInferenceAction(SOURCE_LINKAGE);
86 final Prerequisite<StmtContext<?, ?, ?>> requiresCtxPrerequisite;
87 if (revision == null) {
88 requiresCtxPrerequisite = includeAction.requiresCtx(stmt, SubmoduleNamespace.class,
89 NamespaceKeyCriterion.latestRevisionModule(submoduleName), SOURCE_LINKAGE);
91 requiresCtxPrerequisite = includeAction.requiresCtx(stmt, SubmoduleNamespace.class,
92 RevisionSourceIdentifier.create(submoduleName, Optional.of(revision.argument())), SOURCE_LINKAGE);
95 includeAction.apply(new InferenceAction() {
97 public void apply(final InferenceContext ctx) {
98 final StmtContext<?, ?, ?> includedSubModuleContext = requiresCtxPrerequisite.resolve(ctx);
100 stmt.addToNs(IncludedModuleContext.class, revision != null
101 ? RevisionSourceIdentifier.create(submoduleName, revision.argument())
102 : RevisionSourceIdentifier.create(submoduleName), includedSubModuleContext);
103 stmt.addToNs(IncludedSubmoduleNameToModuleCtx.class, stmt.argument(), includedSubModuleContext);
107 public void prerequisiteFailed(final Collection<? extends Prerequisite<?>> failed) {
108 InferenceException.throwIf(failed.contains(requiresCtxPrerequisite), stmt,
109 "Included submodule '%s' was not found: ", stmt.argument());
115 protected IncludeStatement createDeclared(final StmtContext<String, IncludeStatement, ?> ctx,
116 final ImmutableList<? extends DeclaredStatement<?>> substatements) {
117 return DeclaredStatements.createInclude(ctx.getRawArgument(), ctx.getArgument(), substatements);
121 protected IncludeStatement attachDeclarationReference(final IncludeStatement stmt,
122 final DeclarationReference reference) {
123 return DeclaredStatementDecorators.decorateInclude(stmt, reference);
127 protected IncludeEffectiveStatement createEffective(final Current<String, IncludeStatement> stmt,
128 final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
129 return EffectiveStatements.createInclude(stmt.declared(), substatements);