parser/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 com.google.common.annotations.Beta;
  11 import com.google.common.collect.ImmutableList;
  12 import java.util.Collection;
  13 import org.eclipse.jdt.annotation.NonNull;
  14 import org.opendaylight.yangtools.yang.common.QName;
  15 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
  16 import org.opendaylight.yangtools.yang.model.api.meta.DeclarationReference;
  17 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
  18 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  19 import org.opendaylight.yangtools.yang.model.api.stmt.GroupingEffectiveStatement;
  20 import org.opendaylight.yangtools.yang.model.api.stmt.GroupingStatement;
  21 import org.opendaylight.yangtools.yang.model.ri.stmt.DeclaredStatementDecorators;
  22 import org.opendaylight.yangtools.yang.model.ri.stmt.DeclaredStatements;
  23 import org.opendaylight.yangtools.yang.model.ri.stmt.EffectiveStatements;
  24 import org.opendaylight.yangtools.yang.model.spi.meta.EffectiveStatementMixins;
  25 import org.opendaylight.yangtools.yang.model.spi.meta.SubstatementIndexingException;
  26 import org.opendaylight.yangtools.yang.parser.api.YangParserConfiguration;
  27 import org.opendaylight.yangtools.yang.parser.spi.GroupingNamespace;
  28 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractQNameStatementSupport;
  29 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
  30 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder;
  31 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.InferenceAction;
  32 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.InferenceContext;
  33 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.Prerequisite;
  34 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase;
  35 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  36 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
  37 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
  38 import org.opendaylight.yangtools.yang.parser.spi.meta.SubstatementValidator;
  39 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
  40
  41 @Beta
  42 public final class GroupingStatementSupport
  43         extends AbstractQNameStatementSupport<GroupingStatement, GroupingEffectiveStatement> {
  44     private static final SubstatementValidator RFC6020_VALIDATOR =
  45         SubstatementValidator.builder(YangStmtMapping.GROUPING)
  46             .addAny(YangStmtMapping.ANYXML)
  47             .addAny(YangStmtMapping.CHOICE)
  48             .addAny(YangStmtMapping.CONTAINER)
  49             .addOptional(YangStmtMapping.DESCRIPTION)
  50             .addAny(YangStmtMapping.GROUPING)
  51             .addAny(YangStmtMapping.LEAF)
  52             .addAny(YangStmtMapping.LEAF_LIST)
  53             .addAny(YangStmtMapping.LIST)
  54             .addOptional(YangStmtMapping.REFERENCE)
  55             .addOptional(YangStmtMapping.STATUS)
  56             .addAny(YangStmtMapping.TYPEDEF)
  57             .addAny(YangStmtMapping.USES)
  58             .build();
  59     private static final SubstatementValidator RFC7950_VALIDATOR =
  60         SubstatementValidator.builder(YangStmtMapping.GROUPING)
  61             .addAny(YangStmtMapping.ACTION)
  62             .addAny(YangStmtMapping.ANYDATA)
  63             .addAny(YangStmtMapping.ANYXML)
  64             .addAny(YangStmtMapping.CHOICE)
  65             .addAny(YangStmtMapping.CONTAINER)
  66             .addOptional(YangStmtMapping.DESCRIPTION)
  67             .addAny(YangStmtMapping.GROUPING)
  68             .addAny(YangStmtMapping.LEAF)
  69             .addAny(YangStmtMapping.LEAF_LIST)
  70             .addAny(YangStmtMapping.LIST)
  71             .addAny(YangStmtMapping.NOTIFICATION)
  72             .addOptional(YangStmtMapping.REFERENCE)
  73             .addOptional(YangStmtMapping.STATUS)
  74             .addAny(YangStmtMapping.TYPEDEF)
  75             .addAny(YangStmtMapping.USES)
  76             .build();
  77
  78     GroupingStatementSupport(final YangParserConfiguration config, 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)), config, validator);
  84     }
  85
  86     public static @NonNull GroupingStatementSupport rfc6020Instance(final YangParserConfiguration config) {
  87         return new GroupingStatementSupport(config, RFC6020_VALIDATOR);
  88     }
  89
  90     public static @NonNull GroupingStatementSupport rfc7950Instance(final YangParserConfiguration config) {
  91         return new GroupingStatementSupport(config, RFC7950_VALIDATOR);
  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 GroupingStatement createDeclared(final StmtContext<QName, GroupingStatement, ?> ctx,
 135             final ImmutableList<? extends DeclaredStatement<?>> substatements) {
 136         return DeclaredStatements.createGrouping(ctx.getArgument(), substatements);
 137     }
 138
 139     @Override
 140     protected GroupingStatement attachDeclarationReference(final GroupingStatement stmt,
 141             final DeclarationReference reference) {
 142         return DeclaredStatementDecorators.decorateGrouping(stmt, reference);
 143     }
 144
 145     @Override
 146     protected GroupingEffectiveStatement createEffective(final Current<QName, GroupingStatement> stmt,
 147             final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
 148         try {
 149             return EffectiveStatements.createGrouping(stmt.declared(), substatements, stmt.effectivePath(),
 150                 EffectiveStatementMixins.historyAndStatusFlags(stmt.history(), substatements));
 151         } catch (SubstatementIndexingException e) {
 152             throw new SourceException(e.getMessage(), stmt, e);
 153         }
 154     }
 155
 156     private static void checkConflict(final StmtContext<?, ?, ?> parent, final StmtContext<QName, ?, ?> stmt) {
 157         final QName arg = stmt.getArgument();
 158         final StmtContext<?, ?, ?> existing = parent.getFromNamespace(GroupingNamespace.class, arg);
 159         SourceException.throwIf(existing != null, stmt, "Duplicate name for grouping %s", arg);
 160     }
 161 }