plushie-widget-sdk 0.7.1

Widget SDK for Plushie
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
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
//! Main render dispatch: maps a [`TreeNode`] to an iced [`Element`].
//!
//! This is the immutable side of the prepare/render split. All
//! mutable cache state must be pre-populated by `registry.prepare_walk()` (via PlushieWidget::prepare)
//! before calling [`render`]. Recursion depth is bounded by a
//! thread-local counter.

use std::cell::Cell;

use iced::widget::text;
use iced::{Color, Element, Theme};

use crate::PlushieRenderer;
use crate::message::Message;
use crate::protocol::TreeNode;
use crate::render_ctx::RenderCtx;
use crate::shared_state::MAX_TREE_DEPTH;
use crate::validate;

// ---------------------------------------------------------------------------
// Main render dispatch
// ---------------------------------------------------------------------------

/// Map a TreeNode to an iced Element. Unknown types render as an empty container.
///
/// This is the immutable side of the prepare/render split. All mutable
/// cache state (text_editor Content, markdown Items, combo_box State, canvas
/// Cache, etc.) must be pre-populated by `registry.prepare_walk()` (via PlushieWidget::prepare) before calling
/// this function. `render` works exclusively with shared (`&`) references
/// to caches, so it can run inside iced's `view()` which only has `&self`.
pub fn render<'a, R: PlushieRenderer>(
    node: &'a TreeNode,
    ctx: RenderCtx<'a, R>,
) -> Element<'a, Message, Theme, R> {
    // Track recursion depth via thread-local counter. Each call increments
    // on entry; the DepthGuard decrements on drop (including early returns).
    thread_local! {
        static RENDER_DEPTH: Cell<usize> = const { Cell::new(0) };
    }
    struct DepthGuard;
    impl Drop for DepthGuard {
        fn drop(&mut self) {
            RENDER_DEPTH.with(|d| d.set(d.get().saturating_sub(1)));
        }
    }

    let depth = RENDER_DEPTH.with(|d| {
        let new = d.get() + 1;
        d.set(new);
        new
    });
    let _guard = DepthGuard;

    if depth > MAX_TREE_DEPTH {
        log::warn!(
            "[id={}] render depth exceeds {MAX_TREE_DEPTH}, returning placeholder",
            node.id
        );
        return text("Max depth exceeded")
            .color(Color::from_rgb(1.0, 0.0, 0.0))
            .into();
    }

    if ctx.validate_props {
        validate::validate_props(node);
    }

    let element = ctx.registry.render_node(node, &ctx);

    // Merge widget-inferred defaults with the author's explicit a11y prop.
    // Explicit values win per field; inferred values fill in the gaps so a
    // single `a11y.label` override doesn't silently discard an inferred
    // `description` (e.g. a text_input's placeholder).
    //
    // Panic-isolated to match the render dispatch: a buggy third-party
    // widget must not take down the renderer via infer_a11y either.
    let inferred = ctx.registry.infer_a11y_for_node(node);
    let explicit = crate::a11y::A11yOverrides::from_props(&node.props);
    let overrides = match (inferred, explicit) {
        (Some(inf), Some(exp)) => Some(crate::a11y::A11yOverrides::merge(&inf, &exp)),
        (Some(inf), None) => Some(inf),
        (None, Some(exp)) => Some(exp),
        (None, None) => None,
    };

    if let Some(overrides) = overrides {
        return crate::a11y::A11yOverride::wrap(element, overrides).into();
    }

    element
}

// ---------------------------------------------------------------------------
// Tests
// ---------------------------------------------------------------------------

#[cfg(test)]
mod tests {
    use super::*;
    use crate::image_registry::ImageRegistry;
    use crate::protocol::TreeNode;
    use crate::registry::WidgetRegistry;
    use crate::shared_state::SharedState;
    use crate::widget::widget_set::iced_widget_set;

    #[test]
    fn image_registry_handle_lookup() {
        let mut registry = ImageRegistry::new();
        // Minimal valid 1x1 RGBA PNG.
        let png_bytes: Vec<u8> = vec![
            0x89, 0x50, 0x4E, 0x47, 0x0D, 0x0A, 0x1A, 0x0A, // signature
            0x00, 0x00, 0x00, 0x0D, 0x49, 0x48, 0x44, 0x52, // IHDR chunk
            0x00, 0x00, 0x00, 0x01, 0x00, 0x00, 0x00, 0x01, // 1x1
            0x08, 0x06, 0x00, 0x00, 0x00, 0x1F, 0x15, 0xC4, // 8-bit RGBA
            0x89, 0x00, 0x00, 0x00, 0x0D, 0x49, 0x44, 0x41, // IDAT
            0x54, 0x78, 0x9C, 0x63, 0xF8, 0xCF, 0xC0, 0xF0, 0x1F, 0x00, 0x05, 0x00, 0x01, 0xFF,
            0x89, 0x99, 0x3D, 0x1D, 0x00, 0x00, 0x00, 0x00, // IEND
            0x49, 0x45, 0x4E, 0x44, 0xAE, 0x42, 0x60, 0x82,
        ];
        registry
            .create_from_bytes("test_sprite", png_bytes)
            .expect("test sprite should be valid");
        assert!(
            registry.get("test_sprite").is_some(),
            "registered handle should be retrievable"
        );
        assert!(
            registry.get("nonexistent").is_none(),
            "unregistered name should return None"
        );
    }

    // -----------------------------------------------------------------------
    // Render smoke tests: verify render() doesn't panic for common types
    // -----------------------------------------------------------------------

    use crate::testing::{
        node_with_props as smoke_node, node_with_props_and_children as smoke_node_with_children,
    };
    use plushie_core::types::Role;

    fn smoke_text_child() -> TreeNode {
        smoke_node("child", "text", serde_json::json!({"content": "hi"}))
    }

    fn smoke_registry() -> WidgetRegistry {
        let mut registry = WidgetRegistry::new();
        registry.register_set(&iced_widget_set());
        registry
    }

    fn smoke_ctx<'a>(
        caches: &'a SharedState,
        images: &'a ImageRegistry,
        theme: &'a iced::Theme,
        registry: &'a WidgetRegistry,
    ) -> RenderCtx<'a> {
        RenderCtx {
            caches,
            images,
            theme,
            theme_chrome: crate::theming::ThemeChrome::default(),
            registry,
            default_text_size: None,
            default_font: None,
            window_id: "",
            scale_factor: 1.0,
            validate_props: crate::validate::is_validate_props_enabled(),
        }
    }

    fn render_prepared(mut node: TreeNode) {
        let mut caches: SharedState = SharedState::new();
        let images = ImageRegistry::new();
        let theme = iced::Theme::Dark;
        let mut registry = smoke_registry();
        registry.prepare_walk(&mut node, &mut caches, &theme);
        let ctx = smoke_ctx(&caches, &images, &theme, &registry);
        let _elem = render(&node, ctx);
    }

    #[test]
    fn render_smoke_text() {
        let node = smoke_node("t", "text", serde_json::json!({"content": "hello"}));
        render_prepared(node);
    }

    #[test]
    fn render_smoke_column_empty() {
        let node = smoke_node("c", "column", serde_json::json!({}));
        render_prepared(node);
    }

    #[test]
    fn render_smoke_row_empty() {
        let node = smoke_node("r", "row", serde_json::json!({}));
        render_prepared(node);
    }

    #[test]
    fn render_smoke_container_with_child() {
        let node = smoke_node_with_children(
            "ct",
            "container",
            serde_json::json!({}),
            vec![smoke_text_child()],
        );
        render_prepared(node);
    }

    #[test]
    fn render_smoke_button_with_child() {
        let node = smoke_node_with_children(
            "btn",
            "button",
            serde_json::json!({}),
            vec![smoke_text_child()],
        );
        render_prepared(node);
    }

    #[test]
    fn render_smoke_checkbox() {
        let node = smoke_node(
            "cb",
            "checkbox",
            serde_json::json!({"label": "Accept", "checked": true}),
        );
        render_prepared(node);
    }

    #[test]
    fn render_smoke_space() {
        let node = smoke_node("sp", "space", serde_json::json!({}));
        render_prepared(node);
    }

    #[test]
    fn render_smoke_rule() {
        let node = smoke_node("rl", "rule", serde_json::json!({"direction": "horizontal"}));
        render_prepared(node);
    }

    #[test]
    fn render_smoke_progress_bar() {
        let node = smoke_node(
            "pb",
            "progress_bar",
            serde_json::json!({"value": 50.0, "min": 0.0, "max": 100.0}),
        );
        render_prepared(node);
    }

    #[test]
    fn render_smoke_slider() {
        let node = smoke_node(
            "sl",
            "slider",
            serde_json::json!({"min": 0.0, "max": 100.0, "value": 50.0}),
        );
        render_prepared(node);
    }

    #[test]
    fn render_smoke_text_input() {
        let node = smoke_node(
            "ti",
            "text_input",
            serde_json::json!({"placeholder": "Type here", "value": ""}),
        );
        render_prepared(node);
    }

    #[test]
    fn render_smoke_toggler() {
        let node = smoke_node("tg", "toggler", serde_json::json!({"is_toggled": false}));
        render_prepared(node);
    }

    #[test]
    fn render_smoke_stack_empty() {
        let node = smoke_node("st", "stack", serde_json::json!({}));
        render_prepared(node);
    }

    // -----------------------------------------------------------------------
    // Error path tests: unknown type and missing props
    // -----------------------------------------------------------------------

    #[test]
    fn render_unknown_type_returns_element_without_panic() {
        let node = smoke_node("unk", "definitely_not_a_widget", serde_json::json!({}));
        let caches: SharedState = SharedState::new();
        let images = ImageRegistry::new();
        let theme = iced::Theme::Dark;
        let registry = smoke_registry();
        let ctx = smoke_ctx(&caches, &images, &theme, &registry);
        // Should produce the empty container fallback, not panic.
        let _elem = render(&node, ctx);
    }

    #[test]
    fn render_text_input_missing_props_does_not_panic() {
        let node = smoke_node("ti_empty", "text_input", serde_json::json!({}));
        render_prepared(node);
    }

    // -----------------------------------------------------------------------
    // A11y auto-inference tests
    // -----------------------------------------------------------------------

    /// Helper: extract auto-inferred overrides the same way render() does,
    /// without actually rendering (avoids needing image handles etc.).
    fn infer_a11y_overrides(node: &TreeNode) -> Option<crate::a11y::A11yOverrides> {
        let props = &node.props;
        let registry = smoke_registry();
        let inferred = registry.infer_a11y_for_node(node);
        let explicit = crate::a11y::A11yOverrides::from_props(props);
        match (inferred, explicit) {
            (Some(inf), Some(exp)) => Some(crate::a11y::A11yOverrides::merge(&inf, &exp)),
            (Some(inf), None) => Some(inf),
            (None, Some(exp)) => Some(exp),
            (None, None) => None,
        }
    }

    #[test]
    fn a11y_image_alt_uses_native_iced_method_not_override() {
        // Image/SVG alt text is handled by iced's native .alt() method,
        // not by A11yOverride wrapping. No override should be created.
        let node = smoke_node(
            "img1",
            "image",
            serde_json::json!({"source": "logo.png", "alt": "Company logo"}),
        );
        assert!(
            infer_a11y_overrides(&node).is_none(),
            "image with alt should NOT get A11yOverride (uses native .alt())"
        );
    }

    #[test]
    fn a11y_svg_alt_uses_native_iced_method_not_override() {
        let node = smoke_node(
            "svg1",
            "svg",
            serde_json::json!({"source": "icon.svg", "alt": "Settings icon"}),
        );
        assert!(
            infer_a11y_overrides(&node).is_none(),
            "svg with alt should NOT get A11yOverride (uses native .alt())"
        );
    }

    #[test]
    fn a11y_auto_infer_text_input_placeholder_as_description() {
        let node = smoke_node(
            "ti1",
            "text_input",
            serde_json::json!({"placeholder": "Search...", "value": ""}),
        );
        let overrides =
            infer_a11y_overrides(&node).expect("should infer overrides from placeholder");
        assert_eq!(overrides.description(), Some("Search..."));
        assert!(overrides.label().is_none());
    }

    #[test]
    fn a11y_explicit_overrides_take_precedence_over_alt() {
        let node = smoke_node(
            "img2",
            "image",
            serde_json::json!({
                "source": "logo.png",
                "alt": "Auto alt",
                "a11y": {"label": "Explicit label"}
            }),
        );
        let overrides = infer_a11y_overrides(&node).expect("should have explicit overrides");
        // Explicit label wins; no double-wrapping.
        assert_eq!(overrides.label(), Some("Explicit label"));
    }

    #[test]
    fn a11y_text_uses_native_text_operation_without_override() {
        let node = smoke_node("txt1", "text", serde_json::json!({"content": "hello"}));
        assert!(
            infer_a11y_overrides(&node).is_none(),
            "text should not get a wrapper role"
        );
    }

    #[test]
    fn a11y_no_wrapping_image_without_alt() {
        let node = smoke_node(
            "img3",
            "image",
            serde_json::json!({"source": "decorative.png"}),
        );
        assert!(
            infer_a11y_overrides(&node).is_none(),
            "image without alt should not get a11y wrapping"
        );
    }

    #[test]
    fn a11y_auto_infer_combo_box_placeholder_as_description() {
        let node = smoke_node(
            "cb1",
            "combo_box",
            serde_json::json!({"placeholder": "Select an option...", "value": ""}),
        );
        let overrides =
            infer_a11y_overrides(&node).expect("should infer overrides from placeholder");
        assert_eq!(overrides.description(), Some("Select an option..."));
        assert!(overrides.label().is_none());
    }

    #[test]
    fn a11y_auto_infer_pick_list_placeholder_as_description() {
        let node = smoke_node(
            "pick1",
            "pick_list",
            serde_json::json!({"placeholder": "Choose one", "options": ["A", "B"]}),
        );
        let overrides =
            infer_a11y_overrides(&node).expect("should infer overrides from placeholder");
        assert_eq!(overrides.description(), Some("Choose one"));
    }

    #[test]
    fn a11y_auto_infer_text_editor_placeholder_as_description() {
        let node = smoke_node(
            "te1",
            "text_editor",
            serde_json::json!({"placeholder": "Write something..."}),
        );
        let overrides =
            infer_a11y_overrides(&node).expect("should infer overrides from placeholder");
        assert_eq!(overrides.description(), Some("Write something..."));
        assert!(overrides.label().is_none());
    }

    #[test]
    fn a11y_combo_box_without_placeholder_declares_has_popup() {
        // combo_box always declares `has_popup: Listbox` regardless of
        // placeholder so screen readers announce the popup affordance
        // even when no description is set. The native role still drives
        // the announcement; the override only adds the popup hint.
        let node = smoke_node("cb2", "combo_box", serde_json::json!({"value": "selected"}));
        let overrides = infer_a11y_overrides(&node).expect("combo_box always declares has_popup");
        assert!(overrides.label().is_none());
        assert!(overrides.description().is_none());
        assert_eq!(
            overrides.core().has_popup,
            Some(plushie_core::types::HasPopup::Listbox)
        );
    }

    #[test]
    fn a11y_text_input_without_placeholder_uses_native_role() {
        let node = smoke_node(
            "ti2",
            "text_input",
            serde_json::json!({"value": "typed text"}),
        );
        assert!(
            infer_a11y_overrides(&node).is_none(),
            "text_input should not get a wrapper role"
        );
    }

    #[test]
    fn a11y_explicit_label_merges_with_inferred_description() {
        // Before the merge fix, an explicit `a11y.label` on a text_input
        // would discard the inferred description from the placeholder.
        // After the fix, both survive on the merged result.
        let node = smoke_node(
            "search",
            "text_input",
            serde_json::json!({
                "placeholder": "Search...",
                "a11y": {"label": "Global search"}
            }),
        );
        let overrides = infer_a11y_overrides(&node)
            .expect("merged overrides should be present when either side sets fields");
        assert_eq!(
            overrides.label(),
            Some("Global search"),
            "explicit label should win"
        );
        assert_eq!(
            overrides.description(),
            Some("Search..."),
            "inferred description should survive merge"
        );
    }

    #[test]
    fn a11y_does_not_infer_role_for_tooltip_wrapper() {
        let node = smoke_node_with_children(
            "help",
            "tooltip",
            serde_json::json!({"tip": "More details"}),
            vec![smoke_text_child()],
        );
        assert!(
            infer_a11y_overrides(&node).is_none(),
            "tooltip has its own iced a11y relationship"
        );
    }

    #[test]
    fn a11y_does_not_infer_roles_for_native_or_pass_through_widgets() {
        // Native widgets must not get an inferred *role* override
        // because iced already drives their accessible role. Other
        // inferred fields (placeholder->description, value, has_popup)
        // are fine; this guard only checks role.
        for type_name in [
            "button",
            "checkbox",
            "column",
            "combo_box",
            "container",
            "floating",
            "float",
            "grid",
            "overlay",
            "pane_grid",
            "pick_list",
            "pin",
            "pointer_area",
            "progress_bar",
            "radio",
            "responsive",
            "row",
            "rule",
            "scrollable",
            "sensor",
            "slider",
            "stack",
            "themer",
            "text_editor",
            "text_input",
            "toggler",
            "vertical_slider",
            "window",
            "rich",
            "rich_text",
            "text",
        ] {
            let node = smoke_node_with_children(
                type_name,
                type_name,
                serde_json::json!({}),
                vec![smoke_text_child()],
            );
            let overrides = infer_a11y_overrides(&node);
            let inferred_role = overrides.as_ref().and_then(|o| o.role());
            assert!(
                inferred_role.is_none(),
                "{type_name} should not get an inferred wrapper role; got {:?}",
                inferred_role
            );
        }
    }

    #[test]
    fn a11y_does_not_infer_roles_for_widgets_with_custom_a11y() {
        for (type_name, props) in [
            (
                "canvas",
                serde_json::json!({"role": "image", "alt": "Chart"}),
            ),
            ("table", serde_json::json!({"columns": []})),
        ] {
            let node = smoke_node(type_name, type_name, props);
            assert!(
                infer_a11y_overrides(&node).is_none(),
                "{type_name} owns its accessible nodes"
            );
        }
    }

    #[test]
    fn a11y_explicit_role_is_preserved() {
        let node = smoke_node(
            "save",
            "button",
            serde_json::json!({
                "a11y": {"role": "link"}
            }),
        );
        let overrides = infer_a11y_overrides(&node).expect("explicit role should be preserved");
        assert_eq!(overrides.core().role, Some(Role::Link));
    }

    #[test]
    fn a11y_auto_infer_button_mnemonic() {
        let node = smoke_node(
            "save",
            "button",
            serde_json::json!({"label": "Save", "mnemonic": "S"}),
        );
        let overrides = infer_a11y_overrides(&node).expect("should infer mnemonic");

        assert_eq!(overrides.core().mnemonic, Some('S'));
    }

    #[test]
    fn a11y_auto_infer_access_key_alias() {
        let node = smoke_node(
            "remember",
            "checkbox",
            serde_json::json!({"label": "Remember me", "access_key": "R"}),
        );
        let overrides = infer_a11y_overrides(&node).expect("should infer access key");

        assert_eq!(overrides.core().mnemonic, Some('R'));
    }

    #[test]
    fn a11y_top_level_mnemonic_wins_over_access_key() {
        let node = smoke_node(
            "choice",
            "radio",
            serde_json::json!({"value": "yes", "mnemonic": "Y", "access_key": "N"}),
        );
        let overrides = infer_a11y_overrides(&node).expect("should infer mnemonic");

        assert_eq!(overrides.core().mnemonic, Some('Y'));
    }

    #[test]
    fn a11y_explicit_mnemonic_wins_over_top_level_prop() {
        let node = smoke_node(
            "save",
            "button",
            serde_json::json!({
                "label": "Save",
                "mnemonic": "S",
                "a11y": {"mnemonic": "V"}
            }),
        );
        let overrides = infer_a11y_overrides(&node).expect("should merge mnemonic overrides");

        assert_eq!(overrides.core().mnemonic, Some('V'));
    }
}