Enable deviation substatement validation
[yangtools.git] / parser / yang-parser-rfc7950 / src / main / java / org / opendaylight / yangtools / yang / parser / rfc7950 / stmt / meta / DeviationStatementSupport.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.collect.ImmutableList;
11 import com.google.common.collect.Iterables;
12 import org.opendaylight.yangtools.yang.common.QNameModule;
13 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
14 import org.opendaylight.yangtools.yang.model.api.meta.DeclarationReference;
15 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
16 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
17 import org.opendaylight.yangtools.yang.model.api.stmt.DeviationEffectiveStatement;
18 import org.opendaylight.yangtools.yang.model.api.stmt.DeviationStatement;
19 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier.Absolute;
20 import org.opendaylight.yangtools.yang.model.ri.stmt.DeclaredStatementDecorators;
21 import org.opendaylight.yangtools.yang.model.ri.stmt.DeclaredStatements;
22 import org.opendaylight.yangtools.yang.model.ri.stmt.EffectiveStatements;
23 import org.opendaylight.yangtools.yang.parser.api.YangParserConfiguration;
24 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.ArgumentUtils;
25 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractStatementSupport;
26 import org.opendaylight.yangtools.yang.parser.spi.meta.BoundStmtCtx;
27 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
28 import org.opendaylight.yangtools.yang.parser.spi.meta.InferenceException;
29 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
30 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
31 import org.opendaylight.yangtools.yang.parser.spi.meta.SubstatementValidator;
32 import org.opendaylight.yangtools.yang.parser.spi.source.ModuleCtxToModuleQName;
33
34 public final class DeviationStatementSupport
35         extends AbstractStatementSupport<Absolute, DeviationStatement, DeviationEffectiveStatement> {
36     private static final SubstatementValidator SUBSTATEMENT_VALIDATOR =
37         SubstatementValidator.builder(YangStmtMapping.DEVIATION)
38             .addOptional(YangStmtMapping.DESCRIPTION)
39             .addAny(YangStmtMapping.DEVIATE)
40             .addOptional(YangStmtMapping.REFERENCE)
41             .build();
42
43     public DeviationStatementSupport(final YangParserConfiguration config) {
44         super(YangStmtMapping.DEVIATION, StatementPolicy.reject(), config, SUBSTATEMENT_VALIDATOR);
45     }
46
47     @Override
48     public Absolute parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
49         return ArgumentUtils.parseAbsoluteSchemaNodeIdentifier(ctx, value);
50     }
51
52     @Override
53     public void onFullDefinitionDeclared(final Mutable<Absolute, DeviationStatement, DeviationEffectiveStatement> ctx) {
54         super.onFullDefinitionDeclared(ctx);
55
56         final QNameModule currentModule = ctx.getFromNamespace(ModuleCtxToModuleQName.class, ctx.getRoot());
57         final QNameModule targetModule = Iterables.getLast(ctx.getArgument().getNodeIdentifiers()).getModule();
58
59         if (currentModule.equals(targetModule)) {
60             throw new InferenceException(ctx,
61                     "Deviation must not target the same module as the one it is defined in: %s", currentModule);
62         }
63     }
64
65     @Override
66     protected DeviationStatement createDeclared(final BoundStmtCtx<Absolute> ctx,
67             final ImmutableList<DeclaredStatement<?>> substatements) {
68         return DeclaredStatements.createDeviation(ctx.getRawArgument(), ctx.getArgument(), substatements);
69     }
70
71     @Override
72     protected DeviationStatement attachDeclarationReference(final DeviationStatement stmt,
73             final DeclarationReference reference) {
74         return DeclaredStatementDecorators.decorateDeviation(stmt, reference);
75     }
76
77     @Override
78     protected DeviationEffectiveStatement createEffective(final Current<Absolute, DeviationStatement> stmt,
79             final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
80         return EffectiveStatements.createDeviation(stmt.declared(), substatements);
81     }
82 }