parser/yang-parser-rfc7950/src/main/java/org/opendaylight/yangtools/yang/parser/rfc7950/stmt/leaf_list/LeafListStatementSupport.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.leaf_list;
   9
  10 import com.google.common.annotations.Beta;
  11 import com.google.common.collect.ImmutableList;
  12 import com.google.common.collect.ImmutableSet;
  13 import java.util.Collection;
  14 import java.util.Optional;
  15 import org.eclipse.jdt.annotation.NonNull;
  16 import org.opendaylight.yangtools.yang.common.Ordering;
  17 import org.opendaylight.yangtools.yang.common.QName;
  18 import org.opendaylight.yangtools.yang.model.api.ElementCountConstraint;
  19 import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode;
  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.stmt.DefaultEffectiveStatement;
  26 import org.opendaylight.yangtools.yang.model.api.stmt.LeafListEffectiveStatement;
  27 import org.opendaylight.yangtools.yang.model.api.stmt.LeafListStatement;
  28 import org.opendaylight.yangtools.yang.model.api.stmt.OrderedByEffectiveStatement;
  29 import org.opendaylight.yangtools.yang.model.api.stmt.StatusEffectiveStatement;
  30 import org.opendaylight.yangtools.yang.model.api.stmt.TypeEffectiveStatement;
  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.spi.meta.EffectiveStatementMixins.EffectiveStatementWithFlags.FlagsBuilder;
  34 import org.opendaylight.yangtools.yang.parser.api.YangParserConfiguration;
  35 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.EffectiveStmtUtils;
  36 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractSchemaTreeStatementSupport;
  37 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
  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 LeafListStatementSupport
  44         extends AbstractSchemaTreeStatementSupport<LeafListStatement, LeafListEffectiveStatement> {
  45     private static final SubstatementValidator RFC6020_VALIDATOR =
  46         SubstatementValidator.builder(YangStmtMapping.LEAF_LIST)
  47             .addOptional(YangStmtMapping.CONFIG)
  48             .addOptional(YangStmtMapping.DESCRIPTION)
  49             .addAny(YangStmtMapping.IF_FEATURE)
  50             .addOptional(YangStmtMapping.MIN_ELEMENTS)
  51             .addOptional(YangStmtMapping.MAX_ELEMENTS)
  52             .addAny(YangStmtMapping.MUST)
  53             .addOptional(YangStmtMapping.ORDERED_BY)
  54             .addOptional(YangStmtMapping.REFERENCE)
  55             .addOptional(YangStmtMapping.STATUS)
  56             .addMandatory(YangStmtMapping.TYPE)
  57             .addOptional(YangStmtMapping.UNITS)
  58             .addOptional(YangStmtMapping.WHEN)
  59             .build();
  60     private static final SubstatementValidator RFC7950_VALIDATOR =
  61         SubstatementValidator.builder(YangStmtMapping.LEAF_LIST)
  62             .addOptional(YangStmtMapping.CONFIG)
  63             .addAny(YangStmtMapping.DEFAULT)
  64             .addOptional(YangStmtMapping.DESCRIPTION)
  65             .addAny(YangStmtMapping.IF_FEATURE)
  66             .addOptional(YangStmtMapping.MIN_ELEMENTS)
  67             .addOptional(YangStmtMapping.MAX_ELEMENTS)
  68             .addAny(YangStmtMapping.MUST)
  69             .addOptional(YangStmtMapping.ORDERED_BY)
  70             .addOptional(YangStmtMapping.REFERENCE)
  71             .addOptional(YangStmtMapping.STATUS)
  72             .addMandatory(YangStmtMapping.TYPE)
  73             .addOptional(YangStmtMapping.UNITS)
  74             .addOptional(YangStmtMapping.WHEN)
  75             .build();
  76
  77     private LeafListStatementSupport(final YangParserConfiguration config, final SubstatementValidator validator) {
  78         super(YangStmtMapping.LEAF_LIST, instantiatedPolicy(), config, validator);
  79     }
  80
  81     public static @NonNull LeafListStatementSupport rfc6020Instance(final YangParserConfiguration config) {
  82         return new LeafListStatementSupport(config, RFC6020_VALIDATOR);
  83     }
  84
  85     public static @NonNull LeafListStatementSupport rfc7950Instance(final YangParserConfiguration config) {
  86         return new LeafListStatementSupport(config, RFC7950_VALIDATOR);
  87     }
  88
  89     @Override
  90     protected LeafListStatement createDeclared(final StmtContext<QName, LeafListStatement, ?> ctx,
  91             final ImmutableList<? extends DeclaredStatement<?>> substatements) {
  92         return DeclaredStatements.createLeafList(ctx.getArgument(), substatements);
  93     }
  94
  95     @Override
  96     protected LeafListStatement attachDeclarationReference(final LeafListStatement stmt,
  97             final DeclarationReference reference) {
  98         return DeclaredStatementDecorators.decorateLeafList(stmt, reference);
  99     }
 100
 101     @Override
 102     public LeafListEffectiveStatement copyEffective(final Current<QName, LeafListStatement> stmt,
 103             final LeafListEffectiveStatement original) {
 104         final int flags = computeFlags(stmt, original.effectiveSubstatements());
 105         if (original instanceof RegularLeafListEffectiveStatement) {
 106             return new RegularLeafListEffectiveStatement((RegularLeafListEffectiveStatement) original,
 107                 stmt.original(LeafListSchemaNode.class), stmt.getArgument(), flags);
 108         } else if (original instanceof SlimLeafListEffectiveStatement) {
 109             return new SlimLeafListEffectiveStatement((SlimLeafListEffectiveStatement) original,
 110                 stmt.original(LeafListSchemaNode.class), stmt.getArgument(), flags);
 111         } else if (original instanceof EmptyLeafListEffectiveStatement) {
 112             // Promote to slim
 113             return new SlimLeafListEffectiveStatement((EmptyLeafListEffectiveStatement) original,
 114                 stmt.original(LeafListSchemaNode.class), stmt.getArgument(), flags);
 115         } else {
 116             // Safe fallback
 117             return super.copyEffective(stmt, original);
 118         }
 119     }
 120
 121     @Override
 122     protected LeafListEffectiveStatement createEffective(final Current<QName, LeafListStatement> stmt,
 123             final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
 124         final TypeEffectiveStatement<?> typeStmt = SourceException.throwIfNull(
 125                 findFirstStatement(substatements, TypeEffectiveStatement.class), stmt,
 126                 "Leaf-list is missing a 'type' statement");
 127
 128         final int flags = computeFlags(stmt, substatements);
 129         final ImmutableSet<String> defaultValues = substatements.stream()
 130                 .filter(DefaultEffectiveStatement.class::isInstance)
 131                 .map(DefaultEffectiveStatement.class::cast)
 132                 .map(DefaultEffectiveStatement::argument)
 133                 .collect(ImmutableSet.toImmutableSet());
 134
 135         // FIXME: We need to interpret the default value in terms of supplied element type
 136         SourceException.throwIf(
 137                 EffectiveStmtUtils.hasDefaultValueMarkedWithIfFeature(stmt.yangVersion(), typeStmt, defaultValues),
 138                 stmt, "Leaf-list '%s' has one of its default values '%s' marked with an if-feature statement.",
 139                 stmt.argument(), defaultValues);
 140
 141         // FIXME: RFC7950 section 7.7.4: we need to check for min-elements and defaultValues conflict
 142
 143         final Optional<ElementCountConstraint> elementCountConstraint =
 144                 EffectiveStmtUtils.createElementCountConstraint(substatements);
 145
 146         final LeafListSchemaNode original = stmt.original(LeafListSchemaNode.class);
 147         final LeafListStatement declared = stmt.declared();
 148         if (defaultValues.isEmpty()) {
 149             return original == null && !elementCountConstraint.isPresent()
 150                 ? new EmptyLeafListEffectiveStatement(declared, stmt.getArgument(), flags, substatements)
 151                     : new SlimLeafListEffectiveStatement(declared, stmt.getArgument(), flags, substatements, original,
 152                         elementCountConstraint.orElse(null));
 153         }
 154
 155         return new RegularLeafListEffectiveStatement(declared, stmt.getArgument(), flags, substatements, original,
 156             defaultValues, elementCountConstraint.orElse(null));
 157     }
 158
 159     private static int computeFlags(final Current<?, ?> stmt,
 160         final Collection<? extends EffectiveStatement<?, ?>> substatements) {
 161         return new FlagsBuilder()
 162             .setHistory(stmt.history())
 163             .setStatus(findFirstArgument(substatements, StatusEffectiveStatement.class, Status.CURRENT))
 164             .setConfiguration(stmt.effectiveConfig().asNullable())
 165             .setUserOrdered(findFirstArgument(substatements, OrderedByEffectiveStatement.class, Ordering.SYSTEM)
 166                 .equals(Ordering.USER))
 167             .toFlags();
 168     }
 169 }