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