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