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