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.Verify.verify;
11 import static com.google.common.base.Verify.verifyNotNull;
12 import static java.util.Objects.requireNonNull;
14 import com.google.common.annotations.Beta;
15 import com.google.common.collect.ImmutableList;
16 import java.util.Collection;
17 import java.util.Optional;
18 import org.eclipse.jdt.annotation.NonNull;
19 import org.opendaylight.yangtools.yang.common.QName;
20 import org.opendaylight.yangtools.yang.model.api.CaseSchemaNode;
21 import org.opendaylight.yangtools.yang.model.api.ChoiceSchemaNode;
22 import org.opendaylight.yangtools.yang.model.api.Status;
23 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
24 import org.opendaylight.yangtools.yang.model.api.meta.DeclarationReference;
25 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
26 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
27 import org.opendaylight.yangtools.yang.model.api.meta.StatementDefinition;
28 import org.opendaylight.yangtools.yang.model.api.stmt.ChoiceEffectiveStatement;
29 import org.opendaylight.yangtools.yang.model.api.stmt.ChoiceStatement;
30 import org.opendaylight.yangtools.yang.model.api.stmt.DefaultEffectiveStatement;
31 import org.opendaylight.yangtools.yang.model.api.stmt.MandatoryEffectiveStatement;
32 import org.opendaylight.yangtools.yang.model.api.stmt.StatusEffectiveStatement;
33 import org.opendaylight.yangtools.yang.model.ri.stmt.DeclaredStatementDecorators;
34 import org.opendaylight.yangtools.yang.model.ri.stmt.DeclaredStatements;
35 import org.opendaylight.yangtools.yang.model.ri.stmt.EffectiveStatements;
36 import org.opendaylight.yangtools.yang.model.spi.meta.EffectiveStatementMixins.EffectiveStatementWithFlags.FlagsBuilder;
37 import org.opendaylight.yangtools.yang.model.spi.meta.SubstatementIndexingException;
38 import org.opendaylight.yangtools.yang.parser.api.YangParserConfiguration;
39 import org.opendaylight.yangtools.yang.parser.rfc7950.reactor.YangValidationBundles;
40 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractSchemaTreeStatementSupport;
41 import org.opendaylight.yangtools.yang.parser.spi.meta.BoundStmtCtx;
42 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStatementState;
43 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
44 import org.opendaylight.yangtools.yang.parser.spi.meta.ImplicitParentAwareStatementSupport;
45 import org.opendaylight.yangtools.yang.parser.spi.meta.InferenceException;
46 import org.opendaylight.yangtools.yang.parser.spi.meta.NamespaceStmtCtx;
47 import org.opendaylight.yangtools.yang.parser.spi.meta.QNameWithFlagsEffectiveStatementState;
48 import org.opendaylight.yangtools.yang.parser.spi.meta.StatementSupport;
49 import org.opendaylight.yangtools.yang.parser.spi.meta.StatementSupportNamespace;
50 import org.opendaylight.yangtools.yang.parser.spi.meta.SubstatementValidator;
51 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
54 public final class ChoiceStatementSupport
55 extends AbstractSchemaTreeStatementSupport<ChoiceStatement, ChoiceEffectiveStatement>
56 implements ImplicitParentAwareStatementSupport {
57 private static final SubstatementValidator RFC6020_VALIDATOR = SubstatementValidator.builder(YangStmtMapping.CHOICE)
58 .addAny(YangStmtMapping.ANYXML)
59 .addAny(YangStmtMapping.CASE)
60 .addOptional(YangStmtMapping.CONFIG)
61 .addAny(YangStmtMapping.CONTAINER)
62 .addOptional(YangStmtMapping.DEFAULT)
63 .addOptional(YangStmtMapping.DESCRIPTION)
64 .addAny(YangStmtMapping.IF_FEATURE)
65 .addAny(YangStmtMapping.LEAF)
66 .addAny(YangStmtMapping.LEAF_LIST)
67 .addAny(YangStmtMapping.LIST)
68 .addOptional(YangStmtMapping.MANDATORY)
69 .addOptional(YangStmtMapping.REFERENCE)
70 .addOptional(YangStmtMapping.STATUS)
71 .addOptional(YangStmtMapping.WHEN)
74 private static final SubstatementValidator RFC7950_VALIDATOR = SubstatementValidator.builder(YangStmtMapping.CHOICE)
75 .addAny(YangStmtMapping.ANYDATA)
76 .addAny(YangStmtMapping.ANYXML)
77 .addAny(YangStmtMapping.CASE)
78 .addOptional(YangStmtMapping.CONFIG)
79 .addAny(YangStmtMapping.CONTAINER)
80 .addOptional(YangStmtMapping.DEFAULT)
81 .addOptional(YangStmtMapping.DESCRIPTION)
82 .addAny(YangStmtMapping.IF_FEATURE)
83 .addAny(YangStmtMapping.LEAF)
84 .addAny(YangStmtMapping.LEAF_LIST)
85 .addAny(YangStmtMapping.LIST)
86 .addOptional(YangStmtMapping.MANDATORY)
87 .addOptional(YangStmtMapping.REFERENCE)
88 .addOptional(YangStmtMapping.STATUS)
89 .addOptional(YangStmtMapping.WHEN)
92 private ChoiceStatementSupport(final YangParserConfiguration config, final SubstatementValidator validator) {
93 super(YangStmtMapping.CHOICE, instantiatedPolicy(), config, requireNonNull(validator));
96 public static @NonNull ChoiceStatementSupport rfc6020Instance(final YangParserConfiguration config) {
97 return new ChoiceStatementSupport(config, RFC6020_VALIDATOR);
100 public static @NonNull ChoiceStatementSupport rfc7950Instance(final YangParserConfiguration config) {
101 return new ChoiceStatementSupport(config, RFC7950_VALIDATOR);
105 public Optional<StatementSupport<?, ?, ?>> getImplicitParentFor(final NamespaceStmtCtx parent,
106 final StatementDefinition stmtDef) {
107 if (!YangValidationBundles.SUPPORTED_CASE_SHORTHANDS.contains(stmtDef)) {
108 return Optional.empty();
110 return Optional.of(verifyNotNull(parent.getFromNamespace(StatementSupportNamespace.class,
111 YangStmtMapping.CASE.getStatementName())));
115 protected ChoiceStatement createDeclared(final BoundStmtCtx<QName> ctx,
116 final ImmutableList<DeclaredStatement<?>> substatements) {
117 return DeclaredStatements.createChoice(ctx.getArgument(), substatements);
121 protected ChoiceStatement attachDeclarationReference(final ChoiceStatement stmt,
122 final DeclarationReference reference) {
123 return DeclaredStatementDecorators.decorateChoice(stmt, reference);
127 public ChoiceEffectiveStatement copyEffective(final Current<QName, ChoiceStatement> stmt,
128 final ChoiceEffectiveStatement original) {
129 return EffectiveStatements.copyChoice(original, stmt.getArgument(),
130 computeFlags(stmt, original.effectiveSubstatements()));
134 protected ChoiceEffectiveStatement createEffective(final Current<QName, ChoiceStatement> stmt,
135 final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
136 final String defaultArg = findFirstArgument(substatements, DefaultEffectiveStatement.class, null);
137 final CaseSchemaNode defaultCase;
138 if (defaultArg != null) {
141 qname = QName.create(stmt.getArgument(), defaultArg);
142 } catch (IllegalArgumentException e) {
143 throw new SourceException(stmt, e, "Default statement has invalid name '%s'", defaultArg);
146 // FIXME: this does not work with submodules, as they are
147 defaultCase = InferenceException.throwIfNull(findCase(qname, substatements), stmt,
148 "Default statement refers to missing case %s", qname);
154 return EffectiveStatements.createChoice(stmt.declared(), stmt.getArgument(),
155 computeFlags(stmt, substatements), substatements, defaultCase);
156 } catch (SubstatementIndexingException e) {
157 throw new SourceException(e.getMessage(), stmt, e);
162 public EffectiveStatementState extractEffectiveState(final ChoiceEffectiveStatement stmt) {
163 verify(stmt instanceof ChoiceSchemaNode, "Unexpected statement %s", stmt);
164 final var schema = (ChoiceSchemaNode) stmt;
165 return new QNameWithFlagsEffectiveStatementState(stmt.argument(), new FlagsBuilder()
167 .setStatus(schema.getStatus())
168 .setConfiguration(schema.effectiveConfig().orElse(null))
169 .setMandatory(schema.isMandatory())
173 private static int computeFlags(final Current<?, ?> stmt,
174 final Collection<? extends EffectiveStatement<?, ?>> substatements) {
175 return new FlagsBuilder()
176 .setHistory(stmt.history())
177 .setStatus(findFirstArgument(substatements, StatusEffectiveStatement.class, Status.CURRENT))
178 .setConfiguration(stmt.effectiveConfig().asNullable())
179 .setMandatory(findFirstArgument(substatements, MandatoryEffectiveStatement.class, Boolean.FALSE))
183 private static CaseSchemaNode findCase(final QName qname,
184 final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
185 for (final EffectiveStatement<?, ?> effectiveStatement : substatements) {
186 if (effectiveStatement instanceof CaseSchemaNode) {
187 final CaseSchemaNode choiceCaseNode = (CaseSchemaNode) effectiveStatement;
188 if (qname.equals(choiceCaseNode.getQName())) {
189 return choiceCaseNode;