formualizer-eval 0.7.0

High-performance Arrow-backed Excel formula engine with dependency graph and incremental recalculation
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
use super::ast_utils::update_internal_sheet_references;
use super::*;
use formualizer_common::{ExcelError, ExcelErrorKind, LiteralValue};

impl DependencyGraph {
    /// Add a new sheet to the workbook.
    ///
    /// Creates a new sheet with the given name. If a sheet with this name
    /// already exists, returns its ID without error (idempotent operation).
    pub fn add_sheet(&mut self, name: &str) -> Result<SheetId, ExcelError> {
        if let Some(id) = self.sheet_reg.get_id(name) {
            return Ok(id);
        }

        let sheet_id = self.sheet_reg.id_for(name);
        self.sheet_indexes.entry(sheet_id).or_default();

        // Heal formulas that were waiting on this sheet name.
        self.heal_orphaned_formulas(name);
        Ok(sheet_id)
    }

    /// Remove a sheet from the workbook.
    pub fn remove_sheet(&mut self, sheet_id: SheetId) -> Result<(), ExcelError> {
        let old_name = self.sheet_reg.name(sheet_id).to_string();
        if old_name.is_empty() {
            return Err(ExcelError::new(ExcelErrorKind::Value).with_message("Sheet does not exist"));
        }

        let sheet_count = self.sheet_reg.all_sheets().len();
        if sheet_count <= 1 {
            return Err(
                ExcelError::new(ExcelErrorKind::Value).with_message("Cannot remove the last sheet")
            );
        }

        self.begin_batch();

        let vertices_to_delete: Vec<VertexId> = self.vertices_in_sheet(sheet_id).collect();

        // Formulas can reference this sheet either through explicit dependency edges
        // (expanded refs) or compressed range deps. Track both.
        let mut formulas_to_update: rustc_hash::FxHashSet<VertexId> =
            rustc_hash::FxHashSet::default();

        for &formula_id in self.vertex_formulas.keys() {
            let deps = self.edges.out_edges(formula_id);
            if deps
                .iter()
                .any(|&dep_id| self.store.sheet_id(dep_id) == sheet_id)
            {
                formulas_to_update.insert(formula_id);
            }
        }

        for (&formula_id, ranges) in &self.formula_to_range_deps {
            if ranges.iter().any(|r| match r.sheet {
                SharedSheetLocator::Id(id) => id == sheet_id,
                SharedSheetLocator::Name(ref n) => n.as_ref() == old_name,
                SharedSheetLocator::Current => false,
            }) {
                formulas_to_update.insert(formula_id);
            }
        }

        let formulas_to_update: Vec<VertexId> = formulas_to_update.into_iter().collect();

        for &formula_id in &formulas_to_update {
            self.tombstone_registry
                .add_orphan(old_name.clone(), formula_id);
            self.rewrite_formula_sheet_to_tombstone(formula_id, &old_name);
        }

        for formula_id in formulas_to_update {
            self.mark_as_ref_error(formula_id);
        }

        // Invalidate defined names that reference the removed sheet.
        //
        // In canonical (Arrow-truth) mode, cell/formula vertices do not cache values in the graph,
        // so we cannot rely on graph-stored ref errors. We must explicitly dirty name vertices and
        // their dependents so that subsequent evaluation updates Arrow overlays.
        let ref_err = LiteralValue::Error(ExcelError::new(ExcelErrorKind::Ref));
        let mut name_vertices_to_update: Vec<VertexId> = Vec::new();
        let mut dirty_vertices: Vec<VertexId> = Vec::new();

        for nr in self.named_ranges.values_mut() {
            match &nr.definition {
                NamedDefinition::Cell(c) if c.sheet_id == sheet_id => {
                    nr.definition = NamedDefinition::Literal(ref_err.clone());
                    name_vertices_to_update.push(nr.vertex);
                    dirty_vertices.push(nr.vertex);
                    dirty_vertices.extend(nr.dependents.iter().copied());
                }
                NamedDefinition::Range(r)
                    if r.start.sheet_id == sheet_id || r.end.sheet_id == sheet_id =>
                {
                    nr.definition = NamedDefinition::Literal(ref_err.clone());
                    name_vertices_to_update.push(nr.vertex);
                    dirty_vertices.push(nr.vertex);
                    dirty_vertices.extend(nr.dependents.iter().copied());
                }
                _ => {}
            }
        }
        for nr in self.sheet_named_ranges.values_mut() {
            match &nr.definition {
                NamedDefinition::Cell(c) if c.sheet_id == sheet_id => {
                    nr.definition = NamedDefinition::Literal(ref_err.clone());
                    name_vertices_to_update.push(nr.vertex);
                    dirty_vertices.push(nr.vertex);
                    dirty_vertices.extend(nr.dependents.iter().copied());
                }
                NamedDefinition::Range(r)
                    if r.start.sheet_id == sheet_id || r.end.sheet_id == sheet_id =>
                {
                    nr.definition = NamedDefinition::Literal(ref_err.clone());
                    name_vertices_to_update.push(nr.vertex);
                    dirty_vertices.push(nr.vertex);
                    dirty_vertices.extend(nr.dependents.iter().copied());
                }
                _ => {}
            }
        }

        // Update cached values for name vertices after the map borrows end.
        for vid in name_vertices_to_update {
            self.update_vertex_value(vid, ref_err.clone());
        }
        for vid in dirty_vertices {
            self.mark_vertex_dirty(vid);
        }

        for vertex_id in vertices_to_delete {
            if let Some(cell_ref) = self.get_cell_ref_for_vertex(vertex_id) {
                self.cell_to_vertex.remove(&cell_ref);
            }

            self.remove_all_edges(vertex_id);

            let coord = self.store.coord(vertex_id);
            if let Some(index) = self.sheet_indexes.get_mut(&sheet_id) {
                index.remove_vertex(coord, vertex_id);
            }

            self.clear_pending_name_references(vertex_id);
            self.vertex_formulas.remove(&vertex_id);
            self.vertex_values.remove(&vertex_id);

            self.mark_deleted(vertex_id, true);
        }

        let sheet_names_to_remove: Vec<(SheetId, String)> = self
            .sheet_named_ranges
            .keys()
            .filter(|(sid, _)| *sid == sheet_id)
            .cloned()
            .collect();

        for key in sheet_names_to_remove {
            if let Some(named_range) = self.sheet_named_ranges.remove(&key) {
                if !self.config.case_sensitive_names {
                    let normalized = key.1.to_lowercase();
                    self.sheet_named_ranges_lookup
                        .remove(&(sheet_id, normalized));
                } else {
                    self.sheet_named_ranges_lookup.remove(&key);
                }
                self.mark_named_vertex_deleted(&named_range);
            }
        }

        self.sheet_indexes.remove(&sheet_id);

        if self.default_sheet_id == sheet_id
            && let Some(&new_default) = self.sheet_indexes.keys().next()
        {
            self.default_sheet_id = new_default;
        }

        self.sheet_reg.remove(sheet_id)?;
        self.end_batch();

        Ok(())
    }

    fn tombstone_marker(sheet_name: &str) -> String {
        format!("__FZ_MISSING_SHEET__{sheet_name}")
    }

    fn rewrite_formula_sheet_to_tombstone(&mut self, vertex_id: VertexId, sheet_name: &str) {
        let Some(ast_id) = self.vertex_formulas.get(&vertex_id).copied() else {
            return;
        };
        let Some(ast) = self.data_store.retrieve_ast(ast_id, &self.sheet_reg) else {
            return;
        };

        let marker = Self::tombstone_marker(sheet_name);
        let mut updated_ast = ast.clone();
        updated_ast.update_sheet_references(Some(sheet_name), &marker);

        if updated_ast != ast {
            let updated_ast_id = self.data_store.store_ast(&updated_ast, &self.sheet_reg);
            self.vertex_formulas.insert(vertex_id, updated_ast_id);
        }
    }

    fn heal_orphaned_formulas(&mut self, sheet_name: &str) {
        let orphans = self.tombstone_registry.take_orphans(sheet_name);
        let marker = Self::tombstone_marker(sheet_name);

        for vertex_id in orphans {
            let Some(ast_id) = self.vertex_formulas.get(&vertex_id).copied() else {
                continue;
            };
            let Some(ast) = self.data_store.retrieve_ast(ast_id, &self.sheet_reg) else {
                continue;
            };

            // If the formula was edited while the sheet was missing, it may no longer
            // be in #REF! state; skip stale orphan entries in that case.
            if !self.is_ref_error(vertex_id) {
                continue;
            }

            // Heal only references that were explicitly tombstoned for this sheet.
            let mut updated_ast = ast.clone();
            updated_ast.update_sheet_references(Some(&marker), sheet_name);

            if updated_ast == ast {
                // Stale orphan entry (formula changed while sheet was missing).
                continue;
            }

            let updated_ast_id = self.data_store.store_ast(&updated_ast, &self.sheet_reg);
            self.vertex_formulas.insert(vertex_id, updated_ast_id);
            self.rebuild_formula_dependencies(vertex_id, &updated_ast);
        }
    }
    /// Rename an existing sheet.
    pub fn rename_sheet(&mut self, sheet_id: SheetId, new_name: &str) -> Result<(), ExcelError> {
        if new_name.is_empty() || new_name.len() > 255 {
            return Err(ExcelError::new(ExcelErrorKind::Value).with_message("Invalid sheet name"));
        }

        let old_name = self.sheet_reg.name(sheet_id).to_string();

        if old_name.is_empty() {
            return Err(ExcelError::new(ExcelErrorKind::Value).with_message("Sheet does not exist"));
        }

        if let Some(existing_id) = self.sheet_reg.get_id(new_name) {
            if existing_id != sheet_id {
                return Err(ExcelError::new(ExcelErrorKind::Value)
                    .with_message(format!("Sheet '{new_name}' already exists")));
            }
            return Ok(());
        }

        self.sheet_reg.rename(sheet_id, new_name)?;

        self.begin_batch();

        // Rescue formulas that were waiting for this exact sheet name to reappear.
        self.heal_orphaned_formulas(new_name);

        // Update still-valid references that explicitly mentioned the renamed sheet.
        let formulas_to_update: Vec<VertexId> = self.vertex_formulas.keys().copied().collect();
        for formula_id in formulas_to_update {
            if let Some(ast_id) = self.vertex_formulas.get(&formula_id)
                && let Some(ast) = self.data_store.retrieve_ast(*ast_id, &self.sheet_reg)
            {
                let mut updated_ast = ast.clone();
                updated_ast.update_sheet_references(Some(&old_name), new_name);

                if ast != updated_ast {
                    self.rebuild_formula_dependencies(formula_id, &updated_ast);
                    let updated_ast_id = self.data_store.store_ast(&updated_ast, &self.sheet_reg);
                    self.vertex_formulas.insert(formula_id, updated_ast_id);
                }
            }
        }

        self.end_batch();
        Ok(())
    }

    /// Duplicate an existing sheet.
    pub fn duplicate_sheet(
        &mut self,
        source_sheet_id: SheetId,
        new_name: &str,
    ) -> Result<SheetId, ExcelError> {
        if new_name.is_empty() || new_name.len() > 255 {
            return Err(ExcelError::new(ExcelErrorKind::Value).with_message("Invalid sheet name"));
        }

        let source_name = self.sheet_reg.name(source_sheet_id).to_string();
        if source_name.is_empty() {
            return Err(
                ExcelError::new(ExcelErrorKind::Value).with_message("Source sheet does not exist")
            );
        }

        if self.sheet_reg.get_id(new_name).is_some() {
            return Err(ExcelError::new(ExcelErrorKind::Value)
                .with_message(format!("Sheet '{new_name}' already exists")));
        }

        let new_sheet_id = self.add_sheet(new_name)?;

        self.begin_batch();

        let source_vertices: Vec<(VertexId, AbsCoord)> = self
            .vertices_in_sheet(source_sheet_id)
            .map(|id| (id, self.store.coord(id)))
            .collect();

        let mut vertex_mapping = FxHashMap::default();

        for (old_id, coord) in &source_vertices {
            let row = coord.row();
            let col = coord.col();
            let kind = self.store.kind(*old_id);

            let new_id = self.store.allocate(*coord, new_sheet_id, 0x01);
            self.edges.add_vertex(*coord, new_id.0);
            self.sheet_index_mut(new_sheet_id)
                .add_vertex(*coord, new_id);

            self.store.set_kind(new_id, kind);

            if let Some(&value_ref) = self.vertex_values.get(old_id) {
                self.vertex_values.insert(new_id, value_ref);
            }

            vertex_mapping.insert(*old_id, new_id);

            let cell_ref = CellRef::new(new_sheet_id, Coord::new(row, col, true, true));
            self.cell_to_vertex.insert(cell_ref, new_id);
        }

        let sheet_names: Vec<(String, NamedRange)> = self
            .sheet_named_ranges
            .iter()
            .filter(|((sid, _), _)| *sid == source_sheet_id)
            .map(|((_, name), range)| (name.clone(), range.clone()))
            .collect();

        for (name, mut named_range) in sheet_names {
            named_range.scope = NameScope::Sheet(new_sheet_id);

            match &mut named_range.definition {
                NamedDefinition::Cell(cell_ref) if cell_ref.sheet_id == source_sheet_id => {
                    cell_ref.sheet_id = new_sheet_id;
                }
                NamedDefinition::Range(range_ref) => {
                    if range_ref.start.sheet_id == source_sheet_id {
                        range_ref.start.sheet_id = new_sheet_id;
                        range_ref.end.sheet_id = new_sheet_id;
                    }
                }
                _ => {}
            }

            named_range.dependents.clear();
            let name_vertex = self.allocate_name_vertex(named_range.scope);
            if matches!(named_range.definition, NamedDefinition::Range(_)) {
                self.store.set_kind(name_vertex, VertexKind::NamedArray);
            } else {
                self.store.set_kind(name_vertex, VertexKind::NamedScalar);
            }
            named_range.vertex = name_vertex;

            let referenced_names = self.rebuild_name_dependencies(
                name_vertex,
                &named_range.definition,
                named_range.scope,
            );
            if !referenced_names.is_empty() {
                self.attach_vertex_to_names(name_vertex, &referenced_names);
            }

            self.sheet_named_ranges
                .insert((new_sheet_id, name.clone()), named_range);
            self.sheet_named_ranges_lookup
                .insert((new_sheet_id, self.name_lookup_key(&name)), name.clone());
            self.name_vertex_lookup
                .insert(name_vertex, (NameScope::Sheet(new_sheet_id), name));
        }

        for (old_id, _) in &source_vertices {
            if let Some(&new_id) = vertex_mapping.get(old_id)
                && let Some(&ast_id) = self.vertex_formulas.get(old_id)
                && let Some(ast) = self.data_store.retrieve_ast(ast_id, &self.sheet_reg)
            {
                let updated_ast = update_internal_sheet_references(
                    &ast,
                    &source_name,
                    new_name,
                    source_sheet_id,
                    new_sheet_id,
                );

                let new_ast_id = self.data_store.store_ast(&updated_ast, &self.sheet_reg);
                self.vertex_formulas.insert(new_id, new_ast_id);

                if let Ok((deps, range_deps, _, name_vertices)) =
                    self.extract_dependencies(&updated_ast, new_sheet_id)
                {
                    let mapped_deps: Vec<VertexId> = deps
                        .iter()
                        .map(|&dep_id| vertex_mapping.get(&dep_id).copied().unwrap_or(dep_id))
                        .collect();

                    self.add_dependent_edges(new_id, &mapped_deps);
                    self.add_range_dependent_edges(new_id, &range_deps, new_sheet_id);

                    if !name_vertices.is_empty() {
                        self.attach_vertex_to_names(new_id, &name_vertices);
                    }
                }
            }
        }

        self.end_batch();

        Ok(new_sheet_id)
    }
}