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<UnsafeCell<RenderFnInner>> = Rc::new(UnsafeCell::new(
136 RenderFnInner::new(Box::new(|_: &mut HookContext| VirtualNode::Empty)),
137 ));
138 Self::new(render_fn_inner, HookContext::default())
139 }
140}
141
142/// Implementation of dynamic node accessor methods.
143impl DynamicNode {
144 /// Invokes the render closure and returns the produced virtual node.
145 ///
146 /// # Safety
147 ///
148 /// Must only be called from the main thread. Guaranteed in WASM
149 /// single-threaded context. No concurrent access is possible.
150 ///
151 /// # Arguments
152 ///
153 /// - `&mut HookContext` - The hook context to pass to the render closure.
154 ///
155 /// # Returns
156 ///
157 /// - `VirtualNode` - The virtual node produced by the render closure.
158 pub fn render(&self, hook_context: &mut HookContext) -> VirtualNode {
159 let inner: &mut RenderFnInner = unsafe { &mut *self.get_render_fn().get() };
160 (inner.get_mut_render_fn())(hook_context)
161 }
162}
163
164/// Implementation of virtual node construction and property extraction.
165impl<T> VirtualNode<T> {
166 /// Returns the tag name if this is an element or component node.
167 ///
168 /// # Returns
169 ///
170 /// - `Option<String>` - The tag name, or `None` if not an element.
171 pub fn try_get_tag_name(&self) -> Option<String> {
172 match self {
173 Self::Element { tag, .. } => match tag {
174 Tag::Element(name) => Some(name.clone()),
175 Tag::Component(name) => Some(name.clone()),
176 },
177 _ => None,
178 }
179 }
180
181 /// Returns a reference to the children of this node, if it has any.
182 ///
183 /// Returns `Some` for `Element` and `Fragment` variants, `None` otherwise.
184 ///
185 /// # Returns
186 ///
187 /// - `Option<&Vec<VirtualNode>>` - The children, or `None`.
188 pub fn try_get_children(&self) -> Option<&Vec<VirtualNode>> {
189 match self {
190 Self::Element { children, .. } => Some(children),
191 Self::Fragment(children) => Some(children),
192 _ => None,
193 }
194 }
195
196 /// Returns `true` if this node has non-empty children.
197 ///
198 /// # Returns
199 ///
200 /// - `bool` - Whether this node has children.
201 pub fn has_children(&self) -> bool {
202 self.try_get_children()
203 .is_some_and(|children: &Vec<VirtualNode>| !children.is_empty())
204 }
205
206 /// Clones the props of this node.
207 ///
208 /// # Returns
209 ///
210 /// - `Option<T>` - The cloned props, or `None` if this node has no props.
211 pub fn try_get_props(&self) -> Option<T>
212 where
213 T: Clone,
214 {
215 match self {
216 Self::Element { props, .. } => props.as_deref().cloned(),
217 _ => None,
218 }
219 }
220
221 /// Returns the children of this node as a virtual node.
222 ///
223 /// Returns `VirtualNode::Empty` when there are no children, a single child
224 /// when there is exactly one, or `VirtualNode::Fragment` when there are
225 /// multiple children.
226 ///
227 /// # Returns
228 ///
229 /// - `Option<VirtualNode>` - The children as a virtual node.
230 pub fn try_get_child_node(&self) -> Option<VirtualNode> {
231 match self.try_get_children() {
232 Some(children) => match children.len() {
233 0 => None,
234 1 => children.first().cloned(),
235 _ => Some(VirtualNode::Fragment(children.clone())),
236 },
237 None => None,
238 }
239 }
240
241 /// Returns the children of this node as a virtual node.
242 ///
243 /// Returns `VirtualNode::Empty` when there are no children, a single child
244 /// when there is exactly one, or `VirtualNode::Fragment` when there are
245 /// multiple children.
246 ///
247 /// # Returns
248 ///
249 /// - `VirtualNode` - The children as a virtual node.
250 pub fn get_child_node(&self) -> VirtualNode {
251 self.try_get_child_node().unwrap_or_default()
252 }
253}
254
255/// Implementation of virtual node construction for `VirtualNode<()>`.
256impl VirtualNode<()> {
257 /// Creates a dynamic node with the given render function.
258 ///
259 /// # Arguments
260 ///
261 /// - `F: FnMut(&mut HookContext) -> Self + 'static` - The render function.
262 ///
263 /// # Returns
264 ///
265 /// - `Self` - The dynamic node.
266 pub fn create_dynamic<F>(render_fn: F) -> Self
267 where
268 F: FnMut(&mut HookContext) -> Self + 'static,
269 {
270 let hook_context: HookContext = HookContext::default();
271 let inner: Rc<UnsafeCell<RenderFnInner>> =
272 Rc::new(UnsafeCell::new(RenderFnInner::new(Box::new(render_fn))));
273 Self::Dynamic(DynamicNode::new(inner, hook_context))
274 }
275}