zserio.ast.IntegerType Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of zserio Show documentation
Zserio Serialization Framework Compiler
The newest version!
package zserio.ast;

import java.math.BigInteger;

/**
 * AST abstract node for all Integer types.
 *
 * This is an abstract class for all built-in Zserio Integer types (int8, uint8, bit:1, int:1, varint16,
 * varuint16, ...).
 */
public abstract class IntegerType extends BuiltInType
{
    /**
     * Constructor from AST node location and the name.
     *
     * @param location AST node location.
     * @param name     Name of the AST node taken from grammar.
     */
    public IntegerType(AstLocation location, String name)
    {
        super(location, name);
    }

    /**
     * Gets upper bound for this integer type.
     *
     * @return Upper bound.
     */
    public abstract BigInteger getUpperBound();

    /**
     * Gets lower bound for this integer type.
     *
     * @return Lower bound.
     */
    public abstract BigInteger getLowerBound();

    /**
     * Checks if this integer type is signed or not.
     *
     * @return true if this integer type is signed.
     */
    public abstract boolean isSigned();

    /**
     * Gets upper bound for this integer type with respect to the given instantiation.
     *
     * @param instantiation Instantiation of this integer type.
     *
     * @return Actual upper bound.
     */
    public BigInteger getUpperBound(TypeInstantiation instantiation)
    {
        if (instantiation instanceof DynamicBitFieldInstantiation)
            return ((DynamicBitFieldInstantiation)instantiation).getUpperBound();

        return getUpperBound();
    }

    /**
     * Gets lower bound for this integer type with respect to the give instantiation.
     *
     * @param instantiation Instantiation of this integer type.
     *
     * @return Actual lower bound.
     */
    public BigInteger getLowerBound(TypeInstantiation instantiation)
    {
        if (instantiation instanceof DynamicBitFieldInstantiation)
            return ((DynamicBitFieldInstantiation)instantiation).getLowerBound();

        return getLowerBound();
    }
}