yang/yang-parser-rfc7950/src/main/java/org/opendaylight/yangtools/yang/parser/rfc7950/stmt/length/LengthStatementSupport.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.length;
   9
  10 import com.google.common.collect.ImmutableList;
  11 import com.google.common.collect.Iterables;
  12 import java.util.ArrayList;
  13 import java.util.Iterator;
  14 import java.util.List;
  15 import org.eclipse.jdt.annotation.NonNull;
  16 import org.opendaylight.yangtools.yang.common.Uint64;
  17 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
  18 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
  19 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  20 import org.opendaylight.yangtools.yang.model.api.stmt.LengthEffectiveStatement;
  21 import org.opendaylight.yangtools.yang.model.api.stmt.LengthStatement;
  22 import org.opendaylight.yangtools.yang.model.api.stmt.UnresolvedNumber;
  23 import org.opendaylight.yangtools.yang.model.api.stmt.ValueRange;
  24 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.ArgumentUtils;
  25 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractStatementSupport;
  26 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
  27 import org.opendaylight.yangtools.yang.parser.spi.meta.InferenceException;
  28 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  29 import org.opendaylight.yangtools.yang.parser.spi.meta.SubstatementValidator;
  30 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
  31
  32 public final class LengthStatementSupport
  33         extends AbstractStatementSupport<List<ValueRange>, LengthStatement, LengthEffectiveStatement> {
  34     private static final SubstatementValidator SUBSTATEMENT_VALIDATOR = SubstatementValidator.builder(YangStmtMapping
  35         .LENGTH)
  36         .addOptional(YangStmtMapping.DESCRIPTION)
  37         .addOptional(YangStmtMapping.ERROR_APP_TAG)
  38         .addOptional(YangStmtMapping.ERROR_MESSAGE)
  39         .addOptional(YangStmtMapping.REFERENCE)
  40         .build();
  41     private static final LengthStatementSupport INSTANCE = new LengthStatementSupport();
  42
  43     private LengthStatementSupport() {
  44         super(YangStmtMapping.LENGTH, StatementPolicy.contextIndependent());
  45     }
  46
  47     public static LengthStatementSupport getInstance() {
  48         return INSTANCE;
  49     }
  50
  51     @Override
  52     public ImmutableList<ValueRange> parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
  53         final List<ValueRange> ranges = new ArrayList<>();
  54
  55         for (final String singleRange : ArgumentUtils.PIPE_SPLITTER.split(value)) {
  56             final Iterator<String> boundaries = ArgumentUtils.TWO_DOTS_SPLITTER.split(singleRange).iterator();
  57             final Number min = parseIntegerConstraintValue(ctx, boundaries.next());
  58
  59             final Number max;
  60             if (boundaries.hasNext()) {
  61                 max = parseIntegerConstraintValue(ctx, boundaries.next());
  62
  63                 // if min larger than max then error
  64                 SourceException.throwIf(ArgumentUtils.compareNumbers(min, max) == 1, ctx,
  65                     "Length constraint %s has descending order of boundaries; should be ascending.", singleRange);
  66                 SourceException.throwIf(boundaries.hasNext(), ctx,
  67                     "Wrong number of boundaries in length constraint %s.", singleRange);
  68             } else {
  69                 max = min;
  70             }
  71
  72             // some of intervals overlapping
  73             InferenceException.throwIf(
  74                 ranges.size() > 1 && ArgumentUtils.compareNumbers(min, Iterables.getLast(ranges).upperBound()) != 1,
  75                 ctx, "Some of the length ranges in %s are not disjoint", value);
  76             ranges.add(ValueRange.of(min, max));
  77         }
  78
  79         return ImmutableList.copyOf(ranges);
  80     }
  81
  82     @Override
  83     protected SubstatementValidator getSubstatementValidator() {
  84         return SUBSTATEMENT_VALIDATOR;
  85     }
  86
  87     @Override
  88     protected LengthStatement createDeclared(final StmtContext<List<ValueRange>, LengthStatement, ?> ctx,
  89             final ImmutableList<? extends DeclaredStatement<?>> substatements) {
  90         return new RegularLengthStatement(ctx.getRawArgument(), ctx.getArgument(), substatements);
  91     }
  92
  93     @Override
  94     protected LengthStatement createEmptyDeclared(final StmtContext<List<ValueRange>, LengthStatement, ?> ctx) {
  95         return new EmptyLengthStatement(ctx.getRawArgument(), ctx.getArgument());
  96     }
  97
  98     @Override
  99     protected LengthEffectiveStatement createEffective(final Current<List<ValueRange>, LengthStatement> stmt,
 100             final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
 101         return substatements.isEmpty() ? new EmptyLengthEffectiveStatement(stmt.declared())
 102             : new RegularLengthEffectiveStatement(stmt.declared(), substatements);
 103     }
 104
 105     private static @NonNull Number parseIntegerConstraintValue(final StmtContext<?, ?, ?> ctx, final String value) {
 106         if ("max".equals(value)) {
 107             return UnresolvedNumber.max();
 108         }
 109         if ("min".equals(value)) {
 110             return UnresolvedNumber.min();
 111         }
 112
 113         // As per RFC6020/RFC7950 section 9.4.4:
 114         //
 115         //   An implementation is not required to support a length value larger than 18446744073709551615.
 116         //
 117         // We could support bigger precision at the cost of additional memory and/or potential ValueRange upper/lower
 118         // bound inconsistency. We also take advantage of Uint64's interning facilities.
 119         try {
 120             return Uint64.valueOf(value).intern();
 121         } catch (NumberFormatException e) {
 122             throw new SourceException(ctx, e, "Value %s is not a valid unsigned integer", value);
 123         } catch (IllegalArgumentException e) {
 124             throw new SourceException(ctx, e, "Value %s exceeds maximum supported value %s", value, Uint64.MAX_VALUE);
 125         }
 126     }
 127 }