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.grouping;
10 import static java.util.Objects.requireNonNull;
12 import com.google.common.annotations.Beta;
13 import com.google.common.collect.ImmutableList;
14 import java.util.Collection;
15 import org.eclipse.jdt.annotation.NonNull;
16 import org.opendaylight.yangtools.yang.common.QName;
17 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
18 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
19 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
20 import org.opendaylight.yangtools.yang.model.api.stmt.GroupingEffectiveStatement;
21 import org.opendaylight.yangtools.yang.model.api.stmt.GroupingStatement;
22 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.EffectiveStatementMixins;
23 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.SubstatementIndexingException;
24 import org.opendaylight.yangtools.yang.parser.spi.GroupingNamespace;
25 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractQNameStatementSupport;
26 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
27 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder;
28 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.InferenceAction;
29 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.InferenceContext;
30 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.Prerequisite;
31 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase;
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.SourceException;
39 public final class GroupingStatementSupport
40 extends AbstractQNameStatementSupport<GroupingStatement, GroupingEffectiveStatement> {
41 private static final @NonNull GroupingStatementSupport RFC6020_INSTANCE = new GroupingStatementSupport(
42 SubstatementValidator.builder(YangStmtMapping.GROUPING)
43 .addAny(YangStmtMapping.ANYXML)
44 .addAny(YangStmtMapping.CHOICE)
45 .addAny(YangStmtMapping.CONTAINER)
46 .addOptional(YangStmtMapping.DESCRIPTION)
47 .addAny(YangStmtMapping.GROUPING)
48 .addAny(YangStmtMapping.LEAF)
49 .addAny(YangStmtMapping.LEAF_LIST)
50 .addAny(YangStmtMapping.LIST)
51 .addOptional(YangStmtMapping.REFERENCE)
52 .addOptional(YangStmtMapping.STATUS)
53 .addAny(YangStmtMapping.TYPEDEF)
54 .addAny(YangStmtMapping.USES)
56 private static final @NonNull GroupingStatementSupport RFC7950_INSTANCE = new GroupingStatementSupport(
57 SubstatementValidator.builder(YangStmtMapping.GROUPING)
58 .addAny(YangStmtMapping.ACTION)
59 .addAny(YangStmtMapping.ANYDATA)
60 .addAny(YangStmtMapping.ANYXML)
61 .addAny(YangStmtMapping.CHOICE)
62 .addAny(YangStmtMapping.CONTAINER)
63 .addOptional(YangStmtMapping.DESCRIPTION)
64 .addAny(YangStmtMapping.GROUPING)
65 .addAny(YangStmtMapping.LEAF)
66 .addAny(YangStmtMapping.LEAF_LIST)
67 .addAny(YangStmtMapping.LIST)
68 .addAny(YangStmtMapping.NOTIFICATION)
69 .addOptional(YangStmtMapping.REFERENCE)
70 .addOptional(YangStmtMapping.STATUS)
71 .addAny(YangStmtMapping.TYPEDEF)
72 .addAny(YangStmtMapping.USES)
75 private final SubstatementValidator validator;
77 GroupingStatementSupport(final SubstatementValidator validator) {
78 super(YangStmtMapping.GROUPING, CopyPolicy.DECLARED_COPY);
79 this.validator = requireNonNull(validator);
82 public static @NonNull GroupingStatementSupport rfc6020Instance() {
83 return RFC6020_INSTANCE;
86 public static @NonNull GroupingStatementSupport rfc7950Instance() {
87 return RFC7950_INSTANCE;
91 public QName parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
92 return StmtContextUtils.parseIdentifier(ctx, value);
96 public void onFullDefinitionDeclared(
97 final Mutable<QName, GroupingStatement, GroupingEffectiveStatement> stmt) {
98 super.onFullDefinitionDeclared(stmt);
100 final Mutable<?, ?, ?> parent = stmt.getParentContext();
101 if (parent != null) {
102 // Shadowing check: make sure we do not trample on pre-existing definitions. This catches sibling
103 // declarations and parent declarations which have already been declared.
104 checkConflict(parent, stmt);
105 parent.addContext(GroupingNamespace.class, stmt.getArgument(), stmt);
107 final StmtContext<?, ?, ?> grandParent = parent.getParentContext();
108 if (grandParent != null) {
109 // Shadowing check: make sure grandparent does not see a conflicting definition. This is required to
110 // ensure that a grouping in child scope does not shadow a grouping in parent scope which occurs later
111 // in the text. For that check we need the full declaration of our model.
112 final ModelActionBuilder action = stmt.newInferenceAction(ModelProcessingPhase.FULL_DECLARATION);
113 action.requiresCtx(grandParent.getRoot(), ModelProcessingPhase.FULL_DECLARATION);
114 action.apply(new InferenceAction() {
116 public void apply(final InferenceContext ctx) {
117 checkConflict(grandParent, stmt);
121 public void prerequisiteFailed(final Collection<? extends Prerequisite<?>> failed) {
130 protected SubstatementValidator getSubstatementValidator() {
135 protected GroupingStatement createDeclared(final StmtContext<QName, GroupingStatement, ?> ctx,
136 final ImmutableList<? extends DeclaredStatement<?>> substatements) {
137 return new RegularGroupingStatement(ctx.getArgument(), substatements);
141 protected GroupingStatement createEmptyDeclared(final StmtContext<QName, GroupingStatement, ?> ctx) {
142 return new EmptyGroupingStatement(ctx.getArgument());
146 protected GroupingEffectiveStatement createEffective(final Current<QName, GroupingStatement> stmt,
147 final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
149 return new GroupingEffectiveStatementImpl(stmt.declared(), substatements,
150 EffectiveStatementMixins.historyAndStatusFlags(stmt.history(), substatements), stmt.wrapSchemaPath());
151 } catch (SubstatementIndexingException e) {
152 throw new SourceException(e.getMessage(), stmt, e);
156 private static void checkConflict(final StmtContext<?, ?, ?> parent, final StmtContext<QName, ?, ?> stmt) {
157 final QName arg = stmt.getArgument();
158 final StmtContext<?, ?, ?> existing = parent.getFromNamespace(GroupingNamespace.class, arg);
159 SourceException.throwIf(existing != null, stmt, "Duplicate name for grouping %s", arg);