//! Store internal widget state in a state tree to ensure continuity. use crate::Widget; use crate::id::{Id, Internal}; use std::any::{self, Any}; use std::borrow::{Borrow, BorrowMut, Cow}; use std::collections::HashMap; use std::hash::Hash; use std::{fmt, mem}; thread_local! { /// A map of named widget states. pub static NAMED: std::cell::RefCell, (State, Vec<(usize, Tree)>)>> = std::cell::RefCell::new(HashMap::new()); } /// A persistent state widget tree. /// /// A [`Tree`] is normally associated with a specific widget in the widget tree. #[derive(Debug)] pub struct Tree { /// The tag of the [`Tree`]. pub tag: Tag, /// the Id of the [`Tree`] pub id: Option, /// The [`State`] of the [`Tree`]. pub state: State, /// The children of the root widget of the [`Tree`]. pub children: Vec, } impl Tree { /// Creates an empty, stateless [`Tree`] with no children. pub fn empty() -> Self { Self { id: None, tag: Tag::stateless(), state: State::None, children: Vec::new(), } } /// Creates a new [`Tree`] for the provided [`Widget`]. pub fn new<'a, Message, Theme, Renderer>( widget: impl Borrow + 'a>, ) -> Self where Renderer: crate::Renderer, { let widget = widget.borrow(); Self { id: widget.id(), tag: widget.tag(), state: widget.state(), children: widget.children(), } } /// Takes all named widgets from the tree. pub fn take_all_named( &mut self, ) -> HashMap, (State, Vec<(usize, Tree)>)> { let mut named = HashMap::new(); struct Visit { parent: Cow<'static, str>, index: usize, visited: bool, } // tree traversal to find all named widgets // and keep their state and children let mut stack = vec![(self, None)]; while let Some((tree, visit)) = stack.pop() { if let Some(Id(Internal::Custom(_, n))) = tree.id.clone() { let state = mem::replace(&mut tree.state, State::None); let children_count = tree.children.len(); let children = tree.children.iter_mut().enumerate().rev().map(|(i, c)| { if matches!(c.id, Some(Id(Internal::Custom(_, _)))) { (c, None) } else { ( c, Some(Visit { index: i, parent: n.clone(), visited: false, }), ) } }); _ = named.insert( n.clone(), (state, Vec::with_capacity(children_count)), ); stack.extend(children); } else if let Some(visit) = visit { if visit.visited { named.get_mut(&visit.parent).unwrap().1.push(( visit.index, mem::replace( tree, Tree { id: tree.id.clone(), tag: tree.tag, ..Tree::empty() }, ), )); } else { let ptr = tree as *mut Tree; stack.push(( // TODO remove this unsafe block #[allow(unsafe_code)] // SAFETY: when the reference is finally accessed, all the children references will have been processed first. unsafe { ptr.as_mut().unwrap() }, Some(Visit { visited: true, ..visit }), )); stack.extend(tree.children.iter_mut().map(|c| (c, None))); } } else { stack.extend(tree.children.iter_mut().map(|s| (s, None))); } } named } /// Finds a widget state in the tree by its id. pub fn find<'a>(&'a self, id: &Id) -> Option<&'a Tree> { if self.id == Some(id.clone()) { return Some(self); } for child in self.children.iter() { if let Some(tree) = child.find(id) { return Some(tree); } } None } /// Reconciliates the current tree with the provided [`Widget`]. /// /// If the tag of the [`Widget`] matches the tag of the [`Tree`], then the /// [`Widget`] proceeds with the reconciliation (i.e. [`Widget::diff`] is called). /// /// Otherwise, the whole [`Tree`] is recreated. /// /// [`Widget::diff`]: crate::Widget::diff pub fn diff<'a, Message, Theme, Renderer>( &mut self, mut new: impl BorrowMut + 'a>, ) where Renderer: crate::Renderer, { let borrowed: &mut dyn Widget = new.borrow_mut(); let mut needs_reset = false; let tag_match = self.tag == borrowed.tag(); if let Some(Id(Internal::Custom(_, n))) = borrowed.id() { if let Some((mut state, children)) = NAMED .with(|named| named.borrow_mut().remove(&n)) .or_else(|| { //check self.id if let Some(Id(Internal::Custom(_, ref name))) = self.id { if name == &n { Some(( mem::replace(&mut self.state, State::None), self.children .iter_mut() .map(|s| { // take the data mem::replace( s, Tree { id: s.id.clone(), tag: s.tag, ..Tree::empty() }, ) }) .enumerate() .collect(), )) } else { None } } else { None } }) { std::mem::swap(&mut self.state, &mut state); let widget_children = borrowed.children(); if !tag_match || self.children.len() != widget_children.len() { self.children = borrowed.children(); } else { for (old_i, mut old) in children { let Some(my_state) = self.children.get_mut(old_i) else { continue; }; if my_state.tag != old.tag || { !match (&old.id, &my_state.id) { ( Some(Id(Internal::Custom(_, old_name))), Some(Id(Internal::Custom(_, my_name))), ) => old_name == my_name, ( Some(Id(Internal::Set(a))), Some(Id(Internal::Set(b))), ) => a.len() == b.len(), ( Some(Id(Internal::Unique(_))), Some(Id(Internal::Unique(_))), ) => true, (None, None) => true, _ => false, } } { continue; } mem::swap(my_state, &mut old); } } } else { needs_reset = true; } } else if tag_match { if let Some(id) = self.id.clone() { borrowed.set_id(id); } if self.children.len() != borrowed.children().len() { self.children = borrowed.children(); } } else { needs_reset = true; } if needs_reset { *self = Self::new(borrowed); let borrowed = new.borrow_mut(); borrowed.diff(self); } else { borrowed.diff(self); } } /// Reconciles the children of the tree with the provided list of widgets. pub fn diff_children<'a, Message, Theme, Renderer>( &mut self, new_children: &mut [impl BorrowMut< dyn Widget + 'a, >], ) where Renderer: crate::Renderer, { self.diff_children_custom( new_children, new_children.iter().map(|c| c.borrow().id()).collect(), |tree, widget| { let borrowed: &mut dyn Widget<_, _, _> = widget.borrow_mut(); tree.diff(borrowed) }, |widget| { let borrowed: &dyn Widget<_, _, _> = widget.borrow(); Self::new(borrowed) }, ) } /// Reconciles the children of the tree with the provided list of widgets using custom /// logic both for diffing and creating new widget state. pub fn diff_children_custom( &mut self, new_children: &mut [T], new_ids: Vec>, diff: impl Fn(&mut Tree, &mut T), new_state: impl Fn(&T) -> Self, ) { if self.children.len() > new_children.len() { self.children.truncate(new_children.len()); } let len_changed = self.children.len() != new_children.len(); let children_len = self.children.len(); let (mut id_map, mut id_list): ( HashMap, Vec<&mut Tree>, ) = self.children.iter_mut().fold( (HashMap::new(), Vec::with_capacity(children_len)), |(mut id_map, mut id_list), c| { if let Some(id) = c.id.as_ref() { if let Internal::Custom(_, ref name) = id.0 { let _ = id_map.insert(name.to_string(), c); } else { id_list.push(c); } } else { id_list.push(c); } (id_map, id_list) }, ); let mut child_state_i = 0; let mut new_trees: Vec<(Tree, usize)> = Vec::with_capacity(new_children.len()); for (i, (new, new_id)) in new_children.iter_mut().zip(new_ids.iter()).enumerate() { let child_state = if let Some(c) = new_id.as_ref().and_then(|id| { if let Internal::Custom(_, ref name) = id.0 { id_map.remove(name.as_ref()) } else { None } }) { c } else if child_state_i < id_list.len() && !matches!( id_list[child_state_i].id, Some(Id(Internal::Custom(_, _))) ) { let c = &mut id_list[child_state_i]; if len_changed { c.id.clone_from(new_id); } child_state_i += 1; c } else { let mut my_new_state = new_state(new); diff(&mut my_new_state, new); new_trees.push((my_new_state, i)); continue; }; diff(child_state, new); } for (new_tree, i) in new_trees { if self.children.len() > i { self.children[i] = new_tree; } else { self.children.push(new_tree); } } } } /// Reconciles the `current_children` with the provided list of widgets using /// custom logic both for diffing and creating new widget state. /// /// The algorithm will try to minimize the impact of diffing by querying the /// `maybe_changed` closure. pub fn diff_children_custom_with_search( current_children: &mut Vec, new_children: &mut [T], diff: impl Fn(&mut Tree, &mut T), maybe_changed: impl Fn(usize) -> bool, new_state: impl Fn(&T) -> Tree, ) { if new_children.is_empty() { current_children.clear(); return; } if current_children.is_empty() { current_children.extend(new_children.iter().map(new_state)); return; } let first_maybe_changed = maybe_changed(0); let last_maybe_changed = maybe_changed(current_children.len() - 1); if current_children.len() > new_children.len() { if !first_maybe_changed && last_maybe_changed { current_children.truncate(new_children.len()); } else { let difference_index = if first_maybe_changed { 0 } else { (1..current_children.len()) .find(|&i| maybe_changed(i)) .unwrap_or(0) }; let _ = current_children.splice( difference_index ..difference_index + (current_children.len() - new_children.len()), std::iter::empty(), ); } } if current_children.len() < new_children.len() { let first_maybe_changed = maybe_changed(0); let last_maybe_changed = maybe_changed(current_children.len() - 1); if !first_maybe_changed && last_maybe_changed { current_children.extend( new_children[current_children.len()..].iter().map(new_state), ); } else { let difference_index = if first_maybe_changed { 0 } else { (1..current_children.len()) .find(|&i| maybe_changed(i)) .unwrap_or(0) }; let _ = current_children.splice( difference_index..difference_index, new_children[difference_index ..difference_index + (new_children.len() - current_children.len())] .iter() .map(new_state), ); } } // TODO: Merge loop with extend logic (?) for (child_state, new) in current_children.iter_mut().zip(new_children.iter_mut()) { diff(child_state, new); } } /// The identifier of some widget state. #[derive(Debug, Clone, Copy, PartialOrd, Ord, PartialEq, Eq, Hash)] pub struct Tag(any::TypeId); impl Tag { /// Creates a [`Tag`] for a state of type `T`. pub fn of() -> Self where T: 'static, { Self(any::TypeId::of::()) } /// Creates a [`Tag`] for a stateless widget. pub fn stateless() -> Self { Self::of::<()>() } } /// The internal [`State`] of a widget. pub enum State { /// No meaningful internal state. None, /// Some meaningful internal state. Some(Box), } impl State { /// Creates a new [`State`]. pub fn new(state: T) -> Self where T: 'static, { State::Some(Box::new(state)) } /// Downcasts the [`State`] to `T` and returns a reference to it. /// /// # Panics /// This method will panic if the downcast fails or the [`State`] is [`State::None`]. pub fn downcast_ref(&self) -> &T where T: 'static, { match self { State::None => panic!("Downcast on stateless state"), State::Some(state) => { state.downcast_ref().expect("Downcast widget state") } } } /// Downcasts the [`State`] to `T` and returns a mutable reference to it. /// /// # Panics /// This method will panic if the downcast fails or the [`State`] is [`State::None`]. pub fn downcast_mut(&mut self) -> &mut T where T: 'static, { match self { State::None => panic!("Downcast on stateless state"), State::Some(state) => { state.downcast_mut().expect("Downcast widget state") } } } } impl fmt::Debug for State { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { match self { Self::None => write!(f, "State::None"), Self::Some(_) => write!(f, "State::Some"), } } }