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