slint/tools/lsp/preview/preview_data.rs

// Copyright © SixtyFPS GmbH <info@slint.dev>
// SPDX-License-Identifier: GPL-3.0-only OR LicenseRef-Slint-Royalty-free-2.0 OR LicenseRef-Slint-Software-3.0

use std::fmt::Display;

use slint_interpreter::ComponentInstance;

#[derive(Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
pub enum PropertyContainer {
    Main,
    Global(String),
}

impl Display for PropertyContainer {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            PropertyContainer::Main => write!(f, "<MAIN>"),
            PropertyContainer::Global(g) => write!(f, "{g}"),
        }
    }
}

fn has_getter(visibility: &i_slint_compiler::object_tree::PropertyVisibility) -> bool {
    matches!(
        visibility,
        i_slint_compiler::object_tree::PropertyVisibility::Output
            | i_slint_compiler::object_tree::PropertyVisibility::InOut
    )
}

fn has_setter(visibility: &i_slint_compiler::object_tree::PropertyVisibility) -> bool {
    matches!(
        visibility,
        i_slint_compiler::object_tree::PropertyVisibility::Input
            | i_slint_compiler::object_tree::PropertyVisibility::InOut
    )
}

fn is_property(ty: &i_slint_compiler::langtype::Type) -> bool {
    !matches!(
        *ty,
        i_slint_compiler::langtype::Type::Function(_)
            | i_slint_compiler::langtype::Type::Callback(_)
            | i_slint_compiler::langtype::Type::InferredCallback
    )
}

#[derive(Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
pub struct PreviewDataKey {
    pub container: PropertyContainer,
    pub property_name: String,
}

#[derive(Clone, Debug, PartialEq)]
pub struct PreviewData {
    pub ty: i_slint_compiler::langtype::Type,
    pub visibility: i_slint_compiler::object_tree::PropertyVisibility,
    pub value: Option<slint_interpreter::Value>,
}

impl PreviewData {
    pub fn is_property(&self) -> bool {
        is_property(&self.ty)
    }

    pub fn has_getter(&self) -> bool {
        has_getter(&self.visibility)
    }

    pub fn has_setter(&self) -> bool {
        has_setter(&self.visibility)
    }
}

pub type PreviewDataMap = std::collections::BTreeMap<PreviewDataKey, PreviewData>;

pub fn get_preview_data(
    component_instance: &ComponentInstance,
    container: &PropertyContainer,
    property_name: &str,
) -> Option<PreviewData> {
    fn find_preview_data(
        property_name: &str,
        mut it: impl Iterator<
            Item = (
                String,
                (
                    i_slint_compiler::langtype::Type,
                    i_slint_compiler::object_tree::PropertyVisibility,
                ),
            ),
        >,
        value_query: &dyn Fn(&str) -> Option<slint_interpreter::Value>,
    ) -> Option<PreviewData> {
        it.find(|(name, (_, _))| name == property_name).map(|(name, (ty, visibility))| {
            let value = value_query(&name);

            PreviewData { ty, visibility, value }
        })
    }

    let definition = &component_instance.definition();
    match &container {
        PropertyContainer::Main => {
            find_preview_data(property_name, &mut definition.properties_and_callbacks(), &|name| {
                component_instance.get_property(name).ok()
            })
        }
        PropertyContainer::Global(g) => find_preview_data(
            property_name,
            &mut definition.global_properties_and_callbacks(g)?,
            &|name| component_instance.get_global_property(g, name).ok(),
        ),
    }
}

pub fn query_preview_data_properties_and_callbacks(
    component_instance: &ComponentInstance,
) -> PreviewDataMap {
    let definition = &component_instance.definition();

    fn collect_preview_data<'a>(
        container: PropertyContainer,
        it: &'a mut dyn Iterator<
            Item = (
                String,
                (
                    i_slint_compiler::langtype::Type,
                    i_slint_compiler::object_tree::PropertyVisibility,
                ),
            ),
        >,
        value_query: &'a dyn Fn(&str) -> Option<slint_interpreter::Value>,
    ) -> impl Iterator<Item = (PreviewDataKey, PreviewData)> + use<'a> {
        it.map(move |(name, (ty, visibility))| {
            let value = value_query(&name);

            (
                PreviewDataKey { container: container.clone(), property_name: name },
                PreviewData { ty, visibility, value },
            )
        })
    }

    let mut result = collect_preview_data(
        PropertyContainer::Main,
        &mut definition.properties_and_callbacks(),
        &|name| component_instance.get_property(name).ok(),
    )
    .collect::<PreviewDataMap>();

    for global in definition.globals() {
        result.extend(collect_preview_data(
            PropertyContainer::Global(global.clone()),
            &mut definition
                .global_properties_and_callbacks(&global)
                .expect("Global was just valid"),
            &|name| component_instance.get_global_property(&global, name).ok(),
        ));
    }

    result
}

fn find_component_properties_and_callbacks<'a>(
    definition: &'a slint_interpreter::ComponentDefinition,
    container: &PropertyContainer,
) -> Result<
    Box<
        dyn Iterator<
                Item = (
                    String,
                    (
                        i_slint_compiler::langtype::Type,
                        i_slint_compiler::object_tree::PropertyVisibility,
                    ),
                ),
            > + 'a,
    >,
    String,
> {
    match container {
        PropertyContainer::Main => Ok(Box::new(definition.properties_and_callbacks())),
        PropertyContainer::Global(g) => Ok(Box::new(
            definition
                .global_properties_and_callbacks(g)
                .ok_or(format!("Global {g} does not exist"))?,
        )),
    }
}

pub fn set_preview_data(
    component_instance: &ComponentInstance,
    container: &PropertyContainer,
    property_name: &str,
    value: slint_interpreter::Value,
) -> Result<(PreviewDataKey, slint_interpreter::Value), String> {
    let result = match &container {
        PropertyContainer::Main => component_instance.set_property(property_name, value.clone()),
        PropertyContainer::Global(g) => {
            component_instance.set_global_property(g, property_name, value.clone())
        }
    };

    if let Err(msg) = result {
        Err(format!("Could not set property {property_name}: {msg}"))
    } else {
        Ok((
            PreviewDataKey {
                container: container.clone(),
                property_name: property_name.to_string(),
            },
            value,
        ))
    }
}

pub fn set_json_preview_data(
    component_instance: &ComponentInstance,
    container: PropertyContainer,
    property_name: Option<String>,
    json: serde_json::Value,
) -> Result<PreviewDataMap, Vec<String>> {
    let mut result = PreviewDataMap::default();

    let definition = &component_instance.definition();

    let mut failed_properties = vec![];

    let it =
        find_component_properties_and_callbacks(definition, &container).map_err(|e| vec![e])?;

    let it: Box<dyn Iterator<Item = _>> = match &property_name {
        None => Box::new(it.filter(|(_, (it, iv))| is_property(it) && has_setter(iv))),
        Some(p) => {
            let p = p.clone();
            Box::new(it.filter(move |(ip, (it, iv))| &p == ip && is_property(it) && has_setter(iv)))
        }
    };

    for (name, (ty, visibility)) in it {
        let (property_name, json_value) = if let Some(pn) = &property_name {
            (pn.clone(), Some(&json))
        } else {
            let json_value = match &json {
                serde_json::Value::Object(obj) => {
                    if let Some(j) = obj.get(&name) {
                        j
                    } else {
                        failed_properties
                            .push(format!("Value for property {name} not found in JSON object"));
                        continue;
                    }
                }
                _ => {
                    failed_properties.push(
                    "JSON value must be an object when setting all properties of a Slint Element"
                        .to_string(),
                    );
                    continue;
                }
            };
            (name.clone(), Some(json_value))
        };

        let Some(json_value) = json_value else {
            // already logged an error for this!
            continue;
        };
        let Ok(value) = slint_interpreter::json::value_from_json(&ty, json_value) else {
            failed_properties
                .push(format!("Could not convert JSON value for property {property_name}"));
            continue;
        };

        match set_preview_data(component_instance, &container, &property_name, value) {
            Err(msg) => {
                failed_properties.push(msg);
            }
            Ok((key, value)) => {
                result.insert(key, PreviewData { ty, visibility, value: Some(value) });
            }
        }
    }

    if !failed_properties.is_empty() {
        return Err(failed_properties);
    }

    if result.is_empty() {
        Err(vec![format!("No property set")])
    } else {
        Ok(result)
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    use crate::{
        common::test::{main_test_file_name, test_file_name},
        preview::test::interpret_test_with_sources,
    };

    use std::collections::HashMap;

    #[test]
    fn test_query_preview_data_properties_and_callbacks() {
        let component_instance = interpret_test_with_sources(
            "fluent",
            HashMap::from([
                (
                    main_test_file_name(),
                    String::from(
                        r#"
                    import { User2 } from "user2.slint";
                    export * from "user1.slint";

                    export global MainGlobal {
                        in property <int> main-global-in: 1;
                        out property <int> main-global-out: 2;
                        in-out property <int> main-global-in-out: 4;
                    }

                    export { User2 }

                    export component MainComponent {
                        in property <int> main-component-in: MainGlobal.main-global-in + User2.user2-in;
                        out property <int> main-component-out: MainGlobal.main-global-out + User2.user2-out;
                        in-out property <int> main-component-in-out: MainGlobal.main-global-in-out + User2.user2-in-out;
                    }
                "#,
                    ),
                ),
                (
                    test_file_name("user1.slint"),
                    String::from(
                        r#"
                    export global User1 {
                        in property <int> user1-in: 8;
                        out property <int> user1-out: 16;
                        in-out property <int> user1-in-out: 32;
                    }
                "#,
                    ),
                ),
                (
                    test_file_name("user2.slint"),
                    String::from(
                        r#"
                    export global User2 {
                        in property <int> user2-in: 64;
                        out property <int> user2-out: 128;
                        in-out property <int> user2-in-out: 256;
                    }
                "#,
                    ),
                ),
            ]),
        );

        let properties = query_preview_data_properties_and_callbacks(&component_instance);

        assert_eq!(properties.len(), 12);

        let main = properties
            .iter()
            .filter(|(k, _)| k.container == PropertyContainer::Main)
            .collect::<Vec<_>>();

        assert_eq!(main.len(), 3);
        assert_eq!(
            main[0],
            (
                &PreviewDataKey {
                    container: PropertyContainer::Main,
                    property_name: "main-component-in".into(),
                },
                &PreviewData {
                    ty: i_slint_compiler::langtype::Type::Int32,
                    visibility: i_slint_compiler::object_tree::PropertyVisibility::Input,
                    value: Some(slint_interpreter::Value::Number(65.0)),
                }
            )
        );
        assert_eq!(
            main[1],
            (
                &PreviewDataKey {
                    container: PropertyContainer::Main,
                    property_name: "main-component-in-out".into(),
                },
                &PreviewData {
                    ty: i_slint_compiler::langtype::Type::Int32,
                    visibility: i_slint_compiler::object_tree::PropertyVisibility::InOut,
                    value: Some(slint_interpreter::Value::Number(260.0))
                }
            )
        );
        assert_eq!(
            main[2],
            (
                &PreviewDataKey {
                    container: PropertyContainer::Main,
                    property_name: "main-component-out".into(),
                },
                &PreviewData {
                    ty: i_slint_compiler::langtype::Type::Int32,
                    visibility: i_slint_compiler::object_tree::PropertyVisibility::Output,
                    value: Some(slint_interpreter::Value::Number(130.0))
                }
            )
        );

        let global = properties
            .iter()
            .filter(|(k, _)| k.container == PropertyContainer::Global("MainGlobal".into()))
            .collect::<Vec<_>>();

        assert_eq!(global.len(), 3);
        assert_eq!(
            global[0],
            (
                &PreviewDataKey {
                    container: PropertyContainer::Global("MainGlobal".into()),
                    property_name: "main-global-in".into(),
                },
                &PreviewData {
                    ty: i_slint_compiler::langtype::Type::Int32,
                    visibility: i_slint_compiler::object_tree::PropertyVisibility::Input,
                    value: Some(slint_interpreter::Value::Number(1.0))
                }
            )
        );
        assert_eq!(
            global[1],
            (
                &PreviewDataKey {
                    container: PropertyContainer::Global("MainGlobal".into()),
                    property_name: "main-global-in-out".into(),
                },
                &PreviewData {
                    ty: i_slint_compiler::langtype::Type::Int32,
                    visibility: i_slint_compiler::object_tree::PropertyVisibility::InOut,
                    value: Some(slint_interpreter::Value::Number(4.0))
                }
            )
        );
        assert_eq!(
            global[2],
            (
                &PreviewDataKey {
                    container: PropertyContainer::Global("MainGlobal".into()),
                    property_name: "main-global-out".into(),
                },
                &PreviewData {
                    ty: i_slint_compiler::langtype::Type::Int32,
                    visibility: i_slint_compiler::object_tree::PropertyVisibility::Output,
                    value: Some(slint_interpreter::Value::Number(2.0))
                }
            )
        );

        let user1 = properties
            .iter()
            .filter(|(k, _)| k.container == PropertyContainer::Global("User1".into()))
            .collect::<Vec<_>>();

        assert_eq!(user1.len(), 3);

        assert_eq!(
            user1[0],
            (
                &PreviewDataKey {
                    container: PropertyContainer::Global("User1".into()),
                    property_name: "user1-in".into(),
                },
                &PreviewData {
                    ty: i_slint_compiler::langtype::Type::Int32,
                    visibility: i_slint_compiler::object_tree::PropertyVisibility::Input,
                    value: Some(slint_interpreter::Value::Number(8.0))
                }
            )
        );
        assert_eq!(
            user1[1],
            (
                &PreviewDataKey {
                    container: PropertyContainer::Global("User1".into()),
                    property_name: "user1-in-out".into(),
                },
                &PreviewData {
                    ty: i_slint_compiler::langtype::Type::Int32,
                    visibility: i_slint_compiler::object_tree::PropertyVisibility::InOut,
                    value: Some(slint_interpreter::Value::Number(32.0))
                }
            )
        );
        assert_eq!(
            user1[2],
            (
                &PreviewDataKey {
                    container: PropertyContainer::Global("User1".into()),
                    property_name: "user1-out".into(),
                },
                &PreviewData {
                    ty: i_slint_compiler::langtype::Type::Int32,
                    visibility: i_slint_compiler::object_tree::PropertyVisibility::Output,
                    value: Some(slint_interpreter::Value::Number(16.0))
                }
            )
        );

        let user2 = properties
            .iter()
            .filter(|(k, _)| k.container == PropertyContainer::Global("User2".into()))
            .collect::<Vec<_>>();

        assert_eq!(user2.len(), 3);
        assert_eq!(
            user2[0],
            (
                &PreviewDataKey {
                    container: PropertyContainer::Global("User2".into()),
                    property_name: "user2-in".into(),
                },
                &PreviewData {
                    ty: i_slint_compiler::langtype::Type::Int32,
                    visibility: i_slint_compiler::object_tree::PropertyVisibility::Input,
                    value: Some(slint_interpreter::Value::Number(64.0))
                }
            )
        );
        assert_eq!(
            user2[1],
            (
                &PreviewDataKey {
                    container: PropertyContainer::Global("User2".into()),
                    property_name: "user2-in-out".into(),
                },
                &PreviewData {
                    ty: i_slint_compiler::langtype::Type::Int32,
                    visibility: i_slint_compiler::object_tree::PropertyVisibility::InOut,
                    value: Some(slint_interpreter::Value::Number(256.0))
                }
            )
        );
        assert_eq!(
            user2[2],
            (
                &PreviewDataKey {
                    container: PropertyContainer::Global("User2".into()),
                    property_name: "user2-out".into(),
                },
                &PreviewData {
                    ty: i_slint_compiler::langtype::Type::Int32,
                    visibility: i_slint_compiler::object_tree::PropertyVisibility::Output,
                    value: Some(slint_interpreter::Value::Number(128.0))
                }
            )
        );
    }
}