mathhook-macros 0.2.0

Procedural macros for MathHook - expr!, symbol!, symbols!, function!
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
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
//! Token preprocessing for expr!() macro with mathematical operator precedence
//!
//! Implements a Pratt parser at the token level to handle mathematical precedence:
//! - `^` (power) - highest precedence, right-associative
//! - `*`, `/` - middle precedence, left-associative
//! - `+`, `-` - lowest precedence, left-associative
//!
//! This allows users to write `expr!(2*x^2 + 4*x + 6)` naturally.

use proc_macro2::{Delimiter, Group, Punct, Spacing, TokenStream, TokenTree};
use quote::quote;

/// Operator precedence levels (higher = binds tighter)
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
enum Precedence {
    Lowest = 0,
    Comparison = 1, // ==, <, >, <=, >=
    Sum = 2,        // +, -
    Product = 3,    // *, /
    Power = 4,      // ^, **
    Unary = 5,      // -, !
}

/// Associativity of operators
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
enum Associativity {
    Left,
    Right,
}

/// Parse result containing tokens and next position
struct ParseResult {
    tokens: TokenStream,
    next_pos: usize,
}

/// Token-level Pratt parser for mathematical expressions
pub struct MathPrecedenceParser;

impl MathPrecedenceParser {
    /// Parse tokens with mathematical precedence and return properly parenthesized stream
    pub fn parse(input: TokenStream) -> TokenStream {
        let tokens: Vec<TokenTree> = input.into_iter().collect();
        if tokens.is_empty() {
            return TokenStream::new();
        }

        // First, convert ** to ^ for uniform handling
        let tokens = Self::normalize_power_operator(&tokens);

        // Then apply mathematical precedence via Pratt parsing
        let result = Self::parse_expression(&tokens, 0);
        result.tokens
    }

    /// Convert ** sequences to ^ tokens for uniform handling
    fn normalize_power_operator(tokens: &[TokenTree]) -> Vec<TokenTree> {
        let mut result = Vec::new();
        let mut i = 0;

        while i < tokens.len() {
            // Check for ** sequence
            if i + 1 < tokens.len() {
                if let (TokenTree::Punct(p1), TokenTree::Punct(p2)) = (&tokens[i], &tokens[i + 1]) {
                    if p1.as_char() == '*' && p2.as_char() == '*' {
                        // Replace ** with ^
                        result.push(TokenTree::Punct(Punct::new('^', Spacing::Alone)));
                        i += 2;
                        continue;
                    }
                }
            }

            // Process groups recursively
            match &tokens[i] {
                TokenTree::Group(g) => {
                    let inner =
                        Self::normalize_power_operator(&g.stream().into_iter().collect::<Vec<_>>());
                    let new_group =
                        Group::new(g.delimiter(), inner.into_iter().collect::<TokenStream>());
                    result.push(TokenTree::Group(new_group));
                }
                other => result.push(other.clone()),
            }
            i += 1;
        }

        result
    }

    /// Get precedence of a binary operator
    fn get_precedence(op: char, next_char: Option<char>) -> Option<(Precedence, Associativity)> {
        match (op, next_char) {
            ('^', _) => Some((Precedence::Power, Associativity::Right)),
            ('*', Some('*')) => Some((Precedence::Power, Associativity::Right)), // ** (shouldn't reach here after normalization)
            ('*', _) => Some((Precedence::Product, Associativity::Left)),
            ('/', _) => Some((Precedence::Product, Associativity::Left)),
            ('+', _) => Some((Precedence::Sum, Associativity::Left)),
            ('-', _) => Some((Precedence::Sum, Associativity::Left)),
            ('=', Some('=')) => Some((Precedence::Comparison, Associativity::Left)),
            ('<', Some('=')) => Some((Precedence::Comparison, Associativity::Left)),
            ('>', Some('=')) => Some((Precedence::Comparison, Associativity::Left)),
            ('<', _) => Some((Precedence::Comparison, Associativity::Left)),
            ('>', _) => Some((Precedence::Comparison, Associativity::Left)),
            _ => None,
        }
    }

    /// Check if token is a binary operator
    fn is_binary_operator(tokens: &[TokenTree], pos: usize) -> Option<(char, usize)> {
        if pos >= tokens.len() {
            return None;
        }

        if let TokenTree::Punct(p) = &tokens[pos] {
            let c = p.as_char();
            let next = tokens.get(pos + 1).and_then(|t| {
                if let TokenTree::Punct(p2) = t {
                    Some(p2.as_char())
                } else {
                    None
                }
            });

            // Check for two-char operators
            match (c, next) {
                ('=', Some('=')) | ('<', Some('=')) | ('>', Some('=')) => return Some((c, 2)),
                ('*', Some('*')) => return Some((c, 2)), // ** power operator
                _ => {}
            }

            // Single char operators
            if matches!(c, '+' | '-' | '*' | '/' | '^' | '<' | '>') {
                return Some((c, 1));
            }
        }

        None
    }

    /// Parse expression with Pratt parsing
    fn parse_expression(tokens: &[TokenTree], start: usize) -> ParseResult {
        Self::parse_precedence(tokens, start, Precedence::Lowest)
    }

    /// Core Pratt parsing algorithm
    ///
    /// The key insight for Pratt parsing:
    /// - For left-associative operators: break when `prec <= min_prec`
    /// - For right-associative operators: break when `prec < min_prec`
    /// - Recursive calls use the operator's precedence as the new min_prec
    fn parse_precedence(tokens: &[TokenTree], start: usize, min_prec: Precedence) -> ParseResult {
        if start >= tokens.len() {
            return ParseResult {
                tokens: TokenStream::new(),
                next_pos: start,
            };
        }

        // Parse prefix/atom
        let mut result = Self::parse_prefix(tokens, start);
        let mut pos = result.next_pos;

        // Parse infix operators
        loop {
            if pos >= tokens.len() {
                break;
            }

            // Check for binary operator
            let op_info = Self::is_binary_operator(tokens, pos);
            if op_info.is_none() {
                break;
            }

            let (op_char, op_len) = op_info.unwrap();
            let next_char = if op_len == 2 {
                tokens.get(pos + 1).and_then(|t| {
                    if let TokenTree::Punct(p) = t {
                        Some(p.as_char())
                    } else {
                        None
                    }
                })
            } else {
                None
            };

            let prec_info = Self::get_precedence(op_char, next_char);
            if prec_info.is_none() {
                break;
            }

            let (prec, assoc) = prec_info.unwrap();

            // Standard Pratt parsing break conditions:
            // - Left-associative: break when prec <= min_prec (only consume higher precedence)
            // - Right-associative: break when prec < min_prec (consume same or higher precedence)
            let should_break = match assoc {
                Associativity::Left => prec <= min_prec,
                Associativity::Right => prec < min_prec,
            };
            if should_break {
                break;
            }

            // Consume the operator
            let op_tokens: Vec<TokenTree> = tokens[pos..pos + op_len].to_vec();
            pos += op_len;

            // Parse right side with the operator's precedence as the new minimum
            // This ensures operators at the same level get proper associativity handling
            let right = Self::parse_precedence(tokens, pos, prec);
            pos = right.next_pos;

            // Handle power operator specially - wrap in parentheses to ensure correct precedence
            if op_char == '^' || (op_char == '*' && next_char == Some('*')) {
                // For power: convert to .pow() method call for correct precedence
                let left = result.tokens;
                let right_tokens = right.tokens;
                result.tokens = quote! { (#left).pow(#right_tokens) };
            } else {
                // For other operators, just combine with the operator
                let left = result.tokens;
                let right_tokens = right.tokens;
                let op_stream: TokenStream = op_tokens.into_iter().collect();
                result.tokens = quote! { (#left) #op_stream (#right_tokens) };
            }
        }

        ParseResult {
            tokens: result.tokens,
            next_pos: pos,
        }
    }

    /// Parse prefix expression (unary ops, atoms)
    fn parse_prefix(tokens: &[TokenTree], start: usize) -> ParseResult {
        if start >= tokens.len() {
            return ParseResult {
                tokens: TokenStream::new(),
                next_pos: start,
            };
        }

        match &tokens[start] {
            // Unary minus
            TokenTree::Punct(p) if p.as_char() == '-' => {
                let inner = Self::parse_precedence(tokens, start + 1, Precedence::Unary);
                let inner_tokens = inner.tokens;
                ParseResult {
                    tokens: quote! { -(#inner_tokens) },
                    next_pos: inner.next_pos,
                }
            }

            // Parenthesized expression
            TokenTree::Group(g) if g.delimiter() == Delimiter::Parenthesis => {
                let inner_tokens: Vec<TokenTree> = g.stream().into_iter().collect();

                // Check if this is a function call (next token would be more parens)
                // For now, just parse the inner expression with precedence
                let inner_result = Self::parse_expression(&inner_tokens, 0);

                // Check for method call after the parentheses
                let mut result_tokens = inner_result.tokens;
                let mut pos = start + 1;

                // Handle chained method calls and operators
                while pos < tokens.len() {
                    if let TokenTree::Punct(p) = &tokens[pos] {
                        if p.as_char() == '.' {
                            // Method call
                            let method_result =
                                Self::parse_method_chain(tokens, pos, result_tokens);
                            result_tokens = method_result.tokens;
                            pos = method_result.next_pos;
                            continue;
                        }
                    }
                    break;
                }

                ParseResult {
                    tokens: quote! { (#result_tokens) },
                    next_pos: pos,
                }
            }

            // Identifier (variable or function call)
            TokenTree::Ident(_ident) => {
                let mut pos = start + 1;
                let ident_stream: TokenStream = std::iter::once(tokens[start].clone()).collect();

                // Check for function call
                if pos < tokens.len() {
                    if let TokenTree::Group(g) = &tokens[pos] {
                        if g.delimiter() == Delimiter::Parenthesis {
                            // Function call - process arguments
                            let args = Self::parse_function_args(g);
                            pos += 1;

                            // Check for method calls after function
                            let mut result = quote! { #ident_stream(#args) };

                            while pos < tokens.len() {
                                if let TokenTree::Punct(p) = &tokens[pos] {
                                    if p.as_char() == '.' {
                                        let method_result =
                                            Self::parse_method_chain(tokens, pos, result);
                                        result = method_result.tokens;
                                        pos = method_result.next_pos;
                                        continue;
                                    }
                                }
                                break;
                            }

                            return ParseResult {
                                tokens: result,
                                next_pos: pos,
                            };
                        }
                    }
                }

                // Check for method call on identifier
                let mut result = ident_stream;
                while pos < tokens.len() {
                    if let TokenTree::Punct(p) = &tokens[pos] {
                        if p.as_char() == '.' {
                            let method_result = Self::parse_method_chain(tokens, pos, result);
                            result = method_result.tokens;
                            pos = method_result.next_pos;
                            continue;
                        }
                    }
                    break;
                }

                ParseResult {
                    tokens: result,
                    next_pos: pos,
                }
            }

            // Literal (number)
            TokenTree::Literal(_lit) => {
                let lit_stream: TokenStream = std::iter::once(tokens[start].clone()).collect();
                let mut pos = start + 1;

                // Check for method call on literal
                let mut result = lit_stream;
                while pos < tokens.len() {
                    if let TokenTree::Punct(p) = &tokens[pos] {
                        if p.as_char() == '.' {
                            // Check if it's a float continuation or method call
                            if pos + 1 < tokens.len() {
                                if let TokenTree::Ident(_) = &tokens[pos + 1] {
                                    let method_result =
                                        Self::parse_method_chain(tokens, pos, result);
                                    result = method_result.tokens;
                                    pos = method_result.next_pos;
                                    continue;
                                }
                            }
                        }
                    }
                    break;
                }

                ParseResult {
                    tokens: result,
                    next_pos: pos,
                }
            }

            // Other punctuation that might start an expression
            other => ParseResult {
                tokens: std::iter::once(other.clone()).collect(),
                next_pos: start + 1,
            },
        }
    }

    /// Parse method chain (e.g., .pow(2), .abs(), .sqrt())
    fn parse_method_chain(
        tokens: &[TokenTree],
        start: usize,
        receiver: TokenStream,
    ) -> ParseResult {
        let mut pos = start;
        let mut result = receiver;

        while pos < tokens.len() {
            // Expect .
            if let TokenTree::Punct(p) = &tokens[pos] {
                if p.as_char() != '.' {
                    break;
                }
                pos += 1;
            } else {
                break;
            }

            // Expect method name
            if pos >= tokens.len() {
                break;
            }
            let method_name = if let TokenTree::Ident(ident) = &tokens[pos] {
                ident.clone()
            } else {
                break;
            };
            pos += 1;

            // Expect arguments (possibly empty)
            if pos < tokens.len() {
                if let TokenTree::Group(g) = &tokens[pos] {
                    if g.delimiter() == Delimiter::Parenthesis {
                        let args = Self::parse_function_args(g);
                        pos += 1;
                        result = quote! { (#result).#method_name(#args) };
                        continue;
                    }
                }
            }

            // Method with no arguments
            result = quote! { (#result).#method_name() };
        }

        ParseResult {
            tokens: result,
            next_pos: pos,
        }
    }

    /// Parse function arguments, applying precedence to each
    fn parse_function_args(group: &Group) -> TokenStream {
        let inner: Vec<TokenTree> = group.stream().into_iter().collect();
        if inner.is_empty() {
            return TokenStream::new();
        }

        // Split by commas and process each argument
        let mut args = Vec::new();
        let mut current_arg = Vec::new();

        for token in inner {
            if let TokenTree::Punct(p) = &token {
                if p.as_char() == ',' {
                    if !current_arg.is_empty() {
                        let arg_result = Self::parse_expression(&current_arg, 0);
                        args.push(arg_result.tokens);
                        current_arg.clear();
                    }
                    continue;
                }
            }
            current_arg.push(token);
        }

        // Don't forget the last argument
        if !current_arg.is_empty() {
            let arg_result = Self::parse_expression(&current_arg, 0);
            args.push(arg_result.tokens);
        }

        // Join with commas
        let mut result = TokenStream::new();
        for (i, arg) in args.into_iter().enumerate() {
            if i > 0 {
                result.extend(quote! { , });
            }
            result.extend(arg);
        }

        result
    }
}

/// Preprocess token stream to handle special operator sequences
///
/// This is the legacy API - delegates to MathPrecedenceParser
#[allow(dead_code)]
pub struct TokenPreprocessor;

#[allow(dead_code)]
impl TokenPreprocessor {
    /// Preprocess input tokens before syn parsing
    pub fn preprocess(input: TokenStream) -> TokenStream {
        MathPrecedenceParser::parse(input)
    }
}

/// Custom syn parser that handles mathematical precedence
pub struct PowerOperatorParser;

impl PowerOperatorParser {
    /// Parse expression with mathematical operator precedence support
    pub fn parse_with_power(input: proc_macro::TokenStream) -> syn::Result<syn::Expr> {
        let token_stream: TokenStream = input.into();
        let preprocessed = MathPrecedenceParser::parse(token_stream);
        syn::parse2(preprocessed)
    }
}

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

    fn parse_to_string(input: &str) -> String {
        let tokens: TokenStream = input.parse().unwrap();
        let result = MathPrecedenceParser::parse(tokens);
        result.to_string()
    }

    #[test]
    fn test_simple_power() {
        let result = parse_to_string("x ^ 2");
        assert!(result.contains("pow"), "Expected pow in: {}", result);
    }

    #[test]
    fn test_mul_before_power() {
        let result = parse_to_string("2 * x ^ 2");
        // Should be 2 * (x^2), not (2*x)^2
        // The result should have pow applied to x, then multiplied by 2
        assert!(result.contains("pow"), "Expected pow in: {}", result);
    }

    #[test]
    fn test_double_star_power() {
        let result = parse_to_string("x ** 2");
        assert!(result.contains("pow"), "Expected pow in: {}", result);
    }

    #[test]
    fn test_addition() {
        let result = parse_to_string("x + y");
        assert!(result.contains("+"), "Expected + in: {}", result);
    }

    #[test]
    fn test_complex_expression() {
        let result = parse_to_string("2 * x ^ 2 + 4 * x + 6");
        assert!(result.contains("pow"), "Expected pow in: {}", result);
        assert!(result.contains("+"), "Expected + in: {}", result);
    }

    #[test]
    fn test_addition_multiplication_debug() {
        let result = parse_to_string("2 * x + 3 * y");
        println!("DEBUG: 2 * x + 3 * y => {}", result);
        assert!(result.contains("+"), "Expected + in: {}", result);
    }

    #[test]
    fn test_comparison_debug() {
        let result = parse_to_string("x + 1 == y + 2");
        println!("DEBUG: x + 1 == y + 2 => {}", result);
        assert!(result.contains("=="), "Expected == in: {}", result);
    }

    #[test]
    fn test_power_chain_debug() {
        let result = parse_to_string("2 ^ 3 ^ 4");
        println!("DEBUG: 2 ^ 3 ^ 4 => {}", result);
        // For right-associative, should be: 2 ^ (3 ^ 4)
        // Which means: (2) .pow ((3) .pow (4))
    }
}