u_num_it/
lib.rs

1extern crate proc_macro;
2
3use std::{collections::HashMap, str::FromStr};
4
5use proc_macro2::{Literal, Span, TokenStream, TokenTree};
6
7use quote::{quote, ToTokens};
8use syn::{
9    parse::Parse, parse_macro_input, spanned::Spanned, Expr, ExprMatch, Ident, Pat, PatRange,
10    RangeLimits, Token,
11};
12
13#[derive(Hash, PartialEq, Eq, Debug, Clone, Copy)]
14enum UType {
15    N,
16    P,
17    U,
18    False,
19    None,
20    Literal(isize),
21}
22
23impl std::fmt::Display for UType {
24    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
25        match self {
26            UType::N => write!(f, "N"),
27            UType::P => write!(f, "P"),
28            UType::U => write!(f, "U"),
29            UType::False => write!(f, "False"),
30            UType::None => write!(f, ""),
31            UType::Literal(_) => write!(f, ""),
32        }
33    }
34}
35
36struct UNumIt {
37    range: Vec<isize>,
38    arms: HashMap<UType, Box<Expr>>,
39    expr: Box<Expr>,
40}
41
42fn range_boundary(val: &Option<Box<Expr>>) -> syn::Result<Option<isize>> {
43    if let Some(val) = val.clone() {
44        let string = val.to_token_stream().to_string().replace(' ', "");
45        let value = string
46            .parse::<isize>()
47            .map_err(|e| syn::Error::new(val.span(), format!("{e}: `{string}`").as_str()))?;
48
49        Ok(Some(value))
50    } else {
51        Ok(None)
52    }
53}
54
55impl Parse for UNumIt {
56    fn parse(input: syn::parse::ParseStream) -> syn::Result<Self> {
57        let range: PatRange = input.parse()?;
58
59        let start = range_boundary(&range.start)?.unwrap_or(0);
60        let end = range_boundary(&range.end)?.unwrap_or(isize::MAX);
61
62        let range = match &range.limits {
63            RangeLimits::HalfOpen(_) => (start..end).collect(),
64            RangeLimits::Closed(_) => (start..=end).collect(),
65        };
66
67        input.parse::<Token![,]>()?;
68        let matcher: ExprMatch = input.parse()?;
69
70        let mut arms = HashMap::new();
71
72        for arm in matcher.arms.iter() {
73            let u_type = match &arm.pat {
74                Pat::Ident(t) => match t.ident.to_token_stream().to_string().as_str() {
75                    "N" => UType::N,
76                    "P" => UType::P,
77                    "U" => UType::U,
78                    "False" => UType::False,
79                    _ => {
80                        return Err(syn::Error::new(
81                            t.span(),
82                            "exepected idents N | P | U, False or _",
83                        ))
84                    }
85                },
86                Pat::Lit(lit_expr) => {
87                    // Parse literal numbers in match arms
88                    let lit_str = lit_expr.to_token_stream().to_string();
89                    let value = lit_str.parse::<isize>().map_err(|e| {
90                        syn::Error::new(lit_expr.span(), format!("invalid literal: {e}"))
91                    })?;
92                    UType::Literal(value)
93                }
94                Pat::Wild(_) => UType::None,
95                _ => return Err(syn::Error::new(arm.pat.span(), "exepected ident")),
96            };
97            let arm_expr = arm.body.clone();
98            if arms.insert(u_type, arm_expr.clone()).is_some() {
99                return Err(syn::Error::new(arm_expr.span(), "duplicate type"));
100            }
101        }
102
103        if arms.get(&UType::P).and(arms.get(&UType::U)).is_some() {
104            return Err(syn::Error::new(
105                matcher.span(),
106                "ambiguous type, don't use P and U in the same macro call",
107            ));
108        }
109
110        // Check for conflict between literal 0 and False (they represent the same value in typenum)
111        if arms.get(&UType::Literal(0)).and(arms.get(&UType::False)).is_some() {
112            return Err(syn::Error::new(
113                matcher.span(),
114                "ambiguous type, don't use literal 0 and False in the same macro call (they represent the same value)",
115            ));
116        }
117
118        let expr = matcher.expr;
119
120        Ok(UNumIt { range, arms, expr })
121    }
122}
123
124fn make_match_arm(i: &isize, body: &Expr, u_type: UType) -> TokenStream {
125    let match_expr = TokenTree::Literal(Literal::from_str(i.to_string().as_str()).unwrap());
126    
127    // Determine the typenum type for all cases
128    let i_str = if *i != 0 {
129        i.abs().to_string()
130    } else {
131        Default::default()
132    };
133    
134    // Determine the type variant based on UType
135    let u_type_for_typenum = match u_type {
136        UType::Literal(val) if val == 0 => UType::False,
137        UType::Literal(val) if val < 0 => UType::N,
138        UType::Literal(val) if val > 0 => UType::P,
139        _ => u_type,
140    };
141    
142    let typenum_type = TokenTree::Ident(Ident::new(
143        format!("{}{}", u_type_for_typenum, i_str).as_str(),
144        Span::mixed_site(),
145    ));
146    let type_variant = quote!(typenum::consts::#typenum_type);
147    
148    // All match arms get NumType and use body as-is (no pattern replacement)
149    let body_tokens = body.to_token_stream();
150    
151    quote! {
152        #match_expr => {
153            type NumType = #type_variant;
154            #body_tokens
155        },
156    }
157}
158
159/// matches `typenum::consts` in a given range
160///
161/// use with an open or closed range
162///
163/// use `P` | `N` | `U` | `False` | `_` or literals `1` | `-1` as match arms
164///
165/// a `NumType` type alias is available in each match arm,
166/// resolving to the specific typenum type for that value.
167/// Use `NumType` to reference the resolved type in the match arm body.
168///
169/// ## Example
170///
171/// ```
172/// let x = 3;
173///
174/// u_num_it::u_num_it!(1..10, match x {
175///     U => {
176///         // NumType is typenum::consts::U3 when x=3
177///         let val = NumType::new();
178///         println!("{:?}", val);
179///         // UInt { msb: UInt { msb: UTerm, lsb: B1 }, lsb: B1 }
180///         
181///         use typenum::ToInt;
182///         let num: usize = NumType::to_int();
183///         assert_eq!(num, 3);
184///     }
185/// })
186/// ```
187#[proc_macro]
188pub fn u_num_it(tokens: proc_macro::TokenStream) -> proc_macro::TokenStream {
189    let UNumIt { range, arms, expr } = parse_macro_input!(tokens as UNumIt);
190
191    let pos_u = arms.get(&UType::U).is_some();
192
193    let expanded_arms = range.iter().filter_map(|i| {
194        // First check if there's a specific literal match for this number
195        if let Some(body) = arms.get(&UType::Literal(*i)) {
196            return Some(make_match_arm(i, body, UType::Literal(*i)));
197        }
198        
199        // Otherwise, use the general type patterns
200        match i {
201            0 => arms
202                .get(&UType::False)
203                .map(|body| make_match_arm(i, body, UType::False)),
204            i if *i < 0 => arms
205                .get(&UType::N)
206                .map(|body| make_match_arm(i, body, UType::N)),
207            i if *i > 0 => {
208                if pos_u {
209                    arms.get(&UType::U)
210                        .map(|body| make_match_arm(i, body, UType::U))
211                } else {
212                    arms.get(&UType::P)
213                        .map(|body| make_match_arm(i, body, UType::P))
214                }
215            }
216            _ => unreachable!(),
217        }
218    });
219
220    let fallback = arms
221        .get(&UType::None)
222        .map(|body| {
223            quote! {
224                _ => {
225                    #body
226                }
227            }
228        })
229        .unwrap_or_else(|| {
230            let first = range.first().unwrap_or(&0);
231            let last = range.last().unwrap_or(&0);
232            quote! {
233                i => unreachable!("{i} is not in range {}-{:?}", #first, #last)
234            }
235        });
236
237    let expanded = quote! {
238        match #expr {
239            #(#expanded_arms)*
240            #fallback
241        }
242    };
243
244    proc_macro::TokenStream::from(expanded)
245}