// Copyright © SixtyFPS GmbH // SPDX-License-Identifier: GPL-3.0-only OR LicenseRef-Slint-Royalty-free-2.0 OR LicenseRef-Slint-Software-3.0 use i_slint_compiler::langtype::Type as LangType; use i_slint_core::component_factory::ComponentFactory; #[cfg(feature = "internal")] use i_slint_core::component_factory::FactoryContext; use i_slint_core::graphics::euclid::approxeq::ApproxEq as _; use i_slint_core::model::{Model, ModelExt, ModelRc}; #[cfg(feature = "internal")] use i_slint_core::window::WindowInner; use i_slint_core::{PathData, SharedVector}; use smol_str::{SmolStr, StrExt}; use std::borrow::Cow; use std::collections::HashMap; use std::future::Future; use std::path::{Path, PathBuf}; use std::rc::Rc; #[doc(inline)] pub use i_slint_compiler::diagnostics::{Diagnostic, DiagnosticLevel}; pub use i_slint_core::api::*; // keep in sync with api/rs/slint/lib.rs pub use i_slint_backend_selector::api::*; pub use i_slint_core::graphics::{ Brush, Color, Image, LoadImageError, Rgb8Pixel, Rgba8Pixel, RgbaColor, SharedPixelBuffer, }; use i_slint_core::items::*; use crate::dynamic_item_tree::ErasedItemTreeBox; #[cfg(any(feature = "internal", target_arch = "wasm32"))] use crate::dynamic_item_tree::WindowOptions; /// This enum represents the different public variants of the [`Value`] enum, without /// the contained values. #[derive(Debug, Copy, Clone, PartialEq)] #[repr(i8)] #[non_exhaustive] pub enum ValueType { /// The variant that expresses the non-type. This is the default. Void, /// An `int` or a `float` (this is also used for unit based type such as `length` or `angle`) Number, /// Correspond to the `string` type in .slint String, /// Correspond to the `bool` type in .slint Bool, /// A model (that includes array in .slint) Model, /// An object Struct, /// Correspond to `brush` or `color` type in .slint. For color, this is then a [`Brush::SolidColor`] Brush, /// Correspond to `image` type in .slint. Image, /// The type is not a public type but something internal. #[doc(hidden)] Other = -1, } impl From for ValueType { fn from(ty: LangType) -> Self { match ty { LangType::Float32 | LangType::Int32 | LangType::Duration | LangType::Angle | LangType::PhysicalLength | LangType::LogicalLength | LangType::Percent | LangType::UnitProduct(_) => Self::Number, LangType::String => Self::String, LangType::Color => Self::Brush, LangType::Brush => Self::Brush, LangType::Array(_) => Self::Model, LangType::Bool => Self::Bool, LangType::Struct { .. } => Self::Struct, LangType::Void => Self::Void, LangType::Image => Self::Image, _ => Self::Other, } } } /// This is a dynamically typed value used in the Slint interpreter. /// It can hold a value of different types, and you should use the /// [`From`] or [`TryFrom`] traits to access the value. /// /// ``` /// # use slint_interpreter::*; /// use core::convert::TryInto; /// // create a value containing an integer /// let v = Value::from(100u32); /// assert_eq!(v.try_into(), Ok(100u32)); /// ``` #[derive(Clone, Default)] #[non_exhaustive] #[repr(u8)] pub enum Value { /// There is nothing in this value. That's the default. /// For example, a function that does not return a result would return a Value::Void #[default] Void = 0, /// An `int` or a `float` (this is also used for unit based type such as `length` or `angle`) Number(f64) = 1, /// Correspond to the `string` type in .slint String(SharedString) = 2, /// Correspond to the `bool` type in .slint Bool(bool) = 3, /// Correspond to the `image` type in .slint Image(Image) = 4, /// A model (that includes array in .slint) Model(ModelRc) = 5, /// An object Struct(Struct) = 6, /// Correspond to `brush` or `color` type in .slint. For color, this is then a [`Brush::SolidColor`] Brush(Brush) = 7, #[doc(hidden)] /// The elements of a path PathData(PathData) = 8, #[doc(hidden)] /// An easing curve EasingCurve(i_slint_core::animations::EasingCurve) = 9, #[doc(hidden)] /// An enumeration, like `TextHorizontalAlignment::align_center`, represented by `("TextHorizontalAlignment", "align_center")`. /// FIXME: consider representing that with a number? EnumerationValue(String, String) = 10, #[doc(hidden)] LayoutCache(SharedVector) = 11, #[doc(hidden)] /// Correspond to the `component-factory` type in .slint ComponentFactory(ComponentFactory) = 12, } impl Value { /// Returns the type variant that this value holds without the containing value. pub fn value_type(&self) -> ValueType { match self { Value::Void => ValueType::Void, Value::Number(_) => ValueType::Number, Value::String(_) => ValueType::String, Value::Bool(_) => ValueType::Bool, Value::Model(_) => ValueType::Model, Value::Struct(_) => ValueType::Struct, Value::Brush(_) => ValueType::Brush, Value::Image(_) => ValueType::Image, _ => ValueType::Other, } } } impl PartialEq for Value { fn eq(&self, other: &Self) -> bool { match self { Value::Void => matches!(other, Value::Void), Value::Number(lhs) => matches!(other, Value::Number(rhs) if lhs.approx_eq(rhs)), Value::String(lhs) => matches!(other, Value::String(rhs) if lhs == rhs), Value::Bool(lhs) => matches!(other, Value::Bool(rhs) if lhs == rhs), Value::Image(lhs) => matches!(other, Value::Image(rhs) if lhs == rhs), Value::Model(lhs) => { if let Value::Model(rhs) = other { lhs == rhs } else { false } } Value::Struct(lhs) => matches!(other, Value::Struct(rhs) if lhs == rhs), Value::Brush(lhs) => matches!(other, Value::Brush(rhs) if lhs == rhs), Value::PathData(lhs) => matches!(other, Value::PathData(rhs) if lhs == rhs), Value::EasingCurve(lhs) => matches!(other, Value::EasingCurve(rhs) if lhs == rhs), Value::EnumerationValue(lhs_name, lhs_value) => { matches!(other, Value::EnumerationValue(rhs_name, rhs_value) if lhs_name == rhs_name && lhs_value == rhs_value) } Value::LayoutCache(lhs) => matches!(other, Value::LayoutCache(rhs) if lhs == rhs), Value::ComponentFactory(lhs) => { matches!(other, Value::ComponentFactory(rhs) if lhs == rhs) } } } } impl std::fmt::Debug for Value { fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { match self { Value::Void => write!(f, "Value::Void"), Value::Number(n) => write!(f, "Value::Number({n:?})"), Value::String(s) => write!(f, "Value::String({s:?})"), Value::Bool(b) => write!(f, "Value::Bool({b:?})"), Value::Image(i) => write!(f, "Value::Image({i:?})"), Value::Model(m) => { write!(f, "Value::Model(")?; f.debug_list().entries(m.iter()).finish()?; write!(f, "])") } Value::Struct(s) => write!(f, "Value::Struct({s:?})"), Value::Brush(b) => write!(f, "Value::Brush({b:?})"), Value::PathData(e) => write!(f, "Value::PathElements({e:?})"), Value::EasingCurve(c) => write!(f, "Value::EasingCurve({c:?})"), Value::EnumerationValue(n, v) => write!(f, "Value::EnumerationValue({n:?}, {v:?})"), Value::LayoutCache(v) => write!(f, "Value::LayoutCache({v:?})"), Value::ComponentFactory(factory) => write!(f, "Value::ComponentFactory({factory:?})"), } } } /// Helper macro to implement the From / TryFrom for Value /// /// For example /// `declare_value_conversion!(Number => [u32, u64, i32, i64, f32, f64] );` /// means that `Value::Number` can be converted to / from each of the said rust types /// /// For `Value::Object` mapping to a rust `struct`, one can use [`declare_value_struct_conversion!`] /// And for `Value::EnumerationValue` which maps to a rust `enum`, one can use [`declare_value_struct_conversion!`] macro_rules! declare_value_conversion { ( $value:ident => [$($ty:ty),*] ) => { $( impl From<$ty> for Value { fn from(v: $ty) -> Self { Value::$value(v as _) } } impl TryFrom for $ty { type Error = Value; fn try_from(v: Value) -> Result<$ty, Self::Error> { match v { Value::$value(x) => Ok(x as _), _ => Err(v) } } } )* }; } declare_value_conversion!(Number => [u32, u64, i32, i64, f32, f64, usize, isize] ); declare_value_conversion!(String => [SharedString] ); declare_value_conversion!(Bool => [bool] ); declare_value_conversion!(Image => [Image] ); declare_value_conversion!(Struct => [Struct] ); declare_value_conversion!(Brush => [Brush] ); declare_value_conversion!(PathData => [PathData]); declare_value_conversion!(EasingCurve => [i_slint_core::animations::EasingCurve]); declare_value_conversion!(LayoutCache => [SharedVector] ); declare_value_conversion!(ComponentFactory => [ComponentFactory] ); /// Implement From / TryFrom for Value that convert a `struct` to/from `Value::Struct` macro_rules! declare_value_struct_conversion { (struct $name:path { $($field:ident),* $(, ..$extra:expr)? }) => { impl From<$name> for Value { fn from($name { $($field),* , .. }: $name) -> Self { let mut struct_ = Struct::default(); $(struct_.set_field(stringify!($field).into(), $field.into());)* Value::Struct(struct_) } } impl TryFrom for $name { type Error = (); fn try_from(v: Value) -> Result<$name, Self::Error> { #[allow(clippy::field_reassign_with_default)] match v { Value::Struct(x) => { type Ty = $name; #[allow(unused)] let mut res: Ty = Ty::default(); $(let mut res: Ty = $extra;)? $(res.$field = x.get_field(stringify!($field)).ok_or(())?.clone().try_into().map_err(|_|())?;)* Ok(res) } _ => Err(()), } } } }; ($( $(#[$struct_attr:meta])* struct $Name:ident { @name = $inner_name:literal export { $( $(#[$pub_attr:meta])* $pub_field:ident : $pub_type:ty, )* } private { $( $(#[$pri_attr:meta])* $pri_field:ident : $pri_type:ty, )* } } )*) => { $( impl From<$Name> for Value { fn from(item: $Name) -> Self { let mut struct_ = Struct::default(); $(struct_.set_field(stringify!($pub_field).into(), item.$pub_field.into());)* $(handle_private!(SET $Name $pri_field, struct_, item);)* Value::Struct(struct_) } } impl TryFrom for $Name { type Error = (); fn try_from(v: Value) -> Result<$Name, Self::Error> { #[allow(clippy::field_reassign_with_default)] match v { Value::Struct(x) => { type Ty = $Name; #[allow(unused)] let mut res: Ty = Ty::default(); $(res.$pub_field = x.get_field(stringify!($pub_field)).ok_or(())?.clone().try_into().map_err(|_|())?;)* $(handle_private!(GET $Name $pri_field, x, res);)* Ok(res) } _ => Err(()), } } } )* }; } macro_rules! handle_private { (SET StateInfo $field:ident, $struct_:ident, $item:ident) => { $struct_.set_field(stringify!($field).into(), $item.$field.into()) }; (SET $_:ident $field:ident, $struct_:ident, $item:ident) => {{}}; (GET StateInfo $field:ident, $struct_:ident, $item:ident) => { $item.$field = $struct_.get_field(stringify!($field)).ok_or(())?.clone().try_into().map_err(|_| ())? }; (GET $_:ident $field:ident, $struct_:ident, $item:ident) => {{}}; } declare_value_struct_conversion!(struct i_slint_core::layout::LayoutInfo { min, max, min_percent, max_percent, preferred, stretch }); declare_value_struct_conversion!(struct i_slint_core::graphics::Point { x, y, ..Default::default()}); declare_value_struct_conversion!(struct i_slint_core::api::LogicalPosition { x, y }); i_slint_common::for_each_builtin_structs!(declare_value_struct_conversion); /// Implement From / TryFrom for Value that convert an `enum` to/from `Value::EnumerationValue` /// /// The `enum` must derive `Display` and `FromStr` /// (can be done with `strum_macros::EnumString`, `strum_macros::Display` derive macro) macro_rules! declare_value_enum_conversion { ($( $(#[$enum_doc:meta])* enum $Name:ident { $($body:tt)* })*) => { $( impl From for Value { fn from(v: i_slint_core::items::$Name) -> Self { Value::EnumerationValue( stringify!($Name).to_owned(), v.to_string().trim_start_matches("r#").replace('_', "-"), ) } } impl TryFrom for i_slint_core::items::$Name { type Error = (); fn try_from(v: Value) -> Result { use std::str::FromStr; match v { Value::EnumerationValue(enumeration, value) => { if enumeration != stringify!($Name) { return Err(()); } ::from_str(value.as_str()) .or_else(|_| { let norm = value.as_str().replace('-', "_"); ::from_str(&norm) .or_else(|_| ::from_str(&format!("r#{}", norm))) }) .map_err(|_| ()) } _ => Err(()), } } } )*}; } i_slint_common::for_each_enums!(declare_value_enum_conversion); impl From for Value { fn from(value: i_slint_core::animations::Instant) -> Self { Value::Number(value.0 as _) } } impl TryFrom for i_slint_core::animations::Instant { type Error = (); fn try_from(v: Value) -> Result { match v { Value::Number(x) => Ok(i_slint_core::animations::Instant(x as _)), _ => Err(()), } } } impl From<()> for Value { #[inline] fn from(_: ()) -> Self { Value::Void } } impl TryFrom for () { type Error = (); #[inline] fn try_from(_: Value) -> Result<(), Self::Error> { Ok(()) } } impl From for Value { #[inline] fn from(c: Color) -> Self { Value::Brush(Brush::SolidColor(c)) } } impl TryFrom for Color { type Error = Value; #[inline] fn try_from(v: Value) -> Result { match v { Value::Brush(Brush::SolidColor(c)) => Ok(c), _ => Err(v), } } } impl From for Value { #[inline] fn from(l: i_slint_core::lengths::LogicalLength) -> Self { Value::Number(l.get() as _) } } impl TryFrom for i_slint_core::lengths::LogicalLength { type Error = Value; #[inline] fn try_from(v: Value) -> Result { match v { Value::Number(n) => Ok(i_slint_core::lengths::LogicalLength::new(n as _)), _ => Err(v), } } } impl + 'static> From> for Value { fn from(m: ModelRc) -> Self { if let Some(v) = ::downcast_ref::>(&m) { Value::Model(v.clone()) } else { Value::Model(ModelRc::new(m.map(|v| v.into()))) } } } impl + Default + 'static> TryFrom for ModelRc { type Error = Value; #[inline] fn try_from(v: Value) -> Result, Self::Error> { match v { Value::Model(m) => { if let Some(v) = ::downcast_ref::>(&m) { Ok(v.clone()) } else { Ok(ModelRc::new(m.map(|v| T::try_from(v).unwrap_or_default()))) } } _ => Err(v), } } } #[test] fn value_model_conversion() { use i_slint_core::model::*; let m = ModelRc::new(VecModel::from_slice(&[Value::Number(42.), Value::Number(12.)])); let v = Value::from(m.clone()); assert_eq!(v, Value::Model(m.clone())); let m2: ModelRc = v.clone().try_into().unwrap(); assert_eq!(m2, m); let int_model: ModelRc = v.clone().try_into().unwrap(); assert_eq!(int_model.row_count(), 2); assert_eq!(int_model.iter().collect::>(), vec![42, 12]); let Value::Model(m3) = int_model.clone().into() else { panic!("not a model?") }; assert_eq!(m3.row_count(), 2); assert_eq!(m3.iter().collect::>(), vec![Value::Number(42.), Value::Number(12.)]); let str_model: ModelRc = v.clone().try_into().unwrap(); assert_eq!(str_model.row_count(), 2); // Value::Int doesn't convert to string, but since the mapping can't report error, we get the default constructed string assert_eq!(str_model.iter().collect::>(), vec!["", ""]); let err: Result, _> = Value::Bool(true).try_into(); assert!(err.is_err()); } /// Normalize the identifier to use dashes pub(crate) fn normalize_identifier(ident: &str) -> Cow<'_, str> { if ident.contains('_') { ident.replace('_', "-").into() } else { ident.into() } } pub(crate) fn normalize_identifier_smolstr(ident: &str) -> SmolStr { if ident.contains('_') { ident.replace_smolstr("_", "-") } else { ident.into() } } /// This type represents a runtime instance of structure in `.slint`. /// /// This can either be an instance of a name structure introduced /// with the `struct` keyword in the .slint file, or an anonymous struct /// written with the `{ key: value, }` notation. /// /// It can be constructed with the [`FromIterator`] trait, and converted /// into or from a [`Value`] with the [`From`], [`TryFrom`] trait /// /// /// ``` /// # use slint_interpreter::*; /// use core::convert::TryInto; /// // Construct a value from a key/value iterator /// let value : Value = [("foo".into(), 45u32.into()), ("bar".into(), true.into())] /// .iter().cloned().collect::().into(); /// /// // get the properties of a `{ foo: 45, bar: true }` /// let s : Struct = value.try_into().unwrap(); /// assert_eq!(s.get_field("foo").cloned().unwrap().try_into(), Ok(45u32)); /// ``` #[derive(Clone, PartialEq, Debug, Default)] pub struct Struct(pub(crate) HashMap); impl Struct { /// Get the value for a given struct field pub fn get_field(&self, name: &str) -> Option<&Value> { self.0.get(&*normalize_identifier(name)) } /// Set the value of a given struct field pub fn set_field(&mut self, name: String, value: Value) { if name.contains('_') { self.0.insert(name.replace('_', "-"), value); } else { self.0.insert(name, value); } } /// Iterate over all the fields in this struct pub fn iter(&self) -> impl Iterator { self.0.iter().map(|(a, b)| (a.as_str(), b)) } } impl FromIterator<(String, Value)> for Struct { fn from_iter>(iter: T) -> Self { Self( iter.into_iter() .map(|(s, v)| (if s.contains('_') { s.replace('_', "-") } else { s }, v)) .collect(), ) } } /// ComponentCompiler is deprecated, use [`Compiler`] instead #[deprecated(note = "Use slint_interpreter::Compiler instead")] pub struct ComponentCompiler { config: i_slint_compiler::CompilerConfiguration, diagnostics: Vec, } #[allow(deprecated)] impl Default for ComponentCompiler { fn default() -> Self { let mut config = i_slint_compiler::CompilerConfiguration::new( i_slint_compiler::generator::OutputFormat::Interpreter, ); config.components_to_generate = i_slint_compiler::ComponentSelection::LastExported; Self { config, diagnostics: vec![] } } } #[allow(deprecated)] impl ComponentCompiler { /// Returns a new ComponentCompiler. pub fn new() -> Self { Self::default() } /// Sets the include paths used for looking up `.slint` imports to the specified vector of paths. pub fn set_include_paths(&mut self, include_paths: Vec) { self.config.include_paths = include_paths; } /// Returns the include paths the component compiler is currently configured with. pub fn include_paths(&self) -> &Vec { &self.config.include_paths } /// Sets the library paths used for looking up `@library` imports to the specified map of library names to paths. pub fn set_library_paths(&mut self, library_paths: HashMap) { self.config.library_paths = library_paths; } /// Returns the library paths the component compiler is currently configured with. pub fn library_paths(&self) -> &HashMap { &self.config.library_paths } /// Sets the style to be used for widgets. /// /// Use the "material" style as widget style when compiling: /// ```rust /// use slint_interpreter::{ComponentDefinition, ComponentCompiler, ComponentHandle}; /// /// let mut compiler = ComponentCompiler::default(); /// compiler.set_style("material".into()); /// let definition = /// spin_on::spin_on(compiler.build_from_path("hello.slint")); /// ``` pub fn set_style(&mut self, style: String) { self.config.style = Some(style); } /// Returns the widget style the compiler is currently using when compiling .slint files. pub fn style(&self) -> Option<&String> { self.config.style.as_ref() } /// The domain used for translations pub fn set_translation_domain(&mut self, domain: String) { self.config.translation_domain = Some(domain); } /// Sets the callback that will be invoked when loading imported .slint files. The specified /// `file_loader_callback` parameter will be called with a canonical file path as argument /// and is expected to return a future that, when resolved, provides the source code of the /// .slint file to be imported as a string. /// If an error is returned, then the build will abort with that error. /// If None is returned, it means the normal resolution algorithm will proceed as if the hook /// was not in place (i.e: load from the file system following the include paths) pub fn set_file_loader( &mut self, file_loader_fallback: impl Fn(&Path) -> core::pin::Pin>>>> + 'static, ) { self.config.open_import_fallback = Some(Rc::new(move |path| file_loader_fallback(Path::new(path.as_str())))); } /// Returns the diagnostics that were produced in the last call to [`Self::build_from_path`] or [`Self::build_from_source`]. pub fn diagnostics(&self) -> &Vec { &self.diagnostics } /// Compile a .slint file into a ComponentDefinition /// /// Returns the compiled `ComponentDefinition` if there were no errors. /// /// Any diagnostics produced during the compilation, such as warnings or errors, are collected /// in this ComponentCompiler and can be retrieved after the call using the [`Self::diagnostics()`] /// function. The [`print_diagnostics`] function can be used to display the diagnostics /// to the users. /// /// Diagnostics from previous calls are cleared when calling this function. /// /// If the path is `"-"`, the file will be read from stdin. /// If the extension of the file .rs, the first `slint!` macro from a rust file will be extracted /// /// This function is `async` but in practice, this is only asynchronous if /// [`Self::set_file_loader`] was called and its future is actually asynchronous. /// If that is not used, then it is fine to use a very simple executor, such as the one /// provided by the `spin_on` crate pub async fn build_from_path>( &mut self, path: P, ) -> Option { let path = path.as_ref(); let source = match i_slint_compiler::diagnostics::load_from_path(path) { Ok(s) => s, Err(d) => { self.diagnostics = vec![d]; return None; } }; let r = crate::dynamic_item_tree::load(source, path.into(), self.config.clone()).await; self.diagnostics = r.diagnostics.into_iter().collect(); r.components.into_values().next() } /// Compile some .slint code into a ComponentDefinition /// /// The `path` argument will be used for diagnostics and to compute relative /// paths while importing. /// /// Any diagnostics produced during the compilation, such as warnings or errors, are collected /// in this ComponentCompiler and can be retrieved after the call using the [`Self::diagnostics()`] /// function. The [`print_diagnostics`] function can be used to display the diagnostics /// to the users. /// /// Diagnostics from previous calls are cleared when calling this function. /// /// This function is `async` but in practice, this is only asynchronous if /// [`Self::set_file_loader`] is set and its future is actually asynchronous. /// If that is not used, then it is fine to use a very simple executor, such as the one /// provided by the `spin_on` crate pub async fn build_from_source( &mut self, source_code: String, path: PathBuf, ) -> Option { let r = crate::dynamic_item_tree::load(source_code, path, self.config.clone()).await; self.diagnostics = r.diagnostics.into_iter().collect(); r.components.into_values().next() } } /// This is the entry point of the crate, it can be used to load a `.slint` file and /// compile it into a [`CompilationResult`]. pub struct Compiler { config: i_slint_compiler::CompilerConfiguration, } impl Default for Compiler { fn default() -> Self { let config = i_slint_compiler::CompilerConfiguration::new( i_slint_compiler::generator::OutputFormat::Interpreter, ); Self { config } } } impl Compiler { /// Returns a new Compiler. pub fn new() -> Self { Self::default() } /// Allow access to the underlying `CompilerConfiguration` /// /// This is an internal function without and ABI or API stability guarantees. #[doc(hidden)] #[cfg(feature = "internal")] pub fn compiler_configuration( &mut self, _: i_slint_core::InternalToken, ) -> &mut i_slint_compiler::CompilerConfiguration { &mut self.config } /// Sets the include paths used for looking up `.slint` imports to the specified vector of paths. pub fn set_include_paths(&mut self, include_paths: Vec) { self.config.include_paths = include_paths; } /// Returns the include paths the component compiler is currently configured with. pub fn include_paths(&self) -> &Vec { &self.config.include_paths } /// Sets the library paths used for looking up `@library` imports to the specified map of library names to paths. pub fn set_library_paths(&mut self, library_paths: HashMap) { self.config.library_paths = library_paths; } /// Returns the library paths the component compiler is currently configured with. pub fn library_paths(&self) -> &HashMap { &self.config.library_paths } /// Sets the style to be used for widgets. /// /// Use the "material" style as widget style when compiling: /// ```rust /// use slint_interpreter::{ComponentDefinition, Compiler, ComponentHandle}; /// /// let mut compiler = Compiler::default(); /// compiler.set_style("material".into()); /// let result = spin_on::spin_on(compiler.build_from_path("hello.slint")); /// ``` pub fn set_style(&mut self, style: String) { self.config.style = Some(style); } /// Returns the widget style the compiler is currently using when compiling .slint files. pub fn style(&self) -> Option<&String> { self.config.style.as_ref() } /// The domain used for translations pub fn set_translation_domain(&mut self, domain: String) { self.config.translation_domain = Some(domain); } /// Sets the callback that will be invoked when loading imported .slint files. The specified /// `file_loader_callback` parameter will be called with a canonical file path as argument /// and is expected to return a future that, when resolved, provides the source code of the /// .slint file to be imported as a string. /// If an error is returned, then the build will abort with that error. /// If None is returned, it means the normal resolution algorithm will proceed as if the hook /// was not in place (i.e: load from the file system following the include paths) pub fn set_file_loader( &mut self, file_loader_fallback: impl Fn(&Path) -> core::pin::Pin>>>> + 'static, ) { self.config.open_import_fallback = Some(Rc::new(move |path| file_loader_fallback(Path::new(path.as_str())))); } /// Compile a .slint file /// /// Returns a structure that holds the diagnostics and the compiled components. /// /// Any diagnostics produced during the compilation, such as warnings or errors, can be retrieved /// after the call using [`CompilationResult::diagnostics()`]. /// /// If the file was compiled without error, the list of component names can be obtained with /// [`CompilationResult::component_names`], and the compiled components themselves with /// [`CompilationResult::component()`]. /// /// If the path is `"-"`, the file will be read from stdin. /// If the extension of the file .rs, the first `slint!` macro from a rust file will be extracted /// /// This function is `async` but in practice, this is only asynchronous if /// [`Self::set_file_loader`] was called and its future is actually asynchronous. /// If that is not used, then it is fine to use a very simple executor, such as the one /// provided by the `spin_on` crate pub async fn build_from_path>(&self, path: P) -> CompilationResult { let path = path.as_ref(); let source = match i_slint_compiler::diagnostics::load_from_path(path) { Ok(s) => s, Err(d) => { let mut diagnostics = i_slint_compiler::diagnostics::BuildDiagnostics::default(); diagnostics.push_compiler_error(d); return CompilationResult { components: HashMap::new(), diagnostics: diagnostics.into_iter().collect(), #[cfg(feature = "internal")] structs_and_enums: Vec::new(), #[cfg(feature = "internal")] named_exports: Vec::new(), }; } }; crate::dynamic_item_tree::load(source, path.into(), self.config.clone()).await } /// Compile some .slint code /// /// The `path` argument will be used for diagnostics and to compute relative /// paths while importing. /// /// Any diagnostics produced during the compilation, such as warnings or errors, can be retrieved /// after the call using [`CompilationResult::diagnostics()`]. /// /// This function is `async` but in practice, this is only asynchronous if /// [`Self::set_file_loader`] is set and its future is actually asynchronous. /// If that is not used, then it is fine to use a very simple executor, such as the one /// provided by the `spin_on` crate pub async fn build_from_source(&self, source_code: String, path: PathBuf) -> CompilationResult { crate::dynamic_item_tree::load(source_code, path, self.config.clone()).await } } /// The result of a compilation /// /// If [`Self::has_errors()`] is true, then the compilation failed. /// The [`Self::diagnostics()`] function can be used to retrieve the diagnostics (errors and/or warnings) /// or [`Self::print_diagnostics()`] can be used to print them to stderr. /// The components can be retrieved using [`Self::components()`] #[derive(Clone)] pub struct CompilationResult { pub(crate) components: HashMap, pub(crate) diagnostics: Vec, #[cfg(feature = "internal")] pub(crate) structs_and_enums: Vec, /// For `export { Foo as Bar }` this vec contains tuples of (`Foo`, `Bar`) #[cfg(feature = "internal")] pub(crate) named_exports: Vec<(String, String)>, } impl core::fmt::Debug for CompilationResult { fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { f.debug_struct("CompilationResult") .field("components", &self.components.keys()) .field("diagnostics", &self.diagnostics) .finish() } } impl CompilationResult { /// Returns true if the compilation failed. /// The errors can be retrieved using the [`Self::diagnostics()`] function. pub fn has_errors(&self) -> bool { self.diagnostics().any(|diag| diag.level() == DiagnosticLevel::Error) } /// Return an iterator over the diagnostics. /// /// You can also call [`Self::print_diagnostics()`] to output the diagnostics to stderr pub fn diagnostics(&self) -> impl Iterator + '_ { self.diagnostics.iter().cloned() } /// Print the diagnostics to stderr /// /// The diagnostics are printed in the same style as rustc errors /// /// This function is available when the `display-diagnostics` is enabled. #[cfg(feature = "display-diagnostics")] pub fn print_diagnostics(&self) { print_diagnostics(&self.diagnostics) } /// Returns an iterator over the compiled components. pub fn components(&self) -> impl Iterator + '_ { self.components.values().cloned() } /// Returns the names of the components that were compiled. pub fn component_names(&self) -> impl Iterator + '_ { self.components.keys().map(|s| s.as_str()) } /// Return the component definition for the given name. /// If the component does not exist, then `None` is returned. pub fn component(&self, name: &str) -> Option { self.components.get(name).cloned() } /// This is an internal function without API stability guarantees. #[doc(hidden)] #[cfg(feature = "internal")] pub fn structs_and_enums( &self, _: i_slint_core::InternalToken, ) -> impl Iterator { self.structs_and_enums.iter() } /// This is an internal function without API stability guarantees. /// Returns the list of named export aliases as tuples (`export { Foo as Bar}` is (`Foo`, `Bar` tuple)). #[doc(hidden)] #[cfg(feature = "internal")] pub fn named_exports( &self, _: i_slint_core::InternalToken, ) -> impl Iterator { self.named_exports.iter() } } /// ComponentDefinition is a representation of a compiled component from .slint markup. /// /// It can be constructed from a .slint file using the [`Compiler::build_from_path`] or [`Compiler::build_from_source`] functions. /// And then it can be instantiated with the [`Self::create`] function. /// /// The ComponentDefinition acts as a factory to create new instances. When you've finished /// creating the instances it is safe to drop the ComponentDefinition. #[derive(Clone)] pub struct ComponentDefinition { pub(crate) inner: crate::dynamic_item_tree::ErasedItemTreeDescription, } impl ComponentDefinition { /// Creates a new instance of the component and returns a shared handle to it. pub fn create(&self) -> Result { generativity::make_guard!(guard); let instance = self.inner.unerase(guard).clone().create(Default::default())?; // Make sure the window adapter is created so call to `window()` do not panic later. instance.window_adapter_ref()?; Ok(ComponentInstance { inner: instance }) } /// Creates a new instance of the component and returns a shared handle to it. #[doc(hidden)] #[cfg(feature = "internal")] pub fn create_embedded(&self, ctx: FactoryContext) -> Result { generativity::make_guard!(guard); Ok(ComponentInstance { inner: self.inner.unerase(guard).clone().create(WindowOptions::Embed { parent_item_tree: ctx.parent_item_tree, parent_item_tree_index: ctx.parent_item_tree_index, })?, }) } /// Instantiate the component using an existing window. #[doc(hidden)] #[cfg(feature = "internal")] pub fn create_with_existing_window( &self, window: &Window, ) -> Result { generativity::make_guard!(guard); Ok(ComponentInstance { inner: self.inner.unerase(guard).clone().create(WindowOptions::UseExistingWindow( WindowInner::from_pub(window).window_adapter(), ))?, }) } /// List of publicly declared properties or callback. /// /// This is internal because it exposes the `Type` from compilerlib. #[doc(hidden)] #[cfg(feature = "internal")] pub fn properties_and_callbacks( &self, ) -> impl Iterator< Item = ( String, (i_slint_compiler::langtype::Type, i_slint_compiler::object_tree::PropertyVisibility), ), > + '_ { // We create here a 'static guard, because unfortunately the returned type would be restricted to the guard lifetime // which is not required, but this is safe because there is only one instance of the unerased type let guard = unsafe { generativity::Guard::new(generativity::Id::new()) }; self.inner.unerase(guard).properties().map(|(s, t, v)| (s.to_string(), (t, v))) } /// Returns an iterator over all publicly declared properties. Each iterator item is a tuple of property name /// and property type for each of them. pub fn properties(&self) -> impl Iterator + '_ { // We create here a 'static guard, because unfortunately the returned type would be restricted to the guard lifetime // which is not required, but this is safe because there is only one instance of the unerased type let guard = unsafe { generativity::Guard::new(generativity::Id::new()) }; self.inner.unerase(guard).properties().filter_map(|(prop_name, prop_type, _)| { if prop_type.is_property_type() { Some((prop_name.to_string(), prop_type.into())) } else { None } }) } /// Returns the names of all publicly declared callbacks. pub fn callbacks(&self) -> impl Iterator + '_ { // We create here a 'static guard, because unfortunately the returned type would be restricted to the guard lifetime // which is not required, but this is safe because there is only one instance of the unerased type let guard = unsafe { generativity::Guard::new(generativity::Id::new()) }; self.inner.unerase(guard).properties().filter_map(|(prop_name, prop_type, _)| { if matches!(prop_type, LangType::Callback { .. }) { Some(prop_name.to_string()) } else { None } }) } /// Returns the names of all publicly declared functions. pub fn functions(&self) -> impl Iterator + '_ { // We create here a 'static guard, because unfortunately the returned type would be restricted to the guard lifetime // which is not required, but this is safe because there is only one instance of the unerased type let guard = unsafe { generativity::Guard::new(generativity::Id::new()) }; self.inner.unerase(guard).properties().filter_map(|(prop_name, prop_type, _)| { if matches!(prop_type, LangType::Function { .. }) { Some(prop_name.to_string()) } else { None } }) } /// Returns the names of all exported global singletons /// /// **Note:** Only globals that are exported or re-exported from the main .slint file will /// be exposed in the API pub fn globals(&self) -> impl Iterator + '_ { // We create here a 'static guard, because unfortunately the returned type would be restricted to the guard lifetime // which is not required, but this is safe because there is only one instance of the unerased type let guard = unsafe { generativity::Guard::new(generativity::Id::new()) }; self.inner.unerase(guard).global_names().map(|s| s.to_string()) } /// List of publicly declared properties or callback in the exported global singleton specified by its name. /// /// This is internal because it exposes the `Type` from compilerlib. #[doc(hidden)] #[cfg(feature = "internal")] pub fn global_properties_and_callbacks( &self, global_name: &str, ) -> Option< impl Iterator< Item = ( String, ( i_slint_compiler::langtype::Type, i_slint_compiler::object_tree::PropertyVisibility, ), ), > + '_, > { // We create here a 'static guard, because unfortunately the returned type would be restricted to the guard lifetime // which is not required, but this is safe because there is only one instance of the unerased type let guard = unsafe { generativity::Guard::new(generativity::Id::new()) }; self.inner .unerase(guard) .global_properties(global_name) .map(|o| o.map(|(s, t, v)| (s.to_string(), (t, v)))) } /// List of publicly declared properties in the exported global singleton specified by its name. pub fn global_properties( &self, global_name: &str, ) -> Option + '_> { // We create here a 'static guard, because unfortunately the returned type would be restricted to the guard lifetime // which is not required, but this is safe because there is only one instance of the unerased type let guard = unsafe { generativity::Guard::new(generativity::Id::new()) }; self.inner.unerase(guard).global_properties(global_name).map(|iter| { iter.filter_map(|(prop_name, prop_type, _)| { if prop_type.is_property_type() { Some((prop_name.to_string(), prop_type.into())) } else { None } }) }) } /// List of publicly declared callbacks in the exported global singleton specified by its name. pub fn global_callbacks(&self, global_name: &str) -> Option + '_> { // We create here a 'static guard, because unfortunately the returned type would be restricted to the guard lifetime // which is not required, but this is safe because there is only one instance of the unerased type let guard = unsafe { generativity::Guard::new(generativity::Id::new()) }; self.inner.unerase(guard).global_properties(global_name).map(|iter| { iter.filter_map(|(prop_name, prop_type, _)| { if matches!(prop_type, LangType::Callback { .. }) { Some(prop_name.to_string()) } else { None } }) }) } /// List of publicly declared functions in the exported global singleton specified by its name. pub fn global_functions(&self, global_name: &str) -> Option + '_> { // We create here a 'static guard, because unfortunately the returned type would be restricted to the guard lifetime // which is not required, but this is safe because there is only one instance of the unerased type let guard = unsafe { generativity::Guard::new(generativity::Id::new()) }; self.inner.unerase(guard).global_properties(global_name).map(|iter| { iter.filter_map(|(prop_name, prop_type, _)| { if matches!(prop_type, LangType::Function { .. }) { Some(prop_name.to_string()) } else { None } }) }) } /// The name of this Component as written in the .slint file pub fn name(&self) -> &str { // We create here a 'static guard, because unfortunately the returned type would be restricted to the guard lifetime // which is not required, but this is safe because there is only one instance of the unerased type let guard = unsafe { generativity::Guard::new(generativity::Id::new()) }; self.inner.unerase(guard).id() } /// This gives access to the tree of Elements. #[cfg(feature = "internal")] #[doc(hidden)] pub fn root_component(&self) -> Rc { let guard = unsafe { generativity::Guard::new(generativity::Id::new()) }; self.inner.unerase(guard).original.clone() } /// Return the `TypeLoader` used when parsing the code in the interpreter. /// /// WARNING: this is not part of the public API #[cfg(feature = "internal-highlight")] pub fn type_loader(&self) -> std::rc::Rc { let guard = unsafe { generativity::Guard::new(generativity::Id::new()) }; self.inner.unerase(guard).type_loader.get().unwrap().clone() } /// Return the `TypeLoader` used when parsing the code in the interpreter in /// a state before most passes were applied by the compiler. /// /// Each returned type loader is a deep copy of the entire state connected to it, /// so this is a fairly expensive function! /// /// WARNING: this is not part of the public API #[cfg(feature = "internal-highlight")] pub fn raw_type_loader(&self) -> Option { let guard = unsafe { generativity::Guard::new(generativity::Id::new()) }; self.inner .unerase(guard) .raw_type_loader .get() .unwrap() .as_ref() .and_then(|tl| i_slint_compiler::typeloader::snapshot(tl)) } } /// Print the diagnostics to stderr /// /// The diagnostics are printed in the same style as rustc errors /// /// This function is available when the `display-diagnostics` is enabled. #[cfg(feature = "display-diagnostics")] pub fn print_diagnostics(diagnostics: &[Diagnostic]) { let mut build_diagnostics = i_slint_compiler::diagnostics::BuildDiagnostics::default(); for d in diagnostics { build_diagnostics.push_compiler_error(d.clone()) } build_diagnostics.print(); } /// This represents an instance of a dynamic component /// /// You can create an instance with the [`ComponentDefinition::create`] function. /// /// Properties and callback can be accessed using the associated functions. /// /// An instance can be put on screen with the [`ComponentInstance::run`] function. #[repr(C)] pub struct ComponentInstance { inner: crate::dynamic_item_tree::DynamicComponentVRc, } impl ComponentInstance { /// Return the [`ComponentDefinition`] that was used to create this instance. pub fn definition(&self) -> ComponentDefinition { generativity::make_guard!(guard); ComponentDefinition { inner: self.inner.unerase(guard).description().into() } } /// Return the value for a public property of this component. /// /// ## Examples /// /// ``` /// # i_slint_backend_testing::init_no_event_loop(); /// use slint_interpreter::{ComponentDefinition, Compiler, Value, SharedString}; /// let code = r#" /// export component MyWin inherits Window { /// in-out property my_property: 42; /// } /// "#; /// let mut compiler = Compiler::default(); /// let result = spin_on::spin_on( /// compiler.build_from_source(code.into(), Default::default())); /// assert_eq!(result.diagnostics().count(), 0, "{:?}", result.diagnostics().collect::>()); /// let instance = result.component("MyWin").unwrap().create().unwrap(); /// assert_eq!(instance.get_property("my_property").unwrap(), Value::from(42)); /// ``` pub fn get_property(&self, name: &str) -> Result { generativity::make_guard!(guard); let comp = self.inner.unerase(guard); let name = normalize_identifier(name); if comp .description() .original .root_element .borrow() .property_declarations .get(name.as_ref()) .is_none_or(|d| !d.expose_in_public_api) { return Err(GetPropertyError::NoSuchProperty); } comp.description() .get_property(comp.borrow(), &name) .map_err(|()| GetPropertyError::NoSuchProperty) } /// Set the value for a public property of this component. pub fn set_property(&self, name: &str, value: Value) -> Result<(), SetPropertyError> { let name = normalize_identifier(name); generativity::make_guard!(guard); let comp = self.inner.unerase(guard); let d = comp.description(); let elem = d.original.root_element.borrow(); let decl = elem .property_declarations .get(name.as_ref()) .ok_or(SetPropertyError::NoSuchProperty)?; if !decl.expose_in_public_api { return Err(SetPropertyError::NoSuchProperty); } else if decl.visibility == i_slint_compiler::object_tree::PropertyVisibility::Output { return Err(SetPropertyError::AccessDenied); } d.set_property(comp.borrow(), &name, value) } /// Set a handler for the callback with the given name. A callback with that /// name must be defined in the document otherwise an error will be returned. /// /// Note: Since the [`ComponentInstance`] holds the handler, the handler itself should not /// contain a strong reference to the instance. So if you need to capture the instance, /// you should use [`Self::as_weak`] to create a weak reference. /// /// ## Examples /// /// ``` /// # i_slint_backend_testing::init_no_event_loop(); /// use slint_interpreter::{Compiler, Value, SharedString, ComponentHandle}; /// use core::convert::TryInto; /// let code = r#" /// export component MyWin inherits Window { /// callback foo(int) -> int; /// in-out property my_prop: 12; /// } /// "#; /// let result = spin_on::spin_on( /// Compiler::default().build_from_source(code.into(), Default::default())); /// assert_eq!(result.diagnostics().count(), 0, "{:?}", result.diagnostics().collect::>()); /// let instance = result.component("MyWin").unwrap().create().unwrap(); /// let instance_weak = instance.as_weak(); /// instance.set_callback("foo", move |args: &[Value]| -> Value { /// let arg: u32 = args[0].clone().try_into().unwrap(); /// let my_prop = instance_weak.unwrap().get_property("my_prop").unwrap(); /// let my_prop : u32 = my_prop.try_into().unwrap(); /// Value::from(arg + my_prop) /// }).unwrap(); /// /// let res = instance.invoke("foo", &[Value::from(500)]).unwrap(); /// assert_eq!(res, Value::from(500+12)); /// ``` pub fn set_callback( &self, name: &str, callback: impl Fn(&[Value]) -> Value + 'static, ) -> Result<(), SetCallbackError> { generativity::make_guard!(guard); let comp = self.inner.unerase(guard); comp.description() .set_callback_handler(comp.borrow(), &normalize_identifier(name), Box::new(callback)) .map_err(|()| SetCallbackError::NoSuchCallback) } /// Call the given callback or function with the arguments /// /// ## Examples /// See the documentation of [`Self::set_callback`] for an example pub fn invoke(&self, name: &str, args: &[Value]) -> Result { generativity::make_guard!(guard); let comp = self.inner.unerase(guard); comp.description() .invoke(comp.borrow(), &normalize_identifier_smolstr(name), args) .map_err(|()| InvokeError::NoSuchCallable) } /// Return the value for a property within an exported global singleton used by this component. /// /// The `global` parameter is the exported name of the global singleton. The `property` argument /// is the name of the property /// /// ## Examples /// /// ``` /// # i_slint_backend_testing::init_no_event_loop(); /// use slint_interpreter::{Compiler, Value, SharedString}; /// let code = r#" /// global Glob { /// in-out property my_property: 42; /// } /// export { Glob as TheGlobal } /// export component MyWin inherits Window { /// } /// "#; /// let mut compiler = Compiler::default(); /// let result = spin_on::spin_on(compiler.build_from_source(code.into(), Default::default())); /// assert_eq!(result.diagnostics().count(), 0, "{:?}", result.diagnostics().collect::>()); /// let instance = result.component("MyWin").unwrap().create().unwrap(); /// assert_eq!(instance.get_global_property("TheGlobal", "my_property").unwrap(), Value::from(42)); /// ``` pub fn get_global_property( &self, global: &str, property: &str, ) -> Result { generativity::make_guard!(guard); let comp = self.inner.unerase(guard); comp.description() .get_global(comp.borrow(), &normalize_identifier(global)) .map_err(|()| GetPropertyError::NoSuchProperty)? // FIXME: should there be a NoSuchGlobal error? .as_ref() .get_property(&normalize_identifier(property)) .map_err(|()| GetPropertyError::NoSuchProperty) } /// Set the value for a property within an exported global singleton used by this component. pub fn set_global_property( &self, global: &str, property: &str, value: Value, ) -> Result<(), SetPropertyError> { generativity::make_guard!(guard); let comp = self.inner.unerase(guard); comp.description() .get_global(comp.borrow(), &normalize_identifier(global)) .map_err(|()| SetPropertyError::NoSuchProperty)? // FIXME: should there be a NoSuchGlobal error? .as_ref() .set_property(&normalize_identifier(property), value) } /// Set a handler for the callback in the exported global singleton. A callback with that /// name must be defined in the specified global and the global must be exported from the /// main document otherwise an error will be returned. /// /// ## Examples /// /// ``` /// # i_slint_backend_testing::init_no_event_loop(); /// use slint_interpreter::{Compiler, Value, SharedString}; /// use core::convert::TryInto; /// let code = r#" /// export global Logic { /// pure callback to_uppercase(string) -> string; /// } /// export component MyWin inherits Window { /// out property hello: Logic.to_uppercase("world"); /// } /// "#; /// let result = spin_on::spin_on( /// Compiler::default().build_from_source(code.into(), Default::default())); /// let instance = result.component("MyWin").unwrap().create().unwrap(); /// instance.set_global_callback("Logic", "to_uppercase", |args: &[Value]| -> Value { /// let arg: SharedString = args[0].clone().try_into().unwrap(); /// Value::from(SharedString::from(arg.to_uppercase())) /// }).unwrap(); /// /// let res = instance.get_property("hello").unwrap(); /// assert_eq!(res, Value::from(SharedString::from("WORLD"))); /// /// let abc = instance.invoke_global("Logic", "to_uppercase", &[ /// SharedString::from("abc").into() /// ]).unwrap(); /// assert_eq!(abc, Value::from(SharedString::from("ABC"))); /// ``` pub fn set_global_callback( &self, global: &str, name: &str, callback: impl Fn(&[Value]) -> Value + 'static, ) -> Result<(), SetCallbackError> { generativity::make_guard!(guard); let comp = self.inner.unerase(guard); comp.description() .get_global(comp.borrow(), &normalize_identifier(global)) .map_err(|()| SetCallbackError::NoSuchCallback)? // FIXME: should there be a NoSuchGlobal error? .as_ref() .set_callback_handler(&normalize_identifier(name), Box::new(callback)) .map_err(|()| SetCallbackError::NoSuchCallback) } /// Call the given callback or function within a global singleton with the arguments /// /// ## Examples /// See the documentation of [`Self::set_global_callback`] for an example pub fn invoke_global( &self, global: &str, callable_name: &str, args: &[Value], ) -> Result { generativity::make_guard!(guard); let comp = self.inner.unerase(guard); let g = comp .description() .get_global(comp.borrow(), &normalize_identifier(global)) .map_err(|()| InvokeError::NoSuchCallable)?; // FIXME: should there be a NoSuchGlobal error? let callable_name = normalize_identifier_smolstr(callable_name); if matches!( comp.description() .original .root_element .borrow() .lookup_property(&callable_name) .property_type, LangType::Function { .. } ) { g.as_ref() .eval_function(&callable_name, args.to_vec()) .map_err(|()| InvokeError::NoSuchCallable) } else { g.as_ref() .invoke_callback(&callable_name, args) .map_err(|()| InvokeError::NoSuchCallable) } } /// Find all positions of the components which are pointed by a given source location. /// /// WARNING: this is not part of the public API #[cfg(feature = "internal-highlight")] pub fn component_positions( &self, path: &Path, offset: u32, ) -> Vec { crate::highlight::component_positions(&self.inner, path, offset) } /// Find the position of the `element`. /// /// WARNING: this is not part of the public API #[cfg(feature = "internal-highlight")] pub fn element_positions( &self, element: &i_slint_compiler::object_tree::ElementRc, ) -> Vec { crate::highlight::element_positions( &self.inner, element, crate::highlight::ElementPositionFilter::IncludeClipped, ) } /// Find the `element` that was defined at the text position. /// /// WARNING: this is not part of the public API #[cfg(feature = "internal-highlight")] pub fn element_node_at_source_code_position( &self, path: &Path, offset: u32, ) -> Vec<(i_slint_compiler::object_tree::ElementRc, usize)> { crate::highlight::element_node_at_source_code_position(&self.inner, path, offset) } } impl ComponentHandle for ComponentInstance { type Inner = crate::dynamic_item_tree::ErasedItemTreeBox; fn as_weak(&self) -> Weak where Self: Sized, { Weak::new(&self.inner) } fn clone_strong(&self) -> Self { Self { inner: self.inner.clone() } } fn from_inner( inner: vtable::VRc, ) -> Self { Self { inner } } fn show(&self) -> Result<(), PlatformError> { self.inner.window_adapter_ref()?.window().show() } fn hide(&self) -> Result<(), PlatformError> { self.inner.window_adapter_ref()?.window().hide() } fn run(&self) -> Result<(), PlatformError> { self.show()?; run_event_loop()?; self.hide() } fn window(&self) -> &Window { self.inner.window_adapter_ref().unwrap().window() } fn global<'a, T: Global<'a, Self>>(&'a self) -> T where Self: Sized, { unreachable!() } } impl From for vtable::VRc { fn from(value: ComponentInstance) -> Self { value.inner } } /// Error returned by [`ComponentInstance::get_property`] #[derive(Debug, Clone, Copy, PartialEq, Eq, derive_more::Error, derive_more::Display)] #[non_exhaustive] pub enum GetPropertyError { /// There is no property with the given name #[display("no such property")] NoSuchProperty, } /// Error returned by [`ComponentInstance::set_property`] #[derive(Debug, Clone, Copy, PartialEq, Eq, derive_more::Error, derive_more::Display)] #[non_exhaustive] pub enum SetPropertyError { /// There is no property with the given name. #[display("no such property")] NoSuchProperty, /// The property exists but does not have a type matching the dynamic value. /// /// This happens for example when assigning a source struct value to a target /// struct property, where the source doesn't have all the fields the target struct /// requires. #[display("wrong type")] WrongType, /// Attempt to set an output property. #[display("access denied")] AccessDenied, } /// Error returned by [`ComponentInstance::set_callback`] #[derive(Debug, Clone, Copy, PartialEq, Eq, derive_more::Error, derive_more::Display)] #[non_exhaustive] pub enum SetCallbackError { /// There is no callback with the given name #[display("no such callback")] NoSuchCallback, } /// Error returned by [`ComponentInstance::invoke`] #[derive(Debug, Clone, Copy, PartialEq, Eq, derive_more::Error, derive_more::Display)] #[non_exhaustive] pub enum InvokeError { /// There is no callback or function with the given name #[display("no such callback or function")] NoSuchCallable, } /// Enters the main event loop. This is necessary in order to receive /// events from the windowing system in order to render to the screen /// and react to user input. pub fn run_event_loop() -> Result<(), PlatformError> { i_slint_backend_selector::with_platform(|b| b.run_event_loop()) } /// Spawns a [`Future`] to execute in the Slint event loop. /// /// See the documentation of `slint::spawn_local()` for more info pub fn spawn_local(fut: F) -> Result, EventLoopError> { i_slint_backend_selector::with_global_context(|ctx| ctx.spawn_local(fut)) .map_err(|_| EventLoopError::NoEventLoopProvider)? } /// This module contains a few functions used by the tests #[doc(hidden)] pub mod testing { use super::ComponentHandle; use i_slint_core::window::WindowInner; /// Wrapper around [`i_slint_core::tests::slint_send_mouse_click`] pub fn send_mouse_click(comp: &super::ComponentInstance, x: f32, y: f32) { i_slint_core::tests::slint_send_mouse_click( x, y, &WindowInner::from_pub(comp.window()).window_adapter(), ); } /// Wrapper around [`i_slint_core::tests::slint_send_keyboard_char`] pub fn send_keyboard_char( comp: &super::ComponentInstance, string: i_slint_core::SharedString, pressed: bool, ) { i_slint_core::tests::slint_send_keyboard_char( &string, pressed, &WindowInner::from_pub(comp.window()).window_adapter(), ); } /// Wrapper around [`i_slint_core::tests::send_keyboard_string_sequence`] pub fn send_keyboard_string_sequence( comp: &super::ComponentInstance, string: i_slint_core::SharedString, ) { i_slint_core::tests::send_keyboard_string_sequence( &string, &WindowInner::from_pub(comp.window()).window_adapter(), ); } } #[test] fn component_definition_properties() { i_slint_backend_testing::init_no_event_loop(); let mut compiler = Compiler::default(); compiler.set_style("fluent".into()); let comp_def = spin_on::spin_on( compiler.build_from_source( r#" export component Dummy { in-out property test; in-out property underscores-and-dashes_preserved: 44; callback hello; }"# .into(), "".into(), ), ) .component("Dummy") .unwrap(); let props = comp_def.properties().collect::>(); assert_eq!(props.len(), 2); assert_eq!(props[0].0, "test"); assert_eq!(props[0].1, ValueType::String); assert_eq!(props[1].0, "underscores-and-dashes_preserved"); assert_eq!(props[1].1, ValueType::Number); let instance = comp_def.create().unwrap(); assert_eq!(instance.get_property("underscores_and-dashes-preserved"), Ok(Value::Number(44.))); assert_eq!( instance.get_property("underscoresanddashespreserved"), Err(GetPropertyError::NoSuchProperty) ); assert_eq!( instance.set_property("underscores-and_dashes-preserved", Value::Number(88.)), Ok(()) ); assert_eq!( instance.set_property("underscoresanddashespreserved", Value::Number(99.)), Err(SetPropertyError::NoSuchProperty) ); assert_eq!( instance.set_property("underscores-and_dashes-preserved", Value::String("99".into())), Err(SetPropertyError::WrongType) ); assert_eq!(instance.get_property("underscores-and-dashes-preserved"), Ok(Value::Number(88.))); } #[test] fn component_definition_properties2() { i_slint_backend_testing::init_no_event_loop(); let mut compiler = Compiler::default(); compiler.set_style("fluent".into()); let comp_def = spin_on::spin_on( compiler.build_from_source( r#" export component Dummy { in-out property sub-text <=> sub.text; sub := Text { property private-not-exported; } out property xreadonly: "the value"; private property xx: sub.text; callback hello; }"# .into(), "".into(), ), ) .component("Dummy") .unwrap(); let props = comp_def.properties().collect::>(); assert_eq!(props.len(), 2); assert_eq!(props[0].0, "sub-text"); assert_eq!(props[0].1, ValueType::String); assert_eq!(props[1].0, "xreadonly"); let callbacks = comp_def.callbacks().collect::>(); assert_eq!(callbacks.len(), 1); assert_eq!(callbacks[0], "hello"); let instance = comp_def.create().unwrap(); assert_eq!( instance.set_property("xreadonly", SharedString::from("XXX").into()), Err(SetPropertyError::AccessDenied) ); assert_eq!(instance.get_property("xreadonly"), Ok(Value::String("the value".into()))); assert_eq!( instance.set_property("xx", SharedString::from("XXX").into()), Err(SetPropertyError::NoSuchProperty) ); assert_eq!( instance.set_property("background", Value::default()), Err(SetPropertyError::NoSuchProperty) ); assert_eq!(instance.get_property("background"), Err(GetPropertyError::NoSuchProperty)); assert_eq!(instance.get_property("xx"), Err(GetPropertyError::NoSuchProperty)); } #[test] fn globals() { i_slint_backend_testing::init_no_event_loop(); let mut compiler = Compiler::default(); compiler.set_style("fluent".into()); let definition = spin_on::spin_on( compiler.build_from_source( r#" export global My-Super_Global { in-out property the-property : 21; callback my-callback(); } export { My-Super_Global as AliasedGlobal } export component Dummy { callback alias <=> My-Super_Global.my-callback; }"# .into(), "".into(), ), ) .component("Dummy") .unwrap(); assert_eq!(definition.globals().collect::>(), vec!["My-Super_Global", "AliasedGlobal"]); assert!(definition.global_properties("not-there").is_none()); { let expected_properties = vec![("the-property".to_string(), ValueType::Number)]; let expected_callbacks = vec!["my-callback".to_string()]; let assert_properties_and_callbacks = |global_name| { assert_eq!( definition .global_properties(global_name) .map(|props| props.collect::>()) .as_ref(), Some(&expected_properties) ); assert_eq!( definition .global_callbacks(global_name) .map(|props| props.collect::>()) .as_ref(), Some(&expected_callbacks) ); }; assert_properties_and_callbacks("My-Super-Global"); assert_properties_and_callbacks("My_Super-Global"); assert_properties_and_callbacks("AliasedGlobal"); } let instance = definition.create().unwrap(); assert_eq!( instance.set_global_property("My_Super-Global", "the_property", Value::Number(44.)), Ok(()) ); assert_eq!( instance.set_global_property("AliasedGlobal", "the_property", Value::Number(44.)), Ok(()) ); assert_eq!( instance.set_global_property("DontExist", "the-property", Value::Number(88.)), Err(SetPropertyError::NoSuchProperty) ); assert_eq!( instance.set_global_property("My_Super-Global", "theproperty", Value::Number(88.)), Err(SetPropertyError::NoSuchProperty) ); assert_eq!( instance.set_global_property("AliasedGlobal", "theproperty", Value::Number(88.)), Err(SetPropertyError::NoSuchProperty) ); assert_eq!( instance.set_global_property("My_Super-Global", "the_property", Value::String("88".into())), Err(SetPropertyError::WrongType) ); assert_eq!( instance.get_global_property("My-Super_Global", "yoyo"), Err(GetPropertyError::NoSuchProperty) ); assert_eq!( instance.get_global_property("My-Super_Global", "the-property"), Ok(Value::Number(44.)) ); assert_eq!( instance.set_property("the-property", Value::Void), Err(SetPropertyError::NoSuchProperty) ); assert_eq!(instance.get_property("the-property"), Err(GetPropertyError::NoSuchProperty)); assert_eq!( instance.set_global_callback("DontExist", "the-property", |_| panic!()), Err(SetCallbackError::NoSuchCallback) ); assert_eq!( instance.set_global_callback("My_Super_Global", "the-property", |_| panic!()), Err(SetCallbackError::NoSuchCallback) ); assert_eq!( instance.set_global_callback("My_Super_Global", "yoyo", |_| panic!()), Err(SetCallbackError::NoSuchCallback) ); assert_eq!( instance.invoke_global("DontExist", "the-property", &[]), Err(InvokeError::NoSuchCallable) ); assert_eq!( instance.invoke_global("My_Super_Global", "the-property", &[]), Err(InvokeError::NoSuchCallable) ); assert_eq!( instance.invoke_global("My_Super_Global", "yoyo", &[]), Err(InvokeError::NoSuchCallable) ); // Alias to global don't crash (#8238) assert_eq!(instance.get_property("alias"), Err(GetPropertyError::NoSuchProperty)); } #[test] fn call_functions() { i_slint_backend_testing::init_no_event_loop(); let mut compiler = Compiler::default(); compiler.set_style("fluent".into()); let definition = spin_on::spin_on( compiler.build_from_source( r#" export global Gl { out property q; public function foo-bar(a-a: string, b-b:int) -> string { q = a-a; return a-a + b-b; } } export component Test { out property p; public function foo-bar(a: int, b:int) -> int { p = a; return a + b; } }"# .into(), "".into(), ), ) .component("Test") .unwrap(); assert_eq!(definition.functions().collect::>(), ["foo-bar"]); assert_eq!(definition.global_functions("Gl").unwrap().collect::>(), ["foo-bar"]); let instance = definition.create().unwrap(); assert_eq!( instance.invoke("foo_bar", &[Value::Number(3.), Value::Number(4.)]), Ok(Value::Number(7.)) ); assert_eq!(instance.invoke("p", &[]), Err(InvokeError::NoSuchCallable)); assert_eq!(instance.get_property("p"), Ok(Value::Number(3.))); assert_eq!( instance.invoke_global( "Gl", "foo_bar", &[Value::String("Hello".into()), Value::Number(10.)] ), Ok(Value::String("Hello10".into())) ); assert_eq!(instance.get_global_property("Gl", "q"), Ok(Value::String("Hello".into()))); } #[test] fn component_definition_struct_properties() { i_slint_backend_testing::init_no_event_loop(); let mut compiler = Compiler::default(); compiler.set_style("fluent".into()); let comp_def = spin_on::spin_on( compiler.build_from_source( r#" export struct Settings { string_value: string, } export component Dummy { in-out property test; }"# .into(), "".into(), ), ) .component("Dummy") .unwrap(); let props = comp_def.properties().collect::>(); assert_eq!(props.len(), 1); assert_eq!(props[0].0, "test"); assert_eq!(props[0].1, ValueType::Struct); let instance = comp_def.create().unwrap(); let valid_struct: Struct = [("string_value".to_string(), Value::String("hello".into()))].iter().cloned().collect(); assert_eq!(instance.set_property("test", Value::Struct(valid_struct.clone())), Ok(())); assert_eq!(instance.get_property("test").unwrap().value_type(), ValueType::Struct); assert_eq!(instance.set_property("test", Value::Number(42.)), Err(SetPropertyError::WrongType)); let mut invalid_struct = valid_struct.clone(); invalid_struct.set_field("other".into(), Value::Number(44.)); assert_eq!( instance.set_property("test", Value::Struct(invalid_struct)), Err(SetPropertyError::WrongType) ); let mut invalid_struct = valid_struct; invalid_struct.set_field("string_value".into(), Value::Number(44.)); assert_eq!( instance.set_property("test", Value::Struct(invalid_struct)), Err(SetPropertyError::WrongType) ); } #[test] fn component_definition_model_properties() { use i_slint_core::model::*; i_slint_backend_testing::init_no_event_loop(); let mut compiler = Compiler::default(); compiler.set_style("fluent".into()); let comp_def = spin_on::spin_on(compiler.build_from_source( "export component Dummy { in-out property <[int]> prop: [42, 12]; }".into(), "".into(), )) .component("Dummy") .unwrap(); let props = comp_def.properties().collect::>(); assert_eq!(props.len(), 1); assert_eq!(props[0].0, "prop"); assert_eq!(props[0].1, ValueType::Model); let instance = comp_def.create().unwrap(); let int_model = Value::Model([Value::Number(14.), Value::Number(15.), Value::Number(16.)].into()); let empty_model = Value::Model(ModelRc::new(VecModel::::default())); let model_with_string = Value::Model(VecModel::from_slice(&[ Value::Number(1000.), Value::String("foo".into()), Value::Number(1111.), ])); #[track_caller] fn check_model(val: Value, r: &[f64]) { if let Value::Model(m) = val { assert_eq!(r.len(), m.row_count()); for (i, v) in r.iter().enumerate() { assert_eq!(m.row_data(i).unwrap(), Value::Number(*v)); } } else { panic!("{val:?} not a model"); } } assert_eq!(instance.get_property("prop").unwrap().value_type(), ValueType::Model); check_model(instance.get_property("prop").unwrap(), &[42., 12.]); instance.set_property("prop", int_model).unwrap(); check_model(instance.get_property("prop").unwrap(), &[14., 15., 16.]); assert_eq!(instance.set_property("prop", Value::Number(42.)), Err(SetPropertyError::WrongType)); check_model(instance.get_property("prop").unwrap(), &[14., 15., 16.]); assert_eq!(instance.set_property("prop", model_with_string), Err(SetPropertyError::WrongType)); check_model(instance.get_property("prop").unwrap(), &[14., 15., 16.]); assert_eq!(instance.set_property("prop", empty_model), Ok(())); check_model(instance.get_property("prop").unwrap(), &[]); } #[test] fn lang_type_to_value_type() { use i_slint_compiler::langtype::Struct as LangStruct; use std::collections::BTreeMap; assert_eq!(ValueType::from(LangType::Void), ValueType::Void); assert_eq!(ValueType::from(LangType::Float32), ValueType::Number); assert_eq!(ValueType::from(LangType::Int32), ValueType::Number); assert_eq!(ValueType::from(LangType::Duration), ValueType::Number); assert_eq!(ValueType::from(LangType::Angle), ValueType::Number); assert_eq!(ValueType::from(LangType::PhysicalLength), ValueType::Number); assert_eq!(ValueType::from(LangType::LogicalLength), ValueType::Number); assert_eq!(ValueType::from(LangType::Percent), ValueType::Number); assert_eq!(ValueType::from(LangType::UnitProduct(vec![])), ValueType::Number); assert_eq!(ValueType::from(LangType::String), ValueType::String); assert_eq!(ValueType::from(LangType::Color), ValueType::Brush); assert_eq!(ValueType::from(LangType::Brush), ValueType::Brush); assert_eq!(ValueType::from(LangType::Array(Rc::new(LangType::Void))), ValueType::Model); assert_eq!(ValueType::from(LangType::Bool), ValueType::Bool); assert_eq!( ValueType::from(LangType::Struct(Rc::new(LangStruct { fields: BTreeMap::default(), name: None, node: None, rust_attributes: None }))), ValueType::Struct ); assert_eq!(ValueType::from(LangType::Image), ValueType::Image); } #[test] fn test_multi_components() { let result = spin_on::spin_on( Compiler::default().build_from_source( r#" export struct Settings { string_value: string, } export global ExpGlo { in-out property test: 42; } component Common { in-out property settings: { string_value: "Hello", }; } export component Xyz inherits Window { in-out property aaa: 8; } export component Foo { in-out property test: 42; c := Common {} } export component Bar inherits Window { in-out property blah: 78; c := Common {} } "# .into(), PathBuf::from("hello.slint"), ), ); assert!(!result.has_errors(), "Error {:?}", result.diagnostics().collect::>()); let mut components = result.component_names().collect::>(); components.sort(); assert_eq!(components, vec!["Bar", "Xyz"]); let diag = result.diagnostics().collect::>(); assert_eq!(diag.len(), 1); assert_eq!(diag[0].level(), DiagnosticLevel::Warning); assert_eq!( diag[0].message(), "Exported component 'Foo' doesn't inherit Window. No code will be generated for it" ); let comp1 = result.component("Xyz").unwrap(); assert_eq!(comp1.name(), "Xyz"); let instance1a = comp1.create().unwrap(); let comp2 = result.component("Bar").unwrap(); let instance2 = comp2.create().unwrap(); let instance1b = comp1.create().unwrap(); // globals are not shared between instances assert_eq!(instance1a.get_global_property("ExpGlo", "test"), Ok(Value::Number(42.0))); assert_eq!(instance1a.set_global_property("ExpGlo", "test", Value::Number(88.0)), Ok(())); assert_eq!(instance2.get_global_property("ExpGlo", "test"), Ok(Value::Number(42.0))); assert_eq!(instance1b.get_global_property("ExpGlo", "test"), Ok(Value::Number(42.0))); assert_eq!(instance1a.get_global_property("ExpGlo", "test"), Ok(Value::Number(88.0))); assert!(result.component("Settings").is_none()); assert!(result.component("Foo").is_none()); assert!(result.component("Common").is_none()); assert!(result.component("ExpGlo").is_none()); assert!(result.component("xyz").is_none()); } #[cfg(all(test, feature = "internal-highlight"))] fn compile(code: &str) -> (ComponentInstance, PathBuf) { i_slint_backend_testing::init_no_event_loop(); let mut compiler = Compiler::default(); compiler.set_style("fluent".into()); let path = PathBuf::from("/tmp/test.slint"); let compile_result = spin_on::spin_on(compiler.build_from_source(code.to_string(), path.clone())); for d in &compile_result.diagnostics { eprintln!("{d}"); } assert!(!compile_result.has_errors()); let definition = compile_result.components().next().unwrap(); let instance = definition.create().unwrap(); (instance, path) } #[cfg(feature = "internal-highlight")] #[test] fn test_element_node_at_source_code_position() { let code = r#" component Bar1 {} component Foo1 { } export component Foo2 inherits Window { Bar1 {} Foo1 {} }"#; let (handle, path) = compile(code); for i in 0..code.len() as u32 { let elements = handle.element_node_at_source_code_position(&path, i); eprintln!("{i}: {}", code.as_bytes()[i as usize] as char); match i { 16 => assert_eq!(elements.len(), 1), // Bar1 (def) 35 => assert_eq!(elements.len(), 1), // Foo1 (def) 71..=78 => assert_eq!(elements.len(), 1), // Window + WS (from Foo2) 85..=89 => assert_eq!(elements.len(), 1), // Bar1 + WS (use) 97..=103 => assert_eq!(elements.len(), 1), // Foo1 + WS (use) _ => assert!(elements.is_empty()), } } } #[cfg(feature = "ffi")] #[allow(missing_docs)] #[path = "ffi.rs"] pub(crate) mod ffi;