i_slint_compiler/passes/
lower_accessibility.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//! Pass that lowers synthetic `accessible-*` properties
5
6use crate::diagnostics::BuildDiagnostics;
7use crate::expression_tree::{Expression, NamedReference};
8use crate::langtype::EnumerationValue;
9use crate::object_tree::{Component, ElementRc};
10
11use smol_str::SmolStr;
12use std::rc::Rc;
13
14pub fn lower_accessibility_properties(component: &Rc<Component>, diag: &mut BuildDiagnostics) {
15    crate::object_tree::recurse_elem_including_sub_components_no_borrow(
16        component,
17        &(),
18        &mut |elem, _| {
19            if elem.borrow().repeated.is_some() {
20                return;
21            };
22            apply_builtin(elem);
23            let accessible_role_set = match elem.borrow().bindings.get("accessible-role") {
24                Some(role) => {
25                    if let Expression::EnumerationValue(val) =
26                        super::ignore_debug_hooks(&role.borrow().expression)
27                    {
28                        debug_assert_eq!(val.enumeration.name, "AccessibleRole");
29                        debug_assert_eq!(val.enumeration.values[0], "none");
30                        if val.value == 0 {
31                            return;
32                        }
33                    } else {
34                        diag.push_error(
35                            "The `accessible-role` property must be a constant expression".into(),
36                            &*role.borrow(),
37                        );
38                    }
39                    true
40                }
41                // maybe it was set on the parent
42                None => elem.borrow().is_binding_set("accessible-role", false),
43            };
44
45            for prop_name in crate::typeregister::reserved_accessibility_properties()
46                .map(|x| x.0)
47                .chain(std::iter::once("accessible-role"))
48            {
49                if accessible_role_set {
50                    if elem.borrow().is_binding_set(prop_name, false) {
51                        let nr = NamedReference::new(elem, SmolStr::new_static(prop_name));
52                        elem.borrow_mut().accessibility_props.0.insert(prop_name.into(), nr);
53                    }
54                } else if let Some(b) = elem.borrow().bindings.get(prop_name) {
55                    diag.push_error(
56                        format!("The `{prop_name}` property can only be set in combination to `accessible-role`"),
57                        &*b.borrow(),
58                    );
59                }
60            }
61        },
62    )
63}
64
65fn apply_builtin(e: &ElementRc) {
66    let bty = if let Some(bty) = e.borrow().builtin_type() { bty } else { return };
67    if bty.name == "Text" {
68        e.borrow_mut().set_binding_if_not_set("accessible-role".into(), || {
69            let enum_ty = crate::typeregister::BUILTIN.with(|e| e.enums.AccessibleRole.clone());
70            Expression::EnumerationValue(EnumerationValue {
71                value: enum_ty.values.iter().position(|v| v == "text").unwrap(),
72                enumeration: enum_ty,
73            })
74        });
75        let text_prop = NamedReference::new(e, SmolStr::new_static("text"));
76        e.borrow_mut().set_binding_if_not_set("accessible-label".into(), || {
77            Expression::PropertyReference(text_prop)
78        });
79    } else if bty.name == "TextInput" {
80        e.borrow_mut().set_binding_if_not_set("accessible-role".into(), || {
81            let enum_ty = crate::typeregister::BUILTIN.with(|e| e.enums.AccessibleRole.clone());
82            Expression::EnumerationValue(EnumerationValue {
83                value: enum_ty.values.iter().position(|v| v == "text-input").unwrap(),
84                enumeration: enum_ty,
85            })
86        });
87        let text_prop = NamedReference::new(e, SmolStr::new_static("text"));
88        e.borrow_mut().set_binding_if_not_set("accessible-value".into(), || {
89            Expression::PropertyReference(text_prop)
90        });
91        let enabled_prop = NamedReference::new(e, SmolStr::new_static("enabled"));
92        e.borrow_mut().set_binding_if_not_set("accessible-enabled".into(), || {
93            Expression::PropertyReference(enabled_prop)
94        });
95        let read_only_prop = NamedReference::new(e, SmolStr::new_static("read-only"));
96        e.borrow_mut().set_binding_if_not_set("accessible-read-only".into(), || {
97            Expression::PropertyReference(read_only_prop)
98        });
99    } else if bty.name == "Image" {
100        e.borrow_mut().set_binding_if_not_set("accessible-role".into(), || {
101            let enum_ty = crate::typeregister::BUILTIN.with(|e| e.enums.AccessibleRole.clone());
102            Expression::EnumerationValue(EnumerationValue {
103                value: enum_ty.values.iter().position(|v| v == "image").unwrap(),
104                enumeration: enum_ty,
105            })
106        });
107    }
108}