2 * Copyright (c) 2017 Pantheon Technologies, s.r.o. and others. All rights reserved.
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
8 package org.opendaylight.yangtools.yang.parser.rfc7950.stmt.meta;
10 import static com.google.common.base.Preconditions.checkState;
11 import static com.google.common.base.Verify.verifyNotNull;
13 import com.google.common.annotations.Beta;
14 import com.google.common.collect.ImmutableList;
15 import org.opendaylight.yangtools.yang.common.QName;
16 import org.opendaylight.yangtools.yang.model.api.Status;
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.InputStatement;
22 import org.opendaylight.yangtools.yang.model.api.stmt.OutputStatement;
23 import org.opendaylight.yangtools.yang.model.api.stmt.RpcEffectiveStatement;
24 import org.opendaylight.yangtools.yang.model.api.stmt.RpcStatement;
25 import org.opendaylight.yangtools.yang.model.api.stmt.StatusEffectiveStatement;
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.EffectiveStatementMixins.EffectiveStatementWithFlags.FlagsBuilder;
30 import org.opendaylight.yangtools.yang.model.spi.meta.SubstatementIndexingException;
31 import org.opendaylight.yangtools.yang.parser.api.YangParserConfiguration;
32 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractSchemaTreeStatementSupport;
33 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
34 import org.opendaylight.yangtools.yang.parser.spi.meta.StatementSupportNamespace;
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;
42 public final class RpcStatementSupport extends AbstractSchemaTreeStatementSupport<RpcStatement, RpcEffectiveStatement> {
43 private static final SubstatementValidator SUBSTATEMENT_VALIDATOR =
44 SubstatementValidator.builder(YangStmtMapping.RPC)
45 .addOptional(YangStmtMapping.DESCRIPTION)
46 .addAny(YangStmtMapping.GROUPING)
47 .addAny(YangStmtMapping.IF_FEATURE)
48 .addOptional(YangStmtMapping.INPUT)
49 .addOptional(YangStmtMapping.OUTPUT)
50 .addOptional(YangStmtMapping.REFERENCE)
51 .addOptional(YangStmtMapping.STATUS)
52 .addAny(YangStmtMapping.TYPEDEF)
55 public RpcStatementSupport(final YangParserConfiguration config) {
56 super(YangStmtMapping.RPC, StatementPolicy.reject(), config, SUBSTATEMENT_VALIDATOR);
60 public void onFullDefinitionDeclared(final Mutable<QName, RpcStatement, RpcEffectiveStatement> stmt) {
61 super.onFullDefinitionDeclared(stmt);
63 if (StmtContextUtils.findFirstDeclaredSubstatement(stmt, InputStatement.class) == null) {
64 appendImplicitSubstatement(stmt, YangStmtMapping.INPUT.getStatementName());
66 if (StmtContextUtils.findFirstDeclaredSubstatement(stmt, OutputStatement.class) == null) {
67 appendImplicitSubstatement(stmt, YangStmtMapping.OUTPUT.getStatementName());
72 protected RpcStatement createDeclared(final StmtContext<QName, RpcStatement, ?> ctx,
73 final ImmutableList<? extends DeclaredStatement<?>> substatements) {
74 return DeclaredStatements.createRpc(ctx.getArgument(), substatements);
78 protected RpcStatement attachDeclarationReference(final RpcStatement stmt, final DeclarationReference reference) {
79 return DeclaredStatementDecorators.decorateRpc(stmt, reference);
83 protected RpcEffectiveStatement createEffective(final Current<QName, RpcStatement> stmt,
84 final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
85 checkState(!substatements.isEmpty(), "Missing implicit input/output statements at %s", stmt.sourceReference());
88 return EffectiveStatements.createRpc(stmt.declared(), substatements, stmt.getArgument(),
89 computeFlags(substatements));
90 } catch (SubstatementIndexingException e) {
91 throw new SourceException(e.getMessage(), stmt, e);
95 private static int computeFlags(final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
96 return new FlagsBuilder()
97 .setStatus(findFirstArgument(substatements, StatusEffectiveStatement.class, Status.CURRENT))
101 private static void appendImplicitSubstatement(final Mutable<QName, RpcStatement, RpcEffectiveStatement> stmt,
102 final QName substatementName) {
103 stmt.addEffectiveSubstatement(
104 verifyNotNull(stmt.getFromNamespace(StatementSupportNamespace.class, substatementName)), null);