typenum-consts 0.1.1

Procedural macros that take a literal integer (or the result of an evaluation of simple mathematical expressions or an environment variable whose value is a literal integer) and convert it to a `typenum::Unsigned` / `typenum::Integer` type-level positive/negative/unsigned integer.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119

use crate::macros::debug_eprintln;
use proc_macro2::TokenStream as TokenStream2;
use quote::{format_ident, quote};
use syn::{Error, LitInt, Result};

// Literally, copied from `typenum`.
const HIGHEST: u64 = 1024;
fn uints() -> impl Iterator<Item = u64> {
    // Use hardcoded values to avoid issues with cross-compilation.
    // See https://github.com/paholg/typenum/issues/162
    let first2: u32 = 11; // (highest as f64).log(2.0).round() as u32 + 1;
    let first10: u32 = 4; // (highest as f64).log(10.0) as u32 + 1;
    (0..(HIGHEST + 1))
        .chain((first2..64).map(|i| 2u64.pow(i)))
        .chain((first10..20).map(|i| 10u64.pow(i)))
}

fn digits_to_uint(digits: &str) -> Result<proc_macro2::TokenStream> {
    let mut token_stream = quote!(::typenum::consts::U0);

    for (expo, d) in digits.chars().rev().enumerate() {
        debug_eprintln!("`expo` = {expo}; `d` = {d}");
        let d_uint_ident = format_ident!("U{}", d);
        let expo_uint_ident = format_ident!("U{}", expo);
        token_stream = quote! {
            ::typenum::Sum::<
                ::typenum::Prod<
                    ::typenum::Exp::<
                        ::typenum::consts::U10,
                        ::typenum::consts::#expo_uint_ident
                        >,
                        ::typenum::consts::#d_uint_ident
                    >,
                #token_stream
            >
        };
        debug_eprintln!("`token_stream` = {token_stream}");
    }

    Ok(token_stream)
}

fn can_represent_as_u32_or_u64(digits: &str) -> Result<bool> {
    #[cfg(target_pointer_width = "32")]
    let (num_digit, usize_max_as_str): (usize, &str) = (10, "4294967295");

    #[cfg(target_pointer_width = "64")]
    let (num_digit, usize_max_as_str): (usize, &str) = (20, "18446744073709551615");

    if digits.is_empty() {
        return Ok(false);
    }

    for ch in digits.chars() {
        if !ch.is_ascii_digit() {
            return Ok(false);
        }
    }

    if digits.len() > num_digit && digits[..digits.len() - num_digit].chars().any(|c| c != '0') {
        return Ok(false);
    }

    if digits.len() == num_digit {
        debug_eprintln!("`if digits.len() == num_digit`: {digits}");
        return Ok(digits <= usize_max_as_str);
    }

    Ok(true)
}

pub(crate) fn uconst_impl(litint: LitInt) -> Result<TokenStream2> {
    debug_eprintln!("`litint` = {litint}");

    if !can_represent_as_u32_or_u64(litint.base10_digits())? {
        return Err(Error::new(litint.span(), format!("the integer literal = `{litint:?}` passed into `uconst` is too large to be represented by {} bits", usize::BITS).as_str()));
    }

    let litint_u32_or_u64 = litint.base10_parse::<usize>()?;
    if uints().any(|uint| uint as usize == litint_u32_or_u64) {
        let ident = format_ident!("U{litint_u32_or_u64}");
        return Ok(quote!(::typenum::consts::#ident));
    }
    let ts = digits_to_uint(&format!("{}", litint_u32_or_u64))?;
    Ok(quote!(#ts))
}

#[cfg(test)]
mod tests {

    use super::*;

    #[test]
    fn test_can_represent_as_u32_or_u64() {
        assert!(can_represent_as_u32_or_u64("123").unwrap());
        assert!(can_represent_as_u32_or_u64("4294967295").unwrap());
        assert!(can_represent_as_u32_or_u64("0").unwrap());
        assert!(can_represent_as_u32_or_u64("1").unwrap());
        assert!(can_represent_as_u32_or_u64("9999999999").unwrap());
        assert!(can_represent_as_u32_or_u64("0123").unwrap()); // Leading zeros
        assert!(can_represent_as_u32_or_u64("000").unwrap());
        assert!(can_represent_as_u32_or_u64("0000000000001234").unwrap()); // Leading zeros

        assert!(!can_represent_as_u32_or_u64("").unwrap());
        assert!(!can_represent_as_u32_or_u64("abc").unwrap());

        #[cfg(target_pointer_width = "32")]
        assert!(!can_represent_as_u32_or_u64("4294967296").unwrap());
        #[cfg(target_pointer_width = "32")]
        assert!(!can_represent_as_u32_or_u64("10000000000").unwrap()); // Exceeds u32::MAX
        #[cfg(target_pointer_width = "32")]
        assert!(!can_represent_as_u32_or_u64("100000000000").unwrap()); // Exceeds u32::MAX

        #[cfg(target_pointer_width = "64")]
        assert!(can_represent_as_u32_or_u64("18446744073709551615").unwrap()); // u64::MAX
        #[cfg(target_pointer_width = "64")]
        assert!(!can_represent_as_u32_or_u64("18446744073709551616").unwrap()); // Exceeds u64::MAX
    }
}