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
use std::{
    fs::File,
    io,
    io::Cursor,
    path::Path,
};

use quick_xml::Writer;

use crate::{
    helper::const_str::{
        CHART_TYPE,
        COMMENTS_TYPE,
        CORE_PROPS_TYPE,
        CUSTOM_PROPS_TYPE,
        DRAWING_TYPE,
        OLE_OBJECT_TYPE,
        PKG_CHARTS,
        PKG_DRAWINGS,
        PKG_EMBEDDINGS,
        PKG_PRNTR_SETTINGS,
        PKG_TABLES,
        SHARED_STRINGS_TYPE,
        SHEET_TYPE,
        STYLES_TYPE,
        TABLE_TYPE,
        PIVOT_TABLE_TYPE,
        PIVOT_CACHE_DEF_TYPE,
        THEME_TYPE,
        VBA_TYPE,
        WORKBOOK_MACRO_TYPE,
        WORKBOOK_TYPE,
        XPROPS_TYPE,
    },
    structs::{
        Workbook,
        XlsxError,
    },
    reader::driver::zip_by_name,
    writer::driver::{
        make_file_from_bin,
        make_file_from_writer,
    },
};
pub struct WriterManager<'a, W: io::Seek + io::Write> {
    files:    Vec<String>,
    arv:      &'a mut zip::ZipWriter<W>,
    is_light: bool,
    table_no: i32,
    pivot_table_no: i32,
    pivot_cache_hash_list: Vec<String>,
}

impl<'a, W: io::Seek + io::Write> WriterManager<'a, W> {
    #[inline]
    pub fn new(arv: &'a mut zip::ZipWriter<W>) -> Self {
        WriterManager {
            files: Vec::new(),
            arv,
            is_light: false,
            table_no: 0,
            pivot_table_no: 0,
            pivot_cache_hash_list: Vec::new(),
        }
    }

    #[inline]
    pub fn set_is_light(&mut self, value: bool) -> &mut Self {
        self.is_light = value;
        self
    }

    #[inline]
    #[must_use]
    pub fn get_is_light(&self) -> bool {
        self.is_light
    }

    #[inline]
    #[must_use]
    pub fn get_num_tables(&self) -> i32 {
        self.table_no
    }

    #[inline]
    pub fn next_table_no(&mut self) -> i32 {
        self.table_no += 1;
        self.table_no
    }

    #[inline]
    pub fn next_pivot_table_no(&mut self) -> i32 {
        self.pivot_table_no += 1;
        self.pivot_table_no
    }

    #[inline]
    pub fn get_pivot_cache_no(&mut self, hash: &str) -> (bool, i32) {
        if let Some(v) = self.pivot_cache_hash_list.iter().position(|x| x == hash) {
            (true, i32::try_from(v + 1).unwrap())
        } else {
            self.pivot_cache_hash_list.push(hash.to_string());
            (false, i32::try_from(self.pivot_cache_hash_list.len()).unwrap())
        }
    }

    #[inline]
    pub(crate) fn add_writer(
        &mut self,
        target: &str,
        writer: Writer<Cursor<Vec<u8>>>,
    ) -> Result<(), XlsxError> {
        if !self.check_file_exist(target) {
            make_file_from_writer(target, self.arv, writer, None, self.is_light)?;
            self.files.push(target.to_string());
        }
        Ok(())
    }

    #[inline]
    pub(crate) fn add_bin(&mut self, target: &str, data: &[u8]) -> Result<(), XlsxError> {
        if !self.check_file_exist(target) {
            make_file_from_bin(target, self.arv, data, None, self.is_light)?;
            self.files.push(target.to_string());
        }
        Ok(())
    }

    #[inline]
    pub(crate) fn add_raw_copy<P: AsRef<Path>>(
        &mut self,
        target: &str,
        source_path: P,
        source_target: &str,
    ) -> Result<(), XlsxError> {
        if !self.check_file_exist(target) {
            let file = File::open(source_path)?;
            let mut archive = zip::read::ZipArchive::new(file)?;
            let source = zip_by_name(&mut archive, source_target)?;
            self.arv.raw_copy_file_rename(source, target)?;
            self.files.push(target.to_string());
        }
        Ok(())
    }

    #[inline]
    pub(crate) fn get_arv_mut(&mut self) -> &mut zip::ZipWriter<W> {
        self.arv
    }

    #[inline]
    pub(crate) fn file_list_sort(&mut self) -> &mut Self {
        self.files.sort();
        self
    }

    #[inline]
    pub(crate) fn check_file_exist(&mut self, file_path: &str) -> bool {
        self.file_list_sort();
        self.files.iter().any(|file| file == file_path)
    }

    pub(crate) fn add_file_at_drawing(
        &mut self,
        writer: Writer<Cursor<Vec<u8>>>,
    ) -> Result<i32, XlsxError> {
        let mut index = 0;
        loop {
            index += 1;
            let file_path = format!("{PKG_DRAWINGS}/drawing{index}.xml");
            if !self.check_file_exist(&file_path) {
                self.add_writer(&file_path, writer)?;
                return Ok(index);
            }
        }
    }

    pub(crate) fn add_file_at_vml_drawing(
        &mut self,
        writer: Writer<Cursor<Vec<u8>>>,
    ) -> Result<i32, XlsxError> {
        let mut index = 0;
        loop {
            index += 1;
            let file_path = format!("{PKG_DRAWINGS}/vmlDrawing{index}.vml");
            if !self.check_file_exist(&file_path) {
                self.add_writer(&file_path, writer)?;
                return Ok(index);
            }
        }
    }

    pub(crate) fn add_file_at_comment(
        &mut self,
        writer: Writer<Cursor<Vec<u8>>>,
    ) -> Result<i32, XlsxError> {
        let mut index = 0;
        loop {
            index += 1;
            let file_path = format!("xl/comments{index}.xml");
            if !self.check_file_exist(&file_path) {
                self.add_writer(&file_path, writer)?;
                return Ok(index);
            }
        }
    }

    pub(crate) fn add_file_at_threaded_comment(
        &mut self,
        writer: Writer<Cursor<Vec<u8>>>,
    ) -> Result<i32, XlsxError> {
        let mut index = 0;
        loop {
            index += 1;
            let file_path = format!("xl/threadedComments/threadedComment{index}.xml");
            if !self.check_file_exist(&file_path) {
                self.add_writer(&file_path, writer)?;
                return Ok(index);
            }
        }
    }

    pub(crate) fn add_file_at_chart(
        &mut self,
        writer: Writer<Cursor<Vec<u8>>>,
    ) -> Result<i32, XlsxError> {
        let mut index = 0;
        loop {
            index += 1;
            let file_path = format!("{PKG_CHARTS}/chart{index}.xml");
            if !self.check_file_exist(&file_path) {
                self.add_writer(&file_path, writer)?;
                return Ok(index);
            }
        }
    }

    pub(crate) fn add_file_at_ole_object(&mut self, writer: &[u8]) -> Result<i32, XlsxError> {
        let mut index = 0;
        loop {
            index += 1;
            let file_path = format!("{PKG_EMBEDDINGS}/oleObject{index}.bin");
            if !self.check_file_exist(&file_path) {
                self.add_bin(&file_path, writer)?;
                return Ok(index);
            }
        }
    }

    pub(crate) fn add_file_at_excel(&mut self, writer: &[u8]) -> Result<i32, XlsxError> {
        let mut index = 0;
        loop {
            index += 1;
            let file_path = format!("{PKG_EMBEDDINGS}/Microsoft_Excel_Worksheet{index}.xlsx");
            if !self.check_file_exist(&file_path) {
                self.add_bin(&file_path, writer)?;
                return Ok(index);
            }
        }
    }

    pub(crate) fn add_file_at_printer_settings(&mut self, writer: &[u8]) -> Result<i32, XlsxError> {
        let mut index = 0;
        loop {
            index += 1;
            let file_path = format!("{PKG_PRNTR_SETTINGS}/printerSettings{index}.bin");
            if !self.check_file_exist(&file_path) {
                self.add_bin(&file_path, writer)?;
                return Ok(index);
            }
        }
    }

    #[inline]
    pub(crate) fn add_file_at_table(
        &mut self,
        writer: Writer<Cursor<Vec<u8>>>,
        table_no: i32,
    ) -> Result<i32, XlsxError> {
        let file_path = format!("{PKG_TABLES}/table{table_no}.xml");
        self.add_writer(&file_path, writer)?;
        Ok(table_no)
    }

    #[inline]
    pub(crate) fn add_file_at_pivot_table(
        &mut self,
        writer: Writer<Cursor<Vec<u8>>>,
        pivot_table_no: i32,
    ) -> Result<i32, XlsxError> {
        let file_path = format!("xl/pivotTables/pivotTable{pivot_table_no}.xml");
        self.add_writer(&file_path, writer)?;
        Ok(pivot_table_no)
    }

    #[inline]
    pub(crate) fn add_file_at_pivot_cache(
        &mut self,
        writer: Writer<Cursor<Vec<u8>>>,
        pivot_cache_no: i32,
    ) -> Result<i32, XlsxError> {
        let file_path = format!("xl/pivotCache/pivotCacheDefinition{pivot_cache_no}.xml");
        self.add_writer(&file_path, writer)?;
        Ok(pivot_cache_no)
    }

    #[inline]
    pub(crate) fn has_extension(&self, extension: &str) -> bool {
        let extension = format!(".{extension}");
        self.files.iter().any(|file| file.ends_with(&extension))
    }

    pub(crate) fn make_context_type_override(&mut self, wb: &Workbook) -> Vec<(String, String)> {
        self.file_list_sort();

        let mut list: Vec<(String, String)> = Vec::new();
        for file in &self.files {
            let file = format!("/{file}");
            let mut content_type = "";

            // Override workbook
            if file.starts_with("/xl/workbook.xml") {
                content_type = if wb.has_macros() {
                    WORKBOOK_MACRO_TYPE
                } else {
                    WORKBOOK_TYPE
                };
            }

            // Override sheet
            if file.starts_with("/xl/worksheets/sheet") {
                content_type = SHEET_TYPE;
            }

            // Override table
            if file.starts_with("/xl/tables/table") {
                content_type = TABLE_TYPE;
            }

            // Override pivot table
            if file.starts_with("/xl/pivotTables/pivotTable") {
                content_type = PIVOT_TABLE_TYPE;
            }

            // Override pivot cache
            if file.starts_with("/xl/pivotCache/pivotCacheDefinition") {
                content_type = PIVOT_CACHE_DEF_TYPE;
            }

            // Override comments
            if file.starts_with("/xl/comments") {
                content_type = COMMENTS_TYPE;
            }

            // Override theme
            if file.starts_with("/xl/theme/theme") {
                content_type = THEME_TYPE;
            }

            // Override styles
            if file.starts_with("/xl/styles.xml") {
                content_type = STYLES_TYPE;
            }

            // Override sharedStrings
            if file.starts_with("/xl/sharedStrings.xml") {
                content_type = SHARED_STRINGS_TYPE;
            }

            // Override drawing
            if file.starts_with("/xl/drawings/drawing") {
                content_type = DRAWING_TYPE;
            }

            // Override chart
            if file.starts_with("/xl/charts/chart") {
                content_type = CHART_TYPE;
            }

            // Override embeddings
            if file.starts_with("/xl/embeddings/oleObject") {
                content_type = OLE_OBJECT_TYPE;
            }

            // Override xl/vbaProject.bin
            if file.starts_with("/xl/vbaProject.bin") {
                content_type = VBA_TYPE;
            }

            // Override docProps/core
            if file.starts_with("/docProps/core.xml") {
                content_type = CORE_PROPS_TYPE;
            }

            // Override docProps/app
            if file.starts_with("/docProps/app.xml") {
                content_type = XPROPS_TYPE;
            }

            // Override docProps/custom
            if file.starts_with("/docProps/custom.xml") {
                content_type = CUSTOM_PROPS_TYPE;
            }

            // Override Unsupported
            if content_type.is_empty() {
                for (old_part_name, old_content_type) in wb.backup_context_types() {
                    if **old_part_name == file {
                        content_type = old_content_type;
                    }
                }
            }

            if !content_type.is_empty() {
                list.push((file, content_type.to_string()));
            }
        }
        list
    }
}