1use collections::{CommandPaletteFilter, HashMap};
2use fuzzy::{StringMatch, StringMatchCandidate};
3use gpui::{
4 actions, Action, AppContext, DismissEvent, Div, EventEmitter, FocusHandle, FocusableView,
5 Keystroke, ParentElement, Render, Styled, View, ViewContext, VisualContext, WeakView,
6};
7use picker::{Picker, PickerDelegate};
8use std::{
9 cmp::{self, Reverse},
10 sync::Arc,
11};
12use ui::{h_stack, v_stack, HighlightedLabel, KeyBinding, ListItem};
13use util::{
14 channel::{parse_zed_link, ReleaseChannel, RELEASE_CHANNEL},
15 ResultExt,
16};
17use workspace::Workspace;
18use zed_actions::OpenZedURL;
19
20actions!(Toggle);
21
22pub fn init(cx: &mut AppContext) {
23 cx.set_global(HitCounts::default());
24 cx.observe_new_views(CommandPalette::register).detach();
25}
26
27pub struct CommandPalette {
28 picker: View<Picker<CommandPaletteDelegate>>,
29}
30
31impl CommandPalette {
32 fn register(workspace: &mut Workspace, _: &mut ViewContext<Workspace>) {
33 workspace.register_action(|workspace, _: &Toggle, cx| {
34 let Some(previous_focus_handle) = cx.focused() else {
35 return;
36 };
37 workspace.toggle_modal(cx, move |cx| CommandPalette::new(previous_focus_handle, cx));
38 });
39 }
40
41 fn new(previous_focus_handle: FocusHandle, cx: &mut ViewContext<Self>) -> Self {
42 let filter = cx.try_global::<CommandPaletteFilter>();
43
44 let commands = cx
45 .available_actions()
46 .into_iter()
47 .filter_map(|action| {
48 let name = gpui::remove_the_2(action.name());
49 let namespace = name.split("::").next().unwrap_or("malformed action name");
50 if filter.is_some_and(|f| f.filtered_namespaces.contains(namespace)) {
51 return None;
52 }
53
54 Some(Command {
55 name: humanize_action_name(&name),
56 action,
57 keystrokes: vec![], // todo!()
58 })
59 })
60 .collect();
61
62 let delegate =
63 CommandPaletteDelegate::new(cx.view().downgrade(), commands, previous_focus_handle);
64
65 let picker = cx.build_view(|cx| Picker::new(delegate, cx));
66 Self { picker }
67 }
68}
69
70impl EventEmitter<DismissEvent> for CommandPalette {}
71
72impl FocusableView for CommandPalette {
73 fn focus_handle(&self, cx: &AppContext) -> FocusHandle {
74 self.picker.focus_handle(cx)
75 }
76}
77
78impl Render for CommandPalette {
79 type Element = Div;
80
81 fn render(&mut self, _cx: &mut ViewContext<Self>) -> Self::Element {
82 v_stack().w_96().child(self.picker.clone())
83 }
84}
85
86pub type CommandPaletteInterceptor =
87 Box<dyn Fn(&str, &AppContext) -> Option<CommandInterceptResult>>;
88
89pub struct CommandInterceptResult {
90 pub action: Box<dyn Action>,
91 pub string: String,
92 pub positions: Vec<usize>,
93}
94
95pub struct CommandPaletteDelegate {
96 command_palette: WeakView<CommandPalette>,
97 commands: Vec<Command>,
98 matches: Vec<StringMatch>,
99 selected_ix: usize,
100 previous_focus_handle: FocusHandle,
101}
102
103struct Command {
104 name: String,
105 action: Box<dyn Action>,
106 keystrokes: Vec<Keystroke>,
107}
108
109impl Clone for Command {
110 fn clone(&self) -> Self {
111 Self {
112 name: self.name.clone(),
113 action: self.action.boxed_clone(),
114 keystrokes: self.keystrokes.clone(),
115 }
116 }
117}
118
119/// Hit count for each command in the palette.
120/// We only account for commands triggered directly via command palette and not by e.g. keystrokes because
121/// if an user already knows a keystroke for a command, they are unlikely to use a command palette to look for it.
122#[derive(Default)]
123struct HitCounts(HashMap<String, usize>);
124
125impl CommandPaletteDelegate {
126 fn new(
127 command_palette: WeakView<CommandPalette>,
128 commands: Vec<Command>,
129 previous_focus_handle: FocusHandle,
130 ) -> Self {
131 Self {
132 command_palette,
133 matches: vec![],
134 commands,
135 selected_ix: 0,
136 previous_focus_handle,
137 }
138 }
139}
140
141impl PickerDelegate for CommandPaletteDelegate {
142 type ListItem = ListItem;
143
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 ) -> Option<Self::ListItem> {
296 let Some(r#match) = self.matches.get(ix) else {
297 return None;
298 };
299 let Some(command) = self.commands.get(r#match.candidate_id) else {
300 return None;
301 };
302
303 Some(
304 ListItem::new(ix).selected(selected).child(
305 h_stack()
306 .justify_between()
307 .child(HighlightedLabel::new(
308 command.name.clone(),
309 r#match.positions.clone(),
310 ))
311 .children(KeyBinding::for_action(&*command.action, cx)),
312 ),
313 )
314 }
315}
316
317fn humanize_action_name(name: &str) -> String {
318 let capacity = name.len() + name.chars().filter(|c| c.is_uppercase()).count();
319 let mut result = String::with_capacity(capacity);
320 for char in name.chars() {
321 if char == ':' {
322 if result.ends_with(':') {
323 result.push(' ');
324 } else {
325 result.push(':');
326 }
327 } else if char == '_' {
328 result.push(' ');
329 } else if char.is_uppercase() {
330 if !result.ends_with(' ') {
331 result.push(' ');
332 }
333 result.extend(char.to_lowercase());
334 } else {
335 result.push(char);
336 }
337 }
338 result
339}
340
341impl std::fmt::Debug for Command {
342 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
343 f.debug_struct("Command")
344 .field("name", &self.name)
345 .field("keystrokes", &self.keystrokes)
346 .finish()
347 }
348}
349
350#[cfg(test)]
351mod tests {
352 use std::sync::Arc;
353
354 use super::*;
355 use editor::Editor;
356 use gpui::TestAppContext;
357 use project::Project;
358 use workspace::{AppState, Workspace};
359
360 #[test]
361 fn test_humanize_action_name() {
362 assert_eq!(
363 humanize_action_name("editor::GoToDefinition"),
364 "editor: go to definition"
365 );
366 assert_eq!(
367 humanize_action_name("editor::Backspace"),
368 "editor: backspace"
369 );
370 assert_eq!(
371 humanize_action_name("go_to_line::Deploy"),
372 "go to line: deploy"
373 );
374 }
375
376 #[gpui::test]
377 async fn test_command_palette(cx: &mut TestAppContext) {
378 let app_state = init_test(cx);
379
380 let project = Project::test(app_state.fs.clone(), [], cx).await;
381 let (workspace, cx) = cx.add_window_view(|cx| Workspace::test_new(project.clone(), cx));
382
383 let editor = cx.build_view(|cx| {
384 let mut editor = Editor::single_line(cx);
385 editor.set_text("abc", cx);
386 editor
387 });
388
389 workspace.update(cx, |workspace, cx| {
390 workspace.add_item(Box::new(editor.clone()), cx);
391 editor.update(cx, |editor, cx| editor.focus(cx))
392 });
393
394 cx.simulate_keystrokes("cmd-shift-p");
395
396 let palette = workspace.update(cx, |workspace, cx| {
397 workspace
398 .active_modal::<CommandPalette>(cx)
399 .unwrap()
400 .read(cx)
401 .picker
402 .clone()
403 });
404
405 palette.update(cx, |palette, _| {
406 assert!(palette.delegate.commands.len() > 5);
407 let is_sorted =
408 |actions: &[Command]| actions.windows(2).all(|pair| pair[0].name <= pair[1].name);
409 assert!(is_sorted(&palette.delegate.commands));
410 });
411
412 cx.simulate_input("bcksp");
413
414 palette.update(cx, |palette, _| {
415 assert_eq!(palette.delegate.matches[0].string, "editor: backspace");
416 });
417
418 cx.simulate_keystrokes("enter");
419
420 workspace.update(cx, |workspace, cx| {
421 assert!(workspace.active_modal::<CommandPalette>(cx).is_none());
422 assert_eq!(editor.read(cx).text(cx), "ab")
423 });
424
425 // Add namespace filter, and redeploy the palette
426 cx.update(|cx| {
427 cx.set_global(CommandPaletteFilter::default());
428 cx.update_global::<CommandPaletteFilter, _>(|filter, _| {
429 filter.filtered_namespaces.insert("editor");
430 })
431 });
432
433 cx.simulate_keystrokes("cmd-shift-p");
434 cx.simulate_input("bcksp");
435
436 let palette = workspace.update(cx, |workspace, cx| {
437 workspace
438 .active_modal::<CommandPalette>(cx)
439 .unwrap()
440 .read(cx)
441 .picker
442 .clone()
443 });
444 palette.update(cx, |palette, _| {
445 assert!(palette.delegate.matches.is_empty())
446 });
447 }
448
449 fn init_test(cx: &mut TestAppContext) -> Arc<AppState> {
450 cx.update(|cx| {
451 let app_state = AppState::test(cx);
452 theme::init(theme::LoadThemes::JustBase, cx);
453 language::init(cx);
454 editor::init(cx);
455 workspace::init(app_state.clone(), cx);
456 init(cx);
457 Project::init_settings(cx);
458 settings::load_default_keymap(cx);
459 app_state
460 })
461 }
462}