i_slint_compiler/
lib.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#![doc = include_str!("README.md")]
5#![doc(html_logo_url = "https://slint.dev/logo/slint-logo-square-light.svg")]
6// It would be nice to keep the compiler free of unsafe code
7#![deny(unsafe_code)]
8
9#[cfg(feature = "proc_macro_span")]
10extern crate proc_macro;
11
12use core::future::Future;
13use core::pin::Pin;
14use std::cell::RefCell;
15use std::collections::HashMap;
16use std::rc::Rc;
17#[cfg(feature = "software-renderer")]
18use std::sync::Arc;
19
20pub mod builtin_macros;
21pub mod diagnostics;
22pub mod embedded_resources;
23pub mod expression_tree;
24pub mod fileaccess;
25pub mod generator;
26pub mod langtype;
27pub mod layout;
28pub mod lexer;
29pub mod literals;
30pub mod llr;
31pub(crate) mod load_builtins;
32pub mod lookup;
33pub mod namedreference;
34pub mod object_tree;
35pub mod parser;
36pub mod pathutils;
37#[cfg(feature = "bundle-translations")]
38pub mod translations;
39pub mod typeloader;
40pub mod typeregister;
41
42pub mod passes;
43
44use crate::generator::OutputFormat;
45use std::path::Path;
46
47/// Specify how the resources are embedded by the compiler
48#[derive(Clone, Copy, Debug, Eq, PartialEq)]
49pub enum EmbedResourcesKind {
50    /// Embeds nothing (only useful for interpreter)
51    Nothing,
52    /// Only embed builtin resources
53    OnlyBuiltinResources,
54    /// Do not embed resources, but list them in the Document as it they were embedded
55    ListAllResources,
56    /// Embed all images resources (the content of their files)
57    EmbedAllResources,
58    #[cfg(feature = "software-renderer")]
59    /// Embed raw texture (process images and fonts)
60    EmbedTextures,
61}
62
63#[derive(Clone, Debug, Eq, PartialEq, Default)]
64#[non_exhaustive]
65pub enum ComponentSelection {
66    /// All components that inherit from Window.
67    ///
68    /// Note: Components marked for export but lacking Window inheritance are not selected (this will produce a warning),
69    /// For compatibility reason, the last exported component is still selected even if it doesn't inherit Window,
70    /// and if no component is exported, the last component is selected
71    #[default]
72    ExportedWindows,
73
74    /// The Last component (legacy for the viewer / interpreter)
75    ///
76    /// Only the last exported component is generated, regardless if this is a Window or not,
77    /// (and it will be transformed in a Window)
78    LastExported,
79
80    /// The component with the given name is generated
81    Named(String),
82}
83
84#[cfg(feature = "software-renderer")]
85pub type FontCache = Rc<
86    RefCell<
87        std::collections::HashMap<
88            i_slint_common::sharedfontdb::fontdb::ID,
89            fontdue::FontResult<(Arc<fontdue::Font>, Arc<dyn AsRef<[u8]> + Send + Sync>, u32)>,
90        >,
91    >,
92>;
93
94/// CompilationConfiguration allows configuring different aspects of the compiler.
95#[derive(Clone)]
96pub struct CompilerConfiguration {
97    /// Indicate whether to embed resources such as images in the generated output or whether
98    /// to retain references to the resources on the file system.
99    pub embed_resources: EmbedResourcesKind,
100    /// Whether to use SDF when pre-rendering fonts.
101    #[cfg(all(feature = "software-renderer", feature = "sdf-fonts"))]
102    pub use_sdf_fonts: bool,
103    /// The compiler will look in these paths for components used in the file to compile.
104    pub include_paths: Vec<std::path::PathBuf>,
105    /// The compiler will look in these paths for library imports.
106    pub library_paths: HashMap<String, std::path::PathBuf>,
107    /// the name of the style. (eg: "native")
108    pub style: Option<String>,
109
110    /// Callback to load import files which is called if the file could not be found
111    ///
112    /// The callback should open the file specified by the given file name and
113    /// return an future that provides the text content of the file as output.
114    pub open_import_fallback: Option<
115        Rc<dyn Fn(String) -> Pin<Box<dyn Future<Output = Option<std::io::Result<String>>>>>>,
116    >,
117    /// Callback to map URLs for resources
118    ///
119    /// The function takes the url and returns the mapped URL (or None if not mapped)
120    pub resource_url_mapper:
121        Option<Rc<dyn Fn(&str) -> Pin<Box<dyn Future<Output = Option<String>>>>>>,
122
123    /// Run the pass that inlines all the elements.
124    ///
125    /// This may help optimization to optimize the runtime resources usages,
126    /// but at the cost of much more generated code and binary size.
127    pub inline_all_elements: bool,
128
129    /// Compile time scale factor to apply to embedded resources such as images and glyphs.
130    /// If != 1.0 then the scale factor will be set on the `slint::Window`.
131    pub const_scale_factor: f64,
132
133    /// expose the accessible role and properties
134    pub accessibility: bool,
135
136    /// Add support for experimental features
137    pub enable_experimental: bool,
138
139    /// The domain used as one of the parameter to the translate function
140    pub translation_domain: Option<String>,
141    /// When Some, this is the path where the translations are looked at to bundle the translations
142    #[cfg(feature = "bundle-translations")]
143    pub translation_path_bundle: Option<std::path::PathBuf>,
144
145    /// Do not generate the hook to create native menus
146    pub no_native_menu: bool,
147
148    /// C++ namespace
149    pub cpp_namespace: Option<String>,
150
151    /// When true, fail the build when a binding loop is detected with a window layout property
152    /// (otherwise this is a compatibility warning)
153    pub error_on_binding_loop_with_window_layout: bool,
154
155    /// Generate debug information for elements (ids, type names)
156    pub debug_info: bool,
157
158    /// Generate debug hooks to inspect/override properties.
159    pub debug_hooks: Option<std::hash::RandomState>,
160
161    pub components_to_generate: ComponentSelection,
162
163    #[cfg(feature = "software-renderer")]
164    pub font_cache: FontCache,
165}
166
167impl CompilerConfiguration {
168    pub fn new(output_format: OutputFormat) -> Self {
169        let embed_resources = if std::env::var_os("SLINT_EMBED_TEXTURES").is_some()
170            || std::env::var_os("DEP_MCU_BOARD_SUPPORT_MCU_EMBED_TEXTURES").is_some()
171        {
172            #[cfg(not(feature = "software-renderer"))]
173            panic!("the software-renderer feature must be enabled in i-slint-compiler when embedding textures");
174            #[cfg(feature = "software-renderer")]
175            EmbedResourcesKind::EmbedTextures
176        } else if let Ok(var) = std::env::var("SLINT_EMBED_RESOURCES") {
177            let var = var.parse::<bool>().unwrap_or_else(|_|{
178                panic!("SLINT_EMBED_RESOURCES has incorrect value. Must be either unset, 'true' or 'false'")
179            });
180            match var {
181                true => EmbedResourcesKind::EmbedAllResources,
182                false => EmbedResourcesKind::OnlyBuiltinResources,
183            }
184        } else {
185            match output_format {
186                #[cfg(feature = "rust")]
187                OutputFormat::Rust => EmbedResourcesKind::EmbedAllResources,
188                OutputFormat::Interpreter => EmbedResourcesKind::Nothing,
189                _ => EmbedResourcesKind::OnlyBuiltinResources,
190            }
191        };
192
193        let inline_all_elements = match std::env::var("SLINT_INLINING") {
194            Ok(var) => var.parse::<bool>().unwrap_or_else(|_| {
195                panic!(
196                    "SLINT_INLINING has incorrect value. Must be either unset, 'true' or 'false'"
197                )
198            }),
199            // Currently, the interpreter needs the inlining to be on.
200            Err(_) => output_format == OutputFormat::Interpreter,
201        };
202
203        let const_scale_factor = std::env::var("SLINT_SCALE_FACTOR")
204            .ok()
205            .and_then(|x| x.parse::<f64>().ok())
206            .filter(|f| *f > 0.)
207            .unwrap_or(1.);
208
209        let enable_experimental = std::env::var_os("SLINT_ENABLE_EXPERIMENTAL_FEATURES").is_some();
210
211        let debug_info = std::env::var_os("SLINT_EMIT_DEBUG_INFO").is_some();
212
213        let cpp_namespace = match output_format {
214            #[cfg(feature = "cpp")]
215            OutputFormat::Cpp(config) => match config.namespace {
216                Some(namespace) => Some(namespace),
217                None => match std::env::var("SLINT_CPP_NAMESPACE") {
218                    Ok(namespace) => Some(namespace),
219                    Err(_) => None,
220                },
221            },
222            _ => None,
223        };
224
225        Self {
226            embed_resources,
227            include_paths: Default::default(),
228            library_paths: Default::default(),
229            style: Default::default(),
230            open_import_fallback: None,
231            resource_url_mapper: None,
232            inline_all_elements,
233            const_scale_factor,
234            accessibility: true,
235            enable_experimental,
236            translation_domain: None,
237            no_native_menu: false,
238            cpp_namespace,
239            error_on_binding_loop_with_window_layout: false,
240            debug_info,
241            debug_hooks: None,
242            components_to_generate: ComponentSelection::ExportedWindows,
243            #[cfg(feature = "software-renderer")]
244            font_cache: Default::default(),
245            #[cfg(all(feature = "software-renderer", feature = "sdf-fonts"))]
246            use_sdf_fonts: false,
247            #[cfg(feature = "bundle-translations")]
248            translation_path_bundle: std::env::var("SLINT_BUNDLE_TRANSLATIONS")
249                .ok()
250                .map(|x| x.into()),
251        }
252    }
253
254    #[cfg(feature = "software-renderer")]
255    fn load_font_by_id(
256        &self,
257        face_id: i_slint_common::sharedfontdb::fontdb::ID,
258    ) -> fontdue::FontResult<(Arc<fontdue::Font>, Arc<dyn AsRef<[u8]> + Send + Sync>, u32)> {
259        self.font_cache
260            .borrow_mut()
261            .entry(face_id)
262            .or_insert_with(|| {
263                i_slint_common::sharedfontdb::FONT_DB.with(|fontdb| {
264                    fontdb
265                        .borrow()
266                        .with_face_data(face_id, |font_data, face_index| {
267                            fontdue::Font::from_bytes(
268                                font_data,
269                                fontdue::FontSettings {
270                                    collection_index: face_index,
271                                    scale: 40.,
272                                    ..Default::default()
273                                },
274                            )
275                            .map(|fontdue_font| {
276                                (
277                                    Arc::new(fontdue_font),
278                                    Arc::new(font_data.to_vec())
279                                        as Arc<dyn AsRef<[u8]> + Send + Sync>,
280                                    face_index,
281                                )
282                            })
283                        })
284                        .unwrap_or_else(|| fontdue::FontResult::Err("internal error: corrupt font"))
285                })
286            })
287            .clone()
288    }
289}
290
291fn prepare_for_compile(
292    diagnostics: &mut diagnostics::BuildDiagnostics,
293    #[allow(unused_mut)] mut compiler_config: CompilerConfiguration,
294) -> typeloader::TypeLoader {
295    #[cfg(feature = "software-renderer")]
296    if compiler_config.embed_resources == EmbedResourcesKind::EmbedTextures {
297        // HACK: disable accessibility when compiling for the software renderer
298        // accessibility is not supported with backend that support software renderer anyway
299        compiler_config.accessibility = false;
300    }
301
302    diagnostics.enable_experimental = compiler_config.enable_experimental;
303
304    let global_type_registry = if compiler_config.enable_experimental {
305        crate::typeregister::TypeRegister::builtin_experimental()
306    } else {
307        crate::typeregister::TypeRegister::builtin()
308    };
309
310    typeloader::TypeLoader::new(global_type_registry, compiler_config, diagnostics)
311}
312
313pub async fn compile_syntax_node(
314    doc_node: parser::SyntaxNode,
315    mut diagnostics: diagnostics::BuildDiagnostics,
316    #[allow(unused_mut)] mut compiler_config: CompilerConfiguration,
317) -> (object_tree::Document, diagnostics::BuildDiagnostics, typeloader::TypeLoader) {
318    let mut loader = prepare_for_compile(&mut diagnostics, compiler_config);
319
320    let doc_node: parser::syntax_nodes::Document = doc_node.into();
321
322    let type_registry =
323        Rc::new(RefCell::new(typeregister::TypeRegister::new(&loader.global_type_registry)));
324    let (foreign_imports, reexports) =
325        loader.load_dependencies_recursively(&doc_node, &mut diagnostics, &type_registry).await;
326
327    let mut doc = crate::object_tree::Document::from_node(
328        doc_node,
329        foreign_imports,
330        reexports,
331        &mut diagnostics,
332        &type_registry,
333    );
334
335    if !diagnostics.has_errors() {
336        passes::run_passes(&mut doc, &mut loader, false, &mut diagnostics).await;
337    } else {
338        // Don't run all the passes in case of errors because because some invariants are not met.
339        passes::run_import_passes(&doc, &loader, &mut diagnostics);
340    }
341    (doc, diagnostics, loader)
342}
343
344/// Pass a file to the compiler and process it fully, applying all the
345/// necessary compilation passes.
346///
347/// This returns a `Tuple` containing the actual cleaned `path` to the file,
348/// a set of `BuildDiagnostics` and a `TypeLoader` with all compilation passes applied.
349pub async fn load_root_file(
350    path: &Path,
351    source_path: &Path,
352    source_code: String,
353    mut diagnostics: diagnostics::BuildDiagnostics,
354    #[allow(unused_mut)] mut compiler_config: CompilerConfiguration,
355) -> (std::path::PathBuf, diagnostics::BuildDiagnostics, typeloader::TypeLoader) {
356    let mut loader = prepare_for_compile(&mut diagnostics, compiler_config);
357
358    let (path, _) =
359        loader.load_root_file(path, source_path, source_code, false, &mut diagnostics).await;
360
361    (path, diagnostics, loader)
362}
363
364/// Pass a file to the compiler and process it fully, applying all the
365/// necessary compilation passes, just like `load_root_file`.
366///
367/// This returns a `Tuple` containing the actual cleaned `path` to the file,
368/// a set of `BuildDiagnostics`, a `TypeLoader` with all compilation passes
369/// applied and another `TypeLoader` with a minimal set of passes applied to it.
370pub async fn load_root_file_with_raw_type_loader(
371    path: &Path,
372    source_path: &Path,
373    source_code: String,
374    mut diagnostics: diagnostics::BuildDiagnostics,
375    #[allow(unused_mut)] mut compiler_config: CompilerConfiguration,
376) -> (
377    std::path::PathBuf,
378    diagnostics::BuildDiagnostics,
379    typeloader::TypeLoader,
380    Option<typeloader::TypeLoader>,
381) {
382    let mut loader = prepare_for_compile(&mut diagnostics, compiler_config);
383
384    let (path, raw_type_loader) =
385        loader.load_root_file(path, source_path, source_code, true, &mut diagnostics).await;
386
387    (path, diagnostics, loader, raw_type_loader)
388}
i_slint_compiler/lib.rs

i_slint_compiler/
lib.rs
