From d5e297147fa80612bc4b48f08950c3d4e21576e6 Mon Sep 17 00:00:00 2001 From: Thomas Heartman Date: Tue, 28 Oct 2025 03:20:45 +0100 Subject: [PATCH] Support relative line number on wrapped lines (#39268) **Problem:** Current relative line numbering creates a mismatch with vim-style navigation when soft wrap is enabled. Users must mentally calculate whether target lines are wrapped segments or logical lines, making `j/k` navigation unreliable and cognitively demanding. **How things work today:** - Real line navigation (`j/k` moves by logical lines): Requires determining if visible lines are wrapped segments before jumping. Can't jump to wrapped lines directly. - Display line navigation (`j/k` moves by display rows): Line numbers don't correspond to actual row distances for multi-line jumps. **Proposed solution:** Count and number each display line (including wrapped segments) for relative numbering. This creates direct visual-to-navigational correspondence where the relative number shown always matches the `j/k` distance needed. **Benefits:** - Eliminates mental overhead of distinguishing wrapped vs. logical lines - Makes relative line numbers consistently actionable regardless of wrap state - Preserves intuitive "what you see is what you navigate" principle - Maintains vim workflow efficiency in narrow window scenarios Also explained an discussed in https://github.com/zed-industries/zed/discussions/25733. Release Notes: Release Notes: - Added support for counting wrapped lines as relative lines and for displaying line numbers for wrapped segments. Changes `relative_line_numbers` from a boolean to an enum: `enabled`, `disabled`, or `wrapped`. --------- Co-authored-by: Conrad Irwin --- assets/settings/default.json | 2 +- crates/editor/src/display_map/wrap_map.rs | 1 + crates/editor/src/editor.rs | 22 +- crates/editor/src/editor_settings.rs | 4 +- crates/editor/src/element.rs | 344 ++++++++++++------ crates/migrator/src/migrations.rs | 6 + .../src/migrations/m_2025_10_21/settings.rs | 15 + crates/migrator/src/migrator.rs | 1 + crates/multi_buffer/src/multi_buffer.rs | 4 + crates/multi_buffer/src/multi_buffer_tests.rs | 3 + .../settings/src/settings_content/editor.rs | 41 ++- crates/settings/src/vscode_import.rs | 2 +- crates/settings_ui/src/page_data.rs | 2 +- crates/settings_ui/src/settings_ui.rs | 1 + docs/src/vim.md | 4 +- docs/src/visual-customization.md | 2 +- 16 files changed, 332 insertions(+), 122 deletions(-) create mode 100644 crates/migrator/src/migrations/m_2025_10_21/settings.rs diff --git a/assets/settings/default.json b/assets/settings/default.json index 10aa98498b09d4cbcf4f231393df3e9203a0512a..b300500b9f185ca7ace85a5c43a153739e67bd24 100644 --- a/assets/settings/default.json +++ b/assets/settings/default.json @@ -592,7 +592,7 @@ // to both the horizontal and vertical delta values while scrolling. Fast scrolling // happens when a user holds the alt or option key while scrolling. "fast_scroll_sensitivity": 4.0, - "relative_line_numbers": false, + "relative_line_numbers": "disabled", // If 'search_wrap' is disabled, search result do not wrap around the end of the file. "search_wrap": true, // Search options to enable by default when opening new project and buffer searches. diff --git a/crates/editor/src/display_map/wrap_map.rs b/crates/editor/src/display_map/wrap_map.rs index e79e5555a61d0ddb8a93a1708c676554f191c3f6..f0dc292e4e4904fa9a1c48135a20ce8e562fc6c4 100644 --- a/crates/editor/src/display_map/wrap_map.rs +++ b/crates/editor/src/display_map/wrap_map.rs @@ -1017,6 +1017,7 @@ impl Iterator for WrapRows<'_> { multibuffer_row: None, diff_status, expand_info: None, + wrapped_buffer_row: buffer_row.buffer_row, } } else { buffer_row diff --git a/crates/editor/src/editor.rs b/crates/editor/src/editor.rs index 8116d990f555bcd8db49bf8173e264aec26fed51..cc13654e9e3f42a1abc49d983aa764d5acdf7436 100644 --- a/crates/editor/src/editor.rs +++ b/crates/editor/src/editor.rs @@ -163,7 +163,10 @@ use rpc::{ErrorCode, ErrorExt, proto::PeerId}; use scroll::{Autoscroll, OngoingScroll, ScrollAnchor, ScrollManager}; use selections_collection::{MutableSelectionsCollection, SelectionsCollection}; use serde::{Deserialize, Serialize}; -use settings::{GitGutterSetting, Settings, SettingsLocation, SettingsStore, update_settings_file}; +use settings::{ + GitGutterSetting, RelativeLineNumbers, Settings, SettingsLocation, SettingsStore, + update_settings_file, +}; use smallvec::{SmallVec, smallvec}; use snippet::Snippet; use std::{ @@ -19351,9 +19354,16 @@ impl Editor { EditorSettings::get_global(cx).gutter.line_numbers } - pub fn should_use_relative_line_numbers(&self, cx: &mut App) -> bool { - self.use_relative_line_numbers - .unwrap_or(EditorSettings::get_global(cx).relative_line_numbers) + pub fn relative_line_numbers(&self, cx: &mut App) -> RelativeLineNumbers { + match ( + self.use_relative_line_numbers, + EditorSettings::get_global(cx).relative_line_numbers, + ) { + (None, setting) => setting, + (Some(false), _) => RelativeLineNumbers::Disabled, + (Some(true), RelativeLineNumbers::Wrapped) => RelativeLineNumbers::Wrapped, + (Some(true), _) => RelativeLineNumbers::Enabled, + } } pub fn toggle_relative_line_numbers( @@ -19362,8 +19372,8 @@ impl Editor { _: &mut Window, cx: &mut Context, ) { - let is_relative = self.should_use_relative_line_numbers(cx); - self.set_relative_line_number(Some(!is_relative), cx) + let is_relative = self.relative_line_numbers(cx); + self.set_relative_line_number(Some(!is_relative.enabled()), cx) } pub fn set_relative_line_number(&mut self, is_relative: Option, cx: &mut Context) { diff --git a/crates/editor/src/editor_settings.rs b/crates/editor/src/editor_settings.rs index dc67ab3ed6c8cfdbe88809e32d615789c01eef60..d4ffeaa03c54030c322a61bb563918c0eb89b30d 100644 --- a/crates/editor/src/editor_settings.rs +++ b/crates/editor/src/editor_settings.rs @@ -3,12 +3,12 @@ use core::num; use gpui::App; use language::CursorShape; use project::project_settings::DiagnosticSeverity; -use settings::Settings; pub use settings::{ CurrentLineHighlight, DelayMs, DisplayIn, DocumentColorsRenderMode, DoubleClickInMultibuffer, GoToDefinitionFallback, HideMouseMode, MinimapThumb, MinimapThumbBorder, MultiCursorModifier, ScrollBeyondLastLine, ScrollbarDiagnostics, SeedQuerySetting, ShowMinimap, SnippetSortOrder, }; +use settings::{RelativeLineNumbers, Settings}; use ui::scrollbars::{ScrollbarVisibility, ShowScrollbar}; /// Imports from the VSCode settings at @@ -33,7 +33,7 @@ pub struct EditorSettings { pub horizontal_scroll_margin: f32, pub scroll_sensitivity: f32, pub fast_scroll_sensitivity: f32, - pub relative_line_numbers: bool, + pub relative_line_numbers: RelativeLineNumbers, pub seed_search_query_from_cursor: SeedQuerySetting, pub use_smartcase_search: bool, pub multi_cursor_modifier: MultiCursorModifier, diff --git a/crates/editor/src/element.rs b/crates/editor/src/element.rs index 41a9809bfa75f091c1c03d924ffebf117d4fd2d7..d6e85631fd129fe1fb109bfaa639d245f0070f7d 100644 --- a/crates/editor/src/element.rs +++ b/crates/editor/src/element.rs @@ -762,8 +762,14 @@ impl EditorElement { .row; if line_numbers .get(&MultiBufferRow(multi_buffer_row)) - .and_then(|line_number| line_number.hitbox.as_ref()) - .is_some_and(|hitbox| hitbox.contains(&event.position)) + .is_some_and(|line_layout| { + line_layout.segments.iter().any(|segment| { + segment + .hitbox + .as_ref() + .is_some_and(|hitbox| hitbox.contains(&event.position)) + }) + }) { let line_offset_from_top = display_row - position_map.scroll_position.y as u32; @@ -3143,9 +3149,10 @@ impl EditorElement { fn calculate_relative_line_numbers( &self, - snapshot: &EditorSnapshot, + buffer_rows: &[RowInfo], rows: &Range, relative_to: Option, + count_wrapped_lines: bool, ) -> HashMap { let mut relative_rows: HashMap = Default::default(); let Some(relative_to) = relative_to else { @@ -3153,18 +3160,19 @@ impl EditorElement { }; let start = rows.start.min(relative_to); - let end = rows.end.max(relative_to); - - let buffer_rows = snapshot - .row_infos(start) - .take(1 + end.minus(start) as usize) - .collect::>(); let head_idx = relative_to.minus(start); let mut delta = 1; let mut i = head_idx + 1; + let should_count_line = |row_info: &RowInfo| { + if count_wrapped_lines { + row_info.buffer_row.is_some() || row_info.wrapped_buffer_row.is_some() + } else { + row_info.buffer_row.is_some() + } + }; while i < buffer_rows.len() as u32 { - if buffer_rows[i as usize].buffer_row.is_some() { + if should_count_line(&buffer_rows[i as usize]) { if rows.contains(&DisplayRow(i + start.0)) { relative_rows.insert(DisplayRow(i + start.0), delta); } @@ -3174,13 +3182,13 @@ impl EditorElement { } delta = 1; i = head_idx.min(buffer_rows.len() as u32 - 1); - while i > 0 && buffer_rows[i as usize].buffer_row.is_none() { + while i > 0 && buffer_rows[i as usize].buffer_row.is_none() && !count_wrapped_lines { i -= 1; } while i > 0 { i -= 1; - if buffer_rows[i as usize].buffer_row.is_some() { + if should_count_line(&buffer_rows[i as usize]) { if rows.contains(&DisplayRow(i + start.0)) { relative_rows.insert(DisplayRow(i + start.0), delta); } @@ -3212,7 +3220,7 @@ impl EditorElement { return Arc::default(); } - let (newest_selection_head, is_relative) = self.editor.update(cx, |editor, cx| { + let (newest_selection_head, relative) = self.editor.update(cx, |editor, cx| { let newest_selection_head = newest_selection_head.unwrap_or_else(|| { let newest = editor .selections @@ -3228,79 +3236,97 @@ impl EditorElement { ) .head }); - let is_relative = editor.should_use_relative_line_numbers(cx); - (newest_selection_head, is_relative) + let relative = editor.relative_line_numbers(cx); + (newest_selection_head, relative) }); - let relative_to = if is_relative { + let relative_to = if relative.enabled() { Some(newest_selection_head.row()) } else { None }; - let relative_rows = self.calculate_relative_line_numbers(snapshot, &rows, relative_to); + let relative_rows = self.calculate_relative_line_numbers( + &buffer_rows, + &rows, + relative_to, + relative.wrapped(), + ); let mut line_number = String::new(); - let line_numbers = buffer_rows - .iter() - .enumerate() - .flat_map(|(ix, row_info)| { - let display_row = DisplayRow(rows.start.0 + ix as u32); - line_number.clear(); - let non_relative_number = row_info.buffer_row? + 1; - let number = relative_rows - .get(&display_row) - .unwrap_or(&non_relative_number); - write!(&mut line_number, "{number}").unwrap(); - if row_info - .diff_status - .is_some_and(|status| status.is_deleted()) - { - return None; - } - - let color = active_rows - .get(&display_row) - .map(|spec| { - if spec.breakpoint { - cx.theme().colors().debugger_accent - } else { - cx.theme().colors().editor_active_line_number - } - }) - .unwrap_or_else(|| cx.theme().colors().editor_line_number); - let shaped_line = - self.shape_line_number(SharedString::from(&line_number), color, window); - let scroll_top = scroll_position.y * ScrollPixelOffset::from(line_height); - let line_origin = gutter_hitbox.map(|hitbox| { - hitbox.origin - + point( - hitbox.size.width - shaped_line.width - gutter_dimensions.right_padding, - ix as f32 * line_height - - Pixels::from(scroll_top % ScrollPixelOffset::from(line_height)), - ) - }); + let segments = buffer_rows.iter().enumerate().flat_map(|(ix, row_info)| { + let display_row = DisplayRow(rows.start.0 + ix as u32); + line_number.clear(); + let non_relative_number = if relative.wrapped() { + row_info.buffer_row.or(row_info.wrapped_buffer_row)? + 1 + } else { + row_info.buffer_row? + 1 + }; + let number = relative_rows + .get(&display_row) + .unwrap_or(&non_relative_number); + write!(&mut line_number, "{number}").unwrap(); + if row_info + .diff_status + .is_some_and(|status| status.is_deleted()) + { + return None; + } - #[cfg(not(test))] - let hitbox = line_origin.map(|line_origin| { - window.insert_hitbox( - Bounds::new(line_origin, size(shaped_line.width, line_height)), - HitboxBehavior::Normal, + let color = active_rows + .get(&display_row) + .map(|spec| { + if spec.breakpoint { + cx.theme().colors().debugger_accent + } else { + cx.theme().colors().editor_active_line_number + } + }) + .unwrap_or_else(|| cx.theme().colors().editor_line_number); + let shaped_line = + self.shape_line_number(SharedString::from(&line_number), color, window); + let scroll_top = scroll_position.y * ScrollPixelOffset::from(line_height); + let line_origin = gutter_hitbox.map(|hitbox| { + hitbox.origin + + point( + hitbox.size.width - shaped_line.width - gutter_dimensions.right_padding, + ix as f32 * line_height + - Pixels::from(scroll_top % ScrollPixelOffset::from(line_height)), ) - }); - #[cfg(test)] - let hitbox = { - let _ = line_origin; - None - }; + }); - let multi_buffer_row = DisplayPoint::new(display_row, 0).to_point(snapshot).row; - let multi_buffer_row = MultiBufferRow(multi_buffer_row); - let line_number = LineNumberLayout { - shaped_line, - hitbox, - }; - Some((multi_buffer_row, line_number)) - }) - .collect(); + #[cfg(not(test))] + let hitbox = line_origin.map(|line_origin| { + window.insert_hitbox( + Bounds::new(line_origin, size(shaped_line.width, line_height)), + HitboxBehavior::Normal, + ) + }); + #[cfg(test)] + let hitbox = { + let _ = line_origin; + None + }; + + let segment = LineNumberSegment { + shaped_line, + hitbox, + }; + + let buffer_row = DisplayPoint::new(display_row, 0).to_point(snapshot).row; + let multi_buffer_row = MultiBufferRow(buffer_row); + + Some((multi_buffer_row, segment)) + }); + + let mut line_numbers: HashMap = HashMap::default(); + for (buffer_row, segment) in segments { + line_numbers + .entry(buffer_row) + .or_insert_with(|| LineNumberLayout { + segments: Default::default(), + }) + .segments + .push(segment); + } Arc::new(line_numbers) } @@ -5838,34 +5864,36 @@ impl EditorElement { let line_height = layout.position_map.line_height; window.set_cursor_style(CursorStyle::Arrow, &layout.gutter_hitbox); - for LineNumberLayout { - shaped_line, - hitbox, - } in layout.line_numbers.values() - { - let Some(hitbox) = hitbox else { - continue; - }; + for line_layout in layout.line_numbers.values() { + for LineNumberSegment { + shaped_line, + hitbox, + } in &line_layout.segments + { + let Some(hitbox) = hitbox else { + continue; + }; - let Some(()) = (if !is_singleton && hitbox.is_hovered(window) { - let color = cx.theme().colors().editor_hover_line_number; + let Some(()) = (if !is_singleton && hitbox.is_hovered(window) { + let color = cx.theme().colors().editor_hover_line_number; - let line = self.shape_line_number(shaped_line.text.clone(), color, window); - line.paint(hitbox.origin, line_height, window, cx).log_err() - } else { - shaped_line - .paint(hitbox.origin, line_height, window, cx) - .log_err() - }) else { - continue; - }; + let line = self.shape_line_number(shaped_line.text.clone(), color, window); + line.paint(hitbox.origin, line_height, window, cx).log_err() + } else { + shaped_line + .paint(hitbox.origin, line_height, window, cx) + .log_err() + }) else { + continue; + }; - // In singleton buffers, we select corresponding lines on the line number click, so use | -like cursor. - // In multi buffers, we open file at the line number clicked, so use a pointing hand cursor. - if is_singleton { - window.set_cursor_style(CursorStyle::IBeam, hitbox); - } else { - window.set_cursor_style(CursorStyle::PointingHand, hitbox); + // In singleton buffers, we select corresponding lines on the line number click, so use | -like cursor. + // In multi buffers, we open file at the line number clicked, so use a pointing hand cursor. + if is_singleton { + window.set_cursor_style(CursorStyle::IBeam, hitbox); + } else { + window.set_cursor_style(CursorStyle::PointingHand, hitbox); + } } } } @@ -9778,11 +9806,17 @@ impl EditorLayout { } } -struct LineNumberLayout { +#[derive(Debug)] +struct LineNumberSegment { shaped_line: ShapedLine, hitbox: Option, } +#[derive(Debug)] +struct LineNumberLayout { + segments: SmallVec<[LineNumberSegment; 1]>, +} + struct ColoredRange { start: T, end: T, @@ -10839,13 +10873,21 @@ mod tests { .unwrap(); assert_eq!(layouts.len(), 6); + let get_row_infos = |snapshot: &EditorSnapshot| { + snapshot + .row_infos(DisplayRow(0)) + .take(6) + .collect::>() + }; + let relative_rows = window .update(cx, |editor, window, cx| { let snapshot = editor.snapshot(window, cx); element.calculate_relative_line_numbers( - &snapshot, + &get_row_infos(&snapshot), &(DisplayRow(0)..DisplayRow(6)), Some(DisplayRow(3)), + false, ) }) .unwrap(); @@ -10861,9 +10903,10 @@ mod tests { .update(cx, |editor, window, cx| { let snapshot = editor.snapshot(window, cx); element.calculate_relative_line_numbers( - &snapshot, + &get_row_infos(&snapshot), &(DisplayRow(3)..DisplayRow(6)), Some(DisplayRow(1)), + false, ) }) .unwrap(); @@ -10877,9 +10920,10 @@ mod tests { .update(cx, |editor, window, cx| { let snapshot = editor.snapshot(window, cx); element.calculate_relative_line_numbers( - &snapshot, + &get_row_infos(&snapshot), &(DisplayRow(0)..DisplayRow(3)), Some(DisplayRow(6)), + false, ) }) .unwrap(); @@ -10889,6 +10933,88 @@ mod tests { assert_eq!(relative_rows[&DisplayRow(2)], 3); } + #[gpui::test] + fn test_shape_line_numbers_wrapping(cx: &mut TestAppContext) { + init_test(cx, |_| {}); + let window = cx.add_window(|window, cx| { + let buffer = MultiBuffer::build_simple(&sample_text(6, 6, 'a'), cx); + Editor::new(EditorMode::full(), buffer, None, window, cx) + }); + + update_test_language_settings(cx, |s| { + s.defaults.preferred_line_length = Some(5_u32); + s.defaults.soft_wrap = Some(language_settings::SoftWrap::PreferredLineLength); + }); + + let editor = window.root(cx).unwrap(); + let style = cx.update(|cx| editor.read(cx).style().unwrap().clone()); + let line_height = window + .update(cx, |_, window, _| { + style.text.line_height_in_pixels(window.rem_size()) + }) + .unwrap(); + let element = EditorElement::new(&editor, style); + let snapshot = window + .update(cx, |editor, window, cx| editor.snapshot(window, cx)) + .unwrap(); + + let layouts = cx + .update_window(*window, |_, window, cx| { + element.layout_line_numbers( + None, + GutterDimensions { + left_padding: Pixels::ZERO, + right_padding: Pixels::ZERO, + width: px(30.0), + margin: Pixels::ZERO, + git_blame_entries_width: None, + }, + line_height, + gpui::Point::default(), + DisplayRow(0)..DisplayRow(6), + &(0..6) + .map(|row| RowInfo { + buffer_row: Some(row), + ..Default::default() + }) + .collect::>(), + &BTreeMap::default(), + Some(DisplayPoint::new(DisplayRow(0), 0)), + &snapshot, + window, + cx, + ) + }) + .unwrap(); + assert_eq!(layouts.len(), 3); + + let relative_rows = window + .update(cx, |editor, window, cx| { + let snapshot = editor.snapshot(window, cx); + let start_row = DisplayRow(0); + let end_row = DisplayRow(6); + let row_infos = snapshot + .row_infos(start_row) + .take((start_row..end_row).len()) + .collect::>(); + + element.calculate_relative_line_numbers( + &row_infos, + &(DisplayRow(0)..DisplayRow(6)), + Some(DisplayRow(3)), + true, + ) + }) + .unwrap(); + + assert_eq!(relative_rows[&DisplayRow(0)], 3); + assert_eq!(relative_rows[&DisplayRow(1)], 2); + assert_eq!(relative_rows[&DisplayRow(2)], 1); + // current line has no relative number + assert_eq!(relative_rows[&DisplayRow(4)], 1); + assert_eq!(relative_rows[&DisplayRow(5)], 2); + } + #[gpui::test] async fn test_vim_visual_selections(cx: &mut TestAppContext) { init_test(cx, |_| {}); @@ -11002,7 +11128,13 @@ mod tests { state .line_numbers .get(&MultiBufferRow(0)) - .map(|line_number| line_number.shaped_line.text.as_ref()), + .map(|line_number| line_number + .segments + .first() + .unwrap() + .shaped_line + .text + .as_ref()), Some("1") ); } diff --git a/crates/migrator/src/migrations.rs b/crates/migrator/src/migrations.rs index 084a3348b54acd9d2fc6ba043e1fb1648bbb3f8b..e4358b36b94c9a738ad784eb7269652b29e7cdfb 100644 --- a/crates/migrator/src/migrations.rs +++ b/crates/migrator/src/migrations.rs @@ -129,3 +129,9 @@ pub(crate) mod m_2025_10_17 { pub(crate) use settings::make_file_finder_include_ignored_an_enum; } + +pub(crate) mod m_2025_10_21 { + mod settings; + + pub(crate) use settings::make_relative_line_numbers_an_enum; +} diff --git a/crates/migrator/src/migrations/m_2025_10_21/settings.rs b/crates/migrator/src/migrations/m_2025_10_21/settings.rs new file mode 100644 index 0000000000000000000000000000000000000000..6fe8814fb43e6423bcc6d4ae04c3a1f7a4e975a3 --- /dev/null +++ b/crates/migrator/src/migrations/m_2025_10_21/settings.rs @@ -0,0 +1,15 @@ +use anyhow::Result; +use serde_json::Value; + +pub fn make_relative_line_numbers_an_enum(value: &mut Value) -> Result<()> { + let Some(relative_line_numbers) = value.get_mut("relative_line_numbers") else { + return Ok(()); + }; + + *relative_line_numbers = match relative_line_numbers { + Value::Bool(true) => Value::String("enabled".to_string()), + Value::Bool(false) => Value::String("disabled".to_string()), + _ => anyhow::bail!("Expected relative_line_numbers to be a boolean"), + }; + Ok(()) +} diff --git a/crates/migrator/src/migrator.rs b/crates/migrator/src/migrator.rs index ff9635dcef7664b17eb02a03b7584ea18ac9a91b..3f5c1edaa7939e442c3e5c007579516fcdeb2151 100644 --- a/crates/migrator/src/migrator.rs +++ b/crates/migrator/src/migrator.rs @@ -214,6 +214,7 @@ pub fn migrate_settings(text: &str) -> Result> { ), MigrationType::Json(migrations::m_2025_10_16::restore_code_actions_on_format), MigrationType::Json(migrations::m_2025_10_17::make_file_finder_include_ignored_an_enum), + MigrationType::Json(migrations::m_2025_10_21::make_relative_line_numbers_an_enum), ]; run_migrations(text, migrations) } diff --git a/crates/multi_buffer/src/multi_buffer.rs b/crates/multi_buffer/src/multi_buffer.rs index e3ea3b9c92014acff7dab6931b1f756224cee288..8bd9ca8e78b468965c943e631742e57720ae7b20 100644 --- a/crates/multi_buffer/src/multi_buffer.rs +++ b/crates/multi_buffer/src/multi_buffer.rs @@ -340,6 +340,7 @@ pub struct RowInfo { pub multibuffer_row: Option, pub diff_status: Option, pub expand_info: Option, + pub wrapped_buffer_row: Option, } /// A slice into a [`Buffer`] that is being edited in a [`MultiBuffer`]. @@ -6632,6 +6633,7 @@ impl Iterator for MultiBufferRows<'_> { multibuffer_row: Some(MultiBufferRow(0)), diff_status: None, expand_info: None, + wrapped_buffer_row: None, }); } @@ -6689,6 +6691,7 @@ impl Iterator for MultiBufferRows<'_> { buffer_row: Some(last_row), multibuffer_row: Some(multibuffer_row), diff_status: None, + wrapped_buffer_row: None, expand_info, }); } else { @@ -6733,6 +6736,7 @@ impl Iterator for MultiBufferRows<'_> { .diff_hunk_status .filter(|_| self.point < region.range.end), expand_info, + wrapped_buffer_row: None, }); self.point += Point::new(1, 0); result diff --git a/crates/multi_buffer/src/multi_buffer_tests.rs b/crates/multi_buffer/src/multi_buffer_tests.rs index a9121b9104400d88d5f22801db1bfebaeeb060d6..22c041267f9c78c1f20609b74e2332516639f39b 100644 --- a/crates/multi_buffer/src/multi_buffer_tests.rs +++ b/crates/multi_buffer/src/multi_buffer_tests.rs @@ -32,6 +32,7 @@ fn test_empty_singleton(cx: &mut App) { multibuffer_row: Some(MultiBufferRow(0)), diff_status: None, expand_info: None, + wrapped_buffer_row: None, }] ); } @@ -2432,6 +2433,8 @@ impl ReferenceMultibuffer { buffer_id: region.buffer_id, diff_status: region.status, buffer_row, + wrapped_buffer_row: None, + multibuffer_row: Some(MultiBufferRow( text[..ix].matches('\n').count() as u32 )), diff --git a/crates/settings/src/settings_content/editor.rs b/crates/settings/src/settings_content/editor.rs index 920f02a0f6597454c82d421247787e8ad6f7f74b..0c6e478bcf021ac837f9544d78f01c678e4240b9 100644 --- a/crates/settings/src/settings_content/editor.rs +++ b/crates/settings/src/settings_content/editor.rs @@ -97,9 +97,11 @@ pub struct EditorSettingsContent { #[serde(serialize_with = "crate::serialize_optional_f32_with_two_decimal_places")] pub fast_scroll_sensitivity: Option, /// Whether the line numbers on editors gutter are relative or not. + /// When "enabled" shows relative number of buffer lines, when "wrapped" shows + /// relative number of display lines. /// - /// Default: false - pub relative_line_numbers: Option, + /// Default: "disabled" + pub relative_line_numbers: Option, /// When to populate a new search's query based on the text under the cursor. /// /// Default: always @@ -199,6 +201,41 @@ pub struct EditorSettingsContent { pub lsp_document_colors: Option, } +#[derive( + Debug, + Clone, + Copy, + Serialize, + Deserialize, + JsonSchema, + MergeFrom, + PartialEq, + Eq, + strum::VariantArray, + strum::VariantNames, +)] +#[serde(rename_all = "snake_case")] +pub enum RelativeLineNumbers { + Disabled, + Enabled, + Wrapped, +} + +impl RelativeLineNumbers { + pub fn enabled(&self) -> bool { + match self { + RelativeLineNumbers::Enabled | RelativeLineNumbers::Wrapped => true, + RelativeLineNumbers::Disabled => false, + } + } + pub fn wrapped(&self) -> bool { + match self { + RelativeLineNumbers::Enabled | RelativeLineNumbers::Disabled => false, + RelativeLineNumbers::Wrapped => true, + } + } +} + // Toolbar related settings #[skip_serializing_none] #[derive(Debug, Clone, Default, Serialize, Deserialize, JsonSchema, MergeFrom, PartialEq, Eq)] diff --git a/crates/settings/src/vscode_import.rs b/crates/settings/src/vscode_import.rs index fd9b343ad9cf6b0fd93ac31bf2dd2e1f2f6023bf..f038f8fbbf2c1053868c9af61beae5ccdfe9bb02 100644 --- a/crates/settings/src/vscode_import.rs +++ b/crates/settings/src/vscode_import.rs @@ -275,7 +275,7 @@ impl VsCodeSettings { }), redact_private_values: None, relative_line_numbers: self.read_enum("editor.lineNumbers", |s| match s { - "relative" => Some(true), + "relative" => Some(RelativeLineNumbers::Enabled), _ => None, }), rounded_selection: self.read_bool("editor.roundedSelection"), diff --git a/crates/settings_ui/src/page_data.rs b/crates/settings_ui/src/page_data.rs index 394e6821c85f68e08450ba18fe2e44959e0cf865..ed3650f361da2d035aaadb8d0aa2bf081e6bc8b5 100644 --- a/crates/settings_ui/src/page_data.rs +++ b/crates/settings_ui/src/page_data.rs @@ -1503,7 +1503,7 @@ pub(crate) fn settings_data(cx: &App) -> Vec { }), SettingsPageItem::SettingItem(SettingItem { title: "Relative Line Numbers", - description: "Whether the line numbers in the editor's gutter are relative or not.", + description: "Controls line number display in the editor's gutter. \"disabled\" shows absolute line numbers, \"enabled\" shows relative line numbers for each absolute line, and \"wrapped\" shows relative line numbers for every line, absolute or wrapped.", field: Box::new(SettingField { json_path: Some("relative_line_numbers"), pick: |settings_content| { diff --git a/crates/settings_ui/src/settings_ui.rs b/crates/settings_ui/src/settings_ui.rs index e60304a9f7bb34b6b802b59f4410c27f322cad01..71b4d6e0ca04238506f7754594c5a968c9d2d300 100644 --- a/crates/settings_ui/src/settings_ui.rs +++ b/crates/settings_ui/src/settings_ui.rs @@ -491,6 +491,7 @@ fn init_renderers(cx: &mut App) { .add_basic_renderer::(render_dropdown) .add_basic_renderer::(render_dropdown) .add_basic_renderer::(render_dropdown) + .add_basic_renderer::(render_dropdown) // please semicolon stay on next line ; } diff --git a/docs/src/vim.md b/docs/src/vim.md index 6af563d3555ab0bbc192b8521ce3eb0986c28988..f1296c4575ce26a298a2e7bb8d13eba37c239a50 100644 --- a/docs/src/vim.md +++ b/docs/src/vim.md @@ -606,7 +606,7 @@ Here are a few general Zed settings that can help you fine-tune your Vim experie | Property | Description | Default Value | | ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------- | | cursor_blink | If `true`, the cursor blinks. | `true` | -| relative_line_numbers | If `true`, line numbers in the left gutter are relative to the cursor. | `false` | +| relative_line_numbers | If `"enabled"`, line numbers in the left gutter are relative to the cursor. If `"wrapped"`, they also display for wrapped lines. | `"disabled"` | | scrollbar | Object that controls the scrollbar display. Set to `{ "show": "never" }` to hide the scroll bar. | `{ "show": "auto" }` | | scroll_beyond_last_line | If set to `"one_page"`, allows scrolling up to one page beyond the last line. Set to `"off"` to prevent this behavior. | `"one_page"` | | vertical_scroll_margin | The number of lines to keep above or below the cursor when scrolling. Set to `0` to allow the cursor to go up to the edges of the screen vertically. | `3` | @@ -620,7 +620,7 @@ Here's an example of these settings changed: // Disable cursor blink "cursor_blink": false, // Use relative line numbers - "relative_line_numbers": true, + "relative_line_numbers": "enabled", // Hide the scroll bar "scrollbar": { "show": "never" }, // Prevent the buffer from scrolling beyond the last line diff --git a/docs/src/visual-customization.md b/docs/src/visual-customization.md index b353377dd764d2506abd4cce46352df3ca47dfcb..8998dc0a894c32108e88988210e98ffb3d90f77d 100644 --- a/docs/src/visual-customization.md +++ b/docs/src/visual-customization.md @@ -204,7 +204,7 @@ TBD: Centered layout related settings "folds": true, // Show/hide show fold buttons in the gutter. "min_line_number_digits": 4 // Reserve space for N digit line numbers }, - "relative_line_numbers": false, // Show relative line numbers in gutter + "relative_line_numbers": "enabled", // Show relative line numbers in gutter // Indent guides "indent_guides": {