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 com.google.common.collect.ImmutableSet;
  15 import java.util.Collection;
  16 import java.util.Optional;
  17 import org.eclipse.jdt.annotation.NonNull;
  18 import org.opendaylight.yangtools.yang.common.QName;
  19 import org.opendaylight.yangtools.yang.model.api.CaseSchemaNode;
  20 import org.opendaylight.yangtools.yang.model.api.ChoiceSchemaNode;
  21 import org.opendaylight.yangtools.yang.model.api.Status;
  22 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
  23 import org.opendaylight.yangtools.yang.model.api.meta.DeclarationReference;
  24 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
  25 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  26 import org.opendaylight.yangtools.yang.model.api.meta.StatementDefinition;
  27 import org.opendaylight.yangtools.yang.model.api.stmt.ChoiceEffectiveStatement;
  28 import org.opendaylight.yangtools.yang.model.api.stmt.ChoiceStatement;
  29 import org.opendaylight.yangtools.yang.model.api.stmt.DefaultEffectiveStatement;
  30 import org.opendaylight.yangtools.yang.model.api.stmt.MandatoryEffectiveStatement;
  31 import org.opendaylight.yangtools.yang.model.api.stmt.StatusEffectiveStatement;
  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.api.YangParserConfiguration;
  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     private static final ImmutableSet<StatementDefinition> RFC6020_CASE_SHORTHANDS = ImmutableSet.of(
  68             YangStmtMapping.ANYXML, YangStmtMapping.CONTAINER, YangStmtMapping.LEAF, YangStmtMapping.LIST,
  69             YangStmtMapping.LEAF_LIST);
  70
  71     private static final SubstatementValidator RFC7950_VALIDATOR = SubstatementValidator.builder(YangStmtMapping.CHOICE)
  72             .addAny(YangStmtMapping.ANYDATA)
  73             .addAny(YangStmtMapping.ANYXML)
  74             .addAny(YangStmtMapping.CASE)
  75             .addAny(YangStmtMapping.CHOICE)
  76             .addOptional(YangStmtMapping.CONFIG)
  77             .addAny(YangStmtMapping.CONTAINER)
  78             .addOptional(YangStmtMapping.DEFAULT)
  79             .addOptional(YangStmtMapping.DESCRIPTION)
  80             .addAny(YangStmtMapping.IF_FEATURE)
  81             .addAny(YangStmtMapping.LEAF)
  82             .addAny(YangStmtMapping.LEAF_LIST)
  83             .addAny(YangStmtMapping.LIST)
  84             .addOptional(YangStmtMapping.MANDATORY)
  85             .addOptional(YangStmtMapping.REFERENCE)
  86             .addOptional(YangStmtMapping.STATUS)
  87             .addOptional(YangStmtMapping.WHEN)
  88             .build();
  89     private static final ImmutableSet<StatementDefinition> RFC7950_CASE_SHORTHANDS = ImmutableSet.of(
  90         YangStmtMapping.ANYDATA, YangStmtMapping.ANYXML, YangStmtMapping.CHOICE, YangStmtMapping.CONTAINER,
  91         YangStmtMapping.LEAF, YangStmtMapping.LIST, YangStmtMapping.LEAF_LIST);
  92
  93     private final ImmutableSet<StatementDefinition> caseShorthands;
  94     private final CaseStatementSupport implicitCase;
  95
  96     private ChoiceStatementSupport(final YangParserConfiguration config, final SubstatementValidator validator,
  97             final ImmutableSet<StatementDefinition> caseShorthands, final CaseStatementSupport implicitCase) {
  98         super(YangStmtMapping.CHOICE, instantiatedPolicy(), config, requireNonNull(validator));
  99         this.caseShorthands = requireNonNull(caseShorthands);
 100         this.implicitCase = requireNonNull(implicitCase);
 101     }
 102
 103     public static @NonNull ChoiceStatementSupport rfc6020Instance(final YangParserConfiguration config,
 104             final CaseStatementSupport implicitCase) {
 105         return new ChoiceStatementSupport(config, RFC6020_VALIDATOR, RFC6020_CASE_SHORTHANDS, implicitCase);
 106     }
 107
 108     public static @NonNull ChoiceStatementSupport rfc7950Instance(final YangParserConfiguration config,
 109             final CaseStatementSupport implicitCase) {
 110         return new ChoiceStatementSupport(config, RFC7950_VALIDATOR, RFC7950_CASE_SHORTHANDS, implicitCase);
 111     }
 112
 113     @Override
 114     public Optional<StatementSupport<?, ?, ?>> getImplicitParentFor(final StatementDefinition stmtDef) {
 115         return caseShorthands.contains(stmtDef) ? Optional.of(implicitCase) : Optional.empty();
 116     }
 117
 118     @Override
 119     protected ChoiceStatement createDeclared(@NonNull final StmtContext<QName, ChoiceStatement, ?> ctx,
 120             final ImmutableList<? extends DeclaredStatement<?>> substatements) {
 121         return DeclaredStatements.createChoice(ctx.getArgument(), substatements);
 122     }
 123
 124     @Override
 125     protected ChoiceStatement attachDeclarationReference(final ChoiceStatement stmt,
 126             final DeclarationReference reference) {
 127         return DeclaredStatementDecorators.decorateChoice(stmt, reference);
 128     }
 129
 130     @Override
 131     public ChoiceEffectiveStatement copyEffective(final Current<QName, ChoiceStatement> stmt,
 132             final ChoiceEffectiveStatement original) {
 133         return EffectiveStatements.copyChoice(original, stmt.effectivePath(),
 134             computeFlags(stmt, original.effectiveSubstatements()), stmt.original(ChoiceSchemaNode.class));
 135     }
 136
 137     @Override
 138     protected ChoiceEffectiveStatement createEffective(final Current<QName, ChoiceStatement> stmt,
 139             final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
 140         final String defaultArg = findFirstArgument(substatements, DefaultEffectiveStatement.class, null);
 141         final CaseSchemaNode defaultCase;
 142         if (defaultArg != null) {
 143             final QName qname;
 144             try {
 145                 qname = QName.create(stmt.getArgument(), defaultArg);
 146             } catch (IllegalArgumentException e) {
 147                 throw new SourceException(stmt, e, "Default statement has invalid name '%s'", defaultArg);
 148             }
 149
 150             // FIXME: this does not work with submodules, as they are
 151             defaultCase = InferenceException.throwIfNull(findCase(qname, substatements), stmt,
 152                 "Default statement refers to missing case %s", qname);
 153         } else {
 154             defaultCase = null;
 155         }
 156
 157         try {
 158             return EffectiveStatements.createChoice(stmt.declared(), stmt.effectivePath(),
 159                 computeFlags(stmt, substatements), substatements, defaultCase, stmt.original(ChoiceSchemaNode.class));
 160         } catch (SubstatementIndexingException e) {
 161             throw new SourceException(e.getMessage(), stmt, e);
 162         }
 163     }
 164
 165     private static int computeFlags(final Current<?, ?> stmt,
 166             final Collection<? extends EffectiveStatement<?, ?>> substatements) {
 167         return new FlagsBuilder()
 168             .setHistory(stmt.history())
 169             .setStatus(findFirstArgument(substatements, StatusEffectiveStatement.class, Status.CURRENT))
 170             .setConfiguration(stmt.effectiveConfig().asNullable())
 171             .setMandatory(findFirstArgument(substatements, MandatoryEffectiveStatement.class, Boolean.FALSE))
 172             .toFlags();
 173     }
 174
 175     private static CaseSchemaNode findCase(final QName qname,
 176             final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
 177         for (final EffectiveStatement<?, ?> effectiveStatement : substatements) {
 178             if (effectiveStatement instanceof CaseSchemaNode) {
 179                 final CaseSchemaNode choiceCaseNode = (CaseSchemaNode) effectiveStatement;
 180                 if (qname.equals(choiceCaseNode.getQName())) {
 181                     return choiceCaseNode;
 182                 }
 183             }
 184         }
 185
 186         return null;
 187     }
 188 }