yang/yang-parser-rfc7950/src/main/java/org/opendaylight/yangtools/yang/parser/rfc7950/stmt/grouping/GroupingStatementSupport.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 static java.util.Objects.requireNonNull;
  11
  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.model.ri.stmt.DeclaredStatements;
  23 import org.opendaylight.yangtools.yang.model.spi.meta.EffectiveStatementMixins;
  24 import org.opendaylight.yangtools.yang.model.spi.meta.SubstatementIndexingException;
  25 import org.opendaylight.yangtools.yang.parser.spi.GroupingNamespace;
  26 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractQNameStatementSupport;
  27 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
  28 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder;
  29 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.InferenceAction;
  30 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.InferenceContext;
  31 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.Prerequisite;
  32 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase;
  33 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  34 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
  35 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
  36 import org.opendaylight.yangtools.yang.parser.spi.meta.SubstatementValidator;
  37 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
  38
  39 @Beta
  40 public final class GroupingStatementSupport
  41         extends AbstractQNameStatementSupport<GroupingStatement, GroupingEffectiveStatement> {
  42     private static final @NonNull GroupingStatementSupport RFC6020_INSTANCE = new GroupingStatementSupport(
  43         SubstatementValidator.builder(YangStmtMapping.GROUPING)
  44             .addAny(YangStmtMapping.ANYXML)
  45             .addAny(YangStmtMapping.CHOICE)
  46             .addAny(YangStmtMapping.CONTAINER)
  47             .addOptional(YangStmtMapping.DESCRIPTION)
  48             .addAny(YangStmtMapping.GROUPING)
  49             .addAny(YangStmtMapping.LEAF)
  50             .addAny(YangStmtMapping.LEAF_LIST)
  51             .addAny(YangStmtMapping.LIST)
  52             .addOptional(YangStmtMapping.REFERENCE)
  53             .addOptional(YangStmtMapping.STATUS)
  54             .addAny(YangStmtMapping.TYPEDEF)
  55             .addAny(YangStmtMapping.USES)
  56             .build());
  57     private static final @NonNull GroupingStatementSupport RFC7950_INSTANCE = new GroupingStatementSupport(
  58         SubstatementValidator.builder(YangStmtMapping.GROUPING)
  59             .addAny(YangStmtMapping.ACTION)
  60             .addAny(YangStmtMapping.ANYDATA)
  61             .addAny(YangStmtMapping.ANYXML)
  62             .addAny(YangStmtMapping.CHOICE)
  63             .addAny(YangStmtMapping.CONTAINER)
  64             .addOptional(YangStmtMapping.DESCRIPTION)
  65             .addAny(YangStmtMapping.GROUPING)
  66             .addAny(YangStmtMapping.LEAF)
  67             .addAny(YangStmtMapping.LEAF_LIST)
  68             .addAny(YangStmtMapping.LIST)
  69             .addAny(YangStmtMapping.NOTIFICATION)
  70             .addOptional(YangStmtMapping.REFERENCE)
  71             .addOptional(YangStmtMapping.STATUS)
  72             .addAny(YangStmtMapping.TYPEDEF)
  73             .addAny(YangStmtMapping.USES)
  74             .build());
  75
  76     private final SubstatementValidator validator;
  77
  78     GroupingStatementSupport(final SubstatementValidator validator) {
  79         super(YangStmtMapping.GROUPING, StatementPolicy.copyDeclared(
  80             (copy, current, substatements) ->
  81                 copy.history().isAddedByUses() == current.history().isAddedByUses()
  82                 && copy.getArgument().equals(current.getArgument())
  83                 && copy.equalParentPath(current)));
  84         this.validator = requireNonNull(validator);
  85     }
  86
  87     public static @NonNull GroupingStatementSupport rfc6020Instance() {
  88         return RFC6020_INSTANCE;
  89     }
  90
  91     public static @NonNull GroupingStatementSupport rfc7950Instance() {
  92         return RFC7950_INSTANCE;
  93     }
  94
  95     @Override
  96     public QName parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
  97         return StmtContextUtils.parseIdentifier(ctx, value);
  98     }
  99
 100     @Override
 101     public void onFullDefinitionDeclared(
 102             final Mutable<QName, GroupingStatement, GroupingEffectiveStatement> stmt) {
 103         super.onFullDefinitionDeclared(stmt);
 104
 105         final Mutable<?, ?, ?> parent = stmt.getParentContext();
 106         if (parent != null) {
 107             // Shadowing check: make sure we do not trample on pre-existing definitions. This catches sibling
 108             // declarations and parent declarations which have already been declared.
 109             checkConflict(parent, stmt);
 110             parent.addContext(GroupingNamespace.class, stmt.getArgument(), stmt);
 111
 112             final StmtContext<?, ?, ?> grandParent = parent.getParentContext();
 113             if (grandParent != null) {
 114                 // Shadowing check: make sure grandparent does not see a conflicting definition. This is required to
 115                 // ensure that a grouping in child scope does not shadow a grouping in parent scope which occurs later
 116                 // in the text. For that check we need the full declaration of our model.
 117                 final ModelActionBuilder action = stmt.newInferenceAction(ModelProcessingPhase.FULL_DECLARATION);
 118                 action.requiresCtx(grandParent.getRoot(), ModelProcessingPhase.FULL_DECLARATION);
 119                 action.apply(new InferenceAction() {
 120                     @Override
 121                     public void apply(final InferenceContext ctx) {
 122                         checkConflict(grandParent, stmt);
 123                     }
 124
 125                     @Override
 126                     public void prerequisiteFailed(final Collection<? extends Prerequisite<?>> failed) {
 127                         // No-op
 128                     }
 129                 });
 130             }
 131         }
 132     }
 133
 134     @Override
 135     protected SubstatementValidator getSubstatementValidator() {
 136         return validator;
 137     }
 138
 139     @Override
 140     protected GroupingStatement createDeclared(final StmtContext<QName, GroupingStatement, ?> ctx,
 141             final ImmutableList<? extends DeclaredStatement<?>> substatements) {
 142         return DeclaredStatements.createGrouping(ctx.getArgument(), substatements);
 143     }
 144
 145     @Override
 146     protected GroupingStatement createEmptyDeclared(final StmtContext<QName, GroupingStatement, ?> ctx) {
 147         return DeclaredStatements.createGrouping(ctx.getArgument());
 148     }
 149
 150     @Override
 151     protected GroupingEffectiveStatement createEffective(final Current<QName, GroupingStatement> stmt,
 152             final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
 153         try {
 154             return new GroupingEffectiveStatementImpl(stmt.declared(), substatements, stmt.effectivePath(),
 155                 EffectiveStatementMixins.historyAndStatusFlags(stmt.history(), substatements));
 156         } catch (SubstatementIndexingException e) {
 157             throw new SourceException(e.getMessage(), stmt, e);
 158         }
 159     }
 160
 161     private static void checkConflict(final StmtContext<?, ?, ?> parent, final StmtContext<QName, ?, ?> stmt) {
 162         final QName arg = stmt.getArgument();
 163         final StmtContext<?, ?, ?> existing = parent.getFromNamespace(GroupingNamespace.class, arg);
 164         SourceException.throwIf(existing != null, stmt, "Duplicate name for grouping %s", arg);
 165     }
 166 }