rat_text/

undo_buffer.rs

//! Undo functionality.

use crate::range_map::expand_range_by;
use crate::TextPosition;
use crate::_private::NonExhaustive;
use dyn_clone::DynClone;
use std::fmt::Debug;
use std::mem;
use std::ops::Range;

/// Undo buffer.
///
/// Keeps up to undo_count operations that can be undone/redone.
///
/// Additionally, it can provide a change-log which can be used
/// to sync other text-widgets.
///
pub trait UndoBuffer: DynClone + Debug {
    /// How many undoes are stored?
    fn undo_count(&self) -> u32;

    /// How many undoes are stored?
    fn set_undo_count(&mut self, n: u32);

    /// Begin a sequence of changes that should be undone at once.
    ///
    /// begin/end calls can be nested, but only the outer one
    /// will define the actual scope of the undo.
    ///
    /// A call to begin_seq must be matched with a call to end_seq.
    fn begin_seq(&mut self);

    /// End a sequence of changes that should be undone at once.
    fn end_seq(&mut self);

    /// Appends a new operation at the current undo-position.
    ///
    /// Redoes will be truncated by this call.
    ///
    /// This call tries merge InsertChar/RemoveChar operations,
    /// if they lie next to each other. InsertStr/RemoveStr
    /// will never be merged.
    fn append(&mut self, undo: UndoOp);

    /// Appends a new operation but doesn't fill the replay-log.
    ///
    /// Used to add to the undo-buffer during replay from another
    /// text-widget.
    fn append_from_replay(&mut self, undo: UndoEntry);

    /// Clear the undo and the replay buffer.
    fn clear(&mut self);

    /// Get the number of possible undo operations.
    fn open_undo(&self) -> usize;

    /// Get the number of possible redo operations.
    fn open_redo(&self) -> usize;

    /// Get the list of the next undo operations.
    fn undo(&mut self) -> Vec<&UndoOp>;

    /// Get the list of the next redo operations.
    fn redo(&mut self) -> Vec<&UndoOp>;

    /// Enable/disable replay recording.
    ///
    /// __Attention__:
    /// For this to work the widget state must be in a 'cleared' state,
    /// or you must *create a clone* of the widget-state *immediately* after
    /// activating the replay-log.
    ///
    /// Only then the replay operations obtained by recent_replay()
    /// will make sense to the clone.
    ///
    /// __Info__:
    /// How you identify the widgets that should receive the replay-log
    /// and other distribution problems are in the domain of the user
    /// of this feature.
    fn enable_replay_log(&mut self, replay: bool);

    /// Is the replay-log active?
    fn has_replay_log(&self) -> bool;

    /// Get the replay-log to sync with another textarea.
    /// This empties the replay buffer.
    fn recent_replay_log(&mut self) -> Vec<UndoEntry>;

    /// Is there undo for setting/removing styles.
    fn undo_styles_enabled(&self) -> bool;
}

/// Stores one style change.
#[derive(Debug, Default, Clone)]
pub struct StyleChange {
    pub before: Range<usize>,
    pub after: Range<usize>,
    pub style: usize,
}

/// Stores a text position change.
#[derive(Debug, Default, Clone)]
pub struct TextPositionChange {
    pub before: TextPosition,
    pub after: TextPosition,
}

/// Storage for undo.
#[derive(Debug, Clone)]
pub struct UndoEntry {
    pub sequence: u32,
    pub operation: UndoOp,
    pub non_exhaustive: NonExhaustive,
}

/// Storage for undo.
#[non_exhaustive]
#[derive(Debug, Clone)]
pub enum UndoOp {
    /// Insert a single char/grapheme.
    ///
    /// This can contain a longer text, if consecutive InsertChar have
    /// been merged.
    InsertChar {
        /// byte range for the insert.
        bytes: Range<usize>,
        /// cursor position change
        cursor: TextPositionChange,
        /// anchor position change
        anchor: TextPositionChange,
        /// inserted text
        txt: String,
    },
    /// Insert a longer text.
    InsertStr {
        /// byte range for the insert.
        bytes: Range<usize>,
        /// cursor position change
        cursor: TextPositionChange,
        /// anchor position change
        anchor: TextPositionChange,
        /// inserted text
        txt: String,
    },
    /// Remove a single char/grapheme range.
    ///
    /// This can be a longer range, if consecutive RemoveChar have been
    /// merged.
    ///
    /// styles contains only styles whose range __intersects__ the
    /// removed range. Styles that lie after the bytes-range will be
    /// shifted left.
    RemoveChar {
        /// byte range for the remove.
        bytes: Range<usize>,
        /// cursor position change
        cursor: TextPositionChange,
        /// anchor position change
        anchor: TextPositionChange,
        /// removed text
        txt: String,
        /// removed styles
        styles: Vec<StyleChange>,
    },
    /// Remove longer text range.
    ///
    /// styles contains only styles whose range __intersects__ the
    /// removed range. Styles that lie after the bytes-range will be
    /// shifted left.
    RemoveStr {
        /// byte range for the remove.
        bytes: Range<usize>,
        /// cursor position change
        cursor: TextPositionChange,
        /// anchor position change
        anchor: TextPositionChange,
        /// removed text
        txt: String,
        /// removed styles
        styles: Vec<StyleChange>,
    },

    /// Cursor/anchor changed.
    ///
    /// This will be merged with a cursor-change immediately before.
    /// And it will merge with both removes and inserts.
    Cursor {
        /// cursor position change
        cursor: TextPositionChange,
        /// anchor position change
        anchor: TextPositionChange,
    },

    /// Set of styles was replaced.
    SetStyles {
        /// old styles
        styles_before: Vec<(Range<usize>, usize)>,
        /// new styles
        styles_after: Vec<(Range<usize>, usize)>,
    },
    /// Add one style.
    AddStyle {
        /// style range
        range: Range<usize>,
        /// style
        style: usize,
    },
    /// Remove one style.
    RemoveStyle {
        /// style range
        range: Range<usize>,
        /// style
        style: usize,
    },

    /// For replay only. Complete content was replaced.
    SetText {
        /// New text
        txt: String,
    },
    /// For replay only. Undo one operation.
    Undo,
    /// For replay only. Redo one operation.
    Redo,
}

/// Standard implementation for undo.
#[derive(Debug, Clone)]
pub struct UndoVec {
    undo_styles: bool,
    track_replay: bool,
    undo_count: u32,

    begin: u8,
    sequence: u32,
    buf: Vec<UndoEntry>,
    replay: Vec<UndoEntry>,

    // undo/redo split
    idx: usize,
}

impl Default for UndoVec {
    fn default() -> Self {
        Self {
            undo_styles: false,
            track_replay: false,
            undo_count: 99,
            begin: 0,
            sequence: 0,
            buf: Vec::default(),
            replay: Vec::default(),
            idx: 0,
        }
    }
}

impl UndoVec {
    /// New undo.
    pub fn new(undo_count: u32) -> Self {
        Self {
            undo_count,
            ..Default::default()
        }
    }

    /// Enable undo for style changes.
    ///
    /// Usually not what you want.
    /// Unless you allow your users to set styles manually.
    /// If your styling is done by a parser, don't activate this.
    ///
    /// Changes to the range of styles and removal of styles
    /// caused by text edits *will* be undone anyway.
    ///
    /// Recording those operations for *replay* will not be affected
    /// by this setting.
    pub fn enable_undo_styles(&mut self, undo_styles: bool) {
        self.undo_styles = undo_styles;
    }

    /// Undo for styles are enabled.
    pub fn undo_styles(&self) -> bool {
        self.undo_styles
    }

    fn merge_undo(mut last: UndoOp, mut curr: UndoOp) -> (Option<UndoOp>, Option<UndoOp>) {
        match &mut curr {
            UndoOp::InsertChar {
                bytes: curr_bytes,
                cursor: curr_cursor,
                anchor: curr_anchor,
                txt: curr_txt,
            } => match &mut last {
                UndoOp::InsertChar {
                    bytes: last_bytes,
                    cursor: last_cursor,
                    anchor: last_anchor,
                    txt: last_txt,
                } => {
                    if last_bytes.end == curr_bytes.start {
                        let mut last_txt = mem::take(last_txt);
                        last_txt.push_str(curr_txt);
                        (
                            Some(UndoOp::InsertChar {
                                bytes: last_bytes.start..curr_bytes.end,
                                cursor: TextPositionChange {
                                    before: last_cursor.before,
                                    after: curr_cursor.after,
                                },
                                anchor: TextPositionChange {
                                    before: last_anchor.before,
                                    after: curr_anchor.after,
                                },
                                txt: last_txt,
                            }),
                            None,
                        )
                    } else {
                        (Some(last), Some(curr))
                    }
                }
                _ => (Some(last), Some(curr)),
            },
            UndoOp::RemoveChar {
                bytes: curr_bytes,
                cursor: curr_cursor,
                anchor: curr_anchor,
                txt: curr_txt,
                styles: curr_styles,
            } => match &mut last {
                UndoOp::RemoveChar {
                    bytes: last_bytes,
                    cursor: last_cursor,
                    anchor: last_anchor,
                    txt: last_txt,
                    styles: last_styles,
                } => {
                    if curr_bytes.end == last_bytes.start {
                        // backspace
                        let mut txt = mem::take(curr_txt);
                        txt.push_str(last_txt);

                        // merge into last_styles
                        let mut styles = mem::take(last_styles);
                        Self::merge_remove_style(last_bytes.clone(), &mut styles, curr_styles);

                        (
                            Some(UndoOp::RemoveChar {
                                bytes: curr_bytes.start..last_bytes.end,
                                cursor: TextPositionChange {
                                    before: last_cursor.before,
                                    after: curr_cursor.after,
                                },
                                anchor: TextPositionChange {
                                    before: last_anchor.before,
                                    after: curr_anchor.after,
                                },
                                txt,
                                styles,
                            }),
                            None,
                        )
                    } else if curr_bytes.start == last_bytes.start {
                        // delete
                        let mut txt = mem::take(last_txt);
                        txt.push_str(curr_txt);

                        let curr_byte_len = curr_bytes.end - curr_bytes.start;

                        // merge into last_styles
                        let mut styles = mem::take(last_styles);
                        Self::merge_remove_style(last_bytes.clone(), &mut styles, curr_styles);

                        (
                            Some(UndoOp::RemoveChar {
                                bytes: last_bytes.start..last_bytes.end + curr_byte_len,
                                cursor: TextPositionChange {
                                    before: last_cursor.before,
                                    after: curr_cursor.after,
                                },
                                anchor: TextPositionChange {
                                    before: last_anchor.before,
                                    after: curr_anchor.after,
                                },
                                txt,
                                styles,
                            }),
                            None,
                        )
                    } else {
                        (Some(last), Some(curr))
                    }
                }
                _ => (Some(last), Some(curr)),
            },

            UndoOp::Cursor {
                cursor: curr_cursor,
                anchor: curr_anchor,
            } => match &mut last {
                UndoOp::InsertChar {
                    bytes: last_bytes,
                    cursor: last_cursor,
                    anchor: last_anchor,
                    txt: last_txt,
                } => (
                    Some(UndoOp::InsertChar {
                        bytes: mem::take(last_bytes),
                        cursor: TextPositionChange {
                            before: last_cursor.before,
                            after: curr_cursor.after,
                        },
                        anchor: TextPositionChange {
                            before: last_anchor.before,
                            after: curr_anchor.after,
                        },
                        txt: mem::take(last_txt),
                    }),
                    None,
                ),
                UndoOp::InsertStr {
                    bytes: last_bytes,
                    cursor: last_cursor,
                    anchor: last_anchor,
                    txt: last_txt,
                } => (
                    Some(UndoOp::InsertStr {
                        bytes: mem::take(last_bytes),
                        cursor: TextPositionChange {
                            before: last_cursor.before,
                            after: curr_cursor.after,
                        },
                        anchor: TextPositionChange {
                            before: last_anchor.before,
                            after: curr_anchor.after,
                        },
                        txt: mem::take(last_txt),
                    }),
                    None,
                ),
                UndoOp::RemoveChar {
                    bytes: last_bytes,
                    cursor: last_cursor,
                    anchor: last_anchor,
                    txt: last_txt,
                    styles: last_styles,
                } => (
                    Some(UndoOp::RemoveChar {
                        bytes: mem::take(last_bytes),
                        cursor: TextPositionChange {
                            before: last_cursor.before,
                            after: curr_cursor.after,
                        },
                        anchor: TextPositionChange {
                            before: last_anchor.before,
                            after: curr_anchor.after,
                        },
                        txt: mem::take(last_txt),
                        styles: mem::take(last_styles),
                    }),
                    None,
                ),
                UndoOp::RemoveStr {
                    bytes: last_bytes,
                    cursor: last_cursor,
                    anchor: last_anchor,
                    txt: last_txt,
                    styles: last_styles,
                } => (
                    Some(UndoOp::RemoveChar {
                        bytes: mem::take(last_bytes),
                        cursor: TextPositionChange {
                            before: last_cursor.before,
                            after: curr_cursor.after,
                        },
                        anchor: TextPositionChange {
                            before: last_anchor.before,
                            after: curr_anchor.after,
                        },
                        txt: mem::take(last_txt),
                        styles: mem::take(last_styles),
                    }),
                    None,
                ),
                UndoOp::Cursor {
                    cursor: last_cursor,
                    anchor: last_anchor,
                } => (
                    Some(UndoOp::Cursor {
                        cursor: TextPositionChange {
                            before: last_cursor.before,
                            after: curr_cursor.after,
                        },
                        anchor: TextPositionChange {
                            before: last_anchor.before,
                            after: curr_anchor.after,
                        },
                    }),
                    None,
                ),
                _ => (Some(last), Some(curr)),
            },
            _ => (Some(last), Some(curr)),
        }
    }

    /// Merge styles from two deletes.
    fn merge_remove_style(
        last_range: Range<usize>,
        last: &mut Vec<StyleChange>,
        curr: &mut Vec<StyleChange>,
    ) {
        for i in (0..last.len()).rev() {
            for j in (0..curr.len()).rev() {
                if last[i].style == curr[j].style {
                    if last[i].after == curr[j].before {
                        last[i].after = curr[j].after.clone();
                        curr.remove(j);
                    }
                }
            }
        }

        // expand before and add
        for mut curr in curr.drain(..) {
            curr.before = expand_range_by(last_range.clone(), curr.before);
            last.push(curr);
        }
    }
}

impl UndoVec {
    fn filter(&self, undo: &UndoOp) -> bool {
        // only useful for tracking
        if matches!(undo, UndoOp::Undo | UndoOp::Redo | UndoOp::SetText { .. }) {
            return true;
        }

        // style changes may/may not be undone
        if !self.undo_styles {
            match &undo {
                UndoOp::SetStyles { .. } | UndoOp::AddStyle { .. } | UndoOp::RemoveStyle { .. } => {
                    return true;
                }
                _ => {}
            }
        }

        false
    }

    fn try_merge(&mut self, undo: UndoOp) -> Option<UndoOp> {
        if let Some(UndoEntry {
            sequence,
            operation: last,
            ..
        }) = self.buf.pop()
        {
            let (last, undo) = Self::merge_undo(last, undo);
            // re-add last if it survived merge
            if let Some(last) = last {
                self.buf.push(UndoEntry {
                    sequence,
                    operation: last,
                    non_exhaustive: NonExhaustive,
                });
            }
            undo
        } else {
            Some(undo)
        }
    }

    fn trim_undo(&mut self) {
        // Dump redo.
        while self.idx < self.buf.len() {
            self.buf.pop();
        }

        // cap undo at capacity.
        // uses the sequence count instead of the size.
        let count_uniq = self
            .buf
            .iter()
            .fold((0, 0), |mut f, v| {
                if v.sequence != f.0 {
                    f.0 = v.sequence;
                    f.1 += 1;
                }
                f
            })
            .1;

        if count_uniq > self.undo_count as usize {
            // don't drop parts of current sequence at all.
            if self.buf[0].sequence != self.sequence {
                let drop_sequence = self.buf[0].sequence;
                loop {
                    if self.buf[0].sequence == drop_sequence {
                        self.buf.remove(0);
                    } else {
                        break;
                    }
                }
            }
        }
    }
}

impl UndoBuffer for UndoVec {
    fn undo_count(&self) -> u32 {
        self.undo_count
    }

    fn set_undo_count(&mut self, n: u32) {
        self.undo_count = n;
    }

    /// Begin a sequence of changes that should be undone at once.
    fn begin_seq(&mut self) {
        self.begin += 1;
        if self.begin == 1 {
            self.sequence += 1;
        }
    }

    /// End a sequence of changes.
    /// Unbalanced end_seq calls panic.
    fn end_seq(&mut self) {
        self.begin -= 1;
    }

    fn append(&mut self, undo: UndoOp) {
        let track_undo = if self.track_replay {
            Some(undo.clone())
        } else {
            None
        };

        // try merge
        let add_undo = if let Some(last) = self.buf.last() {
            // first begin starts a new sequence.
            // so this shouldn't cross that boundary.
            if last.sequence == self.sequence {
                self.try_merge(undo)
            } else {
                Some(undo)
            }
        } else {
            Some(undo)
        };

        // New separate undo.
        if add_undo.is_some() {
            // auto begin+end
            if self.begin == 0 {
                self.sequence += 1;
            }
        }

        // Store in tracking.
        // Sequence number is new if the merge failed, otherwise the
        // same as the last. This fact will be used when replaying.
        if let Some(track_undo) = track_undo {
            self.replay.push(UndoEntry {
                sequence: self.sequence,
                operation: track_undo,
                non_exhaustive: NonExhaustive,
            });
        }

        // Add if not merged.
        if let Some(add_undo) = add_undo {
            // Not everything is undo.
            if self.filter(&add_undo) {
                return;
            }
            // Drop redo and trim undo.
            self.trim_undo();

            // add new undo if it survived merge
            self.buf.push(UndoEntry {
                sequence: self.sequence,
                operation: add_undo,
                non_exhaustive: NonExhaustive,
            });

            self.idx = self.buf.len();
        }
    }

    fn append_from_replay(&mut self, undo: UndoEntry) {
        let UndoEntry {
            sequence,
            operation: undo,
            ..
        } = undo;

        // try merge
        let add_undo = if let Some(last) = self.buf.last() {
            // merges act just like sequences, so this
            // works out for both.
            if last.sequence == sequence {
                self.try_merge(undo)
            } else {
                Some(undo)
            }
        } else {
            Some(undo)
        };

        // sync sequence
        self.sequence = sequence;

        // Add if not merged.
        if let Some(add_undo) = add_undo {
            // Not everything is undo.
            if self.filter(&add_undo) {
                return;
            }
            // Drop redo and trim undo.
            self.trim_undo();

            // add new undo if it survived merge
            self.buf.push(UndoEntry {
                sequence,
                operation: add_undo,
                non_exhaustive: NonExhaustive,
            });

            self.idx = self.buf.len();
        }
    }

    fn clear(&mut self) {
        self.buf.clear();
        self.idx = 0;
        self.begin = 0;
        self.sequence = 0;
        self.replay.clear();
    }

    fn open_undo(&self) -> usize {
        self.idx
    }

    fn open_redo(&self) -> usize {
        self.buf.len() - self.idx
    }

    /// Get next undo
    fn undo(&mut self) -> Vec<&UndoOp> {
        if self.idx > 0 {
            let sequence = self.buf[self.idx - 1].sequence;
            let mut undo = Vec::new();
            loop {
                if self.buf[self.idx - 1].sequence == sequence {
                    undo.push(&self.buf[self.idx - 1].operation);
                    self.idx -= 1;
                } else {
                    break;
                }
                if self.idx == 0 {
                    break;
                }
            }
            undo
        } else {
            Vec::default()
        }
    }

    /// Get next redo
    fn redo(&mut self) -> Vec<&UndoOp> {
        if self.idx < self.buf.len() {
            let sequence = self.buf[self.idx].sequence;
            let mut redo = Vec::new();
            loop {
                if self.buf[self.idx].sequence == sequence {
                    redo.push(&self.buf[self.idx].operation);
                    self.idx += 1;
                } else {
                    break;
                }
                if self.idx == self.buf.len() {
                    break;
                }
            }
            redo
        } else {
            Vec::default()
        }
    }

    /// Enable replay functionality.
    ///
    /// This keeps track of all changes to a textarea.
    /// These changes can be copied to another textarea with
    /// the replay() function.
    fn enable_replay_log(&mut self, replay: bool) {
        if self.track_replay != replay {
            self.replay.clear();
        }
        self.track_replay = replay;
    }

    fn has_replay_log(&self) -> bool {
        self.track_replay
    }

    /// Get all new replay entries.
    fn recent_replay_log(&mut self) -> Vec<UndoEntry> {
        mem::take(&mut self.replay)
    }

    fn undo_styles_enabled(&self) -> bool {
        self.undo_styles
    }
}