Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

vim: Fix ctrl-b not moving the cursor #17808

Merged
merged 4 commits into from
Sep 16, 2024
Merged

vim: Fix ctrl-b not moving the cursor #17808

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
30a63d9
vim: Fix ctrl-b not moving the cursor
mrnugget Sep 13, 2024
94be9b6
Restore old (broken) behavior and add test
mrnugget Sep 16, 2024
ca3c18d
Special case page-wise scrolling in Vim
mrnugget Sep 16, 2024
c5b6ab8
Extend the test
mrnugget Sep 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 28 additions & 1 deletion crates/editor/src/scroll/scroll_amount.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,18 @@
use serde::Deserialize;
use ui::{px, Pixels};

#[derive(Debug)]
pub enum ScrollDirection {
Upwards,
Downwards,
}

impl ScrollDirection {
pub fn is_upwards(&self) -> bool {
matches!(self, ScrollDirection::Upwards)
}
}

#[derive(Debug, Clone, PartialEq, Deserialize)]
pub enum ScrollAmount {
// Scroll N lines (positive is towards the end of the document)
Expand All @@ -15,7 +27,7 @@ impl ScrollAmount {
Self::Line(count) => *count,
Self::Page(count) => {
// for full pages subtract one to leave an anchor line
if count.abs() == 1.0 {
if self.is_full_page() {
visible_line_count -= 1.0
}
(visible_line_count * count).trunc()
Expand All @@ -29,4 +41,19 @@ impl ScrollAmount {
ScrollAmount::Page(x) => px(height.0 * x),
}
}

pub fn is_full_page(&self) -> bool {
match self {
ScrollAmount::Page(count) if count.abs() == 1.0 => true,
_ => false,
}
}

pub fn direction(&self) -> ScrollDirection {
match self {
Self::Line(amount) if amount.is_sign_positive() => ScrollDirection::Downwards,
Self::Page(amount) if amount.is_sign_positive() => ScrollDirection::Downwards,
_ => ScrollDirection::Upwards,
}
}
}
92 changes: 84 additions & 8 deletions crates/vim/src/normal/scroll.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,14 +73,24 @@ fn scroll_editor(
return;
}

editor.scroll_screen(amount, cx);
let full_page_up = amount.is_full_page() && amount.direction().is_upwards();
let amount = match (amount.is_full_page(), editor.visible_line_count()) {
(true, Some(visible_line_count)) => {
if amount.direction().is_upwards() {
ScrollAmount::Line(amount.lines(visible_line_count) + 1.0)
} else {
ScrollAmount::Line(amount.lines(visible_line_count) - 1.0)
}
}
_ => amount.clone(),
};

editor.scroll_screen(&amount, cx);
if !should_move_cursor {
return;
}

let visible_line_count = if let Some(visible_line_count) = editor.visible_line_count() {
visible_line_count
} else {
let Some(visible_line_count) = editor.visible_line_count() else {
return;
};

Expand Down Expand Up @@ -115,11 +125,18 @@ fn scroll_editor(
} else {
DisplayRow(top.row().0 + vertical_scroll_margin)
};
let max_row = DisplayRow(map.max_point().row().0.max(top.row().0.saturating_add(
(visible_line_count as u32).saturating_sub(1 + vertical_scroll_margin),
)));

let new_row = if head.row() < min_row {
let max_visible_row = top.row().0.saturating_add(
(visible_line_count as u32).saturating_sub(1 + vertical_scroll_margin),
);
let max_row = DisplayRow(map.max_point().row().0.max(max_visible_row));

let new_row = if full_page_up {
// Special-casing ctrl-b/page-up, which is special-cased by Vim, it seems
// to always put the cursor on the last line of the page, even if the cursor
// was before that.
DisplayRow(max_visible_row)
} else if head.row() < min_row {
min_row
} else if head.row() > max_row {
max_row
Expand Down Expand Up @@ -251,6 +268,7 @@ mod test {
)
});
}

#[gpui::test]
async fn test_ctrl_d_u(cx: &mut gpui::TestAppContext) {
let mut cx = NeovimBackedTestContext::new(cx).await;
Expand Down Expand Up @@ -282,6 +300,64 @@ mod test {
cx.shared_state().await.assert_matches();
}

#[gpui::test]
async fn test_ctrl_f_b(cx: &mut gpui::TestAppContext) {
let mut cx = NeovimBackedTestContext::new(cx).await;

let visible_lines = 10;
cx.set_scroll_height(visible_lines).await;

// First test without vertical scroll margin
cx.neovim.set_option(&format!("scrolloff={}", 0)).await;
cx.update_global(|store: &mut SettingsStore, cx| {
store.update_user_settings::<EditorSettings>(cx, |s| {
s.vertical_scroll_margin = Some(0.0)
});
});

let content = "ˇ".to_owned() + &sample_text(26, 2, 'a');
cx.set_shared_state(&content).await;

// scroll down: ctrl-f
cx.simulate_shared_keystrokes("ctrl-f").await;
cx.shared_state().await.assert_matches();

cx.simulate_shared_keystrokes("ctrl-f").await;
cx.shared_state().await.assert_matches();

// scroll up: ctrl-b
cx.simulate_shared_keystrokes("ctrl-b").await;
cx.shared_state().await.assert_matches();

cx.simulate_shared_keystrokes("ctrl-b").await;
cx.shared_state().await.assert_matches();

// Now go back to start of file, and test with vertical scroll margin
cx.simulate_shared_keystrokes("g g").await;
cx.shared_state().await.assert_matches();

cx.neovim.set_option(&format!("scrolloff={}", 3)).await;
cx.update_global(|store: &mut SettingsStore, cx| {
store.update_user_settings::<EditorSettings>(cx, |s| {
s.vertical_scroll_margin = Some(3.0)
});
});

// scroll down: ctrl-f
cx.simulate_shared_keystrokes("ctrl-f").await;
cx.shared_state().await.assert_matches();

cx.simulate_shared_keystrokes("ctrl-f").await;
cx.shared_state().await.assert_matches();

// scroll up: ctrl-b
cx.simulate_shared_keystrokes("ctrl-b").await;
cx.shared_state().await.assert_matches();

cx.simulate_shared_keystrokes("ctrl-b").await;
cx.shared_state().await.assert_matches();
}

#[gpui::test]
async fn test_scroll_beyond_last_line(cx: &mut gpui::TestAppContext) {
let mut cx = NeovimBackedTestContext::new(cx).await;
Expand Down
24 changes: 24 additions & 0 deletions crates/vim/test_data/test_ctrl_f_b.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
{"SetOption":{"value":"scrolloff=3"}}
{"SetOption":{"value":"lines=12"}}
{"SetOption":{"value":"scrolloff=0"}}
{"Put":{"state":"ˇaa\nbb\ncc\ndd\nee\nff\ngg\nhh\nii\njj\nkk\nll\nmm\nnn\noo\npp\nqq\nrr\nss\ntt\nuu\nvv\nww\nxx\nyy\nzz"}}
{"Key":"ctrl-f"}
{"Get":{"state":"aa\nbb\ncc\ndd\nee\nff\ngg\nhh\nˇii\njj\nkk\nll\nmm\nnn\noo\npp\nqq\nrr\nss\ntt\nuu\nvv\nww\nxx\nyy\nzz","mode":"Normal"}}
{"Key":"ctrl-f"}
{"Get":{"state":"aa\nbb\ncc\ndd\nee\nff\ngg\nhh\nii\njj\nkk\nll\nmm\nnn\noo\npp\nˇqq\nrr\nss\ntt\nuu\nvv\nww\nxx\nyy\nzz","mode":"Normal"}}
{"Key":"ctrl-b"}
{"Get":{"state":"aa\nbb\ncc\ndd\nee\nff\ngg\nhh\nii\njj\nkk\nll\nmm\nnn\noo\npp\nqq\nˇrr\nss\ntt\nuu\nvv\nww\nxx\nyy\nzz","mode":"Normal"}}
{"Key":"ctrl-b"}
{"Get":{"state":"aa\nbb\ncc\ndd\nee\nff\ngg\nhh\nii\nˇjj\nkk\nll\nmm\nnn\noo\npp\nqq\nrr\nss\ntt\nuu\nvv\nww\nxx\nyy\nzz","mode":"Normal"}}
{"Key":"g"}
{"Key":"g"}
{"Get":{"state":"ˇaa\nbb\ncc\ndd\nee\nff\ngg\nhh\nii\njj\nkk\nll\nmm\nnn\noo\npp\nqq\nrr\nss\ntt\nuu\nvv\nww\nxx\nyy\nzz","mode":"Normal"}}
{"SetOption":{"value":"scrolloff=3"}}
{"Key":"ctrl-f"}
{"Get":{"state":"aa\nbb\ncc\ndd\nee\nff\ngg\nhh\nii\njj\nkk\nˇll\nmm\nnn\noo\npp\nqq\nrr\nss\ntt\nuu\nvv\nww\nxx\nyy\nzz","mode":"Normal"}}
{"Key":"ctrl-f"}
{"Get":{"state":"aa\nbb\ncc\ndd\nee\nff\ngg\nhh\nii\njj\nkk\nll\nmm\nnn\noo\npp\nqq\nrr\nss\nˇtt\nuu\nvv\nww\nxx\nyy\nzz","mode":"Normal"}}
{"Key":"ctrl-b"}
{"Get":{"state":"aa\nbb\ncc\ndd\nee\nff\ngg\nhh\nii\njj\nkk\nll\nmm\nnn\nˇoo\npp\nqq\nrr\nss\ntt\nuu\nvv\nww\nxx\nyy\nzz","mode":"Normal"}}
{"Key":"ctrl-b"}
{"Get":{"state":"aa\nbb\ncc\ndd\nee\nff\nˇgg\nhh\nii\njj\nkk\nll\nmm\nnn\noo\npp\nqq\nrr\nss\ntt\nuu\nvv\nww\nxx\nyy\nzz","mode":"Normal"}}
Loading