cellix-doc 0.6.1

Documents for Cellix: typeset math, HTML export, LaTeX structure and PDF pages
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
//! Editing a Markdown table as a table. Every change rewrites it with its columns lined up,
//! so the source stays as readable as the page.

/// What can be done to a table, from the cell the caret is in.
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum Edit {
    RowAbove,
    RowBelow,
    ColumnLeft,
    ColumnRight,
    DeleteRow,
    DeleteColumn,
    Align(Align),
    Delete,
}

#[derive(Clone, Copy, Debug, Default, PartialEq, Eq)]
pub enum Align {
    #[default]
    Default,
    Left,
    Centre,
    Right,
}

/// The rows, the alignment of each column, without the rule between header and body.
#[derive(Debug, PartialEq, Eq)]
struct Table {
    rows: Vec<Vec<String>>,
    aligns: Vec<Align>,
}

/// Splits a row at its pipes, leaving `\|` and pipes in code alone.
fn cells(line: &str) -> Vec<String> {
    let text = line.trim();
    let text = text.strip_prefix('|').unwrap_or(text);
    let text = text.strip_suffix('|').unwrap_or(text);
    let mut out = vec![String::new()];
    let (mut escaped, mut code) = (false, false);
    for c in text.chars() {
        if c == '|' && !escaped && !code {
            out.push(String::new());
        } else if let Some(cell) = out.last_mut() {
            cell.push(c);
        }
        code ^= c == '`';
        escaped = c == '\\' && !escaped;
    }
    out.iter().map(|c| c.trim().to_string()).collect()
}

fn align_of(cell: &str) -> Align {
    match (cell.starts_with(':'), cell.ends_with(':')) {
        (true, true) => Align::Centre,
        (true, false) => Align::Left,
        (false, true) => Align::Right,
        _ => Align::Default,
    }
}

fn parse(text: &str) -> Option<Table> {
    let lines: Vec<&str> = text.lines().collect();
    let rule = lines.get(1)?;
    let aligns: Vec<Align> = cells(rule).iter().map(|c| align_of(c)).collect();
    let mut rows: Vec<Vec<String>> = lines
        .iter()
        .enumerate()
        .filter(|(index, _)| *index != 1)
        .map(|(_, line)| cells(line))
        .collect();
    let columns = rows
        .iter()
        .map(Vec::len)
        .chain([aligns.len()])
        .max()
        .unwrap_or(1);
    for row in &mut rows {
        row.resize(columns, String::new());
    }
    let mut aligns = aligns;
    aligns.resize(columns, Align::Default);
    Some(Table { rows, aligns })
}

fn print(table: &Table) -> String {
    let columns = table.aligns.len();
    let widths: Vec<usize> = (0..columns)
        .map(|c| {
            let longest = table.rows.iter().map(|r| r[c].chars().count());
            longest.max().unwrap_or(0).max(3)
        })
        .collect();
    let line = |row: &[String]| {
        let shown: Vec<String> = row
            .iter()
            .zip(&widths)
            .map(|(cell, width)| format!("{cell:<width$}"))
            .collect();
        format!("| {} |", shown.join(" | "))
    };
    let rule: Vec<String> = table
        .aligns
        .iter()
        .zip(&widths)
        .map(|(align, width)| {
            let dashes = width.saturating_sub(match align {
                Align::Centre => 2,
                Align::Default => 0,
                _ => 1,
            });
            let dashes = "-".repeat(dashes);
            match align {
                Align::Default => dashes,
                Align::Left => format!(":{dashes}"),
                Align::Right => format!("{dashes}:"),
                Align::Centre => format!(":{dashes}:"),
            }
        })
        .collect();
    let mut out = vec![line(&table.rows[0]), format!("| {} |", rule.join(" | "))];
    out.extend(table.rows[1..].iter().map(|row| line(row)));
    out.join("\n")
}

/// Where a cell's text starts in printed table text, in chars.
pub fn cell_offset(text: &str, row: usize, column: usize) -> usize {
    let line = if row == 0 { 0 } else { row + 1 };
    let mut at = 0;
    for (index, source) in text.split('\n').enumerate() {
        if index == line {
            let mut pipes = 0;
            for (i, c) in source.chars().enumerate() {
                if c == '|' {
                    pipes += 1;
                    if pipes == column + 1 {
                        return at + i + 2;
                    }
                }
            }
        }
        at += source.chars().count() + 1;
    }
    0
}

/// Applies an edit to a table's text, from the cell at `(row, column)`, counting the header
/// as row zero and leaving out the rule. Returns the new text, and the cell to land in.
/// Deleting the table, or its only row or column, returns None for the text.
pub fn apply(text: &str, row: usize, column: usize, edit: Edit) -> Option<(String, usize, usize)> {
    let mut table = parse(text)?;
    let columns = table.aligns.len();
    let blank = || vec![String::new(); columns];
    let (mut row, mut column) = (row.min(table.rows.len() - 1), column.min(columns - 1));
    match edit {
        // A table always has its header, so a row above that goes under it.
        Edit::RowAbove if row == 0 => {
            table.rows.insert(1, blank());
            row = 1;
        }
        Edit::RowAbove => table.rows.insert(row, blank()),
        Edit::RowBelow => {
            table.rows.insert(row + 1, blank());
            row += 1;
        }
        Edit::ColumnLeft | Edit::ColumnRight => {
            let at = column + usize::from(edit == Edit::ColumnRight);
            for cells in &mut table.rows {
                cells.insert(at, String::new());
            }
            table.aligns.insert(at, Align::Default);
            column = at;
        }
        Edit::DeleteRow if table.rows.len() == 1 => return None,
        Edit::DeleteRow if row == 0 => {
            // The first body row becomes the header.
            table.rows.remove(0);
        }
        Edit::DeleteRow => {
            table.rows.remove(row);
            row = row.min(table.rows.len() - 1);
        }
        Edit::DeleteColumn if columns == 1 => return None,
        Edit::DeleteColumn => {
            for cells in &mut table.rows {
                cells.remove(column);
            }
            table.aligns.remove(column);
            column = column.min(columns - 2);
        }
        Edit::Align(align) => table.aligns[column] = align,
        Edit::Delete => return None,
    }
    Some((print(&table), row, column))
}

/// Which field a row of data is at, given the text before the caret.
pub fn field_of(before: &str, separator: char) -> usize {
    let mut quoted = false;
    let mut field = 0;
    for c in before.chars() {
        quoted ^= c == '"';
        field += usize::from(c == separator && !quoted);
    }
    field
}

fn field_split(line: &str, separator: char) -> Vec<String> {
    let mut out = vec![String::new()];
    let mut quoted = false;
    for c in line.chars() {
        quoted ^= c == '"';
        if c == separator && !quoted {
            out.push(String::new());
        } else if let Some(field) = out.last_mut() {
            field.push(c);
        }
    }
    out
}

/// Changes rows of data, and says where the caret goes, in chars. None leaves it as it was:
/// data keeps at least one row and column, and has no alignment to change.
pub fn edit_rows(
    text: &str,
    separator: char,
    row: usize,
    column: usize,
    edit: Edit,
) -> Option<(String, usize)> {
    let mut rows: Vec<Vec<String>> = text
        .lines()
        .map(|line| field_split(line, separator))
        .collect();
    let columns = rows.iter().map(Vec::len).max()?;
    for cells in &mut rows {
        cells.resize(columns, String::new());
    }
    let (mut row, mut column) = (row.min(rows.len() - 1), column.min(columns - 1));
    match edit {
        Edit::RowAbove => rows.insert(row, vec![String::new(); columns]),
        Edit::RowBelow => {
            row += 1;
            rows.insert(row, vec![String::new(); columns]);
        }
        Edit::ColumnLeft | Edit::ColumnRight => {
            column += usize::from(edit == Edit::ColumnRight);
            for cells in &mut rows {
                cells.insert(column, String::new());
            }
        }
        Edit::DeleteRow if rows.len() > 1 => {
            rows.remove(row);
            row = row.min(rows.len() - 1);
        }
        Edit::DeleteColumn if columns > 1 => {
            for cells in &mut rows {
                cells.remove(column);
            }
            column = column.min(columns - 2);
        }
        _ => return None,
    }
    let glue = separator.to_string();
    let lines: Vec<String> = rows.iter().map(|cells| cells.join(&glue)).collect();
    let before: usize = lines[..row].iter().map(|l| l.chars().count() + 1).sum();
    let inside: usize = rows[row][..column]
        .iter()
        .map(|cell| cell.chars().count() + 1)
        .sum();
    Some((lines.join("\n"), before + inside))
}

/// A new, empty table with a header row.
pub fn new_table(rows: usize, columns: usize) -> String {
    let rows = rows.max(2);
    let columns = columns.max(1);
    let table = Table {
        rows: (0..rows)
            .map(|row| {
                (0..columns)
                    .map(|c| {
                        if row == 0 {
                            format!("Column {}", c + 1)
                        } else {
                            String::new()
                        }
                    })
                    .collect()
            })
            .collect(),
        aligns: vec![Align::Default; columns],
    };
    print(&table)
}

#[cfg(test)]
mod tests {
    use super::*;

    const TABLE: &str = "| A | B |\n|---|---|\n| 1 | 2 |\n| 3 | 4 |";

    fn rows(text: &str) -> Vec<Vec<String>> {
        parse(text).unwrap().rows
    }

    #[test]
    fn rows_go_in_above_and_below() {
        let (text, row, _) = apply(TABLE, 1, 0, Edit::RowBelow).unwrap();
        assert_eq!(rows(&text).len(), 4);
        assert_eq!(rows(&text)[2], ["", ""]);
        assert_eq!(row, 2);
        let (text, row, _) = apply(TABLE, 2, 0, Edit::RowAbove).unwrap();
        assert_eq!(rows(&text)[2], ["", ""]);
        assert_eq!(rows(&text)[3], ["3", "4"]);
        assert_eq!(row, 2);
    }

    #[test]
    fn a_row_above_the_header_goes_under_it() {
        let (text, row, _) = apply(TABLE, 0, 0, Edit::RowAbove).unwrap();
        assert_eq!(rows(&text)[0], ["A", "B"]);
        assert_eq!(rows(&text)[1], ["", ""]);
        assert_eq!(row, 1);
    }

    #[test]
    fn columns_go_in_either_side() {
        let (text, _, column) = apply(TABLE, 1, 0, Edit::ColumnRight).unwrap();
        assert_eq!(rows(&text)[1], ["1", "", "2"]);
        assert_eq!(column, 1);
        let (text, _, column) = apply(TABLE, 1, 1, Edit::ColumnLeft).unwrap();
        assert_eq!(rows(&text)[0], ["A", "", "B"]);
        assert_eq!(column, 1);
    }

    #[test]
    fn rows_and_columns_come_out() {
        let (text, ..) = apply(TABLE, 1, 0, Edit::DeleteRow).unwrap();
        assert_eq!(rows(&text), [["A", "B"], ["3", "4"]]);
        let (text, ..) = apply(TABLE, 1, 0, Edit::DeleteColumn).unwrap();
        assert_eq!(rows(&text), [["B"], ["2"], ["4"]]);
        let (text, ..) = apply(TABLE, 0, 0, Edit::DeleteRow).unwrap();
        assert_eq!(
            rows(&text)[0],
            ["1", "2"],
            "the next row becomes the header"
        );
    }

    #[test]
    fn the_last_of_anything_takes_the_table_with_it() {
        assert_eq!(apply("| A |\n|---|", 0, 0, Edit::DeleteColumn), None);
        assert_eq!(apply("| A |\n|---|", 0, 0, Edit::DeleteRow), None);
        assert_eq!(apply(TABLE, 1, 1, Edit::Delete), None);
    }

    #[test]
    fn alignment_is_written_in_the_rule() {
        let (text, ..) = apply(TABLE, 1, 1, Edit::Align(Align::Right)).unwrap();
        assert!(text.lines().nth(1).unwrap().contains("--:"), "{text}");
        let (again, ..) = apply(&text, 1, 0, Edit::Align(Align::Centre)).unwrap();
        assert!(again.lines().nth(1).unwrap().contains(":-:"), "{again}");
        let parsed = parse(&again).unwrap();
        assert_eq!(parsed.aligns, [Align::Centre, Align::Right]);
    }

    #[test]
    fn pipes_in_code_and_escapes_are_text() {
        let table = "| a |\n|---|\n| `x|y` |\n| p\\|q |";
        assert_eq!(rows(table)[1], ["`x|y`"]);
        assert_eq!(rows(table)[2], ["p\\|q"]);
    }

    #[test]
    fn the_caret_can_find_a_cell_again() {
        let (text, row, column) = apply(TABLE, 2, 0, Edit::ColumnRight).unwrap();
        let at = cell_offset(&text, row, column);
        let chars: Vec<char> = text.chars().collect();
        assert_eq!(chars[at - 2], '|');
        assert_eq!(chars[at - 1], ' ');
        let first = cell_offset(&text, 0, 0);
        assert_eq!(chars[first], 'A');
    }

    #[test]
    fn rows_of_data_grow_and_shrink() {
        let text = "a,b\n1,2";
        let (grown, at) = edit_rows(text, ',', 1, 0, Edit::RowBelow).unwrap();
        assert_eq!(grown, "a,b\n1,2\n,");
        assert_eq!(at, 8);
        let (wider, at) = edit_rows(text, ',', 1, 0, Edit::ColumnRight).unwrap();
        assert_eq!(wider, "a,,b\n1,,2");
        assert_eq!(at, 7);
        let (less, _) = edit_rows(text, ',', 1, 1, Edit::DeleteColumn).unwrap();
        assert_eq!(less, "a\n1");
        assert_eq!(edit_rows("a,b", ',', 0, 0, Edit::DeleteRow), None);
        assert_eq!(edit_rows(text, ',', 0, 0, Edit::Align(Align::Left)), None);
    }

    #[test]
    fn a_quoted_comma_is_not_a_new_field() {
        assert_eq!(field_of("\"a,b\",c", ','), 1);
        let (wider, _) = edit_rows("\"a,b\",c", ',', 0, 1, Edit::DeleteColumn).unwrap();
        assert_eq!(wider, "\"a,b\"");
    }

    #[test]
    fn a_new_table_has_a_header_and_its_size() {
        let text = new_table(3, 4);
        assert_eq!(rows(&text).len(), 3);
        assert_eq!(rows(&text)[0][3], "Column 4");
        assert_eq!(text.lines().count(), 4);
    }
}