umya-spreadsheet 3.0.0

umya-spreadsheet is a library written in pure Rust to read and write xlsx file.
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
use std::{
    collections::HashMap,
    io,
    sync::RwLock,
};

use quick_xml::{
    Writer,
    events::{
        BytesDecl,
        Event,
    },
};

use super::{
    XlsxError,
    driver::{
        write_end_tag,
        write_new_line,
        write_start_tag,
    },
};
use crate::{
    Row,
    helper::const_str::{
        MC_NS,
        PKG_SHEET,
        REL_OFC_NS,
        SHEET_DRAWING_NS,
        SHEET_MAIN_NS,
        SHEET_MS_MAIN_NS,
        SHEETML_AC_NS,
    },
    structs::{
        Cell,
        SharedStringTable,
        Stylesheet,
        Worksheet,
        WriterManager,
    },
};

type InternalWriter = Writer<io::Cursor<Vec<u8>>>;

/// Writes a worksheet to the XLSX file format.
///
/// # Arguments
///
/// * `sheet_no` - The sheet number
/// * `worksheet` - The worksheet to write
/// * `shared_string_table` - Table containing shared strings
/// * `stylesheet` - The workbook's stylesheet
/// * `has_macros` - Whether the workbook contains macros
/// * `writer_mng` - The writer manager handling file output
///
/// # Returns
///
/// Returns `Result<(), XlsxError>` indicating success or failure
pub(crate) fn write<W: io::Seek + io::Write>(
    sheet_no: i32,
    worksheet: &Worksheet,
    shared_string_table: &RwLock<SharedStringTable>,
    stylesheet: &mut Stylesheet,
    has_macros: bool,
    writer_mng: &mut WriterManager<W>,
) -> Result<(), XlsxError> {
    let mut writer = Writer::new(io::Cursor::new(Vec::new()));

    write_worksheet_header(&mut writer);
    write_worksheet_properties(&mut writer, worksheet, has_macros);
    write_dimension_and_views(&mut writer, worksheet);
    write_columns_and_rows(&mut writer, worksheet, shared_string_table, stylesheet);
    write_worksheet_features(&mut writer, worksheet, stylesheet);
    write_worksheet_extensions(&mut writer, worksheet);

    write_end_tag(&mut writer, "worksheet");

    let target = format!("{PKG_SHEET}{sheet_no}.xml");
    writer_mng.add_writer(&target, writer)
}

/// Writes the XML header and worksheet opening tag with required namespace
/// declarations.
///
/// # Arguments
///
/// * `writer` - The XML writer to write to
fn write_worksheet_header(writer: &mut InternalWriter) {
    writer
        .write_event(Event::Decl(BytesDecl::new(
            "1.0",
            Some("UTF-8"),
            Some("yes"),
        )))
        .unwrap();
    write_new_line(writer);

    write_start_tag(
        writer,
        "worksheet",
        vec![
            ("xmlns", SHEET_MAIN_NS).into(),
            ("xmlns:r", REL_OFC_NS).into(),
            ("xmlns:xdr", SHEET_DRAWING_NS).into(),
            ("xmlns:x14", SHEET_MS_MAIN_NS).into(),
            ("xmlns:mc", MC_NS).into(),
            ("mc:Ignorable", "x14ac").into(),
            ("xmlns:x14ac", SHEETML_AC_NS).into(),
        ],
        false,
    );
}

/// Writes worksheet properties including sheet protection and tab color
/// settings.
///
/// # Arguments
///
/// * `writer` - The XML writer to write to
/// * `worksheet` - The worksheet containing the properties
/// * `has_macros` - Whether the workbook contains VBA macros
fn write_worksheet_properties(
    writer: &mut InternalWriter,
    worksheet: &Worksheet,
    has_macros: bool,
) {
    let mut attributes: crate::structs::AttrCollection = Vec::new();
    if has_macros {
        let code_name = if worksheet.has_code_name() {
            worksheet.code_name().as_ref().unwrap()
        } else {
            worksheet.name()
        };
        attributes.push(("codeName", code_name).into());
    }

    match worksheet.tab_color() {
        Some(v) => {
            write_start_tag(writer, "sheetPr", attributes, false);
            v.write_to_tab_color(writer);
            write_end_tag(writer, "sheetPr");
        }
        None => {
            if !attributes.is_empty() {
                write_start_tag(writer, "sheetPr", attributes, true);
            }
        }
    }
}

/// Writes the worksheet dimension (used range) and sheet view settings.
///
/// # Arguments
///
/// * `writer` - The XML writer to write to
/// * `worksheet` - The worksheet containing dimension and view settings
fn write_dimension_and_views(writer: &mut InternalWriter, worksheet: &Worksheet) {
    write_start_tag(
        writer,
        "dimension",
        vec![("ref", &worksheet.calculate_worksheet_dimension()).into()],
        true,
    );

    worksheet.sheets_views().write_to(writer);
    worksheet.sheet_format_properties().write_to(writer);
}

/// Writes column definitions and row data including cell contents.
///
/// # Arguments
///
/// * `writer` - The XML writer to write to
/// * `worksheet` - The worksheet containing the data
/// * `shared_string_table` - Table containing shared string values
/// * `stylesheet` - The workbook's stylesheet for formatting
fn write_columns_and_rows(
    writer: &mut InternalWriter,
    worksheet: &Worksheet,
    shared_string_table: &RwLock<SharedStringTable>,
    stylesheet: &mut Stylesheet,
) {
    let mut column_dimensions = worksheet.column_dimensions_crate().clone();
    column_dimensions
        .calculation_auto_width(worksheet.cells_crate(), worksheet.merge_cells_crate());
    column_dimensions.write_to(writer, stylesheet);

    write_sheet_data(writer, worksheet, shared_string_table, stylesheet);
}

/// Writes the sheet data section containing rows and cells.
///
/// # Arguments
///
/// * `writer` - The XML writer to write to
/// * `worksheet` - The worksheet containing the data
/// * `shared_string_table` - Table containing shared string values
/// * `stylesheet` - The workbook's stylesheet for formatting
fn write_sheet_data(
    writer: &mut InternalWriter,
    worksheet: &Worksheet,
    shared_string_table: &RwLock<SharedStringTable>,
    stylesheet: &mut Stylesheet,
) {
    let has_sheet_data = worksheet.has_sheet_data();
    write_start_tag(writer, "sheetData", vec![], !has_sheet_data);

    let mut row_dimensions = worksheet.row_dimensions();
    row_dimensions.sort_by_key(|a| a.row_num());
    let cells = worksheet.cells_sorted();
    let formula_shared_list = build_formula_shared_list(&cells);
    write_rows_and_cells(
        writer,
        &row_dimensions,
        &cells,
        shared_string_table,
        stylesheet,
        &formula_shared_list,
    );

    if has_sheet_data {
        write_end_tag(writer, "sheetData");
    }
}

/// Creates a map of shared formulas indexed by their shared formula ID.
///
/// # Arguments
///
/// * `cells` - Slice of cell references to process
///
/// # Returns
///
/// A `HashMap` mapping formula IDs to tuples of (`start_cell_ref`,
/// `end_cell_ref`)
fn build_formula_shared_list(cells: &[&Cell]) -> HashMap<u32, (String, Option<String>)> {
    let mut formula_shared_list: HashMap<u32, (String, Option<String>)> = HashMap::new();
    for cell in cells {
        if let Some(si) = cell.formula_shared_index() {
            match formula_shared_list.get(&si) {
                Some((start_cell, _)) => {
                    formula_shared_list.insert(
                        si,
                        (start_cell.clone(), Some(cell.coordinate().get_coordinate())),
                    );
                }
                None => {
                    formula_shared_list.insert(si, (cell.coordinate().get_coordinate(), None));
                }
            }
        }
    }
    formula_shared_list
}

/// Writes worksheet features including protection, filters, merged cells, and
/// conditional formatting.
///
/// # Arguments
///
/// * `writer` - The XML writer to write to
/// * `worksheet` - The worksheet containing the features
/// * `stylesheet` - The workbook's stylesheet for formatting
fn write_worksheet_features(
    writer: &mut InternalWriter,
    worksheet: &Worksheet,
    stylesheet: &mut Stylesheet,
) {
    if let Some(v) = worksheet.sheet_protection() {
        v.write_to(writer);
    }

    if let Some(v) = worksheet.auto_filter() {
        write_start_tag(
            writer,
            "autoFilter",
            vec![("ref", &v.range().range()).into()],
            true,
        );
    }

    worksheet.merge_cells_crate().write_to(writer);
    write_start_tag(writer, "phoneticPr", vec![("fontId", "1").into()], true);

    for conditional_formatting in worksheet.conditional_formatting_collection() {
        conditional_formatting.write_to(writer, stylesheet.differential_formats_mut());
    }

    if let Some(v) = worksheet.data_validations() {
        v.write_to(writer);
    }
}

/// Writes worksheet extensions including hyperlinks, print settings, drawings,
/// and tables.
///
/// # Arguments
///
/// * `writer` - The XML writer to write to
/// * `worksheet` - The worksheet containing the extensions
fn write_worksheet_extensions(writer: &mut InternalWriter, worksheet: &Worksheet) {
    let mut r_id = write_hyperlinks(writer, worksheet);
    r_id = write_print_settings(writer, worksheet, r_id);
    r_id = write_drawings(writer, worksheet, r_id);
    write_tables_and_objects(writer, worksheet, r_id);

    if worksheet.data_validations_2010().is_some() {
        write_start_tag(writer, "extLst", vec![], false);
        if let Some(v) = worksheet.data_validations_2010() {
            v.write_to(writer);
        }
        write_end_tag(writer, "extLst");
    }
}

/// Writes rows and their contained cells to the worksheet.
///
/// # Arguments
///
/// * `writer` - The XML writer to write to
/// * `row_dimensions` - Slice of row references to write
/// * `cells` - Slice of cell references to write
/// * `shared_string_table` - Table containing shared string values
/// * `stylesheet` - The workbook's stylesheet for formatting
/// * `formula_shared_list` - Map of shared formula definitions
fn write_rows_and_cells(
    writer: &mut InternalWriter,
    row_dimensions: &[&Row],
    cells: &[&Cell],
    shared_string_table: &RwLock<SharedStringTable>,
    stylesheet: &mut Stylesheet,
    formula_shared_list: &HashMap<u32, (String, Option<String>)>,
) {
    let mut cells_iter = cells.iter().peekable();

    for row in row_dimensions {
        let mut cells_in_row: Vec<&Cell> = Vec::new();

        while let Some(cell) = cells_iter.peek() {
            if row.row_num() != cell.coordinate().row_num() {
                break;
            }
            cells_in_row.push(cells_iter.next().unwrap());
        }

        write_row_with_cells(
            writer,
            row,
            &cells_in_row,
            shared_string_table,
            stylesheet,
            formula_shared_list,
        );
    }
}

/// Writes a single row and its contained cells.
///
/// # Arguments
///
/// * `writer` - The XML writer to write to
/// * `row` - The row to write
/// * `cells_in_row` - Slice of cells belonging to this row
/// * `shared_string_table` - Table containing shared string values
/// * `stylesheet` - The workbook's stylesheet for formatting
/// * `formula_shared_list` - Map of shared formula definitions
fn write_row_with_cells(
    writer: &mut InternalWriter,
    row: &Row,
    cells_in_row: &[&Cell],
    shared_string_table: &RwLock<SharedStringTable>,
    stylesheet: &mut Stylesheet,
    formula_shared_list: &HashMap<u32, (String, Option<String>)>,
) {
    if cells_in_row.is_empty() {
        let spans = "0:0";
        row.write_to(writer, stylesheet, spans, true);
    } else {
        let (first_num, last_num) = (
            cells_in_row.first().unwrap().coordinate().col_num(),
            cells_in_row.last().unwrap().coordinate().col_num(),
        );
        let spans = format!("{first_num}:{last_num}");

        row.write_to(writer, stylesheet, &spans, false);

        for cell in cells_in_row {
            cell.write_to(writer, shared_string_table, stylesheet, formula_shared_list);
        }

        write_end_tag(writer, "row");
    }
}

/// Writes hyperlinks and returns the next available relationship ID.
///
/// # Arguments
///
/// * `writer` - The XML writer to write to
/// * `worksheet` - The worksheet containing hyperlinks
///
/// # Returns
///
/// The next available relationship ID
fn write_hyperlinks(writer: &mut InternalWriter, worksheet: &Worksheet) -> i32 {
    let mut r_id = 1;

    if worksheet.has_hyperlink() {
        write_start_tag(writer, "hyperlinks", vec![], false);

        for (coordition, hyperlink) in worksheet.hyperlink_collection() {
            let r_id_str = format!("rId{r_id}");
            let mut attributes: crate::structs::AttrCollection = Vec::new();
            attributes.push(("ref", &coordition).into());
            if hyperlink.location() {
                attributes.push(("location", hyperlink.url()).into());
            } else {
                attributes.push(("r:id", &r_id_str).into());
                r_id += 1;
            }
            if !hyperlink.tooltip().is_empty() {
                attributes.push(("tooltip", hyperlink.tooltip()).into());
            }
            write_start_tag(writer, "hyperlink", attributes, true);
        }

        write_end_tag(writer, "hyperlinks");
    }

    r_id
}

/// Writes print settings and returns the next available relationship ID.
///
/// # Arguments
///
/// * `writer` - The XML writer to write to
/// * `worksheet` - The worksheet containing print settings
/// * `r_id` - The current relationship ID
///
/// # Returns
///
/// The next available relationship ID
fn write_print_settings(writer: &mut InternalWriter, worksheet: &Worksheet, r_id: i32) -> i32 {
    let mut r_id = r_id;
    worksheet.print_options().write_to(writer);
    worksheet.page_margins().write_to(writer);

    if worksheet.page_setup().has_param() {
        worksheet
            .page_setup()
            .write_to(writer, &mut num_traits::cast(r_id).unwrap());
        r_id += 1;
    }

    worksheet.header_footer().write_to(writer);
    worksheet.row_breaks().write_to(writer);
    worksheet.column_breaks().write_to(writer);

    r_id
}

/// Writes drawing objects and returns the next available relationship ID.
///
/// # Arguments
///
/// * `writer` - The XML writer to write to
/// * `worksheet` - The worksheet containing drawings
/// * `r_id` - The current relationship ID
///
/// # Returns
///
/// The next available relationship ID
fn write_drawings(writer: &mut InternalWriter, worksheet: &Worksheet, mut r_id: i32) -> i32 {
    if worksheet.has_drawing_object() {
        let r_id_str = format!("rId{r_id}");
        write_start_tag(writer, "drawing", vec![("r:id", &r_id_str).into()], true);
        r_id += 1;
    }

    if worksheet.has_legacy_drawing() {
        let r_id_str = format!("rId{r_id}");
        write_start_tag(
            writer,
            "legacyDrawing",
            vec![("r:id", &r_id_str).into()],
            true,
        );
        r_id += 1;
    }

    r_id
}

/// Writes tables and OLE objects.
///
/// # Arguments
///
/// * `writer` - The XML writer to write to
/// * `worksheet` - The worksheet containing tables and objects
/// * `r_id` - The current relationship ID
fn write_tables_and_objects(writer: &mut InternalWriter, worksheet: &Worksheet, mut r_id: i32) {
    if worksheet.has_table() {
        let tables = worksheet.tables();
        write_start_tag(
            writer,
            "tableParts",
            vec![("count", &tables.len().to_string()).into()],
            false,
        );
        for _table in worksheet.tables() {
            let r_id_str = format!("rId{r_id}");
            write_start_tag(writer, "tablePart", vec![("r:id", &r_id_str).into()], true);
            r_id += 1;
        }
        write_end_tag(writer, "tableParts");
    }

    let ole_id = 1000 + 25;
    worksheet
        .ole_objects()
        .write_to(writer, num_traits::cast(r_id).unwrap(), ole_id);
}

#[cfg(test)]
mod tests {
    use std::io::Cursor;

    use super::*;

    fn setup_test_writer() -> InternalWriter {
        Writer::new(Cursor::new(Vec::new()))
    }

    fn setup_test_worksheet() -> Worksheet {
        let mut ws = Worksheet::default();
        ws.set_name("Test Sheet");
        ws
    }

    fn setup_shared_string_table() -> RwLock<SharedStringTable> {
        RwLock::new(SharedStringTable::default())
    }

    fn setup_stylesheet() -> Stylesheet {
        Stylesheet::default()
    }

    #[test]
    fn test_write_worksheet_header() {
        let mut writer = setup_test_writer();
        write_worksheet_header(&mut writer);

        let result = String::from_utf8(writer.into_inner().into_inner()).unwrap();
        assert!(result.contains("<?xml"));
        assert!(result.contains("worksheet"));
        assert!(result.contains(SHEET_MAIN_NS));
    }

    #[test]
    fn test_write_worksheet_properties() {
        let mut writer = setup_test_writer();
        let worksheet = setup_test_worksheet();

        // Test without macros
        write_worksheet_properties(&mut writer, &worksheet, false);
        let result = String::from_utf8(writer.into_inner().into_inner()).unwrap();
        assert!(!result.contains("codeName"));

        // Test with macros
        let mut writer = setup_test_writer();
        write_worksheet_properties(&mut writer, &worksheet, true);
        let result = String::from_utf8(writer.into_inner().into_inner()).unwrap();
        assert!(result.contains("codeName"));
    }

    #[test]
    fn test_write_dimension_and_views() {
        let mut writer = setup_test_writer();
        let worksheet = setup_test_worksheet();

        write_dimension_and_views(&mut writer, &worksheet);
        let result = String::from_utf8(writer.into_inner().into_inner()).unwrap();
        assert!(result.contains("dimension"));
    }

    #[test]
    fn test_write_rows_and_cells() {
        let mut writer = setup_test_writer();
        let mut row = Row::default();
        row.set_row_num(1);
        let mut cell = Cell::default();
        cell.set_coordinate("C1");
        let shared_string_table = setup_shared_string_table();
        let mut stylesheet = setup_stylesheet();
        let formula_shared_list = HashMap::new();

        write_rows_and_cells(
            &mut writer,
            &[&row],
            &[&cell],
            &shared_string_table,
            &mut stylesheet,
            &formula_shared_list,
        );

        let result = String::from_utf8(writer.into_inner().into_inner()).unwrap();
        assert!(result.contains("<row r=\"1\" spans=\"3:3\">"));
    }

    #[test]
    fn test_write_row_with_cells() {
        let mut writer = setup_test_writer();
        let mut row = Row::default();
        row.set_row_num(1);
        let mut cell = Cell::default();
        cell.set_coordinate("A1");
        let shared_string_table = setup_shared_string_table();
        let mut stylesheet = setup_stylesheet();
        let formula_shared_list = HashMap::new();

        write_row_with_cells(
            &mut writer,
            &row,
            &[&cell],
            &shared_string_table,
            &mut stylesheet,
            &formula_shared_list,
        );

        let result = String::from_utf8(writer.into_inner().into_inner()).unwrap();
        assert!(result.contains("<row r=\"1\" spans=\"1:1\">"));
    }

    // fn test_write_hyperlinks() {
    //     let mut writer = setup_test_writer();
    //     let mut worksheet = setup_test_worksheet();

    //     // Add a test hyperlink
    //     worksheet.add_hyperlink("A1", "http://example.com");

    //     let r_id = write_hyperlinks(&mut writer, &worksheet);

    //     let result =
    // String::from_utf8(writer.into_inner().into_inner()).unwrap();     assert!
    // (result.contains("hyperlinks"));     assert!(result.contains("hyperlink"
    // ));     assert!(r_id > 1);
    // }
    #[test]
    fn test_write_print_settings() {
        let mut writer = setup_test_writer();
        let worksheet = setup_test_worksheet();

        let r_id = write_print_settings(&mut writer, &worksheet, 1);

        let result = String::from_utf8(writer.into_inner().into_inner()).unwrap();
        assert!(result.contains("pageMargins"));
        assert_eq!(r_id, 1);
    }

    #[test]
    fn test_write_drawings() {
        let mut writer = setup_test_writer();
        let worksheet = setup_test_worksheet();

        let r_id = write_drawings(&mut writer, &worksheet, 1);

        // Should return same r_id if no drawings
        assert_eq!(r_id, 1);
    }

    #[test]
    fn test_write_tables_and_objects() {
        let mut writer = setup_test_writer();
        let worksheet = setup_test_worksheet();

        write_tables_and_objects(&mut writer, &worksheet, 1);

        let result = String::from_utf8(writer.into_inner().into_inner()).unwrap();
        // Should be empty if no tables/objects
        assert!(!result.contains("tableParts"));
    }

    #[test]
    fn test_write_complete_worksheet() {
        let cursor = Cursor::new(Vec::new());
        let mut arv = zip::ZipWriter::new(cursor);
        let mut writer_manager = WriterManager::new(&mut arv);
        let worksheet = setup_test_worksheet();
        let shared_string_table = setup_shared_string_table();
        let mut stylesheet = setup_stylesheet();

        let result = write(
            1,
            &worksheet,
            &shared_string_table,
            &mut stylesheet,
            false,
            &mut writer_manager,
        );

        assert!(result.is_ok());
    }
}