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
|
/*
* Copyright (C) 2006-2023 Apple Inc. All rights reserved.
* Copyright (C) 2019 Adobe. All rights reserved.
* Copyright (C) 2014 Google. All rights reserved.
* Copyright (C) 2020 Igalia S.L.
*
* Portions are Copyright (C) 1998 Netscape Communications Corporation.
*
* Other contributors:
* Robert O'Callahan <roc+@cs.cmu.edu>
* David Baron <dbaron@fas.harvard.edu>
* Christian Biesinger <cbiesinger@web.de>
* Randall Jesup <rjesup@wgate.com>
* Roland Mainz <roland.mainz@informatik.med.uni-giessen.de>
* Josh Soref <timeless@mac.com>
* Boris Zbarsky <bzbarsky@mit.edu>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*
* Alternatively, the contents of this file may be used under the terms
* of either the Mozilla Public License Version 1.1, found at
* http://www.mozilla.org/MPL/ (the "MPL") or the GNU General Public
* License Version 2.0, found at http://www.fsf.org/copyleft/gpl.html
* (the "GPL"), in which case the provisions of the MPL or the GPL are
* applicable instead of those above. If you wish to allow use of your
* version of this file only under the terms of one of those two
* licenses (the MPL or the GPL) and not to allow others to use your
* version of this file under the LGPL, indicate your decision by
* deletingthe provisions above and replace them with the notice and
* other provisions required by the MPL or the GPL, as the case may be.
* If you do not delete the provisions above, a recipient may use your
* version of this file under any of the LGPL, the MPL or the GPL.
*/
#include "config.h"
#include "RenderLayerScrollableArea.h"
#include "AnchorPositionEvaluator.h"
#include "Chrome.h"
#include "DebugPageOverlays.h"
#include "DocumentInlines.h"
#include "Editor.h"
#include "ElementRuleCollector.h"
#include "EventHandler.h"
#include "FocusController.h"
#include "FrameSelection.h"
#include "HTMLBodyElement.h"
#include "HTMLHtmlElement.h"
#include "HitTestResult.h"
#include "InspectorInstrumentation.h"
#include "LineClampValue.h"
#include "Logging.h"
#include "RenderBoxInlines.h"
#include "RenderBoxModelObjectInlines.h"
#include "RenderElementInlines.h"
#include "RenderFlexibleBox.h"
#include "RenderGeometryMap.h"
#include "RenderLayerBacking.h"
#include "RenderLayerCompositor.h"
#include "RenderMarquee.h"
#include "RenderScrollbar.h"
#include "RenderScrollbarPart.h"
#include "RenderStyleInlines.h"
#include "RenderView.h"
#include "ScrollAnimator.h"
#include "ScrollbarTheme.h"
#include "ScrollbarsController.h"
#include "ScrollingCoordinator.h"
#include "ShadowRoot.h"
#include <wtf/SetForScope.h>
#include <wtf/TZoneMallocInlines.h>
#include <wtf/text/MakeString.h>
namespace WebCore {
WTF_MAKE_TZONE_ALLOCATED_IMPL(RenderLayerScrollableArea);
RenderLayerScrollableArea::RenderLayerScrollableArea(RenderLayer& layer)
: m_layer(layer)
{
auto& renderer = m_layer.renderer();
if (renderer.document().settings().cssScrollAnchoringEnabled() && !is<HTMLHtmlElement>(renderer.element()) && !is<HTMLBodyElement>(renderer.element()))
m_scrollAnchoringController = WTF::makeUnique<ScrollAnchoringController>(*this);
}
RenderLayerScrollableArea::~RenderLayerScrollableArea()
{
}
void RenderLayerScrollableArea::clear()
{
auto& renderer = m_layer.renderer();
if (m_registeredScrollableArea)
renderer.view().protectedFrameView()->removeScrollableArea(this);
if (m_isRegisteredForAnimatedScroll) {
renderer.view().protectedFrameView()->removeScrollableAreaForAnimatedScroll(this);
m_isRegisteredForAnimatedScroll = false;
}
#if ENABLE(IOS_TOUCH_EVENTS)
unregisterAsTouchEventListenerForScrolling();
#endif
if (RefPtr element = renderer.element())
element->setSavedLayerScrollPosition(m_scrollPosition);
destroyScrollbar(ScrollbarOrientation::Horizontal);
destroyScrollbar(ScrollbarOrientation::Vertical);
clearScrollCorner();
clearResizer();
}
void RenderLayerScrollableArea::restoreScrollPosition()
{
RefPtr element = m_layer.renderer().element();
if (!element)
return;
if (m_layer.renderBox()) {
// We save and restore only the scrollOffset as the other scroll values are recalculated.
m_scrollPosition = element->savedLayerScrollPosition();
if (!m_scrollPosition.isZero())
scrollAnimator().setCurrentPosition(m_scrollPosition);
}
element->setSavedLayerScrollPosition({ });
}
bool RenderLayerScrollableArea::shouldPlaceVerticalScrollbarOnLeft() const
{
return m_layer.renderer().shouldPlaceVerticalScrollbarOnLeft();
}
#if ENABLE(IOS_TOUCH_EVENTS)
bool RenderLayerScrollableArea::handleTouchEvent(const PlatformTouchEvent& touchEvent)
{
// If we have accelerated scrolling, let the scrolling be handled outside of WebKit.
if (hasCompositedScrollableOverflow())
return false;
return ScrollableArea::handleTouchEvent(touchEvent);
}
void RenderLayerScrollableArea::registerAsTouchEventListenerForScrolling()
{
auto& renderer = m_layer.renderer();
if (!renderer.element() || m_registeredAsTouchEventListenerForScrolling)
return;
renderer.document().addTouchEventHandler(*renderer.element());
m_registeredAsTouchEventListenerForScrolling = true;
}
void RenderLayerScrollableArea::unregisterAsTouchEventListenerForScrolling()
{
auto& renderer = m_layer.renderer();
if (!renderer.element() || !m_registeredAsTouchEventListenerForScrolling)
return;
renderer.document().removeTouchEventHandler(*renderer.element());
m_registeredAsTouchEventListenerForScrolling = false;
}
#endif // ENABLE(IOS_TOUCH_EVENTS)
IntRect RenderLayerScrollableArea::scrollableAreaBoundingBox(bool* isInsideFixed) const
{
return m_layer.renderer().absoluteBoundingBoxRect(/* useTransforms */ true, isInsideFixed);
}
bool RenderLayerScrollableArea::isUserScrollInProgress() const
{
if (!scrollsOverflow())
return false;
if (RefPtr scrollingCoordinator = m_layer.protectedPage()->scrollingCoordinator()) {
if (scrollingCoordinator->isUserScrollInProgress(scrollingNodeID()))
return true;
}
if (auto scrollAnimator = existingScrollAnimator())
return scrollAnimator->isUserScrollInProgress();
return false;
}
bool RenderLayerScrollableArea::isRubberBandInProgress() const
{
#if HAVE(RUBBER_BANDING)
if (!scrollsOverflow())
return false;
if (RefPtr scrollingCoordinator = m_layer.protectedPage()->scrollingCoordinator()) {
if (scrollingCoordinator->isRubberBandInProgress(scrollingNodeID()))
return true;
}
if (auto scrollAnimator = existingScrollAnimator())
return scrollAnimator->isRubberBandInProgress();
#endif
return false;
}
bool RenderLayerScrollableArea::forceUpdateScrollbarsOnMainThreadForPerformanceTesting() const
{
return m_layer.renderer().settings().scrollingPerformanceTestingEnabled();
}
// FIXME: this is only valid after we've made layers.
bool RenderLayerScrollableArea::usesAsyncScrolling() const
{
return m_layer.compositor().useCoordinatedScrollingForLayer(m_layer);
}
void RenderLayerScrollableArea::setPostLayoutScrollPosition(std::optional<ScrollPosition> position)
{
m_postLayoutScrollPosition = position;
}
void RenderLayerScrollableArea::applyPostLayoutScrollPositionIfNeeded()
{
if (!m_postLayoutScrollPosition)
return;
scrollToOffset(scrollOffsetFromPosition(m_postLayoutScrollPosition.value()));
m_postLayoutScrollPosition = std::nullopt;
}
void RenderLayerScrollableArea::scrollToXPosition(int x, const ScrollPositionChangeOptions& options)
{
ScrollPosition position(x, m_scrollPosition.y());
setScrollPosition(position, options);
}
void RenderLayerScrollableArea::scrollToYPosition(int y, const ScrollPositionChangeOptions& options)
{
ScrollPosition position(m_scrollPosition.x(), y);
setScrollPosition(position, options);
}
void RenderLayerScrollableArea::setScrollPosition(const ScrollPosition& position, const ScrollPositionChangeOptions& options)
{
scrollToOffset(scrollOffsetFromPosition(position), options);
}
ScrollOffset RenderLayerScrollableArea::clampScrollOffset(const ScrollOffset& scrollOffset) const
{
return scrollOffset.constrainedBetween(minimumScrollOffset(), maximumScrollOffset());
}
bool RenderLayerScrollableArea::requestScrollToPosition(const ScrollPosition& position, const ScrollPositionChangeOptions& options)
{
#if ENABLE(ASYNC_SCROLLING)
LOG_WITH_STREAM(Scrolling, stream << "RenderLayerScrollableArea::requestScrollToPosition " << position << " options " << options);
if (RefPtr scrollingCoordinator = m_layer.protectedPage()->scrollingCoordinator())
return scrollingCoordinator->requestScrollToPosition(*this, position, options);
#else
UNUSED_PARAM(position);
UNUSED_PARAM(options);
#endif
return false;
}
bool RenderLayerScrollableArea::requestStartKeyboardScrollAnimation(const KeyboardScroll& scrollData)
{
if (RefPtr scrollingCoordinator = m_layer.protectedPage()->scrollingCoordinator())
return scrollingCoordinator->requestStartKeyboardScrollAnimation(*this, scrollData);
return false;
}
bool RenderLayerScrollableArea::requestStopKeyboardScrollAnimation(bool immediate)
{
if (RefPtr scrollingCoordinator = m_layer.protectedPage()->scrollingCoordinator())
return scrollingCoordinator->requestStopKeyboardScrollAnimation(*this, immediate);
return false;
}
void RenderLayerScrollableArea::stopAsyncAnimatedScroll()
{
#if ENABLE(ASYNC_SCROLLING)
LOG_WITH_STREAM(Scrolling, stream << m_layer << " stopAsyncAnimatedScroll");
if (RefPtr scrollingCoordinator = m_layer.protectedPage()->scrollingCoordinator())
return scrollingCoordinator->stopAnimatedScroll(*this);
#endif
}
ScrollOffset RenderLayerScrollableArea::scrollToOffset(const ScrollOffset& scrollOffset, const ScrollPositionChangeOptions& options)
{
if (scrollAnimationStatus() == ScrollAnimationStatus::Animating) {
scrollAnimator().cancelAnimations();
stopAsyncAnimatedScroll();
}
ScrollOffset clampedScrollOffset = options.clamping == ScrollClamping::Clamped ? clampScrollOffset(scrollOffset) : scrollOffset;
if (clampedScrollOffset == this->scrollOffset())
return clampedScrollOffset;
auto previousScrollType = currentScrollType();
setCurrentScrollType(options.type);
ScrollOffset snappedOffset = ceiledIntPoint(scrollAnimator().scrollOffsetAdjustedForSnapping(clampedScrollOffset, options.snapPointSelectionMethod));
auto snappedPosition = scrollPositionFromOffset(snappedOffset);
if (options.animated == ScrollIsAnimated::Yes) {
registerScrollableAreaForAnimatedScroll();
ScrollableArea::scrollToPositionWithAnimation(snappedPosition, options);
} else if (!requestScrollToPosition(snappedPosition, options))
scrollToPositionWithoutAnimation(snappedPosition, options.clamping);
setCurrentScrollType(previousScrollType);
return snappedOffset;
}
void RenderLayerScrollableArea::scrollTo(const ScrollPosition& position)
{
RenderBox* box = m_layer.renderBox();
if (!box)
return;
LOG_WITH_STREAM(Scrolling, stream << "RenderLayerScrollableArea [" << (scrollingNodeID() ? scrollingNodeID()->toString() : ""_str) << "] scrollTo " << position << " from " << m_scrollPosition << " (is user scroll " << (currentScrollType() == ScrollType::User) << ")");
ScrollPosition newPosition = position;
if (!box->isHTMLMarquee()) {
// Ensure that the dimensions will be computed if they need to be (for overflow:hidden blocks).
if (m_scrollDimensionsDirty)
computeScrollDimensions();
}
if (m_scrollPosition == newPosition && scrollAnimationStatus() == ScrollAnimationStatus::NotAnimating) {
// FIXME: Nothing guarantees we get a scrollTo() with an unchanged position at the end of a user gesture.
// The ScrollingCoordinator probably needs to message the main thread when a gesture ends.
if (requiresScrollPositionReconciliation()) {
m_layer.setNeedsCompositingGeometryUpdate();
updateCompositingLayersAfterScroll();
}
return;
}
m_scrollPosition = newPosition;
m_layer.setSelfAndDescendantsNeedPositionUpdate();
auto& renderer = m_layer.renderer();
if (RefPtr element = renderer.element())
element->setSavedLayerScrollPosition(m_scrollPosition);
RenderView& view = renderer.view();
// Update the positions of our child layers (if needed as only fixed layers should be impacted by a scroll).
// We don't update compositing layers, because we need to do a deep update from the compositing ancestor.
if (!view.frameView().layoutContext().isInRenderTreeLayout()) {
Style::AnchorPositionEvaluator::updateSnapshottedScrollOffsets(m_layer.renderer().protectedDocument());
// If we're in the middle of layout, we'll just update layers once layout has finished.
view.protectedFrameView()->updateLayerPositionsAfterOverflowScroll(m_layer);
if (!m_updatingMarqueePosition) {
// Avoid updating compositing layers if, higher on the stack, we're already updating layer
// positions. Updating layer positions requires a full walk of up-to-date RenderLayers, and
// in this case we're still updating their positions; we'll update compositing layers later
// when that completes.
if (usesCompositedScrolling()) {
m_layer.setNeedsCompositingGeometryUpdate();
// Scroll position can affect the location of a composited descendant (which may be a sibling in z-order),
// so trigger a descendant walk from the stacking context.
if (auto* paintParent = m_layer.stackingContext())
paintParent->setDescendantsNeedUpdateBackingAndHierarchyTraversal();
}
updateCompositingLayersAfterScroll();
}
// Update regions, scrolling may change the clip of a particular region.
renderer.protectedDocument()->invalidateRenderingDependentRegions();
DebugPageOverlays::didLayout(renderer.protectedFrame());
}
Ref frame = renderer.frame();
CheckedPtr repaintContainer = renderer.containerForRepaint().renderer;
// The caret rect needs to be invalidated after scrolling
frame->selection().setCaretRectNeedsUpdate();
auto rectForRepaint = valueOrCompute(layer().cachedClippedOverflowRect(), [&] { return renderer.clippedOverflowRectForRepaint(repaintContainer.get()); });
FloatQuad quadForFakeMouseMoveEvent = FloatQuad(rectForRepaint);
if (repaintContainer)
quadForFakeMouseMoveEvent = repaintContainer->localToAbsoluteQuad(quadForFakeMouseMoveEvent);
frame->eventHandler().dispatchFakeMouseMoveEventSoonInQuad(quadForFakeMouseMoveEvent);
bool requiresRepaint = true;
if (usesCompositedScrolling()) {
m_layer.setNeedsCompositingGeometryUpdate();
m_layer.setDescendantsNeedUpdateBackingAndHierarchyTraversal();
requiresRepaint = m_layer.backing()->needsRepaintOnCompositedScroll();
}
auto isScrolledBy = [](RenderObject& renderer, RenderLayer& scrollableLayer) {
auto layer = renderer.enclosingLayer();
return layer && layer->ancestorLayerIsInContainingBlockChain(scrollableLayer);
};
// Just schedule a full repaint of our object.
if (requiresRepaint) {
renderer.repaintUsingContainer(repaintContainer.get(), rectForRepaint);
// We also have to repaint any descendant composited layers that have fixed backgrounds.
if (auto slowRepaintObjects = view.frameView().slowRepaintObjects()) {
for (auto& renderer : *slowRepaintObjects) {
if (isScrolledBy(renderer, m_layer))
renderer.repaint();
}
}
}
// Schedule the scroll and scroll-related DOM events.
if (RefPtr element = renderer.element())
element->protectedDocument()->addPendingScrollEventTarget(*element);
if (scrollsOverflow())
view.protectedFrameView()->didChangeScrollOffset();
view.protectedFrameView()->viewportContentsChanged();
frame->protectedEditor()->renderLayerDidScroll(m_layer);
}
void RenderLayerScrollableArea::updateCompositingLayersAfterScroll()
{
if (m_layer.compositor().hasContentCompositingLayers()) {
// Our stacking container is guaranteed to contain all of our descendants that may need
// repositioning, so update compositing layers from there.
if (RenderLayer* compositingAncestor = m_layer.stackingContext()->enclosingCompositingLayer()) {
if (usesCompositedScrolling())
m_layer.compositor().updateCompositingLayers(CompositingUpdateType::OnCompositedScroll, compositingAncestor);
else {
// FIXME: would be nice to only dirty layers whose positions were affected by scrolling.
compositingAncestor->setDescendantsNeedUpdateBackingAndHierarchyTraversal();
m_layer.compositor().updateCompositingLayers(CompositingUpdateType::OnScroll, compositingAncestor);
}
}
}
}
int RenderLayerScrollableArea::scrollWidth() const
{
ASSERT(m_layer.renderBox());
if (m_scrollDimensionsDirty)
const_cast<RenderLayerScrollableArea*>(this)->computeScrollDimensions();
// FIXME: This should use snappedIntSize() instead with absolute coordinates.
return m_scrollWidth;
}
int RenderLayerScrollableArea::scrollHeight() const
{
ASSERT(m_layer.renderBox());
if (m_scrollDimensionsDirty)
const_cast<RenderLayerScrollableArea*>(this)->computeScrollDimensions();
// FIXME: This should use snappedIntSize() instead with absolute coordinates.
return m_scrollHeight;
}
void RenderLayerScrollableArea::updateMarqueePosition()
{
if (!m_marquee)
return;
// FIXME: would like to use SetForScope<> but it doesn't work with bitfields.
bool oldUpdatingMarqueePosition = m_updatingMarqueePosition;
m_updatingMarqueePosition = true;
m_marquee->updateMarqueePosition();
m_updatingMarqueePosition = oldUpdatingMarqueePosition;
}
void RenderLayerScrollableArea::createOrDestroyMarquee()
{
auto& renderer = m_layer.renderer();
if (renderer.isHTMLMarquee() && renderer.style().marqueeBehavior() != MarqueeBehavior::None && renderer.isRenderBox()) {
if (!m_marquee)
m_marquee = makeUnique<RenderMarquee>(&m_layer);
m_marquee->updateMarqueeStyle();
} else if (m_marquee)
m_marquee = nullptr;
}
bool RenderLayerScrollableArea::scrollsOverflow() const
{
auto* renderer = dynamicDowncast<RenderBox>(m_layer.renderer());
return renderer && renderer->scrollsOverflow();
}
bool RenderLayerScrollableArea::canUseCompositedScrolling() const
{
auto& renderer = m_layer.renderer();
bool isVisible = renderer.style().usedVisibility() == Visibility::Visible;
if (renderer.settings().asyncOverflowScrollingEnabled())
return isVisible && scrollsOverflow() && !m_layer.isInsideSVGForeignObject();
#if PLATFORM(IOS_FAMILY) && ENABLE(OVERFLOW_SCROLLING_TOUCH)
return isVisible && scrollsOverflow() && renderer.style().useTouchOverflowScrolling();
#else
return false;
#endif
}
void RenderLayerScrollableArea::setScrollOffset(const ScrollOffset& offset)
{
scrollTo(scrollPositionFromOffset(offset));
}
std::optional<ScrollingNodeID> RenderLayerScrollableArea::scrollingNodeID() const
{
if (!m_layer.isComposited())
return std::nullopt;
return m_layer.backing()->scrollingNodeIDForRole(ScrollCoordinationRole::Scrolling);
}
bool RenderLayerScrollableArea::handleWheelEventForScrolling(const PlatformWheelEvent& wheelEvent, std::optional<WheelScrollGestureState> gestureState)
{
if (!isScrollableOrRubberbandable())
return false;
#if ENABLE(ASYNC_SCROLLING)
if (usesAsyncScrolling() && scrollingNodeID()) {
if (RefPtr scrollingCoordinator = m_layer.protectedPage()->scrollingCoordinator()) {
auto result = scrollingCoordinator->handleWheelEventForScrolling(wheelEvent, *scrollingNodeID(), gestureState);
if (!result.needsMainThreadProcessing())
return result.wasHandled;
}
}
#endif
return ScrollableArea::handleWheelEventForScrolling(wheelEvent, gestureState);
}
IntRect RenderLayerScrollableArea::visibleContentRectInternal(VisibleContentRectIncludesScrollbars scrollbarInclusion, VisibleContentRectBehavior) const
{
IntSize scrollbarSpace;
if (showsOverflowControls() && scrollbarInclusion == VisibleContentRectIncludesScrollbars::Yes)
scrollbarSpace = scrollbarIntrusion();
auto visibleSize = this->visibleSize();
return { scrollPosition(), { std::max(0, visibleSize.width() - scrollbarSpace.width()), std::max(0, visibleSize.height() - scrollbarSpace.height()) } };
}
IntSize RenderLayerScrollableArea::overhangAmount() const
{
#if HAVE(RUBBER_BANDING)
auto& renderer = m_layer.renderer();
if (!renderer.settings().rubberBandingForSubScrollableRegionsEnabled())
return IntSize();
IntSize stretch;
// FIXME: use maximumScrollOffset(), or just move this to ScrollableArea.
ScrollOffset scrollOffset = scrollOffsetFromPosition(scrollPosition());
auto reachableSize = reachableTotalContentsSize();
if (scrollOffset.y() < 0)
stretch.setHeight(scrollOffset.y());
else if (reachableSize.height() && scrollOffset.y() > reachableSize.height() - visibleHeight())
stretch.setHeight(scrollOffset.y() - (reachableSize.height() - visibleHeight()));
if (scrollOffset.x() < 0)
stretch.setWidth(scrollOffset.x());
else if (reachableSize.width() && scrollOffset.x() > reachableSize.width() - visibleWidth())
stretch.setWidth(scrollOffset.x() - (reachableSize.width() - visibleWidth()));
return stretch;
#else
return IntSize();
#endif
}
IntRect RenderLayerScrollableArea::scrollCornerRect() const
{
return overflowControlsRects().scrollCorner;
}
bool RenderLayerScrollableArea::isScrollCornerVisible() const
{
ASSERT(m_layer.renderer().isRenderBox());
return !scrollCornerRect().isEmpty();
}
IntRect RenderLayerScrollableArea::convertFromScrollbarToContainingView(const Scrollbar& scrollbar, const IntRect& scrollbarRect) const
{
auto& renderer = m_layer.renderer();
IntRect rect = scrollbarRect;
rect.move(scrollbarOffset(scrollbar));
return renderer.view().protectedFrameView()->convertFromRendererToContainingView(&renderer, rect);
}
IntRect RenderLayerScrollableArea::convertFromContainingViewToScrollbar(const Scrollbar& scrollbar, const IntRect& parentRect) const
{
auto& renderer = m_layer.renderer();
IntRect rect = renderer.view().protectedFrameView()->convertFromContainingViewToRenderer(&renderer, parentRect);
rect.move(-scrollbarOffset(scrollbar));
return rect;
}
IntPoint RenderLayerScrollableArea::convertFromScrollbarToContainingView(const Scrollbar& scrollbar, const IntPoint& scrollbarPoint) const
{
auto& renderer = m_layer.renderer();
IntPoint point = scrollbarPoint;
point.move(scrollbarOffset(scrollbar));
return renderer.view().protectedFrameView()->convertFromRendererToContainingView(&renderer, point);
}
IntPoint RenderLayerScrollableArea::convertFromContainingViewToScrollbar(const Scrollbar& scrollbar, const IntPoint& parentPoint) const
{
auto& renderer = m_layer.renderer();
IntPoint point = renderer.view().protectedFrameView()->convertFromContainingViewToRenderer(&renderer, parentPoint);
point.move(-scrollbarOffset(scrollbar));
return point;
}
IntSize RenderLayerScrollableArea::visibleSize() const
{
return m_layer.visibleSize();
}
IntSize RenderLayerScrollableArea::contentsSize() const
{
return IntSize(scrollWidth(), scrollHeight());
}
IntSize RenderLayerScrollableArea::reachableTotalContentsSize() const
{
IntSize contentsSize = this->contentsSize();
if (!hasScrollableHorizontalOverflow())
contentsSize.setWidth(std::min(contentsSize.width(), visibleSize().width()));
if (!hasScrollableVerticalOverflow())
contentsSize.setHeight(std::min(contentsSize.height(), visibleSize().height()));
return contentsSize;
}
void RenderLayerScrollableArea::availableContentSizeChanged(AvailableSizeChangeReason reason)
{
ScrollableArea::availableContentSizeChanged(reason);
auto& renderer = m_layer.renderer();
if (reason == AvailableSizeChangeReason::ScrollbarsChanged) {
if (CheckedPtr renderBlock = dynamicDowncast<RenderBlock>(renderer))
renderBlock->setShouldForceRelayoutChildren(true);
renderer.setNeedsLayout();
}
}
bool RenderLayerScrollableArea::shouldSuspendScrollAnimations() const
{
auto& renderer = m_layer.renderer();
return renderer.view().protectedFrameView()->shouldSuspendScrollAnimations();
}
#if PLATFORM(IOS_FAMILY)
void RenderLayerScrollableArea::didStartScroll()
{
m_layer.page().chrome().client().didStartOverflowScroll();
}
void RenderLayerScrollableArea::didEndScroll()
{
m_layer.page().chrome().client().didEndOverflowScroll();
}
void RenderLayerScrollableArea::didUpdateScroll()
{
// Send this notification when we scroll, since this is how we keep selection updated.
m_layer.page().chrome().client().didLayout(ChromeClient::Scroll);
}
#endif
RenderLayer::OverflowControlRects RenderLayerScrollableArea::overflowControlsRects() const
{
auto& renderBox = downcast<RenderBox>(m_layer.renderer());
// Scrollbars sit inside the border box.
auto overflowControlsPositioningRect = snappedIntRect(renderBox.paddingBoxRectIncludingScrollbar());
RefPtr hBar = m_hBar;
RefPtr vBar = m_vBar;
auto horizontalScrollbarHeight = hBar ? hBar->height() : 0;
auto verticalScrollbarWidth = vBar ? vBar->width() : 0;
auto isNonOverlayScrollbar = [](const Scrollbar* scrollbar) {
return scrollbar && !scrollbar->isOverlayScrollbar();
};
bool haveNonOverlayHorizontalScrollbar = isNonOverlayScrollbar(hBar.get());
bool haveNonOverlayVerticalScrollbar = isNonOverlayScrollbar(vBar.get());
bool placeVerticalScrollbarOnTheLeft = shouldPlaceVerticalScrollbarOnLeft();
bool haveResizer = renderBox.style().resize() != Resize::None && renderBox.style().pseudoElementType() == PseudoId::None;
bool scrollbarsAvoidCorner = ((haveNonOverlayHorizontalScrollbar && haveNonOverlayVerticalScrollbar) || (haveResizer && (haveNonOverlayHorizontalScrollbar || haveNonOverlayVerticalScrollbar))) && renderBox.style().scrollbarWidth() != ScrollbarWidth::None;
IntSize cornerSize;
if (scrollbarsAvoidCorner) {
// If only one scrollbar is present, the corner is square.
cornerSize = IntSize {
verticalScrollbarWidth ? verticalScrollbarWidth : horizontalScrollbarHeight,
horizontalScrollbarHeight ? horizontalScrollbarHeight : verticalScrollbarWidth
};
}
RenderLayer::OverflowControlRects result;
if (hBar) {
auto barRect = overflowControlsPositioningRect;
barRect.shiftYEdgeTo(barRect.maxY() - horizontalScrollbarHeight);
if (scrollbarsAvoidCorner) {
if (placeVerticalScrollbarOnTheLeft)
barRect.shiftXEdgeTo(barRect.x() + cornerSize.width());
else
barRect.contract(cornerSize.width(), 0);
}
result.horizontalScrollbar = barRect;
}
if (vBar) {
auto barRect = overflowControlsPositioningRect;
if (placeVerticalScrollbarOnTheLeft)
barRect.setWidth(verticalScrollbarWidth);
else
barRect.shiftXEdgeTo(barRect.maxX() - verticalScrollbarWidth);
if (scrollbarsAvoidCorner)
barRect.contract(0, cornerSize.height());
result.verticalScrollbar = barRect;
}
auto cornerRect = [&](IntSize cornerSize) {
if (placeVerticalScrollbarOnTheLeft) {
auto bottomLeftCorner = overflowControlsPositioningRect.minXMaxYCorner();
return IntRect { { bottomLeftCorner.x(), bottomLeftCorner.y() - cornerSize.height(), }, cornerSize };
}
return IntRect { overflowControlsPositioningRect.maxXMaxYCorner() - cornerSize, cornerSize };
};
if (scrollbarsAvoidCorner)
result.scrollCorner = cornerRect(cornerSize);
if (haveResizer) {
if (scrollbarsAvoidCorner)
result.resizer = result.scrollCorner;
else {
auto scrollbarThickness = ScrollbarTheme::theme().scrollbarThickness();
result.resizer = cornerRect({ scrollbarThickness, scrollbarThickness });
}
}
return result;
}
IntSize RenderLayerScrollableArea::scrollbarOffset(const Scrollbar& scrollbar) const
{
auto rects = overflowControlsRects();
if (&scrollbar == m_vBar.get())
return toIntSize(rects.verticalScrollbar.location());
if (&scrollbar == m_hBar.get())
return toIntSize(rects.horizontalScrollbar.location());
ASSERT_NOT_REACHED();
return { };
}
void RenderLayerScrollableArea::invalidateScrollbarRect(Scrollbar& scrollbar, const IntRect& rect)
{
if (!showsOverflowControls())
return;
if (&scrollbar == m_vBar.get()) {
if (RefPtr layer = layerForVerticalScrollbar()) {
layer->setNeedsDisplayInRect(rect);
return;
}
} else {
if (RefPtr layer = layerForHorizontalScrollbar()) {
layer->setNeedsDisplayInRect(rect);
return;
}
}
auto scrollRect = rect;
RenderBox* box = m_layer.renderBox();
ASSERT(box);
// If we are not yet inserted into the tree, there is no need to repaint.
if (!box->parent())
return;
auto rects = overflowControlsRects();
if (&scrollbar == m_vBar.get())
scrollRect.moveBy(rects.verticalScrollbar.location());
else
scrollRect.moveBy(rects.horizontalScrollbar.location());
LayoutRect repaintRect = scrollRect;
box->flipForWritingMode(repaintRect);
box->repaintRectangle(repaintRect);
}
void RenderLayerScrollableArea::invalidateScrollCornerRect(const IntRect& rect)
{
if (!showsOverflowControls())
return;
if (layerForScrollCorner())
return ScrollableArea::invalidateScrollCorner(rect);
if (m_scrollCorner)
m_scrollCorner->repaintRectangle(rect);
if (m_resizer)
m_resizer->repaintRectangle(rect);
}
NativeScrollbarVisibility RenderLayerScrollableArea::horizontalNativeScrollbarVisibility() const
{
RefPtr scrollbar = horizontalScrollbar();
return Scrollbar::nativeScrollbarVisibility(scrollbar.get());
}
NativeScrollbarVisibility RenderLayerScrollableArea::verticalNativeScrollbarVisibility() const
{
RefPtr scrollbar = verticalScrollbar();
return Scrollbar::nativeScrollbarVisibility(scrollbar.get());
}
bool RenderLayerScrollableArea::canShowNonOverlayScrollbars() const
{
return canHaveScrollbars() && !(m_layer.renderBox() && m_layer.renderBox()->canUseOverlayScrollbars());
}
void RenderLayerScrollableArea::createScrollbarsController()
{
m_layer.page().chrome().client().ensureScrollbarsController(m_layer.protectedPage(), *this);
}
static inline RenderElement* rendererForScrollbar(RenderLayerModelObject& renderer)
{
if (RefPtr element = renderer.element()) {
if (RefPtr shadowRoot = element->containingShadowRoot()) {
if (shadowRoot->mode() == ShadowRootMode::UserAgent)
return shadowRoot->protectedHost()->renderer();
}
}
return &renderer;
}
Ref<Scrollbar> RenderLayerScrollableArea::createScrollbar(ScrollbarOrientation orientation)
{
auto& renderer = m_layer.renderer();
RefPtr<Scrollbar> widget;
ASSERT(rendererForScrollbar(renderer));
auto& actualRenderer = *rendererForScrollbar(renderer);
auto* actualRenderBox = dynamicDowncast<RenderBox>(actualRenderer);
bool usesLegacyScrollbarStyle = actualRenderBox && actualRenderBox->style().usesLegacyScrollbarStyle();
RefPtr element = actualRenderBox ? actualRenderBox->element() : nullptr;
if (usesLegacyScrollbarStyle && element)
widget = RenderScrollbar::createCustomScrollbar(*this, orientation, element.get());
else {
widget = Scrollbar::createNativeScrollbar(*this, orientation, scrollbarWidthStyle());
didAddScrollbar(widget.get(), orientation);
if (Ref page = m_layer.page(); page->isMonitoringWheelEvents())
scrollAnimator().setWheelEventTestMonitor(page->wheelEventTestMonitor());
}
renderer.view().protectedFrameView()->addChild(*widget);
return widget.releaseNonNull();
}
void RenderLayerScrollableArea::destroyScrollbar(ScrollbarOrientation orientation)
{
RefPtr<Scrollbar>& scrollbar = orientation == ScrollbarOrientation::Horizontal ? m_hBar : m_vBar;
if (!scrollbar)
return;
if (!scrollbar->isCustomScrollbar())
willRemoveScrollbar(scrollbar.get(), orientation);
scrollbar->removeFromParent();
scrollbar = nullptr;
}
void RenderLayerScrollableArea::setHasHorizontalScrollbar(bool hasScrollbar)
{
if (hasScrollbar == hasHorizontalScrollbar())
return;
if (hasScrollbar) {
m_hBar = createScrollbar(ScrollbarOrientation::Horizontal);
#if HAVE(RUBBER_BANDING)
auto& renderer = m_layer.renderer();
ScrollElasticity elasticity = scrollsOverflow() && renderer.settings().rubberBandingForSubScrollableRegionsEnabled() ? ScrollElasticity::Automatic : ScrollElasticity::None;
ScrollableArea::setHorizontalScrollElasticity(elasticity);
#endif
} else {
destroyScrollbar(ScrollbarOrientation::Horizontal);
#if HAVE(RUBBER_BANDING)
ScrollableArea::setHorizontalScrollElasticity(ScrollElasticity::None);
#endif
}
// Destroying or creating one bar can cause our scrollbar corner to come and go. We need to update the opposite scrollbar's style.
if (m_hBar)
m_hBar->styleChanged();
if (m_vBar)
m_vBar->styleChanged();
}
void RenderLayerScrollableArea::setHasVerticalScrollbar(bool hasScrollbar)
{
if (hasScrollbar == hasVerticalScrollbar())
return;
if (hasScrollbar) {
m_vBar = createScrollbar(ScrollbarOrientation::Vertical);
#if HAVE(RUBBER_BANDING)
auto& renderer = m_layer.renderer();
ScrollElasticity elasticity = scrollsOverflow() && renderer.settings().rubberBandingForSubScrollableRegionsEnabled() ? ScrollElasticity::Automatic : ScrollElasticity::None;
ScrollableArea::setVerticalScrollElasticity(elasticity);
#endif
} else {
destroyScrollbar(ScrollbarOrientation::Vertical);
#if HAVE(RUBBER_BANDING)
ScrollableArea::setVerticalScrollElasticity(ScrollElasticity::None);
#endif
}
// Destroying or creating one bar can cause our scrollbar corner to come and go. We need to update the opposite scrollbar's style.
if (m_hBar)
m_hBar->styleChanged();
if (m_vBar)
m_vBar->styleChanged();
}
ScrollableArea* RenderLayerScrollableArea::enclosingScrollableArea() const
{
if (auto* scrollableLayer = m_layer.enclosingScrollableLayer(IncludeSelfOrNot::ExcludeSelf, CrossFrameBoundaries::No))
return scrollableLayer->scrollableArea();
auto& renderer = m_layer.renderer();
return &renderer.view().frameView();
}
bool RenderLayerScrollableArea::isScrollableOrRubberbandable()
{
auto& renderer = m_layer.renderer();
return renderer.isScrollableOrRubberbandableBox();
}
bool RenderLayerScrollableArea::hasScrollableOrRubberbandableAncestor()
{
for (auto* nextLayer = m_layer.enclosingContainingBlockLayer(CrossFrameBoundaries::Yes); nextLayer; nextLayer = nextLayer->enclosingContainingBlockLayer(CrossFrameBoundaries::Yes)) {
if (nextLayer->renderer().isScrollableOrRubberbandableBox())
return true;
}
return false;
}
int RenderLayerScrollableArea::verticalScrollbarWidth(OverlayScrollbarSizeRelevancy relevancy, bool isHorizontalWritingMode) const
{
RefPtr vBar = m_vBar;
if (vBar && vBar->isOverlayScrollbar() && (relevancy == OverlayScrollbarSizeRelevancy::IgnoreOverlayScrollbarSize || !vBar->shouldParticipateInHitTesting()))
return 0;
if (!vBar && isHorizontalWritingMode && !(scrollbarGutterStyle().isAuto || ScrollbarTheme::theme().usesOverlayScrollbars()))
return ScrollbarTheme::theme().scrollbarThickness(scrollbarWidthStyle());
if (!vBar || !showsOverflowControls())
return 0;
return vBar->width();
}
int RenderLayerScrollableArea::horizontalScrollbarHeight(OverlayScrollbarSizeRelevancy relevancy, bool isHorizontalWritingMode) const
{
RefPtr hBar = m_hBar;
if (hBar && hBar->isOverlayScrollbar() && (relevancy == OverlayScrollbarSizeRelevancy::IgnoreOverlayScrollbarSize || !hBar->shouldParticipateInHitTesting()))
return 0;
if (!hBar && !isHorizontalWritingMode && !(scrollbarGutterStyle().isAuto || ScrollbarTheme::theme().usesOverlayScrollbars()))
return ScrollbarTheme::theme().scrollbarThickness(scrollbarWidthStyle());
if (!hBar || !showsOverflowControls())
return 0;
return hBar->height();
}
OverscrollBehavior RenderLayerScrollableArea::horizontalOverscrollBehavior() const
{
if (m_layer.renderBox())
return m_layer.renderer().style().overscrollBehaviorX();
return OverscrollBehavior::Auto;
}
OverscrollBehavior RenderLayerScrollableArea::verticalOverscrollBehavior() const
{
if (m_layer.renderBox())
return m_layer.renderer().style().overscrollBehaviorY();
return OverscrollBehavior::Auto;
}
Color RenderLayerScrollableArea::scrollbarThumbColorStyle() const
{
if (auto* renderer = m_layer.renderBox())
return renderer->style().usedScrollbarThumbColor();
return { };
}
Color RenderLayerScrollableArea::scrollbarTrackColorStyle() const
{
if (auto* renderer = m_layer.renderBox())
return renderer->style().usedScrollbarTrackColor();
return { };
}
ScrollbarGutter RenderLayerScrollableArea::scrollbarGutterStyle() const
{
if (auto* renderer = m_layer.renderBox())
return renderer->style().scrollbarGutter();
return { };
}
ScrollbarWidth RenderLayerScrollableArea::scrollbarWidthStyle() const
{
if (m_layer.renderBox())
return m_layer.renderer().style().scrollbarWidth();
return ScrollbarWidth::Auto;
}
bool RenderLayerScrollableArea::hasOverflowControls() const
{
return m_hBar || m_vBar || m_scrollCorner || m_layer.renderer().style().resize() != Resize::None;
}
bool RenderLayerScrollableArea::positionOverflowControls(const IntSize& offsetFromRoot)
{
if (!m_hBar && !m_vBar && !m_layer.canResize())
return false;
if (!m_layer.renderBox())
return false;
auto rects = overflowControlsRects();
bool changed = false;
if (RefPtr vBar = m_vBar) {
rects.verticalScrollbar.move(offsetFromRoot);
if (vBar->frameRect() != rects.verticalScrollbar) {
vBar->setFrameRect(rects.verticalScrollbar);
changed = true;
}
}
if (RefPtr hBar = m_hBar) {
rects.horizontalScrollbar.move(offsetFromRoot);
if (hBar->frameRect() != rects.horizontalScrollbar) {
hBar->setFrameRect(rects.horizontalScrollbar);
changed = true;
}
}
if (m_scrollCorner && m_scrollCorner->frameRect() != rects.scrollCorner) {
m_scrollCorner->setFrameRect(rects.scrollCorner);
changed = true;
}
if (m_resizer && m_resizer->frameRect() != rects.resizer) {
m_resizer->setFrameRect(rects.resizer);
changed = true;
}
return changed;
}
LayoutUnit RenderLayerScrollableArea::overflowTop() const
{
RenderBox* box = m_layer.renderBox();
LayoutRect overflowRect(box->layoutOverflowRect());
box->flipForWritingMode(overflowRect);
return overflowRect.y();
}
LayoutUnit RenderLayerScrollableArea::overflowBottom() const
{
RenderBox* box = m_layer.renderBox();
LayoutRect overflowRect(box->layoutOverflowRect());
box->flipForWritingMode(overflowRect);
return overflowRect.maxY();
}
LayoutUnit RenderLayerScrollableArea::overflowLeft() const
{
RenderBox* box = m_layer.renderBox();
LayoutRect overflowRect(box->layoutOverflowRect());
box->flipForWritingMode(overflowRect);
return overflowRect.x();
}
LayoutUnit RenderLayerScrollableArea::overflowRight() const
{
RenderBox* box = m_layer.renderBox();
LayoutRect overflowRect(box->layoutOverflowRect());
box->flipForWritingMode(overflowRect);
return overflowRect.maxX();
}
void RenderLayerScrollableArea::computeScrollDimensions()
{
m_scrollDimensionsDirty = false;
RenderBox* box = m_layer.renderBox();
ASSERT(box);
LayoutRect overflowRect(box->layoutOverflowRect());
m_scrollWidth = roundToInt(overflowRect.width());
m_scrollHeight = roundToInt(overflowRect.height());
computeScrollOrigin();
computeHasCompositedScrollableOverflow(LayoutUpToDate::Yes);
}
void RenderLayerScrollableArea::computeScrollOrigin()
{
RenderBox* box = m_layer.renderBox();
ASSERT(box);
int scrollableLeftOverflow = roundToInt(overflowLeft() - box->borderLeft());
if (shouldPlaceVerticalScrollbarOnLeft())
scrollableLeftOverflow -= verticalScrollbarWidth(OverlayScrollbarSizeRelevancy::IgnoreOverlayScrollbarSize, box->writingMode().isHorizontal());
int scrollableTopOverflow = roundToInt(overflowTop() - box->borderTop());
setScrollOrigin(IntPoint(-scrollableLeftOverflow, -scrollableTopOverflow));
// Horizontal scrollbar offsets depend on the scroll origin when vertical
// scrollbars are on the left.
if (RefPtr hBar = m_hBar)
hBar->offsetDidChange();
}
void RenderLayerScrollableArea::computeHasCompositedScrollableOverflow(LayoutUpToDate layoutUpToDate)
{
bool hasCompositedScrollableOverflow = m_hasCompositedScrollableOverflow;
switch (layoutUpToDate) {
case LayoutUpToDate::No:
// If layout is not up to date, the only thing we can reliably know is that style prevents overflow scrolling.
if (!canUseCompositedScrolling())
hasCompositedScrollableOverflow = false;
break;
case LayoutUpToDate::Yes:
hasCompositedScrollableOverflow = canUseCompositedScrolling() && (hasScrollableHorizontalOverflow() || hasScrollableVerticalOverflow());
break;
}
if (hasCompositedScrollableOverflow == m_hasCompositedScrollableOverflow)
return;
m_layer.setSelfAndDescendantsNeedPositionUpdate();
// Whether this layer does composited scrolling affects the configuration of descendant sticky layers. We have to
// dirty from the enclosing stacking context because overflow scroll doesn't create stacking context so those
// containing block descendants may not be paint-order descendants, and the compositing dirty bits on RenderLayer act in paint order.
if (auto* paintParent = m_layer.stackingContext())
paintParent->setDescendantsNeedUpdateBackingAndHierarchyTraversal();
m_hasCompositedScrollableOverflow = hasCompositedScrollableOverflow;
if (m_hasCompositedScrollableOverflow)
m_layer.compositor().layerGainedCompositedScrollableOverflow(m_layer);
}
bool RenderLayerScrollableArea::hasScrollableHorizontalOverflow() const
{
return hasHorizontalOverflow() && m_layer.renderBox()->scrollsOverflowX();
}
bool RenderLayerScrollableArea::hasScrollableVerticalOverflow() const
{
return hasVerticalOverflow() && m_layer.renderBox()->scrollsOverflowY();
}
bool RenderLayerScrollableArea::hasHorizontalOverflow() const
{
ASSERT(!m_scrollDimensionsDirty);
return scrollWidth() > roundToInt(m_layer.renderBox()->clientWidth());
}
bool RenderLayerScrollableArea::hasVerticalOverflow() const
{
ASSERT(!m_scrollDimensionsDirty);
return scrollHeight() > roundToInt(m_layer.renderBox()->clientHeight());
}
void RenderLayerScrollableArea::updateScrollbarPresenceAndState(std::optional<bool> hasHorizontalOverflow, std::optional<bool> hasVerticalOverflow)
{
auto* box = m_layer.renderBox();
ASSERT(box);
enum class ScrollbarState {
NoScrollbar,
Enabled,
Disabled
};
auto scrollbarForAxis = [&](ScrollbarOrientation orientation) -> RefPtr<Scrollbar>& {
return orientation == ScrollbarOrientation::Horizontal ? m_hBar : m_vBar;
};
auto stateForScrollbar = [&](ScrollbarOrientation orientation, std::optional<bool> hasOverflow, ScrollbarState nonScrollableState) {
if (hasOverflow)
return *hasOverflow ? ScrollbarState::Enabled : nonScrollableState;
// If we don't have information about overflow (because we haven't done layout yet), just return the current state of the scrollbar.
auto existingScrollbar = scrollbarForAxis(orientation);
return (existingScrollbar && existingScrollbar->enabled()) ? ScrollbarState::Enabled : nonScrollableState;
};
auto stateForScrollbarOnAxis = [&](ScrollbarOrientation orientation, std::optional<bool> hasOverflow) {
if (box->hasAlwaysPresentScrollbar(orientation))
return stateForScrollbar(orientation, hasOverflow, ScrollbarState::Disabled);
if (box->hasAutoScrollbar(orientation))
return stateForScrollbar(orientation, hasOverflow, ScrollbarState::NoScrollbar);
return ScrollbarState::NoScrollbar;
};
auto horizontalBarState = stateForScrollbarOnAxis(ScrollbarOrientation::Horizontal, hasHorizontalOverflow);
setHasHorizontalScrollbar(horizontalBarState != ScrollbarState::NoScrollbar);
if (horizontalBarState != ScrollbarState::NoScrollbar)
Ref { *m_hBar }->setEnabled(horizontalBarState == ScrollbarState::Enabled);
auto verticalBarState = stateForScrollbarOnAxis(ScrollbarOrientation::Vertical, hasVerticalOverflow);
setHasVerticalScrollbar(verticalBarState != ScrollbarState::NoScrollbar);
if (verticalBarState != ScrollbarState::NoScrollbar)
Ref { *m_vBar }->setEnabled(verticalBarState == ScrollbarState::Enabled);
}
void RenderLayerScrollableArea::updateScrollbarsAfterStyleChange(const RenderStyle* oldStyle)
{
// Overflow is a box concept.
RenderBox* box = m_layer.renderBox();
if (!box)
return;
// List box parts handle the scrollbars by themselves so we have nothing to do.
if (box->style().usedAppearance() == StyleAppearance::Listbox)
return;
bool hadVerticalScrollbar = hasVerticalScrollbar();
updateScrollbarPresenceAndState();
bool hasVerticalScrollbar = this->hasVerticalScrollbar();
if (hadVerticalScrollbar != hasVerticalScrollbar || (hasVerticalScrollbar && oldStyle && oldStyle->shouldPlaceVerticalScrollbarOnLeft() != box->style().shouldPlaceVerticalScrollbarOnLeft()))
computeScrollOrigin();
if (!m_scrollDimensionsDirty)
updateScrollableAreaSet(hasScrollableHorizontalOverflow() || hasScrollableVerticalOverflow());
}
void RenderLayerScrollableArea::updateScrollbarsAfterLayout()
{
RenderBox* box = m_layer.renderBox();
ASSERT(box);
// List box parts handle the scrollbars by themselves so we have nothing to do.
if (box->style().usedAppearance() == StyleAppearance::Listbox)
return;
bool hadHorizontalScrollbar = hasHorizontalScrollbar();
bool hadVerticalScrollbar = hasVerticalScrollbar();
updateScrollbarPresenceAndState(hasHorizontalOverflow(), hasVerticalOverflow());
// Scrollbars with auto behavior may need to lay out again if scrollbars got added or removed.
bool autoHorizontalScrollBarChanged = box->hasAutoScrollbar(ScrollbarOrientation::Horizontal) && (hadHorizontalScrollbar != hasHorizontalScrollbar());
bool autoVerticalScrollBarChanged = box->hasAutoScrollbar(ScrollbarOrientation::Vertical) && (hadVerticalScrollbar != hasVerticalScrollbar());
if (autoHorizontalScrollBarChanged || autoVerticalScrollBarChanged) {
if (autoVerticalScrollBarChanged && shouldPlaceVerticalScrollbarOnLeft())
computeScrollOrigin();
m_layer.updateSelfPaintingLayer();
auto& renderer = m_layer.renderer();
renderer.repaint();
if (renderer.style().overflowX() == Overflow::Auto || renderer.style().overflowY() == Overflow::Auto) {
if (!m_inOverflowRelayout) {
SetForScope inOverflowRelayoutScope(m_inOverflowRelayout, true);
renderer.setNeedsLayout(MarkOnlyThis);
if (CheckedPtr block = dynamicDowncast<RenderBlock>(renderer)) {
block->scrollbarsChanged(autoHorizontalScrollBarChanged, autoVerticalScrollBarChanged);
block->layoutBlock(RelayoutChildren::Yes);
} else
renderer.layout();
}
}
// FIXME: This does not belong here.
auto* parent = renderer.parent();
if (CheckedPtr parentFlexibleBox = dynamicDowncast<RenderFlexibleBox>(parent); parentFlexibleBox && renderer.isRenderBox())
parentFlexibleBox->clearCachedMainSizeForFlexItem(*m_layer.renderBox());
}
// Set up the range.
if (RefPtr hBar = m_hBar)
hBar->setProportion(roundToInt(box->clientWidth()), m_scrollWidth);
if (RefPtr vBar = m_vBar)
vBar->setProportion(roundToInt(box->clientHeight()), m_scrollHeight);
updateScrollbarSteps();
updateScrollableAreaSet(hasScrollableHorizontalOverflow() || hasScrollableVerticalOverflow());
}
void RenderLayerScrollableArea::updateScrollbarSteps()
{
RenderBox* box = m_layer.renderBox();
ASSERT(box);
LayoutRect paddedLayerBounds(0_lu, 0_lu, box->clientWidth(), box->clientHeight());
paddedLayerBounds.contract(box->scrollPaddingForViewportRect(paddedLayerBounds));
// Set up the page step/line step.
if (RefPtr hBar = m_hBar) {
int width = roundToInt(paddedLayerBounds.width());
hBar->setSteps(Scrollbar::pixelsPerLineStep(width), Scrollbar::pageStep(width));
}
if (RefPtr vBar = m_vBar) {
int height = roundToInt(paddedLayerBounds.height());
vBar->setSteps(Scrollbar::pixelsPerLineStep(height), Scrollbar::pageStep(height));
}
}
// This is called from layout code (before updateLayerPositions).
void RenderLayerScrollableArea::updateScrollInfoAfterLayout()
{
RenderBox* box = m_layer.renderBox();
if (!box)
return;
m_scrollDimensionsDirty = true;
ScrollPosition originalScrollPosition = scrollPosition();
computeScrollDimensions();
m_layer.updateSelfPaintingLayer();
// FIXME: Ensure that offsets are also updated in case of programmatic style changes.
// https://bugs.webkit.org/show_bug.cgi?id=135964
updateSnapOffsets();
if (!box->isHTMLMarquee() && !isRubberBandInProgress() && !isUserScrollInProgress()) {
// Layout may cause us to be at an invalid scroll position. In this case we need
// to pull our scroll offsets back to the max (or push them up to the min).
ScrollOffset clampedScrollOffset = clampScrollOffset(scrollOffset());
if (clampedScrollOffset != scrollOffset())
scrollToOffset(clampedScrollOffset);
}
updateScrollbarsAfterLayout();
LOG_WITH_STREAM(Scrolling, stream << "RenderLayerScrollableArea [" << scrollingNodeID() << "] updateScrollInfoAfterLayout - new scroll width " << m_scrollWidth << " scroll height " << m_scrollHeight
<< " rubber banding " << isRubberBandInProgress() << " user scrolling " << isUserScrollInProgress() << " scroll position updated from " << originalScrollPosition << " to " << scrollPosition());
if (originalScrollPosition != scrollPosition())
scrollToPositionWithoutAnimation(IntPoint(scrollPosition()));
if (m_layer.isComposited()) {
m_layer.setNeedsCompositingGeometryUpdate();
m_layer.setNeedsCompositingConfigurationUpdate();
}
if (canUseCompositedScrolling())
m_layer.setNeedsPostLayoutCompositingUpdate();
resnapAfterLayout();
InspectorInstrumentation::didAddOrRemoveScrollbars(m_layer.renderer());
}
bool RenderLayerScrollableArea::overflowControlsIntersectRect(const IntRect& localRect) const
{
auto rects = overflowControlsRects();
if (rects.horizontalScrollbar.intersects(localRect))
return true;
if (rects.verticalScrollbar.intersects(localRect))
return true;
if (rects.scrollCorner.intersects(localRect))
return true;
if (rects.resizer.intersects(localRect))
return true;
return false;
}
bool RenderLayerScrollableArea::showsOverflowControls() const
{
#if PLATFORM(IOS_FAMILY)
// On iOS, the scrollbars are made in the UI process.
return !canUseCompositedScrolling();
#endif
return true;
}
void RenderLayerScrollableArea::paintOverflowControls(GraphicsContext& context, const IntPoint& paintOffset, const IntRect& damageRect, bool paintingOverlayControls)
{
// Don't do anything if we have no overflow.
auto& renderer = m_layer.renderer();
if (!renderer.hasNonVisibleOverflow())
return;
if (!showsOverflowControls())
return;
// Overlay scrollbars paint in a second pass through the layer tree so that they will paint
// on top of everything else. If this is the normal painting pass, paintingOverlayControls
// will be false, and we should just tell the root layer that there are overlay scrollbars
// that need to be painted. That will cause the second pass through the layer tree to run,
// and we'll paint the scrollbars then. In the meantime, cache tx and ty so that the
// second pass doesn't need to re-enter the RenderTree to get it right.
if (hasOverlayScrollbars() && !paintingOverlayControls) {
m_cachedOverlayScrollbarOffset = paintOffset;
// It's not necessary to do the second pass if the scrollbars paint into layers.
if ((m_hBar && layerForHorizontalScrollbar()) || (m_vBar && layerForVerticalScrollbar()))
return;
IntRect localDamgeRect = damageRect;
localDamgeRect.moveBy(-paintOffset);
if (!overflowControlsIntersectRect(localDamgeRect))
return;
RenderLayer* paintingRoot = m_layer.enclosingCompositingLayer();
if (!paintingRoot)
paintingRoot = renderer.view().layer();
if (CheckedPtr scrollableArea = paintingRoot->scrollableArea())
scrollableArea->setContainsDirtyOverlayScrollbars(true);
return;
}
// This check is required to avoid painting custom CSS scrollbars twice.
if (paintingOverlayControls && !hasOverlayScrollbars())
return;
IntPoint adjustedPaintOffset = paintOffset;
if (paintingOverlayControls)
adjustedPaintOffset = m_cachedOverlayScrollbarOffset;
// Move the scrollbar widgets if necessary. We normally move and resize widgets during layout, but sometimes
// widgets can move without layout occurring (most notably when you scroll a document that
// contains fixed positioned elements).
positionOverflowControls(toIntSize(adjustedPaintOffset));
// Now that we're sure the scrollbars are in the right place, paint them.
if (RefPtr hBar = m_hBar; hBar && !layerForHorizontalScrollbar())
hBar->paint(context, damageRect);
if (RefPtr vBar = m_vBar; vBar && !layerForVerticalScrollbar())
vBar->paint(context, damageRect);
if (layerForScrollCorner())
return;
// We fill our scroll corner with white if we have a scrollbar that doesn't run all the way up to the
// edge of the box.
paintScrollCorner(context, adjustedPaintOffset, damageRect);
// Paint our resizer last, since it sits on top of the scroll corner.
paintResizer(context, adjustedPaintOffset, damageRect);
}
void RenderLayerScrollableArea::paintScrollCorner(GraphicsContext& context, const IntPoint& paintOffset, const IntRect& damageRect)
{
IntRect absRect = scrollCornerRect();
absRect.moveBy(paintOffset);
if (!absRect.intersects(damageRect))
return;
if (context.invalidatingControlTints()) {
updateScrollCornerStyle();
return;
}
if (m_scrollCorner) {
m_scrollCorner->paintIntoRect(context, paintOffset, absRect);
return;
}
// We don't want to paint a corner if we have overlay scrollbars, since we need
// to see what is behind it.
if (!hasOverlayScrollbars())
ScrollbarTheme::theme().paintScrollCorner(*this, context, absRect);
}
void RenderLayerScrollableArea::drawPlatformResizerImage(GraphicsContext& context, const LayoutRect& resizerCornerRect)
{
auto& renderer = m_layer.renderer();
RefPtr<Image> resizeCornerImage;
FloatSize cornerResizerSize;
Ref document = renderer.document();
if (document->deviceScaleFactor() >= 2) {
static NeverDestroyed<Image*> resizeCornerImageHiRes(&ImageAdapter::loadPlatformResource("textAreaResizeCorner@2x").leakRef());
resizeCornerImage = resizeCornerImageHiRes;
cornerResizerSize = resizeCornerImage->size();
cornerResizerSize.scale(0.5f);
} else {
static NeverDestroyed<Image*> resizeCornerImageLoRes(&ImageAdapter::loadPlatformResource("textAreaResizeCorner").leakRef());
resizeCornerImage = resizeCornerImageLoRes;
cornerResizerSize = resizeCornerImage->size();
}
if (shouldPlaceVerticalScrollbarOnLeft()) {
context.save();
context.translate(resizerCornerRect.x() + cornerResizerSize.width(), resizerCornerRect.y() + resizerCornerRect.height() - cornerResizerSize.height());
context.scale(FloatSize(-1.0, 1.0));
if (resizeCornerImage)
context.drawImage(*resizeCornerImage, FloatRect(FloatPoint(), cornerResizerSize));
context.restore();
return;
}
if (!resizeCornerImage)
return;
FloatRect imageRect = snapRectToDevicePixels(LayoutRect(resizerCornerRect.maxXMaxYCorner() - cornerResizerSize, cornerResizerSize), document->deviceScaleFactor());
context.drawImage(*resizeCornerImage, imageRect);
}
void RenderLayerScrollableArea::paintResizer(GraphicsContext& context, const LayoutPoint& paintOffset, const LayoutRect& damageRect)
{
auto& renderer = m_layer.renderer();
if (renderer.style().resize() == Resize::None)
return;
auto rects = overflowControlsRects();
LayoutRect resizerAbsRect = rects.resizer;
resizerAbsRect.moveBy(paintOffset);
if (!resizerAbsRect.intersects(damageRect))
return;
if (context.invalidatingControlTints()) {
updateResizerStyle();
return;
}
if (m_resizer) {
m_resizer->paintIntoRect(context, paintOffset, resizerAbsRect);
return;
}
drawPlatformResizerImage(context, resizerAbsRect);
// Draw a frame around the resizer (1px grey line) if there are any scrollbars present.
// Clipping will exclude the right and bottom edges of this frame.
if (!hasOverlayScrollbars() && (m_vBar || m_hBar) && renderer.style().scrollbarWidth() != ScrollbarWidth::None) {
GraphicsContextStateSaver stateSaver(context);
context.clip(resizerAbsRect);
LayoutRect largerCorner = resizerAbsRect;
largerCorner.setSize(LayoutSize(largerCorner.width() + 1_lu, largerCorner.height() + 1_lu));
context.setStrokeColor(SRGBA<uint8_t> { 217, 217, 217 });
context.setStrokeThickness(1.0f);
context.setFillColor(Color::transparentBlack);
context.drawRect(snappedIntRect(largerCorner));
}
}
bool RenderLayerScrollableArea::hitTestOverflowControls(HitTestResult& result, const IntPoint& localPoint)
{
if (!m_hBar && !m_vBar && !m_layer.canResize())
return false;
auto rects = overflowControlsRects();
auto& renderer = m_layer.renderer();
if (renderer.style().resize() != Resize::None) {
if (rects.resizer.contains(localPoint))
return true;
}
// FIXME: We should hit test the m_scrollCorner and pass it back through the result.
if (RefPtr vBar = m_vBar; vBar && vBar->shouldParticipateInHitTesting()) {
if (rects.verticalScrollbar.contains(localPoint)) {
result.setScrollbar(vBar.get());
return true;
}
}
if (RefPtr hBar = m_hBar; hBar && hBar->shouldParticipateInHitTesting()) {
if (rects.horizontalScrollbar.contains(localPoint)) {
result.setScrollbar(hBar.get());
return true;
}
}
return false;
}
bool RenderLayerScrollableArea::scroll(ScrollDirection direction, ScrollGranularity granularity, unsigned stepCount)
{
return ScrollableArea::scroll(direction, granularity, stepCount);
}
bool RenderLayerScrollableArea::isActive() const
{
return m_layer.page().focusController().isActive();
}
IntPoint RenderLayerScrollableArea::lastKnownMousePositionInView() const
{
return m_layer.renderer().view().protectedFrameView()->lastKnownMousePositionInView();
}
bool RenderLayerScrollableArea::isHandlingWheelEvent() const
{
return m_layer.renderer().frame().eventHandler().isHandlingWheelEvent();
}
bool RenderLayerScrollableArea::useDarkAppearance() const
{
return m_layer.renderer().useDarkAppearance();
}
void RenderLayerScrollableArea::updateSnapOffsets()
{
// FIXME: Extend support beyond HTMLElements.
RefPtr enclosingElement = m_layer.enclosingElement();
if (!is<HTMLElement>(enclosingElement) || !enclosingElement->renderBox())
return;
RenderBox* box = enclosingElement->renderBox();
updateSnapOffsetsForScrollableArea(*this, *box, box->style(), box->paddingBoxRect(), box->style().writingMode(), m_layer.renderer().document().protectedFocusedElement().get());
}
bool RenderLayerScrollableArea::isScrollSnapInProgress() const
{
if (!scrollsOverflow())
return false;
if (RefPtr scrollingCoordinator = m_layer.protectedPage()->scrollingCoordinator()) {
if (scrollingCoordinator->isScrollSnapInProgress(scrollingNodeID()))
return true;
}
if (auto* scrollAnimator = existingScrollAnimator())
return scrollAnimator->isScrollSnapInProgress();
return false;
}
bool RenderLayerScrollableArea::scrollAnimatorEnabled() const
{
return m_layer.page().settings().scrollAnimatorEnabled();
}
void RenderLayerScrollableArea::paintOverlayScrollbars(GraphicsContext& context, const LayoutRect& damageRect, OptionSet<PaintBehavior> paintBehavior, RenderObject* subtreePaintRoot)
{
if (!m_containsDirtyOverlayScrollbars)
return;
RenderLayer::LayerPaintingInfo paintingInfo(&m_layer, enclosingIntRect(damageRect), paintBehavior, LayoutSize(), subtreePaintRoot);
m_layer.paintLayer(context, paintingInfo, RenderLayer::PaintLayerFlag::PaintingOverlayScrollbars);
m_containsDirtyOverlayScrollbars = false;
}
bool RenderLayerScrollableArea::hitTestResizerInFragments(const LayerFragments& layerFragments, const HitTestLocation& hitTestLocation, LayoutPoint& pointInFragment) const
{
if (layerFragments.isEmpty())
return false;
auto& renderer = m_layer.renderer();
if (!renderer.visibleToHitTesting())
return false;
auto borderBoxRect = snappedIntRect(downcast<RenderBox>(renderer).borderBoxRect());
auto rects = overflowControlsRects();
auto cornerRectInFragment = [&](const IntRect& fragmentBounds, const IntRect& resizerRect) {
if (shouldPlaceVerticalScrollbarOnLeft()) {
IntSize offsetFromBottomLeft = borderBoxRect.minXMaxYCorner() - resizerRect.minXMaxYCorner();
return IntRect { fragmentBounds.minXMaxYCorner() - offsetFromBottomLeft - IntSize { 0, resizerRect.height() }, resizerRect.size() };
}
IntSize offsetFromBottomRight = borderBoxRect.maxXMaxYCorner() - resizerRect.maxXMaxYCorner();
return IntRect { fragmentBounds.maxXMaxYCorner() - offsetFromBottomRight - resizerRect.size(), resizerRect.size() };
};
for (int i = layerFragments.size() - 1; i >= 0; --i) {
const LayerFragment& fragment = layerFragments.at(i);
auto resizerRectInFragment = cornerRectInFragment(snappedIntRect(fragment.layerBounds), rects.resizer);
if (fragment.backgroundRect.intersects(hitTestLocation) && resizerRectInFragment.contains(hitTestLocation.roundedPoint())) {
pointInFragment = toLayoutPoint(hitTestLocation.point() - fragment.layerBounds.location());
return true;
}
}
return false;
}
GraphicsLayer* RenderLayerScrollableArea::layerForHorizontalScrollbar() const
{
return m_layer.backing() ? m_layer.backing()->layerForHorizontalScrollbar() : nullptr;
}
GraphicsLayer* RenderLayerScrollableArea::layerForVerticalScrollbar() const
{
return m_layer.backing() ? m_layer.backing()->layerForVerticalScrollbar() : nullptr;
}
GraphicsLayer* RenderLayerScrollableArea::layerForScrollCorner() const
{
return m_layer.backing() ? m_layer.backing()->layerForScrollCorner() : nullptr;
}
bool RenderLayerScrollableArea::scrollingMayRevealBackground() const
{
return scrollsOverflow() || usesCompositedScrolling();
}
bool RenderLayerScrollableArea::isVisibleToHitTesting() const
{
auto& renderer = m_layer.renderer();
Ref frameView = renderer.view().frameView();
return renderer.visibleToHitTesting() && frameView->isVisibleToHitTesting();
}
void RenderLayerScrollableArea::updateScrollableAreaSet(bool hasOverflow)
{
auto& renderer = m_layer.renderer();
Ref frameView = renderer.view().frameView();
bool isVisibleToHitTest = renderer.visibleToHitTesting();
if (RefPtr owner = frameView->frame().ownerElement())
isVisibleToHitTest &= owner->renderer() && owner->renderer()->visibleToHitTesting();
bool needsToBeRegistered = (hasOverflow && isVisibleToHitTest) || scrollAnimationStatus() == ScrollAnimationStatus::Animating;
bool addedOrRemoved = false;
if (needsToBeRegistered) {
if (!m_registeredScrollableArea) {
addedOrRemoved = frameView->addScrollableArea(this);
m_registeredScrollableArea = true;
}
} else if (m_registeredScrollableArea) {
addedOrRemoved = frameView->removeScrollableArea(this);
m_registeredScrollableArea = false;
}
#if ENABLE(IOS_TOUCH_EVENTS)
if (addedOrRemoved) {
if (needsToBeRegistered && !canUseCompositedScrolling())
registerAsTouchEventListenerForScrolling();
else {
// We only need the touch listener for unaccelerated overflow scrolling, so if we became
// accelerated, remove ourselves as a touch event listener.
unregisterAsTouchEventListenerForScrolling();
}
}
#else
UNUSED_VARIABLE(addedOrRemoved);
#endif
}
void RenderLayerScrollableArea::registerScrollableAreaForAnimatedScroll()
{
auto& renderer = m_layer.renderer();
Ref frameView = renderer.view().frameView();
if (!m_registeredScrollableArea) {
frameView->addScrollableAreaForAnimatedScroll(this);
m_isRegisteredForAnimatedScroll = true;
}
}
void RenderLayerScrollableArea::updateScrollCornerStyle()
{
auto& renderer = m_layer.renderer();
RenderElement* actualRenderer = rendererForScrollbar(renderer);
auto corner = (renderer.hasNonVisibleOverflow() && !renderer.style().usesStandardScrollbarStyle()) ? actualRenderer->getUncachedPseudoStyle({ PseudoId::WebKitScrollbarCorner }, &actualRenderer->style()) : nullptr;
if (!corner) {
clearScrollCorner();
return;
}
if (!m_scrollCorner) {
m_scrollCorner = createRenderer<RenderScrollbarPart>(renderer.protectedDocument(), WTFMove(*corner));
// FIXME: A renderer should be a child of its parent!
m_scrollCorner->setParent(&renderer);
m_scrollCorner->initializeStyle();
} else
m_scrollCorner->setStyle(WTFMove(*corner));
}
void RenderLayerScrollableArea::clearScrollCorner()
{
if (!m_scrollCorner)
return;
m_scrollCorner->setParent(nullptr);
m_scrollCorner = nullptr;
}
void RenderLayerScrollableArea::updateResizerStyle()
{
if (!m_resizer && !m_layer.canResize())
return;
auto& renderer = m_layer.renderer();
RenderElement* actualRenderer = rendererForScrollbar(renderer);
auto resizer = renderer.hasNonVisibleOverflow() ? actualRenderer->getUncachedPseudoStyle({ PseudoId::WebKitResizer }, &actualRenderer->style()) : nullptr;
if (!resizer) {
clearResizer();
return;
}
if (!m_resizer) {
m_resizer = createRenderer<RenderScrollbarPart>(renderer.protectedDocument(), WTFMove(*resizer));
// FIXME: A renderer should be a child of its parent!
m_resizer->setParent(&renderer);
m_resizer->initializeStyle();
} else
m_resizer->setStyle(WTFMove(*resizer));
}
void RenderLayerScrollableArea::clearResizer()
{
if (!m_resizer)
return;
m_resizer->setParent(nullptr);
m_resizer = nullptr;
}
void RenderLayerScrollableArea::updateAllScrollbarRelatedStyle()
{
if (m_hBar)
m_hBar->styleChanged();
if (m_vBar)
m_vBar->styleChanged();
updateScrollCornerStyle();
updateResizerStyle();
}
// FIXME: this is only valid after we've made layers.
bool RenderLayerScrollableArea::usesCompositedScrolling() const
{
return hasCompositedScrollableOverflow() && m_layer.isComposited();
}
static inline int adjustedScrollDelta(int beginningDelta)
{
// This implemention matches Firefox's.
// http://mxr.mozilla.org/firefox/source/toolkit/content/widgets/browser.xml#856.
const int speedReducer = 12;
int adjustedDelta = beginningDelta / speedReducer;
if (adjustedDelta > 1)
adjustedDelta = static_cast<int>(adjustedDelta * sqrt(static_cast<double>(adjustedDelta))) - 1;
else if (adjustedDelta < -1)
adjustedDelta = static_cast<int>(adjustedDelta * sqrt(static_cast<double>(-adjustedDelta))) + 1;
return adjustedDelta;
}
static inline IntSize adjustedScrollDelta(const IntSize& delta)
{
return IntSize(adjustedScrollDelta(delta.width()), adjustedScrollDelta(delta.height()));
}
void RenderLayerScrollableArea::panScrollFromPoint(const IntPoint& sourcePoint)
{
IntPoint lastKnownMousePosition = m_layer.renderer().frame().eventHandler().lastKnownMousePosition();
// We need to check if the last known mouse position is out of the window. When the mouse is out of the window, the position is incoherent
static IntPoint previousMousePosition;
if (lastKnownMousePosition.x() < 0 || lastKnownMousePosition.y() < 0)
lastKnownMousePosition = previousMousePosition;
else
previousMousePosition = lastKnownMousePosition;
IntSize delta = lastKnownMousePosition - sourcePoint;
if (std::abs(delta.width()) <= ScrollView::noPanScrollRadius) // at the center we let the space for the icon
delta.setWidth(0);
if (std::abs(delta.height()) <= ScrollView::noPanScrollRadius)
delta.setHeight(0);
scrollByRecursively(adjustedScrollDelta(delta));
}
static LayoutRect getLocalExposeRect(const LayoutRect& absoluteRect, RenderBox* box, int verticalScrollbarWidth, const LayoutRect& layerBounds)
{
LayoutRect localExposeRect(box->absoluteToLocalQuad(FloatQuad(FloatRect(absoluteRect))).boundingBox());
// localExposedRect is now the absolute rect in local coordinates, but relative to the
// border edge. Make the rectangle relative to the scrollable area.
localExposeRect.moveBy(-LayoutPoint(box->borderLeft(), box->borderTop()));
if (box->shouldPlaceVerticalScrollbarOnLeft()) {
// For `direction: rtl; writing-mode: horizontal-{tb,bt}` and `writing-mode: vertical-rl`
// boxes, the scroll bar is on the left side. The visible rect starts from the right side
// of the scroll bar. So the x of localExposeRect should start from the same position too.
localExposeRect.moveBy(LayoutPoint(-verticalScrollbarWidth, 0));
}
// scroll-padding applies to the scroll container, but expand the rectangle that we want to expose in order
// simulate padding the scroll container. This rectangle is passed up the tree of scrolling elements to
// ensure that the padding on this scroll container is maintained.
localExposeRect.expand(box->scrollPaddingForViewportRect(layerBounds));
return localExposeRect;
}
LayoutRect RenderLayerScrollableArea::scrollRectToVisible(const LayoutRect& absoluteRect, const ScrollRectToVisibleOptions& options)
{
RenderBox* box = layer().renderBox();
ASSERT(box);
LayoutRect layerBounds(0_lu, 0_lu, box->clientWidth(), box->clientHeight());
LayoutRect localExposeRect = getLocalExposeRect(absoluteRect, box, verticalScrollbarWidth(), layerBounds);
std::optional<LayoutRect> localVisiblityRect;
if (options.visibilityCheckRect)
localVisiblityRect = getLocalExposeRect(*options.visibilityCheckRect, box, verticalScrollbarWidth(), layerBounds);
auto revealRect = getRectToExposeForScrollIntoView(layerBounds, localExposeRect, options.alignX, options.alignY, localVisiblityRect);
auto scrollPositionOptions = ScrollPositionChangeOptions::createProgrammatic();
if (!box->frame().eventHandler().autoscrollInProgress() && box->element() && useSmoothScrolling(options.behavior, box->protectedElement().get()))
scrollPositionOptions.animated = ScrollIsAnimated::Yes;
if (auto result = updateScrollPositionForScrollIntoView(scrollPositionOptions, revealRect, localExposeRect))
return result.value();
return absoluteRect;
}
std::optional<LayoutRect> RenderLayerScrollableArea::updateScrollPositionForScrollIntoView(const ScrollPositionChangeOptions& options, const LayoutRect& revealRect, const LayoutRect& localExposeRect)
{
RenderBox* box = m_layer.renderBox();
ASSERT(box);
ScrollOffset clampedScrollOffset = clampScrollOffset(scrollOffset() + toIntSize(roundedIntRect(revealRect).location()));
if (clampedScrollOffset == scrollOffset() && scrollAnimationStatus() == ScrollAnimationStatus::NotAnimating)
return std::nullopt;
ScrollOffset oldScrollOffset = scrollOffset();
ScrollOffset realScrollOffset = scrollToOffset(clampedScrollOffset, options);
IntSize scrollOffsetDifference = realScrollOffset - oldScrollOffset;
auto localExposeRectScrolled = localExposeRect;
localExposeRectScrolled.move(-scrollOffsetDifference);
return LayoutRect(box->localToAbsoluteQuad(FloatQuad(FloatRect(localExposeRectScrolled)), UseTransforms).boundingBox());
}
void RenderLayerScrollableArea::scrollByRecursively(const IntSize& delta, ScrollableArea** scrolledArea)
{
if (delta.isZero())
return;
auto& renderer = m_layer.renderer();
bool restrictedByLineClamp = false;
if (renderer.parent())
restrictedByLineClamp = !renderer.parent()->style().lineClamp().isNone();
if (renderer.hasNonVisibleOverflow() && !restrictedByLineClamp) {
ScrollOffset newScrollOffset = scrollOffset() + delta;
scrollToOffset(newScrollOffset);
if (scrolledArea)
*scrolledArea = this;
// If this layer can't do the scroll we ask the next layer up that can scroll to try
IntSize remainingScrollOffset = newScrollOffset - scrollOffset();
if (!remainingScrollOffset.isZero() && renderer.parent()) {
// FIXME: This skips scrollable frames.
if (auto* enclosingScrollableLayer = m_layer.enclosingScrollableLayer(IncludeSelfOrNot::ExcludeSelf, CrossFrameBoundaries::Yes)) {
if (CheckedPtr scrollableArea = enclosingScrollableLayer->scrollableArea())
scrollableArea->scrollByRecursively(remainingScrollOffset, scrolledArea);
}
renderer.frame().eventHandler().updateAutoscrollRenderer();
}
} else {
// If we are here, we were called on a renderer that can be programmatically scrolled, but doesn't
// have an overflow clip. Which means that it is a document node that can be scrolled.
renderer.view().protectedFrameView()->scrollBy(delta);
if (scrolledArea)
*scrolledArea = &renderer.view().frameView();
// FIXME: If we didn't scroll the whole way, do we want to try looking at the frames ownerElement?
// https://bugs.webkit.org/show_bug.cgi?id=28237
}
}
bool RenderLayerScrollableArea::mockScrollbarsControllerEnabled() const
{
return m_layer.renderer().settings().mockScrollbarsControllerEnabled();
}
void RenderLayerScrollableArea::logMockScrollbarsControllerMessage(const String& message) const
{
m_layer.renderer().protectedDocument()->addConsoleMessage(MessageSource::Other, MessageLevel::Debug, makeString("RenderLayer: "_s, message));
}
String RenderLayerScrollableArea::debugDescription() const
{
return m_layer.debugDescription();
}
void RenderLayerScrollableArea::didStartScrollAnimation()
{
m_layer.protectedPage()->scheduleRenderingUpdate({ RenderingUpdateStep::Scroll });
}
void RenderLayerScrollableArea::animatedScrollDidEnd()
{
if (m_isRegisteredForAnimatedScroll) {
auto& renderer = m_layer.renderer();
Ref frameView = renderer.view().frameView();
m_isRegisteredForAnimatedScroll = false;
frameView->removeScrollableAreaForAnimatedScroll(this);
}
}
float RenderLayerScrollableArea::deviceScaleFactor() const
{
return m_layer.renderer().protectedDocument()->deviceScaleFactor();
}
void RenderLayerScrollableArea::updateScrollAnchoringElement()
{
if (m_scrollAnchoringController)
m_scrollAnchoringController->updateAnchorElement();
}
void RenderLayerScrollableArea::updateScrollPositionForScrollAnchoringController()
{
if (m_scrollAnchoringController)
m_scrollAnchoringController->adjustScrollPositionForAnchoring();
}
void RenderLayerScrollableArea::invalidateScrollAnchoringElement()
{
if (m_scrollAnchoringController)
m_scrollAnchoringController->invalidateAnchorElement();
}
std::optional<FrameIdentifier> RenderLayerScrollableArea::rootFrameID() const
{
return m_layer.renderer().frame().rootFrame().frameID();
}
void RenderLayerScrollableArea::scrollbarWidthChanged(ScrollbarWidth width)
{
scrollbarsController().scrollbarWidthChanged(width);
availableContentSizeChanged(AvailableSizeChangeReason::ScrollbarsChanged);
}
} // namespace WebCore
|