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