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
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
// SPDX-FileCopyrightText: Copyright (c) 2026 Mike Li/Mikewolfli/Wei Li(mikewolfli@163.com)
// SPDX-License-Identifier: MIT
//! Shared backend state model used by platform adapters.
use super::{DropEvent, EchoMode, WidgetTriggerEvent, WidgetTriggerKind, WindowStateFlag};
use crate::compat::lock;
use crate::compat::HashMap;
use crate::compat::Mutex;
use crate::compat::String;
use crate::compat::ToString;
use crate::core::ObjectId;
use crate::core::Orientation;
use crate::core::Rect;
use alloc::collections::VecDeque;
use core::hash::Hash;
use core::sync::atomic::{AtomicU64, Ordering};
/// Generic widget state record owned by backend state model.
#[cfg(all(feature = "serde", widgets_unstripped))]
use serde::{Deserialize, Serialize};
/// The platform-neutral state a backend keeps for one widget handle.
///
/// `K` is the backend's own handle-kind discriminator; the record itself is
/// written by the shared accessors in the stub backend and by any OS
/// adapter, so the accessors read back what they were told to set rather than
/// querying an OS control. Optional fields follow the convention described on
/// each: `None` means "this control has no such concept here", never "zero".
#[derive(Clone, Debug)]
#[cfg_attr(all(feature = "serde", widgets_unstripped), derive(Serialize, Deserialize))]
pub struct WidgetRecord<K> {
/// Backend-specific widget kind discriminator.
pub kind: K,
/// Widget text/content payload.
pub text: String,
/// Visibility state.
pub visible: bool,
/// Enabled/disabled state.
pub enabled: bool,
/// IME enabled state.
pub ime_enabled: bool,
/// Accessibility label.
pub accessibility_name: String,
/// Geometry origin x.
pub x: i32,
/// Geometry origin y.
pub y: i32,
/// Geometry width.
pub width: u32,
/// Geometry height.
pub height: u32,
/// Primary numeric value for value-carrying controls (slider, progress bar,
/// spin box, scroll bar, dial). `None` means "this widget has no numeric
/// value", which is distinct from `Some(0.0)` — a backend must not invent a
/// value for a control that has none (principle #37).
pub value: Option<f64>,
/// `(min, max)` range of [`WidgetRecord::value`], when the control has one.
pub range: Option<(f64, f64)>,
/// Current selection index for selection-model controls (combo box, list
/// box, tab widget). `None` means "nothing selected" or "no selection
/// model".
pub selected_index: Option<usize>,
/// Checked state for checkable controls (check box, radio button, toggle
/// button). `None` means the control is not checkable on this backend.
pub checked: Option<bool>,
/// Increment step for value controls with a settable stride (slider, spin
/// box, scroll bar). `None` means the control has no settable step here.
pub step: Option<f64>,
/// Indeterminate (busy) state for progress-style controls. `None` means the
/// control has no indeterminate mode here.
pub indeterminate: Option<bool>,
/// Read-only state for text-entry controls. `None` means the control is not
/// a text entry here.
pub read_only: Option<bool>,
/// Maximum accepted character count for text-entry controls. `None` means the
/// control has no settable limit here.
pub max_length: Option<u32>,
/// Window state flags for window handles (maximised, minimised, full-screen,
/// resizable, decorated). `None` means the widget is not a window on this
/// backend, which is what keeps `is_window_in_state` honest for controls.
pub window_state: Option<WindowStateRecord>,
/// Text-entry selection range as `(start, end)` character offsets. `None`
/// means nothing is selected (or the control has no selectable text).
pub selection: Option<(u32, u32)>,
/// Placeholder (cue) text for a text entry. `None` until one is set.
pub placeholder: Option<String>,
/// Echo mode for a text entry, when the backend can apply one.
pub echo_mode: Option<EchoMode>,
/// Tri-state mode for a checkable control. `None` means the control is not
/// checkable, or this backend has no tri-state support.
pub tristate: Option<bool>,
/// Mutually-exclusive group name for a radio button.
pub group: Option<String>,
/// Scroll offset of a scrollable container, as `(x, y)` virtual pixels.
pub scroll: Option<(i32, i32)>,
/// Slider orientation chosen at creation time, stored as "horizontal".
///
/// Kept as a `bool` rather than `core::Orientation` so this serde-derived
/// record does not force a serde derive onto a core geometry type (the
/// `BackendState` snapshot is serialized, and widening `core`'s feature
/// surface for one field is not worth it).
pub horizontal: Option<bool>,
}
/// The togglable states of a window, as stored by a backend.
///
/// Captured as a small record instead of five parallel `Option<bool>` fields so
/// the whole window state travels together and cannot drift out of sync. It also
/// carries the two non-boolean window attributes (minimum size, icon path), which
/// share the "is this a window?" gate that `WidgetRecord::window_state` provides.
#[derive(Clone, Debug, PartialEq, Eq)]
#[cfg_attr(all(feature = "serde", widgets_unstripped), derive(Serialize, Deserialize))]
pub struct WindowStateRecord {
/// Window is maximised rather than restored.
pub maximized: bool,
/// Window is minimised.
pub minimized: bool,
/// Window is full-screen.
pub fullscreen: bool,
/// Window is user-resizable.
pub resizable: bool,
/// Window is OS-decorated.
pub decorated: bool,
/// Minimum content size. `None` until the caller sets one, so a read can tell
/// "no explicit constraint" from a real request.
pub min_size: Option<(u32, u32)>,
/// Icon path supplied to `set_window_icon`. `None` until set.
pub icon: Option<String>,
}
impl WindowStateRecord {
/// The state a freshly created OS window starts in: restored, windowed,
/// resizable, decorated, with no explicit minimum size and no icon.
///
/// This is the single source of truth for window defaults — every backend's
/// `create_window` uses it, so a new field cannot be added in one place and
/// silently left unset in another.
pub fn new_window() -> Self {
Self {
maximized: false,
minimized: false,
fullscreen: false,
resizable: true,
decorated: true,
min_size: None,
icon: None,
}
}
/// Read one flag.
pub fn get(&self, flag: WindowStateFlag) -> bool {
match flag {
WindowStateFlag::Maximized => self.maximized,
WindowStateFlag::Minimized => self.minimized,
WindowStateFlag::Fullscreen => self.fullscreen,
WindowStateFlag::Resizable => self.resizable,
WindowStateFlag::Decorated => self.decorated,
}
}
/// Write one flag.
pub fn set(&mut self, flag: WindowStateFlag, on: bool) {
match flag {
WindowStateFlag::Maximized => self.maximized = on,
WindowStateFlag::Minimized => self.minimized = on,
WindowStateFlag::Fullscreen => self.fullscreen = on,
WindowStateFlag::Resizable => self.resizable = on,
WindowStateFlag::Decorated => self.decorated = on,
}
}
}
impl Default for WindowStateRecord {
fn default() -> Self {
Self::new_window()
}
}
/// Converts a [`Rect`] to the four primitives the surface map stores.
///
/// See `BackendState::surfaces` for why the rect is not stored as a `Rect`.
fn rect_to_tuple(rect: Rect) -> (i32, i32, u32, u32) {
(rect.x, rect.y, rect.width, rect.height)
}
/// Thread-safe state model split from native handle adapters.
#[cfg_attr(all(feature = "serde", widgets_unstripped), derive(Serialize, Deserialize))]
pub struct BackendState<K> {
next_id: AtomicU64,
widgets: Mutex<HashMap<ObjectId, WidgetRecord<K>>>,
menu_events: Mutex<VecDeque<ObjectId>>,
widget_events: Mutex<VecDeque<WidgetTriggerEvent>>,
clipboard_text: Mutex<String>,
drop_events: Mutex<VecDeque<DropEvent>>,
/// Widgets this host is displaying, with the rect each surface covers.
///
/// A state-only backend has no native object per control (every `WidgetKind` is
/// painted by the library), so "is it displayed?" is exactly this map. The host
/// still owns the pixels and pulls them via `widget::runtime::render_frame`.
///
/// Stored as primitives rather than [`Rect`] because this struct is serialized by
/// the iOS/Android backends, and `Rect` deliberately carries no serde derive
/// (widening `core`'s feature surface for one field is not worth it).
surfaces: Mutex<HashMap<ObjectId, (i32, i32, u32, u32)>>,
/// Widgets whose pixels changed since the host last asked.
///
/// A queue rather than a flag set: the host drains it in order, and coalescing on
/// insert keeps a burst of invalidations from producing a burst of repaints.
pending_repaints: Mutex<VecDeque<ObjectId>>,
}
impl<K> Default for BackendState<K>
where
K: Copy + Eq + Hash,
{
fn default() -> Self {
Self::new()
}
}
impl<K> BackendState<K>
where
K: Copy + Eq + Hash,
{
#[cfg(feature = "serde_json")]
/// Serialize widget text snapshots without exposing synchronization primitives or id counters.
pub fn serialize_widget_snapshot(&self) -> Result<String, serde_json::Error> {
let texts: Vec<String> =
lock(&self.widgets).values().map(|record| record.text.clone()).collect();
serde_json::to_string(&texts)
}
/// Create empty backend state.
pub fn new() -> Self {
Self {
next_id: AtomicU64::new(1),
widgets: Mutex::new(HashMap::new()),
menu_events: Mutex::new(VecDeque::new()),
widget_events: Mutex::new(VecDeque::new()),
clipboard_text: Mutex::new(String::new()),
drop_events: Mutex::new(VecDeque::new()),
surfaces: Mutex::new(HashMap::new()),
pending_repaints: Mutex::new(VecDeque::new()),
}
}
// -----------------------------------------------------------------------
// Widget surfaces
// -----------------------------------------------------------------------
/// Records that `id` is displayed on a host surface covering `rect`.
///
/// The host owns the pixels; this records only *which* widgets the host agreed
/// to display and where. `mount_surface` returns this, and
/// [`BackendState::invalidate_surface_record`] queues a repaint the host drains
/// through [`BackendState::take_pending_repaint`].
///
/// Refuses an unknown `id`: a surface for a widget that does not exist could only
/// produce a frame nobody reads, so reporting `false` is the honest answer.
pub fn mount_surface_record(&self, id: ObjectId, rect: Rect) -> bool {
if !self.contains_widget(id) {
return false;
}
let mut surfaces = lock(&self.surfaces);
surfaces.insert(id, rect_to_tuple(rect));
true
}
/// Forgets the surface for `id`. Returns whether one was recorded.
pub fn unmount_surface_record(&self, id: ObjectId) -> bool {
let removed = lock(&self.surfaces).remove(&id).is_some();
if removed {
// A repaint request for a widget that is gone would make the host ask for
// a frame that can never be produced.
lock(&self.pending_repaints).retain(|&pending| pending != id);
}
removed
}
/// Updates the rect of a mounted surface. Returns whether `id` was mounted.
pub fn resize_surface_record(&self, id: ObjectId, rect: Rect) -> bool {
let mut surfaces = lock(&self.surfaces);
match surfaces.get_mut(&id) {
Some(existing) => {
*existing = rect_to_tuple(rect);
true
}
None => false,
}
}
/// Returns the rect of a mounted surface, or `None` when `id` is not mounted.
pub fn surface_rect(&self, id: ObjectId) -> Option<Rect> {
lock(&self.surfaces).get(&id).map(|&(x, y, width, height)| Rect::new(x, y, width, height))
}
/// Queues a repaint for `id` and reports whether it was mounted.
///
/// The queue is drained by the host, which is the only party that can put the
/// pixels on screen. Coalesced: a widget already awaiting a repaint is not queued
/// again, so a burst of invalidations in one frame produces one repaint.
pub fn invalidate_surface_record(&self, id: ObjectId) -> bool {
if self.surface_rect(id).is_none() {
return false;
}
let mut pending = lock(&self.pending_repaints);
if !pending.contains(&id) {
pending.push_back(id);
}
true
}
/// Removes and returns the next widget awaiting a repaint.
pub fn take_pending_repaint(&self) -> Option<ObjectId> {
lock(&self.pending_repaints).pop_front()
}
/// Returns how many widgets are awaiting a repaint.
pub fn pending_repaint_count(&self) -> usize {
lock(&self.pending_repaints).len()
}
/// Returns how many surfaces this host is displaying.
pub fn mounted_surface_count(&self) -> usize {
lock(&self.surfaces).len()
}
/// Insert one widget record and return allocated logical id.
pub fn create_widget(
&self,
kind: K,
text: &str,
x: i32,
y: i32,
width: u32,
height: u32,
) -> ObjectId {
let id = self.next_id.fetch_add(1, Ordering::Relaxed);
self.insert_widget(id, kind, text, x, y, width, height);
id
}
/// Insert one widget record under a **caller-chosen** id.
///
/// Used by self-drawn mounts: the id originates in
/// `widget::runtime`, which owns the widget, so the backend state
/// has to adopt it rather than allocate its own. Also advances the internal
/// allocator past `id` so a later `create_widget` cannot collide with it.
pub fn register_widget_with_id(
&self,
id: ObjectId,
kind: K,
text: &str,
x: i32,
y: i32,
width: u32,
height: u32,
) {
self.insert_widget(id, kind, text, x, y, width, height);
// Keep the allocator ahead of any externally supplied id.
let mut next = self.next_id.load(Ordering::Relaxed);
while next <= id {
match self.next_id.compare_exchange(next, id + 1, Ordering::Relaxed, Ordering::Relaxed)
{
Ok(_) => break,
Err(current) => next = current,
}
}
}
/// Shared insert used by both creation paths.
fn insert_widget(
&self,
id: ObjectId,
kind: K,
text: &str,
x: i32,
y: i32,
width: u32,
height: u32,
) {
lock(&self.widgets).insert(
id,
WidgetRecord {
kind,
text: text.to_string(),
visible: true,
enabled: true,
ime_enabled: true,
accessibility_name: text.to_string(),
x,
y,
width,
height,
value: None,
range: None,
selected_index: None,
checked: None,
step: None,
indeterminate: None,
read_only: None,
max_length: None,
window_state: None,
selection: None,
placeholder: None,
echo_mode: None,
tristate: None,
group: None,
scroll: None,
horizontal: None,
},
);
}
/// Return `true` when widget exists.
pub fn contains_widget(&self, widget_id: ObjectId) -> bool {
lock(&self.widgets).contains_key(&widget_id)
}
/// Remove a widget record, returning `true` when it existed.
///
/// This is the state-side half of widget teardown. Without it a backend's
/// registry could only ever grow: a long-running app that rebuilds its UI
/// (create/discard cycles) would leak one record — plus whatever native
/// object the backend stored — per discarded widget, forever.
pub fn destroy_widget(&self, widget_id: ObjectId) -> bool {
lock(&self.widgets).remove(&widget_id).is_some()
}
/// Number of live widget records. Used by tests and diagnostics to prove
/// that teardown actually releases state.
pub fn widget_count(&self) -> usize {
lock(&self.widgets).len()
}
/// Return kind for an existing widget.
pub fn kind_of(&self, widget_id: ObjectId) -> Option<K> {
lock(&self.widgets).get(&widget_id).map(|widget| widget.kind)
}
/// Return `true` when widget exists and kind matches.
pub fn is_kind(&self, widget_id: ObjectId, kind: K) -> bool {
self.kind_of(widget_id).map(|k| k == kind).unwrap_or(false)
}
/// Set visibility for a widget.
pub fn set_visible(&self, widget_id: ObjectId, visible: bool) {
if let Some(widget) = lock(&self.widgets).get_mut(&widget_id) {
widget.visible = visible;
}
}
/// Return visibility for a widget.
pub fn visible(&self, widget_id: ObjectId) -> bool {
lock(&self.widgets).get(&widget_id).map(|widget| widget.visible).unwrap_or(false)
}
/// Set enabled state for a widget.
pub fn set_enabled(&self, widget_id: ObjectId, enabled: bool) {
if let Some(widget) = lock(&self.widgets).get_mut(&widget_id) {
widget.enabled = enabled;
}
}
/// Return enabled state for a widget.
pub fn enabled(&self, widget_id: ObjectId) -> bool {
lock(&self.widgets).get(&widget_id).map(|widget| widget.enabled).unwrap_or(false)
}
/// Set geometry for a widget.
pub fn set_geometry(&self, widget_id: ObjectId, x: i32, y: i32, width: u32, height: u32) {
if let Some(widget) = lock(&self.widgets).get_mut(&widget_id) {
widget.x = x;
widget.y = y;
widget.width = width;
widget.height = height;
}
}
/// Set text for a widget.
pub fn set_text(&self, widget_id: ObjectId, text: &str) -> bool {
if let Some(widget) = lock(&self.widgets).get_mut(&widget_id) {
widget.text = text.to_string();
return true;
}
false
}
/// Return text for a widget.
pub fn text(&self, widget_id: ObjectId) -> String {
lock(&self.widgets).get(&widget_id).map(|widget| widget.text.clone()).unwrap_or_default()
}
/// Set IME enabled state for a widget.
pub fn set_ime_enabled(&self, widget_id: ObjectId, enabled: bool) -> bool {
if let Some(widget) = lock(&self.widgets).get_mut(&widget_id) {
widget.ime_enabled = enabled;
return true;
}
false
}
/// Return IME enabled state for a widget.
pub fn ime_enabled(&self, widget_id: ObjectId) -> bool {
lock(&self.widgets).get(&widget_id).map(|widget| widget.ime_enabled).unwrap_or(false)
}
/// Set accessibility label for a widget.
pub fn set_accessibility_name(&self, widget_id: ObjectId, name: &str) -> bool {
if let Some(widget) = lock(&self.widgets).get_mut(&widget_id) {
widget.accessibility_name = name.to_string();
return true;
}
false
}
/// Return accessibility label for a widget.
pub fn accessibility_name(&self, widget_id: ObjectId) -> String {
lock(&self.widgets)
.get(&widget_id)
.map(|widget| widget.accessibility_name.clone())
.unwrap_or_default()
}
// ─── Uniform property storage ────────────────────────────────────────────
//
// These accessors back `Platform::{set_widget_value, set_widget_range,
// set_widget_selected_index, set_widget_checked, ...}`. A backend whose
// native control is the source of truth (macOS/Windows/GTK) writes through
// to the control and *also* mirrors here, so off-main calls and teardown
// still observe a consistent value. A state-only backend reads straight from
// this record.
//
// A record only ever holds a property for a control that actually has one —
// `None` means "this backend's control has no such property", which is why
// the setters below are never called by a backend for an unsupported
// control.
/// Store a widget's numeric value, returning `false` for an unknown id.
pub fn set_value(&self, widget_id: ObjectId, value: f64) -> bool {
if let Some(widget) = lock(&self.widgets).get_mut(&widget_id) {
widget.value = Some(value);
return true;
}
false
}
/// Return a widget's numeric value, or `None` when it has none.
pub fn value(&self, widget_id: ObjectId) -> Option<f64> {
lock(&self.widgets).get(&widget_id).and_then(|widget| widget.value)
}
/// Store a widget's `(min, max)` range, returning `false` for an unknown id.
pub fn set_range(&self, widget_id: ObjectId, min: f64, max: f64) -> bool {
if let Some(widget) = lock(&self.widgets).get_mut(&widget_id) {
widget.range = Some((min, max));
// Keep the stored value inside the new range, mirroring what every
// native control does when its range shrinks under the current value.
if let Some(value) = widget.value {
widget.value = Some(value.clamp(min.min(max), max.max(min)));
}
return true;
}
false
}
/// Return a widget's `(min, max)` range, or `None` when it has none.
pub fn range(&self, widget_id: ObjectId) -> Option<(f64, f64)> {
lock(&self.widgets).get(&widget_id).and_then(|widget| widget.range)
}
/// Store a widget's selection index, returning `false` for an unknown id.
pub fn set_selected_index(&self, widget_id: ObjectId, index: Option<usize>) -> bool {
if let Some(widget) = lock(&self.widgets).get_mut(&widget_id) {
widget.selected_index = index;
return true;
}
false
}
/// Return a widget's selection index, or `None` when nothing is selected.
pub fn selected_index(&self, widget_id: ObjectId) -> Option<usize> {
lock(&self.widgets).get(&widget_id).and_then(|widget| widget.selected_index)
}
/// Store a widget's checked state, returning `false` for an unknown id.
pub fn set_checked(&self, widget_id: ObjectId, checked: bool) -> bool {
if let Some(widget) = lock(&self.widgets).get_mut(&widget_id) {
widget.checked = Some(checked);
return true;
}
false
}
/// Return a widget's checked state, or `None` when it is not checkable.
pub fn checked(&self, widget_id: ObjectId) -> Option<bool> {
lock(&self.widgets).get(&widget_id).and_then(|widget| widget.checked)
}
/// Store a widget's increment step, returning `false` for an unknown id.
pub fn set_step(&self, widget_id: ObjectId, step: f64) -> bool {
if let Some(widget) = lock(&self.widgets).get_mut(&widget_id) {
widget.step = Some(step);
return true;
}
false
}
/// Return a widget's increment step, or `None` when it has none.
pub fn step(&self, widget_id: ObjectId) -> Option<f64> {
lock(&self.widgets).get(&widget_id).and_then(|widget| widget.step)
}
/// Store a widget's indeterminate state, returning `false` for an unknown id.
pub fn set_indeterminate(&self, widget_id: ObjectId, indeterminate: bool) -> bool {
if let Some(widget) = lock(&self.widgets).get_mut(&widget_id) {
widget.indeterminate = Some(indeterminate);
return true;
}
false
}
/// Return a widget's indeterminate state, or `None` when it has none.
pub fn indeterminate(&self, widget_id: ObjectId) -> Option<bool> {
lock(&self.widgets).get(&widget_id).and_then(|widget| widget.indeterminate)
}
/// Store a widget's read-only state, returning `false` for an unknown id.
pub fn set_read_only(&self, widget_id: ObjectId, read_only: bool) -> bool {
if let Some(widget) = lock(&self.widgets).get_mut(&widget_id) {
widget.read_only = Some(read_only);
return true;
}
false
}
/// Return a widget's read-only state, or `None` when it has none.
pub fn read_only(&self, widget_id: ObjectId) -> Option<bool> {
lock(&self.widgets).get(&widget_id).and_then(|widget| widget.read_only)
}
/// Store a widget's maximum text length, returning `false` for an unknown id.
pub fn set_max_length(&self, widget_id: ObjectId, max_length: u32) -> bool {
if let Some(widget) = lock(&self.widgets).get_mut(&widget_id) {
widget.max_length = Some(max_length);
return true;
}
false
}
/// Return a widget's maximum text length, or `None` when it has none.
pub fn max_length(&self, widget_id: ObjectId) -> Option<u32> {
lock(&self.widgets).get(&widget_id).and_then(|widget| widget.max_length)
}
/// Mark a widget as a window and seed its initial window state.
///
/// Called by a backend's `create_window`. Until this runs the widget has
/// `window_state == None`, so `is_window_in_state` correctly reports "not a
/// window" for every non-window control.
pub fn init_window_state(&self, widget_id: ObjectId, initial: WindowStateRecord) -> bool {
if let Some(widget) = lock(&self.widgets).get_mut(&widget_id) {
widget.window_state = Some(initial);
return true;
}
false
}
/// Store one window state flag, returning `false` when the id is not a window.
pub fn set_window_state(&self, widget_id: ObjectId, flag: WindowStateFlag, on: bool) -> bool {
if let Some(widget) = lock(&self.widgets).get_mut(&widget_id) {
if let Some(state) = widget.window_state.as_mut() {
state.set(flag, on);
return true;
}
}
false
}
/// Read one window state flag, or `None` when the id is not a window.
pub fn window_state(&self, widget_id: ObjectId, flag: WindowStateFlag) -> Option<bool> {
lock(&self.widgets)
.get(&widget_id)
.and_then(|widget| widget.window_state.as_ref())
.map(|state| state.get(flag))
}
/// Store a window's minimum content size, returning `false` for a non-window.
pub fn set_window_min_size(&self, widget_id: ObjectId, width: u32, height: u32) -> bool {
if let Some(widget) = lock(&self.widgets).get_mut(&widget_id) {
if let Some(state) = widget.window_state.as_mut() {
state.min_size = Some((width, height));
return true;
}
}
false
}
/// Read a window's minimum content size, or `None` when it has none.
pub fn window_min_size(&self, widget_id: ObjectId) -> Option<(u32, u32)> {
lock(&self.widgets)
.get(&widget_id)
.and_then(|widget| widget.window_state.as_ref())
.and_then(|state| state.min_size)
}
/// Store a window's icon path, returning `false` for a non-window.
pub fn set_window_icon(&self, widget_id: ObjectId, path: &str) -> bool {
if let Some(widget) = lock(&self.widgets).get_mut(&widget_id) {
if let Some(state) = widget.window_state.as_mut() {
state.icon = Some(path.to_string());
return true;
}
}
false
}
/// Read a window's icon path, or `None` when it has none.
pub fn window_icon(&self, widget_id: ObjectId) -> Option<String> {
lock(&self.widgets)
.get(&widget_id)
.and_then(|widget| widget.window_state.as_ref())
.and_then(|state| state.icon.clone())
}
/// Store a text entry's selection range, returning `false` for unknown ids.
pub fn set_selection(&self, widget_id: ObjectId, start: u32, end: u32) -> bool {
if let Some(widget) = lock(&self.widgets).get_mut(&widget_id) {
widget.selection = Some((start, end));
return true;
}
false
}
/// Read a text entry's selection range, or `None` when nothing is selected.
pub fn selection(&self, widget_id: ObjectId) -> Option<(u32, u32)> {
lock(&self.widgets).get(&widget_id).and_then(|widget| widget.selection)
}
/// Store a text entry's placeholder text, returning `false` for unknown ids.
pub fn set_placeholder(&self, widget_id: ObjectId, text: &str) -> bool {
if let Some(widget) = lock(&self.widgets).get_mut(&widget_id) {
widget.placeholder = Some(text.to_string());
return true;
}
false
}
/// Read a text entry's placeholder text.
pub fn placeholder(&self, widget_id: ObjectId) -> Option<String> {
lock(&self.widgets).get(&widget_id).and_then(|widget| widget.placeholder.clone())
}
/// Store a text entry's echo mode, returning `false` for unknown ids.
pub fn set_echo_mode(&self, widget_id: ObjectId, mode: EchoMode) -> bool {
if let Some(widget) = lock(&self.widgets).get_mut(&widget_id) {
widget.echo_mode = Some(mode);
return true;
}
false
}
/// Read a text entry's echo mode.
pub fn echo_mode(&self, widget_id: ObjectId) -> Option<EchoMode> {
lock(&self.widgets).get(&widget_id).and_then(|widget| widget.echo_mode)
}
/// Store a checkable control's tri-state mode, `false` for unknown ids.
pub fn set_tristate(&self, widget_id: ObjectId, enabled: bool) -> bool {
if let Some(widget) = lock(&self.widgets).get_mut(&widget_id) {
widget.tristate = Some(enabled);
return true;
}
false
}
/// Read a checkable control's tri-state mode.
pub fn tristate(&self, widget_id: ObjectId) -> Option<bool> {
lock(&self.widgets).get(&widget_id).and_then(|widget| widget.tristate)
}
/// Store a radio button's group name, `false` for unknown ids.
pub fn set_group(&self, widget_id: ObjectId, group: &str) -> bool {
if let Some(widget) = lock(&self.widgets).get_mut(&widget_id) {
widget.group = Some(group.to_string());
return true;
}
false
}
/// Read a radio button's group name.
pub fn group(&self, widget_id: ObjectId) -> Option<String> {
lock(&self.widgets).get(&widget_id).and_then(|widget| widget.group.clone())
}
/// Store a scroll container's offset, `false` for unknown ids.
pub fn set_scroll(&self, widget_id: ObjectId, x: i32, y: i32) -> bool {
if let Some(widget) = lock(&self.widgets).get_mut(&widget_id) {
widget.scroll = Some((x, y));
return true;
}
false
}
/// Read a scroll container's offset.
pub fn scroll(&self, widget_id: ObjectId) -> Option<(i32, i32)> {
lock(&self.widgets).get(&widget_id).and_then(|widget| widget.scroll)
}
/// Store a slider's creation-time orientation, `false` for unknown ids.
pub fn set_orientation(&self, widget_id: ObjectId, orientation: Orientation) -> bool {
if let Some(widget) = lock(&self.widgets).get_mut(&widget_id) {
widget.horizontal = Some(orientation == Orientation::Horizontal);
return true;
}
false
}
/// Read a slider's creation-time orientation.
pub fn orientation(&self, widget_id: ObjectId) -> Option<Orientation> {
lock(&self.widgets).get(&widget_id).and_then(|widget| widget.horizontal).map(|horizontal| {
if horizontal {
Orientation::Horizontal
} else {
Orientation::Vertical
}
})
}
// ─── Backend event methods ─────────────────────────────────────────────────
// These methods provide event system integration for menu and widget trigger
// dispatch. They are called by the macos, mobile, and stub platform backends.
/// Push menu trigger event.
/// Reserved for menu system integration (not yet wired to platform backends).
pub fn push_menu_event(&self, item_id: ObjectId) {
lock(&self.menu_events).push_back(item_id);
}
/// Pop menu trigger event.
/// Reserved for menu system integration (paired with push_menu_event).
pub fn pop_menu_event(&self) -> Option<ObjectId> {
lock(&self.menu_events).pop_front()
}
/// Push typed widget trigger event.
/// Reserved for event system integration (not yet wired to platform backends).
pub fn push_widget_event(&self, event: WidgetTriggerEvent) {
lock(&self.widget_events).push_back(event);
}
/// Pop typed widget trigger event.
pub fn pop_widget_event(&self) -> Option<WidgetTriggerEvent> {
lock(&self.widget_events).pop_front()
}
/// Set clipboard text.
pub fn set_clipboard_text(&self, text: &str) -> bool {
*lock(&self.clipboard_text) = text.to_string();
true
}
/// Get clipboard text.
pub fn clipboard_text(&self) -> String {
lock(&self.clipboard_text).clone()
}
/// Begin drag event for existing source widget.
pub fn begin_drag(&self, source_widget_id: ObjectId, mime: &str, payload: &[u8]) -> bool {
if !self.contains_widget(source_widget_id) {
return false;
}
lock(&self.drop_events).push_back(DropEvent {
source_widget_id,
target_widget_id: 0, // Not yet known — target is determined at drop time
mime: mime.to_string(),
payload: payload.to_vec(),
});
true
}
/// Pop one drop event.
pub fn pop_drop_event(&self) -> Option<DropEvent> {
lock(&self.drop_events).pop_front()
}
/// Inject drop event when target widget exists.
pub fn inject_drop_event(&self, event: DropEvent) -> bool {
if !self.contains_widget(event.target_widget_id) {
return false;
}
lock(&self.drop_events).push_back(event);
true
}
// ─── Test/programmatic event injection ─────────────────────────────────────
// These helpers are called by the macos, mobile, and stub platform backends
// for event system bridge functions.
/// Inject menu trigger event.
/// Reserved for testing and programmatic event injection.
pub fn inject_menu_trigger(&self, menu_item_id: ObjectId) -> bool {
if !self.contains_widget(menu_item_id) {
return false;
}
self.push_menu_event(menu_item_id);
true
}
/// Pop widget trigger event.
/// Reserved for event processing in platform backends.
pub fn pop_widget_trigger(&self) -> Option<ObjectId> {
// Pop the widget_id from the widget_events queue (typed variant),
// extracting just the widget_id. This is the widget-side counterpart
// of push_widget_event / inject_widget_trigger_event.
self.pop_widget_event().map(|e| e.widget_id)
}
/// Pop typed widget trigger event.
/// Reserved for event processing in platform backends (typed variant).
pub fn pop_widget_trigger_event(&self) -> Option<WidgetTriggerEvent> {
self.pop_widget_event()
}
/// Inject widget trigger event.
/// Reserved for testing and programmatic event injection (typed variant).
pub fn inject_widget_trigger_event(
&self,
widget_id: ObjectId,
kind: WidgetTriggerKind,
) -> bool {
if !self.contains_widget(widget_id) {
return false;
}
self.push_widget_event(WidgetTriggerEvent { widget_id, kind });
true
}
/// The size `window_id` was created with, if it exists.
///
/// Used as the fallback behind a backend's `Platform::window_client_size`: a window
/// that has never been resized still has the dimensions it was created at, and
/// reporting those is honest where inventing a number would not be (principle #37).
/// The *reported* size lives with the control backend, which owns the window.
pub fn window_size(&self, window_id: ObjectId) -> Option<(u32, u32)> {
lock(&self.widgets).get(&window_id).map(|record| (record.width, record.height))
}
/// The full geometry `widget_id` was last given, if it exists.
///
/// A backend that resizes a window by rewriting its record (rather than by keeping a
/// separate client-size map) needs the origin to write back, because
/// [`BackendState::set_geometry`] takes all four numbers: dropping the origin would
/// move the window to `(0, 0)` as a side effect of resizing it.
pub fn widget_geometry(&self, widget_id: ObjectId) -> Option<(i32, i32, u32, u32)> {
lock(&self.widgets)
.get(&widget_id)
.map(|record| (record.x, record.y, record.width, record.height))
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn is_kind_returns_true_for_matching_kind() {
#[derive(Clone, Copy, PartialEq, Eq, Hash)]
#[cfg_attr(all(feature = "serde", widgets_unstripped), derive(Serialize, Deserialize))]
enum TestKind {
Button,
Label,
}
let state = BackendState::<TestKind>::new();
let id1 = state.create_widget(TestKind::Button, "Click", 0, 0, 100, 30);
let id2 = state.create_widget(TestKind::Label, "Name:", 0, 0, 50, 20);
assert!(state.is_kind(id1, TestKind::Button));
assert!(!state.is_kind(id1, TestKind::Label));
assert!(state.is_kind(id2, TestKind::Label));
assert!(!state.is_kind(id2, TestKind::Button));
}
#[test]
fn is_kind_returns_false_for_nonexistent_widget() {
#[derive(Clone, Copy, PartialEq, Eq, Hash)]
#[cfg_attr(all(feature = "serde", widgets_unstripped), derive(Serialize, Deserialize))]
enum TestKind {
Widget,
}
let state = BackendState::<TestKind>::new();
assert!(!state.is_kind(999, TestKind::Widget));
}
}