rabbitizer 2.0.0-alpha.9

/* SPDX-FileCopyrightText: © 2024-2025 Decompollaborate */
/* SPDX-License-Identifier: MIT */

#[must_use]
pub(crate) const fn mask(value: u32, width: u32) -> u32 {
    assert!(
        width < 32,
        "This operation is defined only for bitwidths up to 31 bits."
    );

    value & ((1 << width) - 1)
}

#[must_use]
pub(crate) const fn bitmask(shift: u32, width: u32) -> u32 {
    assert!(
        shift + width <= 32,
        "Can't create a bitmask larger than 32 bits"
    );

    mask(u32::MAX, width) << shift
}

#[cfg(any(feature = "R4000ALLEGREX", feature = "R5900EE"))]
#[must_use]
pub(crate) const fn from_2s_complement<const WIDTH: u32>(number: u32) -> i32 {
    const {
        assert!(
            WIDTH < 32,
            "This operation is defined only for bitwidths between 1 and 31 bits."
        );
        assert!(
            WIDTH > 0,
            "This operation is defined only for bitwidths between 1 and 31 bits."
        );
    }

    let is_negative = number & (1 << (WIDTH - 1)) != 0;

    if is_negative {
        -(mask(!number + 1, WIDTH) as i32)
    } else {
        number as i32
    }
}

#[cfg(feature = "R4000ALLEGREX")]
pub mod f16 {
    use super::*;

    #[must_use]
    pub(crate) const fn repr_32_from_16(mut arg: u16) -> u32 {
        // IEEE754 16-bit floats are encoded in 16 bits as follows:
        // Sign bit: 1 bit (bit 15)
        // Encoded exponent: 5 bits (bits 10 ~ 14)
        // Fraction/Mantissa: 10 bits (bits 0 ~ 9)

        let mut ret: u32 = 0;
        let sign: i32 = (arg as i32) >> 15;

        // If parameter is zero, then return zero
        if (arg & !(1 << 15)) == 0 {
            // Preserve the sign
            ret |= (sign as u32) << 31;
            return ret;
        }

        // Clear up the sign
        arg &= !(1 << 15);

        let encoded_exponent: i32 = arg as i32 >> 10;
        // Clear up the encoded exponent
        arg &= !bitmask(10, 5) as u16;

        // Exponent bias: 0xF
        let real_exponent: i32 = encoded_exponent - 0xF;

        let mantissa_is_zero: bool = arg == 0;

        if encoded_exponent == 0 {
            // subnormals

            ret |= (sign as u32) << 31;
            // no need to set the exponent part since it was already zero'd

            // Set the mantissa
            ret |= (arg as u32) >> (23 - 10);

            return ret;
        }

        if encoded_exponent == 0x1F {
            // Infinity and NaN

            ret |= (sign as u32) << 31;
            ret |= bitmask(23, 8);

            if !mantissa_is_zero {
                // NaN

                // Set the mantissa to any non-zero value
                ret |= (arg as u32) << (23 - 10);
            }

            return ret;
        }

        ret |= (sign as u32) << 31;

        // re-encode the exponent
        ret |= ((real_exponent + 0x7F) as u32) << 23;

        // Set the mantissa
        ret |= (arg as u32) << (23 - 10);

        ret
    }

    #[must_use]
    #[cfg(feature = "encoder")]
    pub(crate) const fn repr_16_from_32(mut arg: u32) -> u16 {
        // IEEE754 16-bit floats are encoded in 16 bits as follows:
        // Sign bit: 1 bit (bit 15)
        // Encoded exponent: 5 bits (bits 10 ~ 14)
        // Fraction/Mantissa: 10 bits (bits 0 ~ 9)

        let mut ret = 0;
        let sign = (arg >> 31) as u16;

        // Clear up the sign
        arg &= !(1 << 31);

        // If parameter is zero, then return zero
        if arg == 0 {
            // Preserve the sign
            ret |= sign << 15;
            return ret;
        }

        let encoded_exponent = (arg >> 23) as i32;
        // Clear up the encoded exponent
        arg &= !bitmask(23, 8);

        // Exponent bias: 0xF
        let real_exponent = encoded_exponent - 0x7F;

        let mantissa_is_zero = arg == 0;

        match encoded_exponent {
            0x00 => {
                // subnormals

                ret |= sign << 15;
                // no need to set the exponent part since it was already zero'd

                // Set the mantissa
                ret |= (arg >> (23 - 10)) as u16;

                ret
            }
            0xFF => {
                // Infinity and NaN

                ret |= sign << 15;
                ret |= bitmask(10, 5) as u16;

                if !mantissa_is_zero {
                    // NaN

                    // Set the mantissa to any non-zero value
                    ret |= (arg >> (23 - 10)) as u16;
                }

                ret
            }
            _ => {
                ret |= sign << 15;

                // re-encode the exponent
                ret |= (mask((real_exponent + 0xF) as u32, 5) as u16) << 10;

                // Set the mantissa
                ret |= (arg >> (23 - 10)) as u16;

                ret
            }
        }
    }

    #[cfg(test)]
    mod tests {
        use super::*;

        #[test]
        fn test_repr_32_from_16_1_5() {
            // 1.5 in f16
            let hex_16 = 0x3E00;
            let hex_32 = repr_32_from_16(hex_16);

            assert_eq!(hex_32, 0x3FC00000);
            assert_eq!(f32::from_bits(hex_32), 1.5);
        }
    }
}

pub(crate) fn array_len_non_default<T, const N: usize>(array: &[T; N]) -> usize
where
    T: Default + PartialEq,
{
    let mut end_aux = N;
    let default = T::default();
    loop {
        if end_aux == 0 {
            break 0;
        }
        let end2 = end_aux - 1;
        if array[end2] != default {
            break end_aux;
        }
        end_aux = end2;
    }
}

#[cfg(feature = "encoder")]
pub mod iter {
    #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq, PartialOrd, Ord)]
    pub struct DoubleOptIterator<I>
    where
        I: Iterator,
    {
        iter: I,
        front: Option<I::Item>,
    }

    impl<I> DoubleOptIterator<I>
    where
        I: Iterator,
    {
        pub const fn new(iter: I) -> Self {
            Self { iter, front: None }
        }

        #[cfg(feature = "R4000ALLEGREX")]
        pub fn push_front(&mut self, item: I::Item) {
            self.front = Some(item);
        }

        #[cfg(feature = "R4000ALLEGREX")]
        pub fn next_inner(&mut self) -> Option<I::Item> {
            self.iter.next()
        }
    }

    impl<I> Iterator for DoubleOptIterator<I>
    where
        I: Iterator,
    {
        type Item = (I::Item, Option<I::Item>);

        fn next(&mut self) -> Option<Self::Item> {
            match self.front.take().or_else(|| self.iter.next()) {
                None => None,
                Some(x) => Some((x, self.iter.next())),
            }
        }
    }
}

#[cfg(feature = "encoder")]
pub mod hex_num {
    pub fn i32_from_str(s: &str) -> Result<i32, core::num::ParseIntError> {
        if matches!(s, "-0x80000000" | "-0X80000000" | "-2147483648") {
            return Ok(-0x80000000);
        }

        let is_negative = s.starts_with('-');
        let s = s.trim_start_matches('-');

        let value = if s.starts_with("0x") || s.starts_with("0X") {
            i32::from_str_radix(s.trim_start_matches("0x").trim_start_matches("0X"), 16)?
        } else {
            s.parse()?
        };

        Ok(if is_negative { -value } else { value })
    }

    pub fn u32_from_str(s: &str) -> Result<u32, core::num::ParseIntError> {
        let value = if s.starts_with("0x") || s.starts_with("0X") {
            u32::from_str_radix(s.trim_start_matches("0x").trim_start_matches("0X"), 16)?
        } else {
            s.parse()?
        };

        Ok(value)
    }

    pub fn i16_from_str(s: &str) -> Result<i16, core::num::ParseIntError> {
        if matches!(s, "-0x8000" | "-0X8000" | "-32768") {
            return Ok(-0x8000);
        }

        let is_negative = s.starts_with('-');
        let s = s.trim_start_matches('-');

        let value = if s.starts_with("0x") || s.starts_with("0X") {
            i16::from_str_radix(s.trim_start_matches("0x").trim_start_matches("0X"), 16)?
        } else {
            s.parse()?
        };

        Ok(if is_negative { -value } else { value })
    }

    pub fn u16_from_str(s: &str) -> Result<u16, core::num::ParseIntError> {
        let value = if s.starts_with("0x") || s.starts_with("0X") {
            u16::from_str_radix(s.trim_start_matches("0x").trim_start_matches("0X"), 16)?
        } else {
            s.parse()?
        };

        Ok(value)
    }

    #[cfg(any(feature = "R4000ALLEGREX", feature = "R5900EE"))]
    pub fn i8_from_str(s: &str) -> Result<i8, core::num::ParseIntError> {
        if matches!(s, "-0x80" | "-0X80" | "-128") {
            return Ok(-0x80);
        }

        let is_negative = s.starts_with('-');
        let s = s.trim_start_matches('-');

        let value = if s.starts_with("0x") || s.starts_with("0X") {
            i8::from_str_radix(s.trim_start_matches("0x").trim_start_matches("0X"), 16)?
        } else {
            s.parse()?
        };

        Ok(if is_negative { -value } else { value })
    }

    pub fn u8_from_str(s: &str) -> Result<u8, core::num::ParseIntError> {
        let value = if s.starts_with("0x") || s.starts_with("0X") {
            u8::from_str_radix(s.trim_start_matches("0x").trim_start_matches("0X"), 16)?
        } else {
            s.parse()?
        };

        Ok(value)
    }
}

#[cfg(test)]
pub mod truth {
    /// If `a` is `true` then `b` must be `true` too. If `a` is `false` then we
    /// don't care about `b` and return `true`.
    ///
    /// The above statement is expressed as the following truth table:
    ///
    /// | a | b | OUT |
    /// |---|---|-----|
    /// | 1 | 1 |  1  |
    /// | 1 | 0 |  0  |
    /// | 0 | 1 |  1  |
    /// | 0 | 0 |  1  |
    #[inline(always)]
    #[must_use]
    pub(crate) const fn a_implies_b(a: bool, b: bool) -> bool {
        !a || b
    }

    /// Returns `true` if both `a` and `b` are `true` or if both are `false`.
    ///
    /// The above statement is expressed as the following truth table:
    ///
    /// | a | b | OUT |
    /// |---|---|-----|
    /// | 1 | 1 |  1  |
    /// | 1 | 0 |  0  |
    /// | 0 | 1 |  0  |
    /// | 0 | 0 |  1  |
    #[inline(always)]
    #[must_use]
    pub(crate) const fn both_or_neither(a: bool, b: bool) -> bool {
        !(a ^ b)
    }
}

pub mod fmt {
    use core::fmt;

    /// Count how many characters are written instead of actually writting them.
    #[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
    pub(crate) struct Counter {
        count: usize,
    }

    impl Counter {
        pub const fn new() -> Self {
            Self { count: 0 }
        }

        pub const fn count(&self) -> usize {
            self.count
        }
    }

    impl fmt::Write for Counter {
        #[inline]
        fn write_str(&mut self, s: &str) -> fmt::Result {
            self.count += s.len();
            Ok(())
        }
    }

    /*
    struct Buffer<'data> {
        data: &'data mut [u8],
        pos: usize,
    }
    impl fmt::Write for Buffer<'_> {
        fn write_str(&mut self, s: &str) -> fmt::Result {
            // TODO: test this implementation actually works.

            if self.pos + s.len() > self.data.len() {
                return Err(fmt::Error);
            }

            self.data[self.pos..].copy_from_slice(s.as_bytes());
            self.pos += s.len();

            Ok(())
        }
    }

    fn test<T: fmt::Display>(a: &super::OperandDisplay<T>, buf: &mut Buffer) -> fmt::Result {
        write!(buf, "{}", a)
    }
    */

    #[cfg(test)]
    mod tests {
        use super::*;

        use core::fmt::Write;

        #[test]
        fn test_fmt_counter() {
            let mut counter = Counter::new();
            let stuff = "stuff";

            write!(&mut counter, "{}", stuff).unwrap();

            assert_eq!(stuff.len(), counter.count(),);
        }
    }
}