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.repo.api.RevisionSourceIdentifier;
26 import org.opendaylight.yangtools.yang.model.repo.api.SourceIdentifier;
27 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.SubstatementIndexingException;
28 import org.opendaylight.yangtools.yang.parser.spi.SubmoduleNamespace;
29 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractStatementSupport;
30 import org.opendaylight.yangtools.yang.parser.spi.meta.CommonStmtCtx;
31 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
32 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
33 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
34 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
35 import org.opendaylight.yangtools.yang.parser.spi.meta.SubstatementValidator;
36 import org.opendaylight.yangtools.yang.parser.spi.source.BelongsToPrefixToModuleName;
37 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
40 public final class SubmoduleStatementSupport
41 extends AbstractStatementSupport<UnqualifiedQName, SubmoduleStatement, SubmoduleEffectiveStatement> {
42 private static final @NonNull SubmoduleStatementSupport RFC6020_INSTANCE = new SubmoduleStatementSupport(
43 SubstatementValidator.builder(YangStmtMapping.SUBMODULE)
44 .addAny(YangStmtMapping.ANYXML)
45 .addAny(YangStmtMapping.AUGMENT)
46 .addMandatory(YangStmtMapping.BELONGS_TO)
47 .addAny(YangStmtMapping.CHOICE)
48 .addOptional(YangStmtMapping.CONTACT)
49 .addAny(YangStmtMapping.CONTAINER)
50 .addOptional(YangStmtMapping.DESCRIPTION)
51 .addAny(YangStmtMapping.DEVIATION)
52 .addAny(YangStmtMapping.EXTENSION)
53 .addAny(YangStmtMapping.FEATURE)
54 .addAny(YangStmtMapping.GROUPING)
55 .addAny(YangStmtMapping.IDENTITY)
56 .addAny(YangStmtMapping.IMPORT)
57 .addAny(YangStmtMapping.INCLUDE)
58 .addAny(YangStmtMapping.LEAF)
59 .addAny(YangStmtMapping.LEAF_LIST)
60 .addAny(YangStmtMapping.LIST)
61 .addAny(YangStmtMapping.NOTIFICATION)
62 .addOptional(YangStmtMapping.ORGANIZATION)
63 .addOptional(YangStmtMapping.REFERENCE)
64 .addAny(YangStmtMapping.REVISION)
65 .addAny(YangStmtMapping.RPC)
66 .addAny(YangStmtMapping.TYPEDEF)
67 .addAny(YangStmtMapping.USES)
68 .addOptional(YangStmtMapping.YANG_VERSION)
70 private static final @NonNull SubmoduleStatementSupport RFC7950_INSTANCE = new SubmoduleStatementSupport(
71 SubstatementValidator.builder(YangStmtMapping.SUBMODULE)
72 .addAny(YangStmtMapping.ANYDATA)
73 .addAny(YangStmtMapping.ANYXML)
74 .addAny(YangStmtMapping.AUGMENT)
75 .addMandatory(YangStmtMapping.BELONGS_TO)
76 .addAny(YangStmtMapping.CHOICE)
77 .addOptional(YangStmtMapping.CONTACT)
78 .addAny(YangStmtMapping.CONTAINER)
79 .addOptional(YangStmtMapping.DESCRIPTION)
80 .addAny(YangStmtMapping.DEVIATION)
81 .addAny(YangStmtMapping.EXTENSION)
82 .addAny(YangStmtMapping.FEATURE)
83 .addAny(YangStmtMapping.GROUPING)
84 .addAny(YangStmtMapping.IDENTITY)
85 .addAny(YangStmtMapping.IMPORT)
86 .addAny(YangStmtMapping.INCLUDE)
87 .addAny(YangStmtMapping.LEAF)
88 .addAny(YangStmtMapping.LEAF_LIST)
89 .addAny(YangStmtMapping.LIST)
90 .addAny(YangStmtMapping.NOTIFICATION)
91 .addOptional(YangStmtMapping.ORGANIZATION)
92 .addOptional(YangStmtMapping.REFERENCE)
93 .addAny(YangStmtMapping.REVISION)
94 .addAny(YangStmtMapping.RPC)
95 .addAny(YangStmtMapping.TYPEDEF)
96 .addAny(YangStmtMapping.USES)
97 .addOptional(YangStmtMapping.YANG_VERSION)
100 private final SubstatementValidator validator;
102 private SubmoduleStatementSupport(final SubstatementValidator validator) {
103 super(YangStmtMapping.SUBMODULE, StatementPolicy.reject());
104 this.validator = requireNonNull(validator);
107 public static @NonNull SubmoduleStatementSupport rfc6020Instance() {
108 return RFC6020_INSTANCE;
111 public static @NonNull SubmoduleStatementSupport rfc7950Instance() {
112 return RFC7950_INSTANCE;
116 public UnqualifiedQName parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
118 return UnqualifiedQName.of(value);
119 } catch (IllegalArgumentException e) {
120 throw new SourceException(e.getMessage(), ctx, e);
125 public void onPreLinkageDeclared(
126 final Mutable<UnqualifiedQName, SubmoduleStatement, SubmoduleEffectiveStatement> stmt) {
127 stmt.setRootIdentifier(RevisionSourceIdentifier.create(stmt.getRawArgument(),
128 StmtContextUtils.getLatestRevision(stmt.declaredSubstatements())));
132 public void onLinkageDeclared(
133 final Mutable<UnqualifiedQName, 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 SubstatementValidator getSubstatementValidator() {
161 protected SubmoduleStatement createDeclared(final StmtContext<UnqualifiedQName, SubmoduleStatement, ?> ctx,
162 final ImmutableList<? extends DeclaredStatement<?>> substatements) {
163 return new SubmoduleStatementImpl(ctx.getRawArgument(), ctx.getArgument(), substatements);
167 protected SubmoduleStatement createEmptyDeclared(
168 final StmtContext<UnqualifiedQName, SubmoduleStatement, ?> ctx) {
169 throw noBelongsTo(ctx);
173 protected SubmoduleEffectiveStatement createEffective(final Current<UnqualifiedQName, SubmoduleStatement> stmt,
174 final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
175 if (substatements.isEmpty()) {
176 throw noBelongsTo(stmt);
179 return new SubmoduleEffectiveStatementImpl(stmt, substatements);
180 } catch (SubstatementIndexingException e) {
181 throw new SourceException(e.getMessage(), stmt, e);
185 private static SourceException noBelongsTo(final CommonStmtCtx stmt) {
186 return new SourceException("No belongs-to declared in submodule", stmt);