parser/yang-parser-rfc7950/src/main/java/org/opendaylight/yangtools/yang/parser/rfc7950/stmt/meta/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.meta;
   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.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.ri.stmt.DeclaredStatementDecorators;
  32 import org.opendaylight.yangtools.yang.model.ri.stmt.DeclaredStatements;
  33 import org.opendaylight.yangtools.yang.model.ri.stmt.EffectiveStatements;
  34 import org.opendaylight.yangtools.yang.model.spi.meta.EffectiveStatementMixins.EffectiveStatementWithFlags.FlagsBuilder;
  35 import org.opendaylight.yangtools.yang.model.spi.meta.SubstatementIndexingException;
  36 import org.opendaylight.yangtools.yang.parser.api.YangParserConfiguration;
  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;
  46
  47 @Beta
  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)
  66             .build();
  67
  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)
  84             .build();
  85
  86     private final CaseStatementSupport implicitCase;
  87
  88     private ChoiceStatementSupport(final YangParserConfiguration config, final SubstatementValidator validator,
  89             final CaseStatementSupport implicitCase) {
  90         super(YangStmtMapping.CHOICE, instantiatedPolicy(), config, requireNonNull(validator));
  91         this.implicitCase = requireNonNull(implicitCase);
  92     }
  93
  94     public static @NonNull ChoiceStatementSupport rfc6020Instance(final YangParserConfiguration config,
  95             final CaseStatementSupport implicitCase) {
  96         return new ChoiceStatementSupport(config, RFC6020_VALIDATOR, implicitCase);
  97     }
  98
  99     public static @NonNull ChoiceStatementSupport rfc7950Instance(final YangParserConfiguration config,
 100             final CaseStatementSupport implicitCase) {
 101         return new ChoiceStatementSupport(config, RFC7950_VALIDATOR, implicitCase);
 102     }
 103
 104     @Override
 105     public Optional<StatementSupport<?, ?, ?>> getImplicitParentFor(final StatementDefinition stmtDef) {
 106         return YangValidationBundles.SUPPORTED_CASE_SHORTHANDS.contains(stmtDef) ? Optional.of(implicitCase)
 107             : Optional.empty();
 108     }
 109
 110     @Override
 111     protected ChoiceStatement createDeclared(@NonNull final StmtContext<QName, ChoiceStatement, ?> ctx,
 112             final ImmutableList<? extends DeclaredStatement<?>> substatements) {
 113         return DeclaredStatements.createChoice(ctx.getArgument(), substatements);
 114     }
 115
 116     @Override
 117     protected ChoiceStatement attachDeclarationReference(final ChoiceStatement stmt,
 118             final DeclarationReference reference) {
 119         return DeclaredStatementDecorators.decorateChoice(stmt, reference);
 120     }
 121
 122     @Override
 123     public ChoiceEffectiveStatement copyEffective(final Current<QName, ChoiceStatement> stmt,
 124             final ChoiceEffectiveStatement original) {
 125         return EffectiveStatements.copyChoice(original, stmt.effectivePath(),
 126             computeFlags(stmt, original.effectiveSubstatements()), stmt.original(ChoiceSchemaNode.class));
 127     }
 128
 129     @Override
 130     protected ChoiceEffectiveStatement createEffective(final Current<QName, ChoiceStatement> stmt,
 131             final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
 132         final String defaultArg = findFirstArgument(substatements, DefaultEffectiveStatement.class, null);
 133         final CaseSchemaNode defaultCase;
 134         if (defaultArg != null) {
 135             final QName qname;
 136             try {
 137                 qname = QName.create(stmt.getArgument(), defaultArg);
 138             } catch (IllegalArgumentException e) {
 139                 throw new SourceException(stmt, e, "Default statement has invalid name '%s'", defaultArg);
 140             }
 141
 142             // FIXME: this does not work with submodules, as they are
 143             defaultCase = InferenceException.throwIfNull(findCase(qname, substatements), stmt,
 144                 "Default statement refers to missing case %s", qname);
 145         } else {
 146             defaultCase = null;
 147         }
 148
 149         try {
 150             return EffectiveStatements.createChoice(stmt.declared(), stmt.effectivePath(),
 151                 computeFlags(stmt, substatements), substatements, defaultCase, stmt.original(ChoiceSchemaNode.class));
 152         } catch (SubstatementIndexingException e) {
 153             throw new SourceException(e.getMessage(), stmt, e);
 154         }
 155     }
 156
 157     private static int computeFlags(final Current<?, ?> stmt,
 158             final Collection<? extends EffectiveStatement<?, ?>> substatements) {
 159         return new FlagsBuilder()
 160             .setHistory(stmt.history())
 161             .setStatus(findFirstArgument(substatements, StatusEffectiveStatement.class, Status.CURRENT))
 162             .setConfiguration(stmt.effectiveConfig().asNullable())
 163             .setMandatory(findFirstArgument(substatements, MandatoryEffectiveStatement.class, Boolean.FALSE))
 164             .toFlags();
 165     }
 166
 167     private static CaseSchemaNode findCase(final QName qname,
 168             final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
 169         for (final EffectiveStatement<?, ?> effectiveStatement : substatements) {
 170             if (effectiveStatement instanceof CaseSchemaNode) {
 171                 final CaseSchemaNode choiceCaseNode = (CaseSchemaNode) effectiveStatement;
 172                 if (qname.equals(choiceCaseNode.getQName())) {
 173                     return choiceCaseNode;
 174                 }
 175             }
 176         }
 177
 178         return null;
 179     }
 180 }