excel_reader 2.0.2 

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

pub mod cell;
pub mod column_information;
pub mod hyperlink;
pub mod merge_cell;
pub mod row;
pub mod sheet_data;
pub mod sheet_dimension;
pub mod sheet_view;
pub mod table_part;

use anyhow::bail;
use column_information::{load_column_infos, XlsxColumnInformations};
use hyperlink::{load_hyperlinks, XlsxHyperlinks};
use merge_cell::{load_merge_cells, XlsxMergeCells};
use quick_xml::events::Event;
use sheet_data::XlsxSheetData;
use sheet_dimension::{load_sheet_dimension, XlsxSheetDimension};
use std::io::{Read, Seek};
use table_part::{load_table_parts, XlsxTableParts};
use zip::ZipArchive;

use super::{drawing::XlsxDrawing, sheet_format_properties::XlsxSheetFormatProperties};
use crate::{
    excel::xml_reader,
    raw::spreadsheet::{
        filter::auto_filter::XlsxAutoFilter,
        string_item::phonetic_properties::XlsxPhoneticProperties,
    },
};

/// https://learn.microsoft.com/en-us/dotnet/api/documentformat.openxml.spreadsheet.worksheet?view=openxml-3.0.1
///
/// This is the root element of Worksheet parts.
/// Contains information on dimension, sheetview, column styles, cell data, cell styles, merged regions, etc.
///
/// Example:
/// ```
/// <worksheet xmlns:r="http://schemas.openxmlformats.org/officeDocument/2006/relationships" xmlns="http://schemas.openxmlformats.org/spreadsheetml/2006/main">
///   <dimension ref="A2:B7" />
///   <sheetViews>
///     <sheetView workbookViewId="0" showGridLines="0" defaultGridColor="1">
///       <pane topLeftCell="B3" xSplit="1" ySplit="2" activePane="bottomRight" state="frozen" />
///     </sheetView>
///   </sheetViews>
///   <sheetFormatPr defaultColWidth="16.3333" defaultRowHeight="19.9" customHeight="1" outlineLevelRow="0" outlineLevelCol="0" />
///   <cols>
///     <col min="1" max="2" width="16.3516" style="1" customWidth="1" />
///     <col min="3" max="16384" width="16.3516" style="1" customWidth="1" />
///   </cols>
///   <sheetData>
///     <row r="1" ht="27.65" customHeight="1">
///       <c r="A1" t="s" s="2">
///         <v>0</v>
///       </c>
///       <c r="B1" s="2" />
///     </row>
///     /// ...
///   </sheetData>
///   <mergeCells count="2">
///     <mergeCell ref="A1:B1" />
///     <mergeCell ref="B6:B7" />
///   </mergeCells>
///   <pageMargins left="0.5" right="0.5" top="0.75" bottom="0.75" header="0.277778" footer="0.277778" />
///   <pageSetup firstPageNumber="1" fitToHeight="1" fitToWidth="1" scale="72" useFirstPageNumber="0" orientation="portrait" pageOrder="downThenOver" />
///   <headerFooter>
///     <oddFooter>&amp;C&amp;"Helvetica Neue,Regular"&amp;12&amp;K000000&amp;P</oddFooter>
///   </headerFooter>
/// </worksheet>
/// ```
/// worksheet (Worksheet)
#[derive(Debug, Clone, PartialEq, Default)]
pub struct XlsxWorksheet {
    // extLst (Future Feature Data Storage Area) Not supported

    // Child Elements	Subclause
    // autoFilter (AutoFilter Settings)	§18.3.1.2
    pub auto_filter: Option<XlsxAutoFilter>,
    // cellWatches (Cell Watch Items)	§18.3.1.9
    // colBreaks (Vertical Page Breaks)	§18.3.1.14

    // cols (Column Information)	§18.3.1.17
    pub column_infos: Option<XlsxColumnInformations>,
    // conditionalFormatting (Conditional Formatting)	§18.3.1.18
    // controls (Embedded Controls)	§18.3.1.21
    // customProperties (Custom Properties)	§18.3.1.23
    // customSheetViews (Custom Sheet Views)	§18.3.1.27
    // dataConsolidate (Data Consolidate)	§18.3.1.29
    // dataValidations (Data Validations)	§18.3.1.33

    // dimension (Worksheet Dimensions)
    pub dimension: Option<XlsxSheetDimension>,

    // drawing (Drawing)
    pub drawing: Option<XlsxDrawing>,

    // drawingHF (Drawing Reference in Header Footer)	§18.3.1.37
    // headerFooter (Header Footer Settings)	§18.3.1.46

    // hyperlinks (Hyperlinks)
    pub hyperlinks: Option<XlsxHyperlinks>,

    // ignoredErrors (Ignored Errors)	§18.3.1.51

    // mergeCells (Merge Cells)	§18.3.1.55
    pub merge_cells: Option<XlsxMergeCells>,

    // oleObjects (Embedded Objects)	§18.3.1.60
    // pageMargins (Page Margins)	§18.3.1.62
    // pageSetup (Page Setup Settings)	§18.3.1.63
    // phoneticPr (Phonetic Properties)	§18.4.3
    pub phonetic_properties: Option<XlsxPhoneticProperties>,

    // picture (Background Image)	§18.3.1.67
    // printOptions (Print Options)	§18.3.1.70
    // protectedRanges (Protected Ranges)	§18.3.1.72
    // rowBreaks (Horizontal Page Breaks (Row))	§18.3.1.74
    // scenarios (Scenarios)	§18.3.1.76
    // sheetCalcPr (Sheet Calculation Properties)	§18.3.1.79

    // sheetData (Sheet Data)	§18.3.1.80
    pub sheet_data: Option<XlsxSheetData>,

    // sheetFormatPr (Sheet Format Properties)	§18.3.1.81
    pub sheet_format_properties: Option<XlsxSheetFormatProperties>,
    // sheetPr (Sheet Properties)	§18.3.1.82
    // sheetProtection (Sheet Protection Options)	§18.3.1.85
    // sheetViews (Sheet Views)	§18.3.1.88
    // smartTags (Smart Tags)	§18.3.1.90
    // sortState (Sort State)	§18.3.1.92

    // tableParts (Table Parts)	§18.3.1.95
    pub table_parts: Option<XlsxTableParts>, // webPublishItems (Web Publishing Items)
}

impl XlsxWorksheet {
    pub(crate) fn load(zip: &mut ZipArchive<impl Read + Seek>, path: &str) -> anyhow::Result<Self> {
        let mut worksheet = Self {
            auto_filter: None,
            column_infos: None,
            dimension: None,
            drawing: None,
            hyperlinks: None,
            merge_cells: None,
            phonetic_properties: None,
            sheet_data: None,
            sheet_format_properties: None,
            table_parts: None,
        };

        let Some(mut reader) = xml_reader(zip, path) else {
            return Ok(worksheet);
        };

        let mut buf = Vec::new();

        loop {
            buf.clear();

            match reader.read_event_into(&mut buf) {
                Ok(Event::Start(ref e)) if e.local_name().as_ref() == b"extLst" => {
                    let _ = reader.read_to_end_into(e.to_end().to_owned().name(), &mut Vec::new());
                }
                Ok(Event::Start(ref e)) if e.local_name().as_ref() == b"autoFilter" => {
                    worksheet.auto_filter = Some(XlsxAutoFilter::load(&mut reader, e)?);
                }
                Ok(Event::Start(ref e)) if e.local_name().as_ref() == b"cols" => {
                    worksheet.column_infos = Some(load_column_infos(&mut reader)?);
                }
                Ok(Event::Start(ref e)) if e.local_name().as_ref() == b"dimension" => {
                    worksheet.dimension = load_sheet_dimension(e)?;
                }
                Ok(Event::Start(ref e)) if e.local_name().as_ref() == b"drawing" => {
                    worksheet.drawing = Some(XlsxDrawing::load(e)?);
                }
                Ok(Event::Start(ref e)) if e.local_name().as_ref() == b"hyperlinks" => {
                    worksheet.hyperlinks = Some(load_hyperlinks(&mut reader)?);
                }
                Ok(Event::Start(ref e)) if e.local_name().as_ref() == b"mergeCells" => {
                    worksheet.merge_cells = Some(load_merge_cells(&mut reader)?);
                }
                Ok(Event::Start(ref e)) if e.local_name().as_ref() == b"phoneticPr" => {
                    worksheet.phonetic_properties = Some(XlsxPhoneticProperties::load(e)?);
                }
                Ok(Event::Start(ref e)) if e.local_name().as_ref() == b"sheetData" => {
                    worksheet.sheet_data = Some(XlsxSheetData::load(&mut reader)?);
                }
                Ok(Event::Start(ref e)) if e.local_name().as_ref() == b"sheetFormatPr" => {
                    worksheet.sheet_format_properties = Some(XlsxSheetFormatProperties::load(e)?);
                }
                Ok(Event::Start(ref e)) if e.local_name().as_ref() == b"tableParts" => {
                    worksheet.table_parts = Some(load_table_parts(&mut reader)?);
                }

                Ok(Event::End(ref e)) if e.local_name().as_ref() == b"worksheet" => break,
                Ok(Event::Eof) => break,
                Err(e) => bail!(e.to_string()),
                _ => (),
            }
        }

        return Ok(worksheet);
    }
}