snippets_ui.rs

  1use file_finder::file_finder_settings::FileFinderSettings;
  2use file_icons::FileIcons;
  3use fuzzy::{StringMatch, StringMatchCandidate, match_strings};
  4use gpui::{
  5    App, Context, DismissEvent, Entity, EventEmitter, Focusable, ParentElement, Render, Styled,
  6    WeakEntity, Window, actions,
  7};
  8use language::{LanguageMatcher, LanguageName, LanguageRegistry};
  9use paths::snippets_dir;
 10use picker::{Picker, PickerDelegate};
 11use settings::Settings;
 12use std::{
 13    borrow::{Borrow, Cow},
 14    collections::HashSet,
 15    fs,
 16    path::Path,
 17    sync::Arc,
 18};
 19use ui::{HighlightedLabel, ListItem, ListItemSpacing, prelude::*};
 20use util::ResultExt;
 21use workspace::{ModalView, OpenOptions, OpenVisible, Workspace, notifications::NotifyResultExt};
 22
 23#[derive(Eq, Hash, PartialEq)]
 24struct ScopeName(Cow<'static, str>);
 25
 26struct ScopeFileName(Cow<'static, str>);
 27
 28impl ScopeFileName {
 29    fn with_extension(self) -> String {
 30        format!("{}.json", self.0)
 31    }
 32}
 33
 34const GLOBAL_SCOPE_NAME: &str = "global";
 35const GLOBAL_SCOPE_FILE_NAME: &str = "snippets";
 36
 37impl From<ScopeName> for ScopeFileName {
 38    fn from(value: ScopeName) -> Self {
 39        if value.0 == GLOBAL_SCOPE_NAME {
 40            ScopeFileName(Cow::Borrowed(GLOBAL_SCOPE_FILE_NAME))
 41        } else {
 42            ScopeFileName(value.0)
 43        }
 44    }
 45}
 46
 47impl From<ScopeFileName> for ScopeName {
 48    fn from(value: ScopeFileName) -> Self {
 49        if value.0 == GLOBAL_SCOPE_FILE_NAME {
 50            ScopeName(Cow::Borrowed(GLOBAL_SCOPE_NAME))
 51        } else {
 52            ScopeName(value.0)
 53        }
 54    }
 55}
 56
 57actions!(
 58    snippets,
 59    [
 60        /// Opens the snippets configuration file.
 61        ConfigureSnippets,
 62        /// Opens the snippets folder in the file manager.
 63        OpenFolder
 64    ]
 65);
 66
 67pub fn init(cx: &mut App) {
 68    cx.observe_new(register).detach();
 69}
 70
 71fn register(workspace: &mut Workspace, _window: Option<&mut Window>, _: &mut Context<Workspace>) {
 72    workspace.register_action(configure_snippets);
 73    workspace.register_action(open_folder);
 74}
 75
 76fn configure_snippets(
 77    workspace: &mut Workspace,
 78    _: &ConfigureSnippets,
 79    window: &mut Window,
 80    cx: &mut Context<Workspace>,
 81) {
 82    let language_registry = workspace.app_state().languages.clone();
 83    let workspace_handle = workspace.weak_handle();
 84
 85    workspace.toggle_modal(window, cx, move |window, cx| {
 86        ScopeSelector::new(language_registry, workspace_handle, window, cx)
 87    });
 88}
 89
 90fn open_folder(
 91    workspace: &mut Workspace,
 92    _: &OpenFolder,
 93    _: &mut Window,
 94    cx: &mut Context<Workspace>,
 95) {
 96    fs::create_dir_all(snippets_dir()).notify_err(workspace, cx);
 97    cx.open_with_system(snippets_dir().borrow());
 98}
 99
100pub struct ScopeSelector {
101    picker: Entity<Picker<ScopeSelectorDelegate>>,
102}
103
104impl ScopeSelector {
105    fn new(
106        language_registry: Arc<LanguageRegistry>,
107        workspace: WeakEntity<Workspace>,
108        window: &mut Window,
109        cx: &mut Context<Self>,
110    ) -> Self {
111        let delegate =
112            ScopeSelectorDelegate::new(workspace, cx.entity().downgrade(), language_registry);
113
114        let picker = cx.new(|cx| Picker::uniform_list(delegate, window, cx));
115
116        Self { picker }
117    }
118}
119
120impl ModalView for ScopeSelector {}
121
122impl EventEmitter<DismissEvent> for ScopeSelector {}
123
124impl Focusable for ScopeSelector {
125    fn focus_handle(&self, cx: &App) -> gpui::FocusHandle {
126        self.picker.focus_handle(cx)
127    }
128}
129
130impl Render for ScopeSelector {
131    fn render(&mut self, _window: &mut Window, _cx: &mut Context<Self>) -> impl IntoElement {
132        v_flex().w(rems(34.)).child(self.picker.clone())
133    }
134}
135
136pub struct ScopeSelectorDelegate {
137    workspace: WeakEntity<Workspace>,
138    scope_selector: WeakEntity<ScopeSelector>,
139    language_registry: Arc<LanguageRegistry>,
140    candidates: Vec<StringMatchCandidate>,
141    matches: Vec<StringMatch>,
142    selected_index: usize,
143    existing_scopes: HashSet<ScopeName>,
144}
145
146impl ScopeSelectorDelegate {
147    fn new(
148        workspace: WeakEntity<Workspace>,
149        scope_selector: WeakEntity<ScopeSelector>,
150        language_registry: Arc<LanguageRegistry>,
151    ) -> Self {
152        let candidates = Vec::from([GLOBAL_SCOPE_NAME.to_string()]).into_iter();
153        let languages = language_registry.language_names().into_iter();
154
155        let candidates = candidates
156            .chain(languages)
157            .enumerate()
158            .map(|(candidate_id, name)| StringMatchCandidate::new(candidate_id, &name))
159            .collect::<Vec<_>>();
160
161        let mut existing_scopes = HashSet::new();
162
163        if let Some(read_dir) = fs::read_dir(snippets_dir()).log_err() {
164            for entry in read_dir {
165                if let Some(entry) = entry.log_err() {
166                    let path = entry.path();
167                    if let (Some(stem), Some(extension)) = (path.file_stem(), path.extension()) {
168                        if extension.to_os_string().to_str() == Some("json") {
169                            if let Ok(file_name) = stem.to_os_string().into_string() {
170                                existing_scopes
171                                    .insert(ScopeName::from(ScopeFileName(Cow::Owned(file_name))));
172                            }
173                        }
174                    }
175                }
176            }
177        }
178
179        Self {
180            workspace,
181            scope_selector,
182            language_registry,
183            candidates,
184            matches: Vec::new(),
185            selected_index: 0,
186            existing_scopes,
187        }
188    }
189
190    fn scope_icon(&self, matcher: &LanguageMatcher, cx: &App) -> Option<Icon> {
191        matcher
192            .path_suffixes
193            .iter()
194            .find_map(|extension| FileIcons::get_icon(Path::new(extension), cx))
195            .or(FileIcons::get(cx).get_icon_for_type("default", cx))
196            .map(Icon::from_path)
197            .map(|icon| icon.color(Color::Muted))
198    }
199}
200
201impl PickerDelegate for ScopeSelectorDelegate {
202    type ListItem = ListItem;
203
204    fn placeholder_text(&self, _window: &mut Window, _: &mut App) -> Arc<str> {
205        "Select snippet scope...".into()
206    }
207
208    fn match_count(&self) -> usize {
209        self.matches.len()
210    }
211
212    fn confirm(&mut self, _: bool, window: &mut Window, cx: &mut Context<Picker<Self>>) {
213        if let Some(mat) = self.matches.get(self.selected_index) {
214            let scope_name = self.candidates[mat.candidate_id].string.clone();
215            let language = self.language_registry.language_for_name(&scope_name);
216
217            if let Some(workspace) = self.workspace.upgrade() {
218                cx.spawn_in(window, async move |_, cx| {
219                    let scope_file_name = ScopeFileName(match scope_name.to_lowercase().as_str() {
220                        GLOBAL_SCOPE_NAME => Cow::Borrowed(GLOBAL_SCOPE_FILE_NAME),
221                        _ => Cow::Owned(language.await?.lsp_id()),
222                    });
223
224                    workspace.update_in(cx, |workspace, window, cx| {
225                        workspace
226                            .open_abs_path(
227                                snippets_dir().join(scope_file_name.with_extension()),
228                                OpenOptions {
229                                    visible: Some(OpenVisible::None),
230                                    ..Default::default()
231                                },
232                                window,
233                                cx,
234                            )
235                            .detach();
236                    })
237                })
238                .detach_and_log_err(cx);
239            };
240        }
241        self.dismissed(window, cx);
242    }
243
244    fn dismissed(&mut self, _: &mut Window, cx: &mut Context<Picker<Self>>) {
245        self.scope_selector
246            .update(cx, |_, cx| cx.emit(DismissEvent))
247            .log_err();
248    }
249
250    fn selected_index(&self) -> usize {
251        self.selected_index
252    }
253
254    fn set_selected_index(
255        &mut self,
256        ix: usize,
257        _window: &mut Window,
258        _: &mut Context<Picker<Self>>,
259    ) {
260        self.selected_index = ix;
261    }
262
263    fn update_matches(
264        &mut self,
265        query: String,
266        window: &mut Window,
267        cx: &mut Context<Picker<Self>>,
268    ) -> gpui::Task<()> {
269        let background = cx.background_executor().clone();
270        let candidates = self.candidates.clone();
271        cx.spawn_in(window, async move |this, cx| {
272            let matches = if query.is_empty() {
273                candidates
274                    .into_iter()
275                    .enumerate()
276                    .map(|(index, candidate)| StringMatch {
277                        candidate_id: index,
278                        string: candidate.string,
279                        positions: Vec::new(),
280                        score: 0.0,
281                    })
282                    .collect()
283            } else {
284                match_strings(
285                    &candidates,
286                    &query,
287                    false,
288                    true,
289                    100,
290                    &Default::default(),
291                    background,
292                )
293                .await
294            };
295
296            this.update(cx, |this, cx| {
297                let delegate = &mut this.delegate;
298                delegate.matches = matches;
299                delegate.selected_index = delegate
300                    .selected_index
301                    .min(delegate.matches.len().saturating_sub(1));
302                cx.notify();
303            })
304            .log_err();
305        })
306    }
307
308    fn render_match(
309        &self,
310        ix: usize,
311        selected: bool,
312        _window: &mut Window,
313        cx: &mut Context<Picker<Self>>,
314    ) -> Option<Self::ListItem> {
315        let mat = &self.matches[ix];
316        let name_label = mat.string.clone();
317
318        let scope_name = ScopeName(Cow::Owned(
319            LanguageName::new(&self.candidates[mat.candidate_id].string).lsp_id(),
320        ));
321        let file_label = if self.existing_scopes.contains(&scope_name) {
322            Some(ScopeFileName::from(scope_name).with_extension())
323        } else {
324            None
325        };
326
327        let language_icon = if FileFinderSettings::get_global(cx).file_icons {
328            let language_name = LanguageName::new(mat.string.as_str());
329            self.language_registry
330                .available_language_for_name(language_name.as_ref())
331                .and_then(|available_language| self.scope_icon(available_language.matcher(), cx))
332                .or_else(|| {
333                    Some(
334                        Icon::from_path(IconName::Globe.path())
335                            .map(|icon| icon.color(Color::Muted)),
336                    )
337                })
338        } else {
339            None
340        };
341
342        Some(
343            ListItem::new(ix)
344                .inset(true)
345                .spacing(ListItemSpacing::Sparse)
346                .toggle_state(selected)
347                .start_slot::<Icon>(language_icon)
348                .child(
349                    h_flex()
350                        .gap_x_2()
351                        .child(HighlightedLabel::new(name_label, mat.positions.clone()))
352                        .when_some(file_label, |item, path_label| {
353                            item.child(
354                                Label::new(path_label)
355                                    .color(Color::Muted)
356                                    .size(LabelSize::Small),
357                            )
358                        }),
359                ),
360        )
361    }
362}