formualizer-workbook 0.5.4

Ergonomic workbook API over the Formualizer engine (sheets, loaders, staging, undo/redo)
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
use crate::traits::{
    AccessGranularity, BackendCaps, CellData, NamedRange, NamedRangeScope, SheetData,
    SpreadsheetReader, SpreadsheetWriter,
};
use chrono::Timelike;
use formualizer_common::{ExcelError, ExcelErrorKind, LiteralValue, RangeAddress};
use formualizer_parse::parser::ReferenceType;
use parking_lot::RwLock;
use std::collections::BTreeMap;
use std::collections::HashMap;
use std::collections::HashSet;
use std::io::{Cursor, Read, Seek};
use std::path::Path;
use umya_spreadsheet::{
    CellRawValue, CellValue, Spreadsheet,
    reader::xlsx,
    structs::{DefinedName as UmyaDefinedName, Worksheet},
};

use crate::traits::{DefinedName as WorkbookDefinedName, DefinedNameDefinition, DefinedNameScope};

type FormulaBatch = (String, Vec<(u32, u32, formualizer_parse::ASTNode)>);

/// Owned cache-write update used by batch formula-cache APIs.
#[derive(Clone, Debug, PartialEq)]
pub struct FormulaCacheUpdate {
    pub sheet: String,
    pub row: u32,
    pub col: u32,
    pub value: LiteralValue,
}

/// Borrowed cache-write update used by zero-copy batch formula-cache APIs.
#[derive(Clone, Copy, Debug)]
pub struct FormulaCacheUpdateRef<'a> {
    pub sheet: &'a str,
    pub row: u32,
    pub col: u32,
    pub value: &'a LiteralValue,
}

pub struct UmyaAdapter {
    workbook: RwLock<Spreadsheet>,
    lazy: bool,
    original_path: Option<std::path::PathBuf>,

    // Best-effort: parse `headerRowCount` from xl/tables/*.xml.
    // Key: table name (as stored in XLSX); Value: header_row bool.
    table_header_rows: HashMap<String, bool>,
    table_header_rows_available: bool,
}

impl UmyaAdapter {
    const EXCEL_MAX_ROWS: u32 = 1_048_576;
    const EXCEL_MAX_COLS: u32 = 16_384;

    fn extract_attr(tag: &str, key: &str) -> Option<String> {
        let needle_dq = format!("{key}=\"");
        if let Some(pos) = tag.find(&needle_dq) {
            let start = pos + needle_dq.len();
            let rest = &tag[start..];
            if let Some(end) = rest.find('"') {
                return Some(rest[..end].to_string());
            }
        }
        let needle_sq = format!("{key}='");
        if let Some(pos) = tag.find(&needle_sq) {
            let start = pos + needle_sq.len();
            let rest = &tag[start..];
            if let Some(end) = rest.find('\'') {
                return Some(rest[..end].to_string());
            }
        }
        None
    }

    fn parse_table_tag(xml: &str) -> Option<(String, bool)> {
        let start = xml.find("<table")?;
        let after = &xml[start..];
        let end = after.find('>')?;
        let tag = &after[..end];

        let name =
            Self::extract_attr(tag, "name").or_else(|| Self::extract_attr(tag, "displayName"))?;

        let header_row = match Self::extract_attr(tag, "headerRowCount") {
            None => true,
            Some(v) => v.parse::<u32>().ok().map(|n| n != 0).unwrap_or(true),
        };
        Some((name, header_row))
    }

    #[inline]
    fn clamp_excel_row(row_1based: u32) -> u32 {
        row_1based.clamp(1, Self::EXCEL_MAX_ROWS)
    }

    #[inline]
    fn clamp_excel_col(col_1based: u32) -> u32 {
        col_1based.clamp(1, Self::EXCEL_MAX_COLS)
    }

    #[inline]
    fn clamp_excel_cell(row_1based: u32, col_1based: u32) -> (u32, u32) {
        (
            Self::clamp_excel_row(row_1based),
            Self::clamp_excel_col(col_1based),
        )
    }

    fn normalize_open_ended_bounds(
        start_row: Option<u32>,
        start_col: Option<u32>,
        end_row: Option<u32>,
        end_col: Option<u32>,
    ) -> Option<(u32, u32, u32, u32)> {
        let mut sr = start_row;
        let mut sc = start_col;
        let mut er = end_row;
        let mut ec = end_col;

        if sr.is_none() && er.is_none() {
            sr = Some(1);
            er = Some(Self::EXCEL_MAX_ROWS);
        }
        if sc.is_none() && ec.is_none() {
            sc = Some(1);
            ec = Some(Self::EXCEL_MAX_COLS);
        }

        if sr.is_some() && er.is_none() {
            er = Some(Self::EXCEL_MAX_ROWS);
        }
        if er.is_some() && sr.is_none() {
            sr = Some(1);
        }

        if sc.is_some() && ec.is_none() {
            ec = Some(Self::EXCEL_MAX_COLS);
        }
        if ec.is_some() && sc.is_none() {
            sc = Some(1);
        }

        let mut sr = sr?;
        let mut sc = sc?;
        let mut er = er?;
        let mut ec = ec?;

        sr = Self::clamp_excel_row(sr);
        sc = Self::clamp_excel_col(sc);
        er = Self::clamp_excel_row(er);
        ec = Self::clamp_excel_col(ec);

        if er < sr || ec < sc {
            return None;
        }

        Some((sr, sc, er, ec))
    }

    fn read_table_header_rows_from_reader<R: Read + Seek>(
        reader: R,
    ) -> Result<HashMap<String, bool>, std::io::Error> {
        let mut archive = zip::ZipArchive::new(reader)
            .map_err(|e| std::io::Error::new(std::io::ErrorKind::InvalidData, e))?;

        let mut out: HashMap<String, bool> = HashMap::new();
        for i in 0..archive.len() {
            let mut entry = archive
                .by_index(i)
                .map_err(|e| std::io::Error::new(std::io::ErrorKind::InvalidData, e))?;
            let name = entry.name().to_string();
            if !name.starts_with("xl/tables/") || !name.ends_with(".xml") {
                continue;
            }

            let mut xml = String::new();
            entry.read_to_string(&mut xml)?;
            if let Some((tname, header_row)) = Self::parse_table_tag(&xml) {
                out.insert(tname, header_row);
            }
        }

        Ok(out)
    }

    fn convert_cell_value(cv: &CellValue) -> Option<LiteralValue> {
        // Value portion
        let raw = cv.get_raw_value();
        // Skip empty
        if raw.is_empty() {
            return None;
        }
        // Errors
        if raw.is_error() {
            // Map string representation -> error kind
            let txt = cv.get_value();
            let kind = match txt.as_ref() {
                "#DIV/0!" => ExcelErrorKind::Div,
                "#N/A" => ExcelErrorKind::Na,
                "#NAME?" => ExcelErrorKind::Name,
                "#NULL!" => ExcelErrorKind::Null,
                "#NUM!" => ExcelErrorKind::Num,
                "#REF!" => ExcelErrorKind::Ref,
                "#VALUE!" => ExcelErrorKind::Value,
                _ => ExcelErrorKind::Value,
            };
            return Some(LiteralValue::Error(ExcelError::new(kind)));
        }
        match raw {
            CellRawValue::Numeric(n) => Some(LiteralValue::Number(*n)),
            CellRawValue::Bool(b) => Some(LiteralValue::Boolean(*b)),
            CellRawValue::String(s) => Some(LiteralValue::Text(s.to_string())),
            CellRawValue::RichText(rt) => Some(LiteralValue::Text(rt.get_text().to_string())),
            CellRawValue::Lazy(s) => {
                // attempt parse
                let txt = s.as_ref();
                if let Ok(n) = txt.parse::<f64>() {
                    Some(LiteralValue::Number(n))
                } else if txt.eq_ignore_ascii_case("TRUE") {
                    Some(LiteralValue::Boolean(true))
                } else if txt.eq_ignore_ascii_case("FALSE") {
                    Some(LiteralValue::Boolean(false))
                } else {
                    Some(LiteralValue::Text(txt.to_string()))
                }
            }
            CellRawValue::Error(_) => unreachable!(),
            CellRawValue::Empty => None,
        }
    }

    fn table_header_row_for(&self, table_name: &str) -> bool {
        if let Some(v) = self.table_header_rows.get(table_name) {
            return *v;
        }

        // Keep the availability flag live even when `tracing` is disabled.
        let available = self.table_header_rows_available;
        if !available {
            // no-op
        }

        #[cfg(feature = "tracing")]
        {
            if available {
                tracing::warn!(
                    table = table_name,
                    "umya: table headerRowCount not found; assuming header_row=true"
                );
            } else {
                tracing::warn!(
                    table = table_name,
                    "umya: table headerRowCount unavailable; assuming header_row=true"
                );
            }
        }

        true
    }

    fn read_table_header_rows_from_xlsx(
        path: &Path,
    ) -> Result<HashMap<String, bool>, std::io::Error> {
        use std::fs::File;
        let file = File::open(path)?;
        Self::read_table_header_rows_from_reader(file)
    }

    /// Enumerate all formula cells currently present in the workbook DOM.
    pub fn formula_cells(&self) -> Vec<(String, u32, u32)> {
        let mut wb = self.workbook.write();
        let count = wb.get_sheet_count();
        let mut out: Vec<(String, u32, u32)> = Vec::new();
        for i in 0..count {
            wb.read_sheet(i);
            let Some(ws) = wb.get_sheet(&i) else {
                continue;
            };
            let sheet_name = ws.get_name().to_string();
            for cell in ws.get_cell_collection() {
                if !cell.is_formula() {
                    continue;
                }
                let coord = cell.get_coordinate();
                out.push((
                    sheet_name.clone(),
                    *coord.get_row_num(),
                    *coord.get_col_num(),
                ));
            }
        }
        out
    }

    fn write_formula_cache_to_sheet(
        ws: &mut Worksheet,
        row: u32,
        col: u32,
        value: &LiteralValue,
        date_system: formualizer_eval::engine::DateSystem,
    ) {
        let cell = ws.get_cell_mut((col, row));
        if !cell.is_formula() {
            return;
        }

        let formula_obj = cell.get_formula_obj().cloned();
        let mut cv = cell.get_cell_value().clone();

        match value {
            LiteralValue::Empty => {
                cv.set_blank();
            }
            LiteralValue::Int(i) => {
                cv.set_value_number(*i as f64);
            }
            LiteralValue::Number(n) => {
                cv.set_value_number(*n);
            }
            LiteralValue::Boolean(b) => {
                cv.set_value_bool(*b);
            }
            LiteralValue::Text(s) => {
                cv.set_value_string(s.clone());
            }
            LiteralValue::Error(e) => {
                cv.set_error(e.kind.to_string());
            }
            LiteralValue::Date(d) => {
                let dt = d.and_hms_opt(0, 0, 0).unwrap();
                let serial =
                    formualizer_eval::builtins::datetime::datetime_to_serial_for(date_system, &dt);
                cv.set_value_number(serial);
            }
            LiteralValue::DateTime(dt) => {
                let serial =
                    formualizer_eval::builtins::datetime::datetime_to_serial_for(date_system, dt);
                cv.set_value_number(serial);
            }
            LiteralValue::Time(t) => {
                let serial = t.num_seconds_from_midnight() as f64 / 86_400.0;
                cv.set_value_number(serial);
            }
            LiteralValue::Duration(d) => {
                let serial = d.num_seconds() as f64 / 86_400.0;
                cv.set_value_number(serial);
            }
            LiteralValue::Pending | LiteralValue::Array(_) => {
                cv.set_error(ExcelErrorKind::Value.to_string());
            }
        }

        if let Some(formula) = formula_obj {
            cv.set_formula_obj(formula);
        }

        cell.set_cell_value(cv);
    }

    /// Write cached values for formula cells in a single workbook lock, amortizing
    /// sheet lookup/deserialization across updates.
    pub fn set_formula_cached_values_batch<'a, I>(
        &mut self,
        updates: I,
        date_system: formualizer_eval::engine::DateSystem,
    ) -> Result<(), umya_spreadsheet::XlsxError>
    where
        I: IntoIterator<Item = FormulaCacheUpdateRef<'a>>,
    {
        let mut grouped: BTreeMap<&str, Vec<(u32, u32, &LiteralValue)>> = BTreeMap::new();
        for update in updates {
            grouped
                .entry(update.sheet)
                .or_default()
                .push((update.row, update.col, update.value));
        }

        if grouped.is_empty() {
            return Ok(());
        }

        let mut wb = self.workbook.write();
        for (sheet, cells) in grouped {
            wb.read_sheet_by_name(sheet);
            let ws = wb
                .get_sheet_by_name_mut(sheet)
                .ok_or_else(|| umya_spreadsheet::XlsxError::CellError("sheet not found".into()))?;

            for (row, col, value) in cells {
                Self::write_formula_cache_to_sheet(ws, row, col, value, date_system);
            }
        }

        Ok(())
    }

    /// Owned variant of [`Self::set_formula_cached_values_batch`].
    pub fn write_formula_caches_batch(
        &mut self,
        updates: &[FormulaCacheUpdate],
        date_system: formualizer_eval::engine::DateSystem,
    ) -> Result<(), umya_spreadsheet::XlsxError> {
        self.set_formula_cached_values_batch(
            updates.iter().map(|u| FormulaCacheUpdateRef {
                sheet: &u.sheet,
                row: u.row,
                col: u.col,
                value: &u.value,
            }),
            date_system,
        )
    }

    /// Backward-compatible single-cell cache write API.
    pub fn set_formula_cached_value(
        &mut self,
        sheet: &str,
        row: u32,
        col: u32,
        value: &LiteralValue,
        date_system: formualizer_eval::engine::DateSystem,
    ) -> Result<(), umya_spreadsheet::XlsxError> {
        self.set_formula_cached_values_batch(
            std::iter::once(FormulaCacheUpdateRef {
                sheet,
                row,
                col,
                value,
            }),
            date_system,
        )
    }
}

impl SpreadsheetReader for UmyaAdapter {
    type Error = umya_spreadsheet::XlsxError;

    fn access_granularity(&self) -> AccessGranularity {
        AccessGranularity::Sheet
    }

    fn capabilities(&self) -> BackendCaps {
        BackendCaps {
            read: true,
            write: true,
            formulas: true,
            lazy_loading: self.lazy,
            random_access: false,
            styles: true,
            bytes_input: true,
            ..Default::default()
        }
    }

    fn sheet_names(&self) -> Result<Vec<String>, Self::Error> {
        // Need write lock to deserialize sheets lazily
        let mut wb = self.workbook.write();
        let count = wb.get_sheet_count();
        let mut names = Vec::with_capacity(count);
        for i in 0..count {
            wb.read_sheet(i); // ensure sheet deserialized
            if let Some(s) = wb.get_sheet(&i) {
                names.push(s.get_name().to_string());
            }
        }
        Ok(names)
    }

    fn defined_names(&mut self) -> Result<Vec<WorkbookDefinedName>, Self::Error> {
        let mut wb = self.workbook.write();
        let count = wb.get_sheet_count();
        for i in 0..count {
            wb.read_sheet(i);
        }

        let mut sheet_names: Vec<String> = Vec::with_capacity(count);
        for i in 0..count {
            if let Some(s) = wb.get_sheet(&i) {
                sheet_names.push(s.get_name().to_string());
            }
        }

        let mut out: Vec<WorkbookDefinedName> = Vec::new();
        let mut seen: HashSet<(DefinedNameScope, Option<String>, String)> = HashSet::new();

        // Sheet-level names (if present)
        for i in 0..count {
            let Some(ws) = wb.get_sheet(&i) else {
                continue;
            };
            let declared_on = ws.get_name();
            for dn in ws.get_defined_names() {
                if let Some(converted) =
                    Self::convert_defined_name_stable(dn, Some(declared_on), &sheet_names)
                {
                    let key = (
                        converted.scope.clone(),
                        converted.scope_sheet.clone(),
                        converted.name.clone(),
                    );
                    if seen.insert(key) {
                        out.push(converted);
                    }
                }
            }
        }

        // Workbook-level names
        for dn in wb.get_defined_names() {
            if let Some(converted) = Self::convert_defined_name_stable(dn, None, &sheet_names) {
                let key = (
                    converted.scope.clone(),
                    converted.scope_sheet.clone(),
                    converted.name.clone(),
                );
                if seen.insert(key) {
                    out.push(converted);
                }
            }
        }

        Ok(out)
    }

    fn open_path<P: AsRef<Path>>(path: P) -> Result<Self, Self::Error>
    where
        Self: Sized,
    {
        // Prefer lazy read for large files; expose both later
        // Use full read (not lazy) so that save operations don't hit deserialization assertions
        let sheet = xlsx::read(path.as_ref())?;

        // Umya doesn't currently expose header-row metadata, so we parse it from the XLSX zip.
        // If we fail, we keep the previous (Excel default) behavior by assuming `header_row=true`.
        let (table_header_rows, table_header_rows_available) =
            match Self::read_table_header_rows_from_xlsx(path.as_ref()) {
                Ok(m) => (m, true),
                Err(_) => (HashMap::new(), false),
            };
        Ok(Self {
            workbook: RwLock::new(sheet),
            lazy: false,
            original_path: Some(path.as_ref().to_path_buf()),
            table_header_rows,
            table_header_rows_available,
        })
    }

    fn open_reader(mut reader: Box<dyn Read + Send + Sync>) -> Result<Self, Self::Error>
    where
        Self: Sized,
    {
        let mut data = Vec::new();
        reader
            .read_to_end(&mut data)
            .map_err(umya_spreadsheet::XlsxError::Io)?;
        Self::open_bytes(data)
    }

    fn open_bytes(data: Vec<u8>) -> Result<Self, Self::Error>
    where
        Self: Sized,
    {
        let (table_header_rows, table_header_rows_available) =
            match Self::read_table_header_rows_from_reader(Cursor::new(data.as_slice())) {
                Ok(m) => (m, true),
                Err(_) => (HashMap::new(), false),
            };
        let sheet = xlsx::read_reader(Cursor::new(data), true)?;

        Ok(Self {
            workbook: RwLock::new(sheet),
            lazy: false,
            original_path: None,
            table_header_rows,
            table_header_rows_available,
        })
    }

    fn read_range(
        &mut self,
        sheet: &str,
        start: (u32, u32),
        end: (u32, u32),
    ) -> Result<BTreeMap<(u32, u32), CellData>, Self::Error> {
        // Fallback: read whole sheet then filter
        let data = self.read_sheet(sheet)?;
        Ok(data
            .cells
            .into_iter()
            .filter(|((r, c), _)| *r >= start.0 && *r <= end.0 && *c >= start.1 && *c <= end.1)
            .collect())
    }

    fn read_sheet(&mut self, sheet: &str) -> Result<SheetData, Self::Error> {
        let mut wb = self.workbook.write();
        // Ensure sheet deserialized
        wb.read_sheet_by_name(sheet);
        let ws = wb
            .get_sheet_by_name(sheet)
            .ok_or_else(|| umya_spreadsheet::XlsxError::CellError("sheet not found".into()))?;
        let mut cells_map: BTreeMap<(u32, u32), CellData> = BTreeMap::new();
        for cell in ws.get_cell_collection() {
            // returns Vec<&Cell>
            let coord = cell.get_coordinate();
            let col = *coord.get_col_num();
            let row = *coord.get_row_num();
            let cv = cell.get_cell_value();
            let formula = if cv.is_formula() {
                let f = cv.get_formula();
                if f.is_empty() {
                    None
                } else {
                    Some(if f.starts_with('=') {
                        f.to_string()
                    } else {
                        format!("={}", f)
                    })
                }
            } else {
                None
            };
            let value = Self::convert_cell_value(cv);
            if value.is_none() && formula.is_none() {
                continue;
            }
            cells_map.insert(
                (row, col),
                CellData {
                    value,
                    formula,
                    style: None,
                },
            );
        }
        let mut row_hidden_manual: Vec<u32> = ws
            .get_row_dimensions_to_hashmap()
            .iter()
            .filter_map(|(row, row_dim)| {
                if *row_dim.get_hidden() {
                    Some(*row)
                } else {
                    None
                }
            })
            .collect();
        row_hidden_manual.sort_unstable();

        let dims = cells_map.keys().fold((0u32, 0u32), |mut acc, (r, c)| {
            if *r > acc.0 {
                acc.0 = *r;
            }
            if *c > acc.1 {
                acc.1 = *c;
            }
            acc
        });
        Ok(SheetData {
            cells: cells_map,
            dimensions: Some(dims),
            tables: self.collect_tables(ws),
            named_ranges: Self::collect_named_ranges(sheet, &wb, ws),
            date_system_1904: false,
            merged_cells: vec![],
            hidden: false,
            row_hidden_manual,
            row_hidden_filter: vec![],
        })
    }

    fn sheet_bounds(&self, sheet: &str) -> Option<(u32, u32)> {
        let wb = self.workbook.read();
        let ws = wb.get_sheet_by_name(sheet)?;
        let mut max_r = 0;
        let mut max_c = 0;
        for cell in ws.get_cell_collection() {
            let coord = cell.get_coordinate();
            let r = *coord.get_row_num();
            let c = *coord.get_col_num();
            if r > max_r {
                max_r = r;
            }
            if c > max_c {
                max_c = c;
            }
        }
        Some((max_r, max_c))
    }

    fn is_loaded(&self, sheet: &str, _row: Option<u32>, _col: Option<u32>) -> bool {
        // In lazy mode, after first read_sheet call it's loaded; simplistic: if deserialized
        let wb = self.workbook.read();
        wb.get_sheet_by_name(sheet).is_some()
    }
}

impl SpreadsheetWriter for UmyaAdapter {
    type Error = umya_spreadsheet::XlsxError;

    fn write_cell(
        &mut self,
        sheet: &str,
        row: u32,
        col: u32,
        data: CellData,
    ) -> Result<(), Self::Error> {
        let mut wb = self.workbook.write();
        // If sheet missing create before any deserialize attempts
        if wb.get_sheet_by_name(sheet).is_none() {
            let _ = wb.new_sheet(sheet);
            // Ensure it's marked deserialized for writer
            wb.read_sheet_collection();
        }
        // Now safely attempt to access mut sheet
        let ws = wb.get_sheet_by_name_mut(sheet).ok_or_else(|| {
            umya_spreadsheet::XlsxError::CellError("sheet create/load failure".into())
        })?;
        // umya uses (col,row)
        let cell = ws.get_cell_mut((col, row));
        if let Some(v) = data.value {
            match v {
                LiteralValue::Number(n) => {
                    cell.set_value_number(n);
                }
                LiteralValue::Int(i) => {
                    cell.set_value_number(i as f64);
                }
                LiteralValue::Boolean(b) => {
                    cell.set_value_bool(b);
                }
                LiteralValue::Text(s) => {
                    cell.set_value(s);
                }
                LiteralValue::Error(e) => {
                    cell.set_value(e.kind.to_string());
                }
                LiteralValue::Empty => {
                    cell.set_blank();
                }
                LiteralValue::Array(_arr) => {
                    // Flatten first element as placeholder (TODO: proper array spill to grid)
                    cell.set_value("#ARRAY");
                }
                LiteralValue::Date(d) => {
                    cell.set_value(d.to_string());
                }
                LiteralValue::DateTime(dt) => {
                    cell.set_value(dt.to_string());
                }
                LiteralValue::Time(t) => {
                    cell.set_value(t.format("%H:%M:%S").to_string());
                }
                LiteralValue::Duration(dur) => {
                    cell.set_value(format!("PT{}S", dur.num_seconds()));
                }
                LiteralValue::Pending => {
                    cell.set_value("#PENDING");
                }
            }
        } else {
            // Clear value if none provided
            cell.set_blank();
        }
        if let Some(f) = data.formula {
            if let Some(stripped) = f.strip_prefix('=') {
                cell.set_formula(stripped); // umya stores formula without leading '='
            } else {
                cell.set_formula(f);
            }
        }
        Ok(())
    }

    fn write_range(
        &mut self,
        sheet: &str,
        cells: BTreeMap<(u32, u32), CellData>,
    ) -> Result<(), Self::Error> {
        for ((r, c), cd) in cells.into_iter() {
            self.write_cell(sheet, r, c, cd)?;
        }
        Ok(())
    }

    fn clear_range(
        &mut self,
        sheet: &str,
        start: (u32, u32),
        end: (u32, u32),
    ) -> Result<(), Self::Error> {
        let mut wb = self.workbook.write();
        wb.read_sheet_by_name(sheet);
        let ws = match wb.get_sheet_by_name_mut(sheet) {
            Some(s) => s,
            None => return Ok(()), // nothing to clear
        };
        for r in start.0..=end.0 {
            for c in start.1..=end.1 {
                ws.get_cell_mut((c, r)).set_blank();
            }
        }
        Ok(())
    }

    fn create_sheet(&mut self, name: &str) -> Result<(), Self::Error> {
        let mut wb = self.workbook.write();
        if wb.get_sheet_by_name(name).is_none() {
            let _ = wb.new_sheet(name);
        }
        Ok(())
    }

    fn delete_sheet(&mut self, name: &str) -> Result<(), Self::Error> {
        let mut wb = self.workbook.write();
        let _ = wb.remove_sheet_by_name(name); // ignore error if sheet not present
        Ok(())
    }

    fn rename_sheet(&mut self, old: &str, new: &str) -> Result<(), Self::Error> {
        let mut wb = self.workbook.write();
        if let Some(s) = wb.get_sheet_by_name_mut(old) {
            s.set_name(new);
        }
        Ok(())
    }

    fn flush(&mut self) -> Result<(), Self::Error> {
        // No-op: writes are already in-memory. Keep for interface parity.
        Ok(())
    }

    fn save_to<'a>(
        &mut self,
        dest: crate::traits::SaveDestination<'a>,
    ) -> Result<Option<Vec<u8>>, Self::Error> {
        use crate::traits::SaveDestination;
        match dest {
            SaveDestination::InPlace => {
                let path = self.original_path.as_ref().ok_or_else(|| {
                    umya_spreadsheet::XlsxError::Io(std::io::Error::new(
                        std::io::ErrorKind::Unsupported,
                        "InPlace save unavailable: no original path",
                    ))
                })?;
                let mut wb = self.workbook.write();
                // Force deserialize each sheet explicitly (more robust than collection helper alone)
                let count = wb.get_sheet_count();
                for i in 0..count {
                    wb.read_sheet(i);
                }
                umya_spreadsheet::writer::xlsx::write(&wb, path)?;
                Ok(None)
            }
            SaveDestination::Path(p) => {
                let mut wb = self.workbook.write();
                let count = wb.get_sheet_count();
                for i in 0..count {
                    wb.read_sheet(i);
                }
                umya_spreadsheet::writer::xlsx::write(&wb, p)?;
                Ok(None)
            }
            SaveDestination::Writer(w) => {
                let mut wb = self.workbook.write();
                let count = wb.get_sheet_count();
                for i in 0..count {
                    wb.read_sheet(i);
                }
                umya_spreadsheet::writer::xlsx::write_writer(&wb, w)?;
                Ok(None)
            }
            SaveDestination::Bytes => {
                let mut wb = self.workbook.write();
                let count = wb.get_sheet_count();
                for i in 0..count {
                    wb.read_sheet(i);
                }
                let mut buf: Vec<u8> = Vec::new();
                umya_spreadsheet::writer::xlsx::write_writer(&wb, &mut buf)?;
                Ok(Some(buf))
            }
        }
    }
}

impl UmyaAdapter {
    fn convert_defined_name_stable(
        defined: &UmyaDefinedName,
        declared_on_sheet: Option<&str>,
        sheet_names: &[String],
    ) -> Option<WorkbookDefinedName> {
        let raw = defined.get_address();
        let mut trimmed = raw.trim();
        if let Some(rest) = trimmed.strip_prefix('=') {
            trimmed = rest.trim();
        }
        if trimmed.is_empty() || trimmed.contains(',') {
            return None;
        }

        // Only support cell/range references for Stage 1.
        let reference = ReferenceType::from_string(trimmed).ok()?;

        // Scope is determined solely by the presence of local_sheet_id in the OOXML.
        // declared_on_sheet is only used as a fallback for resolving an address that
        // omits its sheet prefix — it must not influence the scope classification.
        let scope_sheet = if defined.has_local_sheet_id() {
            let idx = *defined.get_local_sheet_id() as usize;
            sheet_names.get(idx).cloned()
        } else {
            None
        };

        let scope = if scope_sheet.is_some() {
            DefinedNameScope::Sheet
        } else {
            DefinedNameScope::Workbook
        };

        let base_sheet = scope_sheet.as_deref().or(declared_on_sheet);
        let (sheet_name, start_row, start_col, end_row, end_col) = match reference {
            ReferenceType::Cell {
                sheet, row, col, ..
            } => {
                let sheet = sheet.or_else(|| base_sheet.map(|s| s.to_string()))?;
                let (row, col) = Self::clamp_excel_cell(row, col);
                (sheet, row, col, row, col)
            }
            ReferenceType::Range {
                sheet,
                start_row,
                start_col,
                end_row,
                end_col,
                ..
            } => {
                let (sr, sc, er, ec) =
                    Self::normalize_open_ended_bounds(start_row, start_col, end_row, end_col)?;
                let sheet = sheet.or_else(|| base_sheet.map(|s| s.to_string()))?;
                (sheet, sr, sc, er, ec)
            }
            _ => return None,
        };

        let address = RangeAddress::new(sheet_name, start_row, start_col, end_row, end_col).ok()?;

        Some(WorkbookDefinedName {
            name: defined.get_name().to_string(),
            scope,
            scope_sheet,
            definition: DefinedNameDefinition::Range { address },
        })
    }

    fn collect_named_ranges(
        sheet_name: &str,
        workbook: &Spreadsheet,
        worksheet: &Worksheet,
    ) -> Vec<NamedRange> {
        let mut ranges = Vec::new();
        let mut seen: HashSet<(NamedRangeScope, String)> = HashSet::new();

        for defined in worksheet.get_defined_names() {
            if let Some(named) = Self::convert_defined_name(defined, sheet_name) {
                let key = (named.scope.clone(), named.name.clone());
                if seen.insert(key) {
                    ranges.push(named);
                }
            }
        }

        for defined in workbook.get_defined_names() {
            if let Some(named) = Self::convert_defined_name(defined, sheet_name) {
                let key = (named.scope.clone(), named.name.clone());
                if seen.insert(key) {
                    ranges.push(named);
                }
            }
        }

        ranges
    }

    fn collect_tables(&self, worksheet: &Worksheet) -> Vec<crate::traits::TableDefinition> {
        worksheet
            .get_tables()
            .iter()
            .map(|t| {
                let (beg, end) = t.get_area();
                let headers = t
                    .get_columns()
                    .iter()
                    .map(|c| c.get_name().to_string())
                    .collect();

                let name = t.get_name().to_string();
                let header_row = self.table_header_row_for(&name);

                crate::traits::TableDefinition {
                    name,
                    range: (
                        *beg.get_row_num(),
                        *beg.get_col_num(),
                        *end.get_row_num(),
                        *end.get_col_num(),
                    ),
                    header_row,
                    headers,
                    totals_row: *t.get_totals_row_shown(),
                }
            })
            .collect()
    }

    fn convert_defined_name(defined: &UmyaDefinedName, current_sheet: &str) -> Option<NamedRange> {
        let raw = defined.get_address();
        let trimmed = raw.trim();
        if trimmed.is_empty() || trimmed.contains(',') {
            return None;
        }

        let reference = ReferenceType::from_string(trimmed).ok()?;

        let (sheet_name, start_row, start_col, end_row, end_col) = match reference {
            ReferenceType::Cell {
                sheet, row, col, ..
            } => {
                let sheet = sheet.unwrap_or_else(|| current_sheet.to_string());
                let (row, col) = Self::clamp_excel_cell(row, col);
                (sheet, row, col, row, col)
            }
            ReferenceType::Range {
                sheet,
                start_row,
                start_col,
                end_row,
                end_col,
                ..
            } => {
                let (sr, sc, er, ec) =
                    Self::normalize_open_ended_bounds(start_row, start_col, end_row, end_col)?;
                let sheet = sheet.unwrap_or_else(|| current_sheet.to_string());
                (sheet, sr, sc, er, ec)
            }
            _ => return None,
        };

        if sheet_name != current_sheet {
            return None;
        }

        let scope = if defined.has_local_sheet_id() {
            NamedRangeScope::Sheet
        } else {
            NamedRangeScope::Workbook
        };

        let address = RangeAddress::new(sheet_name, start_row, start_col, end_row, end_col).ok()?;

        Some(NamedRange {
            name: defined.get_name().to_string(),
            scope,
            address,
        })
    }
}

impl<R> formualizer_eval::engine::ingest::EngineLoadStream<R> for UmyaAdapter
where
    R: formualizer_eval::traits::EvaluationContext,
{
    type Error = crate::error::IoError;

    fn stream_into_engine(
        &mut self,
        engine: &mut formualizer_eval::engine::Engine<R>,
    ) -> Result<(), Self::Error> {
        use crate::error::IoError;
        use formualizer_eval::arrow_store::IngestBuilder;
        use formualizer_eval::engine::named_range::{NameScope, NamedDefinition};
        use formualizer_eval::reference::{CellRef, Coord};

        let names = self
            .sheet_names()
            .map_err(|e| IoError::from_backend("umya", e))?;
        for n in &names {
            engine.add_sheet(n).map_err(IoError::Engine)?;
        }

        let prev_index_mode = engine.config.sheet_index_mode;
        engine.set_sheet_index_mode(formualizer_eval::engine::SheetIndexMode::Lazy);
        let prev_range_limit = engine.config.range_expansion_limit;
        engine.config.range_expansion_limit = 0;

        engine.set_first_load_assume_new(true);
        engine.reset_ensure_touched();

        let chunk_rows: usize = 32 * 1024;

        let mut eager_formula_batches: Vec<FormulaBatch> = Vec::new();

        for n in &names {
            let sheet_data = self
                .read_sheet(n)
                .map_err(|e| IoError::from_backend("umya", e))?;
            let dims = sheet_data.dimensions.unwrap_or_else(|| {
                sheet_data
                    .cells
                    .keys()
                    .fold((0u32, 0u32), |mut acc, (r, c)| {
                        if *r > acc.0 {
                            acc.0 = *r;
                        }
                        if *c > acc.1 {
                            acc.1 = *c;
                        }
                        acc
                    })
            });
            let rows = dims.0 as usize;
            let cols = dims.1 as usize;

            let mut aib = IngestBuilder::new(n, cols, chunk_rows, engine.config.date_system);
            for r in 1..=rows {
                let mut row_vals = vec![LiteralValue::Empty; cols];
                for c in 1..=cols {
                    if let Some(cd) = sheet_data.cells.get(&(r as u32, c as u32))
                        && let Some(v) = &cd.value
                    {
                        row_vals[c - 1] = v.clone();
                    }
                }
                aib.append_row(&row_vals).map_err(IoError::Engine)?;
            }
            let asheet = aib.finish();
            let store = engine.sheet_store_mut();
            if let Some(pos) = store.sheets.iter().position(|s| s.name.as_ref() == n) {
                store.sheets[pos] = asheet;
            } else {
                store.sheets.push(asheet);
            }

            // Register native tables before formula ingest.
            if let Some(sheet_id) = engine.sheet_id(n) {
                for table in &sheet_data.tables {
                    let (sr, sc, er, ec) = table.range;
                    let sr0 = sr.saturating_sub(1);
                    let sc0 = sc.saturating_sub(1);
                    let er0 = er.saturating_sub(1);
                    let ec0 = ec.saturating_sub(1);
                    let start_ref = CellRef::new(sheet_id, Coord::new(sr0, sc0, true, true));
                    let end_ref = CellRef::new(sheet_id, Coord::new(er0, ec0, true, true));
                    let range_ref = formualizer_eval::reference::RangeRef::new(start_ref, end_ref);
                    engine.define_table(
                        &table.name,
                        range_ref,
                        table.header_row,
                        table.headers.clone(),
                        table.totals_row,
                    )?;
                }
            }

            if engine.config.defer_graph_building {
                for ((row, col), cd) in &sheet_data.cells {
                    if let Some(f) = &cd.formula {
                        if f.is_empty() {
                            continue;
                        }
                        engine.stage_formula_text(n, *row, *col, f.clone());
                    }
                }
            } else {
                let mut formulas: Vec<(u32, u32, formualizer_parse::ASTNode)> = Vec::new();
                for ((row, col), cd) in &sheet_data.cells {
                    if let Some(f) = &cd.formula {
                        if f.is_empty() {
                            continue;
                        }
                        let with_eq = if f.starts_with('=') {
                            f.clone()
                        } else {
                            format!("={f}")
                        };
                        match formualizer_parse::parser::parse(&with_eq) {
                            Ok(parsed) => formulas.push((*row, *col, parsed)),
                            Err(e) => {
                                if let Some(recovered) = engine
                                    .handle_formula_parse_error(
                                        n,
                                        *row,
                                        *col,
                                        &with_eq,
                                        e.to_string(),
                                    )
                                    .map_err(IoError::Engine)?
                                {
                                    formulas.push((*row, *col, recovered));
                                }
                            }
                        }
                    }
                }
                if !formulas.is_empty() {
                    eager_formula_batches.push((n.clone(), formulas));
                }
            }

            for row in &sheet_data.row_hidden_manual {
                engine
                    .set_row_hidden(
                        n,
                        *row,
                        true,
                        formualizer_eval::engine::RowVisibilitySource::Manual,
                    )
                    .map_err(|e| IoError::from_backend("umya", e))?;
            }
            for row in &sheet_data.row_hidden_filter {
                engine
                    .set_row_hidden(
                        n,
                        *row,
                        true,
                        formualizer_eval::engine::RowVisibilitySource::Filter,
                    )
                    .map_err(|e| IoError::from_backend("umya", e))?;
            }
        }

        if !engine.config.defer_graph_building && !eager_formula_batches.is_empty() {
            let mut builder = engine.begin_bulk_ingest();
            for (sheet_name, formulas) in eager_formula_batches {
                let sid = builder.add_sheet(&sheet_name);
                builder.add_formulas(sid, formulas.into_iter());
            }
            builder.finish().map_err(IoError::Engine)?;
        }

        // Register defined names into the dependency graph.
        {
            use rustc_hash::FxHashSet;

            let defined = self
                .defined_names()
                .map_err(|e| IoError::from_backend("umya", e))?;
            let mut seen: FxHashSet<(DefinedNameScope, Option<String>, String)> =
                FxHashSet::default();

            for dn in defined {
                let key = (dn.scope.clone(), dn.scope_sheet.clone(), dn.name.clone());
                if !seen.insert(key) {
                    continue;
                }

                let scope = match dn.scope {
                    DefinedNameScope::Workbook => NameScope::Workbook,
                    DefinedNameScope::Sheet => {
                        let sheet_name =
                            dn.scope_sheet.as_deref().ok_or_else(|| IoError::Backend {
                                backend: "umya".to_string(),
                                message: format!(
                                    "sheet-scoped defined name `{}` missing scope_sheet",
                                    dn.name
                                ),
                            })?;
                        let sid = engine
                            .sheet_id(sheet_name)
                            .ok_or_else(|| IoError::Backend {
                                backend: "umya".to_string(),
                                message: format!("scope sheet not found: {sheet_name}"),
                            })?;
                        NameScope::Sheet(sid)
                    }
                };

                let definition = match dn.definition {
                    DefinedNameDefinition::Range { address } => {
                        let sheet_id = engine
                            .sheet_id(&address.sheet)
                            .or_else(|| engine.add_sheet(&address.sheet).ok())
                            .ok_or_else(|| IoError::Backend {
                                backend: "umya".to_string(),
                                message: format!("sheet not found: {}", address.sheet),
                            })?;

                        let sr0 = address.start_row.saturating_sub(1);
                        let sc0 = address.start_col.saturating_sub(1);
                        let er0 = address.end_row.saturating_sub(1);
                        let ec0 = address.end_col.saturating_sub(1);
                        let start_ref = CellRef::new(sheet_id, Coord::new(sr0, sc0, true, true));
                        if sr0 == er0 && sc0 == ec0 {
                            NamedDefinition::Cell(start_ref)
                        } else {
                            let end_ref = CellRef::new(sheet_id, Coord::new(er0, ec0, true, true));
                            let range_ref =
                                formualizer_eval::reference::RangeRef::new(start_ref, end_ref);
                            NamedDefinition::Range(range_ref)
                        }
                    }
                    DefinedNameDefinition::Literal { value } => NamedDefinition::Literal(value),
                };

                engine.define_name(&dn.name, definition, scope)?;
            }
        }

        for n in &names {
            engine.finalize_sheet_index(n);
        }

        engine.set_first_load_assume_new(false);
        engine.reset_ensure_touched();
        engine.set_sheet_index_mode(prev_index_mode);
        engine.config.range_expansion_limit = prev_range_limit;
        Ok(())
    }
}