Merge branch 'master' of ../controller
[yangtools.git] / yang / yang-parser-rfc7950 / src / main / java / org / opendaylight / yangtools / yang / parser / rfc7950 / stmt / grouping / AbstractGroupingStatementSupport.java
1 /*
2  * Copyright (c) 2017 Pantheon Technologies, s.r.o. and others.  All rights reserved.
3  *
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
7  */
8 package org.opendaylight.yangtools.yang.parser.rfc7950.stmt.grouping;
9
10 import org.opendaylight.yangtools.yang.common.QName;
11 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
12 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
13 import org.opendaylight.yangtools.yang.model.api.stmt.GroupingStatement;
14 import org.opendaylight.yangtools.yang.parser.spi.GroupingNamespace;
15 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractQNameStatementSupport;
16 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
17 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
18 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
19 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
20
21 abstract class AbstractGroupingStatementSupport
22         extends AbstractQNameStatementSupport<GroupingStatement, EffectiveStatement<QName, GroupingStatement>> {
23
24     AbstractGroupingStatementSupport() {
25         super(YangStmtMapping.GROUPING);
26     }
27
28     @Override
29     public final QName parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
30         return StmtContextUtils.parseIdentifier(ctx, value);
31     }
32
33     @Override
34     public final GroupingStatement createDeclared(final StmtContext<QName, GroupingStatement, ?> ctx) {
35         // Shadowing check: make sure grandparent does not see a conflicting definition. This is required to ensure
36         // that a grouping in child scope does not shadow a grouping in parent scope which occurs later in the text.
37         final StmtContext<?, ?, ?> parent = ctx.getParentContext();
38         if (parent != null) {
39             final StmtContext<?, ?, ?> grandParent = parent.getParentContext();
40             if (grandParent != null) {
41                 checkConflict(grandParent, ctx);
42             }
43         }
44
45         return new GroupingStatementImpl(ctx);
46     }
47
48     @Override
49     public final EffectiveStatement<QName, GroupingStatement> createEffective(
50             final StmtContext<QName, GroupingStatement, EffectiveStatement<QName, GroupingStatement>> ctx) {
51         return new GroupingEffectiveStatementImpl(ctx);
52     }
53
54     @Override
55     public final void onFullDefinitionDeclared(final Mutable<QName, GroupingStatement,
56             EffectiveStatement<QName, GroupingStatement>> stmt) {
57         super.onFullDefinitionDeclared(stmt);
58
59         if (stmt != null) {
60             final Mutable<?, ?, ?> parent = stmt.getParentContext();
61             if (parent != null) {
62                 // Shadowing check: make sure we do not trample on pre-existing definitions. This catches sibling
63                 // declarations and parent declarations which have already been declared.
64                 checkConflict(parent, stmt);
65                 parent.addContext(GroupingNamespace.class, stmt.coerceStatementArgument(), stmt);
66             }
67         }
68     }
69
70     private static void checkConflict(final StmtContext<?, ?, ?> parent, final StmtContext<QName, ?, ?> stmt) {
71         final QName arg = stmt.coerceStatementArgument();
72         final StmtContext<?, ?, ?> existing = parent.getFromNamespace(GroupingNamespace.class, arg);
73         SourceException.throwIf(existing != null, stmt.getStatementSourceReference(), "Duplicate name for grouping %s",
74                 arg);
75     }
76 }