list.rs

  1use crate::{
  2    geometry::{
  3        rect::RectF,
  4        vector::{vec2f, Vector2F},
  5    },
  6    json::json,
  7    DebugContext, Element, ElementBox, ElementRc, Event, EventContext, LayoutContext, PaintContext,
  8    RenderContext, SizeConstraint, View, ViewContext,
  9};
 10use std::{cell::RefCell, collections::VecDeque, ops::Range, rc::Rc};
 11use sum_tree::{Bias, SumTree};
 12
 13pub struct List {
 14    state: ListState,
 15    invalidated_elements: Vec<ElementRc>,
 16}
 17
 18#[derive(Clone)]
 19pub struct ListState(Rc<RefCell<StateInner>>);
 20
 21#[derive(Clone, Copy, Debug, Eq, PartialEq)]
 22pub enum Orientation {
 23    Top,
 24    Bottom,
 25}
 26
 27struct StateInner {
 28    last_layout_width: Option<f32>,
 29    render_item: Box<dyn FnMut(usize, &mut LayoutContext) -> Option<ElementBox>>,
 30    rendered_range: Range<usize>,
 31    items: SumTree<ListItem>,
 32    logical_scroll_top: Option<ListOffset>,
 33    orientation: Orientation,
 34    overdraw: f32,
 35    scroll_handler: Option<Box<dyn FnMut(Range<usize>, &mut EventContext)>>,
 36}
 37
 38#[derive(Clone, Copy, Debug, Default, PartialEq)]
 39pub struct ListOffset {
 40    item_ix: usize,
 41    offset_in_item: f32,
 42}
 43
 44#[derive(Clone)]
 45enum ListItem {
 46    Unrendered,
 47    Rendered(ElementRc),
 48    Removed(f32),
 49}
 50
 51impl std::fmt::Debug for ListItem {
 52    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
 53        match self {
 54            Self::Unrendered => write!(f, "Unrendered"),
 55            Self::Rendered(_) => f.debug_tuple("Rendered").finish(),
 56            Self::Removed(height) => f.debug_tuple("Removed").field(height).finish(),
 57        }
 58    }
 59}
 60
 61#[derive(Clone, Debug, Default, PartialEq)]
 62struct ListItemSummary {
 63    count: usize,
 64    rendered_count: usize,
 65    unrendered_count: usize,
 66    height: f32,
 67}
 68
 69#[derive(Clone, Debug, Default, PartialEq, Eq, PartialOrd, Ord)]
 70struct Count(usize);
 71
 72#[derive(Clone, Debug, Default, PartialEq, Eq, PartialOrd, Ord)]
 73struct RenderedCount(usize);
 74
 75#[derive(Clone, Debug, Default, PartialEq, Eq, PartialOrd, Ord)]
 76struct UnrenderedCount(usize);
 77
 78#[derive(Clone, Debug, Default)]
 79struct Height(f32);
 80
 81impl List {
 82    pub fn new(state: ListState) -> Self {
 83        Self {
 84            state,
 85            invalidated_elements: Default::default(),
 86        }
 87    }
 88}
 89
 90impl Element for List {
 91    type LayoutState = ListOffset;
 92    type PaintState = ();
 93
 94    fn layout(
 95        &mut self,
 96        constraint: SizeConstraint,
 97        cx: &mut LayoutContext,
 98    ) -> (Vector2F, Self::LayoutState) {
 99        let state = &mut *self.state.0.borrow_mut();
100        let size = constraint.max;
101        let mut item_constraint = constraint;
102        item_constraint.min.set_y(0.);
103        item_constraint.max.set_y(f32::INFINITY);
104
105        if cx.refreshing || state.last_layout_width != Some(size.x()) {
106            state.rendered_range = 0..0;
107            state.items = SumTree::from_iter(
108                (0..state.items.summary().count).map(|_| ListItem::Unrendered),
109                &(),
110            )
111        }
112
113        let old_items = state.items.clone();
114        let mut new_items = SumTree::new();
115        let mut rendered_items = VecDeque::new();
116        let mut rendered_height = 0.;
117        let mut scroll_top = state
118            .logical_scroll_top
119            .unwrap_or_else(|| match state.orientation {
120                Orientation::Top => ListOffset {
121                    item_ix: 0,
122                    offset_in_item: 0.,
123                },
124                Orientation::Bottom => ListOffset {
125                    item_ix: state.items.summary().count,
126                    offset_in_item: 0.,
127                },
128            });
129
130        // Render items after the scroll top, including those in the trailing overdraw.
131        let mut cursor = old_items.cursor::<Count>();
132        cursor.seek(&Count(scroll_top.item_ix), Bias::Right, &());
133        for (ix, item) in cursor.by_ref().enumerate() {
134            if rendered_height - scroll_top.offset_in_item >= size.y() + state.overdraw {
135                break;
136            }
137
138            if let Some(element) =
139                state.render_item(scroll_top.item_ix + ix, item, item_constraint, cx)
140            {
141                rendered_height += element.size().y();
142                rendered_items.push_back(ListItem::Rendered(element));
143            }
144        }
145
146        // Prepare to start walking upward from the item at the scroll top.
147        cursor.seek(&Count(scroll_top.item_ix), Bias::Right, &());
148
149        // If the rendered items do not fill the visible region, then adjust
150        // the scroll top upward.
151        if rendered_height - scroll_top.offset_in_item < size.y() {
152            while rendered_height < size.y() {
153                cursor.prev(&());
154                if let Some(item) = cursor.item() {
155                    if let Some(element) =
156                        state.render_item(cursor.start().0, item, item_constraint, cx)
157                    {
158                        rendered_height += element.size().y();
159                        rendered_items.push_front(ListItem::Rendered(element));
160                    }
161                } else {
162                    break;
163                }
164            }
165
166            scroll_top = ListOffset {
167                item_ix: cursor.start().0,
168                offset_in_item: rendered_height - size.y(),
169            };
170
171            match state.orientation {
172                Orientation::Top => {
173                    scroll_top.offset_in_item = scroll_top.offset_in_item.max(0.);
174                    state.logical_scroll_top = Some(scroll_top);
175                }
176                Orientation::Bottom => {
177                    scroll_top = ListOffset {
178                        item_ix: cursor.start().0,
179                        offset_in_item: rendered_height - size.y(),
180                    };
181                    state.logical_scroll_top = None;
182                }
183            };
184        }
185
186        // Render items in the leading overdraw.
187        let mut leading_overdraw = scroll_top.offset_in_item;
188        while leading_overdraw < state.overdraw {
189            cursor.prev(&());
190            if let Some(item) = cursor.item() {
191                if let Some(element) =
192                    state.render_item(cursor.start().0, item, item_constraint, cx)
193                {
194                    leading_overdraw += element.size().y();
195                    rendered_items.push_front(ListItem::Rendered(element));
196                }
197            } else {
198                break;
199            }
200        }
201
202        let new_rendered_range = cursor.start().0..(cursor.start().0 + rendered_items.len());
203
204        let mut cursor = old_items.cursor::<Count>();
205
206        if state.rendered_range.start < new_rendered_range.start {
207            new_items.push_tree(
208                cursor.slice(&Count(state.rendered_range.start), Bias::Right, &()),
209                &(),
210            );
211            let remove_to = state.rendered_range.end.min(new_rendered_range.start);
212            while cursor.start().0 < remove_to {
213                new_items.push(cursor.item().unwrap().remove(), &());
214                cursor.next(&());
215            }
216        }
217        new_items.push_tree(
218            cursor.slice(&Count(new_rendered_range.start), Bias::Right, &()),
219            &(),
220        );
221
222        new_items.extend(rendered_items, &());
223        cursor.seek(&Count(new_rendered_range.end), Bias::Right, &());
224
225        if new_rendered_range.end < state.rendered_range.start {
226            new_items.push_tree(
227                cursor.slice(&Count(state.rendered_range.start), Bias::Right, &()),
228                &(),
229            );
230        }
231        while cursor.start().0 < state.rendered_range.end {
232            new_items.push(cursor.item().unwrap().remove(), &());
233            cursor.next(&());
234        }
235
236        new_items.push_tree(cursor.suffix(&()), &());
237
238        state.items = new_items;
239        state.rendered_range = new_rendered_range;
240        state.last_layout_width = Some(size.x());
241        (size, scroll_top)
242    }
243
244    fn paint(
245        &mut self,
246        bounds: RectF,
247        visible_bounds: RectF,
248        scroll_top: &mut ListOffset,
249        cx: &mut PaintContext,
250    ) {
251        cx.scene.push_layer(Some(bounds));
252
253        let state = &mut *self.state.0.borrow_mut();
254        for (mut element, origin) in state.visible_elements(bounds, scroll_top) {
255            element.paint(origin, visible_bounds, cx);
256        }
257
258        cx.scene.pop_layer();
259    }
260
261    fn dispatch_event(
262        &mut self,
263        event: &Event,
264        bounds: RectF,
265        _: RectF,
266        scroll_top: &mut ListOffset,
267        _: &mut (),
268        cx: &mut EventContext,
269    ) -> bool {
270        let mut handled = false;
271
272        let mut state = self.state.0.borrow_mut();
273        let mut item_origin = bounds.origin() - vec2f(0., scroll_top.offset_in_item);
274        let mut cursor = state.items.cursor::<Count>();
275        let mut new_items = cursor.slice(&Count(scroll_top.item_ix), Bias::Right, &());
276        while let Some(item) = cursor.item() {
277            if item_origin.y() > bounds.max_y() {
278                break;
279            }
280
281            if let ListItem::Rendered(element) = item {
282                let prev_notify_count = cx.notify_count();
283                let mut element = element.clone();
284                handled = element.dispatch_event(event, cx) || handled;
285                item_origin.set_y(item_origin.y() + element.size().y());
286                if cx.notify_count() > prev_notify_count {
287                    new_items.push(ListItem::Unrendered, &());
288                    self.invalidated_elements.push(element);
289                } else {
290                    new_items.push(item.clone(), &());
291                }
292                cursor.next(&());
293            } else {
294                unreachable!();
295            }
296        }
297
298        new_items.push_tree(cursor.suffix(&()), &());
299        drop(cursor);
300        state.items = new_items;
301
302        match event {
303            Event::ScrollWheel {
304                position,
305                delta,
306                precise,
307            } => {
308                if bounds.contains_point(*position) {
309                    if state.scroll(scroll_top, bounds.height(), *delta, *precise, cx) {
310                        handled = true;
311                    }
312                }
313            }
314            _ => {}
315        }
316
317        handled
318    }
319
320    fn debug(
321        &self,
322        bounds: RectF,
323        scroll_top: &Self::LayoutState,
324        _: &(),
325        cx: &DebugContext,
326    ) -> serde_json::Value {
327        let state = self.state.0.borrow_mut();
328        let visible_elements = state
329            .visible_elements(bounds, scroll_top)
330            .map(|e| e.0.debug(cx))
331            .collect::<Vec<_>>();
332        let visible_range = scroll_top.item_ix..(scroll_top.item_ix + visible_elements.len());
333        json!({
334            "visible_range": visible_range,
335            "visible_elements": visible_elements,
336            "scroll_top": state.logical_scroll_top.map(|top| (top.item_ix, top.offset_in_item)),
337        })
338    }
339}
340
341impl ListState {
342    pub fn new<F, V>(
343        element_count: usize,
344        orientation: Orientation,
345        overdraw: f32,
346        cx: &mut ViewContext<V>,
347        mut render_item: F,
348    ) -> Self
349    where
350        V: View,
351        F: 'static + FnMut(&mut V, usize, &mut RenderContext<V>) -> ElementBox,
352    {
353        let mut items = SumTree::new();
354        items.extend((0..element_count).map(|_| ListItem::Unrendered), &());
355        let handle = cx.weak_handle();
356        Self(Rc::new(RefCell::new(StateInner {
357            last_layout_width: None,
358            render_item: Box::new(move |ix, cx| {
359                let handle = handle.upgrade(cx)?;
360                Some(cx.render(&handle, |view, cx| render_item(view, ix, cx)))
361            }),
362            rendered_range: 0..0,
363            items,
364            logical_scroll_top: None,
365            orientation,
366            overdraw,
367            scroll_handler: None,
368        })))
369    }
370
371    pub fn reset(&self, element_count: usize) {
372        let state = &mut *self.0.borrow_mut();
373        state.rendered_range = 0..0;
374        state.logical_scroll_top = None;
375        state.items = SumTree::new();
376        state
377            .items
378            .extend((0..element_count).map(|_| ListItem::Unrendered), &());
379    }
380
381    pub fn splice(&self, old_range: Range<usize>, count: usize) {
382        let state = &mut *self.0.borrow_mut();
383
384        if let Some(ListOffset {
385            item_ix,
386            offset_in_item,
387        }) = state.logical_scroll_top.as_mut()
388        {
389            if old_range.contains(item_ix) {
390                *item_ix = old_range.start;
391                *offset_in_item = 0.;
392            } else if old_range.end <= *item_ix {
393                *item_ix = *item_ix - (old_range.end - old_range.start) + count;
394            }
395        }
396
397        let new_end = old_range.start + count;
398        if old_range.start < state.rendered_range.start {
399            state.rendered_range.start =
400                new_end + state.rendered_range.start.saturating_sub(old_range.end);
401        }
402        if old_range.start < state.rendered_range.end {
403            state.rendered_range.end =
404                new_end + state.rendered_range.end.saturating_sub(old_range.end);
405        }
406
407        let mut old_heights = state.items.cursor::<Count>();
408        let mut new_heights = old_heights.slice(&Count(old_range.start), Bias::Right, &());
409        old_heights.seek_forward(&Count(old_range.end), Bias::Right, &());
410
411        new_heights.extend((0..count).map(|_| ListItem::Unrendered), &());
412        new_heights.push_tree(old_heights.suffix(&()), &());
413        drop(old_heights);
414        state.items = new_heights;
415    }
416
417    pub fn set_scroll_handler(
418        &mut self,
419        handler: impl FnMut(Range<usize>, &mut EventContext) + 'static,
420    ) {
421        self.0.borrow_mut().scroll_handler = Some(Box::new(handler))
422    }
423}
424
425impl StateInner {
426    fn render_item(
427        &mut self,
428        ix: usize,
429        existing_item: &ListItem,
430        constraint: SizeConstraint,
431        cx: &mut LayoutContext,
432    ) -> Option<ElementRc> {
433        if let ListItem::Rendered(element) = existing_item {
434            Some(element.clone())
435        } else {
436            let mut element = (self.render_item)(ix, cx)?;
437            element.layout(constraint, cx);
438            Some(element.into())
439        }
440    }
441
442    fn visible_range(&self, height: f32, scroll_top: &ListOffset) -> Range<usize> {
443        let mut cursor = self.items.cursor::<ListItemSummary>();
444        cursor.seek(&Count(scroll_top.item_ix), Bias::Right, &());
445        let start_y = cursor.start().height + scroll_top.offset_in_item;
446        cursor.seek_forward(&Height(start_y + height), Bias::Left, &());
447        scroll_top.item_ix..cursor.start().count + 1
448    }
449
450    fn visible_elements<'a>(
451        &'a self,
452        bounds: RectF,
453        scroll_top: &ListOffset,
454    ) -> impl Iterator<Item = (ElementRc, Vector2F)> + 'a {
455        let mut item_origin = bounds.origin() - vec2f(0., scroll_top.offset_in_item);
456        let mut cursor = self.items.cursor::<Count>();
457        cursor.seek(&Count(scroll_top.item_ix), Bias::Right, &());
458        std::iter::from_fn(move || {
459            while let Some(item) = cursor.item() {
460                if item_origin.y() > bounds.max_y() {
461                    break;
462                }
463
464                if let ListItem::Rendered(element) = item {
465                    let result = (element.clone(), item_origin);
466                    item_origin.set_y(item_origin.y() + element.size().y());
467                    cursor.next(&());
468                    return Some(result);
469                }
470
471                cursor.next(&());
472            }
473
474            None
475        })
476    }
477
478    fn scroll(
479        &mut self,
480        scroll_top: &ListOffset,
481        height: f32,
482        mut delta: Vector2F,
483        precise: bool,
484        cx: &mut EventContext,
485    ) -> bool {
486        if !precise {
487            delta *= 20.;
488        }
489
490        let scroll_max = (self.items.summary().height - height).max(0.);
491        let new_scroll_top = (self.scroll_top(scroll_top) - delta.y())
492            .max(0.)
493            .min(scroll_max);
494
495        if self.orientation == Orientation::Bottom && new_scroll_top == scroll_max {
496            self.logical_scroll_top = None;
497        } else {
498            let mut cursor = self.items.cursor::<ListItemSummary>();
499            cursor.seek(&Height(new_scroll_top), Bias::Right, &());
500            let item_ix = cursor.start().count;
501            let offset_in_item = new_scroll_top - cursor.start().height;
502            self.logical_scroll_top = Some(ListOffset {
503                item_ix,
504                offset_in_item,
505            });
506        }
507
508        if self.scroll_handler.is_some() {
509            let visible_range = self.visible_range(height, scroll_top);
510            self.scroll_handler.as_mut().unwrap()(visible_range, cx);
511        }
512        cx.notify();
513
514        true
515    }
516
517    fn scroll_top(&self, logical_scroll_top: &ListOffset) -> f32 {
518        let mut cursor = self.items.cursor::<ListItemSummary>();
519        cursor.seek(&Count(logical_scroll_top.item_ix), Bias::Right, &());
520        cursor.start().height + logical_scroll_top.offset_in_item
521    }
522}
523
524impl ListItem {
525    fn remove(&self) -> Self {
526        match self {
527            ListItem::Unrendered => ListItem::Unrendered,
528            ListItem::Rendered(element) => ListItem::Removed(element.size().y()),
529            ListItem::Removed(height) => ListItem::Removed(*height),
530        }
531    }
532}
533
534impl sum_tree::Item for ListItem {
535    type Summary = ListItemSummary;
536
537    fn summary(&self) -> Self::Summary {
538        match self {
539            ListItem::Unrendered => ListItemSummary {
540                count: 1,
541                rendered_count: 0,
542                unrendered_count: 1,
543                height: 0.,
544            },
545            ListItem::Rendered(element) => ListItemSummary {
546                count: 1,
547                rendered_count: 1,
548                unrendered_count: 0,
549                height: element.size().y(),
550            },
551            ListItem::Removed(height) => ListItemSummary {
552                count: 1,
553                rendered_count: 0,
554                unrendered_count: 1,
555                height: *height,
556            },
557        }
558    }
559}
560
561impl sum_tree::Summary for ListItemSummary {
562    type Context = ();
563
564    fn add_summary(&mut self, summary: &Self, _: &()) {
565        self.count += summary.count;
566        self.rendered_count += summary.rendered_count;
567        self.unrendered_count += summary.unrendered_count;
568        self.height += summary.height;
569    }
570}
571
572impl<'a> sum_tree::Dimension<'a, ListItemSummary> for Count {
573    fn add_summary(&mut self, summary: &'a ListItemSummary, _: &()) {
574        self.0 += summary.count;
575    }
576}
577
578impl<'a> sum_tree::Dimension<'a, ListItemSummary> for RenderedCount {
579    fn add_summary(&mut self, summary: &'a ListItemSummary, _: &()) {
580        self.0 += summary.rendered_count;
581    }
582}
583
584impl<'a> sum_tree::Dimension<'a, ListItemSummary> for UnrenderedCount {
585    fn add_summary(&mut self, summary: &'a ListItemSummary, _: &()) {
586        self.0 += summary.unrendered_count;
587    }
588}
589
590impl<'a> sum_tree::Dimension<'a, ListItemSummary> for Height {
591    fn add_summary(&mut self, summary: &'a ListItemSummary, _: &()) {
592        self.0 += summary.height;
593    }
594}
595
596impl<'a> sum_tree::SeekTarget<'a, ListItemSummary, ListItemSummary> for Count {
597    fn cmp(&self, other: &ListItemSummary, _: &()) -> std::cmp::Ordering {
598        self.0.partial_cmp(&other.count).unwrap()
599    }
600}
601
602impl<'a> sum_tree::SeekTarget<'a, ListItemSummary, ListItemSummary> for Height {
603    fn cmp(&self, other: &ListItemSummary, _: &()) -> std::cmp::Ordering {
604        self.0.partial_cmp(&other.height).unwrap()
605    }
606}
607
608#[cfg(test)]
609mod tests {
610    use super::*;
611    use crate::{elements::Empty, geometry::vector::vec2f, Entity};
612    use rand::prelude::*;
613    use std::env;
614
615    #[crate::test(self)]
616    fn test_layout(cx: &mut crate::MutableAppContext) {
617        let mut presenter = cx.build_presenter(0, 0.);
618        let (_, view) = cx.add_window(Default::default(), |_| TestView);
619        let constraint = SizeConstraint::new(vec2f(0., 0.), vec2f(100., 40.));
620
621        let elements = Rc::new(RefCell::new(vec![(0, 20.), (1, 30.), (2, 100.)]));
622
623        let state = view.update(cx, |_, cx| {
624            ListState::new(elements.borrow().len(), Orientation::Top, 1000.0, cx, {
625                let elements = elements.clone();
626                move |_, ix, _| {
627                    let (id, height) = elements.borrow()[ix];
628                    TestElement::new(id, height).boxed()
629                }
630            })
631        });
632
633        let mut list = List::new(state.clone());
634        let (size, _) = list.layout(
635            constraint,
636            &mut presenter.build_layout_context(vec2f(100., 40.), false, cx),
637        );
638        assert_eq!(size, vec2f(100., 40.));
639        assert_eq!(
640            state.0.borrow().items.summary().clone(),
641            ListItemSummary {
642                count: 3,
643                rendered_count: 3,
644                unrendered_count: 0,
645                height: 150.
646            }
647        );
648
649        state.0.borrow_mut().scroll(
650            &ListOffset {
651                item_ix: 0,
652                offset_in_item: 0.,
653            },
654            40.,
655            vec2f(0., -54.),
656            true,
657            &mut presenter.build_event_context(cx),
658        );
659        let (_, logical_scroll_top) = list.layout(
660            constraint,
661            &mut presenter.build_layout_context(vec2f(100., 40.), false, cx),
662        );
663        assert_eq!(
664            logical_scroll_top,
665            ListOffset {
666                item_ix: 2,
667                offset_in_item: 4.
668            }
669        );
670        assert_eq!(state.0.borrow().scroll_top(&logical_scroll_top), 54.);
671
672        elements.borrow_mut().splice(1..2, vec![(3, 40.), (4, 50.)]);
673        elements.borrow_mut().push((5, 60.));
674        state.splice(1..2, 2);
675        state.splice(4..4, 1);
676        assert_eq!(
677            state.0.borrow().items.summary().clone(),
678            ListItemSummary {
679                count: 5,
680                rendered_count: 2,
681                unrendered_count: 3,
682                height: 120.
683            }
684        );
685
686        let (size, logical_scroll_top) = list.layout(
687            constraint,
688            &mut presenter.build_layout_context(vec2f(100., 40.), false, cx),
689        );
690        assert_eq!(size, vec2f(100., 40.));
691        assert_eq!(
692            state.0.borrow().items.summary().clone(),
693            ListItemSummary {
694                count: 5,
695                rendered_count: 5,
696                unrendered_count: 0,
697                height: 270.
698            }
699        );
700        assert_eq!(
701            logical_scroll_top,
702            ListOffset {
703                item_ix: 3,
704                offset_in_item: 4.
705            }
706        );
707        assert_eq!(state.0.borrow().scroll_top(&logical_scroll_top), 114.);
708    }
709
710    #[crate::test(self, iterations = 10, seed = 0)]
711    fn test_random(cx: &mut crate::MutableAppContext, mut rng: StdRng) {
712        let operations = env::var("OPERATIONS")
713            .map(|i| i.parse().expect("invalid `OPERATIONS` variable"))
714            .unwrap_or(10);
715
716        let (_, view) = cx.add_window(Default::default(), |_| TestView);
717        let mut presenter = cx.build_presenter(0, 0.);
718        let mut next_id = 0;
719        let elements = Rc::new(RefCell::new(
720            (0..rng.gen_range(0..=20))
721                .map(|_| {
722                    let id = next_id;
723                    next_id += 1;
724                    (id, rng.gen_range(0..=200) as f32 / 2.0)
725                })
726                .collect::<Vec<_>>(),
727        ));
728        let orientation = *[Orientation::Top, Orientation::Bottom]
729            .choose(&mut rng)
730            .unwrap();
731        let overdraw = rng.gen_range(1..=100) as f32;
732
733        let state = view.update(cx, |_, cx| {
734            ListState::new(elements.borrow().len(), orientation, overdraw, cx, {
735                let elements = elements.clone();
736                move |_, ix, _| {
737                    let (id, height) = elements.borrow()[ix];
738                    TestElement::new(id, height).boxed()
739                }
740            })
741        });
742
743        let mut width = rng.gen_range(0..=2000) as f32 / 2.;
744        let mut height = rng.gen_range(0..=2000) as f32 / 2.;
745        log::info!("orientation: {:?}", orientation);
746        log::info!("overdraw: {}", overdraw);
747        log::info!("elements: {:?}", elements.borrow());
748        log::info!("size: ({:?}, {:?})", width, height);
749        log::info!("==================");
750
751        let mut last_logical_scroll_top = None;
752        for _ in 0..operations {
753            match rng.gen_range(0..=100) {
754                0..=29 if last_logical_scroll_top.is_some() => {
755                    let delta = vec2f(0., rng.gen_range(-overdraw..=overdraw));
756                    log::info!(
757                        "Scrolling by {:?}, previous scroll top: {:?}",
758                        delta,
759                        last_logical_scroll_top.unwrap()
760                    );
761                    state.0.borrow_mut().scroll(
762                        last_logical_scroll_top.as_ref().unwrap(),
763                        height,
764                        delta,
765                        true,
766                        &mut presenter.build_event_context(cx),
767                    );
768                }
769                30..=34 => {
770                    width = rng.gen_range(0..=2000) as f32 / 2.;
771                    log::info!("changing width: {:?}", width);
772                }
773                35..=54 => {
774                    height = rng.gen_range(0..=1000) as f32 / 2.;
775                    log::info!("changing height: {:?}", height);
776                }
777                _ => {
778                    let mut elements = elements.borrow_mut();
779                    let end_ix = rng.gen_range(0..=elements.len());
780                    let start_ix = rng.gen_range(0..=end_ix);
781                    let new_elements = (0..rng.gen_range(0..10))
782                        .map(|_| {
783                            let id = next_id;
784                            next_id += 1;
785                            (id, rng.gen_range(0..=200) as f32 / 2.)
786                        })
787                        .collect::<Vec<_>>();
788                    log::info!("splice({:?}, {:?})", start_ix..end_ix, new_elements);
789                    state.splice(start_ix..end_ix, new_elements.len());
790                    elements.splice(start_ix..end_ix, new_elements);
791                    for (ix, item) in state.0.borrow().items.cursor::<()>().enumerate() {
792                        if let ListItem::Rendered(element) = item {
793                            let (expected_id, _) = elements[ix];
794                            element.with_metadata(|metadata: Option<&usize>| {
795                                assert_eq!(*metadata.unwrap(), expected_id);
796                            });
797                        }
798                    }
799                }
800            }
801
802            let mut list = List::new(state.clone());
803            let window_size = vec2f(width, height);
804            let (size, logical_scroll_top) = list.layout(
805                SizeConstraint::new(vec2f(0., 0.), window_size),
806                &mut presenter.build_layout_context(window_size, false, cx),
807            );
808            assert_eq!(size, window_size);
809            last_logical_scroll_top = Some(logical_scroll_top);
810
811            let state = state.0.borrow();
812            log::info!("items {:?}", state.items.items(&()));
813
814            let scroll_top = state.scroll_top(&logical_scroll_top);
815            let rendered_top = (scroll_top - overdraw).max(0.);
816            let rendered_bottom = scroll_top + height + overdraw;
817            let mut item_top = 0.;
818
819            log::info!(
820                "rendered top {:?}, rendered bottom {:?}, scroll top {:?}",
821                rendered_top,
822                rendered_bottom,
823                scroll_top,
824            );
825
826            let mut first_rendered_element_top = None;
827            let mut last_rendered_element_bottom = None;
828            assert_eq!(state.items.summary().count, elements.borrow().len());
829            for (ix, item) in state.items.cursor::<()>().enumerate() {
830                match item {
831                    ListItem::Unrendered => {
832                        let item_bottom = item_top;
833                        assert!(item_bottom <= rendered_top || item_top >= rendered_bottom);
834                        item_top = item_bottom;
835                    }
836                    ListItem::Removed(height) => {
837                        let (id, expected_height) = elements.borrow()[ix];
838                        assert_eq!(
839                            *height, expected_height,
840                            "element {} height didn't match",
841                            id
842                        );
843                        let item_bottom = item_top + height;
844                        assert!(item_bottom <= rendered_top || item_top >= rendered_bottom);
845                        item_top = item_bottom;
846                    }
847                    ListItem::Rendered(element) => {
848                        let (expected_id, expected_height) = elements.borrow()[ix];
849                        element.with_metadata(|metadata: Option<&usize>| {
850                            assert_eq!(*metadata.unwrap(), expected_id);
851                        });
852                        assert_eq!(element.size().y(), expected_height);
853                        let item_bottom = item_top + element.size().y();
854                        first_rendered_element_top.get_or_insert(item_top);
855                        last_rendered_element_bottom = Some(item_bottom);
856                        assert!(item_bottom > rendered_top || item_top < rendered_bottom);
857                        item_top = item_bottom;
858                    }
859                }
860            }
861
862            match orientation {
863                Orientation::Top => {
864                    if let Some(first_rendered_element_top) = first_rendered_element_top {
865                        assert!(first_rendered_element_top <= scroll_top);
866                    }
867                }
868                Orientation::Bottom => {
869                    if let Some(last_rendered_element_bottom) = last_rendered_element_bottom {
870                        assert!(last_rendered_element_bottom >= scroll_top + height);
871                    }
872                }
873            }
874        }
875    }
876
877    struct TestView;
878
879    impl Entity for TestView {
880        type Event = ();
881    }
882
883    impl View for TestView {
884        fn ui_name() -> &'static str {
885            "TestView"
886        }
887
888        fn render(&mut self, _: &mut RenderContext<'_, Self>) -> ElementBox {
889            Empty::new().boxed()
890        }
891    }
892
893    struct TestElement {
894        id: usize,
895        size: Vector2F,
896    }
897
898    impl TestElement {
899        fn new(id: usize, height: f32) -> Self {
900            Self {
901                id,
902                size: vec2f(100., height),
903            }
904        }
905    }
906
907    impl Element for TestElement {
908        type LayoutState = ();
909        type PaintState = ();
910
911        fn layout(&mut self, _: SizeConstraint, _: &mut LayoutContext) -> (Vector2F, ()) {
912            (self.size, ())
913        }
914
915        fn paint(&mut self, _: RectF, _: RectF, _: &mut (), _: &mut PaintContext) {
916            todo!()
917        }
918
919        fn dispatch_event(
920            &mut self,
921            _: &Event,
922            _: RectF,
923            _: RectF,
924            _: &mut (),
925            _: &mut (),
926            _: &mut EventContext,
927        ) -> bool {
928            todo!()
929        }
930
931        fn debug(&self, _: RectF, _: &(), _: &(), _: &DebugContext) -> serde_json::Value {
932            self.id.into()
933        }
934
935        fn metadata(&self) -> Option<&dyn std::any::Any> {
936            Some(&self.id)
937        }
938    }
939}