1//! # settings_ui
2mod components;
3mod page_data;
4
5use anyhow::Result;
6use editor::{Editor, EditorEvent};
7use feature_flags::{FeatureFlag, FeatureFlagAppExt as _};
8use fuzzy::StringMatchCandidate;
9use gpui::{
10 Action, App, Div, Entity, FocusHandle, Focusable, FontWeight, Global, ReadGlobal as _,
11 ScrollHandle, Task, TitlebarOptions, UniformListScrollHandle, Window, WindowHandle,
12 WindowOptions, actions, div, point, prelude::*, px, size, uniform_list,
13};
14use heck::ToTitleCase as _;
15use project::WorktreeId;
16use schemars::JsonSchema;
17use serde::Deserialize;
18use settings::{
19 BottomDockLayout, CloseWindowWhenNoItems, CodeFade, CursorShape, OnLastWindowClosed,
20 RestoreOnStartupBehavior, SaturatingBool, SettingsContent, SettingsStore,
21};
22use std::{
23 any::{Any, TypeId, type_name},
24 cell::RefCell,
25 collections::HashMap,
26 num::{NonZero, NonZeroU32},
27 ops::Range,
28 rc::Rc,
29 sync::{Arc, LazyLock, RwLock, atomic::AtomicBool},
30};
31use ui::{
32 ButtonLike, ContextMenu, Divider, DropdownMenu, DropdownStyle, IconButtonShape,
33 KeybindingPosition, PopoverMenu, Switch, SwitchColor, TreeViewItem, WithScrollbar, prelude::*,
34};
35use ui_input::{NumericStepper, NumericStepperStyle, NumericStepperType};
36use util::{ResultExt as _, paths::PathStyle, rel_path::RelPath};
37use zed_actions::OpenSettingsEditor;
38
39use crate::components::SettingsEditor;
40
41const NAVBAR_CONTAINER_TAB_INDEX: isize = 0;
42const NAVBAR_GROUP_TAB_INDEX: isize = 1;
43const CONTENT_CONTAINER_TAB_INDEX: isize = 2;
44const CONTENT_GROUP_TAB_INDEX: isize = 3;
45
46actions!(
47 settings_editor,
48 [
49 /// Toggles focus between the navbar and the main content.
50 ToggleFocusNav,
51 /// Focuses the next file in the file list.
52 FocusNextFile,
53 /// Focuses the previous file in the file list.
54 FocusPreviousFile
55 ]
56);
57
58#[derive(Action, PartialEq, Eq, Clone, Copy, Debug, JsonSchema, Deserialize)]
59#[action(namespace = settings_editor)]
60struct FocusFile(pub u32);
61
62#[derive(Clone, Copy)]
63struct SettingField<T: 'static> {
64 pick: fn(&SettingsContent) -> &Option<T>,
65 pick_mut: fn(&mut SettingsContent) -> &mut Option<T>,
66}
67
68/// Helper for unimplemented settings, used in combination with `SettingField::unimplemented`
69/// to keep the setting around in the UI with valid pick and pick_mut implementations, but don't actually try to render it.
70/// TODO(settings_ui): In non-dev builds (`#[cfg(not(debug_assertions))]`) make this render as edit-in-json
71struct UnimplementedSettingField;
72
73impl<T: 'static> SettingField<T> {
74 /// Helper for settings with types that are not yet implemented.
75 #[allow(unused)]
76 fn unimplemented(self) -> SettingField<UnimplementedSettingField> {
77 SettingField {
78 pick: |_| &None,
79 pick_mut: |_| unreachable!(),
80 }
81 }
82}
83
84trait AnySettingField {
85 fn as_any(&self) -> &dyn Any;
86 fn type_name(&self) -> &'static str;
87 fn type_id(&self) -> TypeId;
88 // Returns the file this value was set in and true, or File::Default and false to indicate it was not found in any file (missing default)
89 fn file_set_in(&self, file: SettingsUiFile, cx: &App) -> (settings::SettingsFile, bool);
90}
91
92impl<T> AnySettingField for SettingField<T> {
93 fn as_any(&self) -> &dyn Any {
94 self
95 }
96
97 fn type_name(&self) -> &'static str {
98 type_name::<T>()
99 }
100
101 fn type_id(&self) -> TypeId {
102 TypeId::of::<T>()
103 }
104
105 fn file_set_in(&self, file: SettingsUiFile, cx: &App) -> (settings::SettingsFile, bool) {
106 if AnySettingField::type_id(self) == TypeId::of::<UnimplementedSettingField>() {
107 return (file.to_settings(), true);
108 }
109
110 let (file, value) = cx
111 .global::<SettingsStore>()
112 .get_value_from_file(file.to_settings(), self.pick);
113 return (file, value.is_some());
114 }
115}
116
117#[derive(Default, Clone)]
118struct SettingFieldRenderer {
119 renderers: Rc<
120 RefCell<
121 HashMap<
122 TypeId,
123 Box<
124 dyn Fn(
125 &dyn AnySettingField,
126 SettingsUiFile,
127 Option<&SettingsFieldMetadata>,
128 &mut Window,
129 &mut App,
130 ) -> AnyElement,
131 >,
132 >,
133 >,
134 >,
135}
136
137impl Global for SettingFieldRenderer {}
138
139impl SettingFieldRenderer {
140 fn add_renderer<T: 'static>(
141 &mut self,
142 renderer: impl Fn(
143 &SettingField<T>,
144 SettingsUiFile,
145 Option<&SettingsFieldMetadata>,
146 &mut Window,
147 &mut App,
148 ) -> AnyElement
149 + 'static,
150 ) -> &mut Self {
151 let key = TypeId::of::<T>();
152 let renderer = Box::new(
153 move |any_setting_field: &dyn AnySettingField,
154 settings_file: SettingsUiFile,
155 metadata: Option<&SettingsFieldMetadata>,
156 window: &mut Window,
157 cx: &mut App| {
158 let field = any_setting_field
159 .as_any()
160 .downcast_ref::<SettingField<T>>()
161 .unwrap();
162 renderer(field, settings_file, metadata, window, cx)
163 },
164 );
165 self.renderers.borrow_mut().insert(key, renderer);
166 self
167 }
168
169 fn render(
170 &self,
171 any_setting_field: &dyn AnySettingField,
172 settings_file: SettingsUiFile,
173 metadata: Option<&SettingsFieldMetadata>,
174 window: &mut Window,
175 cx: &mut App,
176 ) -> AnyElement {
177 let key = any_setting_field.type_id();
178 if let Some(renderer) = self.renderers.borrow().get(&key) {
179 renderer(any_setting_field, settings_file, metadata, window, cx)
180 } else {
181 panic!(
182 "No renderer found for type: {}",
183 any_setting_field.type_name()
184 )
185 }
186 }
187}
188
189struct SettingsFieldMetadata {
190 placeholder: Option<&'static str>,
191}
192
193pub struct SettingsUiFeatureFlag;
194
195impl FeatureFlag for SettingsUiFeatureFlag {
196 const NAME: &'static str = "settings-ui";
197}
198
199pub fn init(cx: &mut App) {
200 init_renderers(cx);
201
202 cx.observe_new(|workspace: &mut workspace::Workspace, _, _| {
203 workspace.register_action_renderer(|div, _, _, cx| {
204 let settings_ui_actions = [
205 TypeId::of::<OpenSettingsEditor>(),
206 TypeId::of::<ToggleFocusNav>(),
207 TypeId::of::<FocusFile>(),
208 TypeId::of::<FocusNextFile>(),
209 TypeId::of::<FocusPreviousFile>(),
210 ];
211 let has_flag = cx.has_flag::<SettingsUiFeatureFlag>();
212 command_palette_hooks::CommandPaletteFilter::update_global(cx, |filter, _| {
213 if has_flag {
214 filter.show_action_types(&settings_ui_actions);
215 } else {
216 filter.hide_action_types(&settings_ui_actions);
217 }
218 });
219 if has_flag {
220 div.on_action(cx.listener(|_, _: &OpenSettingsEditor, _, cx| {
221 open_settings_editor(cx).ok();
222 }))
223 } else {
224 div
225 }
226 });
227 })
228 .detach();
229}
230
231fn init_renderers(cx: &mut App) {
232 // fn (field: SettingsField, current_file: SettingsFile, cx) -> (currently_set_in: SettingsFile, overridden_in: Vec<SettingsFile>)
233 cx.default_global::<SettingFieldRenderer>()
234 .add_renderer::<UnimplementedSettingField>(|_, _, _, _, _| {
235 // TODO(settings_ui): In non-dev builds (`#[cfg(not(debug_assertions))]`) make this render as edit-in-json
236 Button::new("unimplemented-field", "UNIMPLEMENTED")
237 .size(ButtonSize::Medium)
238 .icon(IconName::XCircle)
239 .icon_position(IconPosition::Start)
240 .icon_color(Color::Error)
241 .icon_size(IconSize::Small)
242 .style(ButtonStyle::Outlined)
243 .into_any_element()
244 })
245 .add_renderer::<bool>(|settings_field, file, _, _, cx| {
246 render_toggle_button(*settings_field, file, cx).into_any_element()
247 })
248 .add_renderer::<String>(|settings_field, file, metadata, _, cx| {
249 render_text_field(settings_field.clone(), file, metadata, cx)
250 })
251 .add_renderer::<SaturatingBool>(|settings_field, file, _, _, cx| {
252 render_toggle_button(*settings_field, file, cx)
253 })
254 .add_renderer::<CursorShape>(|settings_field, file, _, window, cx| {
255 render_dropdown(*settings_field, file, window, cx)
256 })
257 .add_renderer::<RestoreOnStartupBehavior>(|settings_field, file, _, window, cx| {
258 render_dropdown(*settings_field, file, window, cx)
259 })
260 .add_renderer::<BottomDockLayout>(|settings_field, file, _, window, cx| {
261 render_dropdown(*settings_field, file, window, cx)
262 })
263 .add_renderer::<OnLastWindowClosed>(|settings_field, file, _, window, cx| {
264 render_dropdown(*settings_field, file, window, cx)
265 })
266 .add_renderer::<CloseWindowWhenNoItems>(|settings_field, file, _, window, cx| {
267 render_dropdown(*settings_field, file, window, cx)
268 })
269 .add_renderer::<settings::FontFamilyName>(|settings_field, file, _, window, cx| {
270 // todo(settings_ui): We need to pass in a validator for this to ensure that users that type in invalid font names
271 render_font_picker(settings_field.clone(), file, window, cx)
272 })
273 // todo(settings_ui): This needs custom ui
274 // .add_renderer::<settings::BufferLineHeight>(|settings_field, file, _, window, cx| {
275 // // todo(settings_ui): Do we want to expose the custom variant of buffer line height?
276 // // right now there's a manual impl of strum::VariantArray
277 // render_dropdown(*settings_field, file, window, cx)
278 // })
279 .add_renderer::<settings::BaseKeymapContent>(|settings_field, file, _, window, cx| {
280 render_dropdown(*settings_field, file, window, cx)
281 })
282 .add_renderer::<settings::MultiCursorModifier>(|settings_field, file, _, window, cx| {
283 render_dropdown(*settings_field, file, window, cx)
284 })
285 .add_renderer::<settings::HideMouseMode>(|settings_field, file, _, window, cx| {
286 render_dropdown(*settings_field, file, window, cx)
287 })
288 .add_renderer::<settings::CurrentLineHighlight>(|settings_field, file, _, window, cx| {
289 render_dropdown(*settings_field, file, window, cx)
290 })
291 .add_renderer::<settings::ShowWhitespaceSetting>(|settings_field, file, _, window, cx| {
292 render_dropdown(*settings_field, file, window, cx)
293 })
294 .add_renderer::<settings::SoftWrap>(|settings_field, file, _, window, cx| {
295 render_dropdown(*settings_field, file, window, cx)
296 })
297 .add_renderer::<settings::ScrollBeyondLastLine>(|settings_field, file, _, window, cx| {
298 render_dropdown(*settings_field, file, window, cx)
299 })
300 .add_renderer::<settings::SnippetSortOrder>(|settings_field, file, _, window, cx| {
301 render_dropdown(*settings_field, file, window, cx)
302 })
303 .add_renderer::<settings::ClosePosition>(|settings_field, file, _, window, cx| {
304 render_dropdown(*settings_field, file, window, cx)
305 })
306 .add_renderer::<settings::DockSide>(|settings_field, file, _, window, cx| {
307 render_dropdown(*settings_field, file, window, cx)
308 })
309 .add_renderer::<settings::TerminalDockPosition>(|settings_field, file, _, window, cx| {
310 render_dropdown(*settings_field, file, window, cx)
311 })
312 .add_renderer::<settings::DockPosition>(|settings_field, file, _, window, cx| {
313 render_dropdown(*settings_field, file, window, cx)
314 })
315 .add_renderer::<settings::GitGutterSetting>(|settings_field, file, _, window, cx| {
316 render_dropdown(*settings_field, file, window, cx)
317 })
318 .add_renderer::<settings::GitHunkStyleSetting>(|settings_field, file, _, window, cx| {
319 render_dropdown(*settings_field, file, window, cx)
320 })
321 .add_renderer::<settings::DiagnosticSeverityContent>(
322 |settings_field, file, _, window, cx| {
323 render_dropdown(*settings_field, file, window, cx)
324 },
325 )
326 .add_renderer::<settings::SeedQuerySetting>(|settings_field, file, _, window, cx| {
327 render_dropdown(*settings_field, file, window, cx)
328 })
329 .add_renderer::<settings::DoubleClickInMultibuffer>(
330 |settings_field, file, _, window, cx| {
331 render_dropdown(*settings_field, file, window, cx)
332 },
333 )
334 .add_renderer::<settings::GoToDefinitionFallback>(|settings_field, file, _, window, cx| {
335 render_dropdown(*settings_field, file, window, cx)
336 })
337 .add_renderer::<settings::ActivateOnClose>(|settings_field, file, _, window, cx| {
338 render_dropdown(*settings_field, file, window, cx)
339 })
340 .add_renderer::<settings::ShowDiagnostics>(|settings_field, file, _, window, cx| {
341 render_dropdown(*settings_field, file, window, cx)
342 })
343 .add_renderer::<settings::ShowCloseButton>(|settings_field, file, _, window, cx| {
344 render_dropdown(*settings_field, file, window, cx)
345 })
346 .add_renderer::<settings::ProjectPanelEntrySpacing>(
347 |settings_field, file, _, window, cx| {
348 render_dropdown(*settings_field, file, window, cx)
349 },
350 )
351 .add_renderer::<settings::RewrapBehavior>(|settings_field, file, _, window, cx| {
352 render_dropdown(*settings_field, file, window, cx)
353 })
354 .add_renderer::<settings::FormatOnSave>(|settings_field, file, _, window, cx| {
355 render_dropdown(*settings_field, file, window, cx)
356 })
357 .add_renderer::<settings::IndentGuideColoring>(|settings_field, file, _, window, cx| {
358 render_dropdown(*settings_field, file, window, cx)
359 })
360 .add_renderer::<settings::IndentGuideBackgroundColoring>(
361 |settings_field, file, _, window, cx| {
362 render_dropdown(*settings_field, file, window, cx)
363 },
364 )
365 .add_renderer::<settings::FileFinderWidthContent>(|settings_field, file, _, window, cx| {
366 render_dropdown(*settings_field, file, window, cx)
367 })
368 .add_renderer::<settings::ShowDiagnostics>(|settings_field, file, _, window, cx| {
369 render_dropdown(*settings_field, file, window, cx)
370 })
371 .add_renderer::<settings::WordsCompletionMode>(|settings_field, file, _, window, cx| {
372 render_dropdown(*settings_field, file, window, cx)
373 })
374 .add_renderer::<settings::LspInsertMode>(|settings_field, file, _, window, cx| {
375 render_dropdown(*settings_field, file, window, cx)
376 })
377 .add_renderer::<f32>(|settings_field, file, _, window, cx| {
378 render_numeric_stepper(*settings_field, file, window, cx)
379 })
380 .add_renderer::<u32>(|settings_field, file, _, window, cx| {
381 render_numeric_stepper(*settings_field, file, window, cx)
382 })
383 .add_renderer::<u64>(|settings_field, file, _, window, cx| {
384 render_numeric_stepper(*settings_field, file, window, cx)
385 })
386 .add_renderer::<usize>(|settings_field, file, _, window, cx| {
387 render_numeric_stepper(*settings_field, file, window, cx)
388 })
389 .add_renderer::<NonZero<usize>>(|settings_field, file, _, window, cx| {
390 render_numeric_stepper(*settings_field, file, window, cx)
391 })
392 .add_renderer::<NonZeroU32>(|settings_field, file, _, window, cx| {
393 render_numeric_stepper(*settings_field, file, window, cx)
394 })
395 .add_renderer::<CodeFade>(|settings_field, file, _, window, cx| {
396 render_numeric_stepper(*settings_field, file, window, cx)
397 })
398 .add_renderer::<FontWeight>(|settings_field, file, _, window, cx| {
399 render_numeric_stepper(*settings_field, file, window, cx)
400 })
401 .add_renderer::<settings::MinimumContrast>(|settings_field, file, _, window, cx| {
402 render_numeric_stepper(*settings_field, file, window, cx)
403 })
404 .add_renderer::<settings::ShowScrollbar>(|settings_field, file, _, window, cx| {
405 render_dropdown(*settings_field, file, window, cx)
406 })
407 .add_renderer::<settings::ScrollbarDiagnostics>(|settings_field, file, _, window, cx| {
408 render_dropdown(*settings_field, file, window, cx)
409 })
410 .add_renderer::<settings::ShowMinimap>(|settings_field, file, _, window, cx| {
411 render_dropdown(*settings_field, file, window, cx)
412 })
413 .add_renderer::<settings::DisplayIn>(|settings_field, file, _, window, cx| {
414 render_dropdown(*settings_field, file, window, cx)
415 })
416 .add_renderer::<settings::MinimapThumb>(|settings_field, file, _, window, cx| {
417 render_dropdown(*settings_field, file, window, cx)
418 })
419 .add_renderer::<settings::MinimapThumbBorder>(|settings_field, file, _, window, cx| {
420 render_dropdown(*settings_field, file, window, cx)
421 })
422 .add_renderer::<settings::SteppingGranularity>(|settings_field, file, _, window, cx| {
423 render_dropdown(*settings_field, file, window, cx)
424 });
425
426 // todo(settings_ui): Figure out how we want to handle discriminant unions
427 // .add_renderer::<ThemeSelection>(|settings_field, file, _, window, cx| {
428 // render_dropdown(*settings_field, file, window, cx)
429 // });
430}
431
432pub fn open_settings_editor(cx: &mut App) -> anyhow::Result<WindowHandle<SettingsWindow>> {
433 cx.open_window(
434 WindowOptions {
435 titlebar: Some(TitlebarOptions {
436 title: Some("Settings Window".into()),
437 appears_transparent: true,
438 traffic_light_position: Some(point(px(12.0), px(12.0))),
439 }),
440 focus: true,
441 show: true,
442 kind: gpui::WindowKind::Normal,
443 window_background: cx.theme().window_background_appearance(),
444 window_min_size: Some(size(px(800.), px(600.))), // 4:3 Aspect Ratio
445 ..Default::default()
446 },
447 |window, cx| cx.new(|cx| SettingsWindow::new(window, cx)),
448 )
449}
450
451/// The current sub page path that is selected.
452/// If this is empty the selected page is rendered,
453/// otherwise the last sub page gets rendered.
454///
455/// Global so that `pick` and `pick_mut` callbacks can access it
456/// and use it to dynamically render sub pages (e.g. for language settings)
457static SUB_PAGE_STACK: LazyLock<RwLock<Vec<SubPage>>> = LazyLock::new(|| RwLock::new(Vec::new()));
458
459fn sub_page_stack() -> std::sync::RwLockReadGuard<'static, Vec<SubPage>> {
460 SUB_PAGE_STACK
461 .read()
462 .expect("SUB_PAGE_STACK is never poisoned")
463}
464
465fn sub_page_stack_mut() -> std::sync::RwLockWriteGuard<'static, Vec<SubPage>> {
466 SUB_PAGE_STACK
467 .write()
468 .expect("SUB_PAGE_STACK is never poisoned")
469}
470
471pub struct SettingsWindow {
472 files: Vec<(SettingsUiFile, FocusHandle)>,
473 current_file: SettingsUiFile,
474 pages: Vec<SettingsPage>,
475 search_bar: Entity<Editor>,
476 search_task: Option<Task<()>>,
477 navbar_entry: usize, // Index into pages - should probably be (usize, Option<usize>) for section + page
478 navbar_entries: Vec<NavBarEntry>,
479 list_handle: UniformListScrollHandle,
480 search_matches: Vec<Vec<bool>>,
481 scroll_handle: ScrollHandle,
482 navbar_focus_handle: FocusHandle,
483 content_focus_handle: FocusHandle,
484 files_focus_handle: FocusHandle,
485}
486
487struct SubPage {
488 link: SubPageLink,
489 section_header: &'static str,
490}
491
492#[derive(PartialEq, Debug)]
493struct NavBarEntry {
494 title: &'static str,
495 is_root: bool,
496 expanded: bool,
497 page_index: usize,
498 item_index: Option<usize>,
499}
500
501struct SettingsPage {
502 title: &'static str,
503 items: Vec<SettingsPageItem>,
504}
505
506#[derive(PartialEq)]
507enum SettingsPageItem {
508 SectionHeader(&'static str),
509 SettingItem(SettingItem),
510 SubPageLink(SubPageLink),
511}
512
513impl std::fmt::Debug for SettingsPageItem {
514 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
515 match self {
516 SettingsPageItem::SectionHeader(header) => write!(f, "SectionHeader({})", header),
517 SettingsPageItem::SettingItem(setting_item) => {
518 write!(f, "SettingItem({})", setting_item.title)
519 }
520 SettingsPageItem::SubPageLink(sub_page_link) => {
521 write!(f, "SubPageLink({})", sub_page_link.title)
522 }
523 }
524 }
525}
526
527impl SettingsPageItem {
528 fn render(
529 &self,
530 file: SettingsUiFile,
531 section_header: &'static str,
532 is_last: bool,
533 window: &mut Window,
534 cx: &mut Context<SettingsWindow>,
535 ) -> AnyElement {
536 match self {
537 SettingsPageItem::SectionHeader(header) => v_flex()
538 .w_full()
539 .gap_1()
540 .child(
541 Label::new(SharedString::new_static(header))
542 .size(LabelSize::XSmall)
543 .color(Color::Muted)
544 .buffer_font(cx),
545 )
546 .child(Divider::horizontal().color(ui::DividerColor::BorderVariant))
547 .into_any_element(),
548 SettingsPageItem::SettingItem(setting_item) => {
549 let renderer = cx.default_global::<SettingFieldRenderer>().clone();
550 let (found_in_file, found) = setting_item.field.file_set_in(file.clone(), cx);
551 let file_set_in = SettingsUiFile::from_settings(found_in_file);
552
553 h_flex()
554 .id(setting_item.title)
555 .w_full()
556 .gap_2()
557 .flex_wrap()
558 .justify_between()
559 .map(|this| {
560 if is_last {
561 this.pb_6()
562 } else {
563 this.pb_4()
564 .border_b_1()
565 .border_color(cx.theme().colors().border_variant)
566 }
567 })
568 .child(
569 v_flex()
570 .max_w_1_2()
571 .flex_shrink()
572 .child(
573 h_flex()
574 .w_full()
575 .gap_1()
576 .child(Label::new(SharedString::new_static(setting_item.title)))
577 .when_some(
578 file_set_in.filter(|file_set_in| file_set_in != &file),
579 |this, file_set_in| {
580 this.child(
581 Label::new(format!(
582 "— set in {}",
583 file_set_in.name()
584 ))
585 .color(Color::Muted)
586 .size(LabelSize::Small),
587 )
588 },
589 ),
590 )
591 .child(
592 Label::new(SharedString::new_static(setting_item.description))
593 .size(LabelSize::Small)
594 .color(Color::Muted),
595 ),
596 )
597 .child(if cfg!(debug_assertions) && !found {
598 Button::new("no-default-field", "NO DEFAULT")
599 .size(ButtonSize::Medium)
600 .icon(IconName::XCircle)
601 .icon_position(IconPosition::Start)
602 .icon_color(Color::Error)
603 .icon_size(IconSize::Small)
604 .style(ButtonStyle::Outlined)
605 .into_any_element()
606 } else {
607 renderer.render(
608 setting_item.field.as_ref(),
609 file,
610 setting_item.metadata.as_deref(),
611 window,
612 cx,
613 )
614 })
615 .into_any_element()
616 }
617 SettingsPageItem::SubPageLink(sub_page_link) => h_flex()
618 .id(sub_page_link.title)
619 .w_full()
620 .gap_2()
621 .flex_wrap()
622 .justify_between()
623 .when(!is_last, |this| {
624 this.pb_4()
625 .border_b_1()
626 .border_color(cx.theme().colors().border_variant)
627 })
628 .child(
629 v_flex()
630 .max_w_1_2()
631 .flex_shrink()
632 .child(Label::new(SharedString::new_static(sub_page_link.title))),
633 )
634 .child(
635 Button::new(("sub-page".into(), sub_page_link.title), "Configure")
636 .size(ButtonSize::Medium)
637 .icon(IconName::ChevronRight)
638 .icon_position(IconPosition::End)
639 .icon_color(Color::Muted)
640 .icon_size(IconSize::Small)
641 .style(ButtonStyle::Outlined),
642 )
643 .on_click({
644 let sub_page_link = sub_page_link.clone();
645 cx.listener(move |this, _, _, cx| {
646 this.push_sub_page(sub_page_link.clone(), section_header, cx)
647 })
648 })
649 .into_any_element(),
650 }
651 }
652}
653
654struct SettingItem {
655 title: &'static str,
656 description: &'static str,
657 field: Box<dyn AnySettingField>,
658 metadata: Option<Box<SettingsFieldMetadata>>,
659}
660
661impl PartialEq for SettingItem {
662 fn eq(&self, other: &Self) -> bool {
663 self.title == other.title
664 && self.description == other.description
665 && (match (&self.metadata, &other.metadata) {
666 (None, None) => true,
667 (Some(m1), Some(m2)) => m1.placeholder == m2.placeholder,
668 _ => false,
669 })
670 }
671}
672
673#[derive(Clone)]
674struct SubPageLink {
675 title: &'static str,
676 render: Arc<
677 dyn Fn(&mut SettingsWindow, &mut Window, &mut Context<SettingsWindow>) -> AnyElement
678 + 'static
679 + Send
680 + Sync,
681 >,
682}
683
684impl PartialEq for SubPageLink {
685 fn eq(&self, other: &Self) -> bool {
686 self.title == other.title
687 }
688}
689
690#[allow(unused)]
691#[derive(Clone, PartialEq)]
692enum SettingsUiFile {
693 User, // Uses all settings.
694 Local((WorktreeId, Arc<RelPath>)), // Has a special name, and special set of settings
695 Server(&'static str), // Uses a special name, and the user settings
696}
697
698impl SettingsUiFile {
699 fn pages(&self) -> Vec<SettingsPage> {
700 match self {
701 SettingsUiFile::User => page_data::user_settings_data(),
702 SettingsUiFile::Local(_) => page_data::project_settings_data(),
703 SettingsUiFile::Server(_) => page_data::user_settings_data(),
704 }
705 }
706
707 fn name(&self) -> SharedString {
708 match self {
709 SettingsUiFile::User => SharedString::new_static("User"),
710 // TODO is PathStyle::local() ever not appropriate?
711 SettingsUiFile::Local((_, path)) => {
712 format!("Local ({})", path.display(PathStyle::local())).into()
713 }
714 SettingsUiFile::Server(file) => format!("Server ({})", file).into(),
715 }
716 }
717
718 fn from_settings(file: settings::SettingsFile) -> Option<Self> {
719 Some(match file {
720 settings::SettingsFile::User => SettingsUiFile::User,
721 settings::SettingsFile::Local(location) => SettingsUiFile::Local(location),
722 settings::SettingsFile::Server => SettingsUiFile::Server("todo: server name"),
723 settings::SettingsFile::Default => return None,
724 })
725 }
726
727 fn to_settings(&self) -> settings::SettingsFile {
728 match self {
729 SettingsUiFile::User => settings::SettingsFile::User,
730 SettingsUiFile::Local(location) => settings::SettingsFile::Local(location.clone()),
731 SettingsUiFile::Server(_) => settings::SettingsFile::Server,
732 }
733 }
734}
735
736impl SettingsWindow {
737 pub fn new(window: &mut Window, cx: &mut Context<Self>) -> Self {
738 let font_family_cache = theme::FontFamilyCache::global(cx);
739
740 cx.spawn(async move |this, cx| {
741 font_family_cache.prefetch(cx).await;
742 this.update(cx, |_, cx| {
743 cx.notify();
744 })
745 })
746 .detach();
747
748 let current_file = SettingsUiFile::User;
749 let search_bar = cx.new(|cx| {
750 let mut editor = Editor::single_line(window, cx);
751 editor.set_placeholder_text("Search settings…", window, cx);
752 editor
753 });
754
755 cx.subscribe(&search_bar, |this, _, event: &EditorEvent, cx| {
756 let EditorEvent::Edited { transaction_id: _ } = event else {
757 return;
758 };
759
760 this.update_matches(cx);
761 })
762 .detach();
763
764 cx.observe_global_in::<SettingsStore>(window, move |this, _, cx| {
765 this.fetch_files(cx);
766 cx.notify();
767 })
768 .detach();
769
770 let mut this = Self {
771 files: vec![],
772 current_file: current_file,
773 pages: vec![],
774 navbar_entries: vec![],
775 navbar_entry: 0,
776 list_handle: UniformListScrollHandle::default(),
777 search_bar,
778 search_task: None,
779 search_matches: vec![],
780 scroll_handle: ScrollHandle::new(),
781 navbar_focus_handle: cx
782 .focus_handle()
783 .tab_index(NAVBAR_CONTAINER_TAB_INDEX)
784 .tab_stop(false),
785 content_focus_handle: cx
786 .focus_handle()
787 .tab_index(CONTENT_CONTAINER_TAB_INDEX)
788 .tab_stop(false),
789 files_focus_handle: cx.focus_handle().tab_stop(false),
790 };
791
792 this.fetch_files(cx);
793 this.build_ui(cx);
794
795 this.search_bar.update(cx, |editor, cx| {
796 editor.focus_handle(cx).focus(window);
797 });
798
799 this
800 }
801
802 fn toggle_navbar_entry(&mut self, ix: usize) {
803 // We can only toggle root entries
804 if !self.navbar_entries[ix].is_root {
805 return;
806 }
807
808 let toggle_page_index = self.page_index_from_navbar_index(ix);
809 let selected_page_index = self.page_index_from_navbar_index(self.navbar_entry);
810
811 let expanded = &mut self.navbar_entries[ix].expanded;
812 *expanded = !*expanded;
813 // if currently selected page is a child of the parent page we are folding,
814 // set the current page to the parent page
815 if !*expanded && selected_page_index == toggle_page_index {
816 self.navbar_entry = ix;
817 }
818 }
819
820 fn build_navbar(&mut self) {
821 let mut navbar_entries = Vec::with_capacity(self.navbar_entries.len());
822 for (page_index, page) in self.pages.iter().enumerate() {
823 navbar_entries.push(NavBarEntry {
824 title: page.title,
825 is_root: true,
826 expanded: false,
827 page_index,
828 item_index: None,
829 });
830
831 for (item_index, item) in page.items.iter().enumerate() {
832 let SettingsPageItem::SectionHeader(title) = item else {
833 continue;
834 };
835 navbar_entries.push(NavBarEntry {
836 title,
837 is_root: false,
838 expanded: false,
839 page_index,
840 item_index: Some(item_index),
841 });
842 }
843 }
844 self.navbar_entries = navbar_entries;
845 }
846
847 fn visible_navbar_entries(&self) -> impl Iterator<Item = (usize, &NavBarEntry)> {
848 let mut index = 0;
849 let entries = &self.navbar_entries;
850 let search_matches = &self.search_matches;
851 std::iter::from_fn(move || {
852 while index < entries.len() {
853 let entry = &entries[index];
854 let included_in_search = if let Some(item_index) = entry.item_index {
855 search_matches[entry.page_index][item_index]
856 } else {
857 search_matches[entry.page_index].iter().any(|b| *b)
858 || search_matches[entry.page_index].is_empty()
859 };
860 if included_in_search {
861 break;
862 }
863 index += 1;
864 }
865 if index >= self.navbar_entries.len() {
866 return None;
867 }
868 let entry = &entries[index];
869 let entry_index = index;
870
871 index += 1;
872 if entry.is_root && !entry.expanded {
873 while index < entries.len() {
874 if entries[index].is_root {
875 break;
876 }
877 index += 1;
878 }
879 }
880
881 return Some((entry_index, entry));
882 })
883 }
884
885 fn update_matches(&mut self, cx: &mut Context<SettingsWindow>) {
886 self.search_task.take();
887 let query = self.search_bar.read(cx).text(cx);
888 if query.is_empty() {
889 for page in &mut self.search_matches {
890 page.fill(true);
891 }
892 cx.notify();
893 return;
894 }
895
896 struct ItemKey {
897 page_index: usize,
898 header_index: usize,
899 item_index: usize,
900 }
901 let mut key_lut: Vec<ItemKey> = vec![];
902 let mut candidates = Vec::default();
903
904 for (page_index, page) in self.pages.iter().enumerate() {
905 let mut header_index = 0;
906 for (item_index, item) in page.items.iter().enumerate() {
907 let key_index = key_lut.len();
908 match item {
909 SettingsPageItem::SettingItem(item) => {
910 candidates.push(StringMatchCandidate::new(key_index, item.title));
911 candidates.push(StringMatchCandidate::new(key_index, item.description));
912 }
913 SettingsPageItem::SectionHeader(header) => {
914 candidates.push(StringMatchCandidate::new(key_index, header));
915 header_index = item_index;
916 }
917 SettingsPageItem::SubPageLink(sub_page_link) => {
918 candidates.push(StringMatchCandidate::new(key_index, sub_page_link.title));
919 }
920 }
921 key_lut.push(ItemKey {
922 page_index,
923 header_index,
924 item_index,
925 });
926 }
927 }
928 let atomic_bool = AtomicBool::new(false);
929
930 self.search_task = Some(cx.spawn(async move |this, cx| {
931 let string_matches = fuzzy::match_strings(
932 candidates.as_slice(),
933 &query,
934 false,
935 true,
936 candidates.len(),
937 &atomic_bool,
938 cx.background_executor().clone(),
939 );
940 let string_matches = string_matches.await;
941
942 this.update(cx, |this, cx| {
943 for page in &mut this.search_matches {
944 page.fill(false);
945 }
946
947 for string_match in string_matches {
948 let ItemKey {
949 page_index,
950 header_index,
951 item_index,
952 } = key_lut[string_match.candidate_id];
953 let page = &mut this.search_matches[page_index];
954 page[header_index] = true;
955 page[item_index] = true;
956 }
957 let first_navbar_entry_index = this
958 .visible_navbar_entries()
959 .next()
960 .map(|e| e.0)
961 .unwrap_or(0);
962 this.navbar_entry = first_navbar_entry_index;
963 cx.notify();
964 })
965 .ok();
966 }));
967 }
968
969 fn build_search_matches(&mut self) {
970 self.search_matches = self
971 .pages
972 .iter()
973 .map(|page| vec![true; page.items.len()])
974 .collect::<Vec<_>>();
975 }
976
977 fn build_ui(&mut self, cx: &mut Context<SettingsWindow>) {
978 self.pages = self.current_file.pages();
979 self.build_search_matches();
980 self.build_navbar();
981
982 if !self.search_bar.read(cx).is_empty(cx) {
983 self.update_matches(cx);
984 }
985
986 cx.notify();
987 }
988
989 fn calculate_navbar_entry_from_scroll_position(&mut self) {
990 let top = self.scroll_handle.top_item();
991 let bottom = self.scroll_handle.bottom_item();
992
993 let scroll_index = (top + bottom) / 2;
994 let scroll_index = scroll_index.clamp(top, bottom);
995 let mut page_index = self.navbar_entry;
996
997 while !self.navbar_entries[page_index].is_root {
998 page_index -= 1;
999 }
1000
1001 if self.navbar_entries[page_index].expanded {
1002 let section_index = self
1003 .page_items()
1004 .take(scroll_index + 1)
1005 .filter(|item| matches!(item, SettingsPageItem::SectionHeader(_)))
1006 .count();
1007
1008 self.navbar_entry = section_index + page_index;
1009 }
1010 }
1011
1012 fn fetch_files(&mut self, cx: &mut Context<SettingsWindow>) {
1013 let prev_files = self.files.clone();
1014 let settings_store = cx.global::<SettingsStore>();
1015 let mut ui_files = vec![];
1016 let all_files = settings_store.get_all_files();
1017 for file in all_files {
1018 let Some(settings_ui_file) = SettingsUiFile::from_settings(file) else {
1019 continue;
1020 };
1021 let focus_handle = prev_files
1022 .iter()
1023 .find_map(|(prev_file, handle)| {
1024 (prev_file == &settings_ui_file).then(|| handle.clone())
1025 })
1026 .unwrap_or_else(|| cx.focus_handle());
1027 ui_files.push((settings_ui_file, focus_handle));
1028 }
1029 ui_files.reverse();
1030 self.files = ui_files;
1031 let current_file_still_exists = self
1032 .files
1033 .iter()
1034 .any(|(file, _)| file == &self.current_file);
1035 if !current_file_still_exists {
1036 self.change_file(0, cx);
1037 }
1038 }
1039
1040 fn change_file(&mut self, ix: usize, cx: &mut Context<SettingsWindow>) {
1041 if ix >= self.files.len() {
1042 self.current_file = SettingsUiFile::User;
1043 return;
1044 }
1045 if self.files[ix].0 == self.current_file {
1046 return;
1047 }
1048 self.current_file = self.files[ix].0.clone();
1049 self.navbar_entry = 0;
1050 self.build_ui(cx);
1051 }
1052
1053 fn render_files(&self, _window: &mut Window, cx: &mut Context<SettingsWindow>) -> Div {
1054 h_flex().gap_1().children(self.files.iter().enumerate().map(
1055 |(ix, (file, focus_handle))| {
1056 Button::new(ix, file.name())
1057 .toggle_state(file == &self.current_file)
1058 .selected_style(ButtonStyle::Tinted(ui::TintColor::Accent))
1059 .track_focus(focus_handle)
1060 .on_click(
1061 cx.listener(move |this, evt: &gpui::ClickEvent, window, cx| {
1062 this.change_file(ix, cx);
1063 if evt.is_keyboard() {
1064 this.focus_first_nav_item(window, cx);
1065 }
1066 }),
1067 )
1068 },
1069 ))
1070 }
1071
1072 fn render_search(&self, _window: &mut Window, cx: &mut App) -> Div {
1073 h_flex()
1074 .py_1()
1075 .px_1p5()
1076 .gap_1p5()
1077 .rounded_sm()
1078 .bg(cx.theme().colors().editor_background)
1079 .border_1()
1080 .border_color(cx.theme().colors().border)
1081 .child(Icon::new(IconName::MagnifyingGlass).color(Color::Muted))
1082 .child(self.search_bar.clone())
1083 }
1084
1085 fn render_nav(
1086 &self,
1087 window: &mut Window,
1088 cx: &mut Context<SettingsWindow>,
1089 ) -> impl IntoElement {
1090 let visible_count = self.visible_navbar_entries().count();
1091 let nav_background = cx.theme().colors().panel_background;
1092
1093 v_flex()
1094 .w_64()
1095 .p_2p5()
1096 .pt_10()
1097 .gap_3()
1098 .flex_none()
1099 .border_r_1()
1100 .border_color(cx.theme().colors().border)
1101 .bg(nav_background)
1102 .child(self.render_search(window, cx))
1103 .child(
1104 v_flex()
1105 .flex_grow()
1106 .track_focus(&self.navbar_focus_handle)
1107 .tab_group()
1108 .tab_index(NAVBAR_GROUP_TAB_INDEX)
1109 .child(
1110 uniform_list(
1111 "settings-ui-nav-bar",
1112 visible_count,
1113 cx.processor(move |this, range: Range<usize>, _, cx| {
1114 let entries: Vec<_> = this.visible_navbar_entries().collect();
1115 range
1116 .filter_map(|ix| entries.get(ix).copied())
1117 .map(|(ix, entry)| {
1118 TreeViewItem::new(
1119 ("settings-ui-navbar-entry", ix),
1120 entry.title,
1121 )
1122 .tab_index(0)
1123 .root_item(entry.is_root)
1124 .toggle_state(this.is_navbar_entry_selected(ix))
1125 .when(entry.is_root, |item| {
1126 item.expanded(entry.expanded).on_toggle(cx.listener(
1127 move |this, _, _, cx| {
1128 this.toggle_navbar_entry(ix);
1129 cx.notify();
1130 },
1131 ))
1132 })
1133 .on_click(cx.listener(
1134 move |this, evt: &gpui::ClickEvent, window, cx| {
1135 this.navbar_entry = ix;
1136
1137 if !this.navbar_entries[ix].is_root {
1138 let mut selected_page_ix = ix;
1139
1140 while !this.navbar_entries[selected_page_ix]
1141 .is_root
1142 {
1143 selected_page_ix -= 1;
1144 }
1145
1146 let section_header = ix - selected_page_ix;
1147
1148 if let Some(section_index) = this
1149 .page_items()
1150 .enumerate()
1151 .filter(|item| {
1152 matches!(
1153 item.1,
1154 SettingsPageItem::SectionHeader(_)
1155 )
1156 })
1157 .take(section_header)
1158 .last()
1159 .map(|pair| pair.0)
1160 {
1161 this.scroll_handle
1162 .scroll_to_top_of_item(section_index);
1163 }
1164 }
1165
1166 if evt.is_keyboard() {
1167 // todo(settings_ui): Focus the actual item and scroll to it
1168 this.focus_first_content_item(window, cx);
1169 }
1170 cx.notify();
1171 },
1172 ))
1173 .into_any_element()
1174 })
1175 .collect()
1176 }),
1177 )
1178 .track_scroll(self.list_handle.clone())
1179 .flex_grow(),
1180 )
1181 .vertical_scrollbar_for(self.list_handle.clone(), window, cx),
1182 )
1183 .child(
1184 h_flex().w_full().justify_center().bg(nav_background).child(
1185 Button::new(
1186 "nav-key-hint",
1187 if self.navbar_focus_handle.contains_focused(window, cx) {
1188 "Focus Content"
1189 } else {
1190 "Focus Navbar"
1191 },
1192 )
1193 .key_binding(ui::KeyBinding::for_action_in(
1194 &ToggleFocusNav,
1195 &self.navbar_focus_handle,
1196 window,
1197 cx,
1198 ))
1199 .key_binding_position(KeybindingPosition::Start),
1200 ),
1201 )
1202 }
1203
1204 fn focus_first_nav_item(&self, window: &mut Window, cx: &mut Context<Self>) {
1205 self.navbar_focus_handle.focus(window);
1206 window.focus_next();
1207 cx.notify();
1208 }
1209
1210 fn focus_first_content_item(&self, window: &mut Window, cx: &mut Context<Self>) {
1211 self.content_focus_handle.focus(window);
1212 window.focus_next();
1213 cx.notify();
1214 }
1215
1216 fn page_items(&self) -> impl Iterator<Item = &SettingsPageItem> {
1217 let page_idx = self.current_page_index();
1218
1219 self.current_page()
1220 .items
1221 .iter()
1222 .enumerate()
1223 .filter_map(move |(item_index, item)| {
1224 self.search_matches[page_idx][item_index].then_some(item)
1225 })
1226 }
1227
1228 fn render_sub_page_breadcrumbs(&self) -> impl IntoElement {
1229 let mut items = vec![];
1230 items.push(self.current_page().title);
1231 items.extend(
1232 sub_page_stack()
1233 .iter()
1234 .flat_map(|page| [page.section_header, page.link.title]),
1235 );
1236
1237 let last = items.pop().unwrap();
1238 h_flex()
1239 .gap_1()
1240 .children(
1241 items
1242 .into_iter()
1243 .flat_map(|item| [item, "/"])
1244 .map(|item| Label::new(item).color(Color::Muted)),
1245 )
1246 .child(Label::new(last))
1247 }
1248
1249 fn render_page_items<'a, Items: Iterator<Item = &'a SettingsPageItem>>(
1250 &self,
1251 items: Items,
1252 window: &mut Window,
1253 cx: &mut Context<SettingsWindow>,
1254 ) -> impl IntoElement {
1255 let mut page_content = v_flex()
1256 .id("settings-ui-page")
1257 .size_full()
1258 .gap_4()
1259 .overflow_y_scroll()
1260 .track_scroll(&self.scroll_handle);
1261
1262 let items: Vec<_> = items.collect();
1263 let items_len = items.len();
1264 let mut section_header = None;
1265
1266 let has_active_search = !self.search_bar.read(cx).is_empty(cx);
1267 let has_no_results = items_len == 0 && has_active_search;
1268
1269 if has_no_results {
1270 let search_query = self.search_bar.read(cx).text(cx);
1271 page_content = page_content.child(
1272 v_flex()
1273 .size_full()
1274 .items_center()
1275 .justify_center()
1276 .gap_1()
1277 .child(div().child("No Results"))
1278 .child(
1279 div()
1280 .text_sm()
1281 .text_color(cx.theme().colors().text_muted)
1282 .child(format!("No settings match \"{}\"", search_query)),
1283 ),
1284 )
1285 } else {
1286 let last_non_header_index = items
1287 .iter()
1288 .enumerate()
1289 .rev()
1290 .find(|(_, item)| !matches!(item, SettingsPageItem::SectionHeader(_)))
1291 .map(|(index, _)| index);
1292
1293 page_content =
1294 page_content.children(items.clone().into_iter().enumerate().map(|(index, item)| {
1295 let no_bottom_border = items
1296 .get(index + 1)
1297 .map(|next_item| matches!(next_item, SettingsPageItem::SectionHeader(_)))
1298 .unwrap_or(false);
1299 let is_last = Some(index) == last_non_header_index;
1300
1301 if let SettingsPageItem::SectionHeader(header) = item {
1302 section_header = Some(*header);
1303 }
1304 item.render(
1305 self.current_file.clone(),
1306 section_header.expect("All items rendered after a section header"),
1307 no_bottom_border || is_last,
1308 window,
1309 cx,
1310 )
1311 }))
1312 }
1313 page_content
1314 }
1315
1316 fn render_page(
1317 &mut self,
1318 window: &mut Window,
1319 cx: &mut Context<SettingsWindow>,
1320 ) -> impl IntoElement {
1321 let page_header;
1322 let page_content;
1323
1324 if sub_page_stack().len() == 0 {
1325 page_header = self.render_files(window, cx);
1326 page_content = self
1327 .render_page_items(self.page_items(), window, cx)
1328 .into_any_element();
1329 } else {
1330 page_header = h_flex()
1331 .ml_neg_1p5()
1332 .gap_1()
1333 .child(
1334 IconButton::new("back-btn", IconName::ArrowLeft)
1335 .icon_size(IconSize::Small)
1336 .shape(IconButtonShape::Square)
1337 .on_click(cx.listener(|this, _, _, cx| {
1338 this.pop_sub_page(cx);
1339 })),
1340 )
1341 .child(self.render_sub_page_breadcrumbs());
1342
1343 let active_page_render_fn = sub_page_stack().last().unwrap().link.render.clone();
1344 page_content = (active_page_render_fn)(self, window, cx);
1345 }
1346
1347 return v_flex()
1348 .w_full()
1349 .pt_4()
1350 .pb_6()
1351 .px_6()
1352 .gap_4()
1353 .track_focus(&self.content_focus_handle)
1354 .bg(cx.theme().colors().editor_background)
1355 .vertical_scrollbar_for(self.scroll_handle.clone(), window, cx)
1356 .child(page_header)
1357 .child(
1358 div()
1359 .size_full()
1360 .track_focus(&self.content_focus_handle)
1361 .tab_group()
1362 .tab_index(CONTENT_GROUP_TAB_INDEX)
1363 .child(page_content),
1364 );
1365 }
1366
1367 fn current_page_index(&self) -> usize {
1368 self.page_index_from_navbar_index(self.navbar_entry)
1369 }
1370
1371 fn current_page(&self) -> &SettingsPage {
1372 &self.pages[self.current_page_index()]
1373 }
1374
1375 fn page_index_from_navbar_index(&self, index: usize) -> usize {
1376 if self.navbar_entries.is_empty() {
1377 return 0;
1378 }
1379
1380 self.navbar_entries[index].page_index
1381 }
1382
1383 fn is_navbar_entry_selected(&self, ix: usize) -> bool {
1384 ix == self.navbar_entry
1385 }
1386
1387 fn push_sub_page(
1388 &mut self,
1389 sub_page_link: SubPageLink,
1390 section_header: &'static str,
1391 cx: &mut Context<SettingsWindow>,
1392 ) {
1393 sub_page_stack_mut().push(SubPage {
1394 link: sub_page_link,
1395 section_header,
1396 });
1397 cx.notify();
1398 }
1399
1400 fn pop_sub_page(&mut self, cx: &mut Context<SettingsWindow>) {
1401 sub_page_stack_mut().pop();
1402 cx.notify();
1403 }
1404
1405 fn focus_file_at_index(&mut self, index: usize, window: &mut Window) {
1406 if let Some((_, handle)) = self.files.get(index) {
1407 handle.focus(window);
1408 }
1409 }
1410
1411 fn focused_file_index(&self, window: &Window, cx: &Context<Self>) -> usize {
1412 if self.files_focus_handle.contains_focused(window, cx)
1413 && let Some(index) = self
1414 .files
1415 .iter()
1416 .position(|(_, handle)| handle.is_focused(window))
1417 {
1418 return index;
1419 }
1420 if let Some(current_file_index) = self
1421 .files
1422 .iter()
1423 .position(|(file, _)| file == &self.current_file)
1424 {
1425 return current_file_index;
1426 }
1427 0
1428 }
1429}
1430
1431impl Render for SettingsWindow {
1432 fn render(&mut self, window: &mut Window, cx: &mut Context<Self>) -> impl IntoElement {
1433 let ui_font = theme::setup_ui_font(window, cx);
1434 self.calculate_navbar_entry_from_scroll_position();
1435
1436 div()
1437 .id("settings-window")
1438 .key_context("SettingsWindow")
1439 .flex()
1440 .flex_row()
1441 .size_full()
1442 .font(ui_font)
1443 .bg(cx.theme().colors().background)
1444 .text_color(cx.theme().colors().text)
1445 .on_action(cx.listener(|this, _: &search::FocusSearch, window, cx| {
1446 this.search_bar.focus_handle(cx).focus(window);
1447 }))
1448 .on_action(cx.listener(|this, _: &ToggleFocusNav, window, cx| {
1449 if this.navbar_focus_handle.contains_focused(window, cx) {
1450 this.focus_first_content_item(window, cx);
1451 } else {
1452 this.focus_first_nav_item(window, cx);
1453 }
1454 }))
1455 .on_action(
1456 cx.listener(|this, FocusFile(file_index): &FocusFile, window, _| {
1457 this.focus_file_at_index(*file_index as usize, window);
1458 }),
1459 )
1460 .on_action(cx.listener(|this, _: &FocusNextFile, window, cx| {
1461 let next_index = usize::min(
1462 this.focused_file_index(window, cx) + 1,
1463 this.files.len().saturating_sub(1),
1464 );
1465 this.focus_file_at_index(next_index, window);
1466 }))
1467 .on_action(cx.listener(|this, _: &FocusPreviousFile, window, cx| {
1468 let prev_index = this.focused_file_index(window, cx).saturating_sub(1);
1469 this.focus_file_at_index(prev_index, window);
1470 }))
1471 .on_action(|_: &menu::SelectNext, window, _| {
1472 window.focus_next();
1473 })
1474 .on_action(|_: &menu::SelectPrevious, window, _| {
1475 window.focus_prev();
1476 })
1477 .child(self.render_nav(window, cx))
1478 .child(self.render_page(window, cx))
1479 }
1480}
1481
1482fn update_settings_file(
1483 file: SettingsUiFile,
1484 cx: &mut App,
1485 update: impl 'static + Send + FnOnce(&mut SettingsContent, &App),
1486) -> Result<()> {
1487 match file {
1488 SettingsUiFile::Local((worktree_id, rel_path)) => {
1489 fn all_projects(cx: &App) -> impl Iterator<Item = Entity<project::Project>> {
1490 workspace::AppState::global(cx)
1491 .upgrade()
1492 .map(|app_state| {
1493 app_state
1494 .workspace_store
1495 .read(cx)
1496 .workspaces()
1497 .iter()
1498 .filter_map(|workspace| {
1499 Some(workspace.read(cx).ok()?.project().clone())
1500 })
1501 })
1502 .into_iter()
1503 .flatten()
1504 }
1505 let rel_path = rel_path.join(paths::local_settings_file_relative_path());
1506 let project = all_projects(cx).find(|project| {
1507 project.read_with(cx, |project, cx| {
1508 project.contains_local_settings_file(worktree_id, &rel_path, cx)
1509 })
1510 });
1511 let Some(project) = project else {
1512 anyhow::bail!(
1513 "Could not find worktree containing settings file: {}",
1514 &rel_path.display(PathStyle::local())
1515 );
1516 };
1517 project.update(cx, |project, cx| {
1518 project.update_local_settings_file(worktree_id, rel_path, cx, update);
1519 });
1520 return Ok(());
1521 }
1522 SettingsUiFile::User => {
1523 // todo(settings_ui) error?
1524 SettingsStore::global(cx).update_settings_file(<dyn fs::Fs>::global(cx), update);
1525 Ok(())
1526 }
1527 SettingsUiFile::Server(_) => unimplemented!(),
1528 }
1529}
1530
1531fn render_text_field<T: From<String> + Into<String> + AsRef<str> + Clone>(
1532 field: SettingField<T>,
1533 file: SettingsUiFile,
1534 metadata: Option<&SettingsFieldMetadata>,
1535 cx: &mut App,
1536) -> AnyElement {
1537 let (_, initial_text) =
1538 SettingsStore::global(cx).get_value_from_file(file.to_settings(), field.pick);
1539 let initial_text = initial_text.filter(|s| !s.as_ref().is_empty());
1540
1541 SettingsEditor::new()
1542 .tab_index(0)
1543 .when_some(initial_text, |editor, text| {
1544 editor.with_initial_text(text.as_ref().to_string())
1545 })
1546 .when_some(
1547 metadata.and_then(|metadata| metadata.placeholder),
1548 |editor, placeholder| editor.with_placeholder(placeholder),
1549 )
1550 .on_confirm({
1551 move |new_text, cx| {
1552 update_settings_file(file.clone(), cx, move |settings, _cx| {
1553 *(field.pick_mut)(settings) = new_text.map(Into::into);
1554 })
1555 .log_err(); // todo(settings_ui) don't log err
1556 }
1557 })
1558 .into_any_element()
1559}
1560
1561fn render_toggle_button<B: Into<bool> + From<bool> + Copy>(
1562 field: SettingField<B>,
1563 file: SettingsUiFile,
1564 cx: &mut App,
1565) -> AnyElement {
1566 let (_, value) = SettingsStore::global(cx).get_value_from_file(file.to_settings(), field.pick);
1567
1568 let toggle_state = if value.copied().map_or(false, Into::into) {
1569 ToggleState::Selected
1570 } else {
1571 ToggleState::Unselected
1572 };
1573
1574 Switch::new("toggle_button", toggle_state)
1575 .color(ui::SwitchColor::Accent)
1576 .on_click({
1577 move |state, _window, cx| {
1578 let state = *state == ui::ToggleState::Selected;
1579 update_settings_file(file.clone(), cx, move |settings, _cx| {
1580 *(field.pick_mut)(settings) = Some(state.into());
1581 })
1582 .log_err(); // todo(settings_ui) don't log err
1583 }
1584 })
1585 .tab_index(0_isize)
1586 .color(SwitchColor::Accent)
1587 .into_any_element()
1588}
1589
1590fn render_font_picker(
1591 field: SettingField<settings::FontFamilyName>,
1592 file: SettingsUiFile,
1593 window: &mut Window,
1594 cx: &mut App,
1595) -> AnyElement {
1596 let current_value = SettingsStore::global(cx)
1597 .get_value_from_file(file.to_settings(), field.pick)
1598 .1
1599 .cloned()
1600 .unwrap_or_else(|| SharedString::default().into());
1601
1602 let font_picker = cx.new(|cx| {
1603 ui_input::font_picker(
1604 current_value.clone().into(),
1605 move |font_name, cx| {
1606 update_settings_file(file.clone(), cx, move |settings, _cx| {
1607 *(field.pick_mut)(settings) = Some(font_name.into());
1608 })
1609 .log_err(); // todo(settings_ui) don't log err
1610 },
1611 window,
1612 cx,
1613 )
1614 });
1615
1616 div()
1617 .child(
1618 PopoverMenu::new("font-picker")
1619 .menu(move |_window, _cx| Some(font_picker.clone()))
1620 .trigger(
1621 ButtonLike::new("font-family-button")
1622 .style(ButtonStyle::Outlined)
1623 .size(ButtonSize::Medium)
1624 .full_width()
1625 .tab_index(0_isize)
1626 .child(
1627 h_flex()
1628 .w_full()
1629 .justify_between()
1630 .child(Label::new(current_value))
1631 .child(
1632 Icon::new(IconName::ChevronUpDown)
1633 .color(Color::Muted)
1634 .size(IconSize::XSmall),
1635 ),
1636 ),
1637 )
1638 .full_width(true)
1639 .anchor(gpui::Corner::TopLeft)
1640 .offset(gpui::Point {
1641 x: px(0.0),
1642 y: px(4.0),
1643 })
1644 .with_handle(ui::PopoverMenuHandle::default()),
1645 )
1646 .into_any_element()
1647}
1648
1649fn render_numeric_stepper<T: NumericStepperType + Send + Sync>(
1650 field: SettingField<T>,
1651 file: SettingsUiFile,
1652 window: &mut Window,
1653 cx: &mut App,
1654) -> AnyElement {
1655 let (_, value) = SettingsStore::global(cx).get_value_from_file(file.to_settings(), field.pick);
1656 let value = value.copied().unwrap_or_else(T::min_value);
1657 NumericStepper::new("numeric_stepper", value, window, cx)
1658 .on_change({
1659 move |value, _window, cx| {
1660 let value = *value;
1661 update_settings_file(file.clone(), cx, move |settings, _cx| {
1662 *(field.pick_mut)(settings) = Some(value);
1663 })
1664 .log_err(); // todo(settings_ui) don't log err
1665 }
1666 })
1667 .tab_index(0)
1668 .style(NumericStepperStyle::Outlined)
1669 .into_any_element()
1670}
1671
1672fn render_dropdown<T>(
1673 field: SettingField<T>,
1674 file: SettingsUiFile,
1675 window: &mut Window,
1676 cx: &mut App,
1677) -> AnyElement
1678where
1679 T: strum::VariantArray + strum::VariantNames + Copy + PartialEq + Send + Sync + 'static,
1680{
1681 let variants = || -> &'static [T] { <T as strum::VariantArray>::VARIANTS };
1682 let labels = || -> &'static [&'static str] { <T as strum::VariantNames>::VARIANTS };
1683
1684 let (_, current_value) =
1685 SettingsStore::global(cx).get_value_from_file(file.to_settings(), field.pick);
1686 let current_value = current_value.copied().unwrap_or(variants()[0]);
1687
1688 let current_value_label =
1689 labels()[variants().iter().position(|v| *v == current_value).unwrap()];
1690
1691 DropdownMenu::new(
1692 "dropdown",
1693 current_value_label.to_title_case(),
1694 ContextMenu::build(window, cx, move |mut menu, _, _| {
1695 for (&value, &label) in std::iter::zip(variants(), labels()) {
1696 let file = file.clone();
1697 menu = menu.toggleable_entry(
1698 label.to_title_case(),
1699 value == current_value,
1700 IconPosition::Start,
1701 None,
1702 move |_, cx| {
1703 if value == current_value {
1704 return;
1705 }
1706 update_settings_file(file.clone(), cx, move |settings, _cx| {
1707 *(field.pick_mut)(settings) = Some(value);
1708 })
1709 .log_err(); // todo(settings_ui) don't log err
1710 },
1711 );
1712 }
1713 menu
1714 }),
1715 )
1716 .trigger_size(ButtonSize::Medium)
1717 .style(DropdownStyle::Outlined)
1718 .offset(gpui::Point {
1719 x: px(0.0),
1720 y: px(2.0),
1721 })
1722 .tab_index(0)
1723 .into_any_element()
1724}
1725
1726#[cfg(test)]
1727mod test {
1728
1729 use super::*;
1730
1731 impl SettingsWindow {
1732 fn navbar_entry(&self) -> usize {
1733 self.navbar_entry
1734 }
1735
1736 fn new_builder(window: &mut Window, cx: &mut Context<Self>) -> Self {
1737 let mut this = Self::new(window, cx);
1738 this.navbar_entries.clear();
1739 this.pages.clear();
1740 this
1741 }
1742
1743 fn build(mut self) -> Self {
1744 self.build_search_matches();
1745 self.build_navbar();
1746 self
1747 }
1748
1749 fn add_page(
1750 mut self,
1751 title: &'static str,
1752 build_page: impl Fn(SettingsPage) -> SettingsPage,
1753 ) -> Self {
1754 let page = SettingsPage {
1755 title,
1756 items: Vec::default(),
1757 };
1758
1759 self.pages.push(build_page(page));
1760 self
1761 }
1762
1763 fn search(&mut self, search_query: &str, window: &mut Window, cx: &mut Context<Self>) {
1764 self.search_task.take();
1765 self.search_bar.update(cx, |editor, cx| {
1766 editor.set_text(search_query, window, cx);
1767 });
1768 self.update_matches(cx);
1769 }
1770
1771 fn assert_search_results(&self, other: &Self) {
1772 // page index could be different because of filtered out pages
1773 #[derive(Debug, PartialEq)]
1774 struct EntryMinimal {
1775 is_root: bool,
1776 title: &'static str,
1777 }
1778 pretty_assertions::assert_eq!(
1779 other
1780 .visible_navbar_entries()
1781 .map(|(_, entry)| EntryMinimal {
1782 is_root: entry.is_root,
1783 title: entry.title,
1784 })
1785 .collect::<Vec<_>>(),
1786 self.visible_navbar_entries()
1787 .map(|(_, entry)| EntryMinimal {
1788 is_root: entry.is_root,
1789 title: entry.title,
1790 })
1791 .collect::<Vec<_>>(),
1792 );
1793 assert_eq!(
1794 self.current_page().items.iter().collect::<Vec<_>>(),
1795 other.page_items().collect::<Vec<_>>()
1796 );
1797 }
1798 }
1799
1800 impl SettingsPage {
1801 fn item(mut self, item: SettingsPageItem) -> Self {
1802 self.items.push(item);
1803 self
1804 }
1805 }
1806
1807 impl SettingsPageItem {
1808 fn basic_item(title: &'static str, description: &'static str) -> Self {
1809 SettingsPageItem::SettingItem(SettingItem {
1810 title,
1811 description,
1812 field: Box::new(SettingField {
1813 pick: |settings_content| &settings_content.auto_update,
1814 pick_mut: |settings_content| &mut settings_content.auto_update,
1815 }),
1816 metadata: None,
1817 })
1818 }
1819 }
1820
1821 fn register_settings(cx: &mut App) {
1822 settings::init(cx);
1823 theme::init(theme::LoadThemes::JustBase, cx);
1824 workspace::init_settings(cx);
1825 project::Project::init_settings(cx);
1826 language::init(cx);
1827 editor::init(cx);
1828 menu::init();
1829 }
1830
1831 fn parse(input: &'static str, window: &mut Window, cx: &mut App) -> SettingsWindow {
1832 let mut pages: Vec<SettingsPage> = Vec::new();
1833 let mut expanded_pages = Vec::new();
1834 let mut selected_idx = None;
1835 let mut index = 0;
1836 let mut in_expanded_section = false;
1837
1838 for mut line in input
1839 .lines()
1840 .map(|line| line.trim())
1841 .filter(|line| !line.is_empty())
1842 {
1843 if let Some(pre) = line.strip_suffix('*') {
1844 assert!(selected_idx.is_none(), "Only one selected entry allowed");
1845 selected_idx = Some(index);
1846 line = pre;
1847 }
1848 let (kind, title) = line.split_once(" ").unwrap();
1849 assert_eq!(kind.len(), 1);
1850 let kind = kind.chars().next().unwrap();
1851 if kind == 'v' {
1852 let page_idx = pages.len();
1853 expanded_pages.push(page_idx);
1854 pages.push(SettingsPage {
1855 title,
1856 items: vec![],
1857 });
1858 index += 1;
1859 in_expanded_section = true;
1860 } else if kind == '>' {
1861 pages.push(SettingsPage {
1862 title,
1863 items: vec![],
1864 });
1865 index += 1;
1866 in_expanded_section = false;
1867 } else if kind == '-' {
1868 pages
1869 .last_mut()
1870 .unwrap()
1871 .items
1872 .push(SettingsPageItem::SectionHeader(title));
1873 if selected_idx == Some(index) && !in_expanded_section {
1874 panic!("Items in unexpanded sections cannot be selected");
1875 }
1876 index += 1;
1877 } else {
1878 panic!(
1879 "Entries must start with one of 'v', '>', or '-'\n line: {}",
1880 line
1881 );
1882 }
1883 }
1884
1885 let mut settings_window = SettingsWindow {
1886 files: Vec::default(),
1887 current_file: crate::SettingsUiFile::User,
1888 pages,
1889 search_bar: cx.new(|cx| Editor::single_line(window, cx)),
1890 navbar_entry: selected_idx.expect("Must have a selected navbar entry"),
1891 navbar_entries: Vec::default(),
1892 list_handle: UniformListScrollHandle::default(),
1893 search_matches: vec![],
1894 search_task: None,
1895 scroll_handle: ScrollHandle::new(),
1896 navbar_focus_handle: cx.focus_handle(),
1897 content_focus_handle: cx.focus_handle(),
1898 files_focus_handle: cx.focus_handle(),
1899 };
1900
1901 settings_window.build_search_matches();
1902 settings_window.build_navbar();
1903 for expanded_page_index in expanded_pages {
1904 for entry in &mut settings_window.navbar_entries {
1905 if entry.page_index == expanded_page_index && entry.is_root {
1906 entry.expanded = true;
1907 }
1908 }
1909 }
1910 settings_window
1911 }
1912
1913 #[track_caller]
1914 fn check_navbar_toggle(
1915 before: &'static str,
1916 toggle_page: &'static str,
1917 after: &'static str,
1918 window: &mut Window,
1919 cx: &mut App,
1920 ) {
1921 let mut settings_window = parse(before, window, cx);
1922 let toggle_page_idx = settings_window
1923 .pages
1924 .iter()
1925 .position(|page| page.title == toggle_page)
1926 .expect("page not found");
1927 let toggle_idx = settings_window
1928 .navbar_entries
1929 .iter()
1930 .position(|entry| entry.page_index == toggle_page_idx)
1931 .expect("page not found");
1932 settings_window.toggle_navbar_entry(toggle_idx);
1933
1934 let expected_settings_window = parse(after, window, cx);
1935
1936 pretty_assertions::assert_eq!(
1937 settings_window
1938 .visible_navbar_entries()
1939 .map(|(_, entry)| entry)
1940 .collect::<Vec<_>>(),
1941 expected_settings_window
1942 .visible_navbar_entries()
1943 .map(|(_, entry)| entry)
1944 .collect::<Vec<_>>(),
1945 );
1946 pretty_assertions::assert_eq!(
1947 settings_window.navbar_entries[settings_window.navbar_entry()],
1948 expected_settings_window.navbar_entries[expected_settings_window.navbar_entry()],
1949 );
1950 }
1951
1952 macro_rules! check_navbar_toggle {
1953 ($name:ident, before: $before:expr, toggle_page: $toggle_page:expr, after: $after:expr) => {
1954 #[gpui::test]
1955 fn $name(cx: &mut gpui::TestAppContext) {
1956 let window = cx.add_empty_window();
1957 window.update(|window, cx| {
1958 register_settings(cx);
1959 check_navbar_toggle($before, $toggle_page, $after, window, cx);
1960 });
1961 }
1962 };
1963 }
1964
1965 check_navbar_toggle!(
1966 navbar_basic_open,
1967 before: r"
1968 v General
1969 - General
1970 - Privacy*
1971 v Project
1972 - Project Settings
1973 ",
1974 toggle_page: "General",
1975 after: r"
1976 > General*
1977 v Project
1978 - Project Settings
1979 "
1980 );
1981
1982 check_navbar_toggle!(
1983 navbar_basic_close,
1984 before: r"
1985 > General*
1986 - General
1987 - Privacy
1988 v Project
1989 - Project Settings
1990 ",
1991 toggle_page: "General",
1992 after: r"
1993 v General*
1994 - General
1995 - Privacy
1996 v Project
1997 - Project Settings
1998 "
1999 );
2000
2001 check_navbar_toggle!(
2002 navbar_basic_second_root_entry_close,
2003 before: r"
2004 > General
2005 - General
2006 - Privacy
2007 v Project
2008 - Project Settings*
2009 ",
2010 toggle_page: "Project",
2011 after: r"
2012 > General
2013 > Project*
2014 "
2015 );
2016
2017 check_navbar_toggle!(
2018 navbar_toggle_subroot,
2019 before: r"
2020 v General Page
2021 - General
2022 - Privacy
2023 v Project
2024 - Worktree Settings Content*
2025 v AI
2026 - General
2027 > Appearance & Behavior
2028 ",
2029 toggle_page: "Project",
2030 after: r"
2031 v General Page
2032 - General
2033 - Privacy
2034 > Project*
2035 v AI
2036 - General
2037 > Appearance & Behavior
2038 "
2039 );
2040
2041 check_navbar_toggle!(
2042 navbar_toggle_close_propagates_selected_index,
2043 before: r"
2044 v General Page
2045 - General
2046 - Privacy
2047 v Project
2048 - Worktree Settings Content
2049 v AI
2050 - General*
2051 > Appearance & Behavior
2052 ",
2053 toggle_page: "General Page",
2054 after: r"
2055 > General Page
2056 v Project
2057 - Worktree Settings Content
2058 v AI
2059 - General*
2060 > Appearance & Behavior
2061 "
2062 );
2063
2064 check_navbar_toggle!(
2065 navbar_toggle_expand_propagates_selected_index,
2066 before: r"
2067 > General Page
2068 - General
2069 - Privacy
2070 v Project
2071 - Worktree Settings Content
2072 v AI
2073 - General*
2074 > Appearance & Behavior
2075 ",
2076 toggle_page: "General Page",
2077 after: r"
2078 v General Page
2079 - General
2080 - Privacy
2081 v Project
2082 - Worktree Settings Content
2083 v AI
2084 - General*
2085 > Appearance & Behavior
2086 "
2087 );
2088
2089 #[gpui::test]
2090 fn test_basic_search(cx: &mut gpui::TestAppContext) {
2091 let cx = cx.add_empty_window();
2092 let (actual, expected) = cx.update(|window, cx| {
2093 register_settings(cx);
2094
2095 let expected = cx.new(|cx| {
2096 SettingsWindow::new_builder(window, cx)
2097 .add_page("General", |page| {
2098 page.item(SettingsPageItem::SectionHeader("General settings"))
2099 .item(SettingsPageItem::basic_item("test title", "General test"))
2100 })
2101 .build()
2102 });
2103
2104 let actual = cx.new(|cx| {
2105 SettingsWindow::new_builder(window, cx)
2106 .add_page("General", |page| {
2107 page.item(SettingsPageItem::SectionHeader("General settings"))
2108 .item(SettingsPageItem::basic_item("test title", "General test"))
2109 })
2110 .add_page("Theme", |page| {
2111 page.item(SettingsPageItem::SectionHeader("Theme settings"))
2112 })
2113 .build()
2114 });
2115
2116 actual.update(cx, |settings, cx| settings.search("gen", window, cx));
2117
2118 (actual, expected)
2119 });
2120
2121 cx.cx.run_until_parked();
2122
2123 cx.update(|_window, cx| {
2124 let expected = expected.read(cx);
2125 let actual = actual.read(cx);
2126 expected.assert_search_results(&actual);
2127 })
2128 }
2129
2130 #[gpui::test]
2131 fn test_search_render_page_with_filtered_out_navbar_entries(cx: &mut gpui::TestAppContext) {
2132 let cx = cx.add_empty_window();
2133 let (actual, expected) = cx.update(|window, cx| {
2134 register_settings(cx);
2135
2136 let actual = cx.new(|cx| {
2137 SettingsWindow::new_builder(window, cx)
2138 .add_page("General", |page| {
2139 page.item(SettingsPageItem::SectionHeader("General settings"))
2140 .item(SettingsPageItem::basic_item(
2141 "Confirm Quit",
2142 "Whether to confirm before quitting Zed",
2143 ))
2144 .item(SettingsPageItem::basic_item(
2145 "Auto Update",
2146 "Automatically update Zed",
2147 ))
2148 })
2149 .add_page("AI", |page| {
2150 page.item(SettingsPageItem::basic_item(
2151 "Disable AI",
2152 "Whether to disable all AI features in Zed",
2153 ))
2154 })
2155 .add_page("Appearance & Behavior", |page| {
2156 page.item(SettingsPageItem::SectionHeader("Cursor")).item(
2157 SettingsPageItem::basic_item(
2158 "Cursor Shape",
2159 "Cursor shape for the editor",
2160 ),
2161 )
2162 })
2163 .build()
2164 });
2165
2166 let expected = cx.new(|cx| {
2167 SettingsWindow::new_builder(window, cx)
2168 .add_page("Appearance & Behavior", |page| {
2169 page.item(SettingsPageItem::SectionHeader("Cursor")).item(
2170 SettingsPageItem::basic_item(
2171 "Cursor Shape",
2172 "Cursor shape for the editor",
2173 ),
2174 )
2175 })
2176 .build()
2177 });
2178
2179 actual.update(cx, |settings, cx| settings.search("cursor", window, cx));
2180
2181 (actual, expected)
2182 });
2183
2184 cx.cx.run_until_parked();
2185
2186 cx.update(|_window, cx| {
2187 let expected = expected.read(cx);
2188 let actual = actual.read(cx);
2189 expected.assert_search_results(&actual);
2190 })
2191 }
2192}