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 com.google.common.base.Verify.verifyNotNull;
  11 import static java.util.Objects.requireNonNull;
  12
  13 import com.google.common.annotations.Beta;
  14 import com.google.common.collect.ImmutableList;
  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.rfc7950.reactor.YangValidationBundles;
  39 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractSchemaTreeStatementSupport;
  40 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
  41 import org.opendaylight.yangtools.yang.parser.spi.meta.ImplicitParentAwareStatementSupport;
  42 import org.opendaylight.yangtools.yang.parser.spi.meta.InferenceException;
  43 import org.opendaylight.yangtools.yang.parser.spi.meta.NamespaceStmtCtx;
  44 import org.opendaylight.yangtools.yang.parser.spi.meta.StatementSupport;
  45 import org.opendaylight.yangtools.yang.parser.spi.meta.StatementSupportNamespace;
  46 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  47 import org.opendaylight.yangtools.yang.parser.spi.meta.SubstatementValidator;
  48 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
  49
  50 @Beta
  51 public final class ChoiceStatementSupport
  52         extends AbstractSchemaTreeStatementSupport<ChoiceStatement, ChoiceEffectiveStatement>
  53         implements ImplicitParentAwareStatementSupport {
  54     private static final SubstatementValidator RFC6020_VALIDATOR = SubstatementValidator.builder(YangStmtMapping.CHOICE)
  55             .addAny(YangStmtMapping.ANYXML)
  56             .addAny(YangStmtMapping.CASE)
  57             .addOptional(YangStmtMapping.CONFIG)
  58             .addAny(YangStmtMapping.CONTAINER)
  59             .addOptional(YangStmtMapping.DEFAULT)
  60             .addOptional(YangStmtMapping.DESCRIPTION)
  61             .addAny(YangStmtMapping.IF_FEATURE)
  62             .addAny(YangStmtMapping.LEAF)
  63             .addAny(YangStmtMapping.LEAF_LIST)
  64             .addAny(YangStmtMapping.LIST)
  65             .addOptional(YangStmtMapping.MANDATORY)
  66             .addOptional(YangStmtMapping.REFERENCE)
  67             .addOptional(YangStmtMapping.STATUS)
  68             .addOptional(YangStmtMapping.WHEN)
  69             .build();
  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             .addOptional(YangStmtMapping.CONFIG)
  76             .addAny(YangStmtMapping.CONTAINER)
  77             .addOptional(YangStmtMapping.DEFAULT)
  78             .addOptional(YangStmtMapping.DESCRIPTION)
  79             .addAny(YangStmtMapping.IF_FEATURE)
  80             .addAny(YangStmtMapping.LEAF)
  81             .addAny(YangStmtMapping.LEAF_LIST)
  82             .addAny(YangStmtMapping.LIST)
  83             .addOptional(YangStmtMapping.MANDATORY)
  84             .addOptional(YangStmtMapping.REFERENCE)
  85             .addOptional(YangStmtMapping.STATUS)
  86             .addOptional(YangStmtMapping.WHEN)
  87             .build();
  88
  89     private ChoiceStatementSupport(final YangParserConfiguration config, final SubstatementValidator validator) {
  90         super(YangStmtMapping.CHOICE, instantiatedPolicy(), config, requireNonNull(validator));
  91     }
  92
  93     public static @NonNull ChoiceStatementSupport rfc6020Instance(final YangParserConfiguration config) {
  94         return new ChoiceStatementSupport(config, RFC6020_VALIDATOR);
  95     }
  96
  97     public static @NonNull ChoiceStatementSupport rfc7950Instance(final YangParserConfiguration config) {
  98         return new ChoiceStatementSupport(config, RFC7950_VALIDATOR);
  99     }
 100
 101     @Override
 102     public Optional<StatementSupport<?, ?, ?>> getImplicitParentFor(final NamespaceStmtCtx parent,
 103             final StatementDefinition stmtDef) {
 104         if (!YangValidationBundles.SUPPORTED_CASE_SHORTHANDS.contains(stmtDef)) {
 105             return Optional.empty();
 106         }
 107         return Optional.of(verifyNotNull(parent.getFromNamespace(StatementSupportNamespace.class,
 108             YangStmtMapping.CASE.getStatementName())));
 109     }
 110
 111     @Override
 112     protected ChoiceStatement createDeclared(@NonNull final StmtContext<QName, ChoiceStatement, ?> ctx,
 113             final ImmutableList<? extends DeclaredStatement<?>> substatements) {
 114         return DeclaredStatements.createChoice(ctx.getArgument(), substatements);
 115     }
 116
 117     @Override
 118     protected ChoiceStatement attachDeclarationReference(final ChoiceStatement stmt,
 119             final DeclarationReference reference) {
 120         return DeclaredStatementDecorators.decorateChoice(stmt, reference);
 121     }
 122
 123     @Override
 124     public ChoiceEffectiveStatement copyEffective(final Current<QName, ChoiceStatement> stmt,
 125             final ChoiceEffectiveStatement original) {
 126         return EffectiveStatements.copyChoice(original, stmt.getArgument(),
 127             computeFlags(stmt, original.effectiveSubstatements()), stmt.original(ChoiceSchemaNode.class));
 128     }
 129
 130     @Override
 131     protected ChoiceEffectiveStatement createEffective(final Current<QName, ChoiceStatement> stmt,
 132             final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
 133         final String defaultArg = findFirstArgument(substatements, DefaultEffectiveStatement.class, null);
 134         final CaseSchemaNode defaultCase;
 135         if (defaultArg != null) {
 136             final QName qname;
 137             try {
 138                 qname = QName.create(stmt.getArgument(), defaultArg);
 139             } catch (IllegalArgumentException e) {
 140                 throw new SourceException(stmt, e, "Default statement has invalid name '%s'", defaultArg);
 141             }
 142
 143             // FIXME: this does not work with submodules, as they are
 144             defaultCase = InferenceException.throwIfNull(findCase(qname, substatements), stmt,
 145                 "Default statement refers to missing case %s", qname);
 146         } else {
 147             defaultCase = null;
 148         }
 149
 150         try {
 151             return EffectiveStatements.createChoice(stmt.declared(), stmt.getArgument(),
 152                 computeFlags(stmt, substatements), substatements, defaultCase, stmt.original(ChoiceSchemaNode.class));
 153         } catch (SubstatementIndexingException e) {
 154             throw new SourceException(e.getMessage(), stmt, e);
 155         }
 156     }
 157
 158     private static int computeFlags(final Current<?, ?> stmt,
 159             final Collection<? extends EffectiveStatement<?, ?>> substatements) {
 160         return new FlagsBuilder()
 161             .setHistory(stmt.history())
 162             .setStatus(findFirstArgument(substatements, StatusEffectiveStatement.class, Status.CURRENT))
 163             .setConfiguration(stmt.effectiveConfig().asNullable())
 164             .setMandatory(findFirstArgument(substatements, MandatoryEffectiveStatement.class, Boolean.FALSE))
 165             .toFlags();
 166     }
 167
 168     private static CaseSchemaNode findCase(final QName qname,
 169             final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
 170         for (final EffectiveStatement<?, ?> effectiveStatement : substatements) {
 171             if (effectiveStatement instanceof CaseSchemaNode) {
 172                 final CaseSchemaNode choiceCaseNode = (CaseSchemaNode) effectiveStatement;
 173                 if (qname.equals(choiceCaseNode.getQName())) {
 174                     return choiceCaseNode;
 175                 }
 176             }
 177         }
 178
 179         return null;
 180     }
 181 }