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.verify;
  11 import static com.google.common.base.Verify.verifyNotNull;
  12 import static java.util.Objects.requireNonNull;
  13
  14 import com.google.common.annotations.Beta;
  15 import com.google.common.collect.ImmutableList;
  16 import com.google.common.collect.ImmutableSet;
  17 import java.util.Collection;
  18 import java.util.Optional;
  19 import org.eclipse.jdt.annotation.NonNull;
  20 import org.opendaylight.yangtools.yang.common.QName;
  21 import org.opendaylight.yangtools.yang.model.api.CaseSchemaNode;
  22 import org.opendaylight.yangtools.yang.model.api.ChoiceSchemaNode;
  23 import org.opendaylight.yangtools.yang.model.api.Status;
  24 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
  25 import org.opendaylight.yangtools.yang.model.api.meta.DeclarationReference;
  26 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
  27 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  28 import org.opendaylight.yangtools.yang.model.api.meta.StatementDefinition;
  29 import org.opendaylight.yangtools.yang.model.api.stmt.ChoiceEffectiveStatement;
  30 import org.opendaylight.yangtools.yang.model.api.stmt.ChoiceStatement;
  31 import org.opendaylight.yangtools.yang.model.api.stmt.DefaultEffectiveStatement;
  32 import org.opendaylight.yangtools.yang.model.api.stmt.MandatoryEffectiveStatement;
  33 import org.opendaylight.yangtools.yang.model.api.stmt.StatusEffectiveStatement;
  34 import org.opendaylight.yangtools.yang.model.ri.stmt.DeclaredStatementDecorators;
  35 import org.opendaylight.yangtools.yang.model.ri.stmt.DeclaredStatements;
  36 import org.opendaylight.yangtools.yang.model.ri.stmt.EffectiveStatements;
  37 import org.opendaylight.yangtools.yang.model.spi.meta.EffectiveStatementMixins.EffectiveStatementWithFlags.FlagsBuilder;
  38 import org.opendaylight.yangtools.yang.model.spi.meta.SubstatementIndexingException;
  39 import org.opendaylight.yangtools.yang.parser.api.YangParserConfiguration;
  40 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractSchemaTreeStatementSupport;
  41 import org.opendaylight.yangtools.yang.parser.spi.meta.BoundStmtCtx;
  42 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStatementState;
  43 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
  44 import org.opendaylight.yangtools.yang.parser.spi.meta.ImplicitParentAwareStatementSupport;
  45 import org.opendaylight.yangtools.yang.parser.spi.meta.InferenceException;
  46 import org.opendaylight.yangtools.yang.parser.spi.meta.NamespaceStmtCtx;
  47 import org.opendaylight.yangtools.yang.parser.spi.meta.QNameWithFlagsEffectiveStatementState;
  48 import org.opendaylight.yangtools.yang.parser.spi.meta.StatementSupport;
  49 import org.opendaylight.yangtools.yang.parser.spi.meta.SubstatementValidator;
  50 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
  51
  52 @Beta
  53 public final class ChoiceStatementSupport
  54         extends AbstractSchemaTreeStatementSupport<ChoiceStatement, ChoiceEffectiveStatement>
  55         implements ImplicitParentAwareStatementSupport {
  56     private static final SubstatementValidator RFC6020_VALIDATOR = SubstatementValidator.builder(YangStmtMapping.CHOICE)
  57             .addAny(YangStmtMapping.ANYXML)
  58             .addAny(YangStmtMapping.CASE)
  59             .addOptional(YangStmtMapping.CONFIG)
  60             .addAny(YangStmtMapping.CONTAINER)
  61             .addOptional(YangStmtMapping.DEFAULT)
  62             .addOptional(YangStmtMapping.DESCRIPTION)
  63             .addAny(YangStmtMapping.IF_FEATURE)
  64             .addAny(YangStmtMapping.LEAF)
  65             .addAny(YangStmtMapping.LEAF_LIST)
  66             .addAny(YangStmtMapping.LIST)
  67             .addOptional(YangStmtMapping.MANDATORY)
  68             .addOptional(YangStmtMapping.REFERENCE)
  69             .addOptional(YangStmtMapping.STATUS)
  70             .addOptional(YangStmtMapping.WHEN)
  71             .build();
  72     private static final ImmutableSet<StatementDefinition> RFC6020_CASE_SHORTHANDS = ImmutableSet.of(
  73             YangStmtMapping.ANYXML, YangStmtMapping.CONTAINER, YangStmtMapping.LEAF, YangStmtMapping.LIST,
  74             YangStmtMapping.LEAF_LIST);
  75
  76     private static final SubstatementValidator RFC7950_VALIDATOR = SubstatementValidator.builder(YangStmtMapping.CHOICE)
  77             .addAny(YangStmtMapping.ANYDATA)
  78             .addAny(YangStmtMapping.ANYXML)
  79             .addAny(YangStmtMapping.CASE)
  80             .addAny(YangStmtMapping.CHOICE)
  81             .addOptional(YangStmtMapping.CONFIG)
  82             .addAny(YangStmtMapping.CONTAINER)
  83             .addOptional(YangStmtMapping.DEFAULT)
  84             .addOptional(YangStmtMapping.DESCRIPTION)
  85             .addAny(YangStmtMapping.IF_FEATURE)
  86             .addAny(YangStmtMapping.LEAF)
  87             .addAny(YangStmtMapping.LEAF_LIST)
  88             .addAny(YangStmtMapping.LIST)
  89             .addOptional(YangStmtMapping.MANDATORY)
  90             .addOptional(YangStmtMapping.REFERENCE)
  91             .addOptional(YangStmtMapping.STATUS)
  92             .addOptional(YangStmtMapping.WHEN)
  93             .build();
  94     private static final ImmutableSet<StatementDefinition> RFC7950_CASE_SHORTHANDS = ImmutableSet.of(
  95         YangStmtMapping.ANYDATA, YangStmtMapping.ANYXML, YangStmtMapping.CHOICE, YangStmtMapping.CONTAINER,
  96         YangStmtMapping.LEAF, YangStmtMapping.LIST, YangStmtMapping.LEAF_LIST);
  97
  98     private final ImmutableSet<StatementDefinition> caseShorthands;
  99
 100     private ChoiceStatementSupport(final YangParserConfiguration config, final SubstatementValidator validator,
 101             final ImmutableSet<StatementDefinition> caseShorthands) {
 102         super(YangStmtMapping.CHOICE, instantiatedPolicy(), config, requireNonNull(validator));
 103         this.caseShorthands = requireNonNull(caseShorthands);
 104     }
 105
 106     public static @NonNull ChoiceStatementSupport rfc6020Instance(final YangParserConfiguration config) {
 107         return new ChoiceStatementSupport(config, RFC6020_VALIDATOR, RFC6020_CASE_SHORTHANDS);
 108     }
 109
 110     public static @NonNull ChoiceStatementSupport rfc7950Instance(final YangParserConfiguration config) {
 111         return new ChoiceStatementSupport(config, RFC7950_VALIDATOR, RFC7950_CASE_SHORTHANDS);
 112     }
 113
 114     @Override
 115     public Optional<StatementSupport<?, ?, ?>> getImplicitParentFor(final NamespaceStmtCtx parent,
 116             final StatementDefinition stmtDef) {
 117         if (!caseShorthands.contains(stmtDef)) {
 118             return Optional.empty();
 119         }
 120         return Optional.of(verifyNotNull(parent.getFromNamespace(StatementSupport.NAMESPACE,
 121             YangStmtMapping.CASE.getStatementName())));
 122     }
 123
 124     @Override
 125     protected ChoiceStatement createDeclared(final BoundStmtCtx<QName> ctx,
 126             final ImmutableList<DeclaredStatement<?>> substatements) {
 127         return DeclaredStatements.createChoice(ctx.getArgument(), substatements);
 128     }
 129
 130     @Override
 131     protected ChoiceStatement attachDeclarationReference(final ChoiceStatement stmt,
 132             final DeclarationReference reference) {
 133         return DeclaredStatementDecorators.decorateChoice(stmt, reference);
 134     }
 135
 136     @Override
 137     public ChoiceEffectiveStatement copyEffective(final Current<QName, ChoiceStatement> stmt,
 138             final ChoiceEffectiveStatement original) {
 139         return EffectiveStatements.copyChoice(original, stmt.getArgument(),
 140             computeFlags(stmt, original.effectiveSubstatements()));
 141     }
 142
 143     @Override
 144     protected ChoiceEffectiveStatement createEffective(final Current<QName, ChoiceStatement> stmt,
 145             final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
 146         final String defaultArg = findFirstArgument(substatements, DefaultEffectiveStatement.class, null);
 147         final CaseSchemaNode defaultCase;
 148         if (defaultArg != null) {
 149             final QName qname;
 150             try {
 151                 qname = QName.create(stmt.getArgument(), defaultArg);
 152             } catch (IllegalArgumentException e) {
 153                 throw new SourceException(stmt, e, "Default statement has invalid name '%s'", defaultArg);
 154             }
 155
 156             // FIXME: this does not work with submodules, as they are
 157             defaultCase = InferenceException.throwIfNull(findCase(qname, substatements), stmt,
 158                 "Default statement refers to missing case %s", qname);
 159         } else {
 160             defaultCase = null;
 161         }
 162
 163         try {
 164             return EffectiveStatements.createChoice(stmt.declared(), stmt.getArgument(),
 165                 computeFlags(stmt, substatements), substatements, defaultCase);
 166         } catch (SubstatementIndexingException e) {
 167             throw new SourceException(e.getMessage(), stmt, e);
 168         }
 169     }
 170
 171     @Override
 172     public EffectiveStatementState extractEffectiveState(final ChoiceEffectiveStatement stmt) {
 173         verify(stmt instanceof ChoiceSchemaNode, "Unexpected statement %s", stmt);
 174         final var schema = (ChoiceSchemaNode) stmt;
 175         return new QNameWithFlagsEffectiveStatementState(stmt.argument(), new FlagsBuilder()
 176             .setHistory(schema)
 177             .setStatus(schema.getStatus())
 178             .setConfiguration(schema.effectiveConfig().orElse(null))
 179             .setMandatory(schema.isMandatory())
 180             .toFlags());
 181     }
 182
 183     private static int computeFlags(final Current<?, ?> stmt,
 184             final Collection<? extends EffectiveStatement<?, ?>> substatements) {
 185         return new FlagsBuilder()
 186             .setHistory(stmt.history())
 187             .setStatus(findFirstArgument(substatements, StatusEffectiveStatement.class, Status.CURRENT))
 188             .setConfiguration(stmt.effectiveConfig().asNullable())
 189             .setMandatory(findFirstArgument(substatements, MandatoryEffectiveStatement.class, Boolean.FALSE))
 190             .toFlags();
 191     }
 192
 193     private static CaseSchemaNode findCase(final QName qname,
 194             final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
 195         for (final EffectiveStatement<?, ?> effectiveStatement : substatements) {
 196             if (effectiveStatement instanceof CaseSchemaNode choiceCaseNode) {
 197                 if (qname.equals(choiceCaseNode.getQName())) {
 198                     return choiceCaseNode;
 199                 }
 200             }
 201         }
 202
 203         return null;
 204     }
 205 }