fret-runtime 0.1.0

Runtime abstractions and scheduling surfaces for host integration in Fret.
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
use fret_core::TextFontFamilyConfig;
use std::collections::HashSet;

use crate::{FontCatalog, FontCatalogCache, FontCatalogEntry, FontCatalogMetadata, GlobalsHost};

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum FontFamilyDefaultsPolicy {
    None,
    FillIfEmpty,
    /// If any UI family list is empty, seed it from the head of the current font catalog.
    ///
    /// This is primarily intended for Web/WASM bootstrap, where system font discovery is not
    /// available and we need a deterministic, minimal fallback without exploding settings to
    /// "all fonts".
    FillIfEmptyFromCatalogPrefix {
        max: usize,
    },
    /// If any UI family list is empty, seed it with a small curated list of common UI families.
    ///
    /// This is primarily intended for Web/WASM bootstrap.
    FillIfEmptyWithCuratedCandidates,
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct FontCatalogUpdate {
    pub revision: u64,
    pub families: Vec<String>,
    pub cache: FontCatalogCache,
    pub config: TextFontFamilyConfig,
    pub config_changed: bool,
}

fn merge_unique_family_candidates(lists: &[&[&str]]) -> Vec<String> {
    let mut seen_lower: HashSet<String> = HashSet::new();
    let mut out = Vec::new();
    for list in lists {
        for &family in *list {
            let trimmed = family.trim();
            if trimmed.is_empty() {
                continue;
            }
            let key = trimmed.to_ascii_lowercase();
            if seen_lower.insert(key) {
                out.push(trimmed.to_string());
            }
        }
    }
    out
}

fn bundled_profile() -> &'static fret_fonts::BundledFontProfile {
    fret_fonts::default_profile()
}

fn curated_ui_sans_candidates() -> Vec<String> {
    #[cfg(target_arch = "wasm32")]
    {
        merge_unique_family_candidates(&[bundled_profile().ui_sans_families])
    }
    #[cfg(not(target_arch = "wasm32"))]
    {
        merge_unique_family_candidates(&[
            bundled_profile().ui_sans_families,
            &[
                "Segoe UI",
                "Helvetica",
                "Arial",
                "Ubuntu",
                "Adwaita Sans",
                "Cantarell",
                "Noto Sans",
                "DejaVu Sans",
            ],
        ])
    }
}

fn curated_ui_serif_candidates() -> Vec<String> {
    #[cfg(target_arch = "wasm32")]
    {
        merge_unique_family_candidates(&[bundled_profile().ui_serif_families])
    }
    #[cfg(not(target_arch = "wasm32"))]
    {
        merge_unique_family_candidates(&[
            bundled_profile().ui_serif_families,
            &["Noto Serif", "Times New Roman", "Georgia", "DejaVu Serif"],
        ])
    }
}

fn curated_ui_mono_candidates() -> Vec<String> {
    #[cfg(target_arch = "wasm32")]
    {
        merge_unique_family_candidates(&[bundled_profile().ui_mono_families])
    }
    #[cfg(not(target_arch = "wasm32"))]
    {
        merge_unique_family_candidates(&[
            bundled_profile().ui_mono_families,
            &["Consolas", "Menlo", "DejaVu Sans Mono", "Noto Sans Mono"],
        ])
    }
}

fn curated_common_fallback_candidates() -> Vec<String> {
    #[cfg(target_arch = "wasm32")]
    {
        merge_unique_family_candidates(&[bundled_profile().common_fallback_families])
    }
    #[cfg(not(target_arch = "wasm32"))]
    {
        merge_unique_family_candidates(&[
            bundled_profile().common_fallback_families,
            &[
                "Noto Sans CJK JP",
                "Noto Sans CJK TC",
                "Microsoft YaHei UI",
                "Microsoft YaHei",
                "PingFang SC",
                "Hiragino Sans",
                "Apple Color Emoji",
                "Segoe UI Emoji",
                "Segoe UI Symbol",
            ],
        ])
    }
}

fn apply_family_defaults_policy(
    mut config: TextFontFamilyConfig,
    families: &[String],
    policy: FontFamilyDefaultsPolicy,
) -> TextFontFamilyConfig {
    match policy {
        FontFamilyDefaultsPolicy::None => {}
        FontFamilyDefaultsPolicy::FillIfEmpty => {
            if config.ui_sans.is_empty() {
                config.ui_sans = families.to_vec();
            }
            if config.ui_serif.is_empty() {
                config.ui_serif = families.to_vec();
            }
            if config.ui_mono.is_empty() {
                config.ui_mono = families.to_vec();
            }
        }
        FontFamilyDefaultsPolicy::FillIfEmptyFromCatalogPrefix { max } => {
            let max = max.max(1);
            let seed: Vec<String> = families.iter().take(max).cloned().collect();
            if config.ui_sans.is_empty() {
                config.ui_sans = seed.clone();
            }
            if config.ui_serif.is_empty() {
                config.ui_serif = seed.clone();
            }
            if config.ui_mono.is_empty() {
                config.ui_mono = seed;
            }
        }
        FontFamilyDefaultsPolicy::FillIfEmptyWithCuratedCandidates => {
            if config.ui_sans.is_empty() {
                config.ui_sans = curated_ui_sans_candidates();
            }
            if config.ui_serif.is_empty() {
                config.ui_serif = curated_ui_serif_candidates();
            }
            if config.ui_mono.is_empty() {
                config.ui_mono = curated_ui_mono_candidates();
            }
            if config.common_fallback.is_empty() {
                config.common_fallback = curated_common_fallback_candidates();
            }
        }
    }

    config
}

pub fn apply_font_catalog_update(
    app: &mut impl GlobalsHost,
    families: Vec<String>,
    policy: FontFamilyDefaultsPolicy,
) -> FontCatalogUpdate {
    let prev_rev = app.global::<FontCatalog>().map(|c| c.revision).unwrap_or(0);
    let catalog_changed = app
        .global::<FontCatalog>()
        .map(|c| c.families.as_slice() != families.as_slice())
        .unwrap_or(true);
    let revision = if catalog_changed {
        prev_rev.saturating_add(1)
    } else {
        prev_rev
    };

    let cache = if catalog_changed {
        let cache = FontCatalogCache::from_families(revision, &families);
        app.set_global::<FontCatalog>(FontCatalog {
            families: families.clone(),
            revision,
        });
        app.set_global::<FontCatalogCache>(cache.clone());
        cache
    } else {
        app.global::<FontCatalogCache>()
            .cloned()
            .unwrap_or_else(|| FontCatalogCache::from_families(revision, &families))
    };

    let prev_config = app
        .global::<TextFontFamilyConfig>()
        .cloned()
        .unwrap_or_default();
    let config = apply_family_defaults_policy(prev_config.clone(), &families, policy);

    let config_changed = config != prev_config;
    // Always re-set the config global so renderers can react even if the value is unchanged.
    app.set_global::<TextFontFamilyConfig>(config.clone());

    FontCatalogUpdate {
        revision,
        families,
        cache,
        config,
        config_changed,
    }
}

pub fn apply_font_catalog_update_with_metadata(
    app: &mut impl GlobalsHost,
    entries: Vec<FontCatalogEntry>,
    policy: FontFamilyDefaultsPolicy,
) -> FontCatalogUpdate {
    let families = entries.iter().map(|e| e.family.clone()).collect::<Vec<_>>();

    let prev_rev = app.global::<FontCatalog>().map(|c| c.revision).unwrap_or(0);
    let catalog_changed = app
        .global::<FontCatalog>()
        .map(|c| c.families.as_slice() != families.as_slice())
        .unwrap_or(true);
    let metadata_changed = app
        .global::<FontCatalogMetadata>()
        .map(|m| m.entries.as_slice() != entries.as_slice())
        .unwrap_or(true);

    let revision = if catalog_changed || metadata_changed {
        prev_rev.saturating_add(1)
    } else {
        prev_rev
    };

    let prev_config = app
        .global::<TextFontFamilyConfig>()
        .cloned()
        .unwrap_or_default();
    let config = apply_family_defaults_policy(prev_config.clone(), &families, policy);
    let config_changed = config != prev_config;
    app.set_global::<TextFontFamilyConfig>(config.clone());

    let cache = if catalog_changed || metadata_changed {
        let cache = FontCatalogCache::from_families(revision, &families);
        app.set_global::<FontCatalog>(FontCatalog {
            families: families.clone(),
            revision,
        });
        app.set_global::<FontCatalogCache>(cache.clone());
        app.set_global::<FontCatalogMetadata>(FontCatalogMetadata { entries, revision });
        cache
    } else {
        app.global::<FontCatalogCache>()
            .cloned()
            .unwrap_or_else(|| FontCatalogCache::from_families(revision, &families))
    };

    FontCatalogUpdate {
        revision,
        families,
        cache,
        config,
        config_changed,
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use std::any::{Any, TypeId};
    use std::collections::HashMap;

    #[derive(Default)]
    struct TestApp {
        globals: HashMap<TypeId, Box<dyn Any>>,
    }

    impl GlobalsHost for TestApp {
        fn global<T: 'static>(&self) -> Option<&T> {
            self.globals
                .get(&TypeId::of::<T>())
                .and_then(|v| v.downcast_ref::<T>())
        }

        fn set_global<T: 'static>(&mut self, value: T) {
            self.globals.insert(TypeId::of::<T>(), Box::new(value));
        }

        fn with_global_mut<T: 'static, R>(
            &mut self,
            init: impl FnOnce() -> T,
            f: impl FnOnce(&mut T, &mut Self) -> R,
        ) -> R {
            let type_id = TypeId::of::<T>();

            let mut value: T = self
                .globals
                .remove(&type_id)
                .and_then(|v| v.downcast::<T>().ok())
                .map(|v| *v)
                .unwrap_or_else(init);

            let out = f(&mut value, self);

            self.globals.insert(type_id, Box::new(value));
            out
        }
    }

    #[test]
    fn curated_defaults_include_profile_and_platform_fallbacks() {
        let mut app = TestApp::default();
        let update = apply_font_catalog_update(
            &mut app,
            vec!["Inter".to_string(), "JetBrains Mono".to_string()],
            FontFamilyDefaultsPolicy::FillIfEmptyWithCuratedCandidates,
        );

        for family in fret_fonts::default_profile().common_fallback_families {
            assert!(update.config.common_fallback.iter().any(|v| v == family));
        }
        assert!(
            update
                .config
                .common_fallback
                .iter()
                .any(|v| v == "Apple Color Emoji")
        );
        assert!(
            update
                .config
                .common_fallback
                .iter()
                .any(|v| v == "Segoe UI Emoji")
        );
    }

    #[test]
    fn apply_update_does_not_bump_revision_when_families_unchanged() {
        let mut app = TestApp::default();

        let update0 = apply_font_catalog_update(
            &mut app,
            vec!["Inter".to_string(), "JetBrains Mono".to_string()],
            FontFamilyDefaultsPolicy::None,
        );
        let update1 = apply_font_catalog_update(
            &mut app,
            vec!["Inter".to_string(), "JetBrains Mono".to_string()],
            FontFamilyDefaultsPolicy::FillIfEmptyWithCuratedCandidates,
        );

        assert_eq!(update0.revision, update1.revision);
        let catalog = app.global::<FontCatalog>().expect("font catalog");
        assert_eq!(catalog.revision, update0.revision);
        assert_eq!(
            catalog.families,
            vec!["Inter".to_string(), "JetBrains Mono".to_string()]
        );
    }

    #[test]
    fn apply_update_with_metadata_sets_metadata_global() {
        let mut app = TestApp::default();
        let entries = vec![
            FontCatalogEntry {
                family: "Inter".to_string(),
                has_variable_axes: false,
                known_variable_axes: vec![],
                variable_axes: vec![],
                is_monospace_candidate: false,
            },
            FontCatalogEntry {
                family: "Roboto Flex".to_string(),
                has_variable_axes: true,
                known_variable_axes: vec!["wght".to_string(), "wdth".to_string()],
                variable_axes: vec![],
                is_monospace_candidate: false,
            },
        ];

        let update = apply_font_catalog_update_with_metadata(
            &mut app,
            entries.clone(),
            FontFamilyDefaultsPolicy::None,
        );

        let catalog = app.global::<FontCatalog>().expect("font catalog");
        assert_eq!(catalog.revision, update.revision);
        assert_eq!(
            catalog.families,
            vec!["Inter".to_string(), "Roboto Flex".to_string()]
        );

        let meta = app
            .global::<FontCatalogMetadata>()
            .expect("font catalog metadata");
        assert_eq!(meta.revision, update.revision);
        assert_eq!(meta.entries, entries);
    }

    #[test]
    fn apply_update_with_metadata_does_not_bump_revision_when_entries_unchanged() {
        let mut app = TestApp::default();
        let entries = vec![
            FontCatalogEntry {
                family: "Inter".to_string(),
                has_variable_axes: false,
                known_variable_axes: vec![],
                variable_axes: vec![],
                is_monospace_candidate: false,
            },
            FontCatalogEntry {
                family: "Roboto Flex".to_string(),
                has_variable_axes: true,
                known_variable_axes: vec!["wght".to_string(), "wdth".to_string()],
                variable_axes: vec![],
                is_monospace_candidate: false,
            },
        ];

        let update0 = apply_font_catalog_update_with_metadata(
            &mut app,
            entries.clone(),
            FontFamilyDefaultsPolicy::None,
        );
        let update1 = apply_font_catalog_update_with_metadata(
            &mut app,
            entries.clone(),
            FontFamilyDefaultsPolicy::FillIfEmptyWithCuratedCandidates,
        );

        assert_eq!(update0.revision, update1.revision);
        let catalog = app.global::<FontCatalog>().expect("font catalog");
        assert_eq!(catalog.revision, update0.revision);
        let meta = app
            .global::<FontCatalogMetadata>()
            .expect("font catalog metadata");
        assert_eq!(meta.revision, update0.revision);
        assert_eq!(meta.entries, entries);
    }
}