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.Unqualified;
17 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
18 import org.opendaylight.yangtools.yang.model.api.meta.DeclarationReference;
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.repo.api.SourceIdentifier;
26 import org.opendaylight.yangtools.yang.model.ri.stmt.DeclaredStatementDecorators;
27 import org.opendaylight.yangtools.yang.model.ri.stmt.DeclaredStatements;
28 import org.opendaylight.yangtools.yang.model.spi.meta.SubstatementIndexingException;
29 import org.opendaylight.yangtools.yang.parser.api.YangParserConfiguration;
30 import org.opendaylight.yangtools.yang.parser.spi.ParserNamespaces;
31 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractUnqualifiedStatementSupport;
32 import org.opendaylight.yangtools.yang.parser.spi.meta.BoundStmtCtx;
33 import org.opendaylight.yangtools.yang.parser.spi.meta.CommonStmtCtx;
34 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
35 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
36 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
37 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
38 import org.opendaylight.yangtools.yang.parser.spi.meta.SubstatementValidator;
39 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
40 import org.opendaylight.yangtools.yang.parser.spi.source.SourceParserNamespaces;
43 public final class SubmoduleStatementSupport
44 extends AbstractUnqualifiedStatementSupport<SubmoduleStatement, SubmoduleEffectiveStatement> {
45 private static final SubstatementValidator RFC6020_VALIDATOR =
46 SubstatementValidator.builder(YangStmtMapping.SUBMODULE)
47 .addAny(YangStmtMapping.ANYXML)
48 .addAny(YangStmtMapping.AUGMENT)
49 .addMandatory(YangStmtMapping.BELONGS_TO)
50 .addAny(YangStmtMapping.CHOICE)
51 .addOptional(YangStmtMapping.CONTACT)
52 .addAny(YangStmtMapping.CONTAINER)
53 .addOptional(YangStmtMapping.DESCRIPTION)
54 .addAny(YangStmtMapping.DEVIATION)
55 .addAny(YangStmtMapping.EXTENSION)
56 .addAny(YangStmtMapping.FEATURE)
57 .addAny(YangStmtMapping.GROUPING)
58 .addAny(YangStmtMapping.IDENTITY)
59 .addAny(YangStmtMapping.IMPORT)
60 .addAny(YangStmtMapping.INCLUDE)
61 .addAny(YangStmtMapping.LEAF)
62 .addAny(YangStmtMapping.LEAF_LIST)
63 .addAny(YangStmtMapping.LIST)
64 .addAny(YangStmtMapping.NOTIFICATION)
65 .addOptional(YangStmtMapping.ORGANIZATION)
66 .addOptional(YangStmtMapping.REFERENCE)
67 .addAny(YangStmtMapping.REVISION)
68 .addAny(YangStmtMapping.RPC)
69 .addAny(YangStmtMapping.TYPEDEF)
70 .addAny(YangStmtMapping.USES)
71 .addOptional(YangStmtMapping.YANG_VERSION)
73 private static final SubstatementValidator RFC7950_VALIDATOR =
74 SubstatementValidator.builder(YangStmtMapping.SUBMODULE)
75 .addAny(YangStmtMapping.ANYDATA)
76 .addAny(YangStmtMapping.ANYXML)
77 .addAny(YangStmtMapping.AUGMENT)
78 .addMandatory(YangStmtMapping.BELONGS_TO)
79 .addAny(YangStmtMapping.CHOICE)
80 .addOptional(YangStmtMapping.CONTACT)
81 .addAny(YangStmtMapping.CONTAINER)
82 .addOptional(YangStmtMapping.DESCRIPTION)
83 .addAny(YangStmtMapping.DEVIATION)
84 .addAny(YangStmtMapping.EXTENSION)
85 .addAny(YangStmtMapping.FEATURE)
86 .addAny(YangStmtMapping.GROUPING)
87 .addAny(YangStmtMapping.IDENTITY)
88 .addAny(YangStmtMapping.IMPORT)
89 .addAny(YangStmtMapping.INCLUDE)
90 .addAny(YangStmtMapping.LEAF)
91 .addAny(YangStmtMapping.LEAF_LIST)
92 .addAny(YangStmtMapping.LIST)
93 .addAny(YangStmtMapping.NOTIFICATION)
94 .addOptional(YangStmtMapping.ORGANIZATION)
95 .addOptional(YangStmtMapping.REFERENCE)
96 .addAny(YangStmtMapping.REVISION)
97 .addAny(YangStmtMapping.RPC)
98 .addAny(YangStmtMapping.TYPEDEF)
99 .addAny(YangStmtMapping.USES)
100 .addOptional(YangStmtMapping.YANG_VERSION)
103 private SubmoduleStatementSupport(final YangParserConfiguration config, final SubstatementValidator validator) {
104 super(YangStmtMapping.SUBMODULE, StatementPolicy.reject(), config, validator);
107 public static @NonNull SubmoduleStatementSupport rfc6020Instance(final YangParserConfiguration config) {
108 return new SubmoduleStatementSupport(config, RFC6020_VALIDATOR);
111 public static @NonNull SubmoduleStatementSupport rfc7950Instance(final YangParserConfiguration config) {
112 return new SubmoduleStatementSupport(config, RFC7950_VALIDATOR);
116 public void onPreLinkageDeclared(final Mutable<Unqualified, SubmoduleStatement, SubmoduleEffectiveStatement> stmt) {
117 stmt.setRootIdentifier(new SourceIdentifier(stmt.getArgument(),
118 StmtContextUtils.getLatestRevision(stmt.declaredSubstatements()).orElse(null)));
122 public void onLinkageDeclared(final Mutable<Unqualified, SubmoduleStatement, SubmoduleEffectiveStatement> stmt) {
123 final SourceIdentifier submoduleIdentifier = new SourceIdentifier(stmt.getArgument(),
124 StmtContextUtils.getLatestRevision(stmt.declaredSubstatements()).orElse(null));
126 final StmtContext<?, SubmoduleStatement, SubmoduleEffectiveStatement>
127 possibleDuplicateSubmodule = stmt.getFromNamespace(ParserNamespaces.SUBMODULE, submoduleIdentifier);
128 if (possibleDuplicateSubmodule != null && possibleDuplicateSubmodule != stmt) {
129 throw new SourceException(stmt, "Submodule name collision: %s. At %s", stmt.rawArgument(),
130 possibleDuplicateSubmodule.sourceReference());
133 stmt.addContext(ParserNamespaces.SUBMODULE, submoduleIdentifier, stmt);
135 final Unqualified belongsToModuleName = firstAttributeOf(stmt.declaredSubstatements(),
136 BelongsToStatement.class);
137 final StmtContext<?, ?, ?> prefixSubStmtCtx = SourceException.throwIfNull(
138 findFirstDeclaredSubstatement(stmt, 0, BelongsToStatement.class, PrefixStatement.class), stmt,
139 "Prefix of belongsTo statement is missing in submodule [%s]", stmt.rawArgument());
141 final String prefix = prefixSubStmtCtx.rawArgument();
142 stmt.addToNs(SourceParserNamespaces.BELONGSTO_PREFIX_TO_MODULE_NAME, prefix, belongsToModuleName);
146 protected SubmoduleStatement createDeclared(final BoundStmtCtx<Unqualified> ctx,
147 final ImmutableList<DeclaredStatement<?>> substatements) {
148 if (substatements.isEmpty()) {
149 throw noBelongsTo(ctx);
151 return DeclaredStatements.createSubmodule(ctx.getRawArgument(), ctx.getArgument(), substatements);
155 protected SubmoduleStatement attachDeclarationReference(final SubmoduleStatement stmt,
156 final DeclarationReference reference) {
157 return DeclaredStatementDecorators.decorateSubmodule(stmt, reference);
161 protected SubmoduleEffectiveStatement createEffective(final Current<Unqualified, SubmoduleStatement> stmt,
162 final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
163 if (substatements.isEmpty()) {
164 throw noBelongsTo(stmt);
167 return new SubmoduleEffectiveStatementImpl(stmt, substatements);
168 } catch (SubstatementIndexingException e) {
169 throw new SourceException(e.getMessage(), stmt, e);
173 private static SourceException noBelongsTo(final CommonStmtCtx stmt) {
174 return new SourceException("No belongs-to declared in submodule", stmt);