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