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

feat: add config option editor.statusline.unobtrusive to make statusline not block the last line of text #12020

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

feat: add config option editor.statusline.unobtrusive to make statusline not block the last line of text #12020

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
d972708
feat: add config option to make statusline unobtrusive
nikitarevenco Nov 7, 2024
84c8c75
feat: unobtrusive statusline highlight bg surface
nikitarevenco Nov 7, 2024
28e6509
docs: mention editor.statusline.unobtrusive option
nikitarevenco Nov 7, 2024
26c22de
style: format files
nikitarevenco Nov 7, 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
1 change: 1 addition & 0 deletions book/src/editor.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,7 @@ The `[editor.statusline]` key takes the following sub-keys:
| `mode.normal` | The text shown in the `mode` element for normal mode | `"NOR"` |
| `mode.insert` | The text shown in the `mode` element for insert mode | `"INS"` |
| `mode.select` | The text shown in the `mode` element for select mode | `"SEL"` |
| `unobtrusive` | If set, the background of the statusline won't block the last line text in the buffer | `false` |

The following statusline elements can be configured:

Expand Down
13 changes: 9 additions & 4 deletions helix-term/src/application.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,7 @@ impl Application {

use helix_view::editor::Action;

let unobtrusive_statusline = config.editor.statusline.unobtrusive;
let mut theme_parent_dirs = vec![helix_loader::config_dir()];
theme_parent_dirs.extend(helix_loader::runtime_dirs().iter().cloned());
let theme_loader = std::sync::Arc::new(theme::Loader::new(&theme_parent_dirs));
Expand Down Expand Up @@ -221,7 +222,7 @@ impl Application {
// align the view to center after all files are loaded,
// does not affect views without pos since it is at the top
let (view, doc) = current!(editor);
align_view(doc, view, Align::Center);
align_view(doc, view, Align::Center, unobtrusive_statusline);
}
} else {
editor.new_file(Action::VerticalSplit);
Expand Down Expand Up @@ -396,10 +397,12 @@ impl Application {
self.editor.refresh_config();

// reset view position in case softwrap was enabled/disabled
let scrolloff = self.editor.config().scrolloff;
let config = self.editor.config();
let scrolloff = config.scrolloff;
let unobtrusive_statusline = config.statusline.unobtrusive;
for (view, _) in self.editor.tree.views() {
let doc = doc_mut!(self.editor, &view.doc);
view.ensure_cursor_in_view(doc, scrolloff);
view.ensure_cursor_in_view(doc, scrolloff, unobtrusive_statusline);
}
}

Expand Down Expand Up @@ -1171,6 +1174,8 @@ impl Application {
}
};

let config = &self.editor.config();
let unobtrusive_statusline = config.statusline.unobtrusive;
let doc = doc_mut!(self.editor, &doc_id);
if let Some(range) = selection {
// TODO: convert inside server
Expand All @@ -1181,7 +1186,7 @@ impl Application {
// (for example start of the function).
doc.set_selection(view.id, Selection::single(new_range.head, new_range.anchor));
if action.align_view(view, doc.id()) {
align_view(doc, view, Align::Center);
align_view(doc, view, Align::Center, unobtrusive_statusline);
}
} else {
log::warn!("lsp position out of bounds - {:?}", range);
Expand Down
91 changes: 61 additions & 30 deletions helix-term/src/commands.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -676,9 +676,12 @@ type MoveFn =

fn move_impl(cx: &mut Context, move_fn: MoveFn, dir: Direction, behaviour: Movement) {
let count = cx.count();
let config = cx.editor.config();
let (view, doc) = current!(cx.editor);
let unobtrusive_statusline = config.statusline.unobtrusive;

let text = doc.text().slice(..);
let text_fmt = doc.text_format(view.inner_area(doc).width, None);
let text_fmt = doc.text_format(view.inner_area(doc, unobtrusive_statusline).width, None);
let mut annotations = view.text_annotations(doc, None);

let selection = doc.selection(view.id).clone().transform(|range| {
Expand Down Expand Up @@ -1079,18 +1082,19 @@ fn align_selections(cx: &mut Context) {
fn goto_window(cx: &mut Context, align: Align) {
let count = cx.count() - 1;
let config = cx.editor.config();
let unobtrusive_statusline = config.statusline.unobtrusive;
let (view, doc) = current!(cx.editor);
let view_offset = doc.view_offset(view.id);

let height = view.inner_height();
let height = view.inner_height(unobtrusive_statusline);

// respect user given count if any
// - 1 so we have at least one gap in the middle.
// a height of 6 with padding of 3 on each side will keep shifting the view back and forth
// as we type
let scrolloff = config.scrolloff.min(height.saturating_sub(1) / 2);

let last_visual_line = view.last_visual_line(doc);
let last_visual_line = view.last_visual_line(doc, unobtrusive_statusline);

let visual_line = match align {
Align::Top => view_offset.vertical_offset + scrolloff + count,
Expand Down Expand Up @@ -1752,7 +1756,7 @@ pub fn scroll(cx: &mut Context, offset: usize, direction: Direction, sync_cursor
let text = doc.text().slice(..);

let cursor = range.cursor(text);
let height = view.inner_height();
let height = view.inner_height(config.statusline.unobtrusive);

let scrolloff = config.scrolloff.min(height.saturating_sub(1) / 2);
let offset = match direction {
Expand All @@ -1761,7 +1765,7 @@ pub fn scroll(cx: &mut Context, offset: usize, direction: Direction, sync_cursor
};

let doc_text = doc.text().slice(..);
let viewport = view.inner_area(doc);
let viewport = view.inner_area(doc, config.statusline.unobtrusive);
let text_fmt = doc.text_format(viewport.width, None);
(view_offset.anchor, view_offset.vertical_offset) = char_idx_at_visual_offset(
doc_text,
Expand Down Expand Up @@ -1854,49 +1858,49 @@ pub fn scroll(cx: &mut Context, offset: usize, direction: Direction, sync_cursor

fn page_up(cx: &mut Context) {
let view = view!(cx.editor);
let offset = view.inner_height();
let offset = view.inner_height(cx.editor.config().statusline.unobtrusive);
scroll(cx, offset, Direction::Backward, false);
}

fn page_down(cx: &mut Context) {
let view = view!(cx.editor);
let offset = view.inner_height();
let offset = view.inner_height(cx.editor.config().statusline.unobtrusive);
scroll(cx, offset, Direction::Forward, false);
}

fn half_page_up(cx: &mut Context) {
let view = view!(cx.editor);
let offset = view.inner_height() / 2;
let offset = view.inner_height(cx.editor.config().statusline.unobtrusive) / 2;
scroll(cx, offset, Direction::Backward, false);
}

fn half_page_down(cx: &mut Context) {
let view = view!(cx.editor);
let offset = view.inner_height() / 2;
let offset = view.inner_height(cx.editor.config().statusline.unobtrusive) / 2;
scroll(cx, offset, Direction::Forward, false);
}

fn page_cursor_up(cx: &mut Context) {
let view = view!(cx.editor);
let offset = view.inner_height();
let offset = view.inner_height(cx.editor.config().statusline.unobtrusive);
scroll(cx, offset, Direction::Backward, true);
}

fn page_cursor_down(cx: &mut Context) {
let view = view!(cx.editor);
let offset = view.inner_height();
let offset = view.inner_height(cx.editor.config().statusline.unobtrusive);
scroll(cx, offset, Direction::Forward, true);
}

fn page_cursor_half_up(cx: &mut Context) {
let view = view!(cx.editor);
let offset = view.inner_height() / 2;
let offset = view.inner_height(cx.editor.config().statusline.unobtrusive) / 2;
scroll(cx, offset, Direction::Backward, true);
}

fn page_cursor_half_down(cx: &mut Context) {
let view = view!(cx.editor);
let offset = view.inner_height() / 2;
let offset = view.inner_height(cx.editor.config().statusline.unobtrusive) / 2;
scroll(cx, offset, Direction::Forward, true);
}

Expand Down Expand Up @@ -2073,6 +2077,7 @@ fn search_impl(
scrolloff: usize,
wrap_around: bool,
show_warnings: bool,
unobtrusive_statusline: bool,
) {
let (view, doc) = current!(editor);
let text = doc.text().slice(..);
Expand Down Expand Up @@ -2143,7 +2148,7 @@ fn search_impl(
};

doc.set_selection(view.id, selection);
view.ensure_cursor_in_view_center(doc, scrolloff);
view.ensure_cursor_in_view_center(doc, scrolloff, unobtrusive_statusline);
};
}

Expand All @@ -2168,6 +2173,7 @@ fn searcher(cx: &mut Context, direction: Direction) {
let reg = cx.register.unwrap_or('/');
let config = cx.editor.config();
let scrolloff = config.scrolloff;
let unobtrusive_statusline = config.statusline.unobtrusive;
let wrap_around = config.search.wrap_around;
let movement = if cx.editor.mode() == Mode::Select {
Movement::Extend
Expand Down Expand Up @@ -2203,6 +2209,7 @@ fn searcher(cx: &mut Context, direction: Direction) {
scrolloff,
wrap_around,
false,
unobtrusive_statusline,
);
},
);
Expand All @@ -2215,6 +2222,7 @@ fn search_next_or_prev_impl(cx: &mut Context, movement: Movement, direction: Dir
.unwrap_or(cx.editor.registers.last_search_register);
let config = cx.editor.config();
let scrolloff = config.scrolloff;
let unobtrusive_statusline = config.statusline.unobtrusive;
if let Some(query) = cx.editor.registers.first(register, cx.editor) {
let search_config = &config.search;
let case_insensitive = if search_config.smart_case {
Expand All @@ -2240,6 +2248,7 @@ fn search_next_or_prev_impl(cx: &mut Context, movement: Movement, direction: Dir
scrolloff,
wrap_around,
true,
unobtrusive_statusline,
);
}
} else {
Expand Down Expand Up @@ -2498,6 +2507,7 @@ fn global_search(cx: &mut Context) {
[],
config,
move |cx, FileResult { path, line_num, .. }, action| {
let config = cx.editor.config();
let doc = match cx.editor.open(path, action) {
Ok(id) => doc_mut!(cx.editor, &id),
Err(e) => {
Expand All @@ -2508,6 +2518,7 @@ fn global_search(cx: &mut Context) {
};

let line_num = *line_num;
let unobtrusive_statusline = config.statusline.unobtrusive;
let view = view_mut!(cx.editor);
let text = doc.text();
if line_num >= text.len_lines() {
Expand All @@ -2521,7 +2532,7 @@ fn global_search(cx: &mut Context) {

doc.set_selection(view.id, Selection::single(start, end));
if action.align_view(view, doc.id()) {
align_view(doc, view, Align::Center);
align_view(doc, view, Align::Center, unobtrusive_statusline);
}
},
)
Expand Down Expand Up @@ -3095,7 +3106,11 @@ fn jumplist_picker(cx: &mut Context) {
let (view, doc) = (view_mut!(cx.editor), doc_mut!(cx.editor, &meta.id));
doc.set_selection(view.id, meta.selection.clone());
if action.align_view(view, doc.id()) {
view.ensure_cursor_in_view_center(doc, config.scrolloff);
view.ensure_cursor_in_view_center(
doc,
config.scrolloff,
config.statusline.unobtrusive,
);
}
},
)
Expand Down Expand Up @@ -3271,7 +3286,11 @@ pub fn command_palette(cx: &mut Context) {
let view = view_mut!(ctx.editor, focus);
let doc = doc_mut!(ctx.editor, &view.doc);

view.ensure_cursor_in_view(doc, config.scrolloff);
view.ensure_cursor_in_view(
doc,
config.scrolloff,
config.statusline.unobtrusive,
);

if mode != Mode::Insert {
doc.append_changes_to_history(view);
Expand Down Expand Up @@ -3397,7 +3416,9 @@ async fn make_format_callback(
return;
}

let scrolloff = editor.config().scrolloff;
let config = editor.config();
let scrolloff = config.scrolloff;
let unobtrusive_statusline = config.statusline.unobtrusive;
let doc = doc_mut!(editor, &doc_id);
let view = view_mut!(editor, view_id);

Expand All @@ -3406,7 +3427,7 @@ async fn make_format_callback(
doc.apply(&format, view.id);
doc.append_changes_to_history(view);
doc.detect_indent_and_line_ending();
view.ensure_cursor_in_view(doc, scrolloff);
view.ensure_cursor_in_view(doc, scrolloff, unobtrusive_statusline);
} else {
log::info!("discarded formatting changes because the document changed");
}
Expand Down Expand Up @@ -4451,7 +4472,10 @@ fn replace_with_yanked_impl(editor: &mut Editor, register: char, count: usize) {
return;
};
let values: Vec<_> = values.map(|value| value.to_string()).collect();
let scrolloff = editor.config().scrolloff;

let config = editor.config();
let scrolloff = config.scrolloff;
let unobtrusive_statusline = config.statusline.unobtrusive;

let (view, doc) = current!(editor);
let repeat = std::iter::repeat(
Expand All @@ -4475,7 +4499,7 @@ fn replace_with_yanked_impl(editor: &mut Editor, register: char, count: usize) {

doc.apply(&transaction, view.id);
doc.append_changes_to_history(view);
view.ensure_cursor_in_view(doc, scrolloff);
view.ensure_cursor_in_view(doc, scrolloff, unobtrusive_statusline);
}

fn replace_selections_with_clipboard(cx: &mut Context) {
Expand Down Expand Up @@ -5210,7 +5234,7 @@ fn jump_forward(cx: &mut Context) {
doc.set_selection(view.id, selection);
// Document we switch to might not have been opened in the view before
doc.ensure_view_init(view.id);
view.ensure_cursor_in_view_center(doc, config.scrolloff);
view.ensure_cursor_in_view_center(doc, config.scrolloff, config.statusline.unobtrusive);
};
}

Expand All @@ -5232,7 +5256,7 @@ fn jump_backward(cx: &mut Context) {
doc.set_selection(view.id, selection);
// Document we switch to might not have been opened in the view before
doc.ensure_view_init(view.id);
view.ensure_cursor_in_view_center(doc, config.scrolloff);
view.ensure_cursor_in_view_center(doc, config.scrolloff, config.statusline.unobtrusive);
};
}

Expand Down Expand Up @@ -5374,21 +5398,25 @@ fn insert_register(cx: &mut Context) {
}

fn align_view_top(cx: &mut Context) {
let unobtrusive_statusline = cx.editor.config().statusline.unobtrusive;
let (view, doc) = current!(cx.editor);
align_view(doc, view, Align::Top);
align_view(doc, view, Align::Top, unobtrusive_statusline);
}

fn align_view_center(cx: &mut Context) {
let unobtrusive_statusline = cx.editor.config().statusline.unobtrusive;
let (view, doc) = current!(cx.editor);
align_view(doc, view, Align::Center);
align_view(doc, view, Align::Center, unobtrusive_statusline);
}

fn align_view_bottom(cx: &mut Context) {
let unobtrusive_statusline = cx.editor.config().statusline.unobtrusive;
let (view, doc) = current!(cx.editor);
align_view(doc, view, Align::Bottom);
align_view(doc, view, Align::Bottom, unobtrusive_statusline);
}

fn align_view_middle(cx: &mut Context) {
let config = cx.editor.config();
let (view, doc) = current!(cx.editor);
let inner_width = view.inner_width(doc);
let text_fmt = doc.text_format(inner_width, None);
Expand All @@ -5408,9 +5436,10 @@ fn align_view_middle(cx: &mut Context) {
.0;

let mut offset = doc.view_offset(view.id);
let unobtrusive_statusline = config.statusline.unobtrusive;
offset.horizontal_offset = pos
.col
.saturating_sub((view.inner_area(doc).width as usize) / 2);
.saturating_sub((view.inner_area(doc, unobtrusive_statusline).width as usize) / 2);
doc.set_view_offset(view.id, offset);
}

Expand Down Expand Up @@ -5975,7 +6004,7 @@ fn shell(cx: &mut compositor::Context, cmd: &str, behavior: &ShellBehavior) {

// after replace cursor may be out of bounds, do this to
// make sure cursor is in view and update scroll as well
view.ensure_cursor_in_view(doc, config.scrolloff);
view.ensure_cursor_in_view(doc, config.scrolloff, config.statusline.unobtrusive);
}

fn shell_prompt(cx: &mut Context, prompt: Cow<'static, str>, behavior: ShellBehavior) {
Expand Down Expand Up @@ -6282,7 +6311,9 @@ fn jump_to_label(cx: &mut Context, labels: Vec<Range>, behaviour: Movement) {
fn jump_to_word(cx: &mut Context, behaviour: Movement) {
// Calculate the jump candidates: ranges for any visible words with two or
// more characters.
let alphabet = &cx.editor.config().jump_label_alphabet;
let config = cx.editor.config();
let alphabet = &config.jump_label_alphabet;
let unobtrusive_statusline = config.statusline.unobtrusive;
let jump_label_limit = alphabet.len() * alphabet.len();
let mut words = Vec::with_capacity(jump_label_limit);
let (view, doc) = current_ref!(cx.editor);
Expand All @@ -6291,7 +6322,7 @@ fn jump_to_word(cx: &mut Context, behaviour: Movement) {
// This is not necessarily exact if there is virtual text like soft wrap.
// It's ok though because the extra jump labels will not be rendered.
let start = text.line_to_char(text.char_to_line(doc.view_offset(view.id).anchor));
let end = text.line_to_char(view.estimate_last_doc_line(doc) + 1);
let end = text.line_to_char(view.estimate_last_doc_line(doc, unobtrusive_statusline) + 1);

let primary_selection = doc.selection(view.id).primary();
let cursor = primary_selection.cursor(text);
Expand Down
Loading