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 com.google.common.collect.ImmutableList;
  11 import org.opendaylight.yangtools.yang.common.QName;
  12 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
  13 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
  14 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  15 import org.opendaylight.yangtools.yang.model.api.stmt.GroupingEffectiveStatement;
  16 import org.opendaylight.yangtools.yang.model.api.stmt.GroupingStatement;
  17 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.BaseQNameStatementSupport;
  18 import org.opendaylight.yangtools.yang.parser.spi.GroupingNamespace;
  19 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  20 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
  21 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
  22 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
  23
  24 abstract class AbstractGroupingStatementSupport
  25         extends BaseQNameStatementSupport<GroupingStatement, GroupingEffectiveStatement> {
  26     AbstractGroupingStatementSupport() {
  27         super(YangStmtMapping.GROUPING);
  28     }
  29
  30     @Override
  31     public final QName parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
  32         return StmtContextUtils.parseIdentifier(ctx, value);
  33     }
  34
  35     @Override
  36     public final void onFullDefinitionDeclared(
  37             final Mutable<QName, GroupingStatement, GroupingEffectiveStatement> stmt) {
  38         super.onFullDefinitionDeclared(stmt);
  39
  40         if (stmt != null) {
  41             final Mutable<?, ?, ?> parent = stmt.getParentContext();
  42             if (parent != null) {
  43                 // Shadowing check: make sure we do not trample on pre-existing definitions. This catches sibling
  44                 // declarations and parent declarations which have already been declared.
  45                 checkConflict(parent, stmt);
  46                 parent.addContext(GroupingNamespace.class, stmt.coerceStatementArgument(), stmt);
  47             }
  48         }
  49     }
  50
  51     @Override
  52     protected final GroupingStatement createDeclared(final StmtContext<QName, GroupingStatement, ?> ctx,
  53             final ImmutableList<? extends DeclaredStatement<?>> substatements) {
  54         checkDeclaredConflict(ctx);
  55         return new RegularGroupingStatement(ctx.coerceStatementArgument(), substatements);
  56     }
  57
  58     @Override
  59     protected final GroupingStatement createEmptyDeclared(final StmtContext<QName, GroupingStatement, ?> ctx) {
  60         checkDeclaredConflict(ctx);
  61         return new EmptyGroupingStatement(ctx.coerceStatementArgument());
  62     }
  63
  64     @Override
  65     protected final GroupingEffectiveStatement createEffective(
  66             final StmtContext<QName, GroupingStatement, GroupingEffectiveStatement> ctx,
  67             final GroupingStatement declared, final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
  68         return new GroupingEffectiveStatementImpl(declared, ctx, substatements,
  69             historyAndStatusFlags(ctx, substatements));
  70     }
  71
  72     @Override
  73     protected GroupingEffectiveStatement createEmptyEffective(
  74             final StmtContext<QName, GroupingStatement, GroupingEffectiveStatement> ctx,
  75             final GroupingStatement declared) {
  76         return createEffective(ctx, declared, ImmutableList.of());
  77     }
  78
  79     private static void checkDeclaredConflict(final StmtContext<QName, ?, ?> ctx) {
  80         // Shadowing check: make sure grandparent does not see a conflicting definition. This is required to ensure
  81         // that a grouping in child scope does not shadow a grouping in parent scope which occurs later in the text.
  82         final StmtContext<?, ?, ?> parent = ctx.getParentContext();
  83         if (parent != null) {
  84             final StmtContext<?, ?, ?> grandParent = parent.getParentContext();
  85             if (grandParent != null) {
  86                 checkConflict(grandParent, ctx);
  87             }
  88         }
  89     }
  90
  91     private static void checkConflict(final StmtContext<?, ?, ?> parent, final StmtContext<QName, ?, ?> stmt) {
  92         final QName arg = stmt.coerceStatementArgument();
  93         final StmtContext<?, ?, ?> existing = parent.getFromNamespace(GroupingNamespace.class, arg);
  94         SourceException.throwIf(existing != null, stmt.getStatementSourceReference(), "Duplicate name for grouping %s",
  95                 arg);
  96     }
  97 }