1use crate::tokenizer::{Associativity, Token, TokenSubType, TokenType, Tokenizer, TokenizerError};
2use crate::types::{FormulaDialect, ParsingError};
3use crate::{ExcelError, LiteralValue};
4
5#[cfg(feature = "serde")]
6use serde::{Deserialize, Serialize};
7
8use crate::hasher::FormulaHasher;
9use formualizer_common::coord::{
10 col_index_from_letters_1based, col_letters_from_1based, parse_a1_1based,
11};
12use formualizer_common::{
13 AxisBound, RelativeCoord, SheetCellRef, SheetLocator, SheetRangeRef, SheetRef,
14};
15use once_cell::sync::Lazy;
16use smallvec::SmallVec;
17use std::error::Error;
18use std::fmt::{self, Display};
19use std::hash::{Hash, Hasher};
20use std::str::FromStr;
21use std::sync::Arc;
22
23type VolatilityFn = dyn Fn(&str) -> bool + Send + Sync + 'static;
24type VolatilityClassifierBox = Box<VolatilityFn>;
25type VolatilityClassifierArc = Arc<VolatilityFn>;
26
27#[derive(Debug)]
29pub struct ParserError {
30 pub message: String,
31 pub position: Option<usize>,
32}
33
34impl Display for ParserError {
35 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
36 if let Some(pos) = self.position {
37 write!(f, "ParserError at position {}: {}", pos, self.message)
38 } else {
39 write!(f, "ParserError: {}", self.message)
40 }
41 }
42}
43
44impl Error for ParserError {}
45
46static COLUMN_LOOKUP: Lazy<Vec<String>> = Lazy::new(|| {
48 let mut cols = Vec::with_capacity(702);
49 for c in b'A'..=b'Z' {
51 cols.push(String::from(c as char));
52 }
53 for c1 in b'A'..=b'Z' {
55 for c2 in b'A'..=b'Z' {
56 cols.push(format!("{}{}", c1 as char, c2 as char));
57 }
58 }
59 cols
60});
61
62#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
64#[derive(Debug, Clone, PartialEq, Hash)]
65pub enum TableSpecifier {
66 All,
68 Data,
70 Headers,
72 Totals,
74 Row(TableRowSpecifier),
76 Column(String),
78 ColumnRange(String, String),
80 SpecialItem(SpecialItem),
82 Combination(Vec<Box<TableSpecifier>>),
84}
85
86#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
88#[derive(Debug, Clone, PartialEq, Hash)]
89pub enum TableRowSpecifier {
90 Current,
92 All,
94 Data,
96 Headers,
98 Totals,
100 Index(u32),
102}
103
104#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
106#[derive(Debug, Clone, PartialEq, Hash)]
107pub enum SpecialItem {
108 Headers,
110 Data,
112 Totals,
114 All,
116 ThisRow,
118}
119
120#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
122#[derive(Debug, Clone, PartialEq, Hash)]
123pub struct TableReference {
124 pub name: String,
126 pub specifier: Option<TableSpecifier>,
128}
129
130#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
131#[derive(Debug, Clone, PartialEq, Hash)]
132pub enum ExternalBookRef {
133 Token(String),
134}
135
136impl ExternalBookRef {
137 pub fn token(&self) -> &str {
138 match self {
139 ExternalBookRef::Token(s) => s,
140 }
141 }
142}
143
144#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
145#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
146pub enum ExternalRefKind {
147 Cell {
148 row: u32,
149 col: u32,
150 row_abs: bool,
151 col_abs: bool,
152 },
153 Range {
154 start_row: Option<u32>,
155 start_col: Option<u32>,
156 end_row: Option<u32>,
157 end_col: Option<u32>,
158 start_row_abs: bool,
159 start_col_abs: bool,
160 end_row_abs: bool,
161 end_col_abs: bool,
162 },
163}
164
165impl ExternalRefKind {
166 pub fn cell(row: u32, col: u32) -> Self {
167 Self::Cell {
168 row,
169 col,
170 row_abs: false,
171 col_abs: false,
172 }
173 }
174
175 pub fn cell_with_abs(row: u32, col: u32, row_abs: bool, col_abs: bool) -> Self {
176 Self::Cell {
177 row,
178 col,
179 row_abs,
180 col_abs,
181 }
182 }
183
184 pub fn range(
185 start_row: Option<u32>,
186 start_col: Option<u32>,
187 end_row: Option<u32>,
188 end_col: Option<u32>,
189 ) -> Self {
190 Self::Range {
191 start_row,
192 start_col,
193 end_row,
194 end_col,
195 start_row_abs: false,
196 start_col_abs: false,
197 end_row_abs: false,
198 end_col_abs: false,
199 }
200 }
201
202 #[allow(clippy::too_many_arguments)]
205 pub fn range_with_abs(
206 start_row: Option<u32>,
207 start_col: Option<u32>,
208 end_row: Option<u32>,
209 end_col: Option<u32>,
210 start_row_abs: bool,
211 start_col_abs: bool,
212 end_row_abs: bool,
213 end_col_abs: bool,
214 ) -> Self {
215 Self::Range {
216 start_row,
217 start_col,
218 end_row,
219 end_col,
220 start_row_abs,
221 start_col_abs,
222 end_row_abs,
223 end_col_abs,
224 }
225 }
226}
227
228#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
229#[derive(Debug, Clone, PartialEq, Hash)]
230pub struct ExternalReference {
231 pub raw: String,
232 pub book: ExternalBookRef,
233 pub sheet: String,
234 pub kind: ExternalRefKind,
235}
236
237#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
239#[derive(Debug, Clone, PartialEq, Hash)]
240pub enum ReferenceType {
241 Cell {
242 sheet: Option<String>,
243 row: u32,
244 col: u32,
245 row_abs: bool,
246 col_abs: bool,
247 },
248 Range {
249 sheet: Option<String>,
250 start_row: Option<u32>,
251 start_col: Option<u32>,
252 end_row: Option<u32>,
253 end_col: Option<u32>,
254 start_row_abs: bool,
255 start_col_abs: bool,
256 end_row_abs: bool,
257 end_col_abs: bool,
258 },
259 External(ExternalReference),
260 Table(TableReference),
261 NamedRange(String),
262}
263
264impl Display for TableSpecifier {
265 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
266 match self {
267 TableSpecifier::All => write!(f, "#All"),
268 TableSpecifier::Data => write!(f, "#Data"),
269 TableSpecifier::Headers => write!(f, "#Headers"),
270 TableSpecifier::Totals => write!(f, "#Totals"),
271 TableSpecifier::Row(row) => write!(f, "{row}"),
272 TableSpecifier::Column(column) => write!(f, "{column}"),
273 TableSpecifier::ColumnRange(start, end) => write!(f, "{start}:{end}"),
274 TableSpecifier::SpecialItem(item) => write!(f, "{item}"),
275 TableSpecifier::Combination(specs) => {
276 let parts: Vec<String> = specs.iter().map(|s| format!("[{s}]")).collect();
279 write!(f, "{}", parts.join(","))
280 }
281 }
282 }
283}
284
285impl Display for TableRowSpecifier {
286 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
287 match self {
288 TableRowSpecifier::Current => write!(f, "@"),
289 TableRowSpecifier::All => write!(f, "#All"),
290 TableRowSpecifier::Data => write!(f, "#Data"),
291 TableRowSpecifier::Headers => write!(f, "#Headers"),
292 TableRowSpecifier::Totals => write!(f, "#Totals"),
293 TableRowSpecifier::Index(idx) => write!(f, "{idx}"),
294 }
295 }
296}
297
298impl Display for SpecialItem {
299 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
300 match self {
301 SpecialItem::Headers => write!(f, "#Headers"),
302 SpecialItem::Data => write!(f, "#Data"),
303 SpecialItem::Totals => write!(f, "#Totals"),
304 SpecialItem::All => write!(f, "#All"),
305 SpecialItem::ThisRow => write!(f, "@"),
306 }
307 }
308}
309
310fn sheet_name_needs_quoting(name: &str) -> bool {
312 if name.is_empty() {
313 return false;
314 }
315
316 let bytes = name.as_bytes();
317
318 if bytes[0].is_ascii_digit() {
320 return true;
321 }
322
323 for &byte in bytes {
326 match byte {
327 b' ' | b'!' | b'"' | b'#' | b'$' | b'%' | b'&' | b'\'' | b'(' | b')' | b'*' | b'+'
328 | b',' | b'-' | b'.' | b'/' | b':' | b';' | b'<' | b'=' | b'>' | b'?' | b'@' | b'['
329 | b'\\' | b']' | b'^' | b'`' | b'{' | b'|' | b'}' | b'~' => return true,
330 _ => {}
331 }
332 }
333
334 let upper = name.to_uppercase();
336 matches!(
337 upper.as_str(),
338 "TRUE" | "FALSE" | "NULL" | "REF" | "DIV" | "NAME" | "NUM" | "VALUE" | "N/A"
339 )
340}
341
342#[derive(Debug, Clone)]
343struct OpenFormulaRefPart {
344 sheet: Option<String>,
345 coord: String,
346}
347
348type AxisPartWithAbs = Option<(u32, bool)>;
349type RangePartWithAbs = (AxisPartWithAbs, AxisPartWithAbs);
350
351impl ReferenceType {
352 pub fn cell(sheet: Option<String>, row: u32, col: u32) -> Self {
354 Self::Cell {
355 sheet,
356 row,
357 col,
358 row_abs: false,
359 col_abs: false,
360 }
361 }
362
363 pub fn cell_with_abs(
365 sheet: Option<String>,
366 row: u32,
367 col: u32,
368 row_abs: bool,
369 col_abs: bool,
370 ) -> Self {
371 Self::Cell {
372 sheet,
373 row,
374 col,
375 row_abs,
376 col_abs,
377 }
378 }
379
380 pub fn range(
382 sheet: Option<String>,
383 start_row: Option<u32>,
384 start_col: Option<u32>,
385 end_row: Option<u32>,
386 end_col: Option<u32>,
387 ) -> Self {
388 Self::Range {
389 sheet,
390 start_row,
391 start_col,
392 end_row,
393 end_col,
394 start_row_abs: false,
395 start_col_abs: false,
396 end_row_abs: false,
397 end_col_abs: false,
398 }
399 }
400
401 #[allow(clippy::too_many_arguments)]
405 pub fn range_with_abs(
406 sheet: Option<String>,
407 start_row: Option<u32>,
408 start_col: Option<u32>,
409 end_row: Option<u32>,
410 end_col: Option<u32>,
411 start_row_abs: bool,
412 start_col_abs: bool,
413 end_row_abs: bool,
414 end_col_abs: bool,
415 ) -> Self {
416 Self::Range {
417 sheet,
418 start_row,
419 start_col,
420 end_row,
421 end_col,
422 start_row_abs,
423 start_col_abs,
424 end_row_abs,
425 end_col_abs,
426 }
427 }
428
429 pub fn from_string(reference: &str) -> Result<Self, ParsingError> {
431 Self::parse_excel_reference(reference)
432 }
433
434 pub fn from_string_with_dialect(
436 reference: &str,
437 dialect: FormulaDialect,
438 ) -> Result<Self, ParsingError> {
439 match dialect {
440 FormulaDialect::Excel => Self::parse_excel_reference(reference),
441 FormulaDialect::OpenFormula => Self::parse_openformula_reference(reference)
442 .or_else(|_| Self::parse_excel_reference(reference)),
443 }
444 }
445
446 pub fn parse_sheet_ref(reference: &str) -> Result<SheetRef<'static>, ParsingError> {
450 Self::parse_sheet_ref_with_dialect(reference, FormulaDialect::Excel)
451 }
452
453 pub fn parse_sheet_ref_with_dialect(
455 reference: &str,
456 dialect: FormulaDialect,
457 ) -> Result<SheetRef<'static>, ParsingError> {
458 match dialect {
459 FormulaDialect::Excel => Self::parse_excel_sheet_ref(reference),
460 FormulaDialect::OpenFormula => Self::parse_openformula_sheet_ref(reference)
461 .or_else(|_| Self::parse_excel_sheet_ref(reference)),
462 }
463 }
464
465 pub fn to_sheet_ref_lossy(&self) -> Option<SheetRef<'_>> {
468 match self {
469 ReferenceType::Cell {
470 sheet,
471 row,
472 col,
473 row_abs,
474 col_abs,
475 } => {
476 let row0 = row.checked_sub(1)?;
477 let col0 = col.checked_sub(1)?;
478 let sheet_loc = match sheet.as_deref() {
479 Some(name) => SheetLocator::from_name(name),
480 None => SheetLocator::Current,
481 };
482 let coord = RelativeCoord::new(row0, col0, *row_abs, *col_abs);
483 Some(SheetRef::Cell(SheetCellRef::new(sheet_loc, coord)))
484 }
485 ReferenceType::Range {
486 sheet,
487 start_row,
488 start_col,
489 end_row,
490 end_col,
491 start_row_abs,
492 start_col_abs,
493 end_row_abs,
494 end_col_abs,
495 } => {
496 let sheet_loc = match sheet.as_deref() {
497 Some(name) => SheetLocator::from_name(name),
498 None => SheetLocator::Current,
499 };
500 let sr = start_row
501 .and_then(|v| v.checked_sub(1).map(|i| AxisBound::new(i, *start_row_abs)));
502 if start_row.is_some() && sr.is_none() {
503 return None;
504 }
505 let sc = start_col
506 .and_then(|v| v.checked_sub(1).map(|i| AxisBound::new(i, *start_col_abs)));
507 if start_col.is_some() && sc.is_none() {
508 return None;
509 }
510 let er =
511 end_row.and_then(|v| v.checked_sub(1).map(|i| AxisBound::new(i, *end_row_abs)));
512 if end_row.is_some() && er.is_none() {
513 return None;
514 }
515 let ec =
516 end_col.and_then(|v| v.checked_sub(1).map(|i| AxisBound::new(i, *end_col_abs)));
517 if end_col.is_some() && ec.is_none() {
518 return None;
519 }
520 let range = SheetRangeRef::from_parts(sheet_loc, sr, sc, er, ec).ok()?;
521 Some(SheetRef::Range(range))
522 }
523 _ => None,
524 }
525 }
526
527 fn parse_excel_sheet_ref(reference: &str) -> Result<SheetRef<'static>, ParsingError> {
528 let (sheet, ref_part) = Self::extract_sheet_name(reference);
529
530 if ref_part.contains('[') {
531 return Err(ParsingError::InvalidReference(
532 "Table references are not supported for SheetRef".to_string(),
533 ));
534 }
535
536 let sheet_loc: SheetLocator<'static> = match sheet {
537 Some(name) => SheetLocator::from_name(name),
538 None => SheetLocator::Current,
539 };
540
541 if ref_part.contains(':') {
542 let mut parts = ref_part.splitn(2, ':');
543 let start = parts.next().unwrap();
544 let end = parts.next().ok_or_else(|| {
545 ParsingError::InvalidReference(format!("Invalid range: {ref_part}"))
546 })?;
547
548 let (start_col, start_row) = Self::parse_range_part_with_abs(start)?;
549 let (end_col, end_row) = Self::parse_range_part_with_abs(end)?;
550
551 let start_col = Self::axis_bound_from_1based(start_col)?;
552 let start_row = Self::axis_bound_from_1based(start_row)?;
553 let end_col = Self::axis_bound_from_1based(end_col)?;
554 let end_row = Self::axis_bound_from_1based(end_row)?;
555
556 let range =
557 SheetRangeRef::from_parts(sheet_loc, start_row, start_col, end_row, end_col)
558 .map_err(|err| ParsingError::InvalidReference(err.to_string()))?;
559 Ok(SheetRef::Range(range))
560 } else {
561 let (row, col, row_abs, col_abs) = parse_a1_1based(&ref_part)
562 .map_err(|err| ParsingError::InvalidReference(err.to_string()))?;
563 let coord = RelativeCoord::new(row - 1, col - 1, row_abs, col_abs);
564 Ok(SheetRef::Cell(SheetCellRef::new(sheet_loc, coord)))
565 }
566 }
567
568 fn parse_openformula_sheet_ref(reference: &str) -> Result<SheetRef<'static>, ParsingError> {
569 Self::parse_excel_sheet_ref(reference)
570 }
571
572 fn axis_bound_from_1based(
573 bound: Option<(u32, bool)>,
574 ) -> Result<Option<AxisBound>, ParsingError> {
575 match bound {
576 Some((index, abs)) => AxisBound::from_excel_1based(index, abs)
577 .map(Some)
578 .map_err(|err| ParsingError::InvalidReference(err.to_string())),
579 None => Ok(None),
580 }
581 }
582
583 fn parse_range_part_with_abs(part: &str) -> Result<RangePartWithAbs, ParsingError> {
584 if let Ok((row, col, row_abs, col_abs)) = parse_a1_1based(part) {
585 return Ok((Some((col, col_abs)), Some((row, row_abs))));
586 }
587
588 let bytes = part.as_bytes();
589 let len = bytes.len();
590 let mut i = 0usize;
591
592 let mut col_abs = false;
593 let mut row_abs = false;
594
595 if i < len && bytes[i] == b'$' {
596 col_abs = true;
597 i += 1;
598 }
599
600 let col_start = i;
601 while i < len && bytes[i].is_ascii_alphabetic() {
602 i += 1;
603 }
604
605 if i > col_start {
606 let col_str = &part[col_start..i];
607 let col1 = Self::column_to_number(col_str)?;
608
609 if i == len {
610 return Ok((Some((col1, col_abs)), None));
611 }
612
613 if i < len && bytes[i] == b'$' {
614 row_abs = true;
615 i += 1;
616 }
617
618 if i >= len {
619 return Err(ParsingError::InvalidReference(format!(
620 "Invalid range part: {part}"
621 )));
622 }
623
624 let row_start = i;
625 while i < len && bytes[i].is_ascii_digit() {
626 i += 1;
627 }
628
629 if row_start == i || i != len {
630 return Err(ParsingError::InvalidReference(format!(
631 "Invalid range part: {part}"
632 )));
633 }
634
635 let row_str = &part[row_start..i];
636 let row1 = row_str
637 .parse::<u32>()
638 .map_err(|_| ParsingError::InvalidReference(format!("Invalid row: {row_str}")))?;
639 if row1 == 0 {
640 return Err(ParsingError::InvalidReference(format!(
641 "Invalid range part: {part}"
642 )));
643 }
644
645 return Ok((Some((col1, col_abs)), Some((row1, row_abs))));
646 }
647
648 i = 0;
649 if i < len && bytes[i] == b'$' {
650 row_abs = true;
651 i += 1;
652 }
653
654 let row_start = i;
655 while i < len && bytes[i].is_ascii_digit() {
656 i += 1;
657 }
658
659 if row_start == i || i != len {
660 return Err(ParsingError::InvalidReference(format!(
661 "Invalid range part: {part}"
662 )));
663 }
664
665 let row_str = &part[row_start..i];
666 let row1 = row_str
667 .parse::<u32>()
668 .map_err(|_| ParsingError::InvalidReference(format!("Invalid row: {row_str}")))?;
669 if row1 == 0 {
670 return Err(ParsingError::InvalidReference(format!(
671 "Invalid range part: {part}"
672 )));
673 }
674
675 Ok((None, Some((row1, row_abs))))
676 }
677
678 fn parse_excel_reference(reference: &str) -> Result<Self, ParsingError> {
679 if reference.starts_with('[') && reference.ends_with(']') && !reference.contains('!') {
686 return Self::parse_bracketed_structured_reference(reference);
687 }
688
689 let (sheet, ref_part) = Self::extract_sheet_name(reference);
691
692 if ref_part.contains('[') {
695 return Self::parse_table_reference(&ref_part);
696 }
697
698 let external_sheet = sheet.as_deref().and_then(|s| {
699 let lb = s.rfind('[')?;
703 let rb_rel = s[lb..].find(']')?;
704 let rb = lb + rb_rel;
705 if lb >= rb {
706 return None;
707 }
708
709 let token = &s[..=rb];
710 let sheet_name = &s[rb + 1..];
711 if sheet_name.is_empty() {
712 None
713 } else {
714 Some((token, sheet_name))
715 }
716 });
717
718 if ref_part.contains(':') {
719 let mut parts = ref_part.splitn(2, ':');
721 let start = parts.next().unwrap();
722 let end = parts.next().ok_or_else(|| {
723 ParsingError::InvalidReference(format!("Invalid range: {ref_part}"))
724 })?;
725 let (start_col, start_row) = Self::parse_range_part_with_abs(start)?;
726 let (end_col, end_row) = Self::parse_range_part_with_abs(end)?;
727
728 let split = |bound: Option<(u32, bool)>| match bound {
729 Some((index, abs)) => (Some(index), abs),
730 None => (None, false),
731 };
732 let (start_col, start_col_abs) = split(start_col);
733 let (start_row, start_row_abs) = split(start_row);
734 let (end_col, end_col_abs) = split(end_col);
735 let (end_row, end_row_abs) = split(end_row);
736
737 if let Some((book_token, sheet_name)) = external_sheet {
738 Ok(ReferenceType::External(ExternalReference {
739 raw: reference.to_string(),
740 book: ExternalBookRef::Token(book_token.to_string()),
741 sheet: sheet_name.to_string(),
742 kind: ExternalRefKind::Range {
743 start_row,
744 start_col,
745 end_row,
746 end_col,
747 start_row_abs,
748 start_col_abs,
749 end_row_abs,
750 end_col_abs,
751 },
752 }))
753 } else {
754 Ok(ReferenceType::Range {
755 sheet,
756 start_row,
757 start_col,
758 end_row,
759 end_col,
760 start_row_abs,
761 start_col_abs,
762 end_row_abs,
763 end_col_abs,
764 })
765 }
766 } else {
767 match Self::parse_cell_reference(&ref_part) {
769 Ok((col, row, col_abs, row_abs)) => {
770 if let Some((book_token, sheet_name)) = external_sheet {
771 Ok(ReferenceType::External(ExternalReference {
772 raw: reference.to_string(),
773 book: ExternalBookRef::Token(book_token.to_string()),
774 sheet: sheet_name.to_string(),
775 kind: ExternalRefKind::Cell {
776 row,
777 col,
778 row_abs,
779 col_abs,
780 },
781 }))
782 } else {
783 Ok(ReferenceType::Cell {
784 sheet,
785 row,
786 col,
787 row_abs,
788 col_abs,
789 })
790 }
791 }
792 Err(_) => {
793 Ok(ReferenceType::NamedRange(reference.to_string()))
795 }
796 }
797 }
798 }
799
800 fn parse_cell_reference(reference: &str) -> Result<(u32, u32, bool, bool), ParsingError> {
802 parse_a1_1based(reference)
803 .map(|(row, col, row_abs, col_abs)| (col, row, col_abs, row_abs))
804 .map_err(|_| {
805 ParsingError::InvalidReference(format!("Invalid cell reference: {reference}"))
806 })
807 }
808
809 pub(crate) fn column_to_number(column: &str) -> Result<u32, ParsingError> {
811 col_index_from_letters_1based(column)
812 .map_err(|_| ParsingError::InvalidReference(format!("Invalid column: {column}")))
813 }
814
815 pub(crate) fn number_to_column(num: u32) -> String {
817 if num == 0 {
818 return String::new();
819 }
820 if num > 0 && num <= 702 {
822 return COLUMN_LOOKUP[(num - 1) as usize].clone();
823 }
824
825 col_letters_from_1based(num).unwrap_or_default()
826 }
827
828 fn format_col(col: u32, abs: bool) -> String {
829 if abs {
830 format!("${}", Self::number_to_column(col))
831 } else {
832 Self::number_to_column(col)
833 }
834 }
835
836 fn format_row(row: u32, abs: bool) -> String {
837 if abs {
838 format!("${row}")
839 } else {
840 row.to_string()
841 }
842 }
843}
844
845impl Display for ReferenceType {
846 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
847 write!(
848 f,
849 "{}",
850 match self {
851 ReferenceType::Cell {
852 sheet,
853 row,
854 col,
855 row_abs,
856 col_abs,
857 } => {
858 let col_str = Self::format_col(*col, *col_abs);
859 let row_str = Self::format_row(*row, *row_abs);
860
861 if let Some(sheet_name) = sheet {
862 if sheet_name_needs_quoting(sheet_name) {
863 let escaped_name = sheet_name.replace('\'', "''");
865 format!("'{escaped_name}'!{col_str}{row_str}")
866 } else {
867 format!("{sheet_name}!{col_str}{row_str}")
868 }
869 } else {
870 format!("{col_str}{row_str}")
871 }
872 }
873 ReferenceType::Range {
874 sheet,
875 start_row,
876 start_col,
877 end_row,
878 end_col,
879 start_row_abs,
880 start_col_abs,
881 end_row_abs,
882 end_col_abs,
883 } => {
884 let start_ref = match (start_col, start_row) {
886 (Some(col), Some(row)) => format!(
887 "{}{}",
888 Self::format_col(*col, *start_col_abs),
889 Self::format_row(*row, *start_row_abs)
890 ),
891 (Some(col), None) => Self::format_col(*col, *start_col_abs),
892 (None, Some(row)) => Self::format_row(*row, *start_row_abs),
893 (None, None) => "".to_string(), };
895
896 let end_ref = match (end_col, end_row) {
898 (Some(col), Some(row)) => format!(
899 "{}{}",
900 Self::format_col(*col, *end_col_abs),
901 Self::format_row(*row, *end_row_abs)
902 ),
903 (Some(col), None) => Self::format_col(*col, *end_col_abs),
904 (None, Some(row)) => Self::format_row(*row, *end_row_abs),
905 (None, None) => "".to_string(), };
907
908 let range_part = format!("{start_ref}:{end_ref}");
909
910 if let Some(sheet_name) = sheet {
911 if sheet_name_needs_quoting(sheet_name) {
912 let escaped_name = sheet_name.replace('\'', "''");
914 format!("'{escaped_name}'!{range_part}")
915 } else {
916 format!("{sheet_name}!{range_part}")
917 }
918 } else {
919 range_part
920 }
921 }
922 ReferenceType::External(ext) => ext.raw.clone(),
923 ReferenceType::Table(table_ref) => {
924 if let Some(specifier) = &table_ref.specifier {
925 match specifier {
928 TableSpecifier::Column(column) => {
929 format!("{}[{}]", table_ref.name, column.trim())
930 }
931 TableSpecifier::ColumnRange(start, end) => {
932 format!("{}[{}:{}]", table_ref.name, start.trim(), end.trim())
933 }
934 _ => {
935 format!("{}[{}]", table_ref.name, specifier)
937 }
938 }
939 } else {
940 table_ref.name.clone()
941 }
942 }
943 ReferenceType::NamedRange(name) => name.clone(),
944 }
945 )
946 }
947}
948
949impl TryFrom<&str> for ReferenceType {
950 type Error = ParsingError;
951
952 fn try_from(value: &str) -> Result<Self, Self::Error> {
953 ReferenceType::from_string(value)
954 }
955}
956
957impl FromStr for ReferenceType {
958 type Err = ParsingError;
959
960 fn from_str(s: &str) -> Result<Self, Self::Err> {
961 ReferenceType::from_string(s)
962 }
963}
964
965impl ReferenceType {
966 pub fn normalise(&self) -> String {
968 format!("{self}")
969 }
970
971 fn extract_sheet_name(reference: &str) -> (Option<String>, String) {
973 let bytes = reference.as_bytes();
974 let mut i = 0;
975
976 if i < bytes.len() && bytes[i] == b'\'' {
980 i += 1;
981 let start = i;
982
983 while i < bytes.len() {
984 if bytes[i] == b'\'' {
985 if i + 1 < bytes.len() && bytes[i + 1] == b'\'' {
987 i += 2;
988 continue;
989 }
990
991 if i + 1 < bytes.len() && bytes[i + 1] == b'!' {
993 let raw = &reference[start..i];
994 let sheet = raw.replace("''", "'");
995 let ref_part = String::from(&reference[i + 2..]);
996 return (Some(sheet), ref_part);
997 }
998 }
999
1000 i += 1;
1001 }
1002 }
1003
1004 i = 0;
1006 while i < bytes.len() {
1007 if bytes[i] == b'!' && i > 0 {
1008 let sheet = String::from(&reference[0..i]);
1009 let ref_part = String::from(&reference[i + 1..]);
1010 return (Some(sheet), ref_part);
1011 }
1012 i += 1;
1013 }
1014
1015 (None, reference.to_string())
1016 }
1017
1018 fn parse_table_reference(reference: &str) -> Result<Self, ParsingError> {
1020 if let Some(bracket_pos) = reference.find('[') {
1022 let table_name = reference[..bracket_pos].trim();
1023 if table_name.is_empty() {
1024 return Err(ParsingError::InvalidReference(reference.to_string()));
1025 }
1026
1027 let specifier_str = &reference[bracket_pos..];
1028 let specifier = Self::parse_table_specifier(specifier_str)?;
1029
1030 Ok(ReferenceType::Table(TableReference {
1031 name: table_name.to_string(),
1032 specifier,
1033 }))
1034 } else {
1035 Err(ParsingError::InvalidReference(reference.to_string()))
1036 }
1037 }
1038
1039 fn parse_bracketed_structured_reference(reference: &str) -> Result<Self, ParsingError> {
1040 debug_assert!(reference.starts_with('[') && reference.ends_with(']'));
1041 let inner = reference[1..reference.len().saturating_sub(1)].trim();
1042 if inner.is_empty() {
1043 return Err(ParsingError::InvalidReference(reference.to_string()));
1044 }
1045
1046 if let Some(rest) = inner.strip_prefix('@') {
1048 let mut col = rest.trim();
1049 if col.starts_with('[') && col.ends_with(']') && col.len() >= 2 {
1050 col = col[1..col.len() - 1].trim();
1051 }
1052 if col.is_empty() {
1053 return Err(ParsingError::InvalidReference(format!(
1054 "This-row structured reference missing column: {reference}"
1055 )));
1056 }
1057
1058 let spec = TableSpecifier::Combination(vec![
1059 Box::new(TableSpecifier::SpecialItem(SpecialItem::ThisRow)),
1060 Box::new(TableSpecifier::Column(col.to_string())),
1061 ]);
1062 return Ok(ReferenceType::Table(TableReference {
1063 name: String::new(),
1064 specifier: Some(spec),
1065 }));
1066 }
1067
1068 Ok(ReferenceType::Table(TableReference {
1070 name: inner.to_string(),
1071 specifier: Some(TableSpecifier::SpecialItem(SpecialItem::Data)),
1072 }))
1073 }
1074
1075 fn parse_table_specifier(specifier_str: &str) -> Result<Option<TableSpecifier>, ParsingError> {
1077 if specifier_str.is_empty() || !specifier_str.starts_with('[') {
1078 return Ok(None);
1079 }
1080
1081 let mut depth = 0;
1083 let mut end_pos = 0;
1084
1085 for (i, c) in specifier_str.chars().enumerate() {
1086 if c == '[' {
1087 depth += 1;
1088 } else if c == ']' {
1089 depth -= 1;
1090 if depth == 0 {
1091 end_pos = i;
1092 break;
1093 }
1094 }
1095 }
1096
1097 if depth != 0 || end_pos == 0 {
1098 return Err(ParsingError::InvalidReference(format!(
1099 "Unbalanced brackets in table specifier: {specifier_str}"
1100 )));
1101 }
1102
1103 let content = &specifier_str[1..end_pos];
1105
1106 if content.is_empty() {
1108 return Ok(Some(TableSpecifier::All));
1110 }
1111
1112 if content.starts_with("#") {
1114 return Self::parse_special_item(content);
1115 }
1116
1117 if !content.contains('[') && !content.contains('#') {
1119 if let Some(colon_pos) = content.find(':') {
1121 let start = content[..colon_pos].trim();
1122 let end = content[colon_pos + 1..].trim();
1123 return Ok(Some(TableSpecifier::ColumnRange(
1124 start.to_string(),
1125 end.to_string(),
1126 )));
1127 } else {
1128 return Ok(Some(TableSpecifier::Column(content.trim().to_string())));
1130 }
1131 }
1132
1133 if content.contains('[') {
1135 return Self::parse_complex_table_specifier(content);
1136 }
1137
1138 Ok(Some(TableSpecifier::Column(content.trim().to_string())))
1140 }
1141
1142 fn parse_openformula_reference(reference: &str) -> Result<Self, ParsingError> {
1143 if reference.starts_with('[') && reference.ends_with(']') {
1144 let inner = &reference[1..reference.len() - 1];
1145 if inner.is_empty() {
1146 return Err(ParsingError::InvalidReference(
1147 "Empty OpenFormula reference".to_string(),
1148 ));
1149 }
1150
1151 let mut parts = inner.splitn(2, ':');
1152 let start_part_str = parts.next().unwrap();
1153 let end_part_str = parts.next();
1154
1155 let start_part = Self::parse_openformula_part(start_part_str)?;
1156 let end_part = if let Some(part) = end_part_str {
1157 Some(Self::parse_openformula_part(part)?)
1158 } else {
1159 None
1160 };
1161
1162 let sheet = match (&start_part.sheet, &end_part) {
1163 (Some(sheet), Some(end)) => {
1164 if let Some(end_sheet) = &end.sheet
1165 && end_sheet != sheet
1166 {
1167 return Err(ParsingError::InvalidReference(format!(
1168 "Mismatched sheets in reference: {sheet} vs {end_sheet}"
1169 )));
1170 }
1171 Some(sheet.clone())
1172 }
1173 (Some(sheet), None) => Some(sheet.clone()),
1174 (None, Some(end)) => end.sheet.clone(),
1175 (None, None) => None,
1176 };
1177
1178 let mut excel_like = String::new();
1179 if let Some(sheet_name) = sheet {
1180 if sheet_name_needs_quoting(&sheet_name) {
1181 let escaped = sheet_name.replace('\'', "''");
1182 excel_like.push('\'');
1183 excel_like.push_str(&escaped);
1184 excel_like.push('\'');
1185 } else {
1186 excel_like.push_str(&sheet_name);
1187 }
1188 excel_like.push('!');
1189 }
1190
1191 excel_like.push_str(&start_part.coord);
1192 if let Some(end) = end_part {
1193 excel_like.push(':');
1194 excel_like.push_str(&end.coord);
1195 }
1196
1197 return Self::parse_excel_reference(&excel_like);
1198 }
1199
1200 Err(ParsingError::InvalidReference(format!(
1201 "Unsupported OpenFormula reference: {reference}"
1202 )))
1203 }
1204
1205 fn parse_openformula_part(part: &str) -> Result<OpenFormulaRefPart, ParsingError> {
1206 let trimmed = part.trim();
1207 if trimmed.is_empty() {
1208 return Err(ParsingError::InvalidReference(
1209 "Empty component in OpenFormula reference".to_string(),
1210 ));
1211 }
1212
1213 if trimmed == "." {
1214 return Err(ParsingError::InvalidReference(
1215 "Incomplete OpenFormula reference component".to_string(),
1216 ));
1217 }
1218
1219 if trimmed.starts_with('[') {
1220 return Err(ParsingError::InvalidReference(format!(
1222 "Unexpected '[' in OpenFormula reference component: {trimmed}"
1223 )));
1224 }
1225
1226 let (sheet, coord_slice) = if let Some(stripped) = trimmed.strip_prefix('.') {
1227 (None, stripped.trim())
1228 } else if let Some(dot_idx) = Self::find_openformula_sheet_separator(trimmed) {
1229 let sheet_part = trimmed[..dot_idx].trim();
1230 let coord_part = trimmed[dot_idx + 1..].trim();
1231 if coord_part.is_empty() {
1232 return Err(ParsingError::InvalidReference(format!(
1233 "Missing coordinate in OpenFormula reference component: {trimmed}"
1234 )));
1235 }
1236 let sheet_name = Self::normalise_openformula_sheet(sheet_part)?;
1237 (Some(sheet_name), coord_part)
1238 } else {
1239 (None, trimmed)
1240 };
1241
1242 let coord = coord_slice.trim_start_matches('.').trim().to_string();
1243
1244 if coord.is_empty() {
1245 return Err(ParsingError::InvalidReference(format!(
1246 "Missing coordinate in OpenFormula reference component: {trimmed}"
1247 )));
1248 }
1249
1250 Ok(OpenFormulaRefPart { sheet, coord })
1251 }
1252
1253 fn normalise_openformula_sheet(sheet: &str) -> Result<String, ParsingError> {
1254 let without_abs = sheet.trim().trim_start_matches('$');
1255
1256 if without_abs.starts_with('\'') {
1257 if without_abs.len() < 2 || !without_abs.ends_with('\'') {
1258 return Err(ParsingError::InvalidReference(format!(
1259 "Unterminated sheet name in OpenFormula reference: {sheet}"
1260 )));
1261 }
1262 let inner = &without_abs[1..without_abs.len() - 1];
1263 Ok(inner.replace("''", "'"))
1264 } else {
1265 Ok(without_abs.to_string())
1266 }
1267 }
1268
1269 fn find_openformula_sheet_separator(part: &str) -> Option<usize> {
1270 let bytes = part.as_bytes();
1271 let mut i = 0;
1272 let mut in_quotes = false;
1273
1274 while i < bytes.len() {
1275 match bytes[i] {
1276 b'\'' => {
1277 if i + 1 < bytes.len() && bytes[i + 1] == b'\'' {
1278 i += 2;
1279 continue;
1280 }
1281 in_quotes = !in_quotes;
1282 i += 1;
1283 }
1284 b'.' if !in_quotes => return Some(i),
1285 _ => i += 1,
1286 }
1287 }
1288
1289 None
1290 }
1291
1292 fn parse_special_item(content: &str) -> Result<Option<TableSpecifier>, ParsingError> {
1294 match content {
1295 "#All" => Ok(Some(TableSpecifier::SpecialItem(SpecialItem::All))),
1296 "#Headers" => Ok(Some(TableSpecifier::SpecialItem(SpecialItem::Headers))),
1297 "#Data" => Ok(Some(TableSpecifier::SpecialItem(SpecialItem::Data))),
1298 "#Totals" => Ok(Some(TableSpecifier::SpecialItem(SpecialItem::Totals))),
1299 "@" => Ok(Some(TableSpecifier::Row(TableRowSpecifier::Current))),
1300 _ => Err(ParsingError::InvalidReference(format!(
1301 "Unknown special item: {content}"
1302 ))),
1303 }
1304 }
1305
1306 fn parse_complex_table_specifier(
1308 content: &str,
1309 ) -> Result<Option<TableSpecifier>, ParsingError> {
1310 if content.contains("[#Headers]")
1315 || content.contains("[#All]")
1316 || content.contains("[#Data]")
1317 || content.contains("[#Totals]")
1318 || content.contains("[@]")
1319 {
1320 let mut specifiers = Vec::new();
1323
1324 if content.contains("[#Headers]") {
1326 specifiers.push(Box::new(TableSpecifier::SpecialItem(SpecialItem::Headers)));
1327 }
1328 if content.contains("[#Data]") {
1329 specifiers.push(Box::new(TableSpecifier::SpecialItem(SpecialItem::Data)));
1330 }
1331 if content.contains("[#Totals]") {
1332 specifiers.push(Box::new(TableSpecifier::SpecialItem(SpecialItem::Totals)));
1333 }
1334 if content.contains("[#All]") {
1335 specifiers.push(Box::new(TableSpecifier::SpecialItem(SpecialItem::All)));
1336 }
1337
1338 if !specifiers.is_empty() {
1339 return Ok(Some(TableSpecifier::Combination(specifiers)));
1340 }
1341 }
1342
1343 Ok(Some(TableSpecifier::Column(content.trim().to_string())))
1345 }
1346
1347 pub fn to_excel_string(&self) -> String {
1349 match self {
1350 ReferenceType::Cell {
1351 sheet,
1352 row,
1353 col,
1354 row_abs,
1355 col_abs,
1356 } => {
1357 let col_str = Self::format_col(*col, *col_abs);
1358 let row_str = Self::format_row(*row, *row_abs);
1359 if let Some(s) = sheet {
1360 if sheet_name_needs_quoting(s) {
1361 let escaped_name = s.replace('\'', "''");
1362 format!("'{}'!{}{}", escaped_name, col_str, row_str)
1363 } else {
1364 format!("{}!{}{}", s, col_str, row_str)
1365 }
1366 } else {
1367 format!("{}{}", col_str, row_str)
1368 }
1369 }
1370 ReferenceType::Range {
1371 sheet,
1372 start_row,
1373 start_col,
1374 end_row,
1375 end_col,
1376 start_row_abs,
1377 start_col_abs,
1378 end_row_abs,
1379 end_col_abs,
1380 } => {
1381 let start_ref = match (start_col, start_row) {
1383 (Some(col), Some(row)) => format!(
1384 "{}{}",
1385 Self::format_col(*col, *start_col_abs),
1386 Self::format_row(*row, *start_row_abs)
1387 ),
1388 (Some(col), None) => Self::format_col(*col, *start_col_abs),
1389 (None, Some(row)) => Self::format_row(*row, *start_row_abs),
1390 (None, None) => "".to_string(), };
1392
1393 let end_ref = match (end_col, end_row) {
1395 (Some(col), Some(row)) => format!(
1396 "{}{}",
1397 Self::format_col(*col, *end_col_abs),
1398 Self::format_row(*row, *end_row_abs)
1399 ),
1400 (Some(col), None) => Self::format_col(*col, *end_col_abs),
1401 (None, Some(row)) => Self::format_row(*row, *end_row_abs),
1402 (None, None) => "".to_string(), };
1404
1405 let range_part = format!("{start_ref}:{end_ref}");
1406
1407 if let Some(s) = sheet {
1408 if sheet_name_needs_quoting(s) {
1409 let escaped_name = s.replace('\'', "''");
1410 format!("'{escaped_name}'!{range_part}")
1411 } else {
1412 format!("{s}!{range_part}")
1413 }
1414 } else {
1415 range_part
1416 }
1417 }
1418 ReferenceType::External(ext) => ext.raw.clone(),
1419 ReferenceType::Table(table_ref) => {
1420 if let Some(specifier) = &table_ref.specifier {
1421 format!("{}[{}]", table_ref.name, specifier)
1422 } else {
1423 table_ref.name.clone()
1424 }
1425 }
1426 ReferenceType::NamedRange(name) => name.clone(),
1427 }
1428 }
1429}
1430
1431#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
1433#[derive(Debug, Clone, PartialEq, Hash)]
1434pub enum ASTNodeType {
1435 Literal(LiteralValue),
1436 Reference {
1437 original: String, reference: ReferenceType, },
1440 UnaryOp {
1441 op: String,
1442 expr: Box<ASTNode>,
1443 },
1444 BinaryOp {
1445 op: String,
1446 left: Box<ASTNode>,
1447 right: Box<ASTNode>,
1448 },
1449 Function {
1450 name: String,
1451 args: Vec<ASTNode>, },
1453 Array(Vec<Vec<ASTNode>>), }
1455
1456impl Display for ASTNodeType {
1457 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1458 match self {
1459 ASTNodeType::Literal(value) => write!(f, "Literal({value})"),
1460 ASTNodeType::Reference { reference, .. } => write!(f, "Reference({reference:?})"),
1461 ASTNodeType::UnaryOp { op, expr } => write!(f, "UnaryOp({op}, {expr})"),
1462 ASTNodeType::BinaryOp { op, left, right } => {
1463 write!(f, "BinaryOp({op}, {left}, {right})")
1464 }
1465 ASTNodeType::Function { name, args } => write!(f, "Function({name}, {args:?})"),
1466 ASTNodeType::Array(rows) => write!(f, "Array({rows:?})"),
1467 }
1468 }
1469}
1470
1471#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
1473#[derive(Debug, Clone, PartialEq)]
1474pub struct ASTNode {
1475 pub node_type: ASTNodeType,
1476 pub source_token: Option<Token>,
1477 pub contains_volatile: bool,
1482}
1483
1484impl ASTNode {
1485 pub fn new(node_type: ASTNodeType, source_token: Option<Token>) -> Self {
1486 ASTNode {
1487 node_type,
1488 source_token,
1489 contains_volatile: false,
1490 }
1491 }
1492
1493 pub fn new_with_volatile(
1495 node_type: ASTNodeType,
1496 source_token: Option<Token>,
1497 contains_volatile: bool,
1498 ) -> Self {
1499 ASTNode {
1500 node_type,
1501 source_token,
1502 contains_volatile,
1503 }
1504 }
1505
1506 pub fn contains_volatile(&self) -> bool {
1508 self.contains_volatile
1509 }
1510
1511 pub fn fingerprint(&self) -> u64 {
1512 self.calculate_hash()
1513 }
1514
1515 pub fn calculate_hash(&self) -> u64 {
1517 let mut hasher = FormulaHasher::new();
1518 self.hash_node(&mut hasher);
1519 hasher.finish()
1520 }
1521
1522 fn hash_node(&self, hasher: &mut FormulaHasher) {
1523 match &self.node_type {
1524 ASTNodeType::Literal(value) => {
1525 hasher.write(&[1]); value.hash(hasher);
1527 }
1528 ASTNodeType::Reference { reference, .. } => {
1529 hasher.write(&[2]); reference.hash(hasher);
1531 }
1532 ASTNodeType::UnaryOp { op, expr } => {
1533 hasher.write(&[3]); hasher.write(op.as_bytes());
1535 expr.hash_node(hasher);
1536 }
1537 ASTNodeType::BinaryOp { op, left, right } => {
1538 hasher.write(&[4]); hasher.write(op.as_bytes());
1540 left.hash_node(hasher);
1541 right.hash_node(hasher);
1542 }
1543 ASTNodeType::Function { name, args } => {
1544 hasher.write(&[5]); let name_lower = name.to_lowercase();
1547 hasher.write(name_lower.as_bytes());
1548 hasher.write_usize(args.len());
1549 for arg in args {
1550 arg.hash_node(hasher);
1551 }
1552 }
1553 ASTNodeType::Array(rows) => {
1554 hasher.write(&[6]); hasher.write_usize(rows.len());
1556 for row in rows {
1557 hasher.write_usize(row.len());
1558 for item in row {
1559 item.hash_node(hasher);
1560 }
1561 }
1562 }
1563 }
1564 }
1565
1566 pub fn get_dependencies(&self) -> Vec<&ReferenceType> {
1567 let mut dependencies = Vec::new();
1568 self.collect_dependencies(&mut dependencies);
1569 dependencies
1570 }
1571
1572 pub fn get_dependency_strings(&self) -> Vec<String> {
1573 self.get_dependencies()
1574 .into_iter()
1575 .map(|dep| format!("{dep}"))
1576 .collect()
1577 }
1578
1579 fn collect_dependencies<'a>(&'a self, dependencies: &mut Vec<&'a ReferenceType>) {
1580 match &self.node_type {
1581 ASTNodeType::Reference { reference, .. } => {
1582 dependencies.push(reference);
1583 }
1584 ASTNodeType::UnaryOp { expr, .. } => {
1585 expr.collect_dependencies(dependencies);
1586 }
1587 ASTNodeType::BinaryOp { left, right, .. } => {
1588 left.collect_dependencies(dependencies);
1589 right.collect_dependencies(dependencies);
1590 }
1591 ASTNodeType::Function { args, .. } => {
1592 for arg in args {
1593 arg.collect_dependencies(dependencies);
1594 }
1595 }
1596 ASTNodeType::Array(rows) => {
1597 for row in rows {
1598 for item in row {
1599 item.collect_dependencies(dependencies);
1600 }
1601 }
1602 }
1603 _ => {}
1604 }
1605 }
1606
1607 pub fn refs(&self) -> RefIter<'_> {
1610 RefIter {
1611 stack: smallvec::smallvec![self],
1612 }
1613 }
1614
1615 pub fn visit_refs<V: FnMut(RefView<'_>)>(&self, mut visitor: V) {
1617 let mut stack: Vec<&ASTNode> = Vec::with_capacity(8);
1618 stack.push(self);
1619 while let Some(node) = stack.pop() {
1620 match &node.node_type {
1621 ASTNodeType::Reference { reference, .. } => visitor(RefView::from(reference)),
1622 ASTNodeType::UnaryOp { expr, .. } => stack.push(expr),
1623 ASTNodeType::BinaryOp { left, right, .. } => {
1624 stack.push(right);
1626 stack.push(left);
1627 }
1628 ASTNodeType::Function { args, .. } => {
1629 for a in args.iter().rev() {
1630 stack.push(a);
1631 }
1632 }
1633 ASTNodeType::Array(rows) => {
1634 for r in rows.iter().rev() {
1635 for item in r.iter().rev() {
1636 stack.push(item);
1637 }
1638 }
1639 }
1640 ASTNodeType::Literal(_) => {}
1641 }
1642 }
1643 }
1644
1645 pub fn collect_references(&self, policy: &CollectPolicy) -> SmallVec<[ReferenceType; 4]> {
1647 let mut out: SmallVec<[ReferenceType; 4]> = SmallVec::new();
1648 self.visit_refs(|rv| match rv {
1649 RefView::Cell {
1650 sheet,
1651 row,
1652 col,
1653 row_abs,
1654 col_abs,
1655 } => out.push(ReferenceType::Cell {
1656 sheet: sheet.map(|s| s.to_string()),
1657 row,
1658 col,
1659 row_abs,
1660 col_abs,
1661 }),
1662 RefView::Range {
1663 sheet,
1664 start_row,
1665 start_col,
1666 end_row,
1667 end_col,
1668 start_row_abs,
1669 start_col_abs,
1670 end_row_abs,
1671 end_col_abs,
1672 } => {
1673 if policy.expand_small_ranges
1675 && let (Some(sr), Some(sc), Some(er), Some(ec)) =
1676 (start_row, start_col, end_row, end_col)
1677 {
1678 let rows = er.saturating_sub(sr) + 1;
1679 let cols = ec.saturating_sub(sc) + 1;
1680 let area = rows.saturating_mul(cols);
1681 if area as usize <= policy.range_expansion_limit {
1682 let row_abs = start_row_abs && end_row_abs;
1683 let col_abs = start_col_abs && end_col_abs;
1684 for r in sr..=er {
1685 for c in sc..=ec {
1686 out.push(ReferenceType::Cell {
1687 sheet: sheet.map(|s| s.to_string()),
1688 row: r,
1689 col: c,
1690 row_abs,
1691 col_abs,
1692 });
1693 }
1694 }
1695 return; }
1697 }
1698 out.push(ReferenceType::Range {
1699 sheet: sheet.map(|s| s.to_string()),
1700 start_row,
1701 start_col,
1702 end_row,
1703 end_col,
1704 start_row_abs,
1705 start_col_abs,
1706 end_row_abs,
1707 end_col_abs,
1708 });
1709 }
1710 RefView::External {
1711 raw,
1712 book,
1713 sheet,
1714 kind,
1715 } => out.push(ReferenceType::External(ExternalReference {
1716 raw: raw.to_string(),
1717 book: ExternalBookRef::Token(book.to_string()),
1718 sheet: sheet.to_string(),
1719 kind,
1720 })),
1721 RefView::Table { name, specifier } => out.push(ReferenceType::Table(TableReference {
1722 name: name.to_string(),
1723 specifier: specifier.cloned(),
1724 })),
1725 RefView::NamedRange { name } => {
1726 if policy.include_names {
1727 out.push(ReferenceType::NamedRange(name.to_string()));
1728 }
1729 }
1730 });
1731 out
1732 }
1733}
1734
1735#[derive(Clone, Copy, Debug)]
1737pub enum RefView<'a> {
1738 Cell {
1739 sheet: Option<&'a str>,
1740 row: u32,
1741 col: u32,
1742 row_abs: bool,
1743 col_abs: bool,
1744 },
1745 Range {
1746 sheet: Option<&'a str>,
1747 start_row: Option<u32>,
1748 start_col: Option<u32>,
1749 end_row: Option<u32>,
1750 end_col: Option<u32>,
1751 start_row_abs: bool,
1752 start_col_abs: bool,
1753 end_row_abs: bool,
1754 end_col_abs: bool,
1755 },
1756 External {
1757 raw: &'a str,
1758 book: &'a str,
1759 sheet: &'a str,
1760 kind: ExternalRefKind,
1761 },
1762 Table {
1763 name: &'a str,
1764 specifier: Option<&'a TableSpecifier>,
1765 },
1766 NamedRange {
1767 name: &'a str,
1768 },
1769}
1770
1771impl<'a> From<&'a ReferenceType> for RefView<'a> {
1772 fn from(r: &'a ReferenceType) -> Self {
1773 match r {
1774 ReferenceType::Cell {
1775 sheet,
1776 row,
1777 col,
1778 row_abs,
1779 col_abs,
1780 } => RefView::Cell {
1781 sheet: sheet.as_deref(),
1782 row: *row,
1783 col: *col,
1784 row_abs: *row_abs,
1785 col_abs: *col_abs,
1786 },
1787 ReferenceType::Range {
1788 sheet,
1789 start_row,
1790 start_col,
1791 end_row,
1792 end_col,
1793 start_row_abs,
1794 start_col_abs,
1795 end_row_abs,
1796 end_col_abs,
1797 } => RefView::Range {
1798 sheet: sheet.as_deref(),
1799 start_row: *start_row,
1800 start_col: *start_col,
1801 end_row: *end_row,
1802 end_col: *end_col,
1803 start_row_abs: *start_row_abs,
1804 start_col_abs: *start_col_abs,
1805 end_row_abs: *end_row_abs,
1806 end_col_abs: *end_col_abs,
1807 },
1808 ReferenceType::External(ext) => RefView::External {
1809 raw: ext.raw.as_str(),
1810 book: ext.book.token(),
1811 sheet: ext.sheet.as_str(),
1812 kind: ext.kind,
1813 },
1814 ReferenceType::Table(tr) => RefView::Table {
1815 name: tr.name.as_str(),
1816 specifier: tr.specifier.as_ref(),
1817 },
1818 ReferenceType::NamedRange(name) => RefView::NamedRange { name },
1819 }
1820 }
1821}
1822
1823pub struct RefIter<'a> {
1825 stack: smallvec::SmallVec<[&'a ASTNode; 8]>,
1826}
1827
1828impl<'a> Iterator for RefIter<'a> {
1829 type Item = RefView<'a>;
1830 fn next(&mut self) -> Option<Self::Item> {
1831 while let Some(node) = self.stack.pop() {
1832 match &node.node_type {
1833 ASTNodeType::Reference { reference, .. } => return Some(RefView::from(reference)),
1834 ASTNodeType::UnaryOp { expr, .. } => self.stack.push(expr),
1835 ASTNodeType::BinaryOp { left, right, .. } => {
1836 self.stack.push(right);
1837 self.stack.push(left);
1838 }
1839 ASTNodeType::Function { args, .. } => {
1840 for a in args.iter().rev() {
1841 self.stack.push(a);
1842 }
1843 }
1844 ASTNodeType::Array(rows) => {
1845 for r in rows.iter().rev() {
1846 for item in r.iter().rev() {
1847 self.stack.push(item);
1848 }
1849 }
1850 }
1851 ASTNodeType::Literal(_) => {}
1852 }
1853 }
1854 None
1855 }
1856}
1857
1858#[derive(Debug, Clone)]
1860pub struct CollectPolicy {
1861 pub expand_small_ranges: bool,
1862 pub range_expansion_limit: usize,
1863 pub include_names: bool,
1864}
1865
1866impl Default for CollectPolicy {
1867 fn default() -> Self {
1868 Self {
1869 expand_small_ranges: false,
1870 range_expansion_limit: 0,
1871 include_names: true,
1872 }
1873 }
1874}
1875
1876impl Display for ASTNode {
1877 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1878 write!(f, "{}", self.node_type)
1879 }
1880}
1881
1882impl std::hash::Hash for ASTNode {
1883 fn hash<H: std::hash::Hasher>(&self, state: &mut H) {
1884 let hash = self.calculate_hash();
1885 state.write_u64(hash);
1886 }
1887}
1888
1889pub struct Parser {
1891 tokens: Arc<[Token]>,
1892 position: usize,
1893 volatility_classifier: Option<VolatilityClassifierBox>,
1895 dialect: FormulaDialect,
1896}
1897
1898impl TryFrom<&str> for Parser {
1899 type Error = TokenizerError;
1900
1901 fn try_from(formula: &str) -> Result<Self, Self::Error> {
1902 let tokens = Tokenizer::new(formula)?.items;
1903 Ok(Self::new(tokens, false))
1904 }
1905}
1906
1907impl TryFrom<String> for Parser {
1908 type Error = TokenizerError;
1909
1910 fn try_from(formula: String) -> Result<Self, Self::Error> {
1911 Self::try_from(formula.as_str())
1912 }
1913}
1914
1915impl Parser {
1916 pub fn new(tokens: Vec<Token>, include_whitespace: bool) -> Self {
1917 Self::new_with_dialect(tokens, include_whitespace, FormulaDialect::Excel)
1918 }
1919
1920 pub fn new_with_dialect(
1921 mut tokens: Vec<Token>,
1922 include_whitespace: bool,
1923 dialect: FormulaDialect,
1924 ) -> Self {
1925 if !include_whitespace {
1926 tokens.retain(|t| t.token_type != TokenType::Whitespace);
1927 }
1928
1929 Parser {
1930 tokens: Arc::from(tokens.into_boxed_slice()),
1931 position: 0,
1932 volatility_classifier: None,
1933 dialect,
1934 }
1935 }
1936
1937 pub fn try_from_formula(formula: &str) -> Result<Self, TokenizerError> {
1938 let tokens = Tokenizer::new(formula)?.items;
1939 Ok(Self::new(tokens, false))
1940 }
1941
1942 pub fn with_volatility_classifier<F>(mut self, f: F) -> Self
1945 where
1946 F: Fn(&str) -> bool + Send + Sync + 'static,
1947 {
1948 self.volatility_classifier = Some(Box::new(f));
1949 self
1950 }
1951
1952 pub fn new_with_classifier<F>(tokens: Vec<Token>, include_whitespace: bool, f: F) -> Self
1954 where
1955 F: Fn(&str) -> bool + Send + Sync + 'static,
1956 {
1957 Self::new(tokens, include_whitespace).with_volatility_classifier(f)
1958 }
1959
1960 pub fn new_with_classifier_and_dialect<F>(
1961 tokens: Vec<Token>,
1962 include_whitespace: bool,
1963 dialect: FormulaDialect,
1964 f: F,
1965 ) -> Self
1966 where
1967 F: Fn(&str) -> bool + Send + Sync + 'static,
1968 {
1969 Self::new_with_dialect(tokens, include_whitespace, dialect).with_volatility_classifier(f)
1970 }
1971
1972 fn skip_whitespace(&mut self) {
1973 while self.position < self.tokens.len()
1974 && self.tokens[self.position].token_type == TokenType::Whitespace
1975 {
1976 self.position += 1;
1977 }
1978 }
1979
1980 pub fn parse(&mut self) -> Result<ASTNode, ParserError> {
1982 if self.tokens.is_empty() {
1983 return Err(ParserError {
1984 message: "No tokens to parse".to_string(),
1985 position: None,
1986 });
1987 }
1988
1989 self.skip_whitespace();
1990 if self.position >= self.tokens.len() {
1991 return Err(ParserError {
1992 message: "No tokens to parse".to_string(),
1993 position: None,
1994 });
1995 }
1996
1997 if self.tokens[self.position].token_type == TokenType::Literal {
1999 let token = self.tokens[self.position].clone();
2000 self.position += 1;
2001 self.skip_whitespace();
2002 if self.position < self.tokens.len() {
2003 return Err(ParserError {
2004 message: format!(
2005 "Unexpected token at position {}: {:?}",
2006 self.position, self.tokens[self.position]
2007 ),
2008 position: Some(self.position),
2009 });
2010 }
2011 return Ok(ASTNode::new(
2012 ASTNodeType::Literal(LiteralValue::Text(token.value.clone())),
2013 Some(token),
2014 ));
2015 }
2016
2017 let ast = self.parse_expression()?;
2018 self.skip_whitespace();
2019 if self.position < self.tokens.len() {
2020 return Err(ParserError {
2021 message: format!(
2022 "Unexpected token at position {}: {:?}",
2023 self.position, self.tokens[self.position]
2024 ),
2025 position: Some(self.position),
2026 });
2027 }
2028 Ok(ast)
2029 }
2030
2031 fn parse_expression(&mut self) -> Result<ASTNode, ParserError> {
2032 self.parse_bp(0)
2033 }
2034
2035 fn parse_bp(&mut self, min_precedence: u8) -> Result<ASTNode, ParserError> {
2038 let mut left = self.parse_prefix()?;
2039
2040 loop {
2041 self.skip_whitespace();
2042 if self.position >= self.tokens.len() {
2043 break;
2044 }
2045
2046 if self.tokens[self.position].token_type == TokenType::OpPostfix {
2048 let (precedence, _) = self.tokens[self.position]
2049 .get_precedence()
2050 .unwrap_or((0, Associativity::Left));
2051 if precedence < min_precedence {
2052 break;
2053 }
2054
2055 let op_token = self.tokens[self.position].clone();
2056 self.position += 1;
2057 let contains_volatile = left.contains_volatile;
2058 left = ASTNode::new_with_volatile(
2059 ASTNodeType::UnaryOp {
2060 op: op_token.value.clone(),
2061 expr: Box::new(left),
2062 },
2063 Some(op_token),
2064 contains_volatile,
2065 );
2066 continue;
2067 }
2068
2069 let token = &self.tokens[self.position];
2070 if token.token_type != TokenType::OpInfix {
2071 break;
2072 }
2073
2074 let (precedence, associativity) =
2075 token.get_precedence().unwrap_or((0, Associativity::Left));
2076 if precedence < min_precedence {
2077 break;
2078 }
2079
2080 let op_token = self.tokens[self.position].clone();
2081 self.position += 1;
2082
2083 let next_min_precedence = if associativity == Associativity::Left {
2084 precedence + 1
2085 } else {
2086 precedence
2087 };
2088
2089 let right = self.parse_bp(next_min_precedence)?;
2090 let contains_volatile = left.contains_volatile || right.contains_volatile;
2091 left = ASTNode::new_with_volatile(
2092 ASTNodeType::BinaryOp {
2093 op: op_token.value.clone(),
2094 left: Box::new(left),
2095 right: Box::new(right),
2096 },
2097 Some(op_token),
2098 contains_volatile,
2099 );
2100 }
2101
2102 Ok(left)
2103 }
2104
2105 fn parse_prefix(&mut self) -> Result<ASTNode, ParserError> {
2106 self.skip_whitespace();
2107 if self.position < self.tokens.len()
2108 && self.tokens[self.position].token_type == TokenType::OpPrefix
2109 {
2110 let op_token = self.tokens[self.position].clone();
2111 self.position += 1;
2112
2113 let (precedence, _) = op_token
2116 .get_precedence()
2117 .unwrap_or((0, Associativity::Right));
2118
2119 let expr = self.parse_bp(precedence)?;
2120 let contains_volatile = expr.contains_volatile;
2121 return Ok(ASTNode::new_with_volatile(
2122 ASTNodeType::UnaryOp {
2123 op: op_token.value.clone(),
2124 expr: Box::new(expr),
2125 },
2126 Some(op_token),
2127 contains_volatile,
2128 ));
2129 }
2130
2131 self.parse_primary()
2132 }
2133
2134 fn parse_primary(&mut self) -> Result<ASTNode, ParserError> {
2135 self.skip_whitespace();
2136 if self.position >= self.tokens.len() {
2137 return Err(ParserError {
2138 message: "Unexpected end of tokens".to_string(),
2139 position: Some(self.position),
2140 });
2141 }
2142
2143 let token = &self.tokens[self.position];
2144 match token.token_type {
2145 TokenType::Operand => {
2146 let operand_token = self.tokens[self.position].clone();
2147 self.position += 1;
2148 self.parse_operand(operand_token)
2149 }
2150 TokenType::Func => {
2151 let func_token = self.tokens[self.position].clone();
2152 self.position += 1;
2153 self.parse_function(func_token)
2154 }
2155 TokenType::Paren if token.subtype == TokenSubType::Open => {
2156 self.position += 1;
2157 let expr = self.parse_expression()?;
2158 if self.position >= self.tokens.len()
2159 || self.tokens[self.position].token_type != TokenType::Paren
2160 || self.tokens[self.position].subtype != TokenSubType::Close
2161 {
2162 return Err(ParserError {
2163 message: "Expected closing parenthesis".to_string(),
2164 position: Some(self.position),
2165 });
2166 }
2167 self.position += 1;
2168 Ok(expr)
2169 }
2170 TokenType::Array if token.subtype == TokenSubType::Open => {
2171 self.position += 1;
2172 self.parse_array()
2173 }
2174 _ => Err(ParserError {
2175 message: format!("Unexpected token: {token:?}"),
2176 position: Some(self.position),
2177 }),
2178 }
2179 }
2180
2181 fn parse_operand(&mut self, token: Token) -> Result<ASTNode, ParserError> {
2182 match token.subtype {
2183 TokenSubType::Number => {
2184 let value = token.value.parse::<f64>().map_err(|_| ParserError {
2185 message: format!("Invalid number: {}", token.value),
2186 position: Some(self.position),
2187 })?;
2188 Ok(ASTNode::new(
2189 ASTNodeType::Literal(LiteralValue::Number(value)),
2190 Some(token),
2191 ))
2192 }
2193 TokenSubType::Text => {
2194 let mut text = token.value.clone();
2196 if text.starts_with('"') && text.ends_with('"') && text.len() >= 2 {
2197 text = text[1..text.len() - 1].to_string();
2198 text = text.replace("\"\"", "\"");
2200 }
2201 Ok(ASTNode::new(
2202 ASTNodeType::Literal(LiteralValue::Text(text)),
2203 Some(token),
2204 ))
2205 }
2206 TokenSubType::Logical => {
2207 let value = token.value.to_uppercase() == "TRUE";
2208 Ok(ASTNode::new(
2209 ASTNodeType::Literal(LiteralValue::Boolean(value)),
2210 Some(token),
2211 ))
2212 }
2213 TokenSubType::Error => {
2214 let error = ExcelError::from_error_string(&token.value);
2215 Ok(ASTNode::new(
2216 ASTNodeType::Literal(LiteralValue::Error(error)),
2217 Some(token),
2218 ))
2219 }
2220 TokenSubType::Range => {
2221 let reference = ReferenceType::from_string_with_dialect(&token.value, self.dialect)
2222 .map_err(|e| ParserError {
2223 message: format!("Invalid reference '{}': {}", token.value, e),
2224 position: Some(self.position),
2225 })?;
2226 Ok(ASTNode::new(
2227 ASTNodeType::Reference {
2228 original: token.value.clone(),
2229 reference,
2230 },
2231 Some(token),
2232 ))
2233 }
2234 _ => Err(ParserError {
2235 message: format!("Unexpected operand subtype: {:?}", token.subtype),
2236 position: Some(self.position),
2237 }),
2238 }
2239 }
2240
2241 fn parse_function(&mut self, func_token: Token) -> Result<ASTNode, ParserError> {
2242 let name = func_token.value[..func_token.value.len() - 1].to_string();
2243 let args = self.parse_function_arguments()?;
2244 let this_is_volatile = self
2246 .volatility_classifier
2247 .as_ref()
2248 .map(|f| f(name.as_str()))
2249 .unwrap_or(false);
2250 let args_volatile = args.iter().any(|a| a.contains_volatile);
2251
2252 Ok(ASTNode::new_with_volatile(
2253 ASTNodeType::Function { name, args },
2254 Some(func_token),
2255 this_is_volatile || args_volatile,
2256 ))
2257 }
2258
2259 fn parse_function_arguments(&mut self) -> Result<Vec<ASTNode>, ParserError> {
2261 let mut args = Vec::new();
2262
2263 if self.position < self.tokens.len()
2265 && self.tokens[self.position].token_type == TokenType::Func
2266 && self.tokens[self.position].subtype == TokenSubType::Close
2267 {
2268 self.position += 1;
2269 return Ok(args);
2270 }
2271
2272 if self.position < self.tokens.len()
2275 && self.tokens[self.position].token_type == TokenType::Sep
2276 && self.tokens[self.position].subtype == TokenSubType::Arg
2277 {
2278 args.push(ASTNode::new(
2280 ASTNodeType::Literal(LiteralValue::Text("".to_string())),
2281 None,
2282 ));
2283 self.position += 1;
2284 } else {
2285 args.push(self.parse_expression()?);
2287 }
2288
2289 while self.position < self.tokens.len() {
2291 let token = &self.tokens[self.position];
2292
2293 if token.token_type == TokenType::Sep && token.subtype == TokenSubType::Arg {
2294 self.position += 1;
2295 if self.position < self.tokens.len() {
2297 let next_token = &self.tokens[self.position];
2298 if next_token.token_type == TokenType::Sep
2299 && next_token.subtype == TokenSubType::Arg
2300 {
2301 args.push(ASTNode::new(
2303 ASTNodeType::Literal(LiteralValue::Text("".to_string())),
2304 None,
2305 ));
2306 } else if next_token.token_type == TokenType::Func
2307 && next_token.subtype == TokenSubType::Close
2308 {
2309 args.push(ASTNode::new(
2311 ASTNodeType::Literal(LiteralValue::Text("".to_string())),
2312 None,
2313 ));
2314 self.position += 1;
2315 break;
2316 } else {
2317 args.push(self.parse_expression()?);
2318 }
2319 } else {
2320 args.push(ASTNode::new(
2322 ASTNodeType::Literal(LiteralValue::Text("".to_string())),
2323 None,
2324 ));
2325 }
2326 } else if token.token_type == TokenType::Func && token.subtype == TokenSubType::Close {
2327 self.position += 1;
2328 break;
2329 } else {
2330 return Err(ParserError {
2331 message: format!("Expected ',' or ')' in function arguments, got {token:?}"),
2332 position: Some(self.position),
2333 });
2334 }
2335 }
2336
2337 Ok(args)
2338 }
2339
2340 fn parse_array(&mut self) -> Result<ASTNode, ParserError> {
2341 let mut rows = Vec::new();
2342 let mut current_row = Vec::new();
2343
2344 if self.position < self.tokens.len()
2346 && self.tokens[self.position].token_type == TokenType::Array
2347 && self.tokens[self.position].subtype == TokenSubType::Close
2348 {
2349 self.position += 1;
2350 return Ok(ASTNode::new(ASTNodeType::Array(rows), None));
2351 }
2352
2353 current_row.push(self.parse_expression()?);
2355
2356 while self.position < self.tokens.len() {
2357 let token = &self.tokens[self.position];
2358
2359 if token.token_type == TokenType::Sep {
2360 if token.subtype == TokenSubType::Arg {
2361 self.position += 1;
2363 current_row.push(self.parse_expression()?);
2364 } else if token.subtype == TokenSubType::Row {
2365 self.position += 1;
2367 rows.push(current_row);
2368 current_row = vec![self.parse_expression()?];
2369 }
2370 } else if token.token_type == TokenType::Array && token.subtype == TokenSubType::Close {
2371 self.position += 1;
2372 rows.push(current_row);
2373 break;
2374 } else {
2375 return Err(ParserError {
2376 message: format!("Unexpected token in array: {token:?}"),
2377 position: Some(self.position),
2378 });
2379 }
2380 }
2381
2382 let contains_volatile = rows
2384 .iter()
2385 .flat_map(|r| r.iter())
2386 .any(|n| n.contains_volatile);
2387 Ok(ASTNode::new_with_volatile(
2388 ASTNodeType::Array(rows),
2389 None,
2390 contains_volatile,
2391 ))
2392 }
2393}
2394
2395impl From<TokenizerError> for ParserError {
2396 fn from(err: TokenizerError) -> Self {
2397 ParserError {
2398 message: err.message,
2399 position: Some(err.pos),
2400 }
2401 }
2402}
2403
2404struct SpanParser<'a> {
2405 source: &'a str,
2406 tokens: &'a [crate::tokenizer::TokenSpan],
2407 position: usize,
2408 volatility_classifier: Option<VolatilityClassifierBox>,
2409 dialect: FormulaDialect,
2410}
2411
2412impl<'a> SpanParser<'a> {
2413 fn new(
2414 source: &'a str,
2415 tokens: &'a [crate::tokenizer::TokenSpan],
2416 dialect: FormulaDialect,
2417 ) -> Self {
2418 SpanParser {
2419 source,
2420 tokens,
2421 position: 0,
2422 volatility_classifier: None,
2423 dialect,
2424 }
2425 }
2426
2427 fn with_volatility_classifier<F>(mut self, f: F) -> Self
2428 where
2429 F: Fn(&str) -> bool + Send + Sync + 'static,
2430 {
2431 self.volatility_classifier = Some(Box::new(f));
2432 self
2433 }
2434
2435 fn skip_whitespace(&mut self) {
2436 while self.position < self.tokens.len()
2437 && self.tokens[self.position].token_type == TokenType::Whitespace
2438 {
2439 self.position += 1;
2440 }
2441 }
2442
2443 fn span_value(&self, span: &crate::tokenizer::TokenSpan) -> &str {
2444 &self.source[span.start..span.end]
2445 }
2446
2447 fn span_to_token(&self, span: &crate::tokenizer::TokenSpan) -> Token {
2448 Token::new_with_span(
2449 self.span_value(span).to_string(),
2450 span.token_type,
2451 span.subtype,
2452 span.start,
2453 span.end,
2454 )
2455 }
2456
2457 fn span_precedence(&self, span: &crate::tokenizer::TokenSpan) -> Option<(u8, Associativity)> {
2458 if !matches!(
2459 span.token_type,
2460 TokenType::OpPrefix | TokenType::OpInfix | TokenType::OpPostfix
2461 ) {
2462 return None;
2463 }
2464
2465 let op = if span.token_type == TokenType::OpPrefix {
2466 "u"
2467 } else {
2468 self.span_value(span)
2469 };
2470
2471 match op {
2472 ":" | " " | "," => Some((8, Associativity::Left)),
2473 "%" => Some((7, Associativity::Left)),
2474 "^" => Some((6, Associativity::Right)),
2475 "u" => Some((5, Associativity::Right)),
2476 "*" | "/" => Some((4, Associativity::Left)),
2477 "+" | "-" => Some((3, Associativity::Left)),
2478 "&" => Some((2, Associativity::Left)),
2479 "=" | "<" | ">" | "<=" | ">=" | "<>" => Some((1, Associativity::Left)),
2480 _ => None,
2481 }
2482 }
2483
2484 fn parse(&mut self) -> Result<ASTNode, ParserError> {
2485 if self.tokens.is_empty() {
2486 return Err(ParserError {
2487 message: "No tokens to parse".to_string(),
2488 position: None,
2489 });
2490 }
2491
2492 self.skip_whitespace();
2493 if self.position >= self.tokens.len() {
2494 return Err(ParserError {
2495 message: "No tokens to parse".to_string(),
2496 position: None,
2497 });
2498 }
2499
2500 if self.tokens[self.position].token_type == TokenType::Literal {
2501 let span = self.tokens[self.position];
2502 self.position += 1;
2503 self.skip_whitespace();
2504 if self.position < self.tokens.len() {
2505 return Err(ParserError {
2506 message: format!(
2507 "Unexpected token at position {}: {:?}",
2508 self.position, self.tokens[self.position]
2509 ),
2510 position: Some(self.position),
2511 });
2512 }
2513
2514 let token = self.span_to_token(&span);
2515 return Ok(ASTNode::new(
2516 ASTNodeType::Literal(LiteralValue::Text(token.value.clone())),
2517 Some(token),
2518 ));
2519 }
2520
2521 let ast = self.parse_expression()?;
2522 self.skip_whitespace();
2523 if self.position < self.tokens.len() {
2524 return Err(ParserError {
2525 message: format!(
2526 "Unexpected token at position {}: {:?}",
2527 self.position, self.tokens[self.position]
2528 ),
2529 position: Some(self.position),
2530 });
2531 }
2532 Ok(ast)
2533 }
2534
2535 fn parse_expression(&mut self) -> Result<ASTNode, ParserError> {
2536 self.parse_bp(0)
2537 }
2538
2539 fn parse_bp(&mut self, min_precedence: u8) -> Result<ASTNode, ParserError> {
2540 let mut left = self.parse_prefix()?;
2541
2542 loop {
2543 self.skip_whitespace();
2544 if self.position >= self.tokens.len() {
2545 break;
2546 }
2547
2548 if self.tokens[self.position].token_type == TokenType::OpPostfix {
2549 let (precedence, _) = self
2550 .span_precedence(&self.tokens[self.position])
2551 .unwrap_or((0, Associativity::Left));
2552 if precedence < min_precedence {
2553 break;
2554 }
2555
2556 let op_span = self.tokens[self.position];
2557 self.position += 1;
2558 let op_token = self.span_to_token(&op_span);
2559 let contains_volatile = left.contains_volatile;
2560 left = ASTNode::new_with_volatile(
2561 ASTNodeType::UnaryOp {
2562 op: op_token.value.clone(),
2563 expr: Box::new(left),
2564 },
2565 Some(op_token),
2566 contains_volatile,
2567 );
2568 continue;
2569 }
2570
2571 let token = &self.tokens[self.position];
2572 if token.token_type != TokenType::OpInfix {
2573 break;
2574 }
2575
2576 let (precedence, associativity) = self
2577 .span_precedence(token)
2578 .unwrap_or((0, Associativity::Left));
2579 if precedence < min_precedence {
2580 break;
2581 }
2582
2583 let op_span = self.tokens[self.position];
2584 self.position += 1;
2585
2586 let next_min_precedence = if associativity == Associativity::Left {
2587 precedence + 1
2588 } else {
2589 precedence
2590 };
2591
2592 let right = self.parse_bp(next_min_precedence)?;
2593 let op_token = self.span_to_token(&op_span);
2594 let contains_volatile = left.contains_volatile || right.contains_volatile;
2595 left = ASTNode::new_with_volatile(
2596 ASTNodeType::BinaryOp {
2597 op: op_token.value.clone(),
2598 left: Box::new(left),
2599 right: Box::new(right),
2600 },
2601 Some(op_token),
2602 contains_volatile,
2603 );
2604 }
2605
2606 Ok(left)
2607 }
2608
2609 fn parse_prefix(&mut self) -> Result<ASTNode, ParserError> {
2610 self.skip_whitespace();
2611 if self.position < self.tokens.len()
2612 && self.tokens[self.position].token_type == TokenType::OpPrefix
2613 {
2614 let op_span = self.tokens[self.position];
2615 self.position += 1;
2616
2617 let (precedence, _) = self
2618 .span_precedence(&op_span)
2619 .unwrap_or((0, Associativity::Right));
2620
2621 let expr = self.parse_bp(precedence)?;
2622 let op_token = self.span_to_token(&op_span);
2623 let contains_volatile = expr.contains_volatile;
2624 return Ok(ASTNode::new_with_volatile(
2625 ASTNodeType::UnaryOp {
2626 op: op_token.value.clone(),
2627 expr: Box::new(expr),
2628 },
2629 Some(op_token),
2630 contains_volatile,
2631 ));
2632 }
2633
2634 self.parse_primary()
2635 }
2636
2637 fn parse_primary(&mut self) -> Result<ASTNode, ParserError> {
2638 self.skip_whitespace();
2639 if self.position >= self.tokens.len() {
2640 return Err(ParserError {
2641 message: "Unexpected end of tokens".to_string(),
2642 position: Some(self.position),
2643 });
2644 }
2645
2646 let token = &self.tokens[self.position];
2647 match token.token_type {
2648 TokenType::Operand => {
2649 let span = self.tokens[self.position];
2650 self.position += 1;
2651 self.parse_operand(span)
2652 }
2653 TokenType::Func => {
2654 let span = self.tokens[self.position];
2655 self.position += 1;
2656 self.parse_function(span)
2657 }
2658 TokenType::Paren if token.subtype == TokenSubType::Open => {
2659 self.position += 1;
2660 let expr = self.parse_expression()?;
2661 self.skip_whitespace();
2662 if self.position >= self.tokens.len()
2663 || self.tokens[self.position].token_type != TokenType::Paren
2664 || self.tokens[self.position].subtype != TokenSubType::Close
2665 {
2666 return Err(ParserError {
2667 message: "Expected closing parenthesis".to_string(),
2668 position: Some(self.position),
2669 });
2670 }
2671 self.position += 1;
2672 Ok(expr)
2673 }
2674 TokenType::Array if token.subtype == TokenSubType::Open => {
2675 self.position += 1;
2676 self.parse_array()
2677 }
2678 _ => Err(ParserError {
2679 message: format!("Unexpected token: {token:?}"),
2680 position: Some(self.position),
2681 }),
2682 }
2683 }
2684
2685 fn parse_operand(&mut self, span: crate::tokenizer::TokenSpan) -> Result<ASTNode, ParserError> {
2686 let value = self.span_value(&span);
2687 let token = self.span_to_token(&span);
2688
2689 match span.subtype {
2690 TokenSubType::Number => {
2691 let value = value.parse::<f64>().map_err(|_| ParserError {
2692 message: format!("Invalid number: {value}"),
2693 position: Some(self.position),
2694 })?;
2695 Ok(ASTNode::new(
2696 ASTNodeType::Literal(LiteralValue::Number(value)),
2697 Some(token),
2698 ))
2699 }
2700 TokenSubType::Text => {
2701 let mut text = value.to_string();
2702 if text.starts_with('"') && text.ends_with('"') && text.len() >= 2 {
2703 text = text[1..text.len() - 1].to_string();
2704 text = text.replace("\"\"", "\"");
2705 }
2706 Ok(ASTNode::new(
2707 ASTNodeType::Literal(LiteralValue::Text(text)),
2708 Some(token),
2709 ))
2710 }
2711 TokenSubType::Logical => {
2712 let v = value.to_uppercase() == "TRUE";
2713 Ok(ASTNode::new(
2714 ASTNodeType::Literal(LiteralValue::Boolean(v)),
2715 Some(token),
2716 ))
2717 }
2718 TokenSubType::Error => {
2719 let error = ExcelError::from_error_string(value);
2720 Ok(ASTNode::new(
2721 ASTNodeType::Literal(LiteralValue::Error(error)),
2722 Some(token),
2723 ))
2724 }
2725 TokenSubType::Range => {
2726 let reference = ReferenceType::from_string_with_dialect(value, self.dialect)
2727 .map_err(|e| ParserError {
2728 message: format!("Invalid reference '{value}': {e}"),
2729 position: Some(self.position),
2730 })?;
2731 Ok(ASTNode::new(
2732 ASTNodeType::Reference {
2733 original: value.to_string(),
2734 reference,
2735 },
2736 Some(token),
2737 ))
2738 }
2739 _ => Err(ParserError {
2740 message: format!("Unexpected operand subtype: {:?}", span.subtype),
2741 position: Some(self.position),
2742 }),
2743 }
2744 }
2745
2746 fn parse_function(
2747 &mut self,
2748 func_span: crate::tokenizer::TokenSpan,
2749 ) -> Result<ASTNode, ParserError> {
2750 let func_value = self.span_value(&func_span);
2751 if func_value.is_empty() {
2752 return Err(ParserError {
2753 message: "Invalid function token".to_string(),
2754 position: Some(self.position),
2755 });
2756 }
2757 let name = func_value[..func_value.len() - 1].to_string();
2758 let args = self.parse_function_arguments()?;
2759
2760 let this_is_volatile = self
2761 .volatility_classifier
2762 .as_ref()
2763 .map(|f| f(name.as_str()))
2764 .unwrap_or(false);
2765 let args_volatile = args.iter().any(|a| a.contains_volatile);
2766
2767 let func_token = self.span_to_token(&func_span);
2768 Ok(ASTNode::new_with_volatile(
2769 ASTNodeType::Function { name, args },
2770 Some(func_token),
2771 this_is_volatile || args_volatile,
2772 ))
2773 }
2774
2775 fn parse_function_arguments(&mut self) -> Result<Vec<ASTNode>, ParserError> {
2776 let mut args = Vec::new();
2777
2778 self.skip_whitespace();
2779 if self.position < self.tokens.len()
2780 && self.tokens[self.position].token_type == TokenType::Func
2781 && self.tokens[self.position].subtype == TokenSubType::Close
2782 {
2783 self.position += 1;
2784 return Ok(args);
2785 }
2786
2787 self.skip_whitespace();
2788 if self.position < self.tokens.len()
2789 && self.tokens[self.position].token_type == TokenType::Sep
2790 && self.tokens[self.position].subtype == TokenSubType::Arg
2791 {
2792 args.push(ASTNode::new(
2793 ASTNodeType::Literal(LiteralValue::Text("".to_string())),
2794 None,
2795 ));
2796 self.position += 1;
2797 } else {
2798 args.push(self.parse_expression()?);
2799 }
2800
2801 while self.position < self.tokens.len() {
2802 self.skip_whitespace();
2803 if self.position >= self.tokens.len() {
2804 break;
2805 }
2806
2807 let token = &self.tokens[self.position];
2808 if token.token_type == TokenType::Sep && token.subtype == TokenSubType::Arg {
2809 self.position += 1;
2810 self.skip_whitespace();
2811 if self.position < self.tokens.len() {
2812 let next_token = &self.tokens[self.position];
2813 if next_token.token_type == TokenType::Sep
2814 && next_token.subtype == TokenSubType::Arg
2815 {
2816 args.push(ASTNode::new(
2817 ASTNodeType::Literal(LiteralValue::Text("".to_string())),
2818 None,
2819 ));
2820 } else if next_token.token_type == TokenType::Func
2821 && next_token.subtype == TokenSubType::Close
2822 {
2823 args.push(ASTNode::new(
2824 ASTNodeType::Literal(LiteralValue::Text("".to_string())),
2825 None,
2826 ));
2827 self.position += 1;
2828 break;
2829 } else {
2830 args.push(self.parse_expression()?);
2831 }
2832 } else {
2833 args.push(ASTNode::new(
2834 ASTNodeType::Literal(LiteralValue::Text("".to_string())),
2835 None,
2836 ));
2837 }
2838 } else if token.token_type == TokenType::Func && token.subtype == TokenSubType::Close {
2839 self.position += 1;
2840 break;
2841 } else {
2842 return Err(ParserError {
2843 message: format!("Expected ',' or ')' in function arguments, got {token:?}"),
2844 position: Some(self.position),
2845 });
2846 }
2847 }
2848
2849 Ok(args)
2850 }
2851
2852 fn parse_array(&mut self) -> Result<ASTNode, ParserError> {
2853 let mut rows = Vec::new();
2854 let mut current_row = Vec::new();
2855
2856 self.skip_whitespace();
2857 if self.position < self.tokens.len()
2858 && self.tokens[self.position].token_type == TokenType::Array
2859 && self.tokens[self.position].subtype == TokenSubType::Close
2860 {
2861 self.position += 1;
2862 return Ok(ASTNode::new(ASTNodeType::Array(rows), None));
2863 }
2864
2865 current_row.push(self.parse_expression()?);
2866
2867 while self.position < self.tokens.len() {
2868 self.skip_whitespace();
2869 if self.position >= self.tokens.len() {
2870 break;
2871 }
2872 let token = &self.tokens[self.position];
2873
2874 if token.token_type == TokenType::Sep {
2875 if token.subtype == TokenSubType::Arg {
2876 self.position += 1;
2877 current_row.push(self.parse_expression()?);
2878 } else if token.subtype == TokenSubType::Row {
2879 self.position += 1;
2880 rows.push(current_row);
2881 current_row = vec![self.parse_expression()?];
2882 }
2883 } else if token.token_type == TokenType::Array && token.subtype == TokenSubType::Close {
2884 self.position += 1;
2885 rows.push(current_row);
2886 break;
2887 } else {
2888 return Err(ParserError {
2889 message: format!("Unexpected token in array: {token:?}"),
2890 position: Some(self.position),
2891 });
2892 }
2893 }
2894
2895 let contains_volatile = rows
2896 .iter()
2897 .flat_map(|r| r.iter())
2898 .any(|n| n.contains_volatile);
2899
2900 Ok(ASTNode::new_with_volatile(
2901 ASTNodeType::Array(rows),
2902 None,
2903 contains_volatile,
2904 ))
2905 }
2906}
2907
2908pub fn normalise_reference(reference: &str) -> Result<String, ParsingError> {
2910 let ref_type = ReferenceType::from_string(reference)?;
2911 Ok(ref_type.to_string())
2912}
2913
2914pub fn parse<T: AsRef<str>>(formula: T) -> Result<ASTNode, ParserError> {
2915 parse_with_dialect(formula, FormulaDialect::Excel)
2916}
2917
2918pub fn parse_with_dialect<T: AsRef<str>>(
2919 formula: T,
2920 dialect: FormulaDialect,
2921) -> Result<ASTNode, ParserError> {
2922 let spans = crate::tokenizer::tokenize_spans_with_dialect(formula.as_ref(), dialect)?;
2923 let mut parser = SpanParser::new(formula.as_ref(), &spans, dialect);
2924 parser.parse()
2925}
2926
2927pub fn parse_with_volatility_classifier<T, F>(
2930 formula: T,
2931 classifier: F,
2932) -> Result<ASTNode, ParserError>
2933where
2934 T: AsRef<str>,
2935 F: Fn(&str) -> bool + Send + Sync + 'static,
2936{
2937 parse_with_dialect_and_volatility_classifier(formula, FormulaDialect::Excel, classifier)
2938}
2939
2940pub fn parse_with_dialect_and_volatility_classifier<T, F>(
2941 formula: T,
2942 dialect: FormulaDialect,
2943 classifier: F,
2944) -> Result<ASTNode, ParserError>
2945where
2946 T: AsRef<str>,
2947 F: Fn(&str) -> bool + Send + Sync + 'static,
2948{
2949 let spans = crate::tokenizer::tokenize_spans_with_dialect(formula.as_ref(), dialect)?;
2950 let mut parser =
2951 SpanParser::new(formula.as_ref(), &spans, dialect).with_volatility_classifier(classifier);
2952 parser.parse()
2953}
2954
2955pub struct BatchParser {
2960 include_whitespace: bool,
2961 volatility_classifier: Option<VolatilityClassifierArc>,
2962 token_cache: std::collections::HashMap<String, Arc<[crate::tokenizer::TokenSpan]>>, dialect: FormulaDialect,
2964}
2965
2966impl BatchParser {
2967 pub fn builder() -> BatchParserBuilder {
2968 BatchParserBuilder::default()
2969 }
2970
2971 pub fn parse(&mut self, formula: &str) -> Result<ASTNode, ParserError> {
2973 let spans = if let Some(tokens) = self.token_cache.get(formula) {
2974 Arc::clone(tokens)
2975 } else {
2976 let mut spans = crate::tokenizer::tokenize_spans_with_dialect(formula, self.dialect)?;
2977 if !self.include_whitespace {
2978 spans.retain(|t| t.token_type != TokenType::Whitespace);
2979 }
2980
2981 let spans: Arc<[crate::tokenizer::TokenSpan]> = Arc::from(spans.into_boxed_slice());
2982 self.token_cache
2983 .insert(formula.to_string(), Arc::clone(&spans));
2984 spans
2985 };
2986
2987 let mut parser = SpanParser::new(formula, spans.as_ref(), self.dialect);
2988 if let Some(classifier) = self.volatility_classifier.clone() {
2989 parser = parser.with_volatility_classifier(move |name| classifier(name));
2990 }
2991 parser.parse()
2992 }
2993}
2994
2995#[derive(Default)]
2996pub struct BatchParserBuilder {
2997 include_whitespace: bool,
2998 volatility_classifier: Option<VolatilityClassifierArc>,
2999 dialect: FormulaDialect,
3000}
3001
3002impl BatchParserBuilder {
3003 pub fn include_whitespace(mut self, include: bool) -> Self {
3004 self.include_whitespace = include;
3005 self
3006 }
3007
3008 pub fn with_volatility_classifier<F>(mut self, f: F) -> Self
3009 where
3010 F: Fn(&str) -> bool + Send + Sync + 'static,
3011 {
3012 self.volatility_classifier = Some(Arc::new(f));
3013 self
3014 }
3015
3016 pub fn dialect(mut self, dialect: FormulaDialect) -> Self {
3017 self.dialect = dialect;
3018 self
3019 }
3020
3021 pub fn build(self) -> BatchParser {
3022 BatchParser {
3023 include_whitespace: self.include_whitespace,
3024 volatility_classifier: self.volatility_classifier,
3025 token_cache: std::collections::HashMap::new(),
3026 dialect: self.dialect,
3027 }
3028 }
3029}