yang/yang-parser-rfc7950/src/main/java/org/opendaylight/yangtools/yang/parser/rfc7950/stmt/type/BitsSpecificationSupport.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.type;
   9
  10 import com.google.common.collect.ImmutableList;
  11 import java.util.Optional;
  12 import org.opendaylight.yangtools.yang.common.Uint32;
  13 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
  14 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
  15 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  16 import org.opendaylight.yangtools.yang.model.api.stmt.BitEffectiveStatement;
  17 import org.opendaylight.yangtools.yang.model.api.stmt.TypeStatement.BitsSpecification;
  18 import org.opendaylight.yangtools.yang.model.api.type.BitsTypeDefinition.Bit;
  19 import org.opendaylight.yangtools.yang.model.ri.type.BaseTypes;
  20 import org.opendaylight.yangtools.yang.model.ri.type.BitsTypeBuilder;
  21 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractStringStatementSupport;
  22 import org.opendaylight.yangtools.yang.parser.spi.meta.CommonStmtCtx;
  23 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
  24 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  25 import org.opendaylight.yangtools.yang.parser.spi.meta.SubstatementValidator;
  26 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
  27
  28 final class BitsSpecificationSupport
  29         extends AbstractStringStatementSupport<BitsSpecification, EffectiveStatement<String, BitsSpecification>> {
  30     private static final SubstatementValidator SUBSTATEMENT_VALIDATOR = SubstatementValidator.builder(
  31         YangStmtMapping.TYPE)
  32         .addMultiple(YangStmtMapping.BIT)
  33         .build();
  34
  35     BitsSpecificationSupport() {
  36         super(YangStmtMapping.TYPE, StatementPolicy.exactReplica());
  37     }
  38
  39     @Override
  40     protected SubstatementValidator getSubstatementValidator() {
  41         return SUBSTATEMENT_VALIDATOR;
  42     }
  43
  44     @Override
  45     protected BitsSpecification createDeclared(final StmtContext<String, BitsSpecification, ?> ctx,
  46             final ImmutableList<? extends DeclaredStatement<?>> substatements) {
  47         return new BitsSpecificationImpl(ctx.getRawArgument(), substatements);
  48     }
  49
  50     @Override
  51     protected BitsSpecification createEmptyDeclared(final StmtContext<String, BitsSpecification, ?> ctx) {
  52         throw noBits(ctx);
  53     }
  54
  55     @Override
  56     protected EffectiveStatement<String, BitsSpecification> createEffective(
  57             final Current<String, BitsSpecification> stmt,
  58             final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
  59         if (substatements.isEmpty()) {
  60             throw noBits(stmt);
  61         }
  62
  63         final BitsTypeBuilder builder = BaseTypes.bitsTypeBuilder(stmt.argumentAsTypeQName());
  64         Uint32 highestPosition = null;
  65         for (final EffectiveStatement<?, ?> subStmt : substatements) {
  66             if (subStmt instanceof BitEffectiveStatement) {
  67                 final BitEffectiveStatement bitSubStmt = (BitEffectiveStatement) subStmt;
  68
  69                 final Optional<Uint32> declaredPosition = bitSubStmt.getDeclaredPosition();
  70                 final Uint32 effectivePos;
  71                 if (declaredPosition.isEmpty()) {
  72                     if (highestPosition != null) {
  73                         SourceException.throwIf(Uint32.MAX_VALUE.equals(highestPosition), stmt,
  74                             "Bit %s must have a position statement", bitSubStmt);
  75                         effectivePos = Uint32.fromIntBits(highestPosition.intValue() + 1);
  76                     } else {
  77                         effectivePos = Uint32.ZERO;
  78                     }
  79                 } else {
  80                     effectivePos = declaredPosition.get();
  81                 }
  82
  83                 final Bit bit = EffectiveTypeUtil.buildBit(bitSubStmt, effectivePos);
  84                 if (highestPosition == null || highestPosition.compareTo(bit.getPosition()) < 0) {
  85                     highestPosition = bit.getPosition();
  86                 }
  87
  88                 builder.addBit(bit);
  89             }
  90         }
  91
  92         return new TypeEffectiveStatementImpl<>(stmt.declared(), substatements, builder);
  93     }
  94
  95     private static SourceException noBits(final CommonStmtCtx stmt) {
  96         /*
  97          *  https://tools.ietf.org/html/rfc7950#section-9.7.4:
  98          *
  99          *     The "bit" statement, which is a substatement to the "type" statement,
 100          *     MUST be present if the type is "bits".
 101          */
 102         return new SourceException("At least one bit statement has to be present", stmt);
 103     }
 104 }