visi-core 0.2.14

Embeddable spreadsheet engine: Excel formula compilation and evaluation, dependency-tracked recalculation, and .xlsx import/export
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
use crate::core::CompiledFormula;
use crate::core::SharedVec;
use serde::{Deserialize, Serialize};

use super::bitmask::Bitmask;
use super::cell::{CellType, generate_unique_id};
use super::result_data::ResultData;

/// A column of computed values
#[derive(Debug, Clone, Serialize, Deserialize)]
pub enum ColumnData {
    /// All-integer, or integer-and-blank.
    Integer {
        /// Which positions hold a value rather than a blank.
        validity: Bitmask,
        /// The values. Positions marked invalid hold a placeholder.
        values: SharedVec<i64>,
    },
    /// Numeric with at least one non-integer, or integer-and-blank promoted.
    Float {
        /// Which positions hold a value rather than a blank.
        validity: Bitmask,
        /// The values. Positions marked invalid hold a placeholder.
        values: SharedVec<f64>,
    },
    /// Mixed: anything the numeric representations cannot hold -- text,
    /// booleans, errors.
    Any(SharedVec<ResultData>),
}

impl ColumnData {
    pub(crate) fn new(size: usize) -> Self {
        Self::Integer {
            validity: Bitmask::with_size(size),
            values: vec![0; size].into(),
        }
    }

    /// How many rows the column holds.
    pub fn len(&self) -> usize {
        match self {
            Self::Integer { validity, .. } => validity.len,
            Self::Float { validity, .. } => validity.len,
            Self::Any(v) => v.len(),
        }
    }

    /// Whether the column holds no rows at all.
    pub fn is_empty(&self) -> bool {
        self.len() == 0
    }

    pub(crate) fn push(&mut self, value: ResultData) {
        let index = self.len();
        self.insert(index, value);
    }

    /// The value at `index`, or `None` if that is past the end.
    ///
    /// A blank within the column's range reads as
    /// `Some(ResultData::None)`, which is what distinguishes it from an
    /// out-of-range index.
    pub fn get(&self, index: usize) -> Option<ResultData> {
        if index >= self.len() {
            return None;
        }
        match self {
            Self::Integer { validity, values } => {
                if validity.get(index) {
                    Some(ResultData::Integer(values[index]))
                } else {
                    Some(ResultData::None)
                }
            }
            Self::Float { validity, values } => {
                if validity.get(index) {
                    Some(ResultData::Float(values[index]))
                } else {
                    Some(ResultData::None)
                }
            }
            Self::Any(v) => Some(v[index].clone()),
        }
    }

    pub(crate) fn demote_to_any(&mut self) {
        let len = self.len();
        let mut any = Vec::with_capacity(len);
        for i in 0..len {
            any.push(self.get(i).unwrap());
        }
        *self = Self::Any(any.into());
    }

    pub(crate) fn promote_to_float(&mut self) {
        if let Self::Integer { validity, values } = self {
            let float_values = values.iter().map(|&i| i as f64).collect();
            *self = Self::Float {
                validity: validity.clone(),
                values: float_values,
            };
        }
    }

    pub(crate) fn resize(&mut self, size: usize) {
        match self {
            Self::Integer { validity, values } => {
                values.resize(size, 0);
                *validity = Bitmask::with_size(size);
            }
            Self::Float { validity, values } => {
                values.resize(size, 0.0);
                *validity = Bitmask::with_size(size);
            }
            Self::Any(v) => {
                v.resize(size, ResultData::None);
            }
        }
    }

    pub(crate) fn set(&mut self, index: usize, value: ResultData) {
        if index >= self.len() {
            return;
        }
        match self {
            Self::Integer { validity, values } => match value {
                ResultData::Integer(i) => {
                    validity.set(index, true);
                    values[index] = i;
                }
                ResultData::Float(f) => {
                    self.promote_to_float();
                    self.set(index, ResultData::Float(f));
                }
                ResultData::None => {
                    validity.set(index, false);
                    values[index] = 0;
                }
                _ => {
                    self.demote_to_any();
                    if let Self::Any(v) = self {
                        v[index] = value;
                    }
                }
            },
            Self::Float { validity, values } => match value {
                ResultData::Float(f) => {
                    validity.set(index, true);
                    values[index] = f;
                }
                ResultData::Integer(i) => {
                    validity.set(index, true);
                    values[index] = i as f64;
                }
                ResultData::None => {
                    validity.set(index, false);
                    values[index] = 0.0;
                }
                _ => {
                    self.demote_to_any();
                    if let Self::Any(v) = self {
                        v[index] = value;
                    }
                }
            },
            Self::Any(v) => {
                v[index] = value;
            }
        }
    }

    pub(crate) fn insert(&mut self, index: usize, value: ResultData) {
        match self {
            Self::Integer { validity, values } => match value {
                ResultData::Integer(i) => {
                    validity.insert(index, true);
                    values.insert(index, i);
                }
                ResultData::Float(f) => {
                    self.promote_to_float();
                    self.insert(index, ResultData::Float(f));
                }
                ResultData::None => {
                    validity.insert(index, false);
                    values.insert(index, 0);
                }
                _ => {
                    self.demote_to_any();
                    if let Self::Any(v) = self {
                        v.insert(index, value);
                    }
                }
            },
            Self::Float { validity, values } => match value {
                ResultData::Float(f) => {
                    validity.insert(index, true);
                    values.insert(index, f);
                }
                ResultData::Integer(i) => {
                    validity.insert(index, true);
                    values.insert(index, i as f64);
                }
                ResultData::None => {
                    validity.insert(index, false);
                    values.insert(index, 0.0);
                }
                _ => {
                    self.demote_to_any();
                    if let Self::Any(v) = self {
                        v.insert(index, value);
                    }
                }
            },
            Self::Any(v) => {
                v.insert(index, value);
            }
        }
    }

    pub(crate) fn remove(&mut self, index: usize) {
        match self {
            Self::Integer { validity, values } => {
                validity.remove(index);
                values.remove(index);
            }
            Self::Float { validity, values } => {
                validity.remove(index);
                values.remove(index);
            }
            Self::Any(v) => {
                v.remove(index);
            }
        }
    }

    pub(crate) fn drain<R: std::ops::RangeBounds<usize> + Clone>(&mut self, range: R) {
        match self {
            Self::Integer { validity, values } => {
                validity.drain(range.clone());
                values.drain(range);
            }
            Self::Float { validity, values } => {
                validity.drain(range.clone());
                values.drain(range);
            }
            Self::Any(v) => {
                v.drain(range);
            }
        }
    }
}

impl Default for ColumnData {
    fn default() -> Self {
        Self::Integer {
            validity: Bitmask::with_size(0),
            values: SharedVec::new(),
        }
    }
}

/// One column of a sheet, including raw source, values, styles, etc.
///
/// IMPORTANT: `src`, `data`, `cell_types`, `compiled_src` and `styles`
/// must all stay the same length.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct DataColumn {
    /// Identifier, stable across renames and repositioning. Compiled formulas
    /// refer to a column by this rather than by name or position.
    #[serde(default = "generate_unique_id")]
    pub id: u64,
    /// Display name, empty unless one was set.
    #[serde(default)]
    pub name: String,
    /// Excel/OpenXML column width in character units, when one was explicitly stored.
    #[serde(default)]
    pub width: Option<f64>,
    /// The computed values
    #[serde(skip, default)]
    pub(crate) data: ColumnData,
    /// The raw text of each cell, exactly as typed
    pub(crate) src: SharedVec<String>,
    /// Intrinsic cell data types, matching Excel / OpenXML representations.
    #[serde(default)]
    pub(crate) cell_types: SharedVec<CellType>,
    /// Cached compile output for each cell. Rebuilt on load.
    #[serde(skip, default)]
    pub(crate) compiled_src: SharedVec<CompiledFormula>,
    /// Rows awaiting recomputation. Drained by `Sheet::commit`.
    #[serde(skip, default)]
    pub(crate) dirty_indices: SharedVec<usize>,
    /// Per-cell styling, `None` where a cell has none. Carries a date cell's
    /// number format.
    #[serde(default)]
    pub(crate) styles: SharedVec<Option<crate::core::CellStyle>>,
}

pub(crate) struct ColumnPosition {
    pub row: usize,
    pub char_offset: usize,
}

impl DataColumn {
    /// A column of `size` empty rows
    pub fn new(size: usize) -> Self {
        Self {
            id: generate_unique_id(),
            name: String::new(),
            width: None,
            data: ColumnData::new(size),
            src: vec![String::new(); size].into(),
            cell_types: vec![CellType::Empty; size].into(),
            compiled_src: vec![CompiledFormula::default(); size].into(),
            dirty_indices: SharedVec::new(),
            styles: vec![None; size].into(),
        }
    }

    /// Rows in the column
    pub fn len(&self) -> usize {
        self.src.len()
    }

    /// Whether the column has no rows.
    pub fn is_empty(&self) -> bool {
        self.src.is_empty()
    }

    /// The raw text of a cell, exactly as typed, or `None` past the end.
    pub fn src(&self, row: usize) -> Option<&str> {
        self.src.get(row).map(String::as_str)
    }

    /// The computed value of a cell, or `None` past the end
    pub fn value(&self, row: usize) -> Option<ResultData> {
        self.data.get(row)
    }

    /// The whole value column, for callers that want to work with the typed
    /// representation rather than row by row.
    pub fn values(&self) -> &ColumnData {
        &self.data
    }

    /// The intrinsic data type of a cell, or `None` past the end.
    pub fn cell_type(&self, row: usize) -> Option<CellType> {
        self.cell_types.get(row).copied()
    }

    /// Sets the intrinsic data type of a cell at `row`.
    pub fn set_cell_type(&mut self, row: usize, cell_type: CellType) {
        if row < self.cell_types.len() {
            self.cell_types[row] = cell_type;
        }
    }

    /// A cell's compiled formula, or `None` past the end. A cell holding a
    /// literal has an empty one rather than no entry.
    pub fn compiled(&self, row: usize) -> Option<&CompiledFormula> {
        self.compiled_src.get(row)
    }

    /// A cell's style, or `None` if it has none or is past the end.
    pub fn style(&self, row: usize) -> Option<&crate::core::CellStyle> {
        self.styles.get(row).and_then(Option::as_ref)
    }

    pub(crate) fn mark_dirty(&mut self, row: usize) {
        if !self.dirty_indices.contains(&row) {
            self.dirty_indices.push(row);
        }
    }

    #[cfg(test)]
    pub(crate) fn from_src(name: impl Into<String>, src: Vec<String>) -> Self {
        let mut col = Self::new(src.len());
        col.name = name.into();
        col.src = src.into();
        col
    }

    pub(crate) fn rebuild_after_load(&mut self) {
        let size = self.src.len();
        self.data.resize(size);
        self.cell_types.resize(size, CellType::Empty);
        self.compiled_src = vec![CompiledFormula::default(); size].into();
        self.styles.resize(size, None);
    }

    pub(crate) fn push_row(&mut self) {
        self.src.push(String::new());
        self.cell_types.push(CellType::Empty);
        self.compiled_src.push(CompiledFormula::default());
        self.data.push(ResultData::None);
        self.styles.push(None);
    }

    pub(crate) fn insert_row(&mut self, index: usize) {
        if index >= self.len() {
            self.push_row();
            return;
        }
        self.src.insert(index, String::new());
        self.cell_types.insert(index, CellType::Empty);
        self.compiled_src.insert(index, CompiledFormula::default());
        self.data.insert(index, ResultData::None);
        self.styles.insert(index, None);
        self.shift_dirty_after_insert(index, 1);
    }

    pub(crate) fn remove_row(&mut self, index: usize) {
        if index >= self.len() {
            return;
        }
        self.src.remove(index);
        self.cell_types.remove(index);
        self.compiled_src.remove(index);
        self.data.remove(index);
        self.styles.remove(index);
        self.drop_dirty_range(index, index + 1);
    }

    pub(crate) fn drain_rows<R: std::ops::RangeBounds<usize>>(&mut self, range: R) {
        let start = match range.start_bound() {
            std::ops::Bound::Included(&n) => n,
            std::ops::Bound::Excluded(&n) => n + 1,
            std::ops::Bound::Unbounded => 0,
        };
        let end = match range.end_bound() {
            std::ops::Bound::Included(&n) => n + 1,
            std::ops::Bound::Excluded(&n) => n,
            std::ops::Bound::Unbounded => self.len(),
        };
        let start = start.min(self.len());
        let end = end.min(self.len());
        if start >= end {
            return;
        }
        self.src.drain(start..end);
        self.cell_types.drain(start..end);
        self.compiled_src.drain(start..end);
        self.data.drain(start..end);
        self.styles.drain(start..end);
        self.drop_dirty_range(start, end);
    }

    pub(crate) fn resize_rows(&mut self, len: usize) {
        while self.len() < len {
            self.push_row();
        }
        if self.len() > len {
            self.drain_rows(len..);
        }
    }

    fn drop_dirty_range(&mut self, start: usize, end: usize) {
        let removed = end - start;
        self.dirty_indices.retain(|&i| i < start || i >= end);
        for i in self.dirty_indices.iter_mut() {
            if *i >= end {
                *i -= removed;
            }
        }
    }

    fn shift_dirty_after_insert(&mut self, index: usize, count: usize) {
        for i in self.dirty_indices.iter_mut() {
            if *i >= index {
                *i += count;
            }
        }
    }

    pub(crate) fn insert(&mut self, position: ColumnPosition, input: &str) {
        let ColumnPosition { row, char_offset } = position;
        let index = row;
        if index < self.src.len() {
            if self.src[index].is_empty() {
                self.src[index].push_str(input);
            } else {
                self.src[index].insert_str(char_offset, input);
            }
        } else {
            self.resize_rows(index + 1);
            self.src[index] = input.to_string();
        }
    }
}