Do not expose StmtContext to StatementFactory
[yangtools.git] / parser / yang-parser-rfc7950 / src / main / java / org / opendaylight / yangtools / yang / parser / rfc7950 / stmt / meta / FeatureStatementSupport.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 org.opendaylight.yangtools.yang.common.Empty;
12 import org.opendaylight.yangtools.yang.common.QName;
13 import org.opendaylight.yangtools.yang.model.api.Status;
14 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
15 import org.opendaylight.yangtools.yang.model.api.meta.DeclarationReference;
16 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
17 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
18 import org.opendaylight.yangtools.yang.model.api.stmt.FeatureEffectiveStatement;
19 import org.opendaylight.yangtools.yang.model.api.stmt.FeatureStatement;
20 import org.opendaylight.yangtools.yang.model.api.stmt.StatusEffectiveStatement;
21 import org.opendaylight.yangtools.yang.model.ri.stmt.DeclaredStatementDecorators;
22 import org.opendaylight.yangtools.yang.model.ri.stmt.DeclaredStatements;
23 import org.opendaylight.yangtools.yang.model.ri.stmt.EffectiveStatements;
24 import org.opendaylight.yangtools.yang.model.spi.meta.EffectiveStatementMixins.EffectiveStatementWithFlags.FlagsBuilder;
25 import org.opendaylight.yangtools.yang.parser.api.YangParserConfiguration;
26 import org.opendaylight.yangtools.yang.parser.spi.FeatureNamespace;
27 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractQNameStatementSupport;
28 import org.opendaylight.yangtools.yang.parser.spi.meta.BoundStmtCtx;
29 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
30 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
31 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
32 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
33 import org.opendaylight.yangtools.yang.parser.spi.meta.SubstatementValidator;
34 import org.opendaylight.yangtools.yang.parser.spi.source.SupportedFeaturesNamespace;
35
36 public final class FeatureStatementSupport
37         extends AbstractQNameStatementSupport<FeatureStatement, FeatureEffectiveStatement> {
38     private static final SubstatementValidator SUBSTATEMENT_VALIDATOR =
39         SubstatementValidator.builder(YangStmtMapping.FEATURE)
40             .addOptional(YangStmtMapping.DESCRIPTION)
41             .addAny(YangStmtMapping.IF_FEATURE)
42             .addOptional(YangStmtMapping.STATUS)
43             .addOptional(YangStmtMapping.REFERENCE)
44             .build();
45
46     public FeatureStatementSupport(final YangParserConfiguration config) {
47         super(YangStmtMapping.FEATURE, StatementPolicy.reject(), config, SUBSTATEMENT_VALIDATOR);
48     }
49
50     @Override
51     public QName parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
52         return StmtContextUtils.parseIdentifier(ctx, value);
53     }
54
55     @Override
56     public void onFullDefinitionDeclared(final Mutable<QName, FeatureStatement, FeatureEffectiveStatement> stmt) {
57         super.onFullDefinitionDeclared(stmt);
58         stmt.addContext(FeatureNamespace.class, stmt.getArgument(), stmt);
59
60         // Do not build effective statement if supported features does not include this feature
61         final var supportedFeatures = stmt.getFromNamespace(SupportedFeaturesNamespace.class, Empty.value());
62         if (supportedFeatures != null && !supportedFeatures.contains(stmt.getArgument())) {
63             stmt.setUnsupported();
64         }
65     }
66
67     @Override
68     protected FeatureStatement createDeclared(final BoundStmtCtx<QName> ctx,
69             final ImmutableList<DeclaredStatement<?>> substatements) {
70         return DeclaredStatements.createFeature(ctx.getArgument(), substatements);
71     }
72
73     @Override
74     protected FeatureStatement attachDeclarationReference(final FeatureStatement stmt,
75             final DeclarationReference reference) {
76         return DeclaredStatementDecorators.decorateFeature(stmt, reference);
77     }
78
79     @Override
80     protected FeatureEffectiveStatement createEffective(final Current<QName, FeatureStatement> stmt,
81             final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
82         return EffectiveStatements.createFeature(stmt.declared(), computeFlags(substatements), substatements);
83     }
84
85     private static int computeFlags(final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
86         return new FlagsBuilder()
87                 .setStatus(findFirstArgument(substatements, StatusEffectiveStatement.class, Status.CURRENT))
88                 .toFlags();
89     }
90 }