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(crate) struct TableEntry {
15    pub(crate) name: String,
16    pub(crate) range: RangeRef,
17    pub(crate) header_row: bool,
18    pub(crate) headers: Vec<String>,
19    pub(crate) totals_row: bool,
20    pub(crate) 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(crate) 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(crate) 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    /// Canonical names of every defined table, sorted for deterministic output.
69    pub fn table_names(&self) -> Vec<String> {
70        let mut names: Vec<String> = self.tables.values().map(|t| t.name.clone()).collect();
71        names.sort();
72        names
73    }
74
75    pub fn define_table(
76        &mut self,
77        name: &str,
78        range: RangeRef,
79        header_row: bool,
80        headers: Vec<String>,
81        totals_row: bool,
82    ) -> Result<(), ExcelError> {
83        if name.is_empty() {
84            return Err(ExcelError::new(ExcelErrorKind::Name)
85                .with_message("Table name cannot be empty".to_string()));
86        }
87
88        let key = self.table_lookup_key(name);
89        if let Some(existing) = self.tables_lookup.get(&key) {
90            return Err(ExcelError::new(ExcelErrorKind::Name).with_message(format!(
91                "Table collision under normalization: '{name}' conflicts with '{existing}'"
92            )));
93        }
94
95        // A table has a range, but the *vertex* that represents the table symbol has no
96        // position: it is identified by name. Parking it on the range's anchor cell put it
97        // in the sheet index, where grid queries and structural edits could reach it (#304).
98        // Dependencies on the table's cells are carried by the stripe registration below.
99        let sheet_id = range.start.sheet_id;
100        let vertex = self.allocate_symbol_vertex(VertexKind::Table, sheet_id);
101
102        // Register stripes for the full table region so cell edits inside the table
103        // propagate to formulas that depend on the table.
104        self.register_table_range_deps(vertex, &range);
105
106        let entry = TableEntry {
107            name: name.to_string(),
108            range,
109            header_row,
110            headers,
111            totals_row,
112            vertex,
113        };
114
115        let original = name.to_string();
116        self.tables.insert(original.clone(), entry);
117        self.tables_lookup
118            .insert(self.table_lookup_key(&original), original.clone());
119        self.table_vertex_lookup.insert(vertex, original);
120        self.bump_symbol_revision();
121        Ok(())
122    }
123
124    pub fn update_table(
125        &mut self,
126        name: &str,
127        new_range: RangeRef,
128        header_row: bool,
129        headers: Vec<String>,
130        totals_row: bool,
131    ) -> Result<(), ExcelError> {
132        let Some(canon) = self.canonical_table_name(name) else {
133            return Err(ExcelError::new(ExcelErrorKind::Name)
134                .with_message(format!("Unknown table: {name}")));
135        };
136
137        let vertex = self.tables.get(&canon).map(|t| t.vertex).ok_or_else(|| {
138            ExcelError::new(ExcelErrorKind::Name).with_message(format!("Unknown table: {name}"))
139        })?;
140
141        // Replace range deps (cleans old stripes).
142        self.remove_dependent_edges(vertex);
143        self.register_table_range_deps(vertex, &new_range);
144
145        if let Some(existing) = self.tables.get_mut(&canon) {
146            existing.range = new_range;
147            existing.header_row = header_row;
148            existing.headers = headers;
149            existing.totals_row = totals_row;
150        }
151
152        // Propagate to dependents.
153        self.mark_dirty(vertex);
154        self.bump_symbol_revision();
155        Ok(())
156    }
157
158    pub fn delete_table(&mut self, name: &str) -> Result<(), ExcelError> {
159        let Some(canon) = self.canonical_table_name(name) else {
160            return Err(ExcelError::new(ExcelErrorKind::Name)
161                .with_message(format!("Unknown table: {name}")));
162        };
163
164        let Some(entry) = self.tables.remove(&canon) else {
165            return Err(ExcelError::new(ExcelErrorKind::Name)
166                .with_message(format!("Unknown table: {name}")));
167        };
168
169        self.tables_lookup.remove(&self.table_lookup_key(&canon));
170
171        let vertex = entry.vertex;
172        self.table_vertex_lookup.remove(&vertex);
173
174        // Clean range deps / stripes.
175        self.remove_dependent_edges(vertex);
176
177        // Mark deleted for debuggability; edges already removed.
178        self.store.mark_deleted(vertex, true);
179        self.vertex_values.remove(&vertex);
180        self.vertex_formulas.remove(&vertex);
181        self.clear_formula_vertex_dirty(vertex);
182        self.volatile_vertices.remove(&vertex);
183        self.bump_symbol_revision();
184
185        Ok(())
186    }
187
188    fn register_table_range_deps(&mut self, table_vertex: VertexId, range: &RangeRef) {
189        use crate::reference::SharedRangeRef;
190        use crate::reference::SharedSheetLocator;
191        use formualizer_common::AxisBound;
192
193        // Reuse the same range-deps machinery as formulas/names.
194        let sheet_loc = SharedSheetLocator::Id(range.start.sheet_id);
195        let sr = AxisBound::new(range.start.coord.row(), range.start.coord.row_abs());
196        let sc = AxisBound::new(range.start.coord.col(), range.start.coord.col_abs());
197        let er = AxisBound::new(range.end.coord.row(), range.end.coord.row_abs());
198        let ec = AxisBound::new(range.end.coord.col(), range.end.coord.col_abs());
199
200        if let Ok(r) = SharedRangeRef::from_parts(sheet_loc, Some(sr), Some(sc), Some(er), Some(ec))
201        {
202            self.add_range_dependent_edges(table_vertex, &[r.into_owned()], range.start.sheet_id);
203        }
204    }
205}
formualizer_eval/engine/graph/tables.rs

formualizer_eval/engine/graph/
tables.rs
