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