Skip to main content

euv_core/vdom/node/
impl.rs

1use crate::*;
2
3/// Visual equality comparison for text nodes.
4///
5/// Only compares the text content; the backing signal is not considered
6/// because it does not affect visual output.
7impl PartialEq for TextNode {
8    fn eq(&self, other: &Self) -> bool {
9        self.get_content() == other.get_content()
10    }
11}
12
13/// Clones a `VirtualNode<T>` by deep-copying all fields.
14impl<T: Clone> Clone for VirtualNode<T> {
15    fn clone(&self) -> Self {
16        match self {
17            Self::Element {
18                tag,
19                attributes,
20                children,
21                key,
22                props,
23            } => Self::Element {
24                tag: tag.clone(),
25                attributes: attributes.clone(),
26                children: children.clone(),
27                key: key.clone(),
28                props: props.clone(),
29            },
30            Self::Text(text_node) => Self::Text(text_node.clone()),
31            Self::Fragment(children) => Self::Fragment(children.clone()),
32            Self::Dynamic(dynamic_node) => Self::Dynamic(dynamic_node.clone()),
33            Self::Empty => Self::Empty,
34        }
35    }
36}
37
38/// Debug formatting for `VirtualNode<T>`.
39///
40/// Skips `Dynamic` inner details and `props` for brevity.
41impl<T: std::fmt::Debug> std::fmt::Debug for VirtualNode<T> {
42    fn fmt(&self, formatter: &mut Formatter<'_>) -> fmt::Result {
43        match self {
44            Self::Element {
45                tag,
46                attributes,
47                children,
48                key,
49                props,
50            } => formatter
51                .debug_struct("Element")
52                .field("tag", tag)
53                .field("attributes", attributes)
54                .field("children", children)
55                .field("key", key)
56                .field("props", props)
57                .finish(),
58            Self::Text(text_node) => formatter.debug_tuple("Text").field(text_node).finish(),
59            Self::Fragment(children) => formatter.debug_tuple("Fragment").field(children).finish(),
60            Self::Dynamic(_) => formatter.debug_tuple("Dynamic").finish(),
61            Self::Empty => formatter.debug_tuple("Empty").finish(),
62        }
63    }
64}
65
66/// Default implementation returns `VirtualNode::Empty`.
67impl<T> Default for VirtualNode<T> {
68    fn default() -> Self {
69        Self::Empty
70    }
71}
72
73/// Visual equality comparison for virtual DOM nodes.
74///
75/// Used by DynamicNode re-rendering to skip unnecessary DOM patches when
76/// the rendered output has not changed. Event attributes are always
77/// considered equal because re-binding event listeners is handled
78/// separately by the handler registry and does not affect visual output.
79/// Dynamic nodes manage their own subtree re-rendering, so two Dynamic
80/// variants are always considered equal — the inner renderer handles
81/// patching when the dynamic content actually changes.
82impl<T: PartialEq> PartialEq for VirtualNode<T> {
83    fn eq(&self, other: &Self) -> bool {
84        match (self, other) {
85            (VirtualNode::Text(old_text), VirtualNode::Text(new_text)) => old_text == new_text,
86            (
87                VirtualNode::Element {
88                    tag: old_tag,
89                    attributes: old_attrs,
90                    children: old_children,
91                    props: old_props,
92                    ..
93                },
94                VirtualNode::Element {
95                    tag: new_tag,
96                    attributes: new_attrs,
97                    children: new_children,
98                    props: new_props,
99                    ..
100                },
101            ) => {
102                old_tag == new_tag
103                    && old_attrs.len() == new_attrs.len()
104                    && old_attrs.iter().zip(new_attrs.iter()).all(
105                        |(old_attr, new_attr): (&AttributeEntry, &AttributeEntry)| {
106                            old_attr == new_attr
107                        },
108                    )
109                    && old_children.len() == new_children.len()
110                    && old_children.iter().zip(new_children.iter()).all(
111                        |(old_child, new_child): (&VirtualNode, &VirtualNode)| {
112                            old_child == new_child
113                        },
114                    )
115                    && old_props == new_props
116            }
117            (VirtualNode::Fragment(old_children), VirtualNode::Fragment(new_children)) => {
118                old_children.len() == new_children.len()
119                    && old_children.iter().zip(new_children.iter()).all(
120                        |(old_child, new_child): (&VirtualNode, &VirtualNode)| {
121                            old_child == new_child
122                        },
123                    )
124            }
125            (VirtualNode::Dynamic(_), VirtualNode::Dynamic(_)) => false,
126            (VirtualNode::Empty, VirtualNode::Empty) => true,
127            _ => false,
128        }
129    }
130}
131
132/// Provides a default empty dynamic node with a no-op render function.
133impl Default for DynamicNode {
134    fn default() -> Self {
135        let render_fn_inner: Rc<RefCell<RenderFnInner>> =
136            Rc::new(RefCell::new(RenderFnInner::new(Box::new(|| {
137                VirtualNode::Empty
138            }))));
139        Self::new(render_fn_inner, HookContext::default())
140    }
141}
142
143/// Clones a `DynamicNode` by cloning the shared references.
144impl Clone for DynamicNode {
145    fn clone(&self) -> Self {
146        Self::new(
147            self.get_render_fn().clone(),
148            self.get_hook_context().clone(),
149        )
150    }
151}
152
153/// Implementation of dynamic node accessor methods.
154impl DynamicNode {
155    /// Invokes the render closure and returns the produced virtual node.
156    ///
157    /// # Returns
158    ///
159    /// - `Self` - The virtual node produced by the render closure.
160    pub fn render(&self) -> VirtualNode {
161        self.get_render_fn()
162            .try_borrow_mut()
163            .map(|mut inner: RefMut<RenderFnInner>| (inner.get_mut_render_fn())())
164            .unwrap_or_default()
165    }
166}
167
168/// Implementation of virtual node construction and property extraction.
169impl<T> VirtualNode<T> {
170    /// Returns the tag name if this is an element or component node.
171    ///
172    /// # Returns
173    ///
174    /// - `Option<String>` - The tag name, or `None` if not an element.
175    pub fn try_get_tag_name(&self) -> Option<String> {
176        match self {
177            Self::Element { tag, .. } => match tag {
178                Tag::Element(name) => Some(name.clone()),
179                Tag::Component(name) => Some(name.clone()),
180            },
181            _ => None,
182        }
183    }
184
185    /// Returns a reference to the children of this node, if it has any.
186    ///
187    /// Returns `Some` for `Element` and `Fragment` variants, `None` otherwise.
188    ///
189    /// # Returns
190    ///
191    /// - `Option<&Vec<VirtualNode>>` - The children, or `None`.
192    pub fn try_get_children(&self) -> Option<&Vec<VirtualNode>> {
193        match self {
194            Self::Element { children, .. } => Some(children),
195            Self::Fragment(children) => Some(children),
196            _ => None,
197        }
198    }
199
200    /// Returns `true` if this node has non-empty children.
201    ///
202    /// # Returns
203    ///
204    /// - `bool` - Whether this node has children.
205    pub fn has_children(&self) -> bool {
206        self.try_get_children()
207            .is_some_and(|children: &Vec<VirtualNode>| !children.is_empty())
208    }
209
210    /// Clones the props of this node.
211    ///
212    /// # Returns
213    ///
214    /// - `Option<T>` - The cloned props, or `None` if this node has no props.
215    pub fn try_get_props(&self) -> Option<T>
216    where
217        T: Clone,
218    {
219        match self {
220            Self::Element { props, .. } => props.as_deref().cloned(),
221            _ => None,
222        }
223    }
224
225    /// Returns the children of this node as a virtual node.
226    ///
227    /// Returns `VirtualNode::Empty` when there are no children, a single child
228    /// when there is exactly one, or `VirtualNode::Fragment` when there are
229    /// multiple children.
230    ///
231    /// # Returns
232    ///
233    /// - `VirtualNode` - The children as a virtual node.
234    pub fn try_get_child_node(&self) -> VirtualNode {
235        match self.try_get_children() {
236            Some(children) => match children.len() {
237                0 => VirtualNode::Empty,
238                1 => children.first().cloned().unwrap_or_default(),
239                _ => VirtualNode::Fragment(children.clone()),
240            },
241            None => VirtualNode::Empty,
242        }
243    }
244}
245
246/// Implementation of virtual node construction for `VirtualNode<()>`.
247impl VirtualNode<()> {
248    /// Constructs a `Self::Dynamic` from a render closure with hook context management.
249    ///
250    /// # Arguments
251    ///
252    /// - `FnMut() -> Self + 'static` - The render closure that produces
253    ///   a virtual node tree. Called on initial render and on every signal update.
254    ///
255    /// # Returns
256    ///
257    /// - `Self` - A `Self::Dynamic` wrapping the render closure
258    ///   with a fresh `HookContext`.
259    pub fn create_dynamic<F>(mut render_fn: F) -> Self
260    where
261        F: FnMut() -> Self + 'static,
262    {
263        let hook_context: HookContext = create_hook_context();
264        let mut hook_context_for_closure: HookContext = hook_context.clone();
265        let inner: Rc<RefCell<RenderFnInner>> =
266            Rc::new(RefCell::new(RenderFnInner::new(Box::new(move || {
267                hook_context_for_closure.reset_hook_index();
268                render_fn()
269            }))));
270        Self::Dynamic(DynamicNode::new(inner, hook_context))
271    }
272
273    /// Constructs a `Self::Dynamic` for match expressions where arm hook
274    /// isolation is required. The render closure receives a `&mut HookContext`
275    /// so it can call `set_arm_changed` before each arm body.
276    ///
277    /// # Arguments
278    ///
279    /// - `FnMut(&mut HookContext) -> Self + 'static` - The render closure
280    ///   that receives a mutable reference to the hook context.
281    ///
282    /// # Returns
283    ///
284    /// - `Self` - A `Self::Dynamic` wrapping the render closure
285    ///   with a fresh `HookContext`.
286    pub fn create_dynamic_with_context<F>(mut render_fn: F) -> Self
287    where
288        F: FnMut(&mut HookContext) -> Self + 'static,
289    {
290        let hook_context: HookContext = create_hook_context();
291        let mut hook_context_for_closure: HookContext = hook_context.clone();
292        let inner: Rc<RefCell<RenderFnInner>> =
293            Rc::new(RefCell::new(RenderFnInner::new(Box::new(move || {
294                hook_context_for_closure.reset_hook_index();
295                render_fn(&mut hook_context_for_closure)
296            }))));
297        Self::Dynamic(DynamicNode::new(inner, hook_context))
298    }
299}