Do not expose StmtContext to StatementFactory
[yangtools.git] / parser / yang-parser-rfc7950 / src / main / java / org / opendaylight / yangtools / yang / parser / rfc7950 / stmt / meta / LeafStatementSupport.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
12 import com.google.common.collect.ImmutableList;
13 import java.util.Collection;
14 import org.opendaylight.yangtools.yang.common.QName;
15 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
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.DefaultEffectiveStatement;
22 import org.opendaylight.yangtools.yang.model.api.stmt.LeafEffectiveStatement;
23 import org.opendaylight.yangtools.yang.model.api.stmt.LeafStatement;
24 import org.opendaylight.yangtools.yang.model.api.stmt.MandatoryEffectiveStatement;
25 import org.opendaylight.yangtools.yang.model.api.stmt.StatusEffectiveStatement;
26 import org.opendaylight.yangtools.yang.model.api.stmt.TypeEffectiveStatement;
27 import org.opendaylight.yangtools.yang.model.ri.stmt.DeclaredStatementDecorators;
28 import org.opendaylight.yangtools.yang.model.ri.stmt.DeclaredStatements;
29 import org.opendaylight.yangtools.yang.model.ri.stmt.EffectiveStatements;
30 import org.opendaylight.yangtools.yang.model.spi.meta.EffectiveStatementMixins.EffectiveStatementWithFlags.FlagsBuilder;
31 import org.opendaylight.yangtools.yang.parser.api.YangParserConfiguration;
32 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.EffectiveStmtUtils;
33 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractSchemaTreeStatementSupport;
34 import org.opendaylight.yangtools.yang.parser.spi.meta.BoundStmtCtx;
35 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStatementState;
36 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
37 import org.opendaylight.yangtools.yang.parser.spi.meta.QNameWithFlagsEffectiveStatementState;
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
43 public final class LeafStatementSupport
44         extends AbstractSchemaTreeStatementSupport<LeafStatement, LeafEffectiveStatement> {
45     private static final SubstatementValidator SUBSTATEMENT_VALIDATOR =
46         SubstatementValidator.builder(YangStmtMapping.LEAF)
47             .addOptional(YangStmtMapping.CONFIG)
48             .addOptional(YangStmtMapping.DEFAULT)
49             .addOptional(YangStmtMapping.DESCRIPTION)
50             .addAny(YangStmtMapping.IF_FEATURE)
51             .addOptional(YangStmtMapping.MANDATORY)
52             .addAny(YangStmtMapping.MUST)
53             .addOptional(YangStmtMapping.REFERENCE)
54             .addOptional(YangStmtMapping.STATUS)
55             .addMandatory(YangStmtMapping.TYPE)
56             .addOptional(YangStmtMapping.UNITS)
57             .addOptional(YangStmtMapping.WHEN)
58             .build();
59
60     public LeafStatementSupport(final YangParserConfiguration config) {
61         super(YangStmtMapping.LEAF, instantiatedPolicy(), config, SUBSTATEMENT_VALIDATOR);
62     }
63
64     @Override
65     public void onFullDefinitionDeclared(final Mutable<QName, LeafStatement, LeafEffectiveStatement> ctx) {
66         super.onFullDefinitionDeclared(ctx);
67         StmtContextUtils.validateIfFeatureAndWhenOnListKeys(ctx);
68     }
69
70     @Override
71     protected LeafStatement createDeclared(final BoundStmtCtx<QName> ctx,
72             final ImmutableList<DeclaredStatement<?>> substatements) {
73         return DeclaredStatements.createLeaf(ctx.getArgument(), substatements);
74     }
75
76     @Override
77     protected LeafStatement attachDeclarationReference(final LeafStatement stmt, final DeclarationReference reference) {
78         return DeclaredStatementDecorators.decorateLeaf(stmt, reference);
79     }
80
81     @Override
82     public LeafEffectiveStatement copyEffective(final Current<QName, LeafStatement> stmt,
83             final LeafEffectiveStatement original) {
84         return EffectiveStatements.copyLeaf(original, stmt.getArgument(),
85             computeFlags(stmt, original.effectiveSubstatements()));
86     }
87
88     @Override
89     protected LeafEffectiveStatement createEffective(final Current<QName, LeafStatement> stmt,
90             final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
91         final TypeEffectiveStatement<?> typeStmt = SourceException.throwIfNull(
92             findFirstStatement(substatements, TypeEffectiveStatement.class), stmt,
93             "Leaf is missing a 'type' statement");
94         final String dflt = findFirstArgument(substatements, DefaultEffectiveStatement.class, null);
95         SourceException.throwIf(
96             EffectiveStmtUtils.hasDefaultValueMarkedWithIfFeature(stmt.yangVersion(), typeStmt, dflt), stmt,
97             "Leaf '%s' has default value '%s' marked with an if-feature statement.", stmt.argument(), dflt);
98
99         return EffectiveStatements.createLeaf(stmt.declared(), stmt.getArgument(), computeFlags(stmt, substatements),
100             substatements);
101     }
102
103     @Override
104     public EffectiveStatementState extractEffectiveState(final LeafEffectiveStatement stmt) {
105         verify(stmt instanceof LeafSchemaNode, "Unexpected statement %s", stmt);
106         final var schema = (LeafSchemaNode) stmt;
107         return new QNameWithFlagsEffectiveStatementState(stmt.argument(), new FlagsBuilder()
108             .setHistory(schema)
109             .setStatus(schema.getStatus())
110             .setConfiguration(schema.effectiveConfig().orElse(null))
111             .setMandatory(schema.isMandatory())
112             .toFlags());
113     }
114
115     private static int computeFlags(final Current<?, ?> stmt,
116             final Collection<? extends EffectiveStatement<?, ?>> substatements) {
117         return new FlagsBuilder()
118             .setHistory(stmt.history())
119             .setStatus(findFirstArgument(substatements, StatusEffectiveStatement.class, Status.CURRENT))
120             .setConfiguration(stmt.effectiveConfig().asNullable())
121             .setMandatory(findFirstArgument(substatements, MandatoryEffectiveStatement.class, Boolean.FALSE))
122             .toFlags();
123     }
124 }