editor: Show code actions in mouse context menu (#28677)
Closes #27989 Asynchronous fetch of code actions on right-click, and shows them in context menu. https://github.com/user-attachments/assets/413eb0dd-cd1c-4628-a6f1-84eac813da32 Release Notes: - Improved visibility of code actions by showing them in right-click context menu.
This commit is contained in:
Smit Barmase
GitHub
parent
98891e4c70
commit
f2ce183286
5 changed files with 398 additions and 173 deletions
|
|
@ -1,15 +1,22 @@
|
|||
use crate::{
|
||||
Copy, CopyAndTrim, CopyPermalinkToLine, Cut, DebuggerEvaluateSelectedText, DisplayPoint,
|
||||
DisplaySnapshot, Editor, FindAllReferences, GoToDeclaration, GoToDefinition,
|
||||
ConfirmCodeAction, Copy, CopyAndTrim, CopyPermalinkToLine, Cut, DebuggerEvaluateSelectedText,
|
||||
DisplayPoint, DisplaySnapshot, Editor, FindAllReferences, GoToDeclaration, GoToDefinition,
|
||||
GoToImplementation, GoToTypeDefinition, Paste, Rename, RevealInFileManager, SelectMode,
|
||||
ToDisplayPoint, ToggleCodeActions,
|
||||
actions::{Format, FormatSelections},
|
||||
code_context_menus::CodeActionContents,
|
||||
selections_collection::SelectionsCollection,
|
||||
};
|
||||
use feature_flags::{Debugger, FeatureFlagAppExt as _};
|
||||
use gpui::prelude::FluentBuilder;
|
||||
use gpui::{Context, DismissEvent, Entity, Focusable as _, Pixels, Point, Subscription, Window};
|
||||
use gpui::{
|
||||
Context, DismissEvent, Entity, FocusHandle, Focusable as _, Pixels, Point, Subscription, Task,
|
||||
Window,
|
||||
};
|
||||
use std::ops::Range;
|
||||
use text::PointUtf16;
|
||||
use ui::ContextMenu;
|
||||
use util::ResultExt;
|
||||
use workspace::OpenInTerminal;
|
||||
|
||||
#[derive(Debug)]
|
||||
|
|
@ -25,12 +32,23 @@ pub enum MenuPosition {
|
|||
},
|
||||
}
|
||||
|
||||
pub struct MouseCodeAction {
|
||||
pub actions: CodeActionContents,
|
||||
pub buffer: Entity<language::Buffer>,
|
||||
}
|
||||
|
||||
pub struct MouseContextMenu {
|
||||
pub(crate) position: MenuPosition,
|
||||
pub(crate) context_menu: Entity<ui::ContextMenu>,
|
||||
pub(crate) code_action: Option<MouseCodeAction>,
|
||||
_subscription: Subscription,
|
||||
}
|
||||
|
||||
enum CodeActionLoadState {
|
||||
Loading,
|
||||
Loaded(CodeActionContents),
|
||||
}
|
||||
|
||||
impl std::fmt::Debug for MouseContextMenu {
|
||||
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
|
||||
f.debug_struct("MouseContextMenu")
|
||||
|
|
@ -45,6 +63,7 @@ impl MouseContextMenu {
|
|||
editor: &mut Editor,
|
||||
source: multi_buffer::Anchor,
|
||||
position: Point<Pixels>,
|
||||
code_action: Option<MouseCodeAction>,
|
||||
context_menu: Entity<ui::ContextMenu>,
|
||||
window: &mut Window,
|
||||
cx: &mut Context<Editor>,
|
||||
|
|
@ -63,6 +82,7 @@ impl MouseContextMenu {
|
|||
return Some(MouseContextMenu::new(
|
||||
menu_position,
|
||||
context_menu,
|
||||
code_action,
|
||||
window,
|
||||
cx,
|
||||
));
|
||||
|
|
@ -71,6 +91,7 @@ impl MouseContextMenu {
|
|||
pub(crate) fn new(
|
||||
position: MenuPosition,
|
||||
context_menu: Entity<ui::ContextMenu>,
|
||||
code_action: Option<MouseCodeAction>,
|
||||
window: &mut Window,
|
||||
cx: &mut Context<Editor>,
|
||||
) -> Self {
|
||||
|
|
@ -91,6 +112,7 @@ impl MouseContextMenu {
|
|||
Self {
|
||||
position,
|
||||
context_menu,
|
||||
code_action,
|
||||
_subscription,
|
||||
}
|
||||
}
|
||||
|
|
@ -129,13 +151,13 @@ pub fn deploy_context_menu(
|
|||
|
||||
let display_map = editor.selections.display_map(cx);
|
||||
let source_anchor = display_map.display_point_to_anchor(point, text::Bias::Right);
|
||||
let context_menu = if let Some(custom) = editor.custom_context_menu.take() {
|
||||
if let Some(custom) = editor.custom_context_menu.take() {
|
||||
let menu = custom(editor, point, window, cx);
|
||||
editor.custom_context_menu = Some(custom);
|
||||
let Some(menu) = menu else {
|
||||
return;
|
||||
};
|
||||
menu
|
||||
set_context_menu(editor, menu, source_anchor, position, None, window, cx);
|
||||
} else {
|
||||
// Don't show the context menu if there isn't a project associated with this editor
|
||||
let Some(project) = editor.project.clone() else {
|
||||
|
|
@ -174,74 +196,223 @@ pub fn deploy_context_menu(
|
|||
!filter.is_hidden(&DebuggerEvaluateSelectedText)
|
||||
});
|
||||
|
||||
ui::ContextMenu::build(window, cx, |menu, _window, _cx| {
|
||||
let builder = menu
|
||||
.on_blur_subscription(Subscription::new(|| {}))
|
||||
.when(evaluate_selection && has_selections, |builder| {
|
||||
builder
|
||||
.action("Evaluate Selection", Box::new(DebuggerEvaluateSelectedText))
|
||||
.separator()
|
||||
})
|
||||
.action("Go to Definition", Box::new(GoToDefinition))
|
||||
.action("Go to Declaration", Box::new(GoToDeclaration))
|
||||
.action("Go to Type Definition", Box::new(GoToTypeDefinition))
|
||||
.action("Go to Implementation", Box::new(GoToImplementation))
|
||||
.action("Find All References", Box::new(FindAllReferences))
|
||||
.separator()
|
||||
.action("Rename Symbol", Box::new(Rename))
|
||||
.action("Format Buffer", Box::new(Format))
|
||||
.when(has_selections, |cx| {
|
||||
cx.action("Format Selections", Box::new(FormatSelections))
|
||||
})
|
||||
.action(
|
||||
"Code Actions",
|
||||
Box::new(ToggleCodeActions {
|
||||
deployed_from_indicator: None,
|
||||
}),
|
||||
)
|
||||
.separator()
|
||||
.action("Cut", Box::new(Cut))
|
||||
.action("Copy", Box::new(Copy))
|
||||
.action("Copy and trim", Box::new(CopyAndTrim))
|
||||
.action("Paste", Box::new(Paste))
|
||||
.separator()
|
||||
.map(|builder| {
|
||||
let reveal_in_finder_label = if cfg!(target_os = "macos") {
|
||||
"Reveal in Finder"
|
||||
} else {
|
||||
"Reveal in File Manager"
|
||||
};
|
||||
const OPEN_IN_TERMINAL_LABEL: &str = "Open in Terminal";
|
||||
if has_reveal_target {
|
||||
builder
|
||||
.action(reveal_in_finder_label, Box::new(RevealInFileManager))
|
||||
.action(OPEN_IN_TERMINAL_LABEL, Box::new(OpenInTerminal))
|
||||
} else {
|
||||
builder
|
||||
.disabled_action(reveal_in_finder_label, Box::new(RevealInFileManager))
|
||||
.disabled_action(OPEN_IN_TERMINAL_LABEL, Box::new(OpenInTerminal))
|
||||
}
|
||||
})
|
||||
.map(|builder| {
|
||||
const COPY_PERMALINK_LABEL: &str = "Copy Permalink";
|
||||
if has_git_repo {
|
||||
builder.action(COPY_PERMALINK_LABEL, Box::new(CopyPermalinkToLine))
|
||||
} else {
|
||||
builder.disabled_action(COPY_PERMALINK_LABEL, Box::new(CopyPermalinkToLine))
|
||||
}
|
||||
});
|
||||
match focus {
|
||||
Some(focus) => builder.context(focus),
|
||||
None => builder,
|
||||
}
|
||||
})
|
||||
};
|
||||
let menu = build_context_menu(
|
||||
focus,
|
||||
has_selections,
|
||||
has_reveal_target,
|
||||
has_git_repo,
|
||||
evaluate_selection,
|
||||
Some(CodeActionLoadState::Loading),
|
||||
window,
|
||||
cx,
|
||||
);
|
||||
|
||||
set_context_menu(editor, menu, source_anchor, position, None, window, cx);
|
||||
|
||||
let mut actions_task = editor.code_actions_task.take();
|
||||
cx.spawn_in(window, async move |editor, cx| {
|
||||
while let Some(prev_task) = actions_task {
|
||||
prev_task.await.log_err();
|
||||
actions_task = editor.update(cx, |this, _| this.code_actions_task.take())?;
|
||||
}
|
||||
let action = ToggleCodeActions {
|
||||
deployed_from_indicator: Some(point.row()),
|
||||
};
|
||||
let context_menu_task = editor.update_in(cx, |editor, window, cx| {
|
||||
let code_actions_task = editor.prepare_code_actions_task(&action, window, cx);
|
||||
Some(cx.spawn_in(window, async move |editor, cx| {
|
||||
let code_action_result = code_actions_task.await;
|
||||
if let Ok(editor_task) = editor.update_in(cx, |editor, window, cx| {
|
||||
let Some(mouse_context_menu) = editor.mouse_context_menu.take() else {
|
||||
return Task::ready(Ok::<_, anyhow::Error>(()));
|
||||
};
|
||||
if mouse_context_menu
|
||||
.context_menu
|
||||
.focus_handle(cx)
|
||||
.contains_focused(window, cx)
|
||||
{
|
||||
window.focus(&editor.focus_handle(cx));
|
||||
}
|
||||
drop(mouse_context_menu);
|
||||
let (state, code_action) =
|
||||
if let Some((buffer, actions)) = code_action_result {
|
||||
(
|
||||
CodeActionLoadState::Loaded(actions.clone()),
|
||||
Some(MouseCodeAction { actions, buffer }),
|
||||
)
|
||||
} else {
|
||||
(
|
||||
CodeActionLoadState::Loaded(CodeActionContents::default()),
|
||||
None,
|
||||
)
|
||||
};
|
||||
let menu = build_context_menu(
|
||||
window.focused(cx),
|
||||
has_selections,
|
||||
has_reveal_target,
|
||||
has_git_repo,
|
||||
evaluate_selection,
|
||||
Some(state),
|
||||
window,
|
||||
cx,
|
||||
);
|
||||
set_context_menu(
|
||||
editor,
|
||||
menu,
|
||||
source_anchor,
|
||||
position,
|
||||
code_action,
|
||||
window,
|
||||
cx,
|
||||
);
|
||||
Task::ready(Ok(()))
|
||||
}) {
|
||||
editor_task.await
|
||||
} else {
|
||||
Ok(())
|
||||
}
|
||||
}))
|
||||
})?;
|
||||
if let Some(task) = context_menu_task {
|
||||
task.await?;
|
||||
}
|
||||
Ok::<_, anyhow::Error>(())
|
||||
})
|
||||
.detach_and_log_err(cx);
|
||||
};
|
||||
}
|
||||
|
||||
fn build_context_menu(
|
||||
focus: Option<FocusHandle>,
|
||||
has_selections: bool,
|
||||
has_reveal_target: bool,
|
||||
has_git_repo: bool,
|
||||
evaluate_selection: bool,
|
||||
code_action_load_state: Option<CodeActionLoadState>,
|
||||
window: &mut Window,
|
||||
cx: &mut Context<Editor>,
|
||||
) -> Entity<ContextMenu> {
|
||||
ui::ContextMenu::build(window, cx, |menu, _window, cx| {
|
||||
let menu = menu
|
||||
.on_blur_subscription(Subscription::new(|| {}))
|
||||
.when_some(code_action_load_state, |menu, state| {
|
||||
match state {
|
||||
CodeActionLoadState::Loading => menu.disabled_action(
|
||||
"Loading code actions...",
|
||||
Box::new(ConfirmCodeAction {
|
||||
item_ix: None,
|
||||
from_mouse_context_menu: true,
|
||||
}),
|
||||
),
|
||||
CodeActionLoadState::Loaded(actions) => {
|
||||
if actions.is_empty() {
|
||||
menu.disabled_action(
|
||||
"No code actions available",
|
||||
Box::new(ConfirmCodeAction {
|
||||
item_ix: None,
|
||||
from_mouse_context_menu: true,
|
||||
}),
|
||||
)
|
||||
} else {
|
||||
actions
|
||||
.iter()
|
||||
.filter(|action| {
|
||||
if action
|
||||
.as_task()
|
||||
.map(|task| {
|
||||
matches!(task.task_type(), task::TaskType::Debug(_))
|
||||
})
|
||||
.unwrap_or(false)
|
||||
{
|
||||
cx.has_flag::<Debugger>()
|
||||
} else {
|
||||
true
|
||||
}
|
||||
})
|
||||
.enumerate()
|
||||
.fold(menu, |menu, (ix, action)| {
|
||||
menu.action(
|
||||
action.label(),
|
||||
Box::new(ConfirmCodeAction {
|
||||
item_ix: Some(ix),
|
||||
from_mouse_context_menu: true,
|
||||
}),
|
||||
)
|
||||
})
|
||||
}
|
||||
}
|
||||
}
|
||||
.separator()
|
||||
})
|
||||
.when(evaluate_selection && has_selections, |builder| {
|
||||
builder
|
||||
.action("Evaluate Selection", Box::new(DebuggerEvaluateSelectedText))
|
||||
.separator()
|
||||
})
|
||||
.action("Go to Definition", Box::new(GoToDefinition))
|
||||
.action("Go to Declaration", Box::new(GoToDeclaration))
|
||||
.action("Go to Type Definition", Box::new(GoToTypeDefinition))
|
||||
.action("Go to Implementation", Box::new(GoToImplementation))
|
||||
.action("Find All References", Box::new(FindAllReferences))
|
||||
.separator()
|
||||
.action("Rename Symbol", Box::new(Rename))
|
||||
.action("Format Buffer", Box::new(Format))
|
||||
.when(has_selections, |cx| {
|
||||
cx.action("Format Selections", Box::new(FormatSelections))
|
||||
})
|
||||
.separator()
|
||||
.action("Cut", Box::new(Cut))
|
||||
.action("Copy", Box::new(Copy))
|
||||
.action("Copy and trim", Box::new(CopyAndTrim))
|
||||
.action("Paste", Box::new(Paste))
|
||||
.separator()
|
||||
.map(|builder| {
|
||||
let reveal_in_finder_label = if cfg!(target_os = "macos") {
|
||||
"Reveal in Finder"
|
||||
} else {
|
||||
"Reveal in File Manager"
|
||||
};
|
||||
const OPEN_IN_TERMINAL_LABEL: &str = "Open in Terminal";
|
||||
if has_reveal_target {
|
||||
builder
|
||||
.action(reveal_in_finder_label, Box::new(RevealInFileManager))
|
||||
.action(OPEN_IN_TERMINAL_LABEL, Box::new(OpenInTerminal))
|
||||
} else {
|
||||
builder
|
||||
.disabled_action(reveal_in_finder_label, Box::new(RevealInFileManager))
|
||||
.disabled_action(OPEN_IN_TERMINAL_LABEL, Box::new(OpenInTerminal))
|
||||
}
|
||||
})
|
||||
.map(|builder| {
|
||||
const COPY_PERMALINK_LABEL: &str = "Copy Permalink";
|
||||
if has_git_repo {
|
||||
builder.action(COPY_PERMALINK_LABEL, Box::new(CopyPermalinkToLine))
|
||||
} else {
|
||||
builder.disabled_action(COPY_PERMALINK_LABEL, Box::new(CopyPermalinkToLine))
|
||||
}
|
||||
});
|
||||
match focus {
|
||||
Some(focus) => menu.context(focus),
|
||||
None => menu,
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
fn set_context_menu(
|
||||
editor: &mut Editor,
|
||||
context_menu: Entity<ui::ContextMenu>,
|
||||
source_anchor: multi_buffer::Anchor,
|
||||
position: Option<Point<Pixels>>,
|
||||
code_action: Option<MouseCodeAction>,
|
||||
window: &mut Window,
|
||||
cx: &mut Context<Editor>,
|
||||
) {
|
||||
editor.mouse_context_menu = match position {
|
||||
Some(position) => MouseContextMenu::pinned_to_editor(
|
||||
editor,
|
||||
source_anchor,
|
||||
position,
|
||||
code_action,
|
||||
context_menu,
|
||||
window,
|
||||
cx,
|
||||
|
|
@ -255,6 +426,7 @@ pub fn deploy_context_menu(
|
|||
Some(MouseContextMenu::new(
|
||||
menu_position,
|
||||
context_menu,
|
||||
code_action,
|
||||
window,
|
||||
cx,
|
||||
))
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue