truecalc-core 5.0.2

Formula engine with exact Google Sheets semantics — stateless, embeddable evaluator
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
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
pub mod ast;
pub mod refs;
pub mod tokens;

pub use ast::{Expr, Span};
pub use refs::{CellAddr, Ref};
use ast::{BinaryOp, UnaryOp};
use crate::types::ParseError;
use nom::{IResult, character::complete::multispace0};
use tokens::{bool_literal, dollar_cell_ref, identifier, number_literal, offset, string_literal};

/// A cell-address token: `dollar_cell_ref()`'s `$`-bearing shape (`$A1`,
/// `A$1`, `$A$1`), or — when no literal `$` is present — `identifier()`'s
/// plain shape (`A1`). `dollar_cell_ref` must be tried first: `identifier`
/// does not fail on input like `"A$1"`, it just stops early at `A` and
/// succeeds, so trying it first would never give `dollar_cell_ref` a chance
/// to claim the `$1` suffix. Used wherever a range endpoint is expected, so
/// either corner of a range may independently carry `$` anchors (e.g.
/// `A1:$D$4`).
fn cell_ref_text(i: &str) -> IResult<&str, &str> {
    dollar_cell_ref(i).or_else(|_| identifier(i))
}

struct Parser<'a> {
    full: &'a str,
}

impl<'a> Parser<'a> {
    fn new(full: &'a str) -> Self {
        Self { full }
    }

    fn span(&self, before: &str, after: &str) -> Span {
        let start = offset(self.full, before);
        let end = offset(self.full, after);
        Span::new(start, end - start)
    }

    // ── primary ────────────────────────────────────────────────────────────

    fn parse_primary(&self, i: &'a str) -> IResult<&'a str, Expr> {
        let i = multispace0(i)?.0;

        // Number literal (must come before identifier to catch e.g. "1e3")
        if let Ok((rest, n)) = number_literal(i) {
            return Ok((rest, Expr::Number(n, self.span(i, rest))));
        }

        // String literal
        if let Ok((rest, text)) = string_literal(i) {
            return Ok((rest, Expr::Text(text, self.span(i, rest))));
        }

        // Array literal: {expr, expr, ...}
        if let Some(inner) = i.strip_prefix('{') {
            let (rest, elems) = self.parse_array_elements(inner)?;
            let rest = multispace0(rest)?.0;
            if let Some(after) = rest.strip_prefix('}') {
                return Ok((after, Expr::Array(elems, self.span(i, after))));
            }
            return Err(nom::Err::Error(nom::error::Error::new(
                rest,
                nom::error::ErrorKind::Char,
            )));
        }

        // Parenthesised expression
        if let Some(inner) = i.strip_prefix('(') {
            // Trim whitespace after '(' so a padded grouping like `( A1 + B1 )`
            // does not leak the leading space into the inner expression's span
            // (issue #751 — same class as #746/#748/#749, which also trim before
            // parse_comparison; the trailing side is already trimmed below).
            let inner = multispace0(inner)?.0;
            let (rest, expr) = self.parse_comparison(inner)?;
            let rest = multispace0(rest)?.0;
            if let Some(after) = rest.strip_prefix(')') {
                return Ok((after, expr));
            }
            return Err(nom::Err::Error(nom::error::Error::new(
                rest,
                nom::error::ErrorKind::Char,
            )));
        }

        // Boolean (before identifier — uses word-boundary check in bool_literal)
        if let Ok((rest, b)) = bool_literal(i) {
            return Ok((rest, Expr::Bool(b, self.span(i, rest))));
        }

        // Quoted-sheet reference: 'Sheet Name'!A1 / 'Sheet Name'!A1:B2
        if i.starts_with('\'') {
            return self.parse_quoted_sheet_ref(i);
        }

        // $-anchored cell reference (bare, no sheet): $A$1, $A1, A$1. A
        // '$'-bearing token can only ever be a cell/range reference (never a
        // sheet name, function call, or plain variable — none of those can
        // contain '$'), so it short-circuits straight to Expr::Variable,
        // mirroring how plain `A1` becomes Expr::Variable("A1", ..) below.
        if let Ok((rest, span)) = dollar_cell_ref(i) {
            let rest_ws = multispace0(rest)?.0;
            if let Some(after_colon) = rest_ws.strip_prefix(':') {
                if let Ok((rest2, end_span)) = cell_ref_text(after_colon) {
                    if CellAddr::parse(end_span).is_some() {
                        let range_name = format!("{}:{}", span, end_span);
                        return Ok((rest2, Expr::Variable(range_name, self.span(i, rest2))));
                    }
                }
            }
            return Ok((rest, Expr::Variable(span.to_string(), self.span(i, rest))));
        }

        // Identifier: sheet-qualified reference, variable, or function call
        if let Ok((rest, name)) = identifier(i) {
            // Sheet-qualified reference: Sheet1!A1 / Sheet1!A1:B2 — `!` binds
            // tightly to the sheet name (no whitespace on either side).
            if let Some(after_bang) = rest.strip_prefix('!') {
                return self.parse_ref_body(i, name.to_string(), after_bang);
            }
            let rest_ws = multispace0(rest)?.0;
            if let Some(args_input) = rest_ws.strip_prefix('(') {
                // Function call
                let (rest2, args) = self.parse_arg_list(args_input)?;
                let rest2 = multispace0(rest2)?.0;
                if let Some(after_close) = rest2.strip_prefix(')') {
                    let func_expr = Expr::FunctionCall {
                        name: name.to_uppercase(),
                        args,
                        span: self.span(i, after_close),
                    };
                    // Detect immediately-invoked call: FUNC(lambda_args)(call_args)
                    let after_ws = multispace0(after_close)?.0;
                    if let Some(call_input) = after_ws.strip_prefix('(') {
                        let (rest3, call_args) = self.parse_arg_list(call_input)?;
                        let rest3 = multispace0(rest3)?.0;
                        if let Some(after) = rest3.strip_prefix(')') {
                            return Ok((after, Expr::Apply {
                                func: Box::new(func_expr),
                                call_args,
                                span: self.span(i, after),
                            }));
                        }
                        return Err(nom::Err::Error(nom::error::Error::new(
                            rest3,
                            nom::error::ErrorKind::Char,
                        )));
                    }
                    return Ok((after_close, func_expr));
                }
                return Err(nom::Err::Error(nom::error::Error::new(
                    rest2,
                    nom::error::ErrorKind::Char,
                )));
            }
            // Range reference: A1:D4 (end corner may itself be $-anchored,
            // e.g. A1:$D$4 — validated via the same CellAddr::parse used
            // for the dollar-led branch above, so both paths agree on shape).
            if CellAddr::parse(name).is_some() {
                if let Some(after_colon) = rest_ws.strip_prefix(':') {
                    if let Ok((rest2, name2)) = cell_ref_text(after_colon) {
                        if CellAddr::parse(name2).is_some() {
                            let range_name = format!("{}:{}", name, name2);
                            return Ok((rest2, Expr::Variable(range_name, self.span(i, rest2))));
                        }
                    }
                }
            }
            return Ok((rest, Expr::Variable(name.to_string(), self.span(i, rest))));
        }

        Err(nom::Err::Error(nom::error::Error::new(i, nom::error::ErrorKind::Alt)))
    }

    // ── sheet-qualified references ──────────────────────────────────────

    /// Parse the part after `!`: a cell address, optionally `:cell` for a
    /// range. `start` is where the whole reference began (for spans); `sheet`
    /// is the unescaped sheet name.
    fn parse_ref_body(&self, start: &'a str, sheet: String, i: &'a str) -> IResult<&'a str, Expr> {
        let err = || nom::Err::Error(nom::error::Error::new(i, nom::error::ErrorKind::Tag));
        let (rest, cell_text) = cell_ref_text(i).map_err(|_| err())?;
        let addr = CellAddr::parse(cell_text).ok_or_else(err)?;
        // Optional range tail, mirroring the bare `A1:D4` grammar below.
        let rest_ws = multispace0(rest)?.0;
        if let Some(after_colon) = rest_ws.strip_prefix(':') {
            if let Ok((rest2, end_text)) = cell_ref_text(after_colon) {
                if let Some(end) = CellAddr::parse(end_text) {
                    let r = Ref::Range { sheet: Some(sheet), start: addr, end };
                    return Ok((rest2, Expr::Reference(r, self.span(start, rest2))));
                }
            }
        }
        let r = Ref::Cell { sheet: Some(sheet), addr };
        Ok((rest, Expr::Reference(r, self.span(start, rest))))
    }

    /// Parse `'Sheet Name'!A1` / `'Sheet Name'!A1:B2`. `i` starts at the
    /// opening quote. `''` inside the quotes is an escaped single quote.
    fn parse_quoted_sheet_ref(&self, i: &'a str) -> IResult<&'a str, Expr> {
        let inner = &i[1..];
        let mut sheet = String::new();
        let mut idx = 0;
        loop {
            match inner[idx..].find('\'') {
                // Unterminated quoted sheet name
                None => {
                    return Err(nom::Err::Error(nom::error::Error::new(
                        i,
                        nom::error::ErrorKind::Char,
                    )));
                }
                Some(q) => {
                    sheet.push_str(&inner[idx..idx + q]);
                    let after = idx + q + 1;
                    if inner[after..].starts_with('\'') {
                        sheet.push('\'');
                        idx = after + 1;
                    } else {
                        idx = after;
                        break;
                    }
                }
            }
        }
        let rest = &inner[idx..];
        if sheet.is_empty() {
            return Err(nom::Err::Error(nom::error::Error::new(
                i,
                nom::error::ErrorKind::Char,
            )));
        }
        match rest.strip_prefix('!') {
            Some(after_bang) => self.parse_ref_body(i, sheet, after_bang),
            None => Err(nom::Err::Error(nom::error::Error::new(
                rest,
                nom::error::ErrorKind::Char,
            ))),
        }
    }

    fn parse_arg_list(&self, i: &'a str) -> IResult<&'a str, Vec<Expr>> {
        let mut args = Vec::new();
        let mut rest = multispace0(i)?.0;

        if rest.starts_with(')') {
            return Ok((rest, args));
        }

        // Parse first argument (may be empty if it starts with comma or close paren)
        let ws = multispace0(rest)?.0;
        if ws.starts_with(',') || ws.starts_with(')') {
            // Empty first argument
            args.push(Expr::Variable(String::new(), Span::new(0, 0)));
        } else {
            let (r, first) = self.parse_comparison(rest)?;
            args.push(first);
            rest = r;
        }

        loop {
            rest = multispace0(rest)?.0;
            if let Some(after_comma) = rest.strip_prefix(',') {
                let after_ws = multispace0(after_comma)?.0;
                if after_ws.starts_with(',') || after_ws.starts_with(')') {
                    // Empty argument
                    args.push(Expr::Variable(String::new(), Span::new(0, 0)));
                    rest = after_comma;
                } else {
                    // Parse from the first non-whitespace token, not from
                    // just after the comma — a compound (BinaryOp) argument's
                    // span is measured from its entry point here, so passing
                    // the untrimmed `after_comma` would make the span start
                    // at the separating whitespace instead of the argument's
                    // own first token.
                    let (r, arg) = self.parse_comparison(after_ws)?;
                    args.push(arg);
                    rest = r;
                }
            } else {
                break;
            }
        }

        Ok((rest, args))
    }

    fn parse_array_elements(&self, i: &'a str) -> IResult<&'a str, Vec<Expr>> {
        let mut rows: Vec<Vec<Expr>> = Vec::new();
        let mut current_row: Vec<Expr> = Vec::new();
        let mut rest = multispace0(i)?.0;
        if rest.starts_with('}') {
            return Ok((rest, Vec::new())); // empty array {}
        }
        let (r, first) = self.parse_comparison(rest)?;
        current_row.push(first);
        rest = r;
        loop {
            rest = multispace0(rest)?.0;
            if let Some(after_comma) = rest.strip_prefix(',') {
                // Parse from the first non-whitespace token, not from just
                // after the comma — same leading-whitespace bug as #746's
                // function-argument fix, but here in the array-element
                // separator: passing the untrimmed `after_comma` would let a
                // compound (BinaryOp) element's span start at the separating
                // whitespace instead of the element's own first token.
                let after_ws = multispace0(after_comma)?.0;
                let (r, elem) = self.parse_comparison(after_ws)?;
                current_row.push(elem);
                rest = r;
            } else if let Some(after_semi) = rest.strip_prefix(';') {
                rows.push(std::mem::take(&mut current_row));
                // Same trim as the comma branch above, for the first element
                // of the new row.
                let after_ws = multispace0(after_semi)?.0;
                let (r, elem) = self.parse_comparison(after_ws)?;
                current_row.push(elem);
                rest = r;
            } else {
                break;
            }
        }
        rows.push(current_row);
        // If only one row (no semicolons), return flat vec
        if rows.len() == 1 {
            return Ok((rest, rows.into_iter().next().unwrap()));
        }
        // Multiple rows → wrap each row in an Array node. Each row's span
        // must cover only that row's own elements (its first element's start
        // to its last element's end) — not the whole `{…}` body, which is
        // what every row got when this span was computed once outside the
        // loop below.
        let row_exprs: Vec<Expr> = rows
            .into_iter()
            .map(|row_elems| {
                let s = match (row_elems.first(), row_elems.last()) {
                    (Some(first), Some(last)) => {
                        let start = first.span().offset;
                        let end = last.span().offset + last.span().length;
                        Span::new(start, end - start)
                    }
                    // A row is never empty in practice (each row starts with
                    // an element pushed either before the loop or right
                    // after a `;`), but fall back to the old whole-body span
                    // rather than panic if that ever changes.
                    _ => self.span(i, rest),
                };
                Expr::Array(row_elems, s)
            })
            .collect();
        Ok((rest, row_exprs))
    }

    // ── postfix % ─────────────────────────────────────────────────────────

    fn parse_postfix(&self, i: &'a str) -> IResult<&'a str, Expr> {
        let (rest, expr) = self.parse_primary(i)?;
        let rest_ws = multispace0(rest)?.0;
        if let Some(after) = rest_ws.strip_prefix('%') {
            return Ok((after, Expr::UnaryOp {
                op: UnaryOp::Percent,
                operand: Box::new(expr),
                span: self.span(i, after),
            }));
        }
        Ok((rest, expr))
    }

    // ── unary minus ───────────────────────────────────────────────────────

    fn parse_unary(&self, i: &'a str) -> IResult<&'a str, Expr> {
        let i_ws = multispace0(i)?.0;
        if let Some(after_minus) = i_ws.strip_prefix('-') {
            let (rest, operand) = self.parse_unary(after_minus)?;
            return Ok((rest, Expr::UnaryOp {
                op: UnaryOp::Neg,
                operand: Box::new(operand),
                span: self.span(i_ws, rest),
            }));
        }
        self.parse_postfix(i)
    }

    // ── power ^ (right-associative) ───────────────────────────────────────

    fn parse_power(&self, i: &'a str) -> IResult<&'a str, Expr> {
        let (rest, left) = self.parse_unary(i)?;
        let rest_ws = multispace0(rest)?.0;
        if let Some(after_op) = rest_ws.strip_prefix('^') {
            let (rest2, right) = self.parse_power(after_op)?;
            return Ok((rest2, Expr::BinaryOp {
                op: BinaryOp::Pow,
                left: Box::new(left),
                right: Box::new(right),
                span: self.span(i, rest2),
            }));
        }
        Ok((rest, left))
    }

    // ── multiplicative * / ────────────────────────────────────────────────

    fn parse_multiplicative(&self, i: &'a str) -> IResult<&'a str, Expr> {
        let (mut rest, mut left) = self.parse_power(i)?;
        loop {
            let ws = multispace0(rest)?.0;
            let op = ws.strip_prefix('*').map(|after| (BinaryOp::Mul, after))
                .or_else(|| ws.strip_prefix('/').map(|after| (BinaryOp::Div, after)));
            match op {
                None => break,
                Some((op, after)) => {
                    let (r, right) = self.parse_power(after)?;
                    left = Expr::BinaryOp {
                        op,
                        span: self.span(i, r),
                        left: Box::new(left),
                        right: Box::new(right),
                    };
                    rest = r;
                }
            }
        }
        Ok((rest, left))
    }

    // ── additive + - ──────────────────────────────────────────────────────

    fn parse_additive(&self, i: &'a str) -> IResult<&'a str, Expr> {
        let (mut rest, mut left) = self.parse_multiplicative(i)?;
        loop {
            let ws = multispace0(rest)?.0;
            let op = ws.strip_prefix('+').map(|after| (BinaryOp::Add, after))
                .or_else(|| ws.strip_prefix('-').map(|after| (BinaryOp::Sub, after)));
            match op {
                None => break,
                Some((op, after)) => {
                    let (r, right) = self.parse_multiplicative(after)?;
                    left = Expr::BinaryOp {
                        op,
                        span: self.span(i, r),
                        left: Box::new(left),
                        right: Box::new(right),
                    };
                    rest = r;
                }
            }
        }
        Ok((rest, left))
    }

    // ── concat & ─────────────────────────────────────────────────────────

    fn parse_concat(&self, i: &'a str) -> IResult<&'a str, Expr> {
        let (mut rest, mut left) = self.parse_additive(i)?;
        loop {
            let ws = multispace0(rest)?.0;
            if let Some(after) = ws.strip_prefix('&') {
                let (r, right) = self.parse_additive(after)?;
                left = Expr::BinaryOp {
                    op: BinaryOp::Concat,
                    span: self.span(i, r),
                    left: Box::new(left),
                    right: Box::new(right),
                };
                rest = r;
            } else {
                break;
            }
        }
        Ok((rest, left))
    }

    // ── comparison = <> < > <= >= ─────────────────────────────────────────

    fn parse_comparison(&self, i: &'a str) -> IResult<&'a str, Expr> {
        let (rest, left) = self.parse_concat(i)?;
        let ws = multispace0(rest)?.0;

        // Longest match first
        let op_result: Option<(BinaryOp, &'a str)> = if let Some(after) = ws.strip_prefix("<>") {
            Some((BinaryOp::Ne, after))
        } else if let Some(after) = ws.strip_prefix("<=") {
            Some((BinaryOp::Le, after))
        } else if let Some(after) = ws.strip_prefix(">=") {
            Some((BinaryOp::Ge, after))
        } else if let Some(after) = ws.strip_prefix('<') {
            Some((BinaryOp::Lt, after))
        } else if let Some(after) = ws.strip_prefix('>') {
            Some((BinaryOp::Gt, after))
        } else if let Some(after) = ws.strip_prefix('=') {
            Some((BinaryOp::Eq, after))
        } else {
            None
        };

        if let Some((op, after)) = op_result {
            let (r, right) = self.parse_concat(after)?;
            return Ok((r, Expr::BinaryOp {
                op,
                span: self.span(i, r),
                left: Box::new(left),
                right: Box::new(right),
            }));
        }

        Ok((rest, left))
    }
}

// ── public API ──────────────────────────────────────────────────────────────

/// Parse a formula string into an expression tree.
///
/// The formula must start with `=`. Returns a [`ParseError`] if the input
/// is not a valid formula.
#[deprecated(since = "0.7.0", note = "use Engine::sheets()/Engine::excel() and engine.parse() — engine flavor is required; see ADR 2026-04-27; removal target: 0.7.0 coordinated release")]
pub fn parse(formula: &str) -> Result<Expr, ParseError> {
    parse_formula(formula)
}

/// Crate-internal parser entry point used by [`crate::Engine`].
pub(crate) fn parse_formula(formula: &str) -> Result<Expr, ParseError> {
    let input = formula.strip_prefix('=').unwrap_or(formula).trim();
    let p = Parser::new(formula);
    match p.parse_comparison(input) {
        Ok((rest, expr)) => {
            let rest = rest.trim();
            if rest.is_empty() {
                Ok(expr)
            } else {
                Err(ParseError {
                    message: format!("Unexpected input '{}'", rest),
                    position: offset(formula, rest),
                })
            }
        }
        Err(nom::Err::Error(e)) | Err(nom::Err::Failure(e)) => Err(ParseError {
            message: "Parse error".into(),
            position: offset(formula, e.input),
        }),
        Err(nom::Err::Incomplete(_)) => Err(ParseError {
            message: "Incomplete input".into(),
            position: formula.len(),
        }),
    }
}

/// Validate that a formula string is syntactically correct without returning the AST.
#[deprecated(since = "0.7.0", note = "use Engine::sheets()/Engine::excel() and engine.validate() — engine flavor is required; see ADR 2026-04-27; removal target: 0.7.0 coordinated release")]
pub fn validate(formula: &str) -> Result<(), ParseError> {
    parse_formula(formula).map(|_| ())
}

#[cfg(test)]
mod tests {
    use super::*;
    use super::parse_formula as parse;
    use crate::parser::ast::{BinaryOp, Expr, UnaryOp};

    #[test]
    fn parse_number_literal() {
        let expr = parse("=42").unwrap();
        assert!(matches!(expr, Expr::Number(n, _) if n == 42.0));
    }

    #[test]
    fn parse_binary_add() {
        let expr = parse("=1+2").unwrap();
        assert!(matches!(expr, Expr::BinaryOp { op: BinaryOp::Add, .. }));
    }

    #[test]
    fn parse_precedence() {
        // 2+3*4 should parse as 2+(3*4)
        let expr = parse("=2+3*4").unwrap();
        match expr {
            Expr::BinaryOp { op: BinaryOp::Add, right, .. } => {
                assert!(matches!(*right, Expr::BinaryOp { op: BinaryOp::Mul, .. }));
            }
            _ => panic!("Expected Add at top"),
        }
    }

    #[test]
    fn parse_function_call() {
        let expr = parse("=SUM(1,2,3)").unwrap();
        match expr {
            Expr::FunctionCall { name, args, .. } => {
                assert_eq!(name, "SUM");
                assert_eq!(args.len(), 3);
            }
            _ => panic!("Expected FunctionCall"),
        }
    }

    #[test]
    fn parse_function_call_arg_spans_no_leading_space() {
        // A BinaryOp argument in 2nd+ position must span exactly its own
        // tokens — not the whitespace after the preceding comma (issue #746).
        let src = "=SUM(X1*2, X2*3, X3*4)";
        let expr = parse(src).unwrap();
        let slice = |s: &Span| &src[s.offset..s.offset + s.length];
        match expr {
            Expr::FunctionCall { name, args, .. } => {
                assert_eq!(name, "SUM");
                assert_eq!(args.len(), 3);
                assert_eq!(slice(args[0].span()), "X1*2");
                assert_eq!(slice(args[1].span()), "X2*3");
                assert_eq!(slice(args[2].span()), "X3*4");
            }
            _ => panic!("Expected FunctionCall"),
        }
    }

    #[test]
    fn parse_function_call_arg_spans_no_space_after_comma_unaffected() {
        // Gap noted in review: when there's no whitespace after the comma at
        // all (`after_ws == after_comma`), the fix must be a no-op — args
        // still slice to exactly their own tokens.
        let src = "=SUM(X1*2,X2*3)";
        let expr = parse(src).unwrap();
        let slice = |s: &Span| &src[s.offset..s.offset + s.length];
        match expr {
            Expr::FunctionCall { name, args, .. } => {
                assert_eq!(name, "SUM");
                assert_eq!(args.len(), 2);
                assert_eq!(slice(args[0].span()), "X1*2");
                assert_eq!(slice(args[1].span()), "X2*3");
            }
            _ => panic!("Expected FunctionCall"),
        }
    }

    #[test]
    fn parse_parenthesised_expr_span_no_leading_space() {
        // A padded grouping `( A1 + B1 )` must not leak the space after '(' into
        // the inner expression's span (issue #751 — same class as #746/#748/#749).
        let src = "=( A1 + B1 )";
        let expr = parse(src).unwrap();
        assert!(matches!(expr, Expr::BinaryOp { .. }));
        let sp = expr.span();
        assert_eq!(&src[sp.offset..sp.offset + sp.length], "A1 + B1");
        // Extra whitespace + a different precedence level, still clean.
        let src2 = "=(  A1*B1  )";
        let expr2 = parse(src2).unwrap();
        let sp2 = expr2.span();
        assert_eq!(&src2[sp2.offset..sp2.offset + sp2.length], "A1*B1");
    }

    #[test]
    fn parse_function_call_nested_and_unary_arg_spans_unaffected() {
        // Nested-call and unary args were already correct — confirm the
        // leading-whitespace fix doesn't disturb them.
        let src = "=SUM(1, MAX(2,3), 4)";
        let expr = parse(src).unwrap();
        let slice = |s: &Span| &src[s.offset..s.offset + s.length];
        match expr {
            Expr::FunctionCall { name, args, .. } => {
                assert_eq!(name, "SUM");
                assert_eq!(args.len(), 3);
                assert_eq!(slice(args[0].span()), "1");
                assert_eq!(slice(args[1].span()), "MAX(2,3)");
                assert_eq!(slice(args[2].span()), "4");
            }
            _ => panic!("Expected FunctionCall"),
        }

        let src2 = "=SUM(1, -2)";
        let expr2 = parse(src2).unwrap();
        let slice2 = |s: &Span| &src2[s.offset..s.offset + s.length];
        match expr2 {
            Expr::FunctionCall { name, args, .. } => {
                assert_eq!(name, "SUM");
                assert_eq!(args.len(), 2);
                assert_eq!(slice2(args[0].span()), "1");
                assert_eq!(slice2(args[1].span()), "-2");
            }
            _ => panic!("Expected FunctionCall"),
        }
    }

    #[test]
    fn parse_percent() {
        let expr = parse("=50%").unwrap();
        assert!(matches!(expr, Expr::UnaryOp { op: UnaryOp::Percent, .. }));
    }

    #[test]
    fn parse_string_literal() {
        let expr = parse("=\"hello\"").unwrap();
        assert!(matches!(expr, Expr::Text(ref s, _) if s == "hello"));
    }

    #[test]
    fn parse_concat_op() {
        let expr = parse("=\"a\"&\"b\"").unwrap();
        assert!(matches!(expr, Expr::BinaryOp { op: BinaryOp::Concat, .. }));
    }

    #[test]
    #[allow(deprecated)]
    fn validate_incomplete_fails() {
        let err = validate("=SUM(1,").unwrap_err();
        assert!(!err.message.is_empty());
    }

    #[test]
    fn parse_nested() {
        assert!(parse("=ROUND(SUM(1,2)*1.1, 1)").is_ok());
    }

    #[test]
    fn parse_boolean() {
        let expr = parse("=TRUE").unwrap();
        assert!(matches!(expr, Expr::Bool(true, _)));
    }

    #[test]
    fn parse_variable() {
        let expr = parse("=myVar").unwrap();
        assert!(matches!(expr, Expr::Variable(ref n, _) if n == "myVar"));
    }

    #[test]
    fn parse_array_literal_numbers() {
        let expr = parse("={1,2,3}").unwrap();
        match expr {
            Expr::Array(elems, _) => assert_eq!(elems.len(), 3),
            _ => panic!("Expected Array"),
        }
    }

    #[test]
    fn parse_array_literal_mixed() {
        let expr = parse("={1,\"hello\",TRUE}").unwrap();
        assert!(matches!(expr, Expr::Array(_, _)));
    }

    #[test]
    fn parse_array_literal_empty() {
        let expr = parse("={}").unwrap();
        assert!(matches!(expr, Expr::Array(ref e, _) if e.is_empty()));
    }

    #[test]
    fn parse_array_literal_row_spans() {
        // Each row's span must cover only that row's own elements, not the
        // whole `{...}` body (issue #745).
        let src = "={1,2;3,4}";
        let expr = parse(src).unwrap();
        let slice = |s: &Span| &src[s.offset..s.offset + s.length];

        let (rows, outer_span) = match &expr {
            Expr::Array(rows, span) => (rows, span),
            _ => panic!("Expected outer Array"),
        };
        assert_eq!(slice(outer_span), "{1,2;3,4}");
        assert_eq!(rows.len(), 2);

        let (row0_elems, row0_span) = match &rows[0] {
            Expr::Array(elems, span) => (elems, span),
            _ => panic!("Expected row 0 to be an Array"),
        };
        assert_eq!(slice(row0_span), "1,2");
        assert_eq!(row0_elems.len(), 2);
        assert_eq!(slice(row0_elems[0].span()), "1");
        assert_eq!(slice(row0_elems[1].span()), "2");

        let (row1_elems, row1_span) = match &rows[1] {
            Expr::Array(elems, span) => (elems, span),
            _ => panic!("Expected row 1 to be an Array"),
        };
        assert_eq!(slice(row1_span), "3,4");
        assert_eq!(row1_elems.len(), 2);
        assert_eq!(slice(row1_elems[0].span()), "3");
        assert_eq!(slice(row1_elems[1].span()), "4");
    }

    #[test]
    fn parse_array_literal_single_row_unaffected() {
        // A single-row array (no semicolons) returns a flat Vec<Expr> — no
        // row-wrapper Array nodes — and must be unaffected by the row-span
        // fix (issue #745).
        let src = "={1,2,3}";
        let expr = parse(src).unwrap();
        let slice = |s: &Span| &src[s.offset..s.offset + s.length];
        match &expr {
            Expr::Array(elems, span) => {
                assert_eq!(slice(span), "{1,2,3}");
                assert_eq!(elems.len(), 3);
                assert_eq!(slice(elems[0].span()), "1");
                assert_eq!(slice(elems[1].span()), "2");
                assert_eq!(slice(elems[2].span()), "3");
                for e in elems {
                    assert!(!matches!(e, Expr::Array(_, _)), "single-row elements must not be row-wrapped");
                }
            }
            _ => panic!("Expected Array"),
        }
    }

    #[test]
    fn parse_array_literal_element_no_leading_space() {
        // A compound (BinaryOp) element after a `;` (or `,`) separator must
        // span exactly its own tokens — not the whitespace after the
        // separator. Same root cause as issue #746's function-argument bug,
        // here in the sibling `parse_array_elements`.
        let src = "={1; 2+3}";
        let expr = parse(src).unwrap();
        let slice = |s: &Span| &src[s.offset..s.offset + s.length];

        let rows = match &expr {
            Expr::Array(rows, _) => rows,
            _ => panic!("Expected outer Array"),
        };
        assert_eq!(rows.len(), 2);
        let row1_elems = match &rows[1] {
            Expr::Array(elems, _) => elems,
            _ => panic!("Expected row 1 to be an Array"),
        };
        assert_eq!(row1_elems.len(), 1);
        assert_eq!(slice(row1_elems[0].span()), "2+3");
    }

    #[test]
    fn parse_array_literal_multi_row_element_no_leading_space() {
        // Same as above, but with a compound element after a `,` in each
        // row of a multi-row array — every compound element must slice
        // minimally, with no leading whitespace from its separator.
        let src = "={1, 2+3; 4, 5*6}";
        let expr = parse(src).unwrap();
        let slice = |s: &Span| &src[s.offset..s.offset + s.length];

        let rows = match &expr {
            Expr::Array(rows, _) => rows,
            _ => panic!("Expected outer Array"),
        };
        assert_eq!(rows.len(), 2);

        let row0_elems = match &rows[0] {
            Expr::Array(elems, _) => elems,
            _ => panic!("Expected row 0 to be an Array"),
        };
        assert_eq!(slice(row0_elems[0].span()), "1");
        assert_eq!(slice(row0_elems[1].span()), "2+3");

        let row1_elems = match &rows[1] {
            Expr::Array(elems, _) => elems,
            _ => panic!("Expected row 1 to be an Array"),
        };
        assert_eq!(slice(row1_elems[0].span()), "4");
        assert_eq!(slice(row1_elems[1].span()), "5*6");
    }

    #[test]
    fn parse_array_literal_single_element_rows() {
        // Gap noted in review: single-element-per-row arrays must produce
        // flat one-element rows with correct spans.
        let src = "={1;2}";
        let expr = parse(src).unwrap();
        let slice = |s: &Span| &src[s.offset..s.offset + s.length];

        let rows = match &expr {
            Expr::Array(rows, span) => {
                assert_eq!(slice(span), "{1;2}");
                rows
            }
            _ => panic!("Expected outer Array"),
        };
        assert_eq!(rows.len(), 2);

        let (row0_elems, row0_span) = match &rows[0] {
            Expr::Array(elems, span) => (elems, span),
            _ => panic!("Expected row 0 to be an Array"),
        };
        assert_eq!(slice(row0_span), "1");
        assert_eq!(row0_elems.len(), 1);
        assert_eq!(slice(row0_elems[0].span()), "1");

        let (row1_elems, row1_span) = match &rows[1] {
            Expr::Array(elems, span) => (elems, span),
            _ => panic!("Expected row 1 to be an Array"),
        };
        assert_eq!(slice(row1_span), "2");
        assert_eq!(row1_elems.len(), 1);
        assert_eq!(slice(row1_elems[0].span()), "2");
    }

    #[test]
    fn parse_array_in_function_call() {
        let expr = parse("=SUM({1,2,3})").unwrap();
        match expr {
            Expr::FunctionCall { name, args, .. } => {
                assert_eq!(name, "SUM");
                assert_eq!(args.len(), 1);
                assert!(matches!(args[0], Expr::Array(_, _)));
            }
            _ => panic!("Expected FunctionCall"),
        }
    }

    #[test]
    fn parse_power_right_assoc() {
        // 2^3^2 = 2^(3^2) = 2^9 = 512 (right-associative)
        let expr = parse("=2^3^2").unwrap();
        match expr {
            Expr::BinaryOp { op: BinaryOp::Pow, right, .. } => {
                assert!(matches!(*right, Expr::BinaryOp { op: BinaryOp::Pow, .. }));
            }
            _ => panic!("Expected Pow at top"),
        }
    }
}