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 org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils.findFirstDeclaredSubstatement;
11 import static org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils.firstAttributeOf;
13 import com.google.common.annotations.Beta;
14 import com.google.common.collect.ImmutableList;
15 import org.eclipse.jdt.annotation.NonNull;
16 import org.opendaylight.yangtools.yang.common.UnresolvedQName;
17 import org.opendaylight.yangtools.yang.common.UnresolvedQName.Unqualified;
18 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
19 import org.opendaylight.yangtools.yang.model.api.meta.DeclarationReference;
20 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
21 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
22 import org.opendaylight.yangtools.yang.model.api.stmt.BelongsToStatement;
23 import org.opendaylight.yangtools.yang.model.api.stmt.PrefixStatement;
24 import org.opendaylight.yangtools.yang.model.api.stmt.SubmoduleEffectiveStatement;
25 import org.opendaylight.yangtools.yang.model.api.stmt.SubmoduleStatement;
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.DeclaredStatementDecorators;
29 import org.opendaylight.yangtools.yang.model.ri.stmt.DeclaredStatements;
30 import org.opendaylight.yangtools.yang.model.spi.meta.SubstatementIndexingException;
31 import org.opendaylight.yangtools.yang.parser.api.YangParserConfiguration;
32 import org.opendaylight.yangtools.yang.parser.spi.SubmoduleNamespace;
33 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractStatementSupport;
34 import org.opendaylight.yangtools.yang.parser.spi.meta.CommonStmtCtx;
35 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
36 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
37 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
38 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
39 import org.opendaylight.yangtools.yang.parser.spi.meta.SubstatementValidator;
40 import org.opendaylight.yangtools.yang.parser.spi.source.BelongsToPrefixToModuleName;
41 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
44 public final class SubmoduleStatementSupport
45 extends AbstractStatementSupport<Unqualified, SubmoduleStatement, SubmoduleEffectiveStatement> {
46 private static final SubstatementValidator RFC6020_VALIDATOR =
47 SubstatementValidator.builder(YangStmtMapping.SUBMODULE)
48 .addAny(YangStmtMapping.ANYXML)
49 .addAny(YangStmtMapping.AUGMENT)
50 .addMandatory(YangStmtMapping.BELONGS_TO)
51 .addAny(YangStmtMapping.CHOICE)
52 .addOptional(YangStmtMapping.CONTACT)
53 .addAny(YangStmtMapping.CONTAINER)
54 .addOptional(YangStmtMapping.DESCRIPTION)
55 .addAny(YangStmtMapping.DEVIATION)
56 .addAny(YangStmtMapping.EXTENSION)
57 .addAny(YangStmtMapping.FEATURE)
58 .addAny(YangStmtMapping.GROUPING)
59 .addAny(YangStmtMapping.IDENTITY)
60 .addAny(YangStmtMapping.IMPORT)
61 .addAny(YangStmtMapping.INCLUDE)
62 .addAny(YangStmtMapping.LEAF)
63 .addAny(YangStmtMapping.LEAF_LIST)
64 .addAny(YangStmtMapping.LIST)
65 .addAny(YangStmtMapping.NOTIFICATION)
66 .addOptional(YangStmtMapping.ORGANIZATION)
67 .addOptional(YangStmtMapping.REFERENCE)
68 .addAny(YangStmtMapping.REVISION)
69 .addAny(YangStmtMapping.RPC)
70 .addAny(YangStmtMapping.TYPEDEF)
71 .addAny(YangStmtMapping.USES)
72 .addOptional(YangStmtMapping.YANG_VERSION)
74 private static final SubstatementValidator RFC7950_VALIDATOR =
75 SubstatementValidator.builder(YangStmtMapping.SUBMODULE)
76 .addAny(YangStmtMapping.ANYDATA)
77 .addAny(YangStmtMapping.ANYXML)
78 .addAny(YangStmtMapping.AUGMENT)
79 .addMandatory(YangStmtMapping.BELONGS_TO)
80 .addAny(YangStmtMapping.CHOICE)
81 .addOptional(YangStmtMapping.CONTACT)
82 .addAny(YangStmtMapping.CONTAINER)
83 .addOptional(YangStmtMapping.DESCRIPTION)
84 .addAny(YangStmtMapping.DEVIATION)
85 .addAny(YangStmtMapping.EXTENSION)
86 .addAny(YangStmtMapping.FEATURE)
87 .addAny(YangStmtMapping.GROUPING)
88 .addAny(YangStmtMapping.IDENTITY)
89 .addAny(YangStmtMapping.IMPORT)
90 .addAny(YangStmtMapping.INCLUDE)
91 .addAny(YangStmtMapping.LEAF)
92 .addAny(YangStmtMapping.LEAF_LIST)
93 .addAny(YangStmtMapping.LIST)
94 .addAny(YangStmtMapping.NOTIFICATION)
95 .addOptional(YangStmtMapping.ORGANIZATION)
96 .addOptional(YangStmtMapping.REFERENCE)
97 .addAny(YangStmtMapping.REVISION)
98 .addAny(YangStmtMapping.RPC)
99 .addAny(YangStmtMapping.TYPEDEF)
100 .addAny(YangStmtMapping.USES)
101 .addOptional(YangStmtMapping.YANG_VERSION)
104 private SubmoduleStatementSupport(final YangParserConfiguration config, final SubstatementValidator validator) {
105 super(YangStmtMapping.SUBMODULE, StatementPolicy.reject(), config, validator);
108 public static @NonNull SubmoduleStatementSupport rfc6020Instance(final YangParserConfiguration config) {
109 return new SubmoduleStatementSupport(config, RFC6020_VALIDATOR);
112 public static @NonNull SubmoduleStatementSupport rfc7950Instance(final YangParserConfiguration config) {
113 return new SubmoduleStatementSupport(config, RFC7950_VALIDATOR);
117 public Unqualified parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
119 return UnresolvedQName.unqualified(value);
120 } catch (IllegalArgumentException e) {
121 throw new SourceException(e.getMessage(), ctx, e);
126 public void onPreLinkageDeclared(final Mutable<Unqualified, SubmoduleStatement, SubmoduleEffectiveStatement> stmt) {
127 stmt.setRootIdentifier(RevisionSourceIdentifier.create(stmt.getRawArgument(),
128 StmtContextUtils.getLatestRevision(stmt.declaredSubstatements())));
132 public void onLinkageDeclared(final Mutable<Unqualified, SubmoduleStatement, SubmoduleEffectiveStatement> stmt) {
133 final SourceIdentifier submoduleIdentifier = RevisionSourceIdentifier.create(stmt.getRawArgument(),
134 StmtContextUtils.getLatestRevision(stmt.declaredSubstatements()));
136 final StmtContext<?, SubmoduleStatement, SubmoduleEffectiveStatement>
137 possibleDuplicateSubmodule = stmt.getFromNamespace(SubmoduleNamespace.class, submoduleIdentifier);
138 if (possibleDuplicateSubmodule != null && possibleDuplicateSubmodule != stmt) {
139 throw new SourceException(stmt, "Submodule name collision: %s. At %s", stmt.rawArgument(),
140 possibleDuplicateSubmodule.sourceReference());
143 stmt.addContext(SubmoduleNamespace.class, submoduleIdentifier, stmt);
145 final String belongsToModuleName = firstAttributeOf(stmt.declaredSubstatements(), BelongsToStatement.class);
146 final StmtContext<?, ?, ?> prefixSubStmtCtx = SourceException.throwIfNull(
147 findFirstDeclaredSubstatement(stmt, 0, BelongsToStatement.class, PrefixStatement.class), stmt,
148 "Prefix of belongsTo statement is missing in submodule [%s]", stmt.rawArgument());
150 final String prefix = prefixSubStmtCtx.rawArgument();
151 stmt.addToNs(BelongsToPrefixToModuleName.class, prefix, belongsToModuleName);
155 protected SubmoduleStatement createDeclared(final StmtContext<Unqualified, SubmoduleStatement, ?> ctx,
156 final ImmutableList<? extends DeclaredStatement<?>> substatements) {
157 if (substatements.isEmpty()) {
158 throw noBelongsTo(ctx);
160 return DeclaredStatements.createSubmodule(ctx.getRawArgument(), ctx.getArgument(), substatements);
164 protected SubmoduleStatement attachDeclarationReference(final SubmoduleStatement stmt,
165 final DeclarationReference reference) {
166 return DeclaredStatementDecorators.decorateSubmodule(stmt, reference);
170 protected SubmoduleEffectiveStatement createEffective(final Current<Unqualified, SubmoduleStatement> stmt,
171 final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
172 if (substatements.isEmpty()) {
173 throw noBelongsTo(stmt);
176 return new SubmoduleEffectiveStatementImpl(stmt, substatements);
177 } catch (SubstatementIndexingException e) {
178 throw new SourceException(e.getMessage(), stmt, e);
182 private static SourceException noBelongsTo(final CommonStmtCtx stmt) {
183 return new SourceException("No belongs-to declared in submodule", stmt);