-
Notifications
You must be signed in to change notification settings - Fork 815
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Initial undo related machinery added to TextArea * Initial undo implementation * Basic undo and redo * Some more fleshing out of undo and redo * Skeleton code for managing TextArea history * Initial implementation of undo & redo checkpointing in TextArea * Increase checkpoint characters * Restoring the selection in the TextArea and then restoring it on undo * Adding docstrings to undo_batch and redo_batch in the TextArea * Batching edits of the same type * Batching edits of the same type * Keeping edits containing newlines in their own batch * Checking for newline characters in insertion or replacement during undo checkpoint creation. Updating docstrings in history.py * Fix mypy warning * Performance improvement * Add history checkpoint on cursor movement * Fixing merge conflict in Edit class * Fixing error in merge conflict resolution * Remove unused test file * Remove unused test file * Initial testing of undo and redo * Testing for undo redo * Updating lockfile * Add an extra test * Fix: setting the `text` property programmatically should invalidate the edit history * Improving docstrings * Rename EditHistory.reset() to EditHistory.clear() * Add docstring to an exception * Add a pause after focus/blur in a test * Forcing CI colour * Update focus checkpoint test * Try to force color in pytest by setting --color=yes in PYTEST_ADDOPTS in env var on Github Actions * Add extra assertion in a test * Toggle text_area has focus to trigger checkpoint in history * Apply grammar/wording suggestions from code review Co-authored-by: Rodrigo Girão Serrão <[email protected]> * Making max checkpoints configurable in TextArea history * Improve a docstring * Update changelog * Spelling fixes * More spelling fixes * Americanize spelling of tab_behaviour (->tab_behavior) * Update CHANGELOG regarding `tab_behaviour`->`tab_behavior` --------- Co-authored-by: Rodrigo Girão Serrão <[email protected]>
- Loading branch information
1 parent
b736c93
commit fa4f75f
Showing
14 changed files
with
1,180 additions
and
570 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,143 @@ | ||
| from __future__ import annotations | ||
|
|
||
| from dataclasses import dataclass, field | ||
| from typing import TYPE_CHECKING | ||
|
|
||
| from textual.document._document import EditResult, Location, Selection | ||
|
|
||
| if TYPE_CHECKING: | ||
| from textual.widgets import TextArea | ||
|
|
||
|
|
||
| @dataclass | ||
| class Edit: | ||
| """Implements the Undoable protocol to replace text at some range within a document.""" | ||
|
|
||
| text: str | ||
| """The text to insert. An empty string is equivalent to deletion.""" | ||
|
|
||
| from_location: Location | ||
| """The start location of the insert.""" | ||
|
|
||
| to_location: Location | ||
| """The end location of the insert""" | ||
|
|
||
| maintain_selection_offset: bool | ||
| """If True, the selection will maintain its offset to the replacement range.""" | ||
|
|
||
| _original_selection: Selection | None = field(init=False, default=None) | ||
| """The Selection when the edit was originally performed, to be restored on undo.""" | ||
|
|
||
| _updated_selection: Selection | None = field(init=False, default=None) | ||
| """Where the selection should move to after the replace happens.""" | ||
|
|
||
| _edit_result: EditResult | None = field(init=False, default=None) | ||
| """The result of doing the edit.""" | ||
|
|
||
| def do(self, text_area: TextArea, record_selection: bool = True) -> EditResult: | ||
| """Perform the edit operation. | ||
| Args: | ||
| text_area: The `TextArea` to perform the edit on. | ||
| record_selection: If True, record the current selection in the TextArea | ||
| so that it may be restored if this Edit is undone in the future. | ||
| Returns: | ||
| An `EditResult` containing information about the replace operation. | ||
| """ | ||
| if record_selection: | ||
| self._original_selection = text_area.selection | ||
|
|
||
| text = self.text | ||
|
|
||
| # This code is mostly handling how we adjust TextArea.selection | ||
| # when an edit is made to the document programmatically. | ||
| # We want a user who is typing away to maintain their relative | ||
| # position in the document even if an insert happens before | ||
| # their cursor position. | ||
|
|
||
| edit_bottom_row, edit_bottom_column = self.bottom | ||
|
|
||
| selection_start, selection_end = text_area.selection | ||
| selection_start_row, selection_start_column = selection_start | ||
| selection_end_row, selection_end_column = selection_end | ||
|
|
||
| edit_result = text_area.document.replace_range(self.top, self.bottom, text) | ||
|
|
||
| new_edit_to_row, new_edit_to_column = edit_result.end_location | ||
|
|
||
| column_offset = new_edit_to_column - edit_bottom_column | ||
| target_selection_start_column = ( | ||
| selection_start_column + column_offset | ||
| if edit_bottom_row == selection_start_row | ||
| and edit_bottom_column <= selection_start_column | ||
| else selection_start_column | ||
| ) | ||
| target_selection_end_column = ( | ||
| selection_end_column + column_offset | ||
| if edit_bottom_row == selection_end_row | ||
| and edit_bottom_column <= selection_end_column | ||
| else selection_end_column | ||
| ) | ||
|
|
||
| row_offset = new_edit_to_row - edit_bottom_row | ||
| target_selection_start_row = selection_start_row + row_offset | ||
| target_selection_end_row = selection_end_row + row_offset | ||
|
|
||
| if self.maintain_selection_offset: | ||
| self._updated_selection = Selection( | ||
| start=(target_selection_start_row, target_selection_start_column), | ||
| end=(target_selection_end_row, target_selection_end_column), | ||
| ) | ||
| else: | ||
| self._updated_selection = Selection.cursor(edit_result.end_location) | ||
|
|
||
| self._edit_result = edit_result | ||
| return edit_result | ||
|
|
||
| def undo(self, text_area: TextArea) -> EditResult: | ||
| """Undo the edit operation. | ||
| Looks at the data stored in the edit, and performs the inverse operation of `Edit.do`. | ||
| Args: | ||
| text_area: The `TextArea` to undo the insert operation on. | ||
| Returns: | ||
| An `EditResult` containing information about the replace operation. | ||
| """ | ||
| replaced_text = self._edit_result.replaced_text | ||
| edit_end = self._edit_result.end_location | ||
|
|
||
| # Replace the span of the edit with the text that was originally there. | ||
| undo_edit_result = text_area.document.replace_range( | ||
| self.top, edit_end, replaced_text | ||
| ) | ||
| self._updated_selection = self._original_selection | ||
|
|
||
| return undo_edit_result | ||
|
|
||
| def after(self, text_area: TextArea) -> None: | ||
| """Hook for running code after an Edit has been performed via `Edit.do` *and* | ||
| side effects such as re-wrapping the document and refreshing the display | ||
| have completed. | ||
| For example, we can't record cursor visual offset until we know where the cursor will | ||
| land *after* wrapping has been performed, so we must wait until here to do it. | ||
| Args: | ||
| text_area: The `TextArea` this operation was performed on. | ||
| """ | ||
| if self._updated_selection is not None: | ||
| text_area.selection = self._updated_selection | ||
| text_area.record_cursor_width() | ||
|
|
||
| @property | ||
| def top(self) -> Location: | ||
| """The Location impacted by this edit that is nearest the start of the document.""" | ||
| return min([self.from_location, self.to_location]) | ||
|
|
||
| @property | ||
| def bottom(self) -> Location: | ||
| """The Location impacted by this edit that is nearest the end of the document.""" | ||
| return max([self.from_location, self.to_location]) |
Oops, something went wrong.