aboutsummaryrefslogtreecommitdiff
path: root/helix-core/src/history.rs
blob: 8d7164dbb3eaa0fdc37f164a32c394ddcbb92cca (plain) (blame)
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
use crate::{ChangeSet, Rope, State, Transaction};

/// Undo-tree style history store.
pub struct History {
    revisions: Vec<Revision>,
    cursor: usize,
    //
}

#[derive(Debug)]
struct Revision {
    // prev: usize,
    parent: usize,
    /// The transaction to revert to previous state.
    revert: Transaction,
    // selection before, selection after?
}

impl Default for History {
    fn default() -> Self {
        // Add a dummy root revision with empty transaction
        Self {
            revisions: vec![Revision {
                parent: 0,
                revert: Transaction::from(ChangeSet::new(&Rope::new())),
            }],
            cursor: 0,
        }
    }
}

impl History {
    pub fn commit_revision(&mut self, transaction: &Transaction, original: &State) {
        // TODO: store both directions
        // TODO: could store a single set if deletes also stored the text they delete
        let revert = transaction.invert(original);

        let new_cursor = self.revisions.len();
        self.revisions.push(Revision {
            parent: self.cursor,
            revert,
        });
        self.cursor = new_cursor;

        // TODO: child tracking too?
    }

    #[inline]
    pub fn at_root(&self) -> bool {
        self.cursor == 0
    }

    pub fn undo(&mut self, state: &mut State) {
        if self.at_root() {
            // We're at the root of undo, nothing to do.
            return;
        }

        let current_revision = &self.revisions[self.cursor];
        // unimplemented!("{:?}", revision);
        // unimplemented!("{:?}", state.doc().len_chars());
        // TODO: pass the return value through?
        let success = current_revision.revert.apply(state);

        if !success {
            panic!("Failed to apply undo!");
        }

        self.cursor = current_revision.parent;
    }

    pub fn redo(&mut self, state: &mut State) {
        let current_revision = &self.revisions[self.cursor];

        // TODO: pick the latest child

        // if !success {
        //     panic!("Failed to apply undo!");
        // }

        unimplemented!()
    }
}

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

    #[test]
    fn test_undo_redo() {
        let mut history = History::default();
        let doc = Rope::from("hello");
        let mut state = State::new(doc);

        let transaction1 =
            Transaction::change(&state, vec![(5, 5, Some(" world!".into()))].into_iter());

        // Need to commit before applying!
        history.commit_revision(&transaction1, &state);
        transaction1.apply(&mut state);
        assert_eq!("hello world!", state.doc());

        // ---

        let transaction2 =
            Transaction::change(&state, vec![(6, 11, Some("世界".into()))].into_iter());

        // Need to commit before applying!
        history.commit_revision(&transaction2, &state);
        transaction2.apply(&mut state);
        assert_eq!("hello 世界!", state.doc());

        // ---

        history.undo(&mut state);
        assert_eq!("hello world!", state.doc());
        history.redo(&mut state);
        assert_eq!("hello 世界!", state.doc());
        history.undo(&mut state);
        history.undo(&mut state);
        assert_eq!("hello", state.doc());

        // undo at root is a no-op
        history.undo(&mut state);
        assert_eq!("hello", state.doc());
    }
}