Skip to main content

egui_macview/theme/
accessors.rs

1//! Metric, Typography, Motion, and Contrast Accessors on [`MacTheme`].
2
3use super::{MacBackgroundStyle, MacTheme};
4use crate::tokens::{
5    BoxViewMetrics, ButtonMetrics, CheckboxMetrics, CollectionViewMetrics, ColorWellMetrics,
6    ComboBoxMetrics, ContextMenuMetrics, DatePickerMetrics, DisclosureGroupMetrics,
7    FocusRingMetrics, FooterMetrics, HelpButtonMetrics, InlineActionButtonMetrics, LabelMetrics,
8    LayoutMetrics, LevelIndicatorMetrics, MacControlMetrics, MacMotionTokens, MacTypographyTokens,
9    MenuBarMetrics, NavigationMetrics, OutlineViewMetrics, PaletteMetrics, PathControlMetrics,
10    PlayerViewMetrics, PopUpButtonMetrics, PopoverMetrics, ProgressIndicatorMetrics,
11    RuleEditorMetrics, ScrollViewMetrics, SearchFieldMetrics, SegmentedMetrics, SliderMetrics,
12    SplitViewMetrics, StackViewMetrics, StepperMetrics, TabViewMetrics, TableViewMetrics,
13    TextFieldMetrics, ThumbnailCellMetrics, ToastMetrics, ToggleMetrics, TokenFieldMetrics,
14    ToolbarMetrics, TrimScrubberMetrics,
15};
16use egui::{Color32, FontId, Galley, TextFormat, Ui};
17use std::sync::Arc;
18
19const fn tracking_table_key(pt: i32) -> Option<&'static str> {
20    match pt {
21        6 => Some("pt_6"),
22        7 => Some("pt_7"),
23        8 => Some("pt_8"),
24        9 => Some("pt_9"),
25        10 => Some("pt_10"),
26        11 => Some("pt_11"),
27        12 => Some("pt_12"),
28        13 => Some("pt_13"),
29        14 => Some("pt_14"),
30        15 => Some("pt_15"),
31        16 => Some("pt_16"),
32        17 => Some("pt_17"),
33        18 => Some("pt_18"),
34        19 => Some("pt_19"),
35        20 => Some("pt_20"),
36        21 => Some("pt_21"),
37        22 => Some("pt_22"),
38        23 => Some("pt_23"),
39        24 => Some("pt_24"),
40        _ => None,
41    }
42}
43
44impl MacTheme {
45    /// Resolves Apple HIG / SF Pro optical tracking (`extra_letter_spacing` in points)
46    /// for `size_pt` from `self.typography().tracking_table`, falling back to
47    /// [`crate::tokens::sf_pro_tracking`] for fractional or out-of-range font sizes.
48    pub fn tracking_for_font_size(&self, size_pt: f32) -> f32 {
49        let rounded = size_pt.round();
50        if (size_pt - rounded).abs() == 0.0 {
51            if let Some(key) = tracking_table_key(rounded as i32) {
52                if let Some(entry) = self.typography().tracking_table.get(key) {
53                    return entry.tracking_pt;
54                }
55            }
56        }
57        crate::tokens::sf_pro_tracking(size_pt)
58    }
59
60    /// Resolves the `Inter-SemiBold` [`FontId`] when registered in `ui.ctx()`, or falls back
61    /// to [`FontId::proportional`], returning `(font_id, has_semibold_family)` with zero
62    /// per-widget `Arc<str>` or `Vec<FontFamily>` heap allocations.
63    pub fn semibold_font_id(&self, ui: &Ui, size_pt: f32) -> (FontId, bool) {
64        static INTER_SEMIBOLD_FAMILY: std::sync::OnceLock<egui::FontFamily> =
65            std::sync::OnceLock::new();
66        let family = INTER_SEMIBOLD_FAMILY.get_or_init(|| {
67            egui::FontFamily::Name(crate::symbols::INTER_SEMIBOLD_FONT_NAME.into())
68        });
69        let cache_id = egui::Id::unique("macview_has_inter_semibold");
70        let has_semibold = ui
71            .ctx()
72            .data(|d| d.get_temp::<bool>(cache_id))
73            .unwrap_or_else(|| {
74                let found = ui.fonts(|f| f.families().contains(family));
75                ui.ctx().data_mut(|d| d.insert_temp(cache_id, found));
76                found
77            });
78        if has_semibold {
79            (FontId::new(size_pt, family.clone()), true)
80        } else {
81            (FontId::proportional(size_pt), false)
82        }
83    }
84
85    /// Constructs an [`egui::TextFormat`] populated with optical letter spacing (`extra_letter_spacing`)
86    /// from the Apple HIG tracking table for `font_id.size`.
87    pub fn tracked_text_format(&self, font_id: FontId, color: Color32) -> TextFormat {
88        TextFormat {
89            font_id: font_id.clone(),
90            color,
91            extra_letter_spacing: self.tracking_for_font_size(font_id.size),
92            ..Default::default()
93        }
94    }
95
96    /// Lays out a text [`Galley`] with Apple HIG optical tracking (`extra_letter_spacing`)
97    /// automatically applied from `self.typography().tracking_table`.
98    pub fn layout_tracked_galley(
99        &self,
100        ui: &Ui,
101        text: &str,
102        font_id: FontId,
103        color: Color32,
104        wrap_width: f32,
105    ) -> Arc<Galley> {
106        let mut job = egui::text::LayoutJob::single_section(
107            text.to_owned(),
108            self.tracked_text_format(font_id, color),
109        );
110        job.wrap.max_width = wrap_width;
111        ui.painter().layout_job(job)
112    }
113
114    /// Returns control metrics tokens.
115    pub fn control_metrics(&self) -> &MacControlMetrics { self.tokens.control_metrics() }
116    /// Returns button size and geometry tokens.
117    pub fn button(&self) -> &ButtonMetrics { &self.tokens.control_metrics().button }
118    /// Returns text field and input cell size/geometry tokens.
119    pub fn text_field(&self) -> &TextFieldMetrics { &self.tokens.control_metrics().text_field }
120    /// Returns segmented control geometry tokens.
121    pub fn segmented(&self) -> &SegmentedMetrics { &self.tokens.control_metrics().segmented }
122    /// Returns focus ring halo tokens.
123    pub fn focus_ring(&self) -> &FocusRingMetrics { &self.tokens.control_metrics().focus_ring }
124    /// Returns toolbar layout and hit-target tokens.
125    pub fn toolbar_metrics(&self) -> &ToolbarMetrics { self.tokens.toolbar_metrics() }
126    /// Returns popover and floating panel geometry tokens.
127    pub fn popover_metrics(&self) -> &PopoverMetrics { self.tokens.popover_metrics() }
128    /// Returns split view divider and pane geometry tokens.
129    pub fn split_view(&self) -> &SplitViewMetrics { self.tokens.split_view_metrics() }
130    /// Returns layout container metrics (`scroll_view`, `stack_view`).
131    pub fn layout_metrics(&self) -> &LayoutMetrics { self.tokens.layout_metrics() }
132    /// Returns scroll view overlay scrollbar geometry tokens.
133    pub fn scroll_view(&self) -> &ScrollViewMetrics { self.tokens.scroll_view_metrics() }
134    /// Returns stack view spacing, padding, and header tokens.
135    pub fn stack_view(&self) -> &StackViewMetrics { self.tokens.stack_view_metrics() }
136    /// Returns outline view row, indentation, and chevron tokens.
137    pub fn outline_view(&self) -> &OutlineViewMetrics { self.tokens.outline_view_metrics() }
138    /// Returns slider track, thumb, and tick tokens.
139    pub fn slider(&self) -> &SliderMetrics { self.tokens.slider_metrics() }
140    /// Returns thumbnail cell preview tokens.
141    pub fn thumbnail(&self) -> &ThumbnailCellMetrics { self.tokens.thumbnail_metrics() }
142    /// Returns pop-up button bezel and menu tokens.
143    pub fn popup_button(&self) -> &PopUpButtonMetrics { self.tokens.popup_button_metrics() }
144    /// Returns search field pill, icon, and clear button tokens.
145    pub fn search_field(&self) -> &SearchFieldMetrics { self.tokens.search_field_metrics() }
146    /// Returns numeric stepper control tokens.
147    pub fn stepper(&self) -> &StepperMetrics { self.tokens.stepper_metrics() }
148    /// Returns color well swatch and picker tokens.
149    pub fn color_well(&self) -> &ColorWellMetrics { self.tokens.color_well_metrics() }
150    /// Returns toggle switch (`NSSwitch`) tokens.
151    pub fn toggle(&self) -> &ToggleMetrics { self.tokens.toggle_metrics() }
152    /// Returns navigation and feedback metrics tokens.
153    pub fn navigation_metrics(&self) -> &NavigationMetrics { self.tokens.navigation_metrics() }
154    /// Returns menu bar and dropdown menu tokens.
155    pub fn menu_bar_metrics(&self) -> &MenuBarMetrics { self.tokens.menu_bar_metrics() }
156    /// Returns canvas footer bar tokens.
157    pub fn footer_metrics(&self) -> &FooterMetrics { self.tokens.footer_metrics() }
158    /// Returns Spotlight command palette tokens.
159    pub fn palette_metrics(&self) -> &PaletteMetrics { self.tokens.palette_metrics() }
160    /// Returns context menu popup tokens.
161    pub fn context_menu_metrics(&self) -> &ContextMenuMetrics { self.tokens.context_menu_metrics() }
162    /// Returns floating toast notification tokens.
163    pub fn toast_metrics(&self) -> &ToastMetrics { self.tokens.toast_metrics() }
164    /// Returns progress indicator bar and spinning fin tokens.
165    pub fn progress_indicator(&self) -> &ProgressIndicatorMetrics { self.tokens.progress_indicator_metrics() }
166    /// Returns table view and sortable header tokens.
167    pub fn table_view(&self) -> &TableViewMetrics { self.tokens.table_view_metrics() }
168    /// Returns token field pill capsule tokens.
169    pub fn token_field(&self) -> &TokenFieldMetrics { self.tokens.token_field_metrics() }
170    /// Returns level indicator VU meter tokens.
171    pub fn level_indicator(&self) -> &LevelIndicatorMetrics { self.tokens.level_indicator_metrics() }
172    /// Returns AVKit trim scrubber timeline tokens.
173    pub fn trim_scrubber(&self) -> &TrimScrubberMetrics { self.tokens.trim_scrubber_metrics() }
174    /// Returns path control breadcrumb bar tokens.
175    pub fn path_control(&self) -> &PathControlMetrics { self.tokens.path_control_metrics() }
176    /// Returns disclosure group & button tokens.
177    pub fn disclosure_group(&self) -> &DisclosureGroupMetrics { self.tokens.disclosure_group_metrics() }
178    /// Returns combo box tokens.
179    pub fn combo_box(&self) -> &ComboBoxMetrics { self.tokens.combo_box_metrics() }
180    /// Returns tab view tokens.
181    pub fn tab_view(&self) -> &TabViewMetrics { self.tokens.tab_view_metrics() }
182    /// Returns date picker tokens.
183    pub fn date_picker(&self) -> &DatePickerMetrics { self.tokens.date_picker_metrics() }
184    /// Returns collection view tokens.
185    pub fn collection_view(&self) -> &CollectionViewMetrics { self.tokens.collection_view_metrics() }
186    /// Returns player view tokens.
187    pub fn player_view(&self) -> &PlayerViewMetrics { self.tokens.player_view_metrics() }
188    /// Returns box view tokens.
189    pub fn box_view(&self) -> &BoxViewMetrics { self.tokens.box_view_metrics() }
190    /// Returns rule editor tokens.
191    pub fn rule_editor(&self) -> &RuleEditorMetrics { self.tokens.rule_editor_metrics() }
192    /// Returns square AppKit checkbox (`NSButtonTypeSwitch`) tokens.
193    pub fn checkbox(&self) -> &CheckboxMetrics { self.tokens.checkbox_metrics() }
194    /// Returns non-editable AppKit label (`NSTextField.labelWithString:`) tokens.
195    pub fn label_metrics(&self) -> &LabelMetrics { self.tokens.label_metrics() }
196    /// Returns circular AppKit help button (`NSBezelStyleHelpButton`) tokens.
197    pub fn help_button(&self) -> &HelpButtonMetrics { self.tokens.help_button_metrics() }
198    /// Returns circular inline action badge button (`16x16pt`) tokens.
199    pub fn inline_action_button(&self) -> &InlineActionButtonMetrics { self.tokens.inline_action_button_metrics() }
200    /// Returns typography and SF Pro optical tracking tokens.
201    pub fn typography(&self) -> &MacTypographyTokens { self.tokens.typography() }
202    /// Returns CoreAnimation spring physics preset tokens.
203    pub fn motion(&self) -> &MacMotionTokens { self.tokens.motion() }
204
205    /// Evaluates [`MacBackgroundStyle`] for the given background surface color.
206    pub fn background_style(&self, surface_bg: Color32) -> MacBackgroundStyle {
207        MacBackgroundStyle::from_color(surface_bg)
208    }
209    /// Evaluates [`MacBackgroundStyle`] for [`Self::control_accent`] (or custom accent override).
210    pub fn accent_background_style(&self) -> MacBackgroundStyle {
211        MacBackgroundStyle::from_color(self.control_accent())
212    }
213    /// Evaluates [`MacBackgroundStyle`] for [`Self::selected_control`].
214    pub fn selected_control_background_style(&self) -> MacBackgroundStyle {
215        MacBackgroundStyle::from_color(self.selected_control())
216    }
217    /// Returns disabled control opacity factor (`0.45`).
218    pub fn disabled_opacity(&self) -> f32 {
219        self.tokens.control_metrics().disabled_opacity.points()
220    }
221    /// Scales `color` alpha by [`Self::disabled_opacity`] when `enabled` is `false`.
222    pub fn apply_enabled(&self, color: Color32, enabled: bool) -> Color32 {
223        if enabled { color } else { color.gamma_multiply(self.disabled_opacity()) }
224    }
225
226    /// Renders an AppKit outer keyboard focus ring (`NSFocusRingPlacementOutside`) around `rect`.
227    pub fn paint_focus_ring(&self, painter: &egui::Painter, rect: egui::Rect, corner_radius: f32) {
228        let ring = self.focus_ring();
229        let focus_rect = rect.expand(ring.offset.points());
230        let focus_radius = corner_radius + ring.corner_radius_delta.points();
231        painter.rect_stroke(
232            focus_rect,
233            egui::CornerRadius::same(focus_radius as u8),
234            egui::Stroke::new(ring.stroke_width.points(), self.keyboard_focus_indicator()),
235            egui::StrokeKind::Outside,
236        );
237    }
238}