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