truecalc-core 6.0.0

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
use super::*;
use super::parse_formula as parse;
use crate::parser::ast::{BinaryOp, Expr, UnaryOp};
use crate::types::ErrorKind;

#[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"),
    }
}

// ── error literal (issue #716) ──────────────────────────────────────────

#[test]
fn parse_error_literal_ref() {
    let expr = parse("=#REF!").unwrap();
    assert!(matches!(expr, Expr::Error(ErrorKind::Ref, _)));
}

#[test]
fn parse_error_literal_every_canonical_form() {
    let cases = [
        ("=#REF!", ErrorKind::Ref),
        ("=#DIV/0!", ErrorKind::DivByZero),
        ("=#NAME?", ErrorKind::Name),
        ("=#VALUE!", ErrorKind::Value),
        ("=#NUM!", ErrorKind::Num),
        ("=#N/A", ErrorKind::NA),
        ("=#NULL!", ErrorKind::Null),
    ];
    for (formula, expected) in cases {
        let expr = parse(formula).unwrap_or_else(|e| panic!("{formula} failed to parse: {e}"));
        assert!(matches!(&expr, Expr::Error(k, _) if *k == expected), "{formula} -> {expr:?}");
    }
}

#[test]
fn parse_error_literal_span_covers_exactly_the_literal_text() {
    let src = "=#REF!";
    let expr = parse(src).unwrap();
    let sp = expr.span();
    assert_eq!(&src[sp.offset..sp.offset + sp.length], "#REF!");
}

#[test]
fn parse_error_literal_propagates_through_binary_op() {
    // `=#REF!+1` (issue #716 acceptance): the literal is a normal primary, so
    // it composes with the rest of the grammar like any other literal.
    let expr = parse("=#REF!+1").unwrap();
    match expr {
        Expr::BinaryOp { op: BinaryOp::Add, left, .. } => {
            assert!(matches!(*left, Expr::Error(ErrorKind::Ref, _)));
        }
        other => panic!("Expected Add at top, got {other:?}"),
    }
}

#[test]
fn parse_error_literal_na_has_no_trailing_punctuation() {
    // #N/A is the one canonical form with no trailing '!'/'?' -- must still
    // parse standalone and compose with a following operator.
    assert!(matches!(parse("=#N/A").unwrap(), Expr::Error(ErrorKind::NA, _)));
    match parse("=#N/A+1").unwrap() {
        Expr::BinaryOp { op: BinaryOp::Add, left, .. } => {
            assert!(matches!(*left, Expr::Error(ErrorKind::NA, _)));
        }
        other => panic!("Expected Add at top, got {other:?}"),
    }
}

#[test]
fn parse_error_literal_rejects_over_matched_trailing_text() {
    // A hypothetical trailing character glued onto the literal (`#REF!X`)
    // must not silently parse as `#REF!` followed by dropped garbage -- the
    // whole formula should fail to parse.
    assert!(parse("=#REF!X").is_err());
    assert!(parse("=#N/AX").is_err());
}

#[test]
fn parse_error_literal_unsupported_is_not_a_literal() {
    // `#UNSUPPORTED!` is engine-internal, never accepted as formula text.
    assert!(parse("=#UNSUPPORTED!").is_err());
}

#[test]
fn parse_error_literal_is_case_insensitive() {
    // Matches the parser's existing case-insensitive keywords (TRUE/FALSE,
    // function names, cell references).
    assert!(matches!(parse("=#ref!").unwrap(), Expr::Error(ErrorKind::Ref, _)));
    assert!(matches!(parse("=#Div/0!").unwrap(), Expr::Error(ErrorKind::DivByZero, _)));
    assert!(matches!(parse("=#n/a").unwrap(), Expr::Error(ErrorKind::NA, _)));
}