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 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at https://mozilla.org/MPL/2.0/. */
//! Support for [custom properties for cascading variables][custom].
//!
//! [custom]: https://drafts.csswg.org/css-variables/
use crate::applicable_declarations::CascadePriority;
use crate::custom_properties_map::CustomPropertiesMap;
use crate::media_queries::Device;
use crate::properties::{
CSSWideKeyword, CustomDeclaration, CustomDeclarationValue, LonghandId, LonghandIdSet,
PropertyDeclaration,
};
use crate::properties_and_values::{
registry::PropertyRegistrationData,
syntax::data_type::DependentDataTypes,
value::{
AllowComputationallyDependent, ComputedValue as ComputedRegisteredValue,
SpecifiedValue as SpecifiedRegisteredValue,
},
};
use crate::selector_map::{PrecomputedHashMap, PrecomputedHashSet};
use crate::stylesheets::UrlExtraData;
use crate::stylist::Stylist;
use crate::values::computed::{self, ToComputedValue};
use crate::values::specified::FontRelativeLength;
use crate::Atom;
use cssparser::{
CowRcStr, Delimiter, Parser, ParserInput, SourcePosition, Token, TokenSerializationType,
};
use selectors::parser::SelectorParseErrorKind;
use servo_arc::Arc;
use smallvec::SmallVec;
use std::borrow::Cow;
use std::collections::hash_map::Entry;
use std::fmt::{self, Write};
use std::ops::{Index, IndexMut};
use std::{cmp, num};
use style_traits::{CssWriter, ParseError, StyleParseErrorKind, ToCss};
/// The environment from which to get `env` function values.
///
/// TODO(emilio): If this becomes a bit more complex we should probably move it
/// to the `media_queries` module, or something.
#[derive(Debug, MallocSizeOf)]
pub struct CssEnvironment;
type EnvironmentEvaluator = fn(device: &Device, url_data: &UrlExtraData) -> VariableValue;
struct EnvironmentVariable {
name: Atom,
evaluator: EnvironmentEvaluator,
}
macro_rules! make_variable {
($name:expr, $evaluator:expr) => {{
EnvironmentVariable {
name: $name,
evaluator: $evaluator,
}
}};
}
fn get_safearea_inset_top(device: &Device, url_data: &UrlExtraData) -> VariableValue {
VariableValue::pixels(device.safe_area_insets().top, url_data)
}
fn get_safearea_inset_bottom(device: &Device, url_data: &UrlExtraData) -> VariableValue {
VariableValue::pixels(device.safe_area_insets().bottom, url_data)
}
fn get_safearea_inset_left(device: &Device, url_data: &UrlExtraData) -> VariableValue {
VariableValue::pixels(device.safe_area_insets().left, url_data)
}
fn get_safearea_inset_right(device: &Device, url_data: &UrlExtraData) -> VariableValue {
VariableValue::pixels(device.safe_area_insets().right, url_data)
}
#[cfg(feature = "gecko")]
fn get_content_preferred_color_scheme(device: &Device, url_data: &UrlExtraData) -> VariableValue {
use crate::gecko::media_features::PrefersColorScheme;
let prefers_color_scheme = unsafe {
crate::gecko_bindings::bindings::Gecko_MediaFeatures_PrefersColorScheme(
device.document(),
/* use_content = */ true,
)
};
VariableValue::ident(
match prefers_color_scheme {
PrefersColorScheme::Light => "light",
PrefersColorScheme::Dark => "dark",
},
url_data,
)
}
#[cfg(feature = "servo")]
fn get_content_preferred_color_scheme(_device: &Device, url_data: &UrlExtraData) -> VariableValue {
// TODO: Add an implementation for Servo.
VariableValue::ident("light", url_data)
}
fn get_scrollbar_inline_size(device: &Device, url_data: &UrlExtraData) -> VariableValue {
VariableValue::pixels(device.scrollbar_inline_size().px(), url_data)
}
static ENVIRONMENT_VARIABLES: [EnvironmentVariable; 4] = [
make_variable!(atom!("safe-area-inset-top"), get_safearea_inset_top),
make_variable!(atom!("safe-area-inset-bottom"), get_safearea_inset_bottom),
make_variable!(atom!("safe-area-inset-left"), get_safearea_inset_left),
make_variable!(atom!("safe-area-inset-right"), get_safearea_inset_right),
];
#[cfg(feature = "gecko")]
macro_rules! lnf_int {
($id:ident) => {
unsafe {
crate::gecko_bindings::bindings::Gecko_GetLookAndFeelInt(
crate::gecko_bindings::bindings::LookAndFeel_IntID::$id as i32,
)
}
};
}
#[cfg(feature = "servo")]
macro_rules! lnf_int {
($id:ident) => {
// TODO: Add an implementation for Servo.
0
};
}
macro_rules! lnf_int_variable {
($atom:expr, $id:ident, $ctor:ident) => {{
fn __eval(_: &Device, url_data: &UrlExtraData) -> VariableValue {
VariableValue::$ctor(lnf_int!($id), url_data)
}
make_variable!($atom, __eval)
}};
}
static CHROME_ENVIRONMENT_VARIABLES: [EnvironmentVariable; 9] = [
lnf_int_variable!(
atom!("-moz-mac-titlebar-height"),
MacTitlebarHeight,
int_pixels
),
lnf_int_variable!(
atom!("-moz-gtk-csd-titlebar-button-spacing"),
TitlebarButtonSpacing,
int_pixels
),
lnf_int_variable!(
atom!("-moz-gtk-csd-titlebar-radius"),
TitlebarRadius,
int_pixels
),
lnf_int_variable!(
atom!("-moz-gtk-csd-close-button-position"),
GTKCSDCloseButtonPosition,
integer
),
lnf_int_variable!(
atom!("-moz-gtk-csd-minimize-button-position"),
GTKCSDMinimizeButtonPosition,
integer
),
lnf_int_variable!(
atom!("-moz-gtk-csd-maximize-button-position"),
GTKCSDMaximizeButtonPosition,
integer
),
lnf_int_variable!(
atom!("-moz-overlay-scrollbar-fade-duration"),
ScrollbarFadeDuration,
int_ms
),
make_variable!(
atom!("-moz-content-preferred-color-scheme"),
get_content_preferred_color_scheme
),
make_variable!(atom!("scrollbar-inline-size"), get_scrollbar_inline_size),
];
impl CssEnvironment {
#[inline]
fn get(&self, name: &Atom, device: &Device, url_data: &UrlExtraData) -> Option<VariableValue> {
if let Some(var) = ENVIRONMENT_VARIABLES.iter().find(|var| var.name == *name) {
return Some((var.evaluator)(device, url_data));
}
if !url_data.chrome_rules_enabled() {
return None;
}
let var = CHROME_ENVIRONMENT_VARIABLES
.iter()
.find(|var| var.name == *name)?;
Some((var.evaluator)(device, url_data))
}
}
/// A custom property name is just an `Atom`.
///
/// Note that this does not include the `--` prefix
pub type Name = Atom;
/// Parse a custom property name.
///
/// <https://drafts.csswg.org/css-variables/#typedef-custom-property-name>
pub fn parse_name(s: &str) -> Result<&str, ()> {
if s.starts_with("--") && s.len() > 2 {
Ok(&s[2..])
} else {
Err(())
}
}
/// A value for a custom property is just a set of tokens.
///
/// We preserve the original CSS for serialization, and also the variable
/// references to other custom property names.
#[derive(Clone, Debug, MallocSizeOf, ToShmem)]
pub struct VariableValue {
/// The raw CSS string.
pub css: String,
/// The url data of the stylesheet where this value came from.
pub url_data: UrlExtraData,
first_token_type: TokenSerializationType,
last_token_type: TokenSerializationType,
/// var(), env(), or non-custom property (e.g. through `em`) references.
references: References,
}
trivial_to_computed_value!(VariableValue);
// For all purposes, we want values to be considered equal if their css text is equal.
impl PartialEq for VariableValue {
fn eq(&self, other: &Self) -> bool {
self.css == other.css
}
}
impl Eq for VariableValue {}
impl ToCss for SpecifiedValue {
fn to_css<W>(&self, dest: &mut CssWriter<W>) -> fmt::Result
where
W: Write,
{
dest.write_str(&self.css)
}
}
/// A pair of separate CustomPropertiesMaps, split between custom properties
/// that have the inherit flag set and those with the flag unset.
#[repr(C)]
#[derive(Clone, Debug, Default, PartialEq)]
pub struct ComputedCustomProperties {
/// Map for custom properties with inherit flag set, including non-registered
/// ones.
pub inherited: CustomPropertiesMap,
/// Map for custom properties with inherit flag unset.
pub non_inherited: CustomPropertiesMap,
}
impl ComputedCustomProperties {
/// Return whether the inherited and non_inherited maps are none.
pub fn is_empty(&self) -> bool {
self.inherited.is_empty() && self.non_inherited.is_empty()
}
/// Return the name and value of the property at specified index, if any.
pub fn property_at(&self, index: usize) -> Option<(&Name, &Option<ComputedRegisteredValue>)> {
// Just expose the custom property items from custom_properties.inherited, followed
// by custom property items from custom_properties.non_inherited.
self.inherited
.get_index(index)
.or_else(|| self.non_inherited.get_index(index - self.inherited.len()))
}
/// Insert a custom property in the corresponding inherited/non_inherited
/// map, depending on whether the inherit flag is set or unset.
fn insert(
&mut self,
registration: &PropertyRegistrationData,
name: &Name,
value: ComputedRegisteredValue,
) {
self.map_mut(registration).insert(name, value)
}
/// Remove a custom property from the corresponding inherited/non_inherited
/// map, depending on whether the inherit flag is set or unset.
fn remove(&mut self, registration: &PropertyRegistrationData, name: &Name) {
self.map_mut(registration).remove(name);
}
/// Shrink the capacity of the inherited maps as much as possible.
fn shrink_to_fit(&mut self) {
self.inherited.shrink_to_fit();
self.non_inherited.shrink_to_fit();
}
fn map_mut(&mut self, registration: &PropertyRegistrationData) -> &mut CustomPropertiesMap {
if registration.inherits() {
&mut self.inherited
} else {
&mut self.non_inherited
}
}
/// Returns the relevant custom property value given a registration.
pub fn get(
&self,
registration: &PropertyRegistrationData,
name: &Name,
) -> Option<&ComputedRegisteredValue> {
if registration.inherits() {
self.inherited.get(name)
} else {
self.non_inherited.get(name)
}
}
}
/// Both specified and computed values are VariableValues, the difference is
/// whether var() functions are expanded.
pub type SpecifiedValue = VariableValue;
/// Both specified and computed values are VariableValues, the difference is
/// whether var() functions are expanded.
pub type ComputedValue = VariableValue;
/// Set of flags to non-custom references this custom property makes.
#[derive(Clone, Copy, Debug, Default, PartialEq, Eq, MallocSizeOf, ToShmem)]
struct NonCustomReferences(u8);
bitflags! {
impl NonCustomReferences: u8 {
/// At least one custom property depends on font-relative units.
const FONT_UNITS = 1 << 0;
/// At least one custom property depends on root element's font-relative units.
const ROOT_FONT_UNITS = 1 << 1;
/// At least one custom property depends on line height units.
const LH_UNITS = 1 << 2;
/// At least one custom property depends on root element's line height units.
const ROOT_LH_UNITS = 1 << 3;
/// All dependencies not depending on the root element.
const NON_ROOT_DEPENDENCIES = Self::FONT_UNITS.0 | Self::LH_UNITS.0;
/// All dependencies depending on the root element.
const ROOT_DEPENDENCIES = Self::ROOT_FONT_UNITS.0 | Self::ROOT_LH_UNITS.0;
}
}
impl NonCustomReferences {
fn for_each<F>(&self, mut f: F)
where
F: FnMut(SingleNonCustomReference),
{
for (_, r) in self.iter_names() {
let single = match r {
Self::FONT_UNITS => SingleNonCustomReference::FontUnits,
Self::ROOT_FONT_UNITS => SingleNonCustomReference::RootFontUnits,
Self::LH_UNITS => SingleNonCustomReference::LhUnits,
Self::ROOT_LH_UNITS => SingleNonCustomReference::RootLhUnits,
_ => unreachable!("Unexpected single bit value"),
};
f(single);
}
}
fn from_unit(value: &CowRcStr) -> Self {
// For registered properties, any reference to font-relative dimensions
// make it dependent on font-related properties.
// TODO(dshin): When we unit algebra gets implemented and handled -
// Is it valid to say that `calc(1em / 2em * 3px)` triggers this?
if value.eq_ignore_ascii_case(FontRelativeLength::LH) {
return Self::FONT_UNITS | Self::LH_UNITS;
}
if value.eq_ignore_ascii_case(FontRelativeLength::EM) ||
value.eq_ignore_ascii_case(FontRelativeLength::EX) ||
value.eq_ignore_ascii_case(FontRelativeLength::CAP) ||
value.eq_ignore_ascii_case(FontRelativeLength::CH) ||
value.eq_ignore_ascii_case(FontRelativeLength::IC)
{
return Self::FONT_UNITS;
}
if value.eq_ignore_ascii_case(FontRelativeLength::RLH) {
return Self::ROOT_FONT_UNITS | Self::ROOT_LH_UNITS;
}
if value.eq_ignore_ascii_case(FontRelativeLength::REM) {
return Self::ROOT_FONT_UNITS;
}
Self::empty()
}
}
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
enum SingleNonCustomReference {
FontUnits = 0,
RootFontUnits,
LhUnits,
RootLhUnits,
}
struct NonCustomReferenceMap<T>([Option<T>; 4]);
impl<T> Default for NonCustomReferenceMap<T> {
fn default() -> Self {
NonCustomReferenceMap(Default::default())
}
}
impl<T> Index<SingleNonCustomReference> for NonCustomReferenceMap<T> {
type Output = Option<T>;
fn index(&self, reference: SingleNonCustomReference) -> &Self::Output {
&self.0[reference as usize]
}
}
impl<T> IndexMut<SingleNonCustomReference> for NonCustomReferenceMap<T> {
fn index_mut(&mut self, reference: SingleNonCustomReference) -> &mut Self::Output {
&mut self.0[reference as usize]
}
}
/// Whether to defer resolving custom properties referencing font relative units.
#[derive(Clone, Copy, PartialEq, Eq)]
#[allow(missing_docs)]
pub enum DeferFontRelativeCustomPropertyResolution {
Yes,
No,
}
#[derive(Clone, Debug, MallocSizeOf, PartialEq, ToShmem)]
struct VariableFallback {
start: num::NonZeroUsize,
first_token_type: TokenSerializationType,
last_token_type: TokenSerializationType,
}
#[derive(Clone, Debug, MallocSizeOf, PartialEq, ToShmem)]
struct VarOrEnvReference {
name: Name,
start: usize,
end: usize,
fallback: Option<VariableFallback>,
prev_token_type: TokenSerializationType,
next_token_type: TokenSerializationType,
is_var: bool,
}
/// A struct holding information about the external references to that a custom
/// property value may have.
#[derive(Clone, Debug, Default, MallocSizeOf, PartialEq, ToShmem)]
struct References {
refs: Vec<VarOrEnvReference>,
non_custom_references: NonCustomReferences,
any_env: bool,
any_var: bool,
}
impl References {
fn has_references(&self) -> bool {
!self.refs.is_empty()
}
fn non_custom_references(&self, is_root_element: bool) -> NonCustomReferences {
let mut mask = NonCustomReferences::NON_ROOT_DEPENDENCIES;
if is_root_element {
mask |= NonCustomReferences::ROOT_DEPENDENCIES
}
self.non_custom_references & mask
}
}
impl VariableValue {
fn empty(url_data: &UrlExtraData) -> Self {
Self {
css: String::new(),
last_token_type: Default::default(),
first_token_type: Default::default(),
url_data: url_data.clone(),
references: Default::default(),
}
}
/// Create a new custom property without parsing if the CSS is known to be valid and contain no
/// references.
pub fn new(
css: String,
url_data: &UrlExtraData,
first_token_type: TokenSerializationType,
last_token_type: TokenSerializationType,
) -> Self {
Self {
css,
url_data: url_data.clone(),
first_token_type,
last_token_type,
references: Default::default(),
}
}
fn push<'i>(
&mut self,
css: &str,
css_first_token_type: TokenSerializationType,
css_last_token_type: TokenSerializationType,
) -> Result<(), ()> {
/// Prevent values from getting terribly big since you can use custom
/// properties exponentially.
///
/// This number (2MB) is somewhat arbitrary, but silly enough that no
/// reasonable page should hit it. We could limit by number of total
/// substitutions, but that was very easy to work around in practice
/// (just choose a larger initial value and boom).
const MAX_VALUE_LENGTH_IN_BYTES: usize = 2 * 1024 * 1024;
if self.css.len() + css.len() > MAX_VALUE_LENGTH_IN_BYTES {
return Err(());
}
// This happens e.g. between two subsequent var() functions:
// `var(--a)var(--b)`.
//
// In that case, css_*_token_type is nonsensical.
if css.is_empty() {
return Ok(());
}
self.first_token_type.set_if_nothing(css_first_token_type);
// If self.first_token_type was nothing,
// self.last_token_type is also nothing and this will be false:
if self
.last_token_type
.needs_separator_when_before(css_first_token_type)
{
self.css.push_str("/**/")
}
self.css.push_str(css);
self.last_token_type = css_last_token_type;
Ok(())
}
/// Parse a custom property value.
pub fn parse<'i, 't>(
input: &mut Parser<'i, 't>,
url_data: &UrlExtraData,
) -> Result<Self, ParseError<'i>> {
input.skip_whitespace();
let mut references = References::default();
let mut missing_closing_characters = String::new();
let start_position = input.position();
let (first_token_type, last_token_type) = parse_declaration_value(
input,
start_position,
&mut references,
&mut missing_closing_characters,
)?;
let mut css = input.slice_from(start_position).to_owned();
if !missing_closing_characters.is_empty() {
// Unescaped backslash at EOF in a quoted string is ignored.
if css.ends_with("\\") &&
matches!(missing_closing_characters.as_bytes()[0], b'"' | b'\'')
{
css.pop();
}
css.push_str(&missing_closing_characters);
}
css.shrink_to_fit();
references.refs.shrink_to_fit();
Ok(Self {
css,
url_data: url_data.clone(),
first_token_type,
last_token_type,
references,
})
}
/// Create VariableValue from an int.
fn integer(number: i32, url_data: &UrlExtraData) -> Self {
Self::from_token(
Token::Number {
has_sign: false,
value: number as f32,
int_value: Some(number),
},
url_data,
)
}
/// Create VariableValue from an int.
fn ident(ident: &'static str, url_data: &UrlExtraData) -> Self {
Self::from_token(Token::Ident(ident.into()), url_data)
}
/// Create VariableValue from a float amount of CSS pixels.
fn pixels(number: f32, url_data: &UrlExtraData) -> Self {
// FIXME (https://github.com/servo/rust-cssparser/issues/266):
// No way to get TokenSerializationType::Dimension without creating
// Token object.
Self::from_token(
Token::Dimension {
has_sign: false,
value: number,
int_value: None,
unit: CowRcStr::from("px"),
},
url_data,
)
}
/// Create VariableValue from an integer amount of milliseconds.
fn int_ms(number: i32, url_data: &UrlExtraData) -> Self {
Self::from_token(
Token::Dimension {
has_sign: false,
value: number as f32,
int_value: Some(number),
unit: CowRcStr::from("ms"),
},
url_data,
)
}
/// Create VariableValue from an integer amount of CSS pixels.
fn int_pixels(number: i32, url_data: &UrlExtraData) -> Self {
Self::from_token(
Token::Dimension {
has_sign: false,
value: number as f32,
int_value: Some(number),
unit: CowRcStr::from("px"),
},
url_data,
)
}
fn from_token(token: Token, url_data: &UrlExtraData) -> Self {
let token_type = token.serialization_type();
let mut css = token.to_css_string();
css.shrink_to_fit();
VariableValue {
css,
url_data: url_data.clone(),
first_token_type: token_type,
last_token_type: token_type,
references: Default::default(),
}
}
/// Returns the raw CSS text from this VariableValue
pub fn css_text(&self) -> &str {
&self.css
}
/// Returns whether this variable value has any reference to the environment or other
/// variables.
pub fn has_references(&self) -> bool {
self.references.has_references()
}
}
/// <https://drafts.csswg.org/css-syntax-3/#typedef-declaration-value>
fn parse_declaration_value<'i, 't>(
input: &mut Parser<'i, 't>,
input_start: SourcePosition,
references: &mut References,
missing_closing_characters: &mut String,
) -> Result<(TokenSerializationType, TokenSerializationType), ParseError<'i>> {
input.parse_until_before(Delimiter::Bang | Delimiter::Semicolon, |input| {
parse_declaration_value_block(input, input_start, references, missing_closing_characters)
})
}
/// Like parse_declaration_value, but accept `!` and `;` since they are only invalid at the top level.
fn parse_declaration_value_block<'i, 't>(
input: &mut Parser<'i, 't>,
input_start: SourcePosition,
references: &mut References,
missing_closing_characters: &mut String,
) -> Result<(TokenSerializationType, TokenSerializationType), ParseError<'i>> {
let mut is_first = true;
let mut first_token_type = TokenSerializationType::Nothing;
let mut last_token_type = TokenSerializationType::Nothing;
let mut prev_reference_index: Option<usize> = None;
loop {
let token_start = input.position();
let Ok(token) = input.next_including_whitespace_and_comments() else {
break;
};
let prev_token_type = last_token_type;
let serialization_type = token.serialization_type();
last_token_type = serialization_type;
if is_first {
first_token_type = last_token_type;
is_first = false;
}
macro_rules! nested {
() => {
input.parse_nested_block(|input| {
parse_declaration_value_block(
input,
input_start,
references,
missing_closing_characters,
)
})?
};
}
macro_rules! check_closed {
($closing:expr) => {
if !input.slice_from(token_start).ends_with($closing) {
missing_closing_characters.push_str($closing)
}
};
}
if let Some(index) = prev_reference_index.take() {
references.refs[index].next_token_type = serialization_type;
}
match *token {
Token::Comment(_) => {
let token_slice = input.slice_from(token_start);
if !token_slice.ends_with("*/") {
missing_closing_characters.push_str(if token_slice.ends_with('*') {
"/"
} else {
"*/"
})
}
},
Token::BadUrl(ref u) => {
let e = StyleParseErrorKind::BadUrlInDeclarationValueBlock(u.clone());
return Err(input.new_custom_error(e));
},
Token::BadString(ref s) => {
let e = StyleParseErrorKind::BadStringInDeclarationValueBlock(s.clone());
return Err(input.new_custom_error(e));
},
Token::CloseParenthesis => {
let e = StyleParseErrorKind::UnbalancedCloseParenthesisInDeclarationValueBlock;
return Err(input.new_custom_error(e));
},
Token::CloseSquareBracket => {
let e = StyleParseErrorKind::UnbalancedCloseSquareBracketInDeclarationValueBlock;
return Err(input.new_custom_error(e));
},
Token::CloseCurlyBracket => {
let e = StyleParseErrorKind::UnbalancedCloseCurlyBracketInDeclarationValueBlock;
return Err(input.new_custom_error(e));
},
Token::Function(ref name) => {
let is_var = name.eq_ignore_ascii_case("var");
if is_var || name.eq_ignore_ascii_case("env") {
let our_ref_index = references.refs.len();
let fallback = input.parse_nested_block(|input| {
// TODO(emilio): For env() this should be <custom-ident> per spec, but no other browser does
// that, see https://github.com/w3c/csswg-drafts/issues/3262.
let name = input.expect_ident()?;
let name = Atom::from(if is_var {
match parse_name(name.as_ref()) {
Ok(name) => name,
Err(()) => {
let name = name.clone();
return Err(input.new_custom_error(
SelectorParseErrorKind::UnexpectedIdent(name),
));
},
}
} else {
name.as_ref()
});
// We want the order of the references to match source order. So we need to reserve our slot
// now, _before_ parsing our fallback. Note that we don't care if parsing fails after all, since
// if this fails we discard the whole result anyways.
let start = token_start.byte_index() - input_start.byte_index();
references.refs.push(VarOrEnvReference {
name,
start,
// To be fixed up after parsing fallback and auto-closing via our_ref_index.
end: start,
prev_token_type,
// To be fixed up (if needed) on the next loop iteration via prev_reference_index.
next_token_type: TokenSerializationType::Nothing,
// To be fixed up after parsing fallback.
fallback: None,
is_var,
});
let mut fallback = None;
if input.try_parse(|input| input.expect_comma()).is_ok() {
input.skip_whitespace();
let fallback_start = num::NonZeroUsize::new(
input.position().byte_index() - input_start.byte_index(),
)
.unwrap();
// NOTE(emilio): Intentionally using parse_declaration_value rather than
// parse_declaration_value_block, since that's what parse_fallback used to do.
let (first, last) = parse_declaration_value(
input,
input_start,
references,
missing_closing_characters,
)?;
fallback = Some(VariableFallback {
start: fallback_start,
first_token_type: first,
last_token_type: last,
});
} else {
let state = input.state();
// We still need to consume the rest of the potentially-unclosed
// tokens, but make sure to not consume tokens that would otherwise be
// invalid, by calling reset().
parse_declaration_value_block(
input,
input_start,
references,
missing_closing_characters,
)?;
input.reset(&state);
}
Ok(fallback)
})?;
check_closed!(")");
prev_reference_index = Some(our_ref_index);
let reference = &mut references.refs[our_ref_index];
reference.end = input.position().byte_index() - input_start.byte_index() +
missing_closing_characters.len();
reference.fallback = fallback;
if is_var {
references.any_var = true;
} else {
references.any_env = true;
}
} else {
nested!();
check_closed!(")");
}
},
Token::ParenthesisBlock => {
nested!();
check_closed!(")");
},
Token::CurlyBracketBlock => {
nested!();
check_closed!("}");
},
Token::SquareBracketBlock => {
nested!();
check_closed!("]");
},
Token::QuotedString(_) => {
let token_slice = input.slice_from(token_start);
let quote = &token_slice[..1];
debug_assert!(matches!(quote, "\"" | "'"));
if !(token_slice.ends_with(quote) && token_slice.len() > 1) {
missing_closing_characters.push_str(quote)
}
},
Token::Ident(ref value) |
Token::AtKeyword(ref value) |
Token::Hash(ref value) |
Token::IDHash(ref value) |
Token::UnquotedUrl(ref value) |
Token::Dimension {
unit: ref value, ..
} => {
references
.non_custom_references
.insert(NonCustomReferences::from_unit(value));
let is_unquoted_url = matches!(token, Token::UnquotedUrl(_));
if value.ends_with("�") && input.slice_from(token_start).ends_with("\\") {
// Unescaped backslash at EOF in these contexts is interpreted as U+FFFD
// Check the value in case the final backslash was itself escaped.
// Serialize as escaped U+FFFD, which is also interpreted as U+FFFD.
// (Unescaped U+FFFD would also work, but removing the backslash is annoying.)
missing_closing_characters.push_str("�")
}
if is_unquoted_url {
check_closed!(")");
}
},
_ => {},
};
}
Ok((first_token_type, last_token_type))
}
/// A struct that takes care of encapsulating the cascade process for custom properties.
pub struct CustomPropertiesBuilder<'a, 'b: 'a> {
seen: PrecomputedHashSet<&'a Name>,
may_have_cycles: bool,
has_color_scheme: bool,
custom_properties: ComputedCustomProperties,
reverted: PrecomputedHashMap<&'a Name, (CascadePriority, bool)>,
stylist: &'a Stylist,
computed_context: &'a mut computed::Context<'b>,
references_from_non_custom_properties: NonCustomReferenceMap<Vec<Name>>,
}
fn find_non_custom_references(
registration: &PropertyRegistrationData,
value: &VariableValue,
may_have_color_scheme: bool,
is_root_element: bool,
include_universal: bool,
) -> Option<NonCustomReferences> {
let dependent_types = registration.syntax.dependent_types();
let may_reference_length = dependent_types.intersects(DependentDataTypes::LENGTH) ||
(include_universal && registration.syntax.is_universal());
if may_reference_length {
let value_dependencies = value.references.non_custom_references(is_root_element);
if !value_dependencies.is_empty() {
return Some(value_dependencies);
}
}
if dependent_types.intersects(DependentDataTypes::COLOR) && may_have_color_scheme {
// NOTE(emilio): We might want to add a NonCustomReferences::COLOR_SCHEME or something but
// it's not really needed for correctness, so for now we use an Option for that to signal
// that there might be a dependencies.
return Some(NonCustomReferences::empty());
}
None
}
impl<'a, 'b: 'a> CustomPropertiesBuilder<'a, 'b> {
/// Create a new builder, inheriting from a given custom properties map.
///
/// We expose this publicly mostly for @keyframe blocks.
pub fn new_with_properties(
stylist: &'a Stylist,
custom_properties: ComputedCustomProperties,
computed_context: &'a mut computed::Context<'b>,
) -> Self {
Self {
seen: PrecomputedHashSet::default(),
reverted: Default::default(),
may_have_cycles: false,
has_color_scheme: false,
custom_properties,
stylist,
computed_context,
references_from_non_custom_properties: NonCustomReferenceMap::default(),
}
}
/// Create a new builder, inheriting from the right style given context.
pub fn new(stylist: &'a Stylist, context: &'a mut computed::Context<'b>) -> Self {
let is_root_element = context.is_root_element();
let inherited = context.inherited_custom_properties();
let initial_values = stylist.get_custom_property_initial_values();
let properties = ComputedCustomProperties {
inherited: if is_root_element {
debug_assert!(inherited.is_empty());
initial_values.inherited.clone()
} else {
inherited.inherited.clone()
},
non_inherited: initial_values.non_inherited.clone(),
};
// Reuse flags from computing registered custom properties initial values, such as
// whether they depend on viewport units.
context
.style()
.add_flags(stylist.get_custom_property_initial_values_flags());
Self::new_with_properties(stylist, properties, context)
}
/// Cascade a given custom property declaration.
pub fn cascade(&mut self, declaration: &'a CustomDeclaration, priority: CascadePriority) {
let CustomDeclaration {
ref name,
ref value,
} = *declaration;
if let Some(&(reverted_priority, is_origin_revert)) = self.reverted.get(&name) {
if !reverted_priority.allows_when_reverted(&priority, is_origin_revert) {
return;
}
}
let was_already_present = !self.seen.insert(name);
if was_already_present {
return;
}
if !self.value_may_affect_style(name, value) {
return;
}
let map = &mut self.custom_properties;
let registration = self.stylist.get_custom_property_registration(&name);
match value {
CustomDeclarationValue::Unparsed(unparsed_value) => {
// At this point of the cascade we're not guaranteed to have seen the color-scheme
// declaration, so need to assume the worst. We could track all system color
// keyword tokens + the light-dark() function, but that seems non-trivial /
// probably overkill.
let may_have_color_scheme = true;
// Non-custom dependency is really relevant for registered custom properties
// that require computed value of such dependencies.
let has_dependency = unparsed_value.references.any_var ||
find_non_custom_references(
registration,
unparsed_value,
may_have_color_scheme,
self.computed_context.is_root_element(),
/* include_unregistered = */ false,
)
.is_some();
// If the variable value has no references to other properties, perform
// substitution here instead of forcing a full traversal in `substitute_all`
// afterwards.
if !has_dependency {
return substitute_references_if_needed_and_apply(
name,
unparsed_value,
map,
self.stylist,
self.computed_context,
);
}
self.may_have_cycles = true;
let value = ComputedRegisteredValue::universal(Arc::clone(unparsed_value));
map.insert(registration, name, value);
},
CustomDeclarationValue::Parsed(parsed_value) => {
let value = parsed_value.to_computed_value(&self.computed_context);
map.insert(registration, name, value);
},
CustomDeclarationValue::CSSWideKeyword(keyword) => match keyword {
CSSWideKeyword::RevertLayer | CSSWideKeyword::Revert => {
let origin_revert = matches!(keyword, CSSWideKeyword::Revert);
self.seen.remove(name);
self.reverted.insert(name, (priority, origin_revert));
},
CSSWideKeyword::Initial => {
// For non-inherited custom properties, 'initial' was handled in value_may_affect_style.
debug_assert!(registration.inherits(), "Should've been handled earlier");
remove_and_insert_initial_value(name, registration, map);
},
CSSWideKeyword::Inherit => {
// For inherited custom properties, 'inherit' was handled in value_may_affect_style.
debug_assert!(!registration.inherits(), "Should've been handled earlier");
if let Some(inherited_value) = self
.computed_context
.inherited_custom_properties()
.non_inherited
.get(name)
{
map.insert(registration, name, inherited_value.clone());
}
},
// handled in value_may_affect_style
CSSWideKeyword::Unset => unreachable!(),
},
}
}
/// Fast check to avoid calling maybe_note_non_custom_dependency in ~all cases.
#[inline]
pub fn might_have_non_custom_dependency(id: LonghandId, decl: &PropertyDeclaration) -> bool {
if id == LonghandId::ColorScheme {
return true;
}
if matches!(id, LonghandId::LineHeight | LonghandId::FontSize) {
return matches!(decl, PropertyDeclaration::WithVariables(..));
}
false
}
/// Note a non-custom property with variable reference that may in turn depend on that property.
/// e.g. `font-size` depending on a custom property that may be a registered property using `em`.
pub fn maybe_note_non_custom_dependency(&mut self, id: LonghandId, decl: &PropertyDeclaration) {
debug_assert!(Self::might_have_non_custom_dependency(id, decl));
if id == LonghandId::ColorScheme {
// If we might change the color-scheme, we need to defer computation of colors.
self.has_color_scheme = true;
return;
}
let refs = match decl {
PropertyDeclaration::WithVariables(ref v) => &v.value.variable_value.references,
_ => return,
};
if !refs.any_var {
return;
}
// With unit algebra in `calc()`, references aren't limited to `font-size`.
// For example, `--foo: 100ex; font-weight: calc(var(--foo) / 1ex);`,
// or `--foo: 1em; zoom: calc(var(--foo) * 30px / 2em);`
let references = match id {
LonghandId::FontSize => {
if self.computed_context.is_root_element() {
NonCustomReferences::ROOT_FONT_UNITS
} else {
NonCustomReferences::FONT_UNITS
}
},
LonghandId::LineHeight => {
if self.computed_context.is_root_element() {
NonCustomReferences::ROOT_LH_UNITS | NonCustomReferences::ROOT_FONT_UNITS
} else {
NonCustomReferences::LH_UNITS | NonCustomReferences::FONT_UNITS
}
},
_ => return,
};
let variables: Vec<Atom> = refs
.refs
.iter()
.filter_map(|reference| {
if !reference.is_var {
return None;
}
let registration = self
.stylist
.get_custom_property_registration(&reference.name);
if !registration
.syntax
.dependent_types()
.intersects(DependentDataTypes::LENGTH)
{
return None;
}
Some(reference.name.clone())
})
.collect();
references.for_each(|idx| {
let entry = &mut self.references_from_non_custom_properties[idx];
let was_none = entry.is_none();
let v = entry.get_or_insert_with(|| variables.clone());
if was_none {
return;
}
v.extend(variables.iter().cloned());
});
}
fn value_may_affect_style(&self, name: &Name, value: &CustomDeclarationValue) -> bool {
let registration = self.stylist.get_custom_property_registration(&name);
match *value {
CustomDeclarationValue::CSSWideKeyword(CSSWideKeyword::Inherit) => {
// For inherited custom properties, explicit 'inherit' means we
// can just use any existing value in the inherited
// CustomPropertiesMap.
if registration.inherits() {
return false;
}
},
CustomDeclarationValue::CSSWideKeyword(CSSWideKeyword::Initial) => {
// For non-inherited custom properties, explicit 'initial' means
// we can just use any initial value in the registration.
if !registration.inherits() {
return false;
}
},
CustomDeclarationValue::CSSWideKeyword(CSSWideKeyword::Unset) => {
// Explicit 'unset' means we can either just use any existing
// value in the inherited CustomPropertiesMap or the initial
// value in the registration.
return false;
},
_ => {},
}
let existing_value = self.custom_properties.get(registration, &name);
let existing_value = match existing_value {
None => {
if matches!(value, CustomDeclarationValue::CSSWideKeyword(CSSWideKeyword::Initial)) {
debug_assert!(registration.inherits(), "Should've been handled earlier");
// The initial value of a custom property without a
// guaranteed-invalid initial value is the same as it
// not existing in the map.
if registration.initial_value.is_none() {
return false;
}
}
return true;
},
Some(v) => v,
};
let computed_value = match value {
CustomDeclarationValue::Unparsed(value) => {
// Don't bother overwriting an existing value with the same
// specified value.
if let Some(existing_value) = existing_value.as_universal() {
return existing_value != value;
}
if !registration.syntax.is_universal() {
compute_value(
&value.css,
&value.url_data,
registration,
self.computed_context,
).ok()
} else {
None
}
},
CustomDeclarationValue::Parsed(value) => {
Some(value.to_computed_value(&self.computed_context))
},
CustomDeclarationValue::CSSWideKeyword(kw) => {
match kw {
CSSWideKeyword::Inherit => {
debug_assert!(!registration.inherits(), "Should've been handled earlier");
// existing_value is the registered initial value.
// Don't bother adding it to self.custom_properties.non_inherited
// if the key is also absent from self.inherited.non_inherited.
if self
.computed_context
.inherited_custom_properties()
.non_inherited
.get(name)
.is_none()
{
return false;
}
},
CSSWideKeyword::Initial => {
debug_assert!(registration.inherits(), "Should've been handled earlier");
// Don't bother overwriting an existing value with the initial value specified in
// the registration.
if let Some(initial_value) = self
.stylist
.get_custom_property_initial_values()
.get(registration, name)
{
return existing_value != initial_value;
}
},
CSSWideKeyword::Unset => {
debug_assert!(false, "Should've been handled earlier");
},
CSSWideKeyword::Revert | CSSWideKeyword::RevertLayer => {},
}
None
}
};
if let Some(value) = computed_value {
return existing_value.v != value.v;
}
true
}
/// Computes the map of applicable custom properties, as well as
/// longhand properties that are now considered invalid-at-compute time.
/// The result is saved into the computed context.
///
/// If there was any specified property or non-inherited custom property
/// with an initial value, we've created a new map and now we
/// need to remove any potential cycles (And marking non-custom
/// properties), and wrap it in an arc.
///
/// Some registered custom properties may require font-related properties
/// be resolved to resolve. If these properties are not resolved at this time,
/// `defer` should be set to `Yes`, which will leave such custom properties,
/// and other properties referencing them, untouched. These properties are
/// returned separately, to be resolved by `build_deferred` to fully resolve
/// all custom properties after all necessary non-custom properties are resolved.
pub fn build(
mut self,
defer: DeferFontRelativeCustomPropertyResolution,
) -> Option<CustomPropertiesMap> {
let mut deferred_custom_properties = None;
if self.may_have_cycles {
if defer == DeferFontRelativeCustomPropertyResolution::Yes {
deferred_custom_properties = Some(CustomPropertiesMap::default());
}
let mut invalid_non_custom_properties = LonghandIdSet::default();
substitute_all(
&mut self.custom_properties,
deferred_custom_properties.as_mut(),
&mut invalid_non_custom_properties,
self.has_color_scheme,
&self.seen,
&self.references_from_non_custom_properties,
self.stylist,
self.computed_context,
);
self.computed_context.builder.invalid_non_custom_properties =
invalid_non_custom_properties;
}
self.custom_properties.shrink_to_fit();
// Some pages apply a lot of redundant custom properties, see e.g.
// bug 1758974 comment 5. Try to detect the case where the values
// haven't really changed, and save some memory by reusing the inherited
// map in that case.
let initial_values = self.stylist.get_custom_property_initial_values();
self.computed_context.builder.custom_properties = ComputedCustomProperties {
inherited: if self
.computed_context
.inherited_custom_properties()
.inherited ==
self.custom_properties.inherited
{
self.computed_context
.inherited_custom_properties()
.inherited
.clone()
} else {
self.custom_properties.inherited
},
non_inherited: if initial_values.non_inherited == self.custom_properties.non_inherited {
initial_values.non_inherited.clone()
} else {
self.custom_properties.non_inherited
},
};
deferred_custom_properties
}
/// Fully resolve all deferred custom properties, assuming that the incoming context
/// has necessary properties resolved.
pub fn build_deferred(
deferred: CustomPropertiesMap,
stylist: &Stylist,
computed_context: &mut computed::Context,
) {
if deferred.is_empty() {
return;
}
let mut custom_properties = std::mem::take(&mut computed_context.builder.custom_properties);
// Since `CustomPropertiesMap` preserves insertion order, we shouldn't have to worry about
// resolving in a wrong order.
for (k, v) in deferred.iter() {
let Some(v) = v else { continue };
let Some(v) = v.as_universal() else {
unreachable!("Computing should have been deferred!")
};
substitute_references_if_needed_and_apply(
k,
v,
&mut custom_properties,
stylist,
computed_context,
);
}
computed_context.builder.custom_properties = custom_properties;
}
}
/// Resolve all custom properties to either substituted, invalid, or unset
/// (meaning we should use the inherited value).
///
/// It does cycle dependencies removal at the same time as substitution.
fn substitute_all(
custom_properties_map: &mut ComputedCustomProperties,
mut deferred_properties_map: Option<&mut CustomPropertiesMap>,
invalid_non_custom_properties: &mut LonghandIdSet,
has_color_scheme: bool,
seen: &PrecomputedHashSet<&Name>,
references_from_non_custom_properties: &NonCustomReferenceMap<Vec<Name>>,
stylist: &Stylist,
computed_context: &computed::Context,
) {
// The cycle dependencies removal in this function is a variant
// of Tarjan's algorithm. It is mostly based on the pseudo-code
// listed in
// https://en.wikipedia.org/w/index.php?
// title=Tarjan%27s_strongly_connected_components_algorithm&oldid=801728495
#[derive(Clone, Eq, PartialEq, Debug)]
enum VarType {
Custom(Name),
NonCustom(SingleNonCustomReference),
}
/// Struct recording necessary information for each variable.
#[derive(Debug)]
struct VarInfo {
/// The name of the variable. It will be taken to save addref
/// when the corresponding variable is popped from the stack.
/// This also serves as a mark for whether the variable is
/// currently in the stack below.
var: Option<VarType>,
/// If the variable is in a dependency cycle, lowlink represents
/// a smaller index which corresponds to a variable in the same
/// strong connected component, which is known to be accessible
/// from this variable. It is not necessarily the root, though.
lowlink: usize,
}
/// Context struct for traversing the variable graph, so that we can
/// avoid referencing all the fields multiple times.
struct Context<'a, 'b: 'a> {
/// Number of variables visited. This is used as the order index
/// when we visit a new unresolved variable.
count: usize,
/// The map from custom property name to its order index.
index_map: PrecomputedHashMap<Name, usize>,
/// Mapping from a non-custom dependency to its order index.
non_custom_index_map: NonCustomReferenceMap<usize>,
/// Information of each variable indexed by the order index.
var_info: SmallVec<[VarInfo; 5]>,
/// The stack of order index of visited variables. It contains
/// all unfinished strong connected components.
stack: SmallVec<[usize; 5]>,
/// References to non-custom properties in this strongly connected component.
non_custom_references: NonCustomReferences,
/// Whether the builder has seen a non-custom color-scheme reference.
has_color_scheme: bool,
map: &'a mut ComputedCustomProperties,
/// The stylist is used to get registered properties, and to resolve the environment to
/// substitute `env()` variables.
stylist: &'a Stylist,
/// The computed context is used to get inherited custom
/// properties and compute registered custom properties.
computed_context: &'a computed::Context<'b>,
/// Longhand IDs that became invalid due to dependency cycle(s).
invalid_non_custom_properties: &'a mut LonghandIdSet,
/// Properties that cannot yet be substituted. Note we store both inherited and
/// non-inherited properties in the same map, since we need to make sure we iterate through
/// them in the right order.
deferred_properties: Option<&'a mut CustomPropertiesMap>,
}
/// This function combines the traversal for cycle removal and value
/// substitution. It returns either a signal None if this variable
/// has been fully resolved (to either having no reference or being
/// marked invalid), or the order index for the given name.
///
/// When it returns, the variable corresponds to the name would be
/// in one of the following states:
/// * It is still in context.stack, which means it is part of an
/// potentially incomplete dependency circle.
/// * It has been removed from the map. It can be either that the
/// substitution failed, or it is inside a dependency circle.
/// When this function removes a variable from the map because
/// of dependency circle, it would put all variables in the same
/// strong connected component to the set together.
/// * It doesn't have any reference, because either this variable
/// doesn't have reference at all in specified value, or it has
/// been completely resolved.
/// * There is no such variable at all.
fn traverse<'a, 'b>(
var: VarType,
non_custom_references: &NonCustomReferenceMap<Vec<Name>>,
context: &mut Context<'a, 'b>,
) -> Option<usize> {
// Some shortcut checks.
let value = match var {
VarType::Custom(ref name) => {
let registration = context.stylist.get_custom_property_registration(name);
let value = context.map.get(registration, name)?.as_universal()?;
let is_root = context.computed_context.is_root_element();
// We need to keep track of potential non-custom-references even on unregistered
// properties for cycle-detection purposes.
let non_custom_refs = find_non_custom_references(
registration,
value,
context.has_color_scheme,
is_root,
/* include_unregistered = */ true,
);
context.non_custom_references |= non_custom_refs.unwrap_or_default();
let has_dependency = value.references.any_var || non_custom_refs.is_some();
// Nothing to resolve.
if !has_dependency {
debug_assert!(!value.references.any_env, "Should've been handled earlier");
if !registration.syntax.is_universal() {
// We might still need to compute the value if this is not an universal
// registration if we thought this had a dependency before but turned out
// not to be (due to has_color_scheme, for example). Note that if this was
// already computed we would've bailed out in the as_universal() check.
debug_assert!(
registration
.syntax
.dependent_types()
.intersects(DependentDataTypes::COLOR),
"How did an unresolved value get here otherwise?",
);
let value = value.clone();
substitute_references_if_needed_and_apply(
name,
&value,
&mut context.map,
context.stylist,
context.computed_context,
);
}
return None;
}
// Has this variable been visited?
match context.index_map.entry(name.clone()) {
Entry::Occupied(entry) => {
return Some(*entry.get());
},
Entry::Vacant(entry) => {
entry.insert(context.count);
},
}
// Hold a strong reference to the value so that we don't
// need to keep reference to context.map.
Some(value.clone())
},
VarType::NonCustom(ref non_custom) => {
let entry = &mut context.non_custom_index_map[*non_custom];
if let Some(v) = entry {
return Some(*v);
}
*entry = Some(context.count);
None
},
};
// Add new entry to the information table.
let index = context.count;
context.count += 1;
debug_assert_eq!(index, context.var_info.len());
context.var_info.push(VarInfo {
var: Some(var.clone()),
lowlink: index,
});
context.stack.push(index);
let mut self_ref = false;
let mut lowlink = index;
let visit_link =
|var: VarType, context: &mut Context, lowlink: &mut usize, self_ref: &mut bool| {
let next_index = match traverse(var, non_custom_references, context) {
Some(index) => index,
// There is nothing to do if the next variable has been
// fully resolved at this point.
None => {
return;
},
};
let next_info = &context.var_info[next_index];
if next_index > index {
// The next variable has a larger index than us, so it
// must be inserted in the recursive call above. We want
// to get its lowlink.
*lowlink = cmp::min(*lowlink, next_info.lowlink);
} else if next_index == index {
*self_ref = true;
} else if next_info.var.is_some() {
// The next variable has a smaller order index and it is
// in the stack, so we are at the same component.
*lowlink = cmp::min(*lowlink, next_index);
}
};
if let Some(ref v) = value.as_ref() {
debug_assert!(
matches!(var, VarType::Custom(_)),
"Non-custom property has references?"
);
// Visit other custom properties...
// FIXME: Maybe avoid visiting the same var twice if not needed?
for next in &v.references.refs {
if !next.is_var {
continue;
}
visit_link(
VarType::Custom(next.name.clone()),
context,
&mut lowlink,
&mut self_ref,
);
}
// ... Then non-custom properties.
v.references.non_custom_references.for_each(|r| {
visit_link(VarType::NonCustom(r), context, &mut lowlink, &mut self_ref);
});
} else if let VarType::NonCustom(non_custom) = var {
let entry = &non_custom_references[non_custom];
if let Some(deps) = entry.as_ref() {
for d in deps {
// Visit any reference from this non-custom property to custom properties.
visit_link(
VarType::Custom(d.clone()),
context,
&mut lowlink,
&mut self_ref,
);
}
}
}
context.var_info[index].lowlink = lowlink;
if lowlink != index {
// This variable is in a loop, but it is not the root of
// this strong connected component. We simply return for
// now, and the root would remove it from the map.
//
// This cannot be removed from the map here, because
// otherwise the shortcut check at the beginning of this
// function would return the wrong value.
return Some(index);
}
// This is the root of a strong-connected component.
let mut in_loop = self_ref;
let name;
let handle_variable_in_loop = |name: &Name, context: &mut Context<'a, 'b>| {
if context
.non_custom_references
.intersects(NonCustomReferences::FONT_UNITS | NonCustomReferences::ROOT_FONT_UNITS)
{
context
.invalid_non_custom_properties
.insert(LonghandId::FontSize);
}
if context
.non_custom_references
.intersects(NonCustomReferences::LH_UNITS | NonCustomReferences::ROOT_LH_UNITS)
{
context
.invalid_non_custom_properties
.insert(LonghandId::LineHeight);
}
// This variable is in loop. Resolve to invalid.
handle_invalid_at_computed_value_time(name, context.map, context.computed_context);
};
loop {
let var_index = context
.stack
.pop()
.expect("The current variable should still be in stack");
let var_info = &mut context.var_info[var_index];
// We should never visit the variable again, so it's safe
// to take the name away, so that we don't do additional
// reference count.
let var_name = var_info
.var
.take()
.expect("Variable should not be poped from stack twice");
if var_index == index {
name = match var_name {
VarType::Custom(name) => name,
// At the root of this component, and it's a non-custom
// reference - we have nothing to substitute, so
// it's effectively resolved.
VarType::NonCustom(..) => return None,
};
break;
}
if let VarType::Custom(name) = var_name {
// Anything here is in a loop which can traverse to the
// variable we are handling, so it's invalid at
// computed-value time.
handle_variable_in_loop(&name, context);
}
in_loop = true;
}
// We've gotten to the root of this strongly connected component, so clear
// whether or not it involved non-custom references.
// It's fine to track it like this, because non-custom properties currently
// being tracked can only participate in any loop only once.
if in_loop {
handle_variable_in_loop(&name, context);
context.non_custom_references = NonCustomReferences::default();
return None;
}
if let Some(ref v) = value {
let registration = context.stylist.get_custom_property_registration(&name);
let mut defer = false;
if let Some(ref mut deferred) = context.deferred_properties {
// We need to defer this property if it has a non-custom property dependency, or
// any variable that it references is already deferred.
defer = find_non_custom_references(
registration,
v,
context.has_color_scheme,
context.computed_context.is_root_element(),
/* include_unregistered = */ false,
)
.is_some() ||
v.references.refs.iter().any(|reference| {
reference.is_var && deferred.get(&reference.name).is_some()
});
if defer {
let value = ComputedRegisteredValue::universal(Arc::clone(v));
deferred.insert(&name, value);
context.map.remove(registration, &name);
}
}
// If there are no var references we should already be computed and substituted by now.
if !defer && v.references.any_var {
substitute_references_if_needed_and_apply(
&name,
v,
&mut context.map,
context.stylist,
context.computed_context,
);
}
}
context.non_custom_references = NonCustomReferences::default();
// All resolved, so return the signal value.
None
}
// Note that `seen` doesn't contain names inherited from our parent, but
// those can't have variable references (since we inherit the computed
// variables) so we don't want to spend cycles traversing them anyway.
for name in seen {
let mut context = Context {
count: 0,
index_map: PrecomputedHashMap::default(),
non_custom_index_map: NonCustomReferenceMap::default(),
stack: SmallVec::new(),
var_info: SmallVec::new(),
map: custom_properties_map,
non_custom_references: NonCustomReferences::default(),
has_color_scheme,
stylist,
computed_context,
invalid_non_custom_properties,
deferred_properties: deferred_properties_map.as_deref_mut(),
};
traverse(
VarType::Custom((*name).clone()),
references_from_non_custom_properties,
&mut context,
);
}
}
// See https://drafts.csswg.org/css-variables-2/#invalid-at-computed-value-time
fn handle_invalid_at_computed_value_time(
name: &Name,
custom_properties: &mut ComputedCustomProperties,
computed_context: &computed::Context,
) {
let stylist = computed_context.style().stylist.unwrap();
let registration = stylist.get_custom_property_registration(&name);
if !registration.syntax.is_universal() {
// For the root element, inherited maps are empty. We should just
// use the initial value if any, rather than removing the name.
if registration.inherits() && !computed_context.is_root_element() {
let inherited = computed_context.inherited_custom_properties();
if let Some(value) = inherited.get(registration, name) {
custom_properties.insert(registration, name, value.clone());
return;
}
} else if let Some(ref initial_value) = registration.initial_value {
if let Ok(initial_value) = compute_value(
&initial_value.css,
&initial_value.url_data,
registration,
computed_context,
) {
custom_properties.insert(registration, name, initial_value);
return;
}
}
}
custom_properties.remove(registration, name);
}
/// Replace `var()` and `env()` functions in a pre-existing variable value.
fn substitute_references_if_needed_and_apply(
name: &Name,
value: &Arc<VariableValue>,
custom_properties: &mut ComputedCustomProperties,
stylist: &Stylist,
computed_context: &computed::Context,
) {
let registration = stylist.get_custom_property_registration(&name);
if !value.has_references() && registration.syntax.is_universal() {
// Trivial path: no references and no need to compute the value, just apply it directly.
let computed_value = ComputedRegisteredValue::universal(Arc::clone(value));
custom_properties.insert(registration, name, computed_value);
return;
}
let inherited = computed_context.inherited_custom_properties();
let url_data = &value.url_data;
let value = match substitute_internal(
value,
custom_properties,
stylist,
registration,
computed_context,
) {
Ok(v) => v,
Err(..) => {
handle_invalid_at_computed_value_time(name, custom_properties, computed_context);
return;
},
}
.into_value(url_data);
// If variable fallback results in a wide keyword, deal with it now.
{
let css = value.to_variable_value().css;
let mut input = ParserInput::new(&css);
let mut input = Parser::new(&mut input);
if let Ok(kw) = input.try_parse(CSSWideKeyword::parse) {
// TODO: It's unclear what this should do for revert / revert-layer, see
// https://github.com/w3c/csswg-drafts/issues/9131. For now treating as unset
// seems fine?
match (
kw,
registration.inherits(),
computed_context.is_root_element(),
) {
(CSSWideKeyword::Initial, _, _) |
(CSSWideKeyword::Revert, false, _) |
(CSSWideKeyword::RevertLayer, false, _) |
(CSSWideKeyword::Unset, false, _) |
(CSSWideKeyword::Revert, true, true) |
(CSSWideKeyword::RevertLayer, true, true) |
(CSSWideKeyword::Unset, true, true) |
(CSSWideKeyword::Inherit, _, true) => {
remove_and_insert_initial_value(name, registration, custom_properties);
},
(CSSWideKeyword::Revert, true, false) |
(CSSWideKeyword::RevertLayer, true, false) |
(CSSWideKeyword::Inherit, _, false) |
(CSSWideKeyword::Unset, true, false) => {
match inherited.get(registration, name) {
Some(value) => {
custom_properties.insert(registration, name, value.clone());
},
None => {
custom_properties.remove(registration, name);
},
};
},
}
return;
}
}
custom_properties.insert(registration, name, value);
}
enum Substitution<'a> {
Universal(UniversalSubstitution<'a>),
Computed(ComputedRegisteredValue),
}
impl<'a> Default for Substitution<'a> {
fn default() -> Self {
Self::Universal(UniversalSubstitution::default())
}
}
#[derive(Default)]
struct UniversalSubstitution<'a> {
css: Cow<'a, str>,
first_token_type: TokenSerializationType,
last_token_type: TokenSerializationType,
}
impl<'a> UniversalSubstitution<'a> {
fn from_value(v: VariableValue) -> Self {
UniversalSubstitution {
css: Cow::from(v.css),
first_token_type: v.first_token_type,
last_token_type: v.last_token_type,
}
}
}
impl<'a> Substitution<'a> {
fn new(
css: &'a str,
first_token_type: TokenSerializationType,
last_token_type: TokenSerializationType,
) -> Self {
Self::Universal(UniversalSubstitution {
css: Cow::Borrowed(css),
first_token_type,
last_token_type,
})
}
fn into_universal(self) -> UniversalSubstitution<'a> {
match self {
Substitution::Universal(substitution) => substitution,
Substitution::Computed(computed) => {
UniversalSubstitution::from_value(computed.to_variable_value())
},
}
}
fn from_value(v: VariableValue) -> Self {
debug_assert!(
!v.has_references(),
"Computed values shouldn't have references"
);
let substitution = UniversalSubstitution::from_value(v);
Self::Universal(substitution)
}
fn into_value(self, url_data: &UrlExtraData) -> ComputedRegisteredValue {
match self {
Substitution::Universal(substitution) => {
let value = Arc::new(VariableValue {
css: substitution.css.into_owned(),
first_token_type: substitution.first_token_type,
last_token_type: substitution.last_token_type,
url_data: url_data.clone(),
references: Default::default(),
});
ComputedRegisteredValue::universal(value)
},
Substitution::Computed(computed) => computed,
}
}
}
fn compute_value(
css: &str,
url_data: &UrlExtraData,
registration: &PropertyRegistrationData,
computed_context: &computed::Context,
) -> Result<ComputedRegisteredValue, ()> {
debug_assert!(!registration.syntax.is_universal());
let mut input = ParserInput::new(&css);
let mut input = Parser::new(&mut input);
SpecifiedRegisteredValue::compute(
&mut input,
registration,
url_data,
computed_context,
AllowComputationallyDependent::Yes,
)
}
/// Removes the named registered custom property and inserts its uncomputed initial value.
fn remove_and_insert_initial_value(
name: &Name,
registration: &PropertyRegistrationData,
custom_properties: &mut ComputedCustomProperties,
) {
custom_properties.remove(registration, name);
if let Some(ref initial_value) = registration.initial_value {
let value = ComputedRegisteredValue::universal(Arc::clone(initial_value));
custom_properties.insert(registration, name, value);
}
}
fn do_substitute_chunk<'a>(
css: &'a str,
start: usize,
end: usize,
first_token_type: TokenSerializationType,
last_token_type: TokenSerializationType,
url_data: &UrlExtraData,
custom_properties: &'a ComputedCustomProperties,
registration: &PropertyRegistrationData,
stylist: &Stylist,
computed_context: &computed::Context,
references: &mut std::iter::Peekable<std::slice::Iter<VarOrEnvReference>>,
) -> Result<Substitution<'a>, ()> {
if start == end {
// Empty string. Easy.
return Ok(Substitution::default());
}
// Easy case: no references involved.
if references
.peek()
.map_or(true, |reference| reference.end > end)
{
let result = &css[start..end];
if !registration.syntax.is_universal() {
let computed_value = compute_value(result, url_data, registration, computed_context)?;
return Ok(Substitution::Computed(computed_value));
}
return Ok(Substitution::new(result, first_token_type, last_token_type));
}
let mut substituted = ComputedValue::empty(url_data);
let mut next_token_type = first_token_type;
let mut cur_pos = start;
while let Some(reference) = references.next_if(|reference| reference.end <= end) {
if reference.start != cur_pos {
substituted.push(
&css[cur_pos..reference.start],
next_token_type,
reference.prev_token_type,
)?;
}
let substitution = substitute_one_reference(
css,
url_data,
custom_properties,
reference,
stylist,
computed_context,
references,
)?;
let substitution = substitution.into_universal();
// Optimize the property: var(--...) case to avoid allocating at all.
if reference.start == start && reference.end == end && registration.syntax.is_universal() {
return Ok(Substitution::Universal(substitution));
}
substituted.push(
&substitution.css,
substitution.first_token_type,
substitution.last_token_type,
)?;
next_token_type = reference.next_token_type;
cur_pos = reference.end;
}
// Push the rest of the value if needed.
if cur_pos != end {
substituted.push(&css[cur_pos..end], next_token_type, last_token_type)?;
}
if !registration.syntax.is_universal() {
let computed_value =
compute_value(&substituted.css, url_data, registration, computed_context)?;
return Ok(Substitution::Computed(computed_value));
}
Ok(Substitution::from_value(substituted))
}
fn substitute_one_reference<'a>(
css: &'a str,
url_data: &UrlExtraData,
custom_properties: &'a ComputedCustomProperties,
reference: &VarOrEnvReference,
stylist: &Stylist,
computed_context: &computed::Context,
references: &mut std::iter::Peekable<std::slice::Iter<VarOrEnvReference>>,
) -> Result<Substitution<'a>, ()> {
let registration;
if reference.is_var {
registration = stylist.get_custom_property_registration(&reference.name);
if let Some(v) = custom_properties.get(registration, &reference.name) {
#[cfg(debug_assertions)]
debug_assert!(v.is_parsed(registration), "Should be already computed");
if registration.syntax.is_universal() {
// Skip references that are inside the outer variable (in fallback for example).
while references
.next_if(|next_ref| next_ref.end <= reference.end)
.is_some()
{}
} else {
// We need to validate the fallback if any, since invalid fallback should
// invalidate the whole variable.
if let Some(ref fallback) = reference.fallback {
let _ = do_substitute_chunk(
css,
fallback.start.get(),
reference.end - 1, // Don't include the closing parenthesis.
fallback.first_token_type,
fallback.last_token_type,
url_data,
custom_properties,
registration,
stylist,
computed_context,
references,
)?;
}
}
return Ok(Substitution::Computed(v.clone()));
}
} else {
registration = PropertyRegistrationData::unregistered();
let device = stylist.device();
if let Some(v) = device.environment().get(&reference.name, device, url_data) {
while references
.next_if(|next_ref| next_ref.end <= reference.end)
.is_some()
{}
return Ok(Substitution::from_value(v));
}
}
let Some(ref fallback) = reference.fallback else {
return Err(());
};
do_substitute_chunk(
css,
fallback.start.get(),
reference.end - 1, // Skip the closing parenthesis of the reference value.
fallback.first_token_type,
fallback.last_token_type,
url_data,
custom_properties,
registration,
stylist,
computed_context,
references,
)
}
/// Replace `var()` and `env()` functions. Return `Err(..)` for invalid at computed time.
fn substitute_internal<'a>(
variable_value: &'a VariableValue,
custom_properties: &'a ComputedCustomProperties,
stylist: &Stylist,
registration: &PropertyRegistrationData,
computed_context: &computed::Context,
) -> Result<Substitution<'a>, ()> {
let mut refs = variable_value.references.refs.iter().peekable();
do_substitute_chunk(
&variable_value.css,
/* start = */ 0,
/* end = */ variable_value.css.len(),
variable_value.first_token_type,
variable_value.last_token_type,
&variable_value.url_data,
custom_properties,
registration,
stylist,
computed_context,
&mut refs,
)
}
/// Replace var() and env() functions, returning the resulting CSS string.
pub fn substitute<'a>(
variable_value: &'a VariableValue,
custom_properties: &'a ComputedCustomProperties,
stylist: &Stylist,
computed_context: &computed::Context,
) -> Result<Cow<'a, str>, ()> {
debug_assert!(variable_value.has_references());
let v = substitute_internal(
variable_value,
custom_properties,
stylist,
PropertyRegistrationData::unregistered(),
computed_context,
)?;
let v = v.into_universal();
Ok(v.css)
}