formualizer_eval/engine/graph/
tables.rs

1use crate::SheetId;
2use crate::engine::graph::DependencyGraph;
3use crate::engine::vertex::{VertexId, VertexKind};
4use crate::reference::RangeRef;
5use formualizer_common::{ExcelError, ExcelErrorKind};
6
7#[inline]
8fn normalize_table_key(name: &str) -> String {
9    name.to_lowercase()
10}
11
12/// Native workbook table (Excel ListObject) metadata.
13#[derive(Debug, Clone)]
14pub struct TableEntry {
15    pub name: String,
16    pub range: RangeRef,
17    pub header_row: bool,
18    pub headers: Vec<String>,
19    pub totals_row: bool,
20    pub vertex: VertexId,
21}
22
23impl TableEntry {
24    pub fn sheet_id(&self) -> SheetId {
25        self.range.start.sheet_id
26    }
27
28    pub fn col_index(&self, header: &str) -> Option<usize> {
29        let header_key = header.to_lowercase();
30        self.headers
31            .iter()
32            .position(|h| h.to_lowercase() == header_key)
33    }
34}
35
36impl DependencyGraph {
37    #[inline]
38    fn table_lookup_key(&self, name: &str) -> String {
39        if self.config.case_sensitive_tables {
40            name.to_string()
41        } else {
42            normalize_table_key(name)
43        }
44    }
45
46    fn canonical_table_name(&self, name: &str) -> Option<String> {
47        let key = self.table_lookup_key(name);
48        self.tables_lookup.get(&key).cloned()
49    }
50
51    pub fn resolve_table_entry(&self, name: &str) -> Option<&TableEntry> {
52        if self.config.case_sensitive_tables {
53            self.tables.get(name)
54        } else {
55            let key = self.table_lookup_key(name);
56            self.tables_lookup
57                .get(&key)
58                .and_then(|canon| self.tables.get(canon))
59        }
60    }
61
62    pub fn table_by_vertex(&self, vertex: VertexId) -> Option<&TableEntry> {
63        self.table_vertex_lookup
64            .get(&vertex)
65            .and_then(|name| self.tables.get(name))
66    }
67
68    pub fn define_table(
69        &mut self,
70        name: &str,
71        range: RangeRef,
72        header_row: bool,
73        headers: Vec<String>,
74        totals_row: bool,
75    ) -> Result<(), ExcelError> {
76        if name.is_empty() {
77            return Err(ExcelError::new(ExcelErrorKind::Name)
78                .with_message("Table name cannot be empty".to_string()));
79        }
80
81        let key = self.table_lookup_key(name);
82        if let Some(existing) = self.tables_lookup.get(&key) {
83            return Err(ExcelError::new(ExcelErrorKind::Name).with_message(format!(
84                "Table collision under normalization: '{name}' conflicts with '{existing}'"
85            )));
86        }
87
88        let anchor = range.start;
89        let sheet_id = anchor.sheet_id;
90        let packed_coord = formualizer_common::Coord::new(anchor.coord.row(), anchor.coord.col());
91        let vertex = self.store.allocate(packed_coord, sheet_id, 0x01);
92        self.edges.add_vertex(packed_coord, vertex.0);
93        self.sheet_index_mut(sheet_id)
94            .add_vertex(packed_coord, vertex);
95        self.store.set_kind(vertex, VertexKind::Table);
96
97        // Register stripes for the full table region so cell edits inside the table
98        // propagate to formulas that depend on the table.
99        self.register_table_range_deps(vertex, &range);
100
101        let entry = TableEntry {
102            name: name.to_string(),
103            range,
104            header_row,
105            headers,
106            totals_row,
107            vertex,
108        };
109
110        let original = name.to_string();
111        self.tables.insert(original.clone(), entry);
112        self.tables_lookup
113            .insert(self.table_lookup_key(&original), original.clone());
114        self.table_vertex_lookup.insert(vertex, original);
115        Ok(())
116    }
117
118    pub fn update_table(
119        &mut self,
120        name: &str,
121        new_range: RangeRef,
122        header_row: bool,
123        headers: Vec<String>,
124        totals_row: bool,
125    ) -> Result<(), ExcelError> {
126        let Some(canon) = self.canonical_table_name(name) else {
127            return Err(ExcelError::new(ExcelErrorKind::Name)
128                .with_message(format!("Unknown table: {name}")));
129        };
130
131        let vertex = self.tables.get(&canon).map(|t| t.vertex).ok_or_else(|| {
132            ExcelError::new(ExcelErrorKind::Name).with_message(format!("Unknown table: {name}"))
133        })?;
134
135        // Replace range deps (cleans old stripes).
136        self.remove_dependent_edges(vertex);
137        self.register_table_range_deps(vertex, &new_range);
138
139        if let Some(existing) = self.tables.get_mut(&canon) {
140            existing.range = new_range;
141            existing.header_row = header_row;
142            existing.headers = headers;
143            existing.totals_row = totals_row;
144        }
145
146        // Propagate to dependents.
147        self.mark_dirty(vertex);
148        Ok(())
149    }
150
151    pub fn delete_table(&mut self, name: &str) -> Result<(), ExcelError> {
152        let Some(canon) = self.canonical_table_name(name) else {
153            return Err(ExcelError::new(ExcelErrorKind::Name)
154                .with_message(format!("Unknown table: {name}")));
155        };
156
157        let Some(entry) = self.tables.remove(&canon) else {
158            return Err(ExcelError::new(ExcelErrorKind::Name)
159                .with_message(format!("Unknown table: {name}")));
160        };
161
162        self.tables_lookup.remove(&self.table_lookup_key(&canon));
163
164        let vertex = entry.vertex;
165        self.table_vertex_lookup.remove(&vertex);
166
167        // Clean range deps / stripes.
168        self.remove_dependent_edges(vertex);
169
170        // Mark deleted for debuggability; edges already removed.
171        self.store.mark_deleted(vertex, true);
172        self.vertex_values.remove(&vertex);
173        self.vertex_formulas.remove(&vertex);
174        self.dirty_vertices.remove(&vertex);
175        self.volatile_vertices.remove(&vertex);
176
177        Ok(())
178    }
179
180    fn register_table_range_deps(&mut self, table_vertex: VertexId, range: &RangeRef) {
181        use crate::reference::SharedRangeRef;
182        use crate::reference::SharedSheetLocator;
183        use formualizer_common::AxisBound;
184
185        // Reuse the same range-deps machinery as formulas/names.
186        let sheet_loc = SharedSheetLocator::Id(range.start.sheet_id);
187        let sr = AxisBound::new(range.start.coord.row(), range.start.coord.row_abs());
188        let sc = AxisBound::new(range.start.coord.col(), range.start.coord.col_abs());
189        let er = AxisBound::new(range.end.coord.row(), range.end.coord.row_abs());
190        let ec = AxisBound::new(range.end.coord.col(), range.end.coord.col_abs());
191
192        if let Ok(r) = SharedRangeRef::from_parts(sheet_loc, Some(sr), Some(sc), Some(er), Some(ec))
193        {
194            self.add_range_dependent_edges(table_vertex, &[r.into_owned()], range.start.sheet_id);
195        }
196    }
197}
formualizer_eval/engine/graph/tables.rs

formualizer_eval/engine/graph/
tables.rs
