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 java.util.Objects.requireNonNull;
12 import com.google.common.annotations.Beta;
13 import com.google.common.collect.ImmutableList;
14 import java.util.Collection;
15 import java.util.Optional;
16 import org.eclipse.jdt.annotation.NonNull;
17 import org.opendaylight.yangtools.yang.common.QName;
18 import org.opendaylight.yangtools.yang.model.api.CaseSchemaNode;
19 import org.opendaylight.yangtools.yang.model.api.ChoiceSchemaNode;
20 import org.opendaylight.yangtools.yang.model.api.Status;
21 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
22 import org.opendaylight.yangtools.yang.model.api.meta.DeclarationReference;
23 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
24 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
25 import org.opendaylight.yangtools.yang.model.api.meta.StatementDefinition;
26 import org.opendaylight.yangtools.yang.model.api.stmt.ChoiceEffectiveStatement;
27 import org.opendaylight.yangtools.yang.model.api.stmt.ChoiceStatement;
28 import org.opendaylight.yangtools.yang.model.api.stmt.DefaultEffectiveStatement;
29 import org.opendaylight.yangtools.yang.model.api.stmt.MandatoryEffectiveStatement;
30 import org.opendaylight.yangtools.yang.model.api.stmt.StatusEffectiveStatement;
31 import org.opendaylight.yangtools.yang.model.parser.api.YangParserConfiguration;
32 import org.opendaylight.yangtools.yang.model.ri.stmt.DeclaredStatementDecorators;
33 import org.opendaylight.yangtools.yang.model.ri.stmt.DeclaredStatements;
34 import org.opendaylight.yangtools.yang.model.ri.stmt.EffectiveStatements;
35 import org.opendaylight.yangtools.yang.model.spi.meta.EffectiveStatementMixins.EffectiveStatementWithFlags.FlagsBuilder;
36 import org.opendaylight.yangtools.yang.model.spi.meta.SubstatementIndexingException;
37 import org.opendaylight.yangtools.yang.parser.rfc7950.reactor.YangValidationBundles;
38 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractSchemaTreeStatementSupport;
39 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
40 import org.opendaylight.yangtools.yang.parser.spi.meta.ImplicitParentAwareStatementSupport;
41 import org.opendaylight.yangtools.yang.parser.spi.meta.InferenceException;
42 import org.opendaylight.yangtools.yang.parser.spi.meta.StatementSupport;
43 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
44 import org.opendaylight.yangtools.yang.parser.spi.meta.SubstatementValidator;
45 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
48 public final class ChoiceStatementSupport
49 extends AbstractSchemaTreeStatementSupport<ChoiceStatement, ChoiceEffectiveStatement>
50 implements ImplicitParentAwareStatementSupport {
51 private static final SubstatementValidator RFC6020_VALIDATOR = SubstatementValidator.builder(YangStmtMapping.CHOICE)
52 .addAny(YangStmtMapping.ANYXML)
53 .addAny(YangStmtMapping.CASE)
54 .addOptional(YangStmtMapping.CONFIG)
55 .addAny(YangStmtMapping.CONTAINER)
56 .addOptional(YangStmtMapping.DEFAULT)
57 .addOptional(YangStmtMapping.DESCRIPTION)
58 .addAny(YangStmtMapping.IF_FEATURE)
59 .addAny(YangStmtMapping.LEAF)
60 .addAny(YangStmtMapping.LEAF_LIST)
61 .addAny(YangStmtMapping.LIST)
62 .addOptional(YangStmtMapping.MANDATORY)
63 .addOptional(YangStmtMapping.REFERENCE)
64 .addOptional(YangStmtMapping.STATUS)
65 .addOptional(YangStmtMapping.WHEN)
68 private static final SubstatementValidator RFC7950_VALIDATOR = SubstatementValidator.builder(YangStmtMapping.CHOICE)
69 .addAny(YangStmtMapping.ANYDATA)
70 .addAny(YangStmtMapping.ANYXML)
71 .addAny(YangStmtMapping.CASE)
72 .addOptional(YangStmtMapping.CONFIG)
73 .addAny(YangStmtMapping.CONTAINER)
74 .addOptional(YangStmtMapping.DEFAULT)
75 .addOptional(YangStmtMapping.DESCRIPTION)
76 .addAny(YangStmtMapping.IF_FEATURE)
77 .addAny(YangStmtMapping.LEAF)
78 .addAny(YangStmtMapping.LEAF_LIST)
79 .addAny(YangStmtMapping.LIST)
80 .addOptional(YangStmtMapping.MANDATORY)
81 .addOptional(YangStmtMapping.REFERENCE)
82 .addOptional(YangStmtMapping.STATUS)
83 .addOptional(YangStmtMapping.WHEN)
86 private final SubstatementValidator validator;
87 private final CaseStatementSupport implicitCase;
89 private ChoiceStatementSupport(final YangParserConfiguration config, final SubstatementValidator validator,
90 final CaseStatementSupport implicitCase) {
91 super(YangStmtMapping.CHOICE, instantiatedPolicy(), config);
92 this.validator = requireNonNull(validator);
93 this.implicitCase = requireNonNull(implicitCase);
96 public static @NonNull ChoiceStatementSupport rfc6020Instance(final YangParserConfiguration config,
97 final CaseStatementSupport implicitCase) {
98 return new ChoiceStatementSupport(config, RFC6020_VALIDATOR, implicitCase);
101 public static @NonNull ChoiceStatementSupport rfc7950Instance(final YangParserConfiguration config,
102 final CaseStatementSupport implicitCase) {
103 return new ChoiceStatementSupport(config, RFC7950_VALIDATOR, implicitCase);
107 public Optional<StatementSupport<?, ?, ?>> getImplicitParentFor(final StatementDefinition stmtDef) {
108 return YangValidationBundles.SUPPORTED_CASE_SHORTHANDS.contains(stmtDef) ? Optional.of(implicitCase)
113 protected SubstatementValidator getSubstatementValidator() {
118 protected ChoiceStatement createDeclared(@NonNull final StmtContext<QName, ChoiceStatement, ?> ctx,
119 final ImmutableList<? extends DeclaredStatement<?>> substatements) {
120 return DeclaredStatements.createChoice(ctx.getArgument(), substatements);
124 protected ChoiceStatement attachDeclarationReference(final ChoiceStatement stmt,
125 final DeclarationReference reference) {
126 return DeclaredStatementDecorators.decorateChoice(stmt, reference);
130 public ChoiceEffectiveStatement copyEffective(final Current<QName, ChoiceStatement> stmt,
131 final ChoiceEffectiveStatement original) {
132 return EffectiveStatements.copyChoice(original, stmt.effectivePath(),
133 computeFlags(stmt, original.effectiveSubstatements()), stmt.original(ChoiceSchemaNode.class));
137 protected ChoiceEffectiveStatement createEffective(final Current<QName, ChoiceStatement> stmt,
138 final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
139 final String defaultArg = findFirstArgument(substatements, DefaultEffectiveStatement.class, null);
140 final CaseSchemaNode defaultCase;
141 if (defaultArg != null) {
144 qname = QName.create(stmt.getArgument(), defaultArg);
145 } catch (IllegalArgumentException e) {
146 throw new SourceException(stmt, e, "Default statement has invalid name '%s'", defaultArg);
149 // FIXME: this does not work with submodules, as they are
150 defaultCase = InferenceException.throwIfNull(findCase(qname, substatements), stmt,
151 "Default statement refers to missing case %s", qname);
157 return EffectiveStatements.createChoice(stmt.declared(), stmt.effectivePath(),
158 computeFlags(stmt, substatements), substatements, defaultCase, stmt.original(ChoiceSchemaNode.class));
159 } catch (SubstatementIndexingException e) {
160 throw new SourceException(e.getMessage(), stmt, e);
164 private static int computeFlags(final Current<?, ?> stmt,
165 final Collection<? extends EffectiveStatement<?, ?>> substatements) {
166 return new FlagsBuilder()
167 .setHistory(stmt.history())
168 .setStatus(findFirstArgument(substatements, StatusEffectiveStatement.class, Status.CURRENT))
169 .setConfiguration(stmt.effectiveConfig().asNullable())
170 .setMandatory(findFirstArgument(substatements, MandatoryEffectiveStatement.class, Boolean.FALSE))
174 private static CaseSchemaNode findCase(final QName qname,
175 final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
176 for (final EffectiveStatement<?, ?> effectiveStatement : substatements) {
177 if (effectiveStatement instanceof CaseSchemaNode) {
178 final CaseSchemaNode choiceCaseNode = (CaseSchemaNode) effectiveStatement;
179 if (qname.equals(choiceCaseNode.getQName())) {
180 return choiceCaseNode;