From f4bdbe4674e6d023a63d2e64aec48c8c8598be67 Mon Sep 17 00:00:00 2001
From: Kyle Smith <askreet@gmail.com>
Date: Tue, 7 Mar 2023 20:53:31 -0500
Subject: [PATCH] Do not add intermediate lines to jumplist with :<linenum>
command. (#5751)
* Do not add intermediate lines to jumplist with :<linenum> command.
* Revert jumplist index changes.
* Reduce calculations during update cycle.
* Use jumplist for undo, set jumplist before preview.
* remove some debug logging
* Revert "remove some debug logging"
This reverts commit 5772c4327e7121c53ea0726a4d7333ae1c413ffb.
* Revert "Use jumplist for undo, set jumplist before preview."
This reverts commit f73a1b29824feaf16477b9df547fb28d9db81923.
* Add last_selection, update implementation.
* @pascalkuthe initial feedback
* Ensure ":goto 123" keybinding works as expected.
* fix clippies, prefer expect() for expect last_selection state
---
helix-term/src/commands.rs | 10 ++--
helix-term/src/commands/typed.rs | 80 ++++++++++++++++++++------------
helix-view/src/editor.rs | 11 +++--
3 files changed, 65 insertions(+), 36 deletions(-)
diff --git a/helix-term/src/commands.rs b/helix-term/src/commands.rs
index ebdfdfde..e09a1c5b 100644
--- a/helix-term/src/commands.rs
+++ b/helix-term/src/commands.rs
@@ -2828,10 +2828,15 @@ fn push_jump(view: &mut View, doc: &Document) {
}
fn goto_line(cx: &mut Context) {
- goto_line_impl(cx.editor, cx.count)
+ if cx.count.is_some() {
+ let (view, doc) = current!(cx.editor);
+ push_jump(view, doc);
+
+ goto_line_without_jumplist(cx.editor, cx.count);
+ }
}
-fn goto_line_impl(editor: &mut Editor, count: Option<NonZeroUsize>) {
+fn goto_line_without_jumplist(editor: &mut Editor, count: Option<NonZeroUsize>) {
if let Some(count) = count {
let (view, doc) = current!(editor);
let text = doc.text().slice(..);
@@ -2848,7 +2853,6 @@ fn goto_line_impl(editor: &mut Editor, count: Option<NonZeroUsize>) {
.clone()
.transform(|range| range.put_cursor(text, pos, editor.mode == Mode::Select));
- push_jump(view, doc);
doc.set_selection(view.id, selection);
}
}
diff --git a/helix-term/src/commands/typed.rs b/helix-term/src/commands/typed.rs
index 77c14321..7588b708 100644
--- a/helix-term/src/commands/typed.rs
+++ b/helix-term/src/commands/typed.rs
@@ -1572,47 +1572,67 @@ fn tutor(
Ok(())
}
+fn abort_goto_line_number_preview(cx: &mut compositor::Context) {
+ if let Some(last_selection) = cx.editor.last_selection.take() {
+ let scrolloff = cx.editor.config().scrolloff;
+
+ let (view, doc) = current!(cx.editor);
+ doc.set_selection(view.id, last_selection);
+ view.ensure_cursor_in_view(doc, scrolloff);
+ }
+}
+
+fn update_goto_line_number_preview(
+ cx: &mut compositor::Context,
+ args: &[Cow<str>],
+) -> anyhow::Result<()> {
+ cx.editor.last_selection.get_or_insert_with(|| {
+ let (view, doc) = current!(cx.editor);
+ doc.selection(view.id).clone()
+ });
+
+ let scrolloff = cx.editor.config().scrolloff;
+ let line = args[0].parse::<usize>()?;
+ goto_line_without_jumplist(cx.editor, NonZeroUsize::new(line));
+
+ let (view, doc) = current!(cx.editor);
+ view.ensure_cursor_in_view(doc, scrolloff);
+
+ Ok(())
+}
+
pub(super) fn goto_line_number(
cx: &mut compositor::Context,
args: &[Cow<str>],
event: PromptEvent,
) -> anyhow::Result<()> {
match event {
- PromptEvent::Abort => {
- if let Some(line_number) = cx.editor.last_line_number {
- goto_line_impl(cx.editor, NonZeroUsize::new(line_number));
- let (view, doc) = current!(cx.editor);
- view.ensure_cursor_in_view(doc, line_number);
- cx.editor.last_line_number = None;
- }
- return Ok(());
- }
+ PromptEvent::Abort => abort_goto_line_number_preview(cx),
PromptEvent::Validate => {
ensure!(!args.is_empty(), "Line number required");
- cx.editor.last_line_number = None;
- }
- PromptEvent::Update => {
- if args.is_empty() {
- if let Some(line_number) = cx.editor.last_line_number {
- // When a user hits backspace and there are no numbers left,
- // we can bring them back to their original line
- goto_line_impl(cx.editor, NonZeroUsize::new(line_number));
- let (view, doc) = current!(cx.editor);
- view.ensure_cursor_in_view(doc, line_number);
- cx.editor.last_line_number = None;
- }
- return Ok(());
- }
+
+ // If we are invoked directly via a keybinding, Validate is
+ // sent without any prior Update events. Ensure the cursor
+ // is moved to the appropriate location.
+ update_goto_line_number_preview(cx, args)?;
+
+ let last_selection = cx
+ .editor
+ .last_selection
+ .take()
+ .expect("update_goto_line_number_preview should always set last_selection");
+
let (view, doc) = current!(cx.editor);
- let text = doc.text().slice(..);
- let line = doc.selection(view.id).primary().cursor_line(text);
- cx.editor.last_line_number.get_or_insert(line + 1);
+ view.jumps.push((doc.id(), last_selection));
}
+
+ // When a user hits backspace and there are no numbers left,
+ // we can bring them back to their original selection. If they
+ // begin typing numbers again, we'll start a new preview session.
+ PromptEvent::Update if args.is_empty() => abort_goto_line_number_preview(cx),
+ PromptEvent::Update => update_goto_line_number_preview(cx, args)?,
}
- let line = args[0].parse::<usize>()?;
- goto_line_impl(cx.editor, NonZeroUsize::new(line));
- let (view, doc) = current!(cx.editor);
- view.ensure_cursor_in_view(doc, line);
+
Ok(())
}
diff --git a/helix-view/src/editor.rs b/helix-view/src/editor.rs
index 50da3dde..b96eec8d 100644
--- a/helix-view/src/editor.rs
+++ b/helix-view/src/editor.rs
@@ -40,12 +40,12 @@ use anyhow::{anyhow, bail, Error};
pub use helix_core::diagnostic::Severity;
pub use helix_core::register::Registers;
-use helix_core::Position;
use helix_core::{
auto_pairs::AutoPairs,
syntax::{self, AutoPairConfig},
Change,
};
+use helix_core::{Position, Selection};
use helix_dap as dap;
use helix_lsp::lsp;
@@ -848,7 +848,12 @@ pub struct Editor {
/// The currently applied editor theme. While previewing a theme, the previewed theme
/// is set here.
pub theme: Theme,
- pub last_line_number: Option<usize>,
+
+ /// The primary Selection prior to starting a goto_line_number preview. This is
+ /// restored when the preview is aborted, or added to the jumplist when it is
+ /// confirmed.
+ pub last_selection: Option<Selection>,
+
pub status_msg: Option<(Cow<'static, str>, Severity)>,
pub autoinfo: Option<Info>,
@@ -964,7 +969,7 @@ impl Editor {
syn_loader,
theme_loader,
last_theme: None,
- last_line_number: None,
+ last_selection: None,
registers: Registers::default(),
clipboard_provider: get_clipboard_provider(),
status_msg: None,