mirror of
https://github.com/slint-ui/slint.git
synced 2025-11-04 13:39:03 +00:00
590 lines
19 KiB
C++
590 lines
19 KiB
C++
// Copyright © SixtyFPS GmbH <info@sixtyfps.io>
|
|
// SPDX-License-Identifier: (GPL-3.0-only OR LicenseRef-SixtyFPS-commercial)
|
|
|
|
#define CATCH_CONFIG_MAIN
|
|
#include "catch2/catch.hpp"
|
|
|
|
#include <slint.h>
|
|
#include <slint_interpreter.h>
|
|
|
|
SCENARIO("Value API")
|
|
{
|
|
using namespace slint::interpreter;
|
|
Value value;
|
|
|
|
REQUIRE(value.type() == Value::Type::Void);
|
|
|
|
SECTION("Construct a string")
|
|
{
|
|
REQUIRE(!value.to_string().has_value());
|
|
slint::SharedString cpp_str("Hello World");
|
|
value = Value(cpp_str);
|
|
REQUIRE(value.type() == Value::Type::String);
|
|
|
|
auto string_opt = value.to_string();
|
|
REQUIRE(string_opt.has_value());
|
|
REQUIRE(string_opt.value() == "Hello World");
|
|
}
|
|
|
|
SECTION("Construct a number")
|
|
{
|
|
REQUIRE(!value.to_number().has_value());
|
|
const double number = 42.0;
|
|
value = Value(number);
|
|
REQUIRE(value.type() == Value::Type::Number);
|
|
|
|
auto number_opt = value.to_number();
|
|
REQUIRE(number_opt.has_value());
|
|
REQUIRE(number_opt.value() == number);
|
|
}
|
|
|
|
SECTION("Construct a bool")
|
|
{
|
|
REQUIRE(!value.to_bool().has_value());
|
|
value = Value(true);
|
|
REQUIRE(value.type() == Value::Type::Bool);
|
|
|
|
auto bool_opt = value.to_bool();
|
|
REQUIRE(bool_opt.has_value());
|
|
REQUIRE(bool_opt.value() == true);
|
|
}
|
|
|
|
SECTION("Construct an array")
|
|
{
|
|
REQUIRE(!value.to_array().has_value());
|
|
slint::SharedVector<Value> array { Value(42.0), Value(true) };
|
|
value = Value(array);
|
|
REQUIRE(value.type() == Value::Type::Model);
|
|
|
|
auto array_opt = value.to_array();
|
|
REQUIRE(array_opt.has_value());
|
|
|
|
auto extracted_array = array_opt.value();
|
|
REQUIRE(extracted_array.size() == 2);
|
|
REQUIRE(extracted_array[0].to_number().value() == 42);
|
|
REQUIRE(extracted_array[1].to_bool().value());
|
|
}
|
|
|
|
SECTION("Construct a brush")
|
|
{
|
|
REQUIRE(!value.to_brush().has_value());
|
|
slint::Brush brush(slint::Color::from_rgb_uint8(255, 0, 255));
|
|
value = Value(brush);
|
|
REQUIRE(value.type() == Value::Type::Brush);
|
|
|
|
auto brush_opt = value.to_brush();
|
|
REQUIRE(brush_opt.has_value());
|
|
REQUIRE(brush_opt.value() == brush);
|
|
}
|
|
|
|
SECTION("Construct a struct")
|
|
{
|
|
REQUIRE(!value.to_struct().has_value());
|
|
slint::interpreter::Struct struc;
|
|
value = Value(struc);
|
|
REQUIRE(value.type() == Value::Type::Struct);
|
|
|
|
auto struct_opt = value.to_struct();
|
|
REQUIRE(struct_opt.has_value());
|
|
}
|
|
|
|
SECTION("Construct an image")
|
|
{
|
|
// ensure a backend exists, using private api
|
|
slint::private_api::WindowRc wnd;
|
|
|
|
REQUIRE(!value.to_image().has_value());
|
|
slint::Image image = slint::Image::load_from_path(
|
|
SOURCE_DIR "/../../vscode_extension/extension-logo.png");
|
|
REQUIRE(image.size().width == 128);
|
|
value = Value(image);
|
|
REQUIRE(value.type() == Value::Type::Image);
|
|
|
|
auto image2 = value.to_image();
|
|
REQUIRE(image2.has_value());
|
|
REQUIRE(image2->size().width == 128);
|
|
REQUIRE(image == *image2);
|
|
}
|
|
|
|
SECTION("Construct a model")
|
|
{
|
|
// And test that it is properly destroyed when the value is destroyed
|
|
struct M : slint::VectorModel<Value>
|
|
{
|
|
bool *destroyed;
|
|
explicit M(bool *destroyed) : destroyed(destroyed) { }
|
|
void play()
|
|
{
|
|
this->push_back(Value(4.));
|
|
this->set_row_data(0, Value(9.));
|
|
}
|
|
~M() { *destroyed = true; }
|
|
};
|
|
bool destroyed = false;
|
|
auto m = std::make_shared<M>(&destroyed);
|
|
{
|
|
Value value(m);
|
|
REQUIRE(value.type() == Value::Type::Model);
|
|
REQUIRE(!destroyed);
|
|
m->play();
|
|
m = nullptr;
|
|
REQUIRE(!destroyed);
|
|
// play a bit with the value to test the copy and move
|
|
Value v2 = value;
|
|
Value v3 = std::move(v2);
|
|
REQUIRE(!destroyed);
|
|
}
|
|
REQUIRE(destroyed);
|
|
}
|
|
|
|
SECTION("Compare Values")
|
|
{
|
|
Value str1 { slint::SharedString("Hello1") };
|
|
Value str2 { slint::SharedString("Hello2") };
|
|
Value fl1 { 10. };
|
|
Value fl2 { 12. };
|
|
|
|
REQUIRE(str1 == str1);
|
|
REQUIRE(str1 != str2);
|
|
REQUIRE(str1 != fl2);
|
|
REQUIRE(fl1 == fl1);
|
|
REQUIRE(fl1 != fl2);
|
|
REQUIRE(Value() == Value());
|
|
REQUIRE(Value() != str1);
|
|
REQUIRE(str1 == slint::SharedString("Hello1"));
|
|
REQUIRE(str1 != slint::SharedString("Hello2"));
|
|
REQUIRE(slint::SharedString("Hello2") == str2);
|
|
REQUIRE(fl1 != slint::SharedString("Hello2"));
|
|
REQUIRE(fl2 == 12.);
|
|
}
|
|
}
|
|
|
|
SCENARIO("Struct API")
|
|
{
|
|
using namespace slint::interpreter;
|
|
Struct struc;
|
|
|
|
REQUIRE(!struc.get_field("not_there"));
|
|
|
|
struc.set_field("field_a", Value(slint::SharedString("Hallo")));
|
|
|
|
auto value_opt = struc.get_field("field_a");
|
|
REQUIRE(value_opt.has_value());
|
|
auto value = value_opt.value();
|
|
REQUIRE(value.to_string().has_value());
|
|
REQUIRE(value.to_string().value() == "Hallo");
|
|
|
|
int count = 0;
|
|
for (auto [k, value] : struc) {
|
|
REQUIRE(count == 0);
|
|
count++;
|
|
REQUIRE(k == "field-a");
|
|
REQUIRE(value.to_string().value() == "Hallo");
|
|
}
|
|
|
|
struc.set_field("field_b", Value(slint::SharedString("World")));
|
|
std::map<std::string, slint::SharedString> map;
|
|
for (auto [k, value] : struc)
|
|
map[std::string(k)] = *value.to_string();
|
|
|
|
REQUIRE(map
|
|
== std::map<std::string, slint::SharedString> {
|
|
{ "field-a", slint::SharedString("Hallo") },
|
|
{ "field-b", slint::SharedString("World") } });
|
|
}
|
|
|
|
SCENARIO("Struct Iterator Constructor")
|
|
{
|
|
using namespace slint::interpreter;
|
|
|
|
std::vector<std::pair<std::string_view, Value>> values = { { "field_a", Value(true) },
|
|
{ "field_b", Value(42.0) } };
|
|
|
|
Struct struc(values.begin(), values.end());
|
|
|
|
REQUIRE(!struc.get_field("foo").has_value());
|
|
REQUIRE(struc.get_field("field_a").has_value());
|
|
REQUIRE(struc.get_field("field_a").value().to_bool().value());
|
|
REQUIRE(struc.get_field("field_b").value().to_number().value() == 42.0);
|
|
}
|
|
|
|
SCENARIO("Struct Initializer List Constructor")
|
|
{
|
|
using namespace slint::interpreter;
|
|
|
|
Struct struc({ { "field_a", Value(true) }, { "field_b", Value(42.0) } });
|
|
|
|
REQUIRE(!struc.get_field("foo").has_value());
|
|
REQUIRE(struc.get_field("field_a").has_value());
|
|
REQUIRE(struc.get_field("field_a").value().to_bool().value());
|
|
REQUIRE(struc.get_field("field_b").value().to_number().value() == 42.0);
|
|
}
|
|
|
|
SCENARIO("Struct empty field iteration")
|
|
{
|
|
using namespace slint::interpreter;
|
|
Struct struc;
|
|
REQUIRE(struc.begin() == struc.end());
|
|
}
|
|
|
|
SCENARIO("Struct field iteration")
|
|
{
|
|
using namespace slint::interpreter;
|
|
|
|
Struct struc({ { "field_a", Value(true) }, { "field_b", Value(42.0) } });
|
|
|
|
auto it = struc.begin();
|
|
auto end = struc.end();
|
|
REQUIRE(it != end);
|
|
|
|
auto check_valid_entry = [](const auto &key, const auto &value) -> bool {
|
|
if (key == "field-a")
|
|
return value == Value(true);
|
|
if (key == "field-b")
|
|
return value == Value(42.0);
|
|
return false;
|
|
};
|
|
|
|
std::set<std::string> seen_fields;
|
|
|
|
for (; it != end; ++it) {
|
|
const auto [key, value] = *it;
|
|
REQUIRE(check_valid_entry(key, value));
|
|
auto value_inserted = seen_fields.insert(std::string(key)).second;
|
|
REQUIRE(value_inserted);
|
|
}
|
|
}
|
|
|
|
SCENARIO("Component Compiler")
|
|
{
|
|
using namespace slint::interpreter;
|
|
using namespace slint;
|
|
|
|
ComponentCompiler compiler;
|
|
|
|
SECTION("configure include paths")
|
|
{
|
|
SharedVector<SharedString> in_paths;
|
|
in_paths.push_back("path1");
|
|
in_paths.push_back("path2");
|
|
compiler.set_include_paths(in_paths);
|
|
|
|
auto out_paths = compiler.include_paths();
|
|
REQUIRE(out_paths.size() == 2);
|
|
REQUIRE(out_paths[0] == "path1");
|
|
REQUIRE(out_paths[1] == "path2");
|
|
}
|
|
|
|
SECTION("configure style")
|
|
{
|
|
REQUIRE(compiler.style() == "");
|
|
compiler.set_style("ugly");
|
|
REQUIRE(compiler.style() == "ugly");
|
|
}
|
|
|
|
SECTION("Compile failure from source")
|
|
{
|
|
auto result = compiler.build_from_source("Syntax Error!!", "");
|
|
REQUIRE_FALSE(result.has_value());
|
|
}
|
|
|
|
SECTION("Compile from source")
|
|
{
|
|
auto result = compiler.build_from_source("export Dummy := Rectangle {}", "");
|
|
REQUIRE(result.has_value());
|
|
}
|
|
|
|
SECTION("Compile failure from path")
|
|
{
|
|
auto result = compiler.build_from_path(SOURCE_DIR "/file-not-there.slint");
|
|
REQUIRE_FALSE(result.has_value());
|
|
auto diags = compiler.diagnostics();
|
|
|
|
REQUIRE(diags.size() == 1);
|
|
REQUIRE(diags[0].message.starts_with("Could not load"));
|
|
}
|
|
|
|
SECTION("Compile from path")
|
|
{
|
|
auto result = compiler.build_from_path(SOURCE_DIR "/tests/test.slint");
|
|
REQUIRE(result.has_value());
|
|
}
|
|
}
|
|
|
|
SCENARIO("Component Definition Properties")
|
|
{
|
|
using namespace slint::interpreter;
|
|
using namespace slint;
|
|
|
|
ComponentCompiler compiler;
|
|
auto comp_def = *compiler.build_from_source(
|
|
"export Dummy := Rectangle { property <string> test; callback dummy; }", "");
|
|
auto properties = comp_def.properties();
|
|
REQUIRE(properties.size() == 1);
|
|
REQUIRE(properties[0].property_name == "test");
|
|
REQUIRE(properties[0].property_type == Value::Type::String);
|
|
|
|
auto callback_names = comp_def.callbacks();
|
|
REQUIRE(callback_names.size() == 1);
|
|
REQUIRE(callback_names[0] == "dummy");
|
|
}
|
|
|
|
SCENARIO("Component Definition Properties / Two-way bindings")
|
|
{
|
|
using namespace slint::interpreter;
|
|
using namespace slint;
|
|
|
|
ComponentCompiler compiler;
|
|
auto comp_def = *compiler.build_from_source(
|
|
"export Dummy := Rectangle { property <string> test <=> sub_object.test; "
|
|
" sub_object := Rectangle { property <string> test; }"
|
|
"}",
|
|
"");
|
|
auto properties = comp_def.properties();
|
|
REQUIRE(properties.size() == 1);
|
|
REQUIRE(properties[0].property_name == "test");
|
|
REQUIRE(properties[0].property_type == Value::Type::String);
|
|
}
|
|
|
|
SCENARIO("Invoke callback")
|
|
{
|
|
using namespace slint::interpreter;
|
|
using namespace slint;
|
|
|
|
ComponentCompiler compiler;
|
|
|
|
SECTION("valid")
|
|
{
|
|
auto result = compiler.build_from_source(
|
|
"export Dummy := Rectangle { callback some_callback(string, int) -> string; }", "");
|
|
REQUIRE(result.has_value());
|
|
auto instance = result->create();
|
|
std::string local_string = "_string_on_the_stack_";
|
|
REQUIRE(instance->set_callback("some_callback", [local_string](auto args) {
|
|
SharedString arg1 = *args[0].to_string();
|
|
int arg2 = int(*args[1].to_number());
|
|
std::string res = std::string(arg1) + ":" + std::to_string(arg2) + local_string;
|
|
return Value(SharedString(res));
|
|
}));
|
|
Value args[] = { SharedString("Hello"), 42. };
|
|
auto res = instance->invoke_callback("some_callback", args);
|
|
REQUIRE(res.has_value());
|
|
REQUIRE(*res->to_string() == SharedString("Hello:42_string_on_the_stack_"));
|
|
}
|
|
|
|
SECTION("invalid")
|
|
{
|
|
auto result = compiler.build_from_source(
|
|
"export Dummy := Rectangle { callback foo(string, int) -> string; }", "");
|
|
REQUIRE(result.has_value());
|
|
auto instance = result->create();
|
|
REQUIRE(!instance->set_callback("bar", [](auto) { return Value(); }));
|
|
Value args[] = { SharedString("Hello"), 42. };
|
|
auto res = instance->invoke_callback("bar", args);
|
|
REQUIRE(!res.has_value());
|
|
}
|
|
}
|
|
|
|
SCENARIO("Array between .slint and C++")
|
|
{
|
|
using namespace slint::interpreter;
|
|
using namespace slint;
|
|
|
|
ComponentCompiler compiler;
|
|
|
|
auto result = compiler.build_from_source(
|
|
"export Dummy := Rectangle { property <[int]> array: [1, 2, 3]; }", "");
|
|
REQUIRE(result.has_value());
|
|
auto instance = result->create();
|
|
|
|
SECTION(".slint to C++")
|
|
{
|
|
auto maybe_array = instance->get_property("array");
|
|
REQUIRE(maybe_array.has_value());
|
|
REQUIRE(maybe_array->type() == Value::Type::Model);
|
|
|
|
auto array = *maybe_array;
|
|
REQUIRE(array.to_array() == slint::SharedVector<Value> { Value(1.), Value(2.), Value(3.) });
|
|
}
|
|
|
|
SECTION("C++ to .slint")
|
|
{
|
|
slint::SharedVector<Value> cpp_array { Value(4.), Value(5.), Value(6.) };
|
|
|
|
instance->set_property("array", Value(cpp_array));
|
|
auto maybe_array = instance->get_property("array");
|
|
REQUIRE(maybe_array.has_value());
|
|
REQUIRE(maybe_array->type() == Value::Type::Model);
|
|
|
|
auto actual_array = *maybe_array;
|
|
REQUIRE(actual_array.to_array() == cpp_array);
|
|
}
|
|
}
|
|
|
|
SCENARIO("Angle between .slint and C++")
|
|
{
|
|
using namespace slint::interpreter;
|
|
using namespace slint;
|
|
|
|
ComponentCompiler compiler;
|
|
|
|
auto result =
|
|
compiler.build_from_source("export Dummy := Rectangle { property <angle> the_angle: "
|
|
"0.25turn; property <bool> test: the_angle == 0.5turn; }",
|
|
"");
|
|
REQUIRE(result.has_value());
|
|
auto instance = result->create();
|
|
|
|
SECTION("Read property")
|
|
{
|
|
auto angle_value = instance->get_property("the-angle");
|
|
REQUIRE(angle_value.has_value());
|
|
REQUIRE(angle_value->type() == Value::Type::Number);
|
|
auto angle = angle_value->to_number();
|
|
REQUIRE(angle.has_value());
|
|
REQUIRE(*angle == 90);
|
|
}
|
|
SECTION("Write property")
|
|
{
|
|
REQUIRE(!*instance->get_property("test")->to_bool());
|
|
bool ok = instance->set_property("the_angle", 180.);
|
|
REQUIRE(ok);
|
|
REQUIRE(*instance->get_property("the_angle")->to_number() == 180);
|
|
REQUIRE(*instance->get_property("test")->to_bool());
|
|
}
|
|
}
|
|
|
|
SCENARIO("Component Definition Name")
|
|
{
|
|
using namespace slint::interpreter;
|
|
using namespace slint;
|
|
|
|
ComponentCompiler compiler;
|
|
auto comp_def = *compiler.build_from_source("export IHaveAName := Rectangle { }", "");
|
|
REQUIRE(comp_def.name() == "IHaveAName");
|
|
}
|
|
|
|
SCENARIO("Send key events")
|
|
{
|
|
using namespace slint::interpreter;
|
|
using namespace slint;
|
|
|
|
ComponentCompiler compiler;
|
|
auto comp_def = compiler.build_from_source(R"(
|
|
export Dummy := Rectangle {
|
|
forward-focus: scope;
|
|
property <string> result;
|
|
scope := FocusScope {
|
|
key-pressed(event) => {
|
|
result += event.text;
|
|
return accept;
|
|
}
|
|
}
|
|
}
|
|
)",
|
|
"");
|
|
REQUIRE(comp_def.has_value());
|
|
auto instance = comp_def->create();
|
|
slint::testing::send_keyboard_string_sequence(&*instance, "Hello keys!", {});
|
|
REQUIRE(*instance->get_property("result")->to_string() == "Hello keys!");
|
|
}
|
|
|
|
SCENARIO("Global properties")
|
|
{
|
|
using namespace slint::interpreter;
|
|
using namespace slint;
|
|
|
|
ComponentCompiler compiler;
|
|
|
|
auto result = compiler.build_from_source(
|
|
R"(
|
|
export global The-Global := {
|
|
property <string> the-property: "€€€";
|
|
callback to_uppercase(string)->string;
|
|
}
|
|
export Dummy := Rectangle {
|
|
property <string> result: The-Global.to_uppercase("abc");
|
|
}
|
|
)",
|
|
"");
|
|
for (auto &&x : compiler.diagnostics())
|
|
std::cerr << x.message << std::endl;
|
|
REQUIRE(result.has_value());
|
|
auto component_definition = *result;
|
|
|
|
SECTION("Globals introspection")
|
|
{
|
|
auto globals = component_definition.globals();
|
|
REQUIRE(globals.size() == 1);
|
|
REQUIRE(globals[0] == "The-Global");
|
|
|
|
REQUIRE(!component_definition.global_properties("not there").has_value());
|
|
|
|
REQUIRE(component_definition.global_properties("The_Global").has_value());
|
|
REQUIRE(component_definition.global_properties("The-Global").has_value());
|
|
|
|
auto properties = *component_definition.global_properties("The-Global");
|
|
REQUIRE(properties.size() == 1);
|
|
REQUIRE(properties[0].property_name == "the-property");
|
|
REQUIRE(properties[0].property_type == Value::Type::String);
|
|
|
|
auto callbacks = *component_definition.global_callbacks("The-Global");
|
|
REQUIRE(callbacks.size() == 1);
|
|
REQUIRE(callbacks[0] == "to_uppercase");
|
|
}
|
|
|
|
auto instance = component_definition.create();
|
|
|
|
SECTION("Invalid read")
|
|
{
|
|
REQUIRE(!instance->get_global_property("the - global", "the-property").has_value());
|
|
REQUIRE(!instance->get_global_property("The-Global", "the property").has_value());
|
|
}
|
|
SECTION("Invalid set")
|
|
{
|
|
REQUIRE(!instance->set_global_property("the - global", "the-property", 5.));
|
|
REQUIRE(!instance->set_global_property("The-Global", "the property", 5.));
|
|
REQUIRE(!instance->set_global_property("The-Global", "the-property", 5.));
|
|
}
|
|
SECTION("get property")
|
|
{
|
|
auto value = instance->get_global_property("The_Global", "the-property");
|
|
REQUIRE(value.has_value());
|
|
REQUIRE(value->to_string().has_value());
|
|
REQUIRE(value->to_string().value() == "€€€");
|
|
}
|
|
SECTION("set property")
|
|
{
|
|
REQUIRE(instance->set_global_property("The-Global", "the-property", SharedString("§§§")));
|
|
auto value = instance->get_global_property("The-Global", "the_property");
|
|
REQUIRE(value.has_value());
|
|
REQUIRE(value->to_string().has_value());
|
|
REQUIRE(value->to_string().value() == "§§§");
|
|
}
|
|
SECTION("set/invoke callback")
|
|
{
|
|
REQUIRE(instance->set_global_callback("The-Global", "to_uppercase", [](auto args) {
|
|
std::string arg1(*args[0].to_string());
|
|
std::transform(arg1.begin(), arg1.end(), arg1.begin(), toupper);
|
|
return SharedString(arg1);
|
|
}));
|
|
auto result = instance->get_property("result");
|
|
REQUIRE(result.has_value());
|
|
REQUIRE(result->to_string().has_value());
|
|
REQUIRE(result->to_string().value() == "ABC");
|
|
|
|
Value args[] = { SharedString("Hello") };
|
|
auto res = instance->invoke_global_callback("The_Global", "to-uppercase", args);
|
|
REQUIRE(res.has_value());
|
|
REQUIRE(*res->to_string() == SharedString("HELLO"));
|
|
}
|
|
SECTION("callback errors")
|
|
{
|
|
REQUIRE(!instance->set_global_callback("TheGlobal", "to_uppercase",
|
|
[](auto) { return Value {}; }));
|
|
REQUIRE(!instance->set_global_callback("The-Global", "touppercase",
|
|
[](auto) { return Value {}; }));
|
|
REQUIRE(!instance->invoke_global_callback("TheGlobal", "touppercase", {}));
|
|
REQUIRE(!instance->invoke_global_callback("The-Global", "touppercase", {}));
|
|
}
|
|
}
|