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.BoundStmtCtx;
35 import org.opendaylight.yangtools.yang.parser.spi.meta.CommonStmtCtx;
36 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
37 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
38 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
39 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
40 import org.opendaylight.yangtools.yang.parser.spi.meta.SubstatementValidator;
41 import org.opendaylight.yangtools.yang.parser.spi.source.BelongsToPrefixToModuleName;
42 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
45 public final class SubmoduleStatementSupport
46 extends AbstractStatementSupport<Unqualified, SubmoduleStatement, SubmoduleEffectiveStatement> {
47 private static final SubstatementValidator RFC6020_VALIDATOR =
48 SubstatementValidator.builder(YangStmtMapping.SUBMODULE)
49 .addAny(YangStmtMapping.ANYXML)
50 .addAny(YangStmtMapping.AUGMENT)
51 .addMandatory(YangStmtMapping.BELONGS_TO)
52 .addAny(YangStmtMapping.CHOICE)
53 .addOptional(YangStmtMapping.CONTACT)
54 .addAny(YangStmtMapping.CONTAINER)
55 .addOptional(YangStmtMapping.DESCRIPTION)
56 .addAny(YangStmtMapping.DEVIATION)
57 .addAny(YangStmtMapping.EXTENSION)
58 .addAny(YangStmtMapping.FEATURE)
59 .addAny(YangStmtMapping.GROUPING)
60 .addAny(YangStmtMapping.IDENTITY)
61 .addAny(YangStmtMapping.IMPORT)
62 .addAny(YangStmtMapping.INCLUDE)
63 .addAny(YangStmtMapping.LEAF)
64 .addAny(YangStmtMapping.LEAF_LIST)
65 .addAny(YangStmtMapping.LIST)
66 .addAny(YangStmtMapping.NOTIFICATION)
67 .addOptional(YangStmtMapping.ORGANIZATION)
68 .addOptional(YangStmtMapping.REFERENCE)
69 .addAny(YangStmtMapping.REVISION)
70 .addAny(YangStmtMapping.RPC)
71 .addAny(YangStmtMapping.TYPEDEF)
72 .addAny(YangStmtMapping.USES)
73 .addOptional(YangStmtMapping.YANG_VERSION)
75 private static final SubstatementValidator RFC7950_VALIDATOR =
76 SubstatementValidator.builder(YangStmtMapping.SUBMODULE)
77 .addAny(YangStmtMapping.ANYDATA)
78 .addAny(YangStmtMapping.ANYXML)
79 .addAny(YangStmtMapping.AUGMENT)
80 .addMandatory(YangStmtMapping.BELONGS_TO)
81 .addAny(YangStmtMapping.CHOICE)
82 .addOptional(YangStmtMapping.CONTACT)
83 .addAny(YangStmtMapping.CONTAINER)
84 .addOptional(YangStmtMapping.DESCRIPTION)
85 .addAny(YangStmtMapping.DEVIATION)
86 .addAny(YangStmtMapping.EXTENSION)
87 .addAny(YangStmtMapping.FEATURE)
88 .addAny(YangStmtMapping.GROUPING)
89 .addAny(YangStmtMapping.IDENTITY)
90 .addAny(YangStmtMapping.IMPORT)
91 .addAny(YangStmtMapping.INCLUDE)
92 .addAny(YangStmtMapping.LEAF)
93 .addAny(YangStmtMapping.LEAF_LIST)
94 .addAny(YangStmtMapping.LIST)
95 .addAny(YangStmtMapping.NOTIFICATION)
96 .addOptional(YangStmtMapping.ORGANIZATION)
97 .addOptional(YangStmtMapping.REFERENCE)
98 .addAny(YangStmtMapping.REVISION)
99 .addAny(YangStmtMapping.RPC)
100 .addAny(YangStmtMapping.TYPEDEF)
101 .addAny(YangStmtMapping.USES)
102 .addOptional(YangStmtMapping.YANG_VERSION)
105 private SubmoduleStatementSupport(final YangParserConfiguration config, final SubstatementValidator validator) {
106 super(YangStmtMapping.SUBMODULE, StatementPolicy.reject(), config, 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 Unqualified parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
120 return UnresolvedQName.unqualified(value);
121 } catch (IllegalArgumentException e) {
122 throw new SourceException(e.getMessage(), ctx, e);
127 public void onPreLinkageDeclared(final Mutable<Unqualified, SubmoduleStatement, SubmoduleEffectiveStatement> stmt) {
128 stmt.setRootIdentifier(RevisionSourceIdentifier.create(stmt.getRawArgument(),
129 StmtContextUtils.getLatestRevision(stmt.declaredSubstatements())));
133 public void onLinkageDeclared(final Mutable<Unqualified, SubmoduleStatement, SubmoduleEffectiveStatement> stmt) {
134 final SourceIdentifier submoduleIdentifier = RevisionSourceIdentifier.create(stmt.getRawArgument(),
135 StmtContextUtils.getLatestRevision(stmt.declaredSubstatements()));
137 final StmtContext<?, SubmoduleStatement, SubmoduleEffectiveStatement>
138 possibleDuplicateSubmodule = stmt.getFromNamespace(SubmoduleNamespace.class, submoduleIdentifier);
139 if (possibleDuplicateSubmodule != null && possibleDuplicateSubmodule != stmt) {
140 throw new SourceException(stmt, "Submodule name collision: %s. At %s", stmt.rawArgument(),
141 possibleDuplicateSubmodule.sourceReference());
144 stmt.addContext(SubmoduleNamespace.class, submoduleIdentifier, stmt);
146 final String belongsToModuleName = firstAttributeOf(stmt.declaredSubstatements(), BelongsToStatement.class);
147 final StmtContext<?, ?, ?> prefixSubStmtCtx = SourceException.throwIfNull(
148 findFirstDeclaredSubstatement(stmt, 0, BelongsToStatement.class, PrefixStatement.class), stmt,
149 "Prefix of belongsTo statement is missing in submodule [%s]", stmt.rawArgument());
151 final String prefix = prefixSubStmtCtx.rawArgument();
152 stmt.addToNs(BelongsToPrefixToModuleName.class, prefix, belongsToModuleName);
156 protected SubmoduleStatement createDeclared(final BoundStmtCtx<Unqualified> ctx,
157 final ImmutableList<DeclaredStatement<?>> substatements) {
158 if (substatements.isEmpty()) {
159 throw noBelongsTo(ctx);
161 return DeclaredStatements.createSubmodule(ctx.getRawArgument(), ctx.getArgument(), substatements);
165 protected SubmoduleStatement attachDeclarationReference(final SubmoduleStatement stmt,
166 final DeclarationReference reference) {
167 return DeclaredStatementDecorators.decorateSubmodule(stmt, reference);
171 protected SubmoduleEffectiveStatement createEffective(final Current<Unqualified, SubmoduleStatement> stmt,
172 final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
173 if (substatements.isEmpty()) {
174 throw noBelongsTo(stmt);
177 return new SubmoduleEffectiveStatementImpl(stmt, substatements);
178 } catch (SubstatementIndexingException e) {
179 throw new SourceException(e.getMessage(), stmt, e);
183 private static SourceException noBelongsTo(final CommonStmtCtx stmt) {
184 return new SourceException("No belongs-to declared in submodule", stmt);