// Copyright © SixtyFPS GmbH // SPDX-License-Identifier: GPL-3.0-only OR LicenseRef-Slint-commercial // cSpell: ignore vecmodel //! Model and Repeater use crate::component::ComponentVTable; use crate::item_tree::TraversalOrder; use crate::items::ItemRef; use crate::layout::Orientation; use crate::{Coord, Property, SharedString, SharedVector}; use alloc::boxed::Box; use alloc::vec::Vec; use core::cell::{Cell, RefCell}; use core::pin::Pin; #[allow(unused)] use euclid::num::{Ceil, Floor}; pub use model_peer::*; use once_cell::unsync::OnceCell; use pin_project::pin_project; use pin_weak::rc::{PinWeak, Rc}; mod model_peer; type ComponentRc = vtable::VRc; /// This trait defines the interface that users of a model can use to track changes /// to a model. It is supplied via [`Model::model_tracker`] and implementation usually /// return a reference to its field of [`ModelNotify`]. pub trait ModelTracker { /// Attach one peer. The peer will be notified when the model changes fn attach_peer(&self, peer: ModelPeer); /// Register the model as a dependency to the current binding being evaluated, so /// that it will be notified when the model changes its size. fn track_row_count_changes(&self); /// Register a row as a dependency to the current binding being evaluated, so that /// it will be notified when the value of that row changes. fn track_row_data_changes(&self, row: usize); } impl ModelTracker for () { fn attach_peer(&self, _peer: ModelPeer) {} fn track_row_count_changes(&self) {} fn track_row_data_changes(&self, _row: usize) {} } /// A Model is providing Data for the Repeater or ListView elements of the `.slint` language /// /// If the model can be changed, the type implementing the Model trait should holds /// a [`ModelNotify`], and is responsible to call functions on it to let the UI know that /// something has changed. /// /// ## Example /// /// As an example, let's see the implementation of [`VecModel`]. /// /// ``` /// # use i_slint_core::model::{Model, ModelNotify, ModelPeer, ModelTracker}; /// pub struct VecModel { /// // the backing data, stored in a `RefCell` as this model can be modified /// array: std::cell::RefCell>, /// // the ModelNotify will allow to notify the UI that the model changes /// notify: ModelNotify, /// } /// /// impl Model for VecModel { /// type Data = T; /// /// fn row_count(&self) -> usize { /// self.array.borrow().len() /// } /// /// fn row_data(&self, row: usize) -> Option { /// self.array.borrow().get(row).cloned() /// } /// /// fn set_row_data(&self, row: usize, data: Self::Data) { /// self.array.borrow_mut()[row] = data; /// // don't forget to call row_changed /// self.notify.row_changed(row); /// } /// /// fn model_tracker(&self) -> &dyn ModelTracker { /// &self.notify /// } /// /// fn as_any(&self) -> &dyn core::any::Any { /// // a typical implementation just return `self` /// self /// } /// } /// /// // when modifying the model, we call the corresponding function in /// // the ModelNotify /// impl VecModel { /// /// Add a row at the end of the model /// pub fn push(&self, value: T) { /// self.array.borrow_mut().push(value); /// self.notify.row_added(self.array.borrow().len() - 1, 1) /// } /// /// /// Remove the row at the given index from the model /// pub fn remove(&self, index: usize) { /// self.array.borrow_mut().remove(index); /// self.notify.row_removed(index, 1) /// } /// } /// ``` pub trait Model { /// The model data: A model is a set of row and each row has this data type Data; /// The amount of row in the model fn row_count(&self) -> usize; /// Returns the data for a particular row. This function should be called with `row < row_count()`. /// /// This function does not register dependencies on the current binding. For an equivalent /// function that tracks dependencies, see [`ModelExt::row_data_tracked`] fn row_data(&self, row: usize) -> Option; /// Sets the data for a particular row. /// /// This function should be called with `row < row_count()`, otherwise the implementation can panic. /// /// If the model cannot support data changes, then it is ok to do nothing. /// The default implementation will print a warning to stderr. /// /// If the model can update the data, it should also call [`ModelNotify::row_changed`] on its /// internal [`ModelNotify`]. fn set_row_data(&self, _row: usize, _data: Self::Data) { #[cfg(feature = "std")] eprintln!( "Model::set_row_data called on a model of type {} which does not re-implement this method. \ This happens when trying to modify a read-only model", core::any::type_name::(), ); } /// The implementation should return a reference to its [`ModelNotify`] field. /// /// You can return `&()` if you your `Model` is constant and does not have a ModelNotify field. fn model_tracker(&self) -> &dyn ModelTracker; /// Returns an iterator visiting all elements of the model. fn iter(&self) -> ModelIterator where Self: Sized, { ModelIterator::new(self) } /// Return something that can be downcast'ed (typically self) /// /// This is useful to get back to the actual model from a [`ModelRc`] stored /// in a component. /// /// ``` /// # use i_slint_core::model::*; /// # use std::rc::Rc; /// let handle = ModelRc::new(VecModel::from(vec![1i32, 2, 3])); /// // later: /// handle.as_any().downcast_ref::>().unwrap().push(4); /// assert_eq!(handle.row_data(3).unwrap(), 4); /// ``` /// /// Note: the default implementation returns nothing interesting. this method should be /// implemented by model implementation to return something useful. For example: /// ```ignore /// fn as_any(&self) -> &dyn core::any::Any { self } /// ``` fn as_any(&self) -> &dyn core::any::Any { &() } } /// Extension trait with extra methods implemented on types that implements [`Model`] pub trait ModelExt: Model { /// Convenience function that calls [`ModelTracker::track_row_data_changes`] /// before returning [`Self::row_data`]. /// /// Calling [`row_data(row)`](Self::row_data) does not register the row as a dependency when calling it while /// evaluating a property binding. This function calls [`track_row_data_changes(row)`](ModelTracker::track_row_data_changes) /// on the [`self.model_tracker()`](Self::model_tracker) to enable tracking. fn row_data_tracked(&self, row: usize) -> Option { self.model_tracker().track_row_data_changes(row); self.row_data(row) } } impl ModelExt for T {} /// An iterator over the elements of a model. /// This struct is created by the [Model::iter()] trait function. pub struct ModelIterator<'a, T> { model: &'a dyn Model, row: usize, } impl<'a, T> ModelIterator<'a, T> { /// Creates a new model iterator for a model reference. /// This is the same as calling [`model.iter()`](Model::iter) pub fn new(model: &'a dyn Model) -> Self { Self { model, row: 0 } } } impl<'a, T> Iterator for ModelIterator<'a, T> { type Item = T; fn next(&mut self) -> Option { let row = self.row; if self.row < self.model.row_count() { self.row += 1; } self.model.row_data(row) } fn size_hint(&self) -> (usize, Option) { let len = self.model.row_count(); (len, Some(len)) } } impl<'a, T> ExactSizeIterator for ModelIterator<'a, T> {} /// A model backed by a `Vec` #[derive(Default)] pub struct VecModel { array: RefCell>, notify: ModelNotify, } impl VecModel { /// Allocate a new model from a slice pub fn from_slice(slice: &[T]) -> ModelRc where T: Clone, { ModelRc::new(Self::from(slice.to_vec())) } /// Add a row at the end of the model pub fn push(&self, value: T) { self.array.borrow_mut().push(value); self.notify.row_added(self.array.borrow().len() - 1, 1) } /// Inserts a row at position index. All rows after that are shifted. /// This function panics if index is > row_count(). pub fn insert(&self, index: usize, value: T) { self.array.borrow_mut().insert(index, value); self.notify.row_added(index, 1) } /// Remove the row at the given index from the model pub fn remove(&self, index: usize) { self.array.borrow_mut().remove(index); self.notify.row_removed(index, 1) } /// Replace inner Vec with new data pub fn set_vec(&self, new: impl Into>) { *self.array.borrow_mut() = new.into(); self.notify.reset(); } } impl From> for VecModel { fn from(array: Vec) -> Self { VecModel { array: RefCell::new(array), notify: Default::default() } } } impl Model for VecModel { type Data = T; fn row_count(&self) -> usize { self.array.borrow().len() } fn row_data(&self, row: usize) -> Option { self.array.borrow().get(row).cloned() } fn set_row_data(&self, row: usize, data: Self::Data) { if row < self.row_count() { self.array.borrow_mut()[row] = data; self.notify.row_changed(row); } } fn model_tracker(&self) -> &dyn ModelTracker { &self.notify } fn as_any(&self) -> &dyn core::any::Any { self } } /// A model backed by a `SharedVector` #[derive(Default)] pub struct SharedVectorModel { array: RefCell>, notify: ModelNotify, } impl SharedVectorModel { /// Add a row at the end of the model pub fn push(&self, value: T) { self.array.borrow_mut().push(value); self.notify.row_added(self.array.borrow().len() - 1, 1) } } impl SharedVectorModel { /// Returns a clone of the model's backing shared vector. pub fn shared_vector(&self) -> SharedVector { self.array.borrow_mut().clone() } } impl From> for SharedVectorModel { fn from(array: SharedVector) -> Self { SharedVectorModel { array: RefCell::new(array), notify: Default::default() } } } impl Model for SharedVectorModel { type Data = T; fn row_count(&self) -> usize { self.array.borrow().len() } fn row_data(&self, row: usize) -> Option { self.array.borrow().get(row).cloned() } fn set_row_data(&self, row: usize, data: Self::Data) { self.array.borrow_mut().make_mut_slice()[row] = data; self.notify.row_changed(row); } fn model_tracker(&self) -> &dyn ModelTracker { &self.notify } fn as_any(&self) -> &dyn core::any::Any { self } } impl Model for usize { type Data = i32; fn row_count(&self) -> usize { *self } fn row_data(&self, row: usize) -> Option { (row < self.row_count()).then(|| row as i32) } fn as_any(&self) -> &dyn core::any::Any { self } fn model_tracker(&self) -> &dyn ModelTracker { &() } } impl Model for bool { type Data = (); fn row_count(&self) -> usize { if *self { 1 } else { 0 } } fn row_data(&self, row: usize) -> Option { (row < self.row_count()).then(|| ()) } fn as_any(&self) -> &dyn core::any::Any { self } fn model_tracker(&self) -> &dyn ModelTracker { &() } } /// A Reference counted [`Model`]. /// /// The `ModelRc` struct holds something that implements the [`Model`] trait. /// This is used in `for` expressions in the .slint language. /// Array properties in the .slint language are holding a ModelRc. /// /// An empty model can be constructed with [`ModelRc::default()`]. /// Use [`ModelRc::new()`] To construct a ModelRc from something that implements the /// [`Model`] trait. /// It is also possible to use the [`From`] trait to convert from `Rc`. pub struct ModelRc(Option>>); impl core::fmt::Debug for ModelRc { fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result { write!(f, "ModelRc(dyn Model)") } } impl Clone for ModelRc { fn clone(&self) -> Self { Self(self.0.clone()) } } impl Default for ModelRc { /// Construct an empty model fn default() -> Self { Self(None) } } impl core::cmp::PartialEq for ModelRc { fn eq(&self, other: &Self) -> bool { match (&self.0, &other.0) { (None, None) => true, (Some(a), Some(b)) => core::ptr::eq( (&**a) as *const dyn Model as *const u8, (&**b) as *const dyn Model as *const u8, ), _ => false, } } } impl ModelRc { pub fn new(model: impl Model + 'static) -> Self { Self(Some(Rc::new(model))) } } impl + 'static> From> for ModelRc { fn from(model: Rc) -> Self { Self(Some(model)) } } impl From + 'static>> for ModelRc { fn from(model: Rc + 'static>) -> Self { Self(Some(model)) } } impl TryInto>> for ModelRc { type Error = (); fn try_into(self) -> Result>, Self::Error> { self.0.ok_or(()) } } impl Model for ModelRc { type Data = T; fn row_count(&self) -> usize { self.0.as_ref().map_or(0, |model| model.row_count()) } fn row_data(&self, row: usize) -> Option { self.0.as_ref().and_then(|model| model.row_data(row)) } fn set_row_data(&self, row: usize, data: Self::Data) { if let Some(model) = self.0.as_ref() { model.set_row_data(row, data); } } fn model_tracker(&self) -> &dyn ModelTracker { self.0.as_ref().map_or(&(), |model| model.model_tracker()) } fn as_any(&self) -> &dyn core::any::Any { self.0.as_ref().map_or(&(), |model| model.as_any()) } } /// Component that can be instantiated by a repeater. pub trait RepeatedComponent: crate::component::Component + vtable::HasStaticVTable + 'static { /// The data corresponding to the model type Data: 'static; /// Update this component at the given index and the given data fn update(&self, index: usize, data: Self::Data); /// Layout this item in the listview /// /// offset_y is the `y` position where this item should be placed. /// it should be updated to be to the y position of the next item. fn listview_layout( self: Pin<&Self>, _offset_y: &mut Coord, _viewport_width: Pin<&Property>, ) { } /// Returns what's needed to perform the layout if this component is in a box layout fn box_layout_data( self: Pin<&Self>, _orientation: Orientation, ) -> crate::layout::BoxLayoutCellData { crate::layout::BoxLayoutCellData::default() } } #[derive(Clone, Copy, PartialEq, Debug)] enum RepeatedComponentState { /// The item is in a clean state Clean, /// The model data is stale and needs to be refreshed Dirty, } struct RepeaterInner { components: Vec<(RepeatedComponentState, Option>)>, /// The model row (index) of the first component in the `components` vector. /// Only used for ListView offset: usize, /// The average visible item_height. Only used for ListView cached_item_height: Coord, } impl Default for RepeaterInner { fn default() -> Self { RepeaterInner { components: Default::default(), offset: 0, cached_item_height: 0 as _ } } } /// This field is put in a component when using the `for` syntax /// It helps instantiating the components `C` #[pin_project] pub struct RepeaterTracker { inner: RefCell>, #[pin] model: Property>, #[pin] is_dirty: Property, /// Only used for the list view to track if the scrollbar has changed and item needs to be layed out again. #[pin] listview_geometry_tracker: crate::properties::PropertyTracker, } impl ModelChangeListener for RepeaterTracker { /// Notify the peers that a specific row was changed fn row_changed(&self, row: usize) { self.is_dirty.set(true); let mut inner = self.inner.borrow_mut(); let inner = &mut *inner; if let Some(c) = inner.components.get_mut(row.wrapping_sub(inner.offset)) { c.0 = RepeatedComponentState::Dirty; } } /// Notify the peers that rows were added fn row_added(&self, mut index: usize, mut count: usize) { let mut inner = self.inner.borrow_mut(); if index < inner.offset { if index + count < inner.offset { return; } count -= inner.offset - index; index = 0; } else { index -= inner.offset; } if count == 0 || index > inner.components.len() { return; } self.is_dirty.set(true); inner.components.splice( index..index, core::iter::repeat((RepeatedComponentState::Dirty, None)).take(count), ); for c in inner.components[index + count..].iter_mut() { // Because all the indexes are dirty c.0 = RepeatedComponentState::Dirty; } } /// Notify the peers that rows were removed fn row_removed(&self, mut index: usize, mut count: usize) { let mut inner = self.inner.borrow_mut(); if index < inner.offset { if index + count < inner.offset { return; } count -= inner.offset - index; index = 0; } else { index -= inner.offset; } if count == 0 || index >= inner.components.len() { return; } if (index + count) > inner.components.len() { count = inner.components.len() - index; } self.is_dirty.set(true); inner.components.drain(index..(index + count)); for c in inner.components[index..].iter_mut() { // Because all the indexes are dirty c.0 = RepeatedComponentState::Dirty; } } fn reset(&self) { self.is_dirty.set(true); self.inner.borrow_mut().components.clear(); } } impl Default for RepeaterTracker { fn default() -> Self { Self { inner: Default::default(), model: Property::new_named(ModelRc::default(), "i_slint_core::Repeater::model"), is_dirty: Property::new_named(false, "i_slint_core::Repeater::is_dirty"), listview_geometry_tracker: Default::default(), } } } #[pin_project] pub struct Repeater(#[pin] ModelChangeListenerContainer>); impl Default for Repeater { fn default() -> Self { Self(Default::default()) } } impl Repeater { fn data(self: Pin<&Self>) -> Pin<&RepeaterTracker> { self.project_ref().0.get() } fn model(self: Pin<&Self>) -> ModelRc { // Safety: Repeater does not implement drop and never allows access to model as mutable let model = self.data().project_ref().model; if model.is_dirty() { *self.data().inner.borrow_mut() = RepeaterInner::default(); self.data().is_dirty.set(true); let m = model.get(); let peer = self.project_ref().0.model_peer(); m.model_tracker().attach_peer(peer); m } else { model.get() } } /// Call this function to make sure that the model is updated. /// The init function is the function to create a component pub fn ensure_updated(self: Pin<&Self>, init: impl Fn() -> ComponentRc) { let model = self.model(); if self.data().project_ref().is_dirty.get() { self.ensure_updated_impl(init, &model, model.row_count()); } } // returns true if new items were created fn ensure_updated_impl( self: Pin<&Self>, init: impl Fn() -> ComponentRc, model: &ModelRc, count: usize, ) -> bool { let mut inner = self.0.inner.borrow_mut(); inner.components.resize_with(count, || (RepeatedComponentState::Dirty, None)); let offset = inner.offset; let mut created = false; for (i, c) in inner.components.iter_mut().enumerate() { if c.0 == RepeatedComponentState::Dirty { if c.1.is_none() { created = true; c.1 = Some(init()); } c.1.as_ref().unwrap().update(i + offset, model.row_data(i + offset).unwrap()); c.0 = RepeatedComponentState::Clean; } } self.data().is_dirty.set(false); created } /// Same as `Self::ensuer_updated` but for a ListView pub fn ensure_updated_listview( self: Pin<&Self>, init: impl Fn() -> ComponentRc, viewport_width: Pin<&Property>, viewport_height: Pin<&Property>, viewport_y: Pin<&Property>, listview_width: Coord, listview_height: Pin<&Property>, ) { let model = self.model(); let row_count = model.row_count(); if row_count == 0 { self.0.inner.borrow_mut().components.clear(); viewport_height.set(0 as _); viewport_y.set(0 as _); return; } let init = &init; let listview_geometry_tracker = self.data().project_ref().listview_geometry_tracker; let geometry_updated = listview_geometry_tracker .evaluate_if_dirty(|| { // Fetch the model again to make sure that it is a dependency of this geometry tracker. let model = self.model(); // Also register a dependency to "is_dirty" let _ = self.data().project_ref().is_dirty.get(); let listview_height = listview_height.get(); // Compute the element height let total_height = Cell::new(0 as Coord); let min_height = Cell::new(listview_height); let count = Cell::new(0); let get_height_visitor = |item: Pin| { count.set(count.get() + 1); let height = item.as_ref().geometry().height(); total_height.set(total_height.get() + height); min_height.set(min_height.get().min(height)) }; for c in self.data().inner.borrow().components.iter() { if let Some(x) = c.1.as_ref() { get_height_visitor(x.as_pin_ref().get_item_ref(0)); } } let mut element_height = if count.get() > 0 { total_height.get() / (count.get() as Coord) } else { // There seems to be currently no items. Just instantiate one item. { let mut inner = self.0.inner.borrow_mut(); inner.offset = inner.offset.min(row_count - 1); } self.ensure_updated_impl(&init, &model, 1); if let Some(c) = self.data().inner.borrow().components.get(0) { if let Some(x) = c.1.as_ref() { get_height_visitor(x.as_pin_ref().get_item_ref(0)); } } else { panic!("Could not determine size of items"); } total_height.get() }; let min_height = min_height.get().min(element_height).max(1 as _); let mut offset_y = -viewport_y.get().min(0 as _); if offset_y > element_height * row_count as Coord - listview_height && offset_y > viewport_height.get() - listview_height { offset_y = (element_height * row_count as Coord - listview_height).max(0 as Coord); } let mut count = ((listview_height / min_height).ceil() as usize) // count never decreases to avoid too much flickering if items have different size .max(self.data().inner.borrow().components.len()) .min(row_count); let mut offset = ((offset_y / element_height).floor() as usize).min(row_count - count); self.data().inner.borrow_mut().cached_item_height = element_height; loop { self.data().inner.borrow_mut().cached_item_height = element_height; self.set_offset(offset, count); self.ensure_updated_impl(init, &model, count); let end = self.compute_layout_listview(viewport_width, listview_width); let adjusted_element_height = (end - element_height * offset as Coord) / count as Coord; element_height = adjusted_element_height; let diff = listview_height + offset_y - end; if diff > 0.5 as _ && count < row_count { // we did not create enough item, try increasing count until it matches count = (count + (diff / element_height).ceil() as usize).min(row_count); if offset + count > row_count { // apparently, we scrolled past the end, so decrease the offset and make offset_y // so we just are at the end offset = row_count - count; offset_y = (offset_y - diff).max(0 as _); } continue; } viewport_height.set((element_height * row_count as Coord).max(end)); viewport_y.set(-offset_y); break; } }) .is_some(); if !geometry_updated && self.data().project_ref().is_dirty.get() { let count = self .data() .inner .borrow() .components .len() .min(row_count.saturating_sub(self.data().inner.borrow().offset)); self.ensure_updated_impl(init, &model, count); self.compute_layout_listview(viewport_width, listview_width); } } fn set_offset(&self, offset: usize, count: usize) { let mut inner = self.0.inner.borrow_mut(); let old_offset = inner.offset; // Remove the items before the offset, or add items until the old offset let to_remove = offset.saturating_sub(old_offset); if to_remove < inner.components.len() { inner.components.splice( 0..to_remove, core::iter::repeat((RepeatedComponentState::Dirty, None)) .take(old_offset.saturating_sub(offset)), ); } else { inner.components.truncate(0); } inner.components.resize_with(count, || (RepeatedComponentState::Dirty, None)); inner.offset = offset; self.0.is_dirty.set(true); } /// Sets the data directly in the model pub fn model_set_row_data(self: Pin<&Self>, row: usize, data: C::Data) { let model = self.model(); model.set_row_data(row, data); if let Some(c) = self.data().inner.borrow_mut().components.get_mut(row) { if c.0 == RepeatedComponentState::Dirty { if let Some(comp) = c.1.as_ref() { comp.update(row, model.row_data(row).unwrap()); c.0 = RepeatedComponentState::Clean; } } } } /// Set the model binding pub fn set_model_binding(&self, binding: impl Fn() -> ModelRc + 'static) { self.0.model.set_binding(binding); } /// Call the visitor for each component pub fn visit( &self, order: TraversalOrder, mut visitor: crate::item_tree::ItemVisitorRefMut, ) -> crate::item_tree::VisitChildrenResult { // We can't keep self.inner borrowed because the event might modify the model let count = self.0.inner.borrow().components.len(); for i in 0..count { let i = if order == TraversalOrder::BackToFront { i } else { count - i - 1 }; let c = self.0.inner.borrow().components.get(i).and_then(|c| c.1.clone()); if let Some(c) = c { if c.as_pin_ref().visit_children_item(-1, order, visitor.borrow_mut()).has_aborted() { return crate::item_tree::VisitChildrenResult::abort(i, 0); } } } crate::item_tree::VisitChildrenResult::CONTINUE } /// Return the amount of item currently in the component pub fn len(&self) -> usize { self.0.inner.borrow().components.len() } /// Return the range of indices used by this Repeater. /// /// Two values are necessary here since the Repeater can start to insert the data from its /// model at an offset. pub fn range(&self) -> (usize, usize) { let inner = self.0.inner.borrow(); (inner.offset, inner.offset + inner.components.len()) } pub fn component_at(&self, index: usize) -> Option> { self.0 .inner .borrow() .components .get(index) .map(|c| c.1.clone().expect("That was updated before!")) } /// Return true if the Repeater as empty pub fn is_empty(&self) -> bool { self.len() == 0 } /// Returns a vector containing all components pub fn components_vec(&self) -> Vec> { self.0.inner.borrow().components.iter().flat_map(|x| x.1.clone()).collect() } /// Set the position of all the element in the listview /// /// Returns the offset of the end of the last element pub fn compute_layout_listview( &self, viewport_width: Pin<&Property>, listview_width: Coord, ) -> Coord { let inner = self.0.inner.borrow(); let mut y_offset = inner.offset as Coord * inner.cached_item_height; viewport_width.set(listview_width); for c in self.0.inner.borrow().components.iter() { if let Some(x) = c.1.as_ref() { x.as_pin_ref().listview_layout(&mut y_offset, viewport_width); } } y_offset } } /// Represent an item in a StandardListView #[repr(C)] #[derive(Clone, Default, Debug, PartialEq)] pub struct StandardListViewItem { /// The text content of the item pub text: crate::SharedString, } impl From<&str> for StandardListViewItem { fn from(other: &str) -> Self { return Self { text: other.into() }; } } impl From for StandardListViewItem { fn from(other: SharedString) -> Self { return Self { text: other }; } } #[test] fn test_tracking_model_handle() { let model: Rc> = Rc::new(Default::default()); let handle = ModelRc::from(model.clone() as Rc>); let tracker = Box::pin(crate::properties::PropertyTracker::default()); assert_eq!( tracker.as_ref().evaluate(|| { handle.model_tracker().track_row_count_changes(); handle.row_count() }), 0 ); assert!(!tracker.is_dirty()); model.push(42); model.push(100); assert!(tracker.is_dirty()); assert_eq!( tracker.as_ref().evaluate(|| { handle.model_tracker().track_row_count_changes(); handle.row_count() }), 2 ); assert!(!tracker.is_dirty()); model.set_row_data(0, 41); assert!(!tracker.is_dirty()); model.remove(0); assert!(tracker.is_dirty()); assert_eq!( tracker.as_ref().evaluate(|| { handle.model_tracker().track_row_count_changes(); handle.row_count() }), 1 ); assert!(!tracker.is_dirty()); model.set_vec(vec![1, 2, 3]); assert!(tracker.is_dirty()); } #[test] fn test_data_tracking() { let model: Rc> = Rc::new(VecModel::from(vec![0, 1, 2, 3, 4])); let handle = ModelRc::from(model.clone()); let tracker = Box::pin(crate::properties::PropertyTracker::default()); assert_eq!( tracker.as_ref().evaluate(|| { handle.model_tracker().track_row_data_changes(1); handle.row_data(1).unwrap() }), 1 ); assert!(!tracker.is_dirty()); model.set_row_data(2, 42); assert!(!tracker.is_dirty()); model.set_row_data(1, 100); assert!(tracker.is_dirty()); assert_eq!( tracker.as_ref().evaluate(|| { handle.model_tracker().track_row_data_changes(1); handle.row_data(1).unwrap() }), 100 ); assert!(!tracker.is_dirty()); // Any changes to rows (even if after tracked rows) for now also marks watched rows as dirty, to // keep the logic simple. model.push(200); assert!(tracker.is_dirty()); assert_eq!(tracker.as_ref().evaluate(|| { handle.row_data_tracked(1).unwrap() }), 100); assert!(!tracker.is_dirty()); model.insert(0, 255); assert!(tracker.is_dirty()); model.set_vec(vec![]); assert!(tracker.is_dirty()); } #[test] fn test_vecmodel_set_vec() { #[derive(Default)] struct TestView { // Track the parameters reported by the model (row counts, indices, etc.). // The last field in the tuple is the row size the model reports at the time // of callback changed_rows: RefCell>, added_rows: RefCell>, removed_rows: RefCell>, reset: RefCell, model: RefCell>>>, } impl TestView { fn clear(&self) { self.changed_rows.borrow_mut().clear(); self.added_rows.borrow_mut().clear(); self.removed_rows.borrow_mut().clear(); } fn row_count(&self) -> usize { self.model .borrow() .as_ref() .and_then(|model| model.upgrade()) .map_or(0, |model| model.row_count()) } } impl ModelChangeListener for TestView { fn row_changed(&self, row: usize) { self.changed_rows.borrow_mut().push((row, self.row_count())); } fn row_added(&self, index: usize, count: usize) { self.added_rows.borrow_mut().push((index, count, self.row_count())); } fn row_removed(&self, index: usize, count: usize) { self.removed_rows.borrow_mut().push((index, count, self.row_count())); } fn reset(&self) { *self.reset.borrow_mut() += 1; } } let view = Box::pin(ModelChangeListenerContainer::::default()); let model = Rc::new(VecModel::from(vec![1i32, 2, 3, 4])); model.model_tracker().attach_peer(Pin::as_ref(&view).model_peer()); *view.model.borrow_mut() = Some(std::rc::Rc::downgrade(&(model.clone() as Rc>))); model.push(5); assert!(view.changed_rows.borrow().is_empty()); assert_eq!(&*view.added_rows.borrow(), &[(4, 1, 5)]); assert!(view.removed_rows.borrow().is_empty()); assert_eq!(*view.reset.borrow(), 0); view.clear(); model.set_vec(vec![6, 7, 8]); assert!(view.changed_rows.borrow().is_empty()); assert!(view.added_rows.borrow().is_empty()); assert!(view.removed_rows.borrow().is_empty()); assert_eq!(*view.reset.borrow(), 1); view.clear(); }