1#![allow(non_snake_case)]
9
10use std::fmt;
11use std::hash::{Hash, Hasher};
12use std::rc::Rc;
13
14use cranpose_core::hash::default;
15
16mod alignment;
17mod background;
18mod blur;
19mod chain;
20mod clickable;
21mod draw_cache;
22mod fill;
23mod focus;
24mod graphics_layer;
25mod local;
26mod offset;
27mod padding;
28pub(crate) mod pointer_input;
29mod rotary_input;
30mod scroll;
31mod semantics;
32mod shadow;
33mod size;
34mod slices;
35mod toggleable;
36mod weight;
37
38pub use crate::draw::{DrawCacheBuilder, DrawCommand};
39#[allow(unused_imports)]
40pub use chain::{ModifierChainHandle, ModifierChainInspectorNode, ModifierLocalsHandle};
41pub use cranpose_foundation::{
42 modifier_element, AnyModifierElement, DynModifierElement, FocusState, PointerEvent,
43 PointerEventKind, PointerSource, RotaryScrollEvent, SemanticsConfiguration,
44};
45use cranpose_foundation::{ModifierNodeElement, NodeCapabilities};
46#[allow(unused_imports)]
47pub use cranpose_ui_graphics::{
48 BlendMode, BlurredEdgeTreatment, Brush, Color, ColorFilter, CompositingStrategy, CornerRadii,
49 CutDirection, Dp, DpOffset, EdgeInsets, GradientCutMaskSpec, GradientFadeMaskSpec,
50 GraphicsLayer, LayerShape, Point, Rect, RenderEffect, RoundedCornerShape, RuntimeShader,
51 Shadow, ShadowScope, Size, TransformOrigin,
52};
53use cranpose_ui_layout::{Alignment, HorizontalAlignment, IntrinsicSize, VerticalAlignment};
54#[allow(unused_imports)]
55pub use focus::FocusDirection;
56pub use graphics_layer::GlassMaterial;
57pub(crate) use local::{
58 ModifierLocalAncestorResolver, ModifierLocalSource, ModifierLocalToken, ResolvedModifierLocal,
59};
60#[allow(unused_imports)]
61pub use local::{ModifierLocalKey, ModifierLocalReadScope};
62#[allow(unused_imports)]
63pub use pointer_input::{AwaitPointerEventScope, PointerInputScope};
64pub use rotary_input::RotaryInputModifierNode;
65pub use semantics::{
66 collect_semantics_from_chain, collect_semantics_from_modifier, SemanticsRequester,
67 SemanticsRequesterElement,
68};
69pub use slices::{
70 collect_modifier_slices, collect_modifier_slices_into, collect_slices_from_modifier,
71 ModifierNodeSlices, ModifierNodeSlicesDebugStats,
72};
73#[cfg(feature = "test-helpers")]
75pub use scroll::{last_fling_velocity, reset_last_fling_velocity};
76
77use crate::modifier_nodes::ClipToBoundsElement;
78use focus::FocusTargetElement;
79use local::{ModifierLocalConsumerElement, ModifierLocalProviderElement};
80use semantics::SemanticsElement;
81
82#[derive(Clone, Debug, Default)]
84pub struct InspectorInfo {
85 properties: Vec<InspectorProperty>,
86}
87
88impl InspectorInfo {
89 pub fn new() -> Self {
90 Self::default()
91 }
92
93 pub fn add_property<V: Into<String>>(&mut self, name: &'static str, value: V) {
94 self.properties.push(InspectorProperty {
95 name,
96 value: value.into(),
97 });
98 }
99
100 pub fn properties(&self) -> &[InspectorProperty] {
101 &self.properties
102 }
103
104 pub fn is_empty(&self) -> bool {
105 self.properties.is_empty()
106 }
107
108 pub fn add_dimension(&mut self, name: &'static str, constraint: DimensionConstraint) {
109 self.add_property(name, describe_dimension(constraint));
110 }
111
112 pub fn add_offset_components(
113 &mut self,
114 x_name: &'static str,
115 y_name: &'static str,
116 offset: Point,
117 ) {
118 self.add_property(x_name, offset.x.to_string());
119 self.add_property(y_name, offset.y.to_string());
120 }
121
122 pub fn add_alignment<A>(&mut self, name: &'static str, alignment: A)
123 where
124 A: fmt::Debug,
125 {
126 self.add_property(name, format!("{alignment:?}"));
127 }
128}
129
130#[derive(Clone, Debug, PartialEq)]
132pub struct InspectorProperty {
133 pub name: &'static str,
134 pub value: String,
135}
136
137#[derive(Clone, Debug, PartialEq)]
139pub struct ModifierInspectorRecord {
140 pub name: &'static str,
141 pub properties: Vec<InspectorProperty>,
142}
143
144#[derive(Clone, Debug)]
146pub(crate) struct InspectorMetadata {
147 name: &'static str,
148 info: InspectorInfo,
149}
150
151impl InspectorMetadata {
152 pub(crate) fn new<F>(name: &'static str, recorder: F) -> Self
153 where
154 F: FnOnce(&mut InspectorInfo),
155 {
156 let mut info = InspectorInfo::new();
157 recorder(&mut info);
158 Self { name, info }
159 }
160
161 fn is_empty(&self) -> bool {
162 self.info.is_empty()
163 }
164
165 fn to_record(&self) -> ModifierInspectorRecord {
166 ModifierInspectorRecord {
167 name: self.name,
168 properties: self.info.properties().to_vec(),
169 }
170 }
171}
172
173fn describe_dimension(constraint: DimensionConstraint) -> String {
174 match constraint {
175 DimensionConstraint::Unspecified => "unspecified".to_string(),
176 DimensionConstraint::Points(value) => value.to_string(),
177 DimensionConstraint::Fraction(value) => format!("fraction({value})"),
178 DimensionConstraint::Intrinsic(size) => format!("intrinsic({size:?})"),
179 }
180}
181
182pub(crate) fn inspector_metadata<F>(name: &'static str, recorder: F) -> InspectorMetadata
183where
184 F: FnOnce(&mut InspectorInfo),
185{
186 if !inspector_metadata_enabled() {
189 return InspectorMetadata::new(name, |_| {});
190 }
191 InspectorMetadata::new(name, recorder)
192}
193
194pub(crate) fn modifier_debug_enabled() -> bool {
195 #[cfg(not(target_arch = "wasm32"))]
196 {
197 cranpose_core::env_flag!("COMPOSE_DEBUG_MODIFIERS")
198 }
199 #[cfg(target_arch = "wasm32")]
200 {
201 false
202 }
203}
204
205fn inspector_metadata_enabled() -> bool {
206 cfg!(test) || modifier_debug_enabled()
207}
208
209#[derive(Clone)]
215enum ModifierKind {
216 Empty,
218 Single {
220 elements: Rc<Vec<DynModifierElement>>,
221 inspector: Rc<Vec<InspectorMetadata>>,
222 },
223}
224
225const FINGERPRINT_KIND_EMPTY: u8 = 0;
226const FINGERPRINT_KIND_SINGLE: u8 = 1;
227
228const FINGERPRINT_EMPTY_STRICT_SEED: u64 = 0x243f_6a88_85a3_08d3;
229const FINGERPRINT_EMPTY_STRUCTURAL_SEED: u64 = 0x1319_8a2e_0370_7344;
230const FINGERPRINT_SINGLE_STRICT_SEED: u64 = 0xa409_3822_299f_31d0;
231const FINGERPRINT_SINGLE_STRUCTURAL_SEED: u64 = 0x082e_fa98_ec4e_6c89;
232const FINGERPRINT_SEQUENCE_MUL: u64 = 0x9e37_79b1_85eb_ca87;
233const FINGERPRINT_STRICT_UPDATE_TAG: u64 = 0xdbe6_d5d5_fe4c_ce2f;
234const FINGERPRINT_STRUCTURAL_DRAW_ONLY_TAG: u64 = 0x94d0_49bb_1331_11eb;
235
236#[derive(Clone, Copy, Debug, PartialEq, Eq)]
237struct ModifierFingerprints {
238 strict: u64,
239 structural: u64,
240}
241
242#[inline]
243fn mix_fingerprint_bits(mut value: u64) -> u64 {
244 value ^= value >> 33;
245 value = value.wrapping_mul(0xff51_afd7_ed55_8ccd);
246 value ^= value >> 33;
247 value = value.wrapping_mul(0xc4ce_b9fe_1a85_ec53);
248 value ^ (value >> 33)
249}
250
251#[inline]
252fn fold_fingerprint(state: u64, value: u64) -> u64 {
253 mix_fingerprint_bits(state ^ value.wrapping_add(FINGERPRINT_SEQUENCE_MUL))
254 .wrapping_mul(FINGERPRINT_SEQUENCE_MUL)
255}
256
257#[inline]
258fn empty_fingerprints() -> ModifierFingerprints {
259 ModifierFingerprints {
260 strict: fold_fingerprint(FINGERPRINT_EMPTY_STRICT_SEED, FINGERPRINT_KIND_EMPTY as u64),
261 structural: fold_fingerprint(
262 FINGERPRINT_EMPTY_STRUCTURAL_SEED,
263 FINGERPRINT_KIND_EMPTY as u64,
264 ),
265 }
266}
267
268#[inline]
269fn single_fingerprint_seed() -> ModifierFingerprints {
270 let strict = fold_fingerprint(
271 FINGERPRINT_SINGLE_STRICT_SEED,
272 FINGERPRINT_KIND_SINGLE as u64,
273 );
274 let structural = fold_fingerprint(
275 FINGERPRINT_SINGLE_STRUCTURAL_SEED,
276 FINGERPRINT_KIND_SINGLE as u64,
277 );
278 ModifierFingerprints { strict, structural }
279}
280
281#[inline]
282fn element_common_fingerprint(element: &DynModifierElement) -> u64 {
283 let mut hasher = default::new();
284 element.element_type().hash(&mut hasher);
285 element.capabilities().bits().hash(&mut hasher);
286 hasher.finish()
287}
288
289#[inline]
290fn element_fingerprints(element: &DynModifierElement) -> ModifierFingerprints {
291 let common = element_common_fingerprint(element);
292 let requires_update = element.requires_update();
293 let strict_payload = if requires_update {
294 let element_ptr = Rc::as_ptr(element) as *const () as usize as u64;
295 element_ptr ^ FINGERPRINT_STRICT_UPDATE_TAG
296 } else {
297 element.hash_code()
298 };
299 let strict = mix_fingerprint_bits(common ^ strict_payload);
300
301 let is_draw_only = element.capabilities() == NodeCapabilities::DRAW;
302 let structural_payload = if is_draw_only {
303 FINGERPRINT_STRUCTURAL_DRAW_ONLY_TAG
304 } else {
305 element.hash_code()
306 };
307 let structural = mix_fingerprint_bits(common ^ structural_payload);
308
309 ModifierFingerprints { strict, structural }
310}
311
312#[inline]
313fn append_fingerprints(
314 mut fingerprints: ModifierFingerprints,
315 elements: &[DynModifierElement],
316) -> ModifierFingerprints {
317 for element in elements {
318 let element_fingerprints = element_fingerprints(element);
319 fingerprints.strict = fold_fingerprint(fingerprints.strict, element_fingerprints.strict);
320 fingerprints.structural =
321 fold_fingerprint(fingerprints.structural, element_fingerprints.structural);
322 }
323 fingerprints
324}
325
326fn single_fingerprints(elements: &[DynModifierElement]) -> ModifierFingerprints {
327 append_fingerprints(single_fingerprint_seed(), elements)
328}
329
330pub struct ModifierElementIterator<'a> {
333 inner: std::slice::Iter<'a, DynModifierElement>,
334}
335
336impl<'a> Iterator for ModifierElementIterator<'a> {
337 type Item = &'a DynModifierElement;
338
339 #[inline]
340 fn next(&mut self) -> Option<Self::Item> {
341 self.inner.next()
342 }
343
344 #[inline]
345 fn size_hint(&self) -> (usize, Option<usize>) {
346 self.inner.size_hint()
347 }
348}
349
350impl ExactSizeIterator for ModifierElementIterator<'_> {}
351
352pub(crate) struct ModifierInspectorIterator<'a> {
354 inner: std::slice::Iter<'a, InspectorMetadata>,
355}
356
357impl<'a> Iterator for ModifierInspectorIterator<'a> {
358 type Item = &'a InspectorMetadata;
359
360 #[inline]
361 fn next(&mut self) -> Option<Self::Item> {
362 self.inner.next()
363 }
364
365 #[inline]
366 fn size_hint(&self) -> (usize, Option<usize>) {
367 self.inner.size_hint()
368 }
369}
370
371impl ExactSizeIterator for ModifierInspectorIterator<'_> {}
372
373#[derive(Clone)]
391pub struct Modifier {
392 kind: ModifierKind,
393 strict_fingerprint: u64,
394 structural_fingerprint: u64,
395 element_count: usize,
396}
397
398impl Default for Modifier {
399 fn default() -> Self {
400 let fingerprints = empty_fingerprints();
401 Self {
402 kind: ModifierKind::Empty,
403 strict_fingerprint: fingerprints.strict,
404 structural_fingerprint: fingerprints.structural,
405 element_count: 0,
406 }
407 }
408}
409
410impl Modifier {
411 pub fn empty() -> Self {
412 Self::default()
413 }
414
415 pub fn from_element<E>(element: E) -> Self
417 where
418 E: ModifierNodeElement,
419 {
420 Self::with_element(element)
421 }
422
423 pub fn clip_to_bounds(self) -> Self {
427 let modifier = Self::with_element(ClipToBoundsElement::new()).with_inspector_metadata(
428 inspector_metadata("clipToBounds", |info| {
429 info.add_property("clipToBounds", "true");
430 }),
431 );
432 self.then(modifier)
433 }
434
435 pub fn modifier_local_provider<T, F>(self, key: ModifierLocalKey<T>, value: F) -> Self
436 where
437 T: 'static,
438 F: Fn() -> T + 'static,
439 {
440 let element = ModifierLocalProviderElement::new(key, value);
441 let modifier = Modifier::from_parts(vec![modifier_element(element)]);
442 self.then(modifier)
443 }
444
445 pub fn modifier_local_consumer<F>(self, consumer: F) -> Self
446 where
447 F: for<'scope> Fn(&mut ModifierLocalReadScope<'scope>) + 'static,
448 {
449 let element = ModifierLocalConsumerElement::new(consumer);
450 let modifier = Modifier::from_parts(vec![modifier_element(element)]);
451 self.then(modifier)
452 }
453
454 pub fn semantics<F>(self, recorder: F) -> Self
455 where
456 F: Fn(&mut SemanticsConfiguration) + 'static,
457 {
458 let recorder: std::rc::Rc<dyn Fn(&mut SemanticsConfiguration)> = std::rc::Rc::new(recorder);
459 let metadata = if inspector_metadata_enabled() {
465 let mut preview = SemanticsConfiguration::default();
466 recorder(&mut preview);
467 let description = preview.content_description.clone();
468 let state_description = preview.state_description.clone();
469 let role = preview.role;
470 let is_clickable = preview.is_activatable();
471 let canvas_children = preview.canvas_children.len();
472 inspector_metadata("semantics", move |info| {
473 if let Some(desc) = &description {
474 info.add_property("contentDescription", desc.clone());
475 }
476 if let Some(state) = &state_description {
477 info.add_property("stateDescription", state.clone());
478 }
479 if let Some(role) = role {
480 info.add_property("role", format!("{role:?}"));
481 }
482 if is_clickable {
483 info.add_property("isClickable", "true");
484 }
485 if canvas_children > 0 {
486 info.add_property("canvasSemanticsChildren", canvas_children.to_string());
487 }
488 })
489 } else {
490 inspector_metadata("semantics", |_| {})
491 };
492 let element = SemanticsElement::new(recorder);
493 let modifier =
494 Modifier::from_parts(vec![modifier_element(element)]).with_inspector_metadata(metadata);
495 self.then(modifier)
496 }
497
498 pub fn focus_target(self) -> Self {
504 let element = FocusTargetElement::new();
505 let modifier = Modifier::from_parts(vec![modifier_element(element)]);
506 self.then(modifier)
507 }
508
509 pub fn on_focus_changed<F>(self, callback: F) -> Self
514 where
515 F: Fn(FocusState) + 'static,
516 {
517 let element = FocusTargetElement::with_callback(callback);
518 let modifier = Modifier::from_parts(vec![modifier_element(element)]);
519 self.then(modifier)
520 }
521
522 pub fn semantics_requester(self, requester: &SemanticsRequester) -> Self {
530 let element = SemanticsRequesterElement::new(requester.clone());
531 let modifier = Modifier::from_parts(vec![modifier_element(element)]);
532 self.then(modifier)
533 }
534
535 pub fn debug_chain(self, tag: &'static str) -> Self {
553 use cranpose_foundation::{ModifierNode, ModifierNodeContext, NodeCapabilities, NodeState};
554
555 #[derive(Clone)]
556 struct DebugChainElement {
557 tag: &'static str,
558 }
559
560 impl fmt::Debug for DebugChainElement {
561 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
562 f.debug_struct("DebugChainElement")
563 .field("tag", &self.tag)
564 .finish()
565 }
566 }
567
568 impl PartialEq for DebugChainElement {
569 fn eq(&self, other: &Self) -> bool {
570 self.tag == other.tag
571 }
572 }
573
574 impl Eq for DebugChainElement {}
575
576 impl std::hash::Hash for DebugChainElement {
577 fn hash<H: std::hash::Hasher>(&self, state: &mut H) {
578 self.tag.hash(state);
579 }
580 }
581
582 impl ModifierNodeElement for DebugChainElement {
583 type Node = DebugChainNode;
584
585 fn create(&self) -> Self::Node {
586 DebugChainNode::new(self.tag)
587 }
588
589 fn update(&self, node: &mut Self::Node) {
590 node.tag = self.tag;
591 }
592
593 fn capabilities(&self) -> NodeCapabilities {
594 NodeCapabilities::empty()
595 }
596 }
597
598 struct DebugChainNode {
599 tag: &'static str,
600 state: NodeState,
601 }
602
603 impl DebugChainNode {
604 fn new(tag: &'static str) -> Self {
605 Self {
606 tag,
607 state: NodeState::new(),
608 }
609 }
610 }
611
612 impl ModifierNode for DebugChainNode {
613 fn on_attach(&mut self, _context: &mut dyn ModifierNodeContext) {
614 eprintln!("[debug_chain:{}] Modifier chain attached", self.tag);
615 }
616
617 fn on_detach(&mut self) {
618 eprintln!("[debug_chain:{}] Modifier chain detached", self.tag);
619 }
620
621 fn on_reset(&mut self) {
622 eprintln!("[debug_chain:{}] Modifier chain reset", self.tag);
623 }
624 }
625
626 impl cranpose_foundation::DelegatableNode for DebugChainNode {
627 fn node_state(&self) -> &NodeState {
628 &self.state
629 }
630 }
631
632 let element = DebugChainElement { tag };
633 let modifier = Modifier::from_parts(vec![modifier_element(element)]);
634 self.then(modifier)
635 .with_inspector_metadata(inspector_metadata("debugChain", move |info| {
636 info.add_property("tag", tag);
637 }))
638 }
639
640 pub fn then(&self, next: Modifier) -> Modifier {
645 if self.is_trivially_empty() {
646 return next;
647 }
648 if next.is_trivially_empty() {
649 return self.clone();
650 }
651
652 let Some((self_elements, self_inspector)) = self.single_parts() else {
653 return next;
654 };
655 let Some((next_elements, next_inspector)) = next.single_parts() else {
656 return self.clone();
657 };
658
659 let mut merged_elements = Vec::with_capacity(self_elements.len() + next_elements.len());
660 merged_elements.extend_from_slice(self_elements);
661 merged_elements.extend_from_slice(next_elements);
662
663 let mut merged_inspector = Vec::with_capacity(self_inspector.len() + next_inspector.len());
664 merged_inspector.extend_from_slice(self_inspector);
665 merged_inspector.extend_from_slice(next_inspector);
666
667 let fingerprints = append_fingerprints(
668 ModifierFingerprints {
669 strict: self.strict_fingerprint,
670 structural: self.structural_fingerprint,
671 },
672 next_elements,
673 );
674 Modifier {
675 kind: ModifierKind::Single {
676 elements: Rc::new(merged_elements),
677 inspector: Rc::new(merged_inspector),
678 },
679 strict_fingerprint: fingerprints.strict,
680 structural_fingerprint: fingerprints.structural,
681 element_count: self.element_count + next.element_count,
682 }
683 }
684
685 pub(crate) fn iter_elements(&self) -> ModifierElementIterator<'_> {
687 match &self.kind {
688 ModifierKind::Empty => ModifierElementIterator { inner: [].iter() },
689 ModifierKind::Single { elements, .. } => ModifierElementIterator {
690 inner: elements.iter(),
691 },
692 }
693 }
694
695 pub(crate) fn iter_inspector_metadata(&self) -> ModifierInspectorIterator<'_> {
696 match &self.kind {
697 ModifierKind::Empty => ModifierInspectorIterator { inner: [].iter() },
698 ModifierKind::Single { inspector, .. } => ModifierInspectorIterator {
699 inner: inspector.iter(),
700 },
701 }
702 }
703
704 #[cfg(test)]
708 pub(crate) fn elements(&self) -> Vec<DynModifierElement> {
709 match &self.kind {
710 ModifierKind::Empty => Vec::new(),
711 ModifierKind::Single { elements, .. } => elements.as_ref().clone(),
712 }
713 }
714
715 pub(crate) fn inspector_metadata(&self) -> Vec<InspectorMetadata> {
717 match &self.kind {
718 ModifierKind::Empty => Vec::new(),
719 ModifierKind::Single { inspector, .. } => inspector.as_ref().clone(),
720 }
721 }
722
723 pub(crate) fn rehouse_for_live_compaction(&self) -> Self {
724 match &self.kind {
725 ModifierKind::Empty => Self::default(),
726 ModifierKind::Single {
727 elements,
728 inspector,
729 } => Self {
730 kind: ModifierKind::Single {
731 elements: Rc::new(elements.iter().cloned().collect()),
732 inspector: Rc::new(inspector.as_ref().clone()),
733 },
734 strict_fingerprint: self.strict_fingerprint,
735 structural_fingerprint: self.structural_fingerprint,
736 element_count: self.element_count,
737 },
738 }
739 }
740
741 pub fn total_padding(&self) -> f32 {
742 let padding = self.padding_values();
743 padding
744 .left
745 .max(padding.right)
746 .max(padding.top)
747 .max(padding.bottom)
748 }
749
750 pub fn explicit_size(&self) -> Option<Size> {
751 let props = self.layout_properties();
752 match (props.width, props.height) {
753 (DimensionConstraint::Points(width), DimensionConstraint::Points(height)) => {
754 Some(Size { width, height })
755 }
756 _ => None,
757 }
758 }
759
760 pub fn padding_values(&self) -> EdgeInsets {
761 self.resolved_modifiers().padding()
762 }
763
764 pub(crate) fn layout_properties(&self) -> LayoutProperties {
765 self.resolved_modifiers().layout_properties()
766 }
767
768 pub fn box_alignment(&self) -> Option<Alignment> {
769 self.layout_properties().box_alignment()
770 }
771
772 pub fn column_alignment(&self) -> Option<HorizontalAlignment> {
773 self.layout_properties().column_alignment()
774 }
775
776 pub fn row_alignment(&self) -> Option<VerticalAlignment> {
777 self.layout_properties().row_alignment()
778 }
779
780 pub fn draw_commands(&self) -> Vec<DrawCommand> {
781 collect_slices_from_modifier(self).draw_commands().to_vec()
782 }
783
784 pub fn clips_to_bounds(&self) -> bool {
785 collect_slices_from_modifier(self).clip_to_bounds()
786 }
787
788 pub fn collect_inspector_records(&self) -> Vec<ModifierInspectorRecord> {
790 self.inspector_metadata()
791 .iter()
792 .map(|metadata| metadata.to_record())
793 .collect()
794 }
795
796 pub fn resolved_modifiers(&self) -> ResolvedModifiers {
797 let mut handle = ModifierChainHandle::new();
798 let _ = handle.update(self);
799 handle.resolved_modifiers()
800 }
801
802 pub(crate) fn with_element<E>(element: E) -> Self
803 where
804 E: ModifierNodeElement,
805 {
806 let dyn_element = modifier_element(element);
807 Self::from_parts(vec![dyn_element])
808 }
809
810 pub(crate) fn from_parts(elements: Vec<DynModifierElement>) -> Self {
811 if elements.is_empty() {
812 Self::default()
813 } else {
814 let element_count = elements.len();
815 let fingerprints = single_fingerprints(elements.as_slice());
816 Self {
817 kind: ModifierKind::Single {
818 elements: Rc::new(elements),
819 inspector: Rc::new(Vec::new()),
820 },
821 strict_fingerprint: fingerprints.strict,
822 structural_fingerprint: fingerprints.structural,
823 element_count,
824 }
825 }
826 }
827
828 fn is_trivially_empty(&self) -> bool {
829 matches!(self.kind, ModifierKind::Empty)
830 }
831
832 fn single_parts(&self) -> Option<(&[DynModifierElement], &[InspectorMetadata])> {
833 match &self.kind {
834 ModifierKind::Empty => None,
835 ModifierKind::Single {
836 elements,
837 inspector,
838 } => Some((elements.as_slice(), inspector.as_slice())),
839 }
840 }
841
842 pub(crate) fn with_inspector_metadata(self, metadata: InspectorMetadata) -> Self {
843 if metadata.is_empty() {
844 return self;
845 }
846 match self.kind {
847 ModifierKind::Empty => self,
848 ModifierKind::Single {
849 elements,
850 inspector,
851 } => {
852 let mut new_inspector = inspector.as_ref().clone();
853 new_inspector.push(metadata);
854 Self {
855 kind: ModifierKind::Single {
856 elements,
857 inspector: Rc::new(new_inspector),
858 },
859 strict_fingerprint: self.strict_fingerprint,
860 structural_fingerprint: self.structural_fingerprint,
861 element_count: self.element_count,
862 }
863 }
864 }
865 }
866
867 pub fn structural_eq(&self, other: &Self) -> bool {
872 self.eq_internal(other, false)
873 }
874
875 fn eq_internal(&self, other: &Self, consider_always_update: bool) -> bool {
876 if self.element_count != other.element_count {
877 return false;
878 }
879 if consider_always_update {
880 if self.strict_fingerprint != other.strict_fingerprint {
881 return false;
882 }
883 } else if self.structural_fingerprint != other.structural_fingerprint {
884 return false;
885 }
886
887 match (&self.kind, &other.kind) {
888 (ModifierKind::Empty, ModifierKind::Empty) => true,
889 (
890 ModifierKind::Single {
891 elements: e1,
892 inspector: _,
893 },
894 ModifierKind::Single {
895 elements: e2,
896 inspector: _,
897 },
898 ) => {
899 if Rc::ptr_eq(e1, e2) {
900 return true;
901 }
902
903 if e1.len() != e2.len() {
904 return false;
905 }
906
907 for (a, b) in e1.iter().zip(e2.iter()) {
908 if !consider_always_update
912 && a.element_type() == b.element_type()
913 && a.capabilities() == NodeCapabilities::DRAW
914 && b.capabilities() == NodeCapabilities::DRAW
915 {
916 continue;
917 }
918
919 if consider_always_update && (a.requires_update() || b.requires_update()) {
920 if !Rc::ptr_eq(a, b) {
921 return false;
922 }
923 continue;
924 }
925
926 if !a.equals_element(&**b) {
927 return false;
928 }
929 }
930
931 true
932 }
933 _ => false,
934 }
935 }
936}
937
938impl PartialEq for Modifier {
939 fn eq(&self, other: &Self) -> bool {
940 self.eq_internal(other, true)
941 }
942}
943
944impl Eq for Modifier {}
945
946impl fmt::Display for Modifier {
947 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
948 match &self.kind {
949 ModifierKind::Empty => write!(f, "Modifier.empty"),
950 ModifierKind::Single { elements, .. } => {
951 if elements.is_empty() {
952 return write!(f, "Modifier.empty");
953 }
954 write!(f, "Modifier[")?;
955 for (index, element) in elements.iter().enumerate() {
956 if index > 0 {
957 write!(f, ", ")?;
958 }
959 let name = element.inspector_name();
960 let mut properties = Vec::new();
961 element.record_inspector_properties(&mut |prop, value| {
962 properties.push(format!("{prop}={value}"));
963 });
964 if properties.is_empty() {
965 write!(f, "{name}")?;
966 } else {
967 write!(f, "{name}({})", properties.join(", "))?;
968 }
969 }
970 write!(f, "]")
971 }
972 }
973 }
974}
975
976impl fmt::Debug for Modifier {
977 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
978 fmt::Display::fmt(self, f)
979 }
980}
981
982#[derive(Clone, Copy, Debug, PartialEq)]
983pub struct ResolvedBackground {
984 color: Color,
985 shape: Option<RoundedCornerShape>,
986}
987
988impl ResolvedBackground {
989 pub fn new(color: Color, shape: Option<RoundedCornerShape>) -> Self {
990 Self { color, shape }
991 }
992
993 pub fn color(&self) -> Color {
994 self.color
995 }
996
997 pub fn shape(&self) -> Option<RoundedCornerShape> {
998 self.shape
999 }
1000
1001 pub fn set_shape(&mut self, shape: Option<RoundedCornerShape>) {
1002 self.shape = shape;
1003 }
1004}
1005
1006#[derive(Clone, Copy, Debug, PartialEq, Default)]
1007pub struct ResolvedModifiers {
1008 padding: EdgeInsets,
1009 layout: LayoutProperties,
1010 offset: Point,
1011}
1012
1013impl ResolvedModifiers {
1014 pub fn padding(&self) -> EdgeInsets {
1015 self.padding
1016 }
1017
1018 pub fn layout_properties(&self) -> LayoutProperties {
1019 self.layout
1020 }
1021
1022 pub fn offset(&self) -> Point {
1023 self.offset
1024 }
1025
1026 pub(crate) fn set_padding(&mut self, padding: EdgeInsets) {
1027 self.padding = padding;
1028 }
1029
1030 pub(crate) fn set_layout_properties(&mut self, layout: LayoutProperties) {
1031 self.layout = layout;
1032 }
1033
1034 pub(crate) fn set_offset(&mut self, offset: Point) {
1035 self.offset = offset;
1036 }
1037}
1038
1039#[derive(Clone, Copy, Debug, Default, PartialEq)]
1040pub enum DimensionConstraint {
1041 #[default]
1042 Unspecified,
1043 Points(f32),
1044 Fraction(f32),
1045 Intrinsic(IntrinsicSize),
1046}
1047
1048#[derive(Clone, Copy, Debug, Default, PartialEq)]
1049pub struct LayoutWeight {
1050 pub weight: f32,
1051 pub fill: bool,
1052}
1053
1054#[derive(Clone, Copy, Debug, Default, PartialEq)]
1055pub struct LayoutProperties {
1056 padding: EdgeInsets,
1057 width: DimensionConstraint,
1058 height: DimensionConstraint,
1059 min_width: Option<f32>,
1060 min_height: Option<f32>,
1061 max_width: Option<f32>,
1062 max_height: Option<f32>,
1063 weight: Option<LayoutWeight>,
1064 box_alignment: Option<Alignment>,
1065 column_alignment: Option<HorizontalAlignment>,
1066 row_alignment: Option<VerticalAlignment>,
1067}
1068
1069impl LayoutProperties {
1070 pub fn padding(&self) -> EdgeInsets {
1071 self.padding
1072 }
1073
1074 pub fn width(&self) -> DimensionConstraint {
1075 self.width
1076 }
1077
1078 pub fn height(&self) -> DimensionConstraint {
1079 self.height
1080 }
1081
1082 pub fn min_width(&self) -> Option<f32> {
1083 self.min_width
1084 }
1085
1086 pub fn min_height(&self) -> Option<f32> {
1087 self.min_height
1088 }
1089
1090 pub fn max_width(&self) -> Option<f32> {
1091 self.max_width
1092 }
1093
1094 pub fn max_height(&self) -> Option<f32> {
1095 self.max_height
1096 }
1097
1098 pub fn weight(&self) -> Option<LayoutWeight> {
1099 self.weight
1100 }
1101
1102 pub fn box_alignment(&self) -> Option<Alignment> {
1103 self.box_alignment
1104 }
1105
1106 pub fn column_alignment(&self) -> Option<HorizontalAlignment> {
1107 self.column_alignment
1108 }
1109
1110 pub fn row_alignment(&self) -> Option<VerticalAlignment> {
1111 self.row_alignment
1112 }
1113}
1114
1115#[cfg(test)]
1116#[path = "tests/modifier_tests.rs"]
1117mod tests;