Skip to main content

cranpose_ui/modifier/
slices.rs

1use std::fmt;
2use std::mem::size_of;
3use std::rc::Rc;
4
5use cranpose_foundation::{ModifierNodeChain, NodeCapabilities, PointerEvent};
6use cranpose_ui_graphics::{ColorFilter, GraphicsLayer, RenderEffect};
7
8use super::{ModifierChainHandle, Point};
9use crate::draw::DrawCommand;
10use crate::modifier::scroll::{MotionContextAnimatedNode, TranslatedContentContextNode};
11use crate::modifier::Modifier;
12use crate::modifier_nodes::{
13    BackgroundNode, ClipToBoundsNode, CornerShapeNode, DrawCommandNode, GraphicsLayerNode,
14    PaddingNode,
15};
16use crate::text::{TextLayoutOptions, TextStyle};
17use crate::text_field_modifier_node::TextFieldModifierNode;
18use crate::text_modifier_node::{TextModifierNode, TextPreparedLayoutHandle};
19use cranpose_ui_graphics::EdgeInsets;
20
21/// Snapshot of modifier node slices that impact draw and pointer subsystems.
22#[derive(Default)]
23pub struct ModifierNodeSlices {
24    draw_commands: Vec<DrawCommand>,
25    pointer_inputs: Vec<Rc<dyn Fn(PointerEvent)>>,
26    click_handlers: Vec<Rc<dyn Fn(Point)>>,
27    clip_to_bounds: bool,
28    motion_context_animated: bool,
29    translated_content_context: bool,
30    translated_content_context_identity: Option<usize>,
31    translated_content_offset_reader: Option<Rc<dyn Fn() -> Point>>,
32    text_content: Option<Rc<crate::text::AnnotatedString>>,
33    text_style: Option<TextStyle>,
34    text_layout_options: Option<TextLayoutOptions>,
35    prepared_text_layout: Option<TextPreparedLayoutHandle>,
36    graphics_layer: Option<GraphicsLayer>,
37    graphics_layer_resolver: Option<Rc<dyn Fn() -> GraphicsLayer>>,
38    chain_guard: Option<Rc<ChainGuard>>,
39}
40
41struct ChainGuard {
42    _handle: ModifierChainHandle,
43}
44
45#[derive(Clone, Copy, Debug, Default, PartialEq, Eq)]
46pub struct ModifierNodeSlicesDebugStats {
47    pub draw_command_count: usize,
48    pub draw_command_capacity: usize,
49    pub pointer_input_count: usize,
50    pub pointer_input_capacity: usize,
51    pub click_handler_count: usize,
52    pub click_handler_capacity: usize,
53    pub has_text_content: bool,
54    pub has_text_style: bool,
55    pub has_text_layout_options: bool,
56    pub has_prepared_text_layout: bool,
57    pub has_graphics_layer: bool,
58    pub has_graphics_layer_resolver: bool,
59    pub heap_bytes: usize,
60}
61
62impl Clone for ModifierNodeSlices {
63    fn clone(&self) -> Self {
64        Self {
65            draw_commands: self.draw_commands.clone(),
66            pointer_inputs: self.pointer_inputs.clone(),
67            click_handlers: self.click_handlers.clone(),
68            clip_to_bounds: self.clip_to_bounds,
69            motion_context_animated: self.motion_context_animated,
70            translated_content_context: self.translated_content_context,
71            translated_content_context_identity: self.translated_content_context_identity,
72            translated_content_offset_reader: self.translated_content_offset_reader.clone(),
73            text_content: self.text_content.clone(),
74            text_style: self.text_style.clone(),
75            text_layout_options: self.text_layout_options,
76            prepared_text_layout: self.prepared_text_layout.clone(),
77            graphics_layer: self.graphics_layer.clone(),
78            graphics_layer_resolver: self.graphics_layer_resolver.clone(),
79            chain_guard: self.chain_guard.clone(),
80        }
81    }
82}
83
84/// Compose two nested graphics layers (`base` outer, `overlay` inner) into one
85/// flattened layer snapshot used by render pipelines.
86///
87/// Composition rules follow how nested transforms/effects behave visually:
88/// - Multiplicative: `alpha`, `scale`, `scale_x`, `scale_y`
89/// - Additive: `rotation_*`, `translation_*`
90/// - Boolean OR: `clip`
91/// - Overlay-wins when explicitly set: camera distance, transform origin,
92///   shadow elevation/colors, shape, compositing strategy, blend mode
93/// - Filters/effects are composed in draw order:
94///   - color filters are multiplied where possible
95///   - render effects chain inner-first then outer (`inner.then(outer)`)
96/// - Backdrop effect keeps the most local explicit backdrop effect because
97///   backdrop sampling cannot be safely flattened as a deterministic chain.
98fn merge_graphics_layers(base: GraphicsLayer, overlay: GraphicsLayer) -> GraphicsLayer {
99    GraphicsLayer {
100        alpha: (base.alpha * overlay.alpha).clamp(0.0, 1.0),
101        scale: base.scale * overlay.scale,
102        scale_x: base.scale_x * overlay.scale_x,
103        scale_y: base.scale_y * overlay.scale_y,
104        rotation_x: base.rotation_x + overlay.rotation_x,
105        rotation_y: base.rotation_y + overlay.rotation_y,
106        rotation_z: base.rotation_z + overlay.rotation_z,
107        camera_distance: overlay.camera_distance,
108        transform_origin: overlay.transform_origin,
109        translation_x: base.translation_x + overlay.translation_x,
110        translation_y: base.translation_y + overlay.translation_y,
111        shadow_elevation: overlay.shadow_elevation,
112        ambient_shadow_color: overlay.ambient_shadow_color,
113        spot_shadow_color: overlay.spot_shadow_color,
114        shape: overlay.shape,
115        clip: base.clip || overlay.clip,
116        compositing_strategy: overlay.compositing_strategy,
117        blend_mode: overlay.blend_mode,
118        color_filter: compose_color_filters(base.color_filter, overlay.color_filter),
119        // Modifiers are traversed outer -> inner. Layer effects therefore compose
120        // inner-first, then outer, matching nested layer rendering semantics.
121        render_effect: compose_render_effects(base.render_effect, overlay.render_effect),
122        // Backdrop effects cannot be represented as a deterministic chain on a
123        // flattened single layer, so keep the most local explicit backdrop.
124        backdrop_effect: overlay.backdrop_effect.or(base.backdrop_effect),
125    }
126}
127
128fn compose_render_effects(
129    outer: Option<RenderEffect>,
130    inner: Option<RenderEffect>,
131) -> Option<RenderEffect> {
132    match (outer, inner) {
133        (None, None) => None,
134        (Some(effect), None) | (None, Some(effect)) => Some(effect),
135        (Some(outer_effect), Some(inner_effect)) => Some(inner_effect.then(outer_effect)),
136    }
137}
138
139fn compose_color_filters(
140    base: Option<ColorFilter>,
141    overlay: Option<ColorFilter>,
142) -> Option<ColorFilter> {
143    match (base, overlay) {
144        (None, None) => None,
145        (Some(filter), None) | (None, Some(filter)) => Some(filter),
146        (Some(filter), Some(next)) => Some(filter.compose(next)),
147    }
148}
149
150impl ModifierNodeSlices {
151    pub fn draw_commands(&self) -> &[DrawCommand] {
152        &self.draw_commands
153    }
154
155    pub fn pointer_inputs(&self) -> &[Rc<dyn Fn(PointerEvent)>] {
156        &self.pointer_inputs
157    }
158
159    pub fn click_handlers(&self) -> &[Rc<dyn Fn(Point)>] {
160        &self.click_handlers
161    }
162
163    pub fn clip_to_bounds(&self) -> bool {
164        self.clip_to_bounds
165    }
166
167    pub fn motion_context_animated(&self) -> bool {
168        self.motion_context_animated
169    }
170
171    pub fn translated_content_context(&self) -> bool {
172        self.translated_content_context
173    }
174
175    pub fn translated_content_context_identity(&self) -> Option<usize> {
176        self.translated_content_context_identity
177    }
178
179    pub fn translated_content_offset(&self) -> Option<Point> {
180        self.translated_content_offset_reader
181            .as_ref()
182            .map(|reader| reader())
183    }
184
185    pub fn text_content(&self) -> Option<&str> {
186        self.text_content.as_ref().map(|a| a.text.as_str())
187    }
188
189    pub fn annotated_text(&self) -> Option<&crate::text::AnnotatedString> {
190        self.text_content.as_deref()
191    }
192
193    pub fn annotated_string(&self) -> Option<crate::text::AnnotatedString> {
194        self.annotated_text().cloned()
195    }
196
197    pub fn text_style(&self) -> Option<&TextStyle> {
198        self.text_style.as_ref()
199    }
200
201    pub fn text_layout_options(&self) -> Option<TextLayoutOptions> {
202        self.text_layout_options
203    }
204
205    pub fn prepare_text_layout(
206        &self,
207        max_width: Option<f32>,
208    ) -> Option<crate::text::PreparedTextLayout> {
209        if let Some(handle) = &self.prepared_text_layout {
210            return Some(handle.prepare(max_width));
211        }
212
213        let text = self.annotated_text()?;
214        let style = self.text_style.clone().unwrap_or_default();
215        Some(crate::text::prepare_text_layout(
216            text,
217            &style,
218            self.text_layout_options.unwrap_or_default(),
219            max_width,
220        ))
221    }
222
223    pub fn graphics_layer(&self) -> Option<GraphicsLayer> {
224        if let Some(resolve) = &self.graphics_layer_resolver {
225            Some(resolve())
226        } else {
227            self.graphics_layer.clone()
228        }
229    }
230
231    fn push_graphics_layer(
232        &mut self,
233        layer: GraphicsLayer,
234        resolver: Option<Rc<dyn Fn() -> GraphicsLayer>>,
235    ) {
236        let existing_snapshot = self.graphics_layer.clone();
237        let next_snapshot = existing_snapshot
238            .as_ref()
239            .map(|current| merge_graphics_layers(current.clone(), layer.clone()))
240            .unwrap_or_else(|| layer.clone());
241        let existing_resolver = self.graphics_layer_resolver.clone();
242
243        self.graphics_layer = Some(next_snapshot);
244        self.graphics_layer_resolver = match (existing_resolver, resolver) {
245            (None, None) => None,
246            (Some(current_resolver), None) => {
247                let layer = layer.clone();
248                Some(Rc::new(move || {
249                    merge_graphics_layers(current_resolver(), layer.clone())
250                }))
251            }
252            (None, Some(next_resolver)) => {
253                let base = existing_snapshot.unwrap_or_default();
254                Some(Rc::new(move || {
255                    merge_graphics_layers(base.clone(), next_resolver())
256                }))
257            }
258            (Some(current_resolver), Some(next_resolver)) => Some(Rc::new(move || {
259                merge_graphics_layers(current_resolver(), next_resolver())
260            })),
261        };
262    }
263
264    pub fn with_chain_guard(mut self, handle: ModifierChainHandle) -> Self {
265        self.chain_guard = Some(Rc::new(ChainGuard { _handle: handle }));
266        self
267    }
268
269    pub fn debug_stats(&self) -> ModifierNodeSlicesDebugStats {
270        let draw_command_bytes = self.draw_commands.capacity() * size_of::<DrawCommand>();
271        let pointer_input_bytes =
272            self.pointer_inputs.capacity() * size_of::<Rc<dyn Fn(PointerEvent)>>();
273        let click_handler_bytes = self.click_handlers.capacity() * size_of::<Rc<dyn Fn(Point)>>();
274        ModifierNodeSlicesDebugStats {
275            draw_command_count: self.draw_commands.len(),
276            draw_command_capacity: self.draw_commands.capacity(),
277            pointer_input_count: self.pointer_inputs.len(),
278            pointer_input_capacity: self.pointer_inputs.capacity(),
279            click_handler_count: self.click_handlers.len(),
280            click_handler_capacity: self.click_handlers.capacity(),
281            has_text_content: self.text_content.is_some(),
282            has_text_style: self.text_style.is_some(),
283            has_text_layout_options: self.text_layout_options.is_some(),
284            has_prepared_text_layout: self.prepared_text_layout.is_some(),
285            has_graphics_layer: self.graphics_layer.is_some(),
286            has_graphics_layer_resolver: self.graphics_layer_resolver.is_some(),
287            heap_bytes: draw_command_bytes + pointer_input_bytes + click_handler_bytes,
288        }
289    }
290
291    /// Resets the slice collection for reuse, retaining vector capacity.
292    pub fn clear(&mut self) {
293        self.draw_commands.clear();
294        self.pointer_inputs.clear();
295        self.click_handlers.clear();
296        self.clip_to_bounds = false;
297        self.motion_context_animated = false;
298        self.translated_content_context = false;
299        self.translated_content_context_identity = None;
300        self.translated_content_offset_reader = None;
301        self.text_content = None;
302        self.text_style = None;
303        self.text_layout_options = None;
304        self.prepared_text_layout = None;
305        self.graphics_layer = None;
306        self.graphics_layer_resolver = None;
307        self.chain_guard = None;
308    }
309}
310
311impl fmt::Debug for ModifierNodeSlices {
312    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
313        f.debug_struct("ModifierNodeSlices")
314            .field("draw_commands", &self.draw_commands.len())
315            .field("pointer_inputs", &self.pointer_inputs.len())
316            .field("click_handlers", &self.click_handlers.len())
317            .field("clip_to_bounds", &self.clip_to_bounds)
318            .field("motion_context_animated", &self.motion_context_animated)
319            .field(
320                "translated_content_context",
321                &self.translated_content_context,
322            )
323            .field(
324                "translated_content_context_identity",
325                &self.translated_content_context_identity,
326            )
327            .field(
328                "translated_content_offset",
329                &self.translated_content_offset(),
330            )
331            .field("text_content", &self.text_content)
332            .field("text_style", &self.text_style)
333            .field("text_layout_options", &self.text_layout_options)
334            .field("prepared_text_layout", &self.prepared_text_layout.is_some())
335            .field("graphics_layer", &self.graphics_layer)
336            .field(
337                "graphics_layer_resolver",
338                &self.graphics_layer_resolver.is_some(),
339            )
340            .finish()
341    }
342}
343
344/// Collects modifier node slices directly from a reconciled [`ModifierNodeChain`].
345pub fn collect_modifier_slices(chain: &ModifierNodeChain) -> ModifierNodeSlices {
346    let mut slices = ModifierNodeSlices::default();
347    collect_modifier_slices_into(chain, &mut slices);
348    slices
349}
350
351/// Collects modifier node slices into an existing buffer to reuse allocations.
352///
353/// Single-pass: iterates the chain once instead of 4 separate capability-filtered
354/// traversals, reducing per-node `RefCell::borrow()` overhead.
355pub fn collect_modifier_slices_into(chain: &ModifierNodeChain, slices: &mut ModifierNodeSlices) {
356    slices.clear();
357
358    let caps = chain.capabilities();
359    let has_pointer = caps.intersects(NodeCapabilities::POINTER_INPUT);
360    let has_draw = caps.intersects(NodeCapabilities::DRAW);
361    let has_layout = caps.intersects(NodeCapabilities::LAYOUT);
362
363    if !has_pointer && !has_draw && !has_layout {
364        return;
365    }
366
367    let mut background_color = None;
368    let mut background_insert_index = None::<usize>;
369    let mut corner_shape = None;
370    let mut padding = EdgeInsets::default();
371
372    for node_ref in chain.head_to_tail() {
373        let node_caps = node_ref.kind_set();
374
375        node_ref.with_node(|node| {
376            let any = node.as_any();
377
378            // POINTER_INPUT collection
379            if has_pointer && node_caps.intersects(NodeCapabilities::POINTER_INPUT) {
380                if let Some(handler) = node
381                    .as_pointer_input_node()
382                    .and_then(|n| n.pointer_input_handler())
383                {
384                    slices.pointer_inputs.push(handler);
385                }
386            }
387
388            // DRAW collection
389            if has_draw && node_caps.intersects(NodeCapabilities::DRAW) {
390                if let Some(bg_node) = any.downcast_ref::<BackgroundNode>() {
391                    background_color = Some(bg_node.color());
392                    background_insert_index = Some(slices.draw_commands.len());
393                    if bg_node.shape().is_some() {
394                        corner_shape = bg_node.shape();
395                    }
396                }
397
398                if let Some(shape_node) = any.downcast_ref::<CornerShapeNode>() {
399                    corner_shape = Some(shape_node.shape());
400                }
401
402                if let Some(commands) = any.downcast_ref::<DrawCommandNode>() {
403                    slices
404                        .draw_commands
405                        .extend(commands.commands().iter().cloned());
406                }
407
408                if let Some(draw_node) = node.as_draw_node() {
409                    if let Some(closure) = draw_node.create_draw_closure() {
410                        slices.draw_commands.push(DrawCommand::Overlay(closure));
411                    } else {
412                        use cranpose_ui_graphics::{DrawScope as _, DrawScopeDefault};
413                        let mut scope = DrawScopeDefault::new(crate::modifier::Size {
414                            width: 0.0,
415                            height: 0.0,
416                        });
417                        draw_node.draw(&mut scope);
418                        let primitives = scope.into_primitives();
419                        if !primitives.is_empty() {
420                            let draw_cmd =
421                                Rc::new(move |_size: crate::modifier::Size| primitives.clone());
422                            slices.draw_commands.push(DrawCommand::Overlay(draw_cmd));
423                        }
424                    }
425                }
426
427                if let Some(layer_node) = any.downcast_ref::<GraphicsLayerNode>() {
428                    slices.push_graphics_layer(
429                        layer_node.layer_snapshot(),
430                        layer_node.layer_resolver(),
431                    );
432                }
433
434                if any.is::<ClipToBoundsNode>() {
435                    slices.clip_to_bounds = true;
436                }
437            }
438
439            // LAYOUT collection (padding + text)
440            if has_layout && node_caps.intersects(NodeCapabilities::LAYOUT) {
441                if let Some(padding_node) = any.downcast_ref::<PaddingNode>() {
442                    let p = padding_node.padding();
443                    padding.left += p.left;
444                    padding.top += p.top;
445                    padding.right += p.right;
446                    padding.bottom += p.bottom;
447                }
448
449                if let Some(motion_context_node) = any.downcast_ref::<MotionContextAnimatedNode>() {
450                    slices.motion_context_animated = motion_context_node.is_active();
451                }
452
453                if let Some(translated_content_node) =
454                    any.downcast_ref::<TranslatedContentContextNode>()
455                {
456                    slices.translated_content_context = translated_content_node.is_active();
457                    slices.translated_content_context_identity =
458                        Some(translated_content_node.identity());
459                    slices.translated_content_offset_reader =
460                        translated_content_node.content_offset_reader();
461                }
462
463                if let Some(text_node) = any.downcast_ref::<TextModifierNode>() {
464                    slices.text_content = Some(text_node.annotated_text());
465                    slices.text_style = Some(text_node.style().clone());
466                    slices.text_layout_options = Some(text_node.options());
467                    slices.prepared_text_layout = Some(text_node.prepared_layout_handle());
468                }
469
470                if let Some(text_field_node) = any.downcast_ref::<TextFieldModifierNode>() {
471                    let text = text_field_node.text();
472                    slices.text_content = Some(Rc::new(crate::text::AnnotatedString::from(text)));
473                    slices.text_style = Some(text_field_node.style().clone());
474                    slices.text_layout_options = Some(TextLayoutOptions::default());
475                    slices.prepared_text_layout = None;
476
477                    text_field_node.set_content_offset(padding.left);
478                    text_field_node.set_content_y_offset(padding.top);
479                }
480            }
481        });
482    }
483
484    // Convert background + shape into a draw command
485    if let Some(color) = background_color {
486        let draw_cmd = Rc::new(move |size: crate::modifier::Size| {
487            use crate::modifier::{Brush, Rect};
488            use cranpose_ui_graphics::DrawPrimitive;
489
490            let brush = Brush::solid(color);
491            let rect = Rect {
492                x: 0.0,
493                y: 0.0,
494                width: size.width,
495                height: size.height,
496            };
497
498            if let Some(shape) = corner_shape {
499                let radii = shape.resolve(size.width, size.height);
500                vec![DrawPrimitive::RoundRect { rect, brush, radii }]
501            } else {
502                vec![DrawPrimitive::Rect { rect, brush }]
503            }
504        });
505
506        let insert_index = background_insert_index
507            .unwrap_or(0)
508            .min(slices.draw_commands.len());
509        slices
510            .draw_commands
511            .insert(insert_index, DrawCommand::Behind(draw_cmd));
512    }
513}
514
515/// Collects modifier node slices by instantiating a temporary node chain from a [`Modifier`].
516pub fn collect_slices_from_modifier(modifier: &Modifier) -> ModifierNodeSlices {
517    let mut handle = ModifierChainHandle::new();
518    let _ = handle.update(modifier);
519    collect_modifier_slices(handle.chain()).with_chain_guard(handle)
520}