sprawling-documents 0.0.9

The rules of a document a person reads and edits through a sprawling city's page: versions, characters, windows and saves.
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

// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at https://mozilla.org/MPL/2.0/.
// Copyright (c) 2026 2youg1 and the sprawling contributors

//! A reader's place in a document, carried across a save
//! (`crates/documents/Spec.lean` D10).

use crate::edit::Transaction;
use crate::span::Span;

/// Where a selection was begun and where it was carried to, as byte
/// offsets of one version; collapsed when the two are the same offset.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct Selection {
    pub anchor: u64,
    pub focus: u64,
}

impl Selection {
    /// A caret at `at`.
    pub const fn collapsed(at: u64) -> Selection {
        Selection {
            anchor: at,
            focus: at,
        }
    }

    /// The bytes the selection covers, whichever way it was drawn.
    pub fn span(self) -> Span {
        Span::ordered(self.anchor, self.focus)
    }

    /// Where this selection stands in the version `transaction` makes.
    ///
    /// An offset before an edit stays put, an insertion at the offset
    /// itself included; one after it moves by what the edit added and
    /// removed; one inside a replaced span moves to the end of what
    /// replaced it, because the bytes it pointed into are gone.
    pub fn mapped(self, transaction: &Transaction) -> Selection {
        Selection {
            anchor: position_after(self.anchor, transaction),
            focus: position_after(self.focus, transaction),
        }
    }
}

fn position_after(at: u64, transaction: &Transaction) -> u64 {
    let mut added = 0_u64;
    let mut removed = 0_u64;
    for edit in transaction.edits() {
        let span = edit.span;
        if at <= span.start() {
            break;
        }
        let written = crate::span::offset(edit.bytes.len());
        if at < span.end() {
            return span
                .start()
                .saturating_add(added)
                .saturating_sub(removed)
                .saturating_add(written);
        }
        added = added.saturating_add(written);
        removed = removed.saturating_add(span.len());
    }
    at.saturating_add(added).saturating_sub(removed)
}

#[cfg(test)]
#[allow(
    clippy::unwrap_used,
    clippy::expect_used,
    clippy::panic,
    clippy::indexing_slicing,
    reason = "test code"
)]
mod tests {
    use kernel::B3Hash;

    use super::*;
    use crate::edit::Edit;

    fn save(source: &[u8], edits: &[(u64, u64, &[u8])]) -> Transaction {
        Transaction::new(
            B3Hash::digest(source),
            edits
                .iter()
                .map(|(start, end, bytes)| Edit {
                    span: Span::new(*start, *end).unwrap(),
                    bytes: bytes.to_vec(),
                })
                .collect(),
        )
        .unwrap()
    }

    /// A caret before, inside and after the edits of one save lands on
    /// the same character it stood beside, or past what replaced the
    /// bytes it stood in.
    #[test]
    fn a_selection_follows_the_text_it_stood_beside() {
        let source = b"0123456789";
        let saved = save(source, &[(2, 2, b"ab"), (4, 7, b"x")]);
        let after = saved.apply(source).unwrap();
        assert_eq!(after.bytes(), b"01ab23x789");
        let mapped = |at: u64| Selection::collapsed(at).mapped(&saved).anchor;
        assert_eq!(mapped(1), 1);
        assert_eq!(mapped(2), 2);
        assert_eq!(mapped(3), 5);
        assert_eq!(mapped(5), 7);
        assert_eq!(mapped(8), 8);
        assert_eq!(mapped(10), 10);
        let drawn = Selection {
            anchor: 9,
            focus: 1,
        }
        .mapped(&saved);
        assert_eq!(drawn.span(), Span::new(1, 9).unwrap());
    }
}