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