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