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