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.submodule;
10 import static java.util.Objects.requireNonNull;
11 import static org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils.findFirstDeclaredSubstatement;
12 import static org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils.firstAttributeOf;
14 import com.google.common.annotations.Beta;
15 import com.google.common.collect.ImmutableList;
16 import org.eclipse.jdt.annotation.NonNull;
17 import org.opendaylight.yangtools.yang.common.UnqualifiedQName;
18 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
19 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
20 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
21 import org.opendaylight.yangtools.yang.model.api.stmt.BelongsToStatement;
22 import org.opendaylight.yangtools.yang.model.api.stmt.PrefixStatement;
23 import org.opendaylight.yangtools.yang.model.api.stmt.SubmoduleEffectiveStatement;
24 import org.opendaylight.yangtools.yang.model.api.stmt.SubmoduleStatement;
25 import org.opendaylight.yangtools.yang.model.parser.api.YangParserConfiguration;
26 import org.opendaylight.yangtools.yang.model.repo.api.RevisionSourceIdentifier;
27 import org.opendaylight.yangtools.yang.model.repo.api.SourceIdentifier;
28 import org.opendaylight.yangtools.yang.model.ri.stmt.DeclaredStatements;
29 import org.opendaylight.yangtools.yang.model.spi.meta.SubstatementIndexingException;
30 import org.opendaylight.yangtools.yang.parser.spi.SubmoduleNamespace;
31 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractStatementSupport;
32 import org.opendaylight.yangtools.yang.parser.spi.meta.CommonStmtCtx;
33 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
34 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
35 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
36 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
37 import org.opendaylight.yangtools.yang.parser.spi.meta.SubstatementValidator;
38 import org.opendaylight.yangtools.yang.parser.spi.source.BelongsToPrefixToModuleName;
39 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
42 public final class SubmoduleStatementSupport
43 extends AbstractStatementSupport<UnqualifiedQName, SubmoduleStatement, SubmoduleEffectiveStatement> {
44 private static final SubstatementValidator RFC6020_VALIDATOR =
45 SubstatementValidator.builder(YangStmtMapping.SUBMODULE)
46 .addAny(YangStmtMapping.ANYXML)
47 .addAny(YangStmtMapping.AUGMENT)
48 .addMandatory(YangStmtMapping.BELONGS_TO)
49 .addAny(YangStmtMapping.CHOICE)
50 .addOptional(YangStmtMapping.CONTACT)
51 .addAny(YangStmtMapping.CONTAINER)
52 .addOptional(YangStmtMapping.DESCRIPTION)
53 .addAny(YangStmtMapping.DEVIATION)
54 .addAny(YangStmtMapping.EXTENSION)
55 .addAny(YangStmtMapping.FEATURE)
56 .addAny(YangStmtMapping.GROUPING)
57 .addAny(YangStmtMapping.IDENTITY)
58 .addAny(YangStmtMapping.IMPORT)
59 .addAny(YangStmtMapping.INCLUDE)
60 .addAny(YangStmtMapping.LEAF)
61 .addAny(YangStmtMapping.LEAF_LIST)
62 .addAny(YangStmtMapping.LIST)
63 .addAny(YangStmtMapping.NOTIFICATION)
64 .addOptional(YangStmtMapping.ORGANIZATION)
65 .addOptional(YangStmtMapping.REFERENCE)
66 .addAny(YangStmtMapping.REVISION)
67 .addAny(YangStmtMapping.RPC)
68 .addAny(YangStmtMapping.TYPEDEF)
69 .addAny(YangStmtMapping.USES)
70 .addOptional(YangStmtMapping.YANG_VERSION)
72 private static final SubstatementValidator RFC7950_VALIDATOR =
73 SubstatementValidator.builder(YangStmtMapping.SUBMODULE)
74 .addAny(YangStmtMapping.ANYDATA)
75 .addAny(YangStmtMapping.ANYXML)
76 .addAny(YangStmtMapping.AUGMENT)
77 .addMandatory(YangStmtMapping.BELONGS_TO)
78 .addAny(YangStmtMapping.CHOICE)
79 .addOptional(YangStmtMapping.CONTACT)
80 .addAny(YangStmtMapping.CONTAINER)
81 .addOptional(YangStmtMapping.DESCRIPTION)
82 .addAny(YangStmtMapping.DEVIATION)
83 .addAny(YangStmtMapping.EXTENSION)
84 .addAny(YangStmtMapping.FEATURE)
85 .addAny(YangStmtMapping.GROUPING)
86 .addAny(YangStmtMapping.IDENTITY)
87 .addAny(YangStmtMapping.IMPORT)
88 .addAny(YangStmtMapping.INCLUDE)
89 .addAny(YangStmtMapping.LEAF)
90 .addAny(YangStmtMapping.LEAF_LIST)
91 .addAny(YangStmtMapping.LIST)
92 .addAny(YangStmtMapping.NOTIFICATION)
93 .addOptional(YangStmtMapping.ORGANIZATION)
94 .addOptional(YangStmtMapping.REFERENCE)
95 .addAny(YangStmtMapping.REVISION)
96 .addAny(YangStmtMapping.RPC)
97 .addAny(YangStmtMapping.TYPEDEF)
98 .addAny(YangStmtMapping.USES)
99 .addOptional(YangStmtMapping.YANG_VERSION)
102 private final SubstatementValidator validator;
104 private SubmoduleStatementSupport(final YangParserConfiguration config, final SubstatementValidator validator) {
105 super(YangStmtMapping.SUBMODULE, StatementPolicy.reject(), config);
106 this.validator = requireNonNull(validator);
109 public static @NonNull SubmoduleStatementSupport rfc6020Instance(final YangParserConfiguration config) {
110 return new SubmoduleStatementSupport(config, RFC6020_VALIDATOR);
113 public static @NonNull SubmoduleStatementSupport rfc7950Instance(final YangParserConfiguration config) {
114 return new SubmoduleStatementSupport(config, RFC7950_VALIDATOR);
118 public UnqualifiedQName parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
120 return UnqualifiedQName.of(value);
121 } catch (IllegalArgumentException e) {
122 throw new SourceException(e.getMessage(), ctx, e);
127 public void onPreLinkageDeclared(
128 final Mutable<UnqualifiedQName, SubmoduleStatement, SubmoduleEffectiveStatement> stmt) {
129 stmt.setRootIdentifier(RevisionSourceIdentifier.create(stmt.getRawArgument(),
130 StmtContextUtils.getLatestRevision(stmt.declaredSubstatements())));
134 public void onLinkageDeclared(
135 final Mutable<UnqualifiedQName, SubmoduleStatement, SubmoduleEffectiveStatement> stmt) {
136 final SourceIdentifier submoduleIdentifier = RevisionSourceIdentifier.create(stmt.getRawArgument(),
137 StmtContextUtils.getLatestRevision(stmt.declaredSubstatements()));
139 final StmtContext<?, SubmoduleStatement, SubmoduleEffectiveStatement>
140 possibleDuplicateSubmodule = stmt.getFromNamespace(SubmoduleNamespace.class, submoduleIdentifier);
141 if (possibleDuplicateSubmodule != null && possibleDuplicateSubmodule != stmt) {
142 throw new SourceException(stmt, "Submodule name collision: %s. At %s", stmt.rawArgument(),
143 possibleDuplicateSubmodule.sourceReference());
146 stmt.addContext(SubmoduleNamespace.class, submoduleIdentifier, stmt);
148 final String belongsToModuleName = firstAttributeOf(stmt.declaredSubstatements(), BelongsToStatement.class);
149 final StmtContext<?, ?, ?> prefixSubStmtCtx = SourceException.throwIfNull(
150 findFirstDeclaredSubstatement(stmt, 0, BelongsToStatement.class, PrefixStatement.class), stmt,
151 "Prefix of belongsTo statement is missing in submodule [%s]", stmt.rawArgument());
153 final String prefix = prefixSubStmtCtx.rawArgument();
154 stmt.addToNs(BelongsToPrefixToModuleName.class, prefix, belongsToModuleName);
158 protected SubstatementValidator getSubstatementValidator() {
163 protected SubmoduleStatement createDeclared(final StmtContext<UnqualifiedQName, SubmoduleStatement, ?> ctx,
164 final ImmutableList<? extends DeclaredStatement<?>> substatements) {
165 if (substatements.isEmpty()) {
166 throw noBelongsTo(ctx);
168 return DeclaredStatements.createSubmodule(ctx.getRawArgument(), ctx.getArgument(), substatements);
172 protected SubmoduleEffectiveStatement createEffective(final Current<UnqualifiedQName, SubmoduleStatement> stmt,
173 final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
174 if (substatements.isEmpty()) {
175 throw noBelongsTo(stmt);
178 return new SubmoduleEffectiveStatementImpl(stmt, substatements);
179 } catch (SubstatementIndexingException e) {
180 throw new SourceException(e.getMessage(), stmt, e);
184 private static SourceException noBelongsTo(final CommonStmtCtx stmt) {
185 return new SourceException("No belongs-to declared in submodule", stmt);