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