i_slint_compiler/passes/
repeater_component.rs

1// Copyright © SixtyFPS GmbH <info@slint.dev>
2// SPDX-License-Identifier: GPL-3.0-only OR LicenseRef-Slint-Royalty-free-2.0 OR LicenseRef-Slint-Software-3.0
3
4/*!
5Make sure that the Repeated expression are just components without any children
6 */
7
8use crate::expression_tree::{Expression, NamedReference};
9use crate::langtype::ElementType;
10use crate::object_tree::*;
11use smol_str::SmolStr;
12use std::cell::RefCell;
13use std::rc::{Rc, Weak};
14
15pub fn process_repeater_components(component: &Rc<Component>) {
16    create_repeater_components(component);
17    adjust_references(component);
18}
19
20fn create_repeater_components(component: &Rc<Component>) {
21    recurse_elem(&component.root_element, &(), &mut |original_elem_rc, _| {
22        let is_listview = match &original_elem_rc.borrow().repeated {
23            Some(r) => r.is_listview.clone(),
24            None => return,
25        };
26        let original_elem_as_weak = Rc::downgrade(original_elem_rc);
27        let mut original_elem = original_elem_rc.borrow_mut();
28
29        if matches!(&original_elem.base_type, ElementType::Component(c) if c.parent_element().is_some())
30        {
31            debug_assert!(std::rc::Weak::ptr_eq(
32                &original_elem_as_weak,
33                &*original_elem.base_type.as_component().parent_element.borrow()
34            ));
35            // Already processed (can happen if a component is both used and exported root)
36            return;
37        }
38
39        let repeated_component = Rc::new(Component {
40            root_element: Rc::new(RefCell::new(Element {
41                id: original_elem.id.clone(),
42                base_type: std::mem::take(&mut original_elem.base_type),
43                bindings: std::mem::take(&mut original_elem.bindings),
44                change_callbacks: std::mem::take(&mut original_elem.change_callbacks),
45                property_analysis: std::mem::take(&mut original_elem.property_analysis),
46                children: std::mem::take(&mut original_elem.children),
47                property_declarations: std::mem::take(&mut original_elem.property_declarations),
48                shadowing_members: std::mem::take(&mut original_elem.shadowing_members),
49                named_references: Default::default(),
50                repeated: None,
51                is_component_placeholder: false,
52                is_injected_wrapper_element: original_elem.is_injected_wrapper_element,
53                debug: original_elem.debug.clone(),
54                enclosing_component: Default::default(),
55                states: std::mem::take(&mut original_elem.states),
56                transitions: std::mem::take(&mut original_elem.transitions),
57                match_elements: Default::default(),
58                child_of_layout: original_elem.child_of_layout || is_listview.is_some(),
59                child_of_flexbox: original_elem.child_of_flexbox,
60                parent_box_layout_orientation: original_elem.parent_box_layout_orientation,
61                layout_info_prop: original_elem.layout_info_prop.take(),
62                layout_info_v_with_constraint: original_elem.layout_info_v_with_constraint.take(),
63                layout_info_h_at_own_height: original_elem.layout_info_h_at_own_height.take(),
64                height_is_literal: original_elem.height_is_literal,
65                default_fill_parent: original_elem.default_fill_parent,
66                accessibility_props: std::mem::take(&mut original_elem.accessibility_props),
67                geometry_props: original_elem.geometry_props.clone(),
68                is_flickable_content: original_elem.is_flickable_content,
69                has_popup_child: original_elem.has_popup_child,
70                is_tooltip: original_elem.is_tooltip,
71                z_order: original_elem.z_order.clone(),
72                item_index: Default::default(), // Not determined yet
73                item_index_of_first_children: Default::default(),
74                is_legacy_syntax: original_elem.is_legacy_syntax,
75                inline_depth: 0,
76                slot_target: original_elem.slot_target.clone(),
77                forwarded_slots: original_elem.forwarded_slots.clone(),
78                grid_layout_cell: original_elem.grid_layout_cell.clone(),
79            })),
80            parent_element: RefCell::new(Weak::clone(&original_elem_as_weak)),
81            ..Component::default()
82        });
83
84        if let Some(listview) = is_listview {
85            if !repeated_component.root_element.borrow().is_binding_set("height", false) {
86                let preferred = Expression::PropertyReference(NamedReference::new(
87                    &repeated_component.root_element,
88                    SmolStr::new_static("preferred-height"),
89                ));
90                repeated_component
91                    .root_element
92                    .borrow_mut()
93                    .set_binding("height".into(), preferred.into());
94            }
95            if !repeated_component.root_element.borrow().is_binding_set("width", false) {
96                repeated_component.root_element.borrow_mut().set_binding(
97                    "width".into(),
98                    Expression::PropertyReference(listview.listview_width).into(),
99                );
100            }
101        }
102
103        let repeated_component_weak = Rc::downgrade(&repeated_component);
104        recurse_elem(&repeated_component.root_element, &(), &mut |e, _| {
105            e.borrow_mut().enclosing_component = repeated_component_weak.clone()
106        });
107        // Remove the mutable borrow from the RefCell, so that we can later compare it with the parent_element of the menu items
108        drop(original_elem);
109
110        // Move all the menus that belong to the newly created component
111        repeated_component.menu_item_tree.borrow_mut().extend(
112            component.menu_item_tree.borrow_mut().extract_if(.., |menu_item| {
113                let mut parent_elem = menu_item.parent_element.borrow_mut();
114
115                // When parent_element IS the element being split, update the parent_elem
116                // to point to the new sub-component's root.
117                if Weak::ptr_eq(&parent_elem, &original_elem_as_weak) {
118                    *parent_elem = Rc::downgrade(&repeated_component.root_element);
119                }
120
121                let enclosing_component =
122                    parent_elem.upgrade().unwrap().borrow().enclosing_component.clone();
123                Weak::ptr_eq(&enclosing_component, &repeated_component_weak)
124            }),
125        );
126
127        create_repeater_components(&repeated_component);
128        original_elem_rc.borrow_mut().base_type = ElementType::Component(repeated_component);
129    });
130
131    for p in component.popup_windows.borrow().iter() {
132        create_repeater_components(&p.component);
133    }
134    for c in component.menu_item_tree.borrow().iter() {
135        create_repeater_components(c);
136    }
137}
138
139/// Make sure that references to properties within the repeated element actually point to the reference
140/// to the root of the newly created component
141pub fn adjust_references(component: &Rc<Component>) {
142    visit_all_named_references(component, &mut |reference| {
143        if reference.name() == "$model" {
144            return;
145        }
146        let referred_element = reference.element();
147        if referred_element.borrow().repeated.is_some()
148            && let ElementType::Component(created_component) =
149                referred_element.borrow().base_type.clone()
150        {
151            *reference =
152                NamedReference::new(&created_component.root_element, reference.name().clone())
153        };
154    });
155    // Transform any references to the repeated element to refer to the root of each instance.
156    visit_all_expressions(component, |expr, _| {
157        expr.visit_recursive_mut(&mut |expr| {
158            if let Expression::ElementReference(element_ref) = expr
159                && let Some(repeater_element) =
160                    element_ref.upgrade().filter(|e| e.borrow().repeated.is_some())
161            {
162                let inner_element =
163                    repeater_element.borrow().base_type.as_component().root_element.clone();
164                *element_ref = Rc::downgrade(&inner_element);
165            }
166        })
167    });
168}
i_slint_compiler/passes/repeater_component.rs

i_slint_compiler/passes/
repeater_component.rs
