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