xrack-runtime 0.7.0

Runtime types, properties, models, and controls for generated XRack UI
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
use crate::{
    ChangeSignal, Length, ListMetrics, ListModel, Property, RowKey, TableRowPositions,
    TreeSnapshot, VecModel, list::MAX_ROWS,
};
use std::{
    cell::RefCell,
    collections::{BTreeMap, BTreeSet},
    rc::Rc,
    sync::Arc,
};

#[derive(Clone, Debug, PartialEq)]
struct RowHeight {
    index: usize,
    height: f32,
    delta: f64,
}

/// Sparse prefix sums for a virtual view's row heights.
#[derive(Debug, PartialEq)]
#[doc(hidden)]
pub struct RowHeights {
    base: f32,
    projected: Option<Arc<RowHeights>>,
    overrides: Vec<RowHeight>,
}

impl RowHeights {
    fn new(
        base: f32,
        sizes: impl IntoIterator<Item = (usize, f32)>,
        projected: Option<Arc<Self>>,
    ) -> Self {
        let mut overrides: Vec<_> = sizes
            .into_iter()
            .map(|(index, height)| RowHeight {
                index,
                height,
                delta: 0.0,
            })
            .collect();
        overrides.sort_by_key(|row| row.index);
        let mut prefix = 0.0;
        for row in &mut overrides {
            let previous = projected
                .as_ref()
                .map_or(base, |heights| heights.height(row.index));
            prefix += f64::from(row.height) - f64::from(previous);
            row.delta = prefix;
        }
        Self {
            base,
            projected,
            overrides,
        }
    }

    pub fn height(&self, index: usize) -> f32 {
        self.overrides
            .binary_search_by_key(&index, |row| row.index)
            .map_or_else(
                |_| {
                    self.projected
                        .as_ref()
                        .map_or(self.base, |heights| heights.height(index))
                },
                |slot| self.overrides[slot].height,
            )
    }

    pub fn top(&self, index: usize) -> f64 {
        let slot = self.overrides.partition_point(|row| row.index < index);
        let delta = slot
            .checked_sub(1)
            .map_or(0.0, |slot| self.overrides[slot].delta);
        self.projected.as_ref().map_or_else(
            || index as f64 * f64::from(self.base),
            |heights| heights.top(index),
        ) + delta
    }
}

struct ProjectionInput {
    stamp: (u64, u64),
    base: f32,
    tree: Option<Arc<TreeSnapshot>>,
    table_stamp: Option<(u64, u64)>,
}

type FieldUpdates = Rc<RefCell<BTreeMap<usize, Option<f32>>>>;

struct FieldObservation {
    model: u64,
    changed: Rc<ChangeSignal>,
    updates: FieldUpdates,
}

#[derive(Default)]
struct FieldHeights {
    stamp: Option<(u64, u64)>,
    values: BTreeMap<usize, f32>,
}

/// Tracks only the record field that controls layout.
#[derive(Default)]
#[doc(hidden)]
pub struct RowHeightProjection {
    input: RefCell<Option<ProjectionInput>>,
    input_changed: ChangeSignal,
    observation: RefCell<Option<FieldObservation>>,
    fields: RefCell<FieldHeights>,
    geometry: Property<Option<Arc<RowHeights>>>,
}

fn projected_height(value: Length) -> Option<f32> {
    (value.0.is_finite() && value.0 > 0.0).then(|| ListMetrics::clamp_row_height(value.0 as f32))
}

impl RowHeightProjection {
    /// Keep the field selector fixed for this projection's lifetime.
    pub fn snapshot<T: 'static>(
        &self,
        model: &VecModel<T>,
        base: f32,
        project: impl Fn(&T) -> Length + Clone + 'static,
    ) -> Option<Arc<RowHeights>> {
        self.project(model, base, None, None, project)
    }

    pub fn tree_snapshot<T: 'static>(
        &self,
        model: &VecModel<T>,
        base: f32,
        tree: &Arc<TreeSnapshot>,
        project: impl Fn(&T) -> Length + Clone + 'static,
    ) -> Option<Arc<RowHeights>> {
        self.project(model, base, Some(tree), None, project)
    }

    /// Project the same field in the current displayed row order.
    pub fn table_snapshot<T: 'static>(
        &self,
        model: &VecModel<T>,
        base: f32,
        positions: &TableRowPositions,
        project: impl Fn(&T) -> Length + Clone + 'static,
    ) -> Option<Arc<RowHeights>> {
        self.project(model, base, None, Some(positions), project)
    }

    fn project<T: 'static>(
        &self,
        model: &VecModel<T>,
        base: f32,
        tree: Option<&Arc<TreeSnapshot>>,
        table: Option<&TableRowPositions>,
        field: impl Fn(&T) -> Length + Clone + 'static,
    ) -> Option<Arc<RowHeights>> {
        let stamp = model.structure_stamp();
        let table_stamp = table.map(TableRowPositions::stamp);
        {
            let mut input = self.input.borrow_mut();
            if input.as_ref().is_none_or(|input| {
                input.stamp != stamp
                    || input.base != base
                    || !same_arc(input.tree.as_ref(), tree)
                    || input.table_stamp != table_stamp
            }) {
                *input = Some(ProjectionInput {
                    stamp,
                    base,
                    tree: tree.cloned(),
                    table_stamp,
                });
                self.input_changed.notify();
            }
        }
        self.geometry.get(|| {
            self.input_changed.track();
            let project = move |row: &T| projected_height(field(row));
            let updates = {
                let mut observation = self.observation.borrow_mut();
                if observation
                    .as_ref()
                    .is_none_or(|entry| entry.model != stamp.0)
                {
                    let updates = FieldUpdates::default();
                    let pending = Rc::downgrade(&updates);
                    let project = project.clone();
                    let changed =
                        model.observe_projection_changes(MAX_ROWS, move |index, old, new| {
                            let before = project(old);
                            let after = project(new);
                            if before == after {
                                return false;
                            }
                            let Some(pending) = pending.upgrade() else {
                                return false;
                            };
                            pending.borrow_mut().insert(index, after);
                            true
                        });
                    *observation = Some(FieldObservation {
                        model: stamp.0,
                        changed,
                        updates,
                    });
                }
                #[expect(clippy::expect_used, reason = "the observer is installed above when missing or when its model changes")]
                let observation = observation.as_ref().expect("installed field observation");
                observation.changed.track();
                observation.updates.take()
            };
            let mut fields = self.fields.borrow_mut();
            if fields.stamp == Some(stamp) {
                for (index, height) in updates {
                    if let Some(height) = height {
                        fields.values.insert(index, height);
                    } else {
                        fields.values.remove(&index);
                    }
                }
            } else {
                // Inserts, removals, and sorting invalidate old model indices.
                fields.stamp = Some(stamp);
                fields.values.clear();
                model.visit_rows_untracked(MAX_ROWS, |index, _, row| {
                    if let Some(height) = project(row) {
                        fields.values.insert(index, height);
                    }
                });
            }
            let sizes: Vec<_> = if let Some(tree) = tree {
                tree.rows()
                    .iter()
                    .enumerate()
                    .filter_map(|(index, row)| {
                        let &height = fields.values.get(&row.model_index)?;
                        (height != base).then_some((index, height))
                    })
                    .collect()
            } else {
                fields
                    .values
                    .iter()
                    .filter_map(|(&index, &height)| {
                        let index = if let Some(table) = table {
                            table.visual_index(index)?
                        } else {
                            index
                        };
                        (height != base).then_some((index, height))
                    })
                    .collect()
            };
            (!sizes.is_empty()).then(|| Arc::new(RowHeights::new(base, sizes, None)))
        })
    }
}

fn same_arc<T>(left: Option<&Arc<T>>, right: Option<&Arc<T>>) -> bool {
    match (left, right) {
        (Some(left), Some(right)) => Arc::ptr_eq(left, right),
        (None, None) => true,
        _ => false,
    }
}

#[derive(Default)]
struct Overrides {
    stamp: Option<(u64, u64)>,
    source_stamp: Option<(u64, u64)>,
    rows: BTreeMap<RowKey, (usize, f32)>,
    geometry: Option<Arc<RowHeights>>,
}

impl Overrides {
    fn reconcile(&mut self, model: &impl ListModel) {
        let stamp = model.structure_stamp();
        if self.stamp == Some(stamp) {
            return;
        }
        self.stamp = Some(stamp);
        let source = model.source_structure_stamp();
        let source_changed = self.source_stamp.replace(source) != Some(source);
        self.geometry = None;
        self.rows.retain(|key, _| key.model == stamp.0);
        let count = model.row_count();
        let mut displaced: BTreeSet<_> = self
            .rows
            .iter()
            .filter_map(|(&key, &(index, _))| {
                (index >= count || model.row_key(index) != key).then_some(key)
            })
            .collect();
        if displaced.is_empty() {
            return;
        }
        let mut index = 0;
        model.visit_row_keys(0..count, |key| {
            if displaced.remove(&key)
                && let Some(row) = self.rows.get_mut(&key)
            {
                row.0 = index;
            }
            index += 1;
        });
        if source_changed && !displaced.is_empty() {
            let mut live = BTreeSet::new();
            model.visit_source_row_keys(|key| {
                if displaced.contains(&key) {
                    live.insert(key);
                }
            });
            for key in displaced.difference(&live) {
                self.rows.remove(key);
            }
            displaced = live;
        }
        for key in displaced {
            if let Some(row) = self.rows.get_mut(&key) {
                row.0 = usize::MAX;
            }
        }
    }
}

/// Per-view overrides follow stable record identities, even when rows are reordered.
#[derive(Default)]
#[doc(hidden)]
pub struct RowHeightOverrides {
    state: RefCell<Overrides>,
    changed: ChangeSignal,
}

impl RowHeightOverrides {
    /// Resolve rows only after a programmatic resize has valid arguments.
    pub fn try_set_row<M: ListModel, E>(
        &self,
        index: i64,
        height: Length,
        rows: impl FnOnce() -> Result<M, E>,
    ) -> Result<bool, E> {
        let Ok(index) = usize::try_from(index) else {
            return Ok(false);
        };
        if !height.0.is_finite() {
            return Ok(false);
        }
        Ok(self.set(&rows()?, index, None, height.0))
    }

    pub fn set_row<M: ListModel>(
        &self,
        index: i64,
        height: Length,
        rows: impl FnOnce() -> M,
    ) -> bool {
        self.try_set_row(index, height, || Ok::<_, std::convert::Infallible>(rows()))
            .unwrap_or_else(|error| match error {})
    }

    pub fn set(
        &self,
        model: &impl ListModel,
        index: usize,
        expected: Option<RowKey>,
        height: f64,
    ) -> bool {
        if index >= model.row_count() || !height.is_finite() {
            return false;
        }
        let key = model.row_key(index);
        if expected.is_some_and(|expected| expected != key) {
            return false;
        }
        let mut state = self.state.borrow_mut();
        let changed = if height < 0.0 {
            state.rows.remove(&key).is_some()
        } else {
            let height = ListMetrics::clamp_row_height(height as f32);
            if state.rows.get(&key).is_some_and(|&(_, old)| old == height) {
                return false;
            }
            state.rows.insert(key, (index, height));
            true
        };
        if changed {
            state.geometry = None;
            drop(state);
            self.changed.notify();
        }
        changed
    }

    pub fn snapshot(&self, model: &impl ListModel, base: f32) -> Option<Arc<RowHeights>> {
        self.snapshot_over(model, base, None)
    }

    pub fn snapshot_over(
        &self,
        model: &impl ListModel,
        base: f32,
        projected: Option<Arc<RowHeights>>,
    ) -> Option<Arc<RowHeights>> {
        self.changed.track();
        let mut state = self.state.borrow_mut();
        if state.rows.is_empty() {
            return projected;
        }
        state.reconcile(model);
        if state.rows.is_empty() {
            return projected;
        }
        if state.geometry.as_ref().is_none_or(|geometry| {
            geometry.base != base || !same_arc(geometry.projected.as_ref(), projected.as_ref())
        }) {
            state.geometry = Some(Arc::new(RowHeights::new(
                base,
                state
                    .rows
                    .values()
                    .copied()
                    .filter(|(index, _)| *index != usize::MAX),
                projected,
            )));
        }
        state.geometry.clone()
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::VecModel;

    #[test]
    fn field_edits_update_only_changed_rows_and_manual_overrides_remain_separate() {
        use std::cell::Cell;

        thread_local! { static READS: Cell<usize> = const { Cell::new(0) }; }
        fn read(row: &(i64, Length)) -> Length {
            READS.with(|reads| reads.set(reads.get() + 1));
            row.1
        }
        let model = VecModel::from(vec![(0, Length(32.0)); 10_000]);
        assert!(model.set_row(8_000, (0, Length(56.0))));
        let projection = RowHeightProjection::default();
        let scene = Property::default();
        let geometry = || {
            scene
                .get(|| projection.snapshot(&model, 32.0, read))
                .unwrap()
        };
        let initial = geometry();
        assert_eq!(initial.top(8_001), 8_000.0 * 32.0 + 56.0);
        READS.with(|reads| reads.set(0));
        assert!(model.set_row(8_000, (1, Length(56.0))));
        assert!(!scene.is_dirty());
        assert!(Arc::ptr_eq(&initial, &geometry()));
        assert!(model.set_row(8_000, (1, Length(96.0))));
        assert!(scene.is_dirty());
        let projected = geometry();
        assert_eq!(projected.height(8_000), 96.0);
        assert_eq!(READS.with(Cell::get), 4);

        let overrides = RowHeightOverrides::default();
        assert!(overrides.set(&model, 8_000, None, 80.0));
        let combined = overrides
            .snapshot_over(&model, 32.0, Some(projected))
            .unwrap();
        assert_eq!(combined.height(8_000), 80.0);
        assert_eq!(combined.top(8_001), 8_000.0 * 32.0 + 80.0);
        assert!(model.set_row(8_000, (1, Length(120.0))));
        let combined = overrides
            .snapshot_over(&model, 32.0, Some(geometry()))
            .unwrap();
        assert_eq!(combined.height(8_000), 80.0);
        assert!(overrides.set(&model, 8_000, None, -1.0));
        let restored = overrides
            .snapshot_over(&model, 32.0, Some(geometry()))
            .unwrap();
        assert_eq!(restored.height(8_000), 120.0);
    }

    #[test]
    fn projected_heights_follow_view_order_and_incremental_field_edits() {
        let model = Rc::new(VecModel::from(vec![
            Length(64.0),
            Length(32.0),
            Length(48.0),
        ]));
        let order = crate::TableRowOrder::default();
        let projection = RowHeightProjection::default();
        let geometry = || {
            projection
                .table_snapshot(&model, 32.0, &order.positions(&*model), |height| *height)
                .unwrap()
        };
        assert_eq!(geometry().height(0), 64.0);
        assert_eq!(order.move_row(&*model, 0, 2), Some(0));
        let moved = geometry();
        assert_eq!(moved.height(2), 64.0);
        assert_eq!(moved.top(2), 80.0);
        assert!(model.set_row(0, Length(96.0)));
        assert_eq!(geometry().height(2), 96.0);
        assert_eq!(geometry().top(2), 80.0);
        model.push(Length(32.0));
        assert_eq!(geometry().height(0), 96.0);
    }

    #[test]
    fn sparse_row_heights_follow_model_keys_and_drop_orphaned_overrides() {
        let model = VecModel::from((0..100_000).collect::<Vec<_>>());
        let overrides = RowHeightOverrides::default();
        let key = model.row_key(90_000).unwrap();
        assert!(overrides.set(&model, 90_000, Some(key), 80.0));
        let original = overrides.snapshot(&model, 32.0).unwrap();
        assert!(Arc::ptr_eq(
            &original,
            &overrides.snapshot(&model, 32.0).unwrap()
        ));
        assert_eq!(original.top(90_001), 90_000.0 * 32.0 + 80.0);
        assert!(model.insert(0, -1));
        assert!(!overrides.set(&model, 90_000, Some(key), 90.0));
        let shifted = overrides.snapshot(&model, 32.0).unwrap();
        assert_eq!(shifted.height(90_001), 80.0);
        assert!(model.sort_by(|a, b| b.cmp(a)));
        let index = model.row_index(key).unwrap();
        let sorted = overrides.snapshot(&model, 32.0).unwrap();
        assert_eq!(sorted.height(index), 80.0);
        assert_eq!(sorted.height(index + 1), 32.0);
        assert!(model.remove(index).is_some());
        assert!(overrides.snapshot(&model, 32.0).is_none());
    }
}