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