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