1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671
// Copyright © SixtyFPS GmbH <info@slint.dev>
// SPDX-License-Identifier: GPL-3.0-only OR LicenseRef-Slint-Royalty-free-1.1 OR LicenseRef-Slint-commercial
use core::convert::TryFrom;
use i_slint_compiler::langtype::Type as LangType;
use i_slint_core::component_factory::ComponentFactory;
use i_slint_core::graphics::Image;
use i_slint_core::model::{Model, ModelRc};
use i_slint_core::window::WindowInner;
use i_slint_core::{Brush, PathData, SharedVector};
use std::borrow::Cow;
use std::collections::HashMap;
use std::iter::FromIterator;
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::*;
use i_slint_core::items::*;
use crate::dynamic_component::{ErasedComponentBox, 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<LangType> 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 do 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<Value>) = 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<f32>) = 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 == 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<Value> 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<f32>] );
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<Value> 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<Value> 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()});
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<i_slint_core::items::$Name> 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<Value> for i_slint_core::items::$Name {
type Error = ();
fn try_from(v: Value) -> Result<i_slint_core::items::$Name, ()> {
use std::str::FromStr;
match v {
Value::EnumerationValue(enumeration, value) => {
if enumeration != stringify!($Name) {
return Err(());
}
<i_slint_core::items::$Name>::from_str(value.as_str())
.or_else(|_| {
let norm = value.as_str().replace('-', "_");
<i_slint_core::items::$Name>::from_str(&norm)
.or_else(|_| <i_slint_core::items::$Name>::from_str(&format!("r#{}", norm)))
})
.map_err(|_| ())
}
_ => Err(()),
}
}
}
)*};
}
i_slint_common::for_each_enums!(declare_value_enum_conversion);
impl From<i_slint_core::animations::Instant> for Value {
fn from(value: i_slint_core::animations::Instant) -> Self {
Value::Number(value.0 as _)
}
}
impl TryFrom<Value> for i_slint_core::animations::Instant {
type Error = ();
fn try_from(v: Value) -> Result<i_slint_core::animations::Instant, Self::Error> {
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<Value> for () {
type Error = ();
#[inline]
fn try_from(_: Value) -> Result<(), Self::Error> {
Ok(())
}
}
impl From<i_slint_core::Color> for Value {
#[inline]
fn from(c: i_slint_core::Color) -> Self {
Value::Brush(Brush::SolidColor(c))
}
}
impl TryFrom<Value> for i_slint_core::Color {
type Error = Value;
#[inline]
fn try_from(v: Value) -> Result<i_slint_core::Color, Self::Error> {
match v {
Value::Brush(Brush::SolidColor(c)) => Ok(c),
_ => Err(v),
}
}
}
impl From<i_slint_core::lengths::LogicalLength> for Value {
#[inline]
fn from(l: i_slint_core::lengths::LogicalLength) -> Self {
Value::Number(l.get() as _)
}
}
impl TryFrom<Value> for i_slint_core::lengths::LogicalLength {
type Error = Value;
#[inline]
fn try_from(v: Value) -> Result<i_slint_core::lengths::LogicalLength, Self::Error> {
match v {
Value::Number(n) => Ok(i_slint_core::lengths::LogicalLength::new(n as _)),
_ => Err(v),
}
}
}
/// Normalize the identifier to use dashes
pub(crate) fn normalize_identifier(ident: &str) -> Cow<'_, str> {
if ident.contains('_') {
ident.replace('_', "-").into()
} 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::<Struct>().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(HashMap<String, Value>);
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<Item = (&str, &Value)> {
self.0.iter().map(|(a, b)| (a.as_str(), b))
}
}
impl FromIterator<(String, Value)> for Struct {
fn from_iter<T: IntoIterator<Item = (String, Value)>>(iter: T) -> Self {
Self(
iter.into_iter()
.map(|(s, v)| (if s.contains('_') { s.replace('_', "-") } else { s }, v))
.collect(),
)
}
}
/// ComponentCompiler is the entry point to the Slint interpreter that can be used
/// to load .slint files or compile them on-the-fly from a string.
pub struct ComponentCompiler {
config: i_slint_compiler::CompilerConfiguration,
diagnostics: Vec<Diagnostic>,
}
impl Default for ComponentCompiler {
fn default() -> Self {
Self {
config: i_slint_compiler::CompilerConfiguration::new(
i_slint_compiler::generator::OutputFormat::Interpreter,
),
diagnostics: vec![],
}
}
}
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<std::path::PathBuf>) {
self.config.include_paths = include_paths;
}
/// Returns the include paths the component compiler is currently configured with.
pub fn include_paths(&self) -> &Vec<std::path::PathBuf> {
&self.config.include_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<
Box<dyn core::future::Future<Output = Option<std::io::Result<String>>>>,
> + '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<Diagnostic> {
&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<P: AsRef<Path>>(
&mut self,
path: P,
) -> Option<ComponentDefinition> {
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;
}
};
generativity::make_guard!(guard);
let (c, diag) =
crate::dynamic_component::load(source, path.into(), self.config.clone(), guard).await;
self.diagnostics = diag.into_iter().collect();
c.ok().map(|inner| ComponentDefinition { inner: inner.into() })
}
/// 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<ComponentDefinition> {
generativity::make_guard!(guard);
let (c, diag) =
crate::dynamic_component::load(source_code, path, self.config.clone(), guard).await;
self.diagnostics = diag.into_iter().collect();
c.ok().map(|inner| ComponentDefinition { inner: inner.into() })
}
}
/// ComponentDefinition is a representation of a compiled component from .slint markup.
///
/// It can be constructed from a .slint file using the [`ComponentCompiler::build_from_path`] or [`ComponentCompiler::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 {
inner: crate::dynamic_component::ErasedComponentDescription,
}
impl ComponentDefinition {
/// Creates a new instance of the component and returns a shared handle to it.
pub fn create(&self) -> Result<ComponentInstance, PlatformError> {
generativity::make_guard!(guard);
Ok(ComponentInstance {
inner: self.inner.unerase(guard).clone().create(Default::default())?,
})
}
/// Instantiate the component for wasm using the given canvas id
#[cfg(target_arch = "wasm32")]
pub fn create_with_canvas_id(
&self,
canvas_id: &str,
) -> Result<ComponentInstance, PlatformError> {
generativity::make_guard!(guard);
Ok(ComponentInstance {
inner: self
.inner
.unerase(guard)
.clone()
.create(WindowOptions::CreateWithCanvasId(canvas_id.into()))?,
})
}
/// Instantiate the component using an existing window.
#[doc(hidden)]
pub fn create_with_existing_window(
&self,
window: &Window,
) -> Result<ComponentInstance, PlatformError> {
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)]
pub fn properties_and_callbacks(
&self,
) -> impl Iterator<Item = (String, i_slint_compiler::langtype::Type)> + '_ {
// 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()
}
/// Returns an interator 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<Item = (String, ValueType)> + '_ {
// 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, prop_type.into()))
} else {
None
}
})
}
/// Returns the names of all publicly declared callbacks.
pub fn callbacks(&self) -> impl Iterator<Item = String> + '_ {
// 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)
} 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<Item = String> + '_ {
// 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()
}
/// 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)]
pub fn global_properties_and_callbacks(
&self,
global_name: &str,
) -> Option<impl Iterator<Item = (String, i_slint_compiler::langtype::Type)> + '_> {
// 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)
}
/// List of publicly declared properties in the exported global singleton specified by its name.
pub fn global_properties(
&self,
global_name: &str,
) -> Option<impl Iterator<Item = (String, ValueType)> + '_> {
// 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, 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<impl Iterator<Item = String> + '_> {
// 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)
} 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()
}
}
/// 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 represent 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_component::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();
/// use slint_interpreter::{ComponentDefinition, ComponentCompiler, Value, SharedString};
/// let code = r#"
/// export component MyWin inherits Window {
/// in-out property <int> my_property: 42;
/// }
/// "#;
/// let mut compiler = ComponentCompiler::default();
/// let definition = spin_on::spin_on(
/// compiler.build_from_source(code.into(), Default::default()));
/// assert!(compiler.diagnostics().is_empty(), "{:?}", compiler.diagnostics());
/// let instance = definition.unwrap().create().unwrap();
/// assert_eq!(instance.get_property("my_property").unwrap(), Value::from(42));
/// ```
pub fn get_property(&self, name: &str) -> Result<Value, GetPropertyError> {
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())
.map_or(true, |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();
/// use slint_interpreter::{ComponentDefinition, ComponentCompiler, Value, SharedString, ComponentHandle};
/// use core::convert::TryInto;
/// let code = r#"
/// component MyWin inherits Window {
/// callback foo(int) -> int;
/// in-out property <int> my_prop: 12;
/// }
/// "#;
/// let definition = spin_on::spin_on(
/// ComponentCompiler::default().build_from_source(code.into(), Default::default()));
/// let instance = definition.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<Value, InvokeError> {
generativity::make_guard!(guard);
let comp = self.inner.unerase(guard);
comp.description()
.invoke(comp.borrow(), &normalize_identifier(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();
/// use slint_interpreter::{ComponentDefinition, ComponentCompiler, Value, SharedString};
/// let code = r#"
/// global Glob {
/// in-out property <int> my_property: 42;
/// }
/// export { Glob as TheGlobal }
/// component MyWin inherits Window {
/// }
/// "#;
/// let mut compiler = ComponentCompiler::default();
/// let definition = spin_on::spin_on(
/// compiler.build_from_source(code.into(), Default::default()));
/// assert!(compiler.diagnostics().is_empty(), "{:?}", compiler.diagnostics());
/// let instance = definition.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<Value, GetPropertyError> {
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();
/// use slint_interpreter::{ComponentDefinition, ComponentCompiler, Value, SharedString};
/// use core::convert::TryInto;
/// let code = r#"
/// export global Logic {
/// pure callback to_uppercase(string) -> string;
/// }
/// component MyWin inherits Window {
/// out property <string> hello: Logic.to_uppercase("world");
/// }
/// "#;
/// let definition = spin_on::spin_on(
/// ComponentCompiler::default().build_from_source(code.into(), Default::default()));
/// let instance = definition.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<Value, InvokeError> {
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(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)
}
}
/// Highlight the elements which are pointed by a given source location.
///
/// WARNING: this is not part of the public API
#[cfg(feature = "highlight")]
pub fn highlight(&self, path: PathBuf, offset: u32) {
crate::highlight::highlight(&self.inner, path, offset);
}
/// Request information on clicked object
///
/// WARNING: this is not part of the public API
#[cfg(feature = "highlight")]
pub fn set_design_mode(&self, active: bool) {
crate::highlight::set_design_mode(&self.inner, active);
}
/// Register callback to handle current item information
///
/// The callback will be called with the file name, the start line and column
/// followed by the end line and column.
///
/// WARNING: this is not part of the public API
#[cfg(feature = "highlight")]
pub fn on_element_selected(&self, callback: Box<dyn Fn(&str, u32, u32, u32, u32)>) {
crate::highlight::on_element_selected(&self.inner, callback);
}
}
impl ComponentHandle for ComponentInstance {
type Inner = crate::dynamic_component::ErasedComponentBox;
fn as_weak(&self) -> Weak<Self>
where
Self: Sized,
{
Weak::new(&self.inner)
}
fn clone_strong(&self) -> Self {
Self { inner: self.inner.clone() }
}
fn from_inner(
inner: vtable::VRc<i_slint_core::component::ComponentVTable, Self::Inner>,
) -> 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<ComponentInstance>
for vtable::VRc<i_slint_core::component::ComponentVTable, ErasedComponentBox>
{
fn from(value: ComponentInstance) -> Self {
value.inner
}
}
/// Error returned by [`ComponentInstance::get_property`]
#[derive(Debug, Clone, Copy, PartialEq, Eq, thiserror::Error)]
#[non_exhaustive]
pub enum GetPropertyError {
/// There is no property with the given name
#[error("no such property")]
NoSuchProperty,
}
/// Error returned by [`ComponentInstance::set_property`]
#[derive(Debug, Clone, Copy, PartialEq, Eq, thiserror::Error)]
#[non_exhaustive]
pub enum SetPropertyError {
/// There is no property with the given name.
#[error("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.
#[error("wrong type")]
WrongType,
/// Attempt to set an output property.
#[error("access denied")]
AccessDenied,
}
/// Error returned by [`ComponentInstance::set_callback`]
#[derive(Debug, Clone, Copy, PartialEq, Eq, thiserror::Error)]
#[non_exhaustive]
pub enum SetCallbackError {
/// There is no callback with the given name
#[error("no such callback")]
NoSuchCallback,
}
/// Error returned by [`ComponentInstance::invoke`]
#[derive(Debug, Clone, Copy, PartialEq, Eq, thiserror::Error)]
#[non_exhaustive]
pub enum InvokeError {
/// There is no callback or function with the given name
#[error("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())
}
/// 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(
&vtable::VRc::into_dyn(comp.inner.clone()),
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();
let mut compiler = ComponentCompiler::default();
compiler.set_style("fluent".into());
let comp_def = spin_on::spin_on(
compiler.build_from_source(
r#"
export component Dummy {
in-out property <string> test;
in-out property <int> underscores-and-dashes_preserved: 44;
callback hello;
}"#
.into(),
"".into(),
),
)
.unwrap();
let props = comp_def.properties().collect::<Vec<(_, _)>>();
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();
let mut compiler = ComponentCompiler::default();
compiler.set_style("fluent".into());
let comp_def = spin_on::spin_on(
compiler.build_from_source(
r#"
export component Dummy {
in-out property <string> sub-text <=> sub.text;
sub := Text { property <int> private-not-exported; }
out property <string> xreadonly: "the value";
private property <string> xx: sub.text;
callback hello;
}"#
.into(),
"".into(),
),
)
.unwrap();
let props = comp_def.properties().collect::<Vec<(_, _)>>();
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::<Vec<_>>();
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();
let mut compiler = ComponentCompiler::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 <int> the-property : 21;
callback my-callback();
}
export { My-Super_Global as AliasedGlobal }
export component Dummy {
}"#
.into(),
"".into(),
),
)
.unwrap();
assert_eq!(definition.globals().collect::<Vec<_>>(), 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::<Vec<_>>())
.as_ref(),
Some(&expected_properties)
);
assert_eq!(
definition
.global_callbacks(global_name)
.map(|props| props.collect::<Vec<_>>())
.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)
);
}
#[test]
fn call_functions() {
i_slint_backend_testing::init();
let mut compiler = ComponentCompiler::default();
compiler.set_style("fluent".into());
let definition = spin_on::spin_on(
compiler.build_from_source(
r#"
export global Gl {
out property<string> q;
public function foo-bar(a-a: string, b-b:int) -> string {
q = a-a;
return a-a + b-b;
}
}
export Test := Rectangle {
out property<int> p;
public function foo-bar(a: int, b:int) -> int {
p = a;
return a + b;
}
}"#
.into(),
"".into(),
),
);
let instance = definition.unwrap().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();
let mut compiler = ComponentCompiler::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 Dummy := Rectangle {
property <Settings> test;
}"#
.into(),
"".into(),
),
)
.unwrap();
let props = comp_def.properties().collect::<Vec<(_, _)>>();
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();
let mut compiler = ComponentCompiler::default();
compiler.set_style("fluent".into());
let comp_def = spin_on::spin_on(compiler.build_from_source(
"export Dummy := Rectangle { property <[int]> prop: [42, 12]; }".into(),
"".into(),
))
.unwrap();
let props = comp_def.properties().collect::<Vec<(_, _)>>();
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::<Value>::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!("{:?} not a model", val);
}
}
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 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(Box::new(LangType::Void))), ValueType::Model);
assert_eq!(ValueType::from(LangType::Bool), ValueType::Bool);
assert_eq!(
ValueType::from(LangType::Struct {
fields: BTreeMap::default(),
name: None,
node: None,
rust_attributes: None
}),
ValueType::Struct
);
assert_eq!(ValueType::from(LangType::Image), ValueType::Image);
}
#[cfg(feature = "ffi")]
#[allow(missing_docs)]
#[path = "ffi.rs"]
pub(crate) mod ffi;