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 languages = language_registry.language_names().into_iter();
153
154        let candidates = std::iter::once(LanguageName::new(GLOBAL_SCOPE_NAME))
155            .chain(languages)
156            .enumerate()
157            .map(|(candidate_id, name)| StringMatchCandidate::new(candidate_id, name.as_ref()))
158            .collect::<Vec<_>>();
159
160        let mut existing_scopes = HashSet::new();
161
162        if let Some(read_dir) = fs::read_dir(snippets_dir()).log_err() {
163            for entry in read_dir {
164                if let Some(entry) = entry.log_err() {
165                    let path = entry.path();
166                    if let (Some(stem), Some(extension)) = (path.file_stem(), path.extension())
167                        && extension.to_os_string().to_str() == Some("json")
168                        && let Ok(file_name) = stem.to_os_string().into_string()
169                    {
170                        existing_scopes
171                            .insert(ScopeName::from(ScopeFileName(Cow::Owned(file_name))));
172                    }
173                }
174            }
175        }
176
177        Self {
178            workspace,
179            scope_selector,
180            language_registry,
181            candidates,
182            matches: Vec::new(),
183            selected_index: 0,
184            existing_scopes,
185        }
186    }
187
188    fn scope_icon(&self, matcher: &LanguageMatcher, cx: &App) -> Option<Icon> {
189        matcher
190            .path_suffixes
191            .iter()
192            .find_map(|extension| FileIcons::get_icon(Path::new(extension), cx))
193            .or(FileIcons::get(cx).get_icon_for_type("default", cx))
194            .map(Icon::from_path)
195            .map(|icon| icon.color(Color::Muted))
196    }
197}
198
199impl PickerDelegate for ScopeSelectorDelegate {
200    type ListItem = ListItem;
201
202    fn placeholder_text(&self, _window: &mut Window, _: &mut App) -> Arc<str> {
203        "Select snippet scope...".into()
204    }
205
206    fn match_count(&self) -> usize {
207        self.matches.len()
208    }
209
210    fn confirm(&mut self, _: bool, window: &mut Window, cx: &mut Context<Picker<Self>>) {
211        if let Some(mat) = self.matches.get(self.selected_index) {
212            let scope_name = self.candidates[mat.candidate_id].string.clone();
213            let language = self.language_registry.language_for_name(&scope_name);
214
215            if let Some(workspace) = self.workspace.upgrade() {
216                cx.spawn_in(window, async move |_, cx| {
217                    let scope_file_name = ScopeFileName(match scope_name.to_lowercase().as_str() {
218                        GLOBAL_SCOPE_NAME => Cow::Borrowed(GLOBAL_SCOPE_FILE_NAME),
219                        _ => Cow::Owned(language.await?.lsp_id()),
220                    });
221
222                    workspace.update_in(cx, |workspace, window, cx| {
223                        workspace
224                            .open_abs_path(
225                                snippets_dir().join(scope_file_name.with_extension()),
226                                OpenOptions {
227                                    visible: Some(OpenVisible::None),
228                                    ..Default::default()
229                                },
230                                window,
231                                cx,
232                            )
233                            .detach();
234                    })
235                })
236                .detach_and_log_err(cx);
237            };
238        }
239        self.dismissed(window, cx);
240    }
241
242    fn dismissed(&mut self, _: &mut Window, cx: &mut Context<Picker<Self>>) {
243        self.scope_selector
244            .update(cx, |_, cx| cx.emit(DismissEvent))
245            .log_err();
246    }
247
248    fn selected_index(&self) -> usize {
249        self.selected_index
250    }
251
252    fn set_selected_index(
253        &mut self,
254        ix: usize,
255        _window: &mut Window,
256        _: &mut Context<Picker<Self>>,
257    ) {
258        self.selected_index = ix;
259    }
260
261    fn update_matches(
262        &mut self,
263        query: String,
264        window: &mut Window,
265        cx: &mut Context<Picker<Self>>,
266    ) -> gpui::Task<()> {
267        let background = cx.background_executor().clone();
268        let candidates = self.candidates.clone();
269        cx.spawn_in(window, async move |this, cx| {
270            let matches = if query.is_empty() {
271                candidates
272                    .into_iter()
273                    .enumerate()
274                    .map(|(index, candidate)| StringMatch {
275                        candidate_id: index,
276                        string: candidate.string,
277                        positions: Vec::new(),
278                        score: 0.0,
279                    })
280                    .collect()
281            } else {
282                match_strings(
283                    &candidates,
284                    &query,
285                    false,
286                    true,
287                    100,
288                    &Default::default(),
289                    background,
290                )
291                .await
292            };
293
294            this.update(cx, |this, cx| {
295                let delegate = &mut this.delegate;
296                delegate.matches = matches;
297                delegate.selected_index = delegate
298                    .selected_index
299                    .min(delegate.matches.len().saturating_sub(1));
300                cx.notify();
301            })
302            .log_err();
303        })
304    }
305
306    fn render_match(
307        &self,
308        ix: usize,
309        selected: bool,
310        _window: &mut Window,
311        cx: &mut Context<Picker<Self>>,
312    ) -> Option<Self::ListItem> {
313        let mat = &self.matches.get(ix)?;
314        let name_label = mat.string.clone();
315
316        let scope_name = ScopeName(Cow::Owned(
317            LanguageName::new(&self.candidates[mat.candidate_id].string).lsp_id(),
318        ));
319        let file_label = if self.existing_scopes.contains(&scope_name) {
320            Some(ScopeFileName::from(scope_name).with_extension())
321        } else {
322            None
323        };
324
325        let language_icon = if FileFinderSettings::get_global(cx).file_icons {
326            let language_name = LanguageName::new(mat.string.as_str());
327            self.language_registry
328                .available_language_for_name(language_name.as_ref())
329                .and_then(|available_language| self.scope_icon(available_language.matcher(), cx))
330                .or_else(|| {
331                    Some(
332                        Icon::from_path(IconName::ToolWeb.path())
333                            .map(|icon| icon.color(Color::Muted)),
334                    )
335                })
336        } else {
337            None
338        };
339
340        Some(
341            ListItem::new(ix)
342                .inset(true)
343                .spacing(ListItemSpacing::Sparse)
344                .toggle_state(selected)
345                .start_slot::<Icon>(language_icon)
346                .child(
347                    h_flex()
348                        .gap_x_2()
349                        .child(HighlightedLabel::new(name_label, mat.positions.clone()))
350                        .when_some(file_label, |item, path_label| {
351                            item.child(
352                                Label::new(path_label)
353                                    .color(Color::Muted)
354                                    .size(LabelSize::Small),
355                            )
356                        }),
357                ),
358        )
359    }
360}