yang/yang-parser-rfc7950/src/main/java/org/opendaylight/yangtools/yang/parser/rfc7950/stmt/choice/ChoiceStatementSupport.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.choice;
   9
  10 import static java.util.Objects.requireNonNull;
  11
  12 import com.google.common.annotations.Beta;
  13 import com.google.common.collect.ImmutableList;
  14 import java.util.Optional;
  15 import org.eclipse.jdt.annotation.NonNull;
  16 import org.opendaylight.yangtools.yang.common.QName;
  17 import org.opendaylight.yangtools.yang.model.api.CaseSchemaNode;
  18 import org.opendaylight.yangtools.yang.model.api.ChoiceSchemaNode;
  19 import org.opendaylight.yangtools.yang.model.api.Status;
  20 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
  21 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
  22 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  23 import org.opendaylight.yangtools.yang.model.api.meta.StatementDefinition;
  24 import org.opendaylight.yangtools.yang.model.api.stmt.ChoiceEffectiveStatement;
  25 import org.opendaylight.yangtools.yang.model.api.stmt.ChoiceStatement;
  26 import org.opendaylight.yangtools.yang.model.api.stmt.DefaultEffectiveStatement;
  27 import org.opendaylight.yangtools.yang.model.api.stmt.MandatoryEffectiveStatement;
  28 import org.opendaylight.yangtools.yang.model.api.stmt.StatusEffectiveStatement;
  29 import org.opendaylight.yangtools.yang.parser.rfc7950.reactor.YangValidationBundles;
  30 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.BaseSchemaTreeStatementSupport;
  31 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.EffectiveStatementMixins.EffectiveStatementWithFlags.FlagsBuilder;
  32 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.SubstatementIndexingException;
  33 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.case_.CaseStatementSupport;
  34 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
  35 import org.opendaylight.yangtools.yang.parser.spi.meta.ImplicitParentAwareStatementSupport;
  36 import org.opendaylight.yangtools.yang.parser.spi.meta.InferenceException;
  37 import org.opendaylight.yangtools.yang.parser.spi.meta.StatementSupport;
  38 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  39 import org.opendaylight.yangtools.yang.parser.spi.meta.SubstatementValidator;
  40 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
  41
  42 @Beta
  43 public final class ChoiceStatementSupport
  44         extends BaseSchemaTreeStatementSupport<ChoiceStatement, ChoiceEffectiveStatement>
  45         implements ImplicitParentAwareStatementSupport {
  46     private static final @NonNull ChoiceStatementSupport RFC6020_INSTANCE = new ChoiceStatementSupport(
  47         SubstatementValidator.builder(YangStmtMapping.CHOICE)
  48             .addAny(YangStmtMapping.ANYXML)
  49             .addAny(YangStmtMapping.CASE)
  50             .addOptional(YangStmtMapping.CONFIG)
  51             .addAny(YangStmtMapping.CONTAINER)
  52             .addOptional(YangStmtMapping.DEFAULT)
  53             .addOptional(YangStmtMapping.DESCRIPTION)
  54             .addAny(YangStmtMapping.IF_FEATURE)
  55             .addAny(YangStmtMapping.LEAF)
  56             .addAny(YangStmtMapping.LEAF_LIST)
  57             .addAny(YangStmtMapping.LIST)
  58             .addOptional(YangStmtMapping.MANDATORY)
  59             .addOptional(YangStmtMapping.REFERENCE)
  60             .addOptional(YangStmtMapping.STATUS)
  61             .addOptional(YangStmtMapping.WHEN)
  62             .build(),
  63         CaseStatementSupport.rfc6020Instance());
  64
  65     private static final @NonNull ChoiceStatementSupport RFC7950_INSTANCE = new ChoiceStatementSupport(
  66         SubstatementValidator.builder(YangStmtMapping.CHOICE)
  67             .addAny(YangStmtMapping.ANYDATA)
  68             .addAny(YangStmtMapping.ANYXML)
  69             .addAny(YangStmtMapping.CASE)
  70             .addOptional(YangStmtMapping.CONFIG)
  71             .addAny(YangStmtMapping.CONTAINER)
  72             .addOptional(YangStmtMapping.DEFAULT)
  73             .addOptional(YangStmtMapping.DESCRIPTION)
  74             .addAny(YangStmtMapping.IF_FEATURE)
  75             .addAny(YangStmtMapping.LEAF)
  76             .addAny(YangStmtMapping.LEAF_LIST)
  77             .addAny(YangStmtMapping.LIST)
  78             .addOptional(YangStmtMapping.MANDATORY)
  79             .addOptional(YangStmtMapping.REFERENCE)
  80             .addOptional(YangStmtMapping.STATUS)
  81             .addOptional(YangStmtMapping.WHEN)
  82             .build(),
  83         CaseStatementSupport.rfc7950Instance());
  84
  85     private final SubstatementValidator validator;
  86     private final CaseStatementSupport implicitCase;
  87
  88     private ChoiceStatementSupport(final SubstatementValidator validator,
  89             final CaseStatementSupport implicitCase) {
  90         super(YangStmtMapping.CHOICE, CopyPolicy.DECLARED_COPY);
  91         this.validator = requireNonNull(validator);
  92         this.implicitCase = requireNonNull(implicitCase);
  93     }
  94
  95     public static @NonNull ChoiceStatementSupport rfc6020Instance() {
  96         return RFC6020_INSTANCE;
  97     }
  98
  99     public static @NonNull ChoiceStatementSupport rfc7950Instance() {
 100         return RFC7950_INSTANCE;
 101     }
 102
 103     @Override
 104     public Optional<StatementSupport<?, ?, ?>> getImplicitParentFor(final StatementDefinition stmtDef) {
 105         return YangValidationBundles.SUPPORTED_CASE_SHORTHANDS.contains(stmtDef) ? Optional.of(implicitCase)
 106             : Optional.empty();
 107     }
 108
 109     @Override
 110     protected SubstatementValidator getSubstatementValidator() {
 111         return validator;
 112     }
 113
 114     @Override
 115     protected ChoiceStatement createDeclared(@NonNull final StmtContext<QName, ChoiceStatement, ?> ctx,
 116             final ImmutableList<? extends DeclaredStatement<?>> substatements) {
 117         return new RegularChoiceStatement(ctx.getArgument(), substatements);
 118     }
 119
 120     @Override
 121     protected ChoiceStatement createEmptyDeclared(@NonNull final StmtContext<QName, ChoiceStatement, ?> ctx) {
 122         return new EmptyChoiceStatement(ctx.getArgument());
 123     }
 124
 125     @Override
 126     protected ChoiceEffectiveStatement createEffective(final Current<QName, ChoiceStatement> stmt,
 127             final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
 128         final String defaultArg = findFirstArgument(substatements, DefaultEffectiveStatement.class, null);
 129         final CaseSchemaNode defaultCase;
 130         if (defaultArg != null) {
 131             final QName qname;
 132             try {
 133                 qname = QName.create(stmt.getArgument(), defaultArg);
 134             } catch (IllegalArgumentException e) {
 135                 throw new SourceException(stmt, e, "Default statement has invalid name '%s'", defaultArg);
 136             }
 137
 138             // FIXME: this does not work with submodules, as they are
 139             defaultCase = InferenceException.throwIfNull(findCase(qname, substatements), stmt,
 140                 "Default statement refers to missing case %s", qname);
 141         } else {
 142             defaultCase = null;
 143         }
 144
 145         final int flags = new FlagsBuilder()
 146                 .setHistory(stmt.history())
 147                 .setStatus(findFirstArgument(substatements, StatusEffectiveStatement.class, Status.CURRENT))
 148                 .setConfiguration(stmt.effectiveConfig().asNullable())
 149                 .setMandatory(findFirstArgument(substatements, MandatoryEffectiveStatement.class, Boolean.FALSE))
 150                 .toFlags();
 151         try {
 152             return new ChoiceEffectiveStatementImpl(stmt.declared(), substatements, flags, stmt.wrapSchemaPath(),
 153                 defaultCase, (ChoiceSchemaNode) stmt.original());
 154         } catch (SubstatementIndexingException e) {
 155             throw new SourceException(e.getMessage(), stmt, e);
 156         }
 157     }
 158
 159     private static CaseSchemaNode findCase(final QName qname,
 160             final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
 161         for (final EffectiveStatement<?, ?> effectiveStatement : substatements) {
 162             if (effectiveStatement instanceof CaseSchemaNode) {
 163                 final CaseSchemaNode choiceCaseNode = (CaseSchemaNode) effectiveStatement;
 164                 if (qname.equals(choiceCaseNode.getQName())) {
 165                     return choiceCaseNode;
 166                 }
 167             }
 168         }
 169
 170         return null;
 171     }
 172 }