bitfields-impl 1.0.3

Macro for generating flexible bitfields. Useful for low-level code (embedded or emulators).
Documentation
use proc_macro2::Span;

use crate::create_syn_error;
use crate::generation::common::PANIC_ERROR_MESSAGE;
use crate::parsing::types::IntegerType::{
    Bool, I8, I16, I32, I64, I128, Isize, U8, U16, U32, U64, U128, UnknownInteger, Usize,
};

#[derive(PartialEq, Debug)]
pub(crate) enum IntegerType {
    U8,
    U16,
    U32,
    U64,
    U128,
    Usize,
    Isize,
    I8,
    I16,
    I32,
    I64,
    I128,
    Bool,
    UnknownInteger,
}

const UNSIGNED_INTEGER_TYPES: [IntegerType; 6] = [U8, U16, U32, U64, U128, Usize];
const SIGNED_INTEGER_TYPES: [IntegerType; 6] = [I8, I16, I32, I64, I128, Isize];
const SUPPORTED_BITFIELD_TYPES: [IntegerType; 5] = [U8, U16, U32, U64, U128];
const SUPPORTED_BITFIELD_FIELD_TYPES: [IntegerType; 13] =
    [U8, U16, U32, U64, U128, Usize, I8, I16, I32, I64, I128, Isize, Bool];
const SIZE_TYPES: [IntegerType; 2] = [Usize, Isize];

/// Returns the integer type from the type.
pub(crate) fn get_integer_type_from_type(ty: &syn::Type) -> IntegerType {
    match &*get_type_ident(ty).unwrap() {
        "u8" => U8,
        "u16" => U16,
        "u32" => U32,
        "u64" => U64,
        "u128" => U128,
        "usize" => Usize,
        "i8" => I8,
        "i16" => I16,
        "i32" => I32,
        "i64" => I64,
        "i128" => I128,
        "isize" => Isize,
        "bool" => Bool,
        _ => UnknownInteger,
    }
}

/// Returns the integer suffix from the integer type.
pub(crate) fn get_integer_suffix_from_integer_type(
    integer_type: IntegerType,
) -> syn::Result<String> {
    match integer_type {
        U8 => Ok("u8".to_string()),
        U16 => Ok("u16".to_string()),
        U32 => Ok("u32".to_string()),
        U64 => Ok("u64".to_string()),
        U128 => Ok("u128".to_string()),
        Usize => Ok("usize".to_string()),
        I8 => Ok("i8".to_string()),
        I16 => Ok("i16".to_string()),
        I32 => Ok("i32".to_string()),
        I64 => Ok("i64".to_string()),
        I128 => Ok("i128".to_string()),
        Isize => Ok("isize".to_string()),
        Bool => Ok("bool".to_string()),
        _ => Err(create_syn_error(Span::call_site(), PANIC_ERROR_MESSAGE))?,
    }
}

/// Returns if the type is a supported bitfield type.
pub(crate) fn is_supported_bitfield_type(ty: &syn::Type) -> bool {
    SUPPORTED_BITFIELD_TYPES.contains(&get_integer_type_from_type(ty))
}

/// Returns if the type is a supported bitfield field type.
pub(crate) fn is_supported_field_type(ty: &syn::Type) -> bool {
    is_custom_field_type(ty)
        || SUPPORTED_BITFIELD_FIELD_TYPES.contains(&get_integer_type_from_type(ty))
}

/// Returns if the type is an unsigned integer type.
pub(crate) fn is_unsigned_integer_type(ty: &syn::Type) -> bool {
    UNSIGNED_INTEGER_TYPES.contains(&get_integer_type_from_type(ty)) || is_bool_type(ty)
}

/// Returns if the type is an unsigned integer type.
pub(crate) fn is_signed_integer_type(ty: &syn::Type) -> bool {
    SIGNED_INTEGER_TYPES.contains(&get_integer_type_from_type(ty))
}

/// Returns if the type is an unsigned integer type.
pub(crate) fn is_bool_type(ty: &syn::Type) -> bool {
    get_integer_type_from_type(ty) == Bool
}

/// Returns the number of bits of the integer type.
pub(crate) fn get_bits_from_type(ty: &syn::Type) -> syn::Result<u8> {
    match get_type_ident(ty).unwrap().as_str() {
        "bool" => Ok(1),
        "u8" | "i8" => Ok(8),
        "u16" | "i16" => Ok(16),
        "u32" | "i32" => Ok(32),
        "u64" | "i64" => Ok(64),
        "u128" | "i128" => Ok(128),
        _ => Err(create_syn_error(Span::call_site(), PANIC_ERROR_MESSAGE))?,
    }
}

/// Returns if the type is a size type.
pub(crate) fn is_size_type(ty: &syn::Type) -> bool {
    SIZE_TYPES.contains(&get_integer_type_from_type(ty))
}

/// Returns if the type is a custom field type.
pub(crate) fn is_custom_field_type(ty: &syn::Type) -> bool {
    !is_unsigned_integer_type(ty) && !is_signed_integer_type(ty) && !is_bool_type(ty)
}

/// Returns the identifier of the type.
pub(crate) fn get_type_ident(ty: &syn::Type) -> Option<String> {
    if let syn::Type::Path(ty) = ty {
        if let Some(segment) = ty.path.segments.first() {
            return Some(segment.ident.to_string());
        }
    }

    None
}