1use std::{
2 cmp::{self, Reverse},
3 sync::Arc,
4};
5
6use collections::{CommandPaletteFilter, HashMap};
7use fuzzy::{StringMatch, StringMatchCandidate};
8use gpui::{
9 actions, Action, AppContext, DismissEvent, Div, EventEmitter, FocusHandle, FocusableView,
10 ParentElement, Render, Styled, View, ViewContext, VisualContext, WeakView,
11};
12use picker::{Picker, PickerDelegate};
13
14use ui::{h_stack, prelude::*, v_stack, HighlightedLabel, KeyBinding, ListItem};
15use util::{
16 channel::{parse_zed_link, ReleaseChannel, RELEASE_CHANNEL},
17 ResultExt,
18};
19use workspace::{ModalView, Workspace};
20use zed_actions::OpenZedURL;
21
22actions!(command_palette, [Toggle]);
23
24pub fn init(cx: &mut AppContext) {
25 cx.set_global(HitCounts::default());
26 cx.set_global(CommandPaletteFilter::default());
27 cx.observe_new_views(CommandPalette::register).detach();
28}
29
30impl ModalView for CommandPalette {}
31
32pub struct CommandPalette {
33 picker: View<Picker<CommandPaletteDelegate>>,
34}
35
36impl CommandPalette {
37 fn register(workspace: &mut Workspace, _: &mut ViewContext<Workspace>) {
38 workspace.register_action(|workspace, _: &Toggle, cx| {
39 let Some(previous_focus_handle) = cx.focused() else {
40 return;
41 };
42 workspace.toggle_modal(cx, move |cx| CommandPalette::new(previous_focus_handle, cx));
43 });
44 }
45
46 fn new(previous_focus_handle: FocusHandle, cx: &mut ViewContext<Self>) -> Self {
47 let filter = cx.try_global::<CommandPaletteFilter>();
48
49 let commands = cx
50 .available_actions()
51 .into_iter()
52 .filter_map(|action| {
53 let name = action.name();
54 let namespace = name.split("::").next().unwrap_or("malformed action name");
55 if filter.is_some_and(|f| {
56 f.hidden_namespaces.contains(namespace)
57 || f.hidden_action_types.contains(&action.type_id())
58 }) {
59 return None;
60 }
61
62 Some(Command {
63 name: humanize_action_name(&name),
64 action,
65 })
66 })
67 .collect();
68
69 let delegate =
70 CommandPaletteDelegate::new(cx.view().downgrade(), commands, previous_focus_handle);
71
72 let picker = cx.build_view(|cx| Picker::new(delegate, cx));
73 Self { picker }
74 }
75}
76
77impl EventEmitter<DismissEvent> for CommandPalette {}
78
79impl FocusableView for CommandPalette {
80 fn focus_handle(&self, cx: &AppContext) -> FocusHandle {
81 self.picker.focus_handle(cx)
82 }
83}
84
85impl Render for CommandPalette {
86 type Element = Div;
87
88 fn render(&mut self, _cx: &mut ViewContext<Self>) -> Self::Element {
89 v_stack().w(rems(34.)).child(self.picker.clone())
90 }
91}
92
93pub type CommandPaletteInterceptor =
94 Box<dyn Fn(&str, &AppContext) -> Option<CommandInterceptResult>>;
95
96pub struct CommandInterceptResult {
97 pub action: Box<dyn Action>,
98 pub string: String,
99 pub positions: Vec<usize>,
100}
101
102pub struct CommandPaletteDelegate {
103 command_palette: WeakView<CommandPalette>,
104 commands: Vec<Command>,
105 matches: Vec<StringMatch>,
106 selected_ix: usize,
107 previous_focus_handle: FocusHandle,
108}
109
110struct Command {
111 name: String,
112 action: Box<dyn Action>,
113}
114
115impl Clone for Command {
116 fn clone(&self) -> Self {
117 Self {
118 name: self.name.clone(),
119 action: self.action.boxed_clone(),
120 }
121 }
122}
123
124/// Hit count for each command in the palette.
125/// We only account for commands triggered directly via command palette and not by e.g. keystrokes because
126/// if an user already knows a keystroke for a command, they are unlikely to use a command palette to look for it.
127#[derive(Default)]
128struct HitCounts(HashMap<String, usize>);
129
130impl CommandPaletteDelegate {
131 fn new(
132 command_palette: WeakView<CommandPalette>,
133 commands: Vec<Command>,
134 previous_focus_handle: FocusHandle,
135 ) -> Self {
136 Self {
137 command_palette,
138 matches: vec![],
139 commands,
140 selected_ix: 0,
141 previous_focus_handle,
142 }
143 }
144}
145
146impl PickerDelegate for CommandPaletteDelegate {
147 type ListItem = ListItem;
148
149 fn placeholder_text(&self) -> Arc<str> {
150 "Execute a command...".into()
151 }
152
153 fn match_count(&self) -> usize {
154 self.matches.len()
155 }
156
157 fn selected_index(&self) -> usize {
158 self.selected_ix
159 }
160
161 fn set_selected_index(&mut self, ix: usize, _: &mut ViewContext<Picker<Self>>) {
162 self.selected_ix = ix;
163 }
164
165 fn update_matches(
166 &mut self,
167 query: String,
168 cx: &mut ViewContext<Picker<Self>>,
169 ) -> gpui::Task<()> {
170 let mut commands = self.commands.clone();
171
172 cx.spawn(move |picker, mut cx| async move {
173 cx.read_global::<HitCounts, _>(|hit_counts, _| {
174 commands.sort_by_key(|action| {
175 (
176 Reverse(hit_counts.0.get(&action.name).cloned()),
177 action.name.clone(),
178 )
179 });
180 })
181 .ok();
182
183 let candidates = commands
184 .iter()
185 .enumerate()
186 .map(|(ix, command)| StringMatchCandidate {
187 id: ix,
188 string: command.name.to_string(),
189 char_bag: command.name.chars().collect(),
190 })
191 .collect::<Vec<_>>();
192 let mut matches = if query.is_empty() {
193 candidates
194 .into_iter()
195 .enumerate()
196 .map(|(index, candidate)| StringMatch {
197 candidate_id: index,
198 string: candidate.string,
199 positions: Vec::new(),
200 score: 0.0,
201 })
202 .collect()
203 } else {
204 fuzzy::match_strings(
205 &candidates,
206 &query,
207 true,
208 10000,
209 &Default::default(),
210 cx.background_executor().clone(),
211 )
212 .await
213 };
214
215 let mut intercept_result = cx
216 .try_read_global(|interceptor: &CommandPaletteInterceptor, cx| {
217 (interceptor)(&query, cx)
218 })
219 .flatten();
220
221 if *RELEASE_CHANNEL == ReleaseChannel::Dev {
222 if parse_zed_link(&query).is_some() {
223 intercept_result = Some(CommandInterceptResult {
224 action: OpenZedURL { url: query.clone() }.boxed_clone(),
225 string: query.clone(),
226 positions: vec![],
227 })
228 }
229 }
230
231 if let Some(CommandInterceptResult {
232 action,
233 string,
234 positions,
235 }) = intercept_result
236 {
237 if let Some(idx) = matches
238 .iter()
239 .position(|m| commands[m.candidate_id].action.type_id() == action.type_id())
240 {
241 matches.remove(idx);
242 }
243 commands.push(Command {
244 name: string.clone(),
245 action,
246 });
247 matches.insert(
248 0,
249 StringMatch {
250 candidate_id: commands.len() - 1,
251 string,
252 positions,
253 score: 0.0,
254 },
255 )
256 }
257
258 picker
259 .update(&mut cx, |picker, _| {
260 let delegate = &mut picker.delegate;
261 delegate.commands = commands;
262 delegate.matches = matches;
263 if delegate.matches.is_empty() {
264 delegate.selected_ix = 0;
265 } else {
266 delegate.selected_ix =
267 cmp::min(delegate.selected_ix, delegate.matches.len() - 1);
268 }
269 })
270 .log_err();
271 })
272 }
273
274 fn dismissed(&mut self, cx: &mut ViewContext<Picker<Self>>) {
275 self.command_palette
276 .update(cx, |_, cx| cx.emit(DismissEvent))
277 .log_err();
278 }
279
280 fn confirm(&mut self, _: bool, cx: &mut ViewContext<Picker<Self>>) {
281 if self.matches.is_empty() {
282 self.dismissed(cx);
283 return;
284 }
285 let action_ix = self.matches[self.selected_ix].candidate_id;
286 let command = self.commands.swap_remove(action_ix);
287 self.matches.clear();
288 self.commands.clear();
289 cx.update_global(|hit_counts: &mut HitCounts, _| {
290 *hit_counts.0.entry(command.name).or_default() += 1;
291 });
292 let action = command.action;
293 cx.focus(&self.previous_focus_handle);
294 cx.window_context()
295 .spawn(move |mut cx| async move { cx.update(|_, cx| cx.dispatch_action(action)) })
296 .detach_and_log_err(cx);
297 self.dismissed(cx);
298 }
299
300 fn render_match(
301 &self,
302 ix: usize,
303 selected: bool,
304 cx: &mut ViewContext<Picker<Self>>,
305 ) -> Option<Self::ListItem> {
306 let r#match = self.matches.get(ix)?;
307 let command = self.commands.get(r#match.candidate_id)?;
308 Some(
309 ListItem::new(ix).inset(true).selected(selected).child(
310 h_stack()
311 .w_full()
312 .justify_between()
313 .child(HighlightedLabel::new(
314 command.name.clone(),
315 r#match.positions.clone(),
316 ))
317 .children(KeyBinding::for_action_in(
318 &*command.action,
319 &self.previous_focus_handle,
320 cx,
321 )),
322 ),
323 )
324 }
325}
326
327fn humanize_action_name(name: &str) -> String {
328 let capacity = name.len() + name.chars().filter(|c| c.is_uppercase()).count();
329 let mut result = String::with_capacity(capacity);
330 for char in name.chars() {
331 if char == ':' {
332 if result.ends_with(':') {
333 result.push(' ');
334 } else {
335 result.push(':');
336 }
337 } else if char == '_' {
338 result.push(' ');
339 } else if char.is_uppercase() {
340 if !result.ends_with(' ') {
341 result.push(' ');
342 }
343 result.extend(char.to_lowercase());
344 } else {
345 result.push(char);
346 }
347 }
348 result
349}
350
351impl std::fmt::Debug for Command {
352 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
353 f.debug_struct("Command")
354 .field("name", &self.name)
355 .finish_non_exhaustive()
356 }
357}
358
359#[cfg(test)]
360mod tests {
361 use std::sync::Arc;
362
363 use super::*;
364 use editor::Editor;
365 use go_to_line::GoToLine;
366 use gpui::TestAppContext;
367 use language::Point;
368 use project::Project;
369 use workspace::{AppState, Workspace};
370
371 #[test]
372 fn test_humanize_action_name() {
373 assert_eq!(
374 humanize_action_name("editor::GoToDefinition"),
375 "editor: go to definition"
376 );
377 assert_eq!(
378 humanize_action_name("editor::Backspace"),
379 "editor: backspace"
380 );
381 assert_eq!(
382 humanize_action_name("go_to_line::Deploy"),
383 "go to line: deploy"
384 );
385 }
386
387 #[gpui::test]
388 async fn test_command_palette(cx: &mut TestAppContext) {
389 let app_state = init_test(cx);
390 let project = Project::test(app_state.fs.clone(), [], cx).await;
391 let (workspace, cx) = cx.add_window_view(|cx| Workspace::test_new(project.clone(), cx));
392
393 let editor = cx.build_view(|cx| {
394 let mut editor = Editor::single_line(cx);
395 editor.set_text("abc", cx);
396 editor
397 });
398
399 workspace.update(cx, |workspace, cx| {
400 workspace.add_item(Box::new(editor.clone()), cx);
401 editor.update(cx, |editor, cx| editor.focus(cx))
402 });
403
404 cx.simulate_keystrokes("cmd-shift-p");
405
406 let palette = workspace.update(cx, |workspace, cx| {
407 workspace
408 .active_modal::<CommandPalette>(cx)
409 .unwrap()
410 .read(cx)
411 .picker
412 .clone()
413 });
414
415 palette.update(cx, |palette, _| {
416 assert!(palette.delegate.commands.len() > 5);
417 let is_sorted =
418 |actions: &[Command]| actions.windows(2).all(|pair| pair[0].name <= pair[1].name);
419 assert!(is_sorted(&palette.delegate.commands));
420 });
421
422 cx.simulate_input("bcksp");
423
424 palette.update(cx, |palette, _| {
425 assert_eq!(palette.delegate.matches[0].string, "editor: backspace");
426 });
427
428 cx.simulate_keystrokes("enter");
429
430 workspace.update(cx, |workspace, cx| {
431 assert!(workspace.active_modal::<CommandPalette>(cx).is_none());
432 assert_eq!(editor.read(cx).text(cx), "ab")
433 });
434
435 // Add namespace filter, and redeploy the palette
436 cx.update(|cx| {
437 cx.set_global(CommandPaletteFilter::default());
438 cx.update_global::<CommandPaletteFilter, _>(|filter, _| {
439 filter.hidden_namespaces.insert("editor");
440 })
441 });
442
443 cx.simulate_keystrokes("cmd-shift-p");
444 cx.simulate_input("bcksp");
445
446 let palette = workspace.update(cx, |workspace, cx| {
447 workspace
448 .active_modal::<CommandPalette>(cx)
449 .unwrap()
450 .read(cx)
451 .picker
452 .clone()
453 });
454 palette.update(cx, |palette, _| {
455 assert!(palette.delegate.matches.is_empty())
456 });
457 }
458
459 #[gpui::test]
460 async fn test_go_to_line(cx: &mut TestAppContext) {
461 let app_state = init_test(cx);
462 let project = Project::test(app_state.fs.clone(), [], cx).await;
463 let (workspace, cx) = cx.add_window_view(|cx| Workspace::test_new(project.clone(), cx));
464
465 cx.simulate_keystrokes("cmd-n");
466
467 let editor = workspace.update(cx, |workspace, cx| {
468 workspace.active_item_as::<Editor>(cx).unwrap()
469 });
470 editor.update(cx, |editor, cx| editor.set_text("1\n2\n3\n4\n5\n6\n", cx));
471
472 cx.simulate_keystrokes("cmd-shift-p");
473 cx.simulate_input("go to line: Toggle");
474 cx.simulate_keystrokes("enter");
475
476 workspace.update(cx, |workspace, cx| {
477 assert!(workspace.active_modal::<GoToLine>(cx).is_some())
478 });
479
480 cx.simulate_keystrokes("3 enter");
481
482 editor.update(cx, |editor, cx| {
483 assert!(editor.focus_handle(cx).is_focused(cx));
484 assert_eq!(
485 editor.selections.last::<Point>(cx).range().start,
486 Point::new(2, 0)
487 );
488 });
489 }
490
491 fn init_test(cx: &mut TestAppContext) -> Arc<AppState> {
492 cx.update(|cx| {
493 let app_state = AppState::test(cx);
494 theme::init(theme::LoadThemes::JustBase, cx);
495 language::init(cx);
496 editor::init(cx);
497 menu::init();
498 go_to_line::init(cx);
499 workspace::init(app_state.clone(), cx);
500 init(cx);
501 Project::init_settings(cx);
502 settings::load_default_keymap(cx);
503 app_state
504 })
505 }
506}