editor: Implement Go to next/prev Document Highlight (#35994)

Closes #21193
Closes #14703 

Having the ability to navigate directly to the next
symbolHighlight/reference lets you follow the data flow of a variable.
If you highlight the function itself (depending on the LSP), you can
also navigate to all returns.

Note that this is a different feature from navigating to the next match,
as that is not language-context aware. For example, if you have a var
named foo it would also navigate to an unrelated variable fooBar.

Here's how this patch works:

- The editor struct has a background_highlights.
- Collect all highlights with the keys [DocumentHighlightRead,
DocumentHighlightWrite]
- Depending on the direction, move the cursor to the next or previous
highlight relative to the current position.

Release Notes:

- Added `editor::GoToNextDocumentHighlight` and
`editor::GoToPreviousDocumentHighlight` to navigate to the next LSP
document highlight. Useful for navigating to the next usage of a certain
symbol.
This commit is contained in:
Marco Munizaga
2025-09-09 18:38:38 +00:00
committed by GitHub
parent 9431c65733
commit 14ffd7b53f
4 changed files with 182 additions and 0 deletions
+95
View File
@@ -25603,6 +25603,101 @@ async fn test_select_next_prev_syntax_node(cx: &mut TestAppContext) {
});
}
#[gpui::test]
async fn test_next_prev_document_highlight(cx: &mut TestAppContext) {
init_test(cx, |_| {});
let mut cx = EditorTestContext::new(cx).await;
cx.set_state(
"let ˇvariable = 42;
let another = variable + 1;
let result = variable * 2;",
);
// Set up document highlights manually (simulating LSP response)
cx.update_editor(|editor, _window, cx| {
let buffer_snapshot = editor.buffer().read(cx).snapshot(cx);
// Create highlights for "variable" occurrences
let highlight_ranges = [
Point::new(0, 4)..Point::new(0, 12), // First "variable"
Point::new(1, 14)..Point::new(1, 22), // Second "variable"
Point::new(2, 13)..Point::new(2, 21), // Third "variable"
];
let anchor_ranges: Vec<_> = highlight_ranges
.iter()
.map(|range| range.clone().to_anchors(&buffer_snapshot))
.collect();
editor.highlight_background::<DocumentHighlightRead>(
&anchor_ranges,
|theme| theme.colors().editor_document_highlight_read_background,
cx,
);
});
// Go to next highlight - should move to second "variable"
cx.update_editor(|editor, window, cx| {
editor.go_to_next_document_highlight(&GoToNextDocumentHighlight, window, cx);
});
cx.assert_editor_state(
"let variable = 42;
let another = ˇvariable + 1;
let result = variable * 2;",
);
// Go to next highlight - should move to third "variable"
cx.update_editor(|editor, window, cx| {
editor.go_to_next_document_highlight(&GoToNextDocumentHighlight, window, cx);
});
cx.assert_editor_state(
"let variable = 42;
let another = variable + 1;
let result = ˇvariable * 2;",
);
// Go to next highlight - should stay at third "variable" (no wrap-around)
cx.update_editor(|editor, window, cx| {
editor.go_to_next_document_highlight(&GoToNextDocumentHighlight, window, cx);
});
cx.assert_editor_state(
"let variable = 42;
let another = variable + 1;
let result = ˇvariable * 2;",
);
// Now test going backwards from third position
cx.update_editor(|editor, window, cx| {
editor.go_to_prev_document_highlight(&GoToPreviousDocumentHighlight, window, cx);
});
cx.assert_editor_state(
"let variable = 42;
let another = ˇvariable + 1;
let result = variable * 2;",
);
// Go to previous highlight - should move to first "variable"
cx.update_editor(|editor, window, cx| {
editor.go_to_prev_document_highlight(&GoToPreviousDocumentHighlight, window, cx);
});
cx.assert_editor_state(
"let ˇvariable = 42;
let another = variable + 1;
let result = variable * 2;",
);
// Go to previous highlight - should stay on first "variable"
cx.update_editor(|editor, window, cx| {
editor.go_to_prev_document_highlight(&GoToPreviousDocumentHighlight, window, cx);
});
cx.assert_editor_state(
"let ˇvariable = 42;
let another = variable + 1;
let result = variable * 2;",
);
}
#[track_caller]
fn extract_color_inlays(editor: &Editor, cx: &App) -> Vec<Rgba> {
editor