parser/yang-parser-rfc7950/src/main/java/org/opendaylight/yangtools/yang/parser/rfc7950/stmt/meta/ActionStatementSupport.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 com.google.common.base.Verify.verify;
  11 import static com.google.common.base.Verify.verifyNotNull;
  12
  13 import com.google.common.collect.ImmutableList;
  14 import com.google.common.collect.ImmutableSet;
  15 import org.opendaylight.yangtools.yang.common.QName;
  16 import org.opendaylight.yangtools.yang.model.api.ActionDefinition;
  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.meta.StatementDefinition;
  22 import org.opendaylight.yangtools.yang.model.api.stmt.ActionEffectiveStatement;
  23 import org.opendaylight.yangtools.yang.model.api.stmt.ActionStatement;
  24 import org.opendaylight.yangtools.yang.model.api.stmt.InputStatement;
  25 import org.opendaylight.yangtools.yang.model.api.stmt.OutputStatement;
  26 import org.opendaylight.yangtools.yang.model.ri.stmt.DeclaredStatementDecorators;
  27 import org.opendaylight.yangtools.yang.model.ri.stmt.DeclaredStatements;
  28 import org.opendaylight.yangtools.yang.model.ri.stmt.EffectiveStatements;
  29 import org.opendaylight.yangtools.yang.model.spi.meta.SubstatementIndexingException;
  30 import org.opendaylight.yangtools.yang.parser.api.YangParserConfiguration;
  31 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.EffectiveStmtUtils;
  32 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractSchemaTreeStatementSupport;
  33 import org.opendaylight.yangtools.yang.parser.spi.meta.BoundStmtCtx;
  34 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStatementState;
  35 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
  36 import org.opendaylight.yangtools.yang.parser.spi.meta.QNameWithFlagsEffectiveStatementState;
  37 import org.opendaylight.yangtools.yang.parser.spi.meta.StatementSupportNamespace;
  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 import org.opendaylight.yangtools.yang.parser.spi.source.StatementSourceReference;
  43
  44 public final class ActionStatementSupport extends
  45         AbstractSchemaTreeStatementSupport<ActionStatement, ActionEffectiveStatement> {
  46
  47     private static final ImmutableSet<StatementDefinition> ILLEGAL_PARENTS = ImmutableSet.of(
  48             YangStmtMapping.NOTIFICATION, YangStmtMapping.RPC, YangStmtMapping.ACTION);
  49
  50     private static final SubstatementValidator SUBSTATEMENT_VALIDATOR =
  51         SubstatementValidator.builder(YangStmtMapping.ACTION)
  52             .addOptional(YangStmtMapping.DESCRIPTION)
  53             .addAny(YangStmtMapping.GROUPING)
  54             .addAny(YangStmtMapping.IF_FEATURE)
  55             .addOptional(YangStmtMapping.INPUT)
  56             .addOptional(YangStmtMapping.OUTPUT)
  57             .addOptional(YangStmtMapping.REFERENCE)
  58             .addOptional(YangStmtMapping.STATUS)
  59             .addAny(YangStmtMapping.TYPEDEF)
  60             .build();
  61
  62     public ActionStatementSupport(final YangParserConfiguration config) {
  63         super(YangStmtMapping.ACTION, uninstantiatedPolicy(), config, SUBSTATEMENT_VALIDATOR);
  64     }
  65
  66     @Override
  67     public void onStatementAdded(final Mutable<QName, ActionStatement, ActionEffectiveStatement> stmt) {
  68         final QName argument = stmt.getArgument();
  69         SourceException.throwIf(StmtContextUtils.hasAncestorOfType(stmt, ILLEGAL_PARENTS), stmt,
  70             "Action %s is defined within a notification, rpc or another action", argument);
  71         SourceException.throwIf(StmtContextUtils.hasParentOfType(stmt, YangStmtMapping.CASE), stmt,
  72             "Action %s is defined within a case statement", argument);
  73         SourceException.throwIf(StmtContextUtils.hasParentOfType(stmt, YangStmtMapping.MODULE), stmt,
  74             "Action %s is defined at the top level of a module", stmt.getArgument());
  75         StmtContextUtils.validateNoKeylessListAncestorOf(stmt, "Action");
  76
  77         super.onStatementAdded(stmt);
  78     }
  79
  80     @Override
  81     public void onFullDefinitionDeclared(final Mutable<QName, ActionStatement, ActionEffectiveStatement> stmt) {
  82         super.onFullDefinitionDeclared(stmt);
  83
  84         if (StmtContextUtils.findFirstDeclaredSubstatement(stmt, InputStatement.class) == null) {
  85             appendImplicitSubstatement(stmt, YangStmtMapping.INPUT.getStatementName());
  86         }
  87         if (StmtContextUtils.findFirstDeclaredSubstatement(stmt, OutputStatement.class) == null) {
  88             appendImplicitSubstatement(stmt, YangStmtMapping.OUTPUT.getStatementName());
  89         }
  90     }
  91
  92     @Override
  93     protected ActionStatement createDeclared(final BoundStmtCtx<QName> ctx,
  94             final ImmutableList<DeclaredStatement<?>> substatements) {
  95         return DeclaredStatements.createAction(ctx.getArgument(), substatements);
  96     }
  97
  98     @Override
  99     protected ActionStatement attachDeclarationReference(final ActionStatement stmt,
 100             final DeclarationReference reference) {
 101         return DeclaredStatementDecorators.decorateAction(stmt, reference);
 102     }
 103
 104     @Override
 105     protected ActionEffectiveStatement createEffective(final Current<QName, ActionStatement> stmt,
 106             final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
 107         final StatementSourceReference ref = stmt.sourceReference();
 108         verify(!substatements.isEmpty(), "Missing implicit input/output statements at %s", ref);
 109
 110         try {
 111             return EffectiveStatements.createAction(stmt.declared(), stmt.getArgument(),
 112                 EffectiveStmtUtils.historyAndStatusFlags(stmt.history(), substatements), substatements);
 113         } catch (SubstatementIndexingException e) {
 114             throw new SourceException(e.getMessage(), stmt, e);
 115         }
 116     }
 117
 118     @Override
 119     public ActionEffectiveStatement copyEffective(final Current<QName, ActionStatement> stmt,
 120             final ActionEffectiveStatement original) {
 121         return EffectiveStatements.copyAction(original, stmt.getArgument(),
 122             EffectiveStmtUtils.historyAndStatusFlags(stmt.history(), original.effectiveSubstatements()));
 123     }
 124
 125     @Override
 126     public EffectiveStatementState extractEffectiveState(final ActionEffectiveStatement stmt) {
 127         verify(stmt instanceof ActionDefinition, "Unexpected statement %s", stmt);
 128         final var schema = (ActionDefinition) stmt;
 129         return new QNameWithFlagsEffectiveStatementState(stmt.argument(),
 130             EffectiveStmtUtils.historyAndStatusFlags(schema));
 131     }
 132
 133     private static void appendImplicitSubstatement(final Mutable<QName, ActionStatement, ActionEffectiveStatement> stmt,
 134             final QName substatementName) {
 135         stmt.addEffectiveSubstatement(
 136             verifyNotNull(stmt.getFromNamespace(StatementSupportNamespace.class, substatementName)), null);
 137     }
 138 }