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 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479
|
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* 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 http://mozilla.org/MPL/2.0/. */
#include "nsMenuPopupFrame.h"
#include <algorithm>
#include "LayoutConstants.h"
#include "X11UndefineNone.h"
#include "XULButtonElement.h"
#include "XULPopupElement.h"
#include "mozilla/AnimationUtils.h"
#include "mozilla/BasePrincipal.h"
#include "mozilla/ClearOnShutdown.h"
#include "mozilla/ComputedStyle.h"
#include "mozilla/EventDispatcher.h"
#include "mozilla/EventStateManager.h"
#include "mozilla/LookAndFeel.h"
#include "mozilla/MouseEvents.h"
#include "mozilla/Preferences.h"
#include "mozilla/PresShell.h"
#include "mozilla/ScrollContainerFrame.h"
#include "mozilla/Services.h"
#include "mozilla/dom/BrowserParent.h"
#include "mozilla/dom/Document.h"
#include "mozilla/dom/Element.h"
#include "mozilla/dom/Event.h"
#include "mozilla/dom/KeyboardEvent.h"
#include "mozilla/dom/KeyboardEventBinding.h"
#include "mozilla/dom/XULPopupElement.h"
#include "mozilla/widget/ScreenManager.h"
#include "nsAtom.h"
#include "nsCSSFrameConstructor.h"
#include "nsCSSRendering.h"
#include "nsContentUtils.h"
#include "nsDisplayList.h"
#include "nsExpirationTracker.h"
#include "nsFrameManager.h"
#include "nsGkAtoms.h"
#include "nsIBaseWindow.h"
#include "nsIContent.h"
#include "nsIDOMXULSelectCntrlEl.h"
#include "nsIDocShell.h"
#include "nsIDocShellTreeOwner.h"
#include "nsIFrameInlines.h"
#include "nsIPopupContainer.h"
#include "nsIReflowCallback.h"
#include "nsIScreenManager.h"
#include "nsISound.h"
#include "nsLayoutUtils.h"
#include "nsNameSpaceManager.h"
#include "nsPIDOMWindow.h"
#include "nsPIWindowRoot.h"
#include "nsPresContext.h"
#include "nsReadableUtils.h"
#include "nsRect.h"
#include "nsServiceManagerUtils.h"
#include "nsStyleConsts.h"
#include "nsStyleStructInlines.h"
#include "nsTransitionManager.h"
#include "nsUnicharUtils.h"
#include "nsViewManager.h"
#include "nsWidgetsCID.h"
#include "nsXULPopupManager.h"
using namespace mozilla;
using mozilla::dom::Document;
using mozilla::dom::Element;
using mozilla::dom::Event;
using mozilla::dom::XULButtonElement;
TimeStamp nsMenuPopupFrame::sLastKeyTime;
#ifdef MOZ_WAYLAND
# include "mozilla/WidgetUtilsGtk.h"
# define IS_WAYLAND_DISPLAY() mozilla::widget::GdkIsWaylandDisplay()
extern mozilla::LazyLogModule gWidgetPopupLog;
# define LOG_WAYLAND(...) \
MOZ_LOG(gWidgetPopupLog, mozilla::LogLevel::Debug, (__VA_ARGS__))
#else
# define IS_WAYLAND_DISPLAY() false
# define LOG_WAYLAND(...)
#endif
nsIFrame* NS_NewMenuPopupFrame(PresShell* aPresShell, ComputedStyle* aStyle) {
return new (aPresShell)
nsMenuPopupFrame(aStyle, aPresShell->GetPresContext());
}
NS_IMPL_FRAMEARENA_HELPERS(nsMenuPopupFrame)
NS_QUERYFRAME_HEAD(nsMenuPopupFrame)
NS_QUERYFRAME_ENTRY(nsMenuPopupFrame)
NS_QUERYFRAME_TAIL_INHERITING(nsBlockFrame)
// Three generations of 5000ms (so 15s to get rid of all the closed popups).
class PopupExpirationTracker final
: public nsExpirationTracker<nsMenuPopupFrame, 3> {
static StaticAutoPtr<PopupExpirationTracker> sInstance;
void NotifyExpired(nsMenuPopupFrame* aPopup) override {
// printf_stderr("PopupExpirationTracker::NotifyExpired(%s)\n",
// aPopup->ListTag().get());
RemoveObject(aPopup);
aPopup->DestroyWidgetIfNeeded();
}
public:
PopupExpirationTracker()
: nsExpirationTracker(5000 /* ms */, "PopupExpirationTracker"_ns) {}
static PopupExpirationTracker* Get() { return sInstance.get(); }
static PopupExpirationTracker& GetOrCreate() {
if (!sInstance) {
sInstance = new PopupExpirationTracker();
ClearOnShutdown(&sInstance);
}
return *sInstance;
}
};
StaticAutoPtr<PopupExpirationTracker> PopupExpirationTracker::sInstance;
nsMenuPopupFrame::nsMenuPopupFrame(ComputedStyle* aStyle,
nsPresContext* aPresContext)
: nsBlockFrame(aStyle, aPresContext, kClassID) {}
nsMenuPopupFrame::~nsMenuPopupFrame() = default;
static bool IsMouseTransparent(const ComputedStyle& aStyle) {
// If pointer-events: none; is set on the popup, then the widget should
// ignore mouse events, passing them through to the content behind.
return aStyle.PointerEvents() == StylePointerEvents::None;
}
static nsIWidget::InputRegion ComputeInputRegion(const ComputedStyle& aStyle,
const nsPresContext& aPc) {
return {IsMouseTransparent(aStyle),
(aStyle.StyleUIReset()->mMozWindowInputRegionMargin.ToCSSPixels() *
aPc.CSSToDevPixelScale())
.Truncated()};
}
bool nsMenuPopupFrame::IsDragPopup() const {
return !mInContentShell && mPopupType == PopupType::Panel &&
mContent->AsElement()->AttrValueIs(kNameSpaceID_None, nsGkAtoms::type,
nsGkAtoms::drag, eIgnoreCase);
}
bool nsMenuPopupFrame::ShouldHaveWidgetWhenHidden() const {
if (mContent->AsElement()->HasAttr(nsGkAtoms::neverhidden)) {
// Create a widget upfront for panels that never hide frames for their
// contents (like web extension popups). These, for now, need to create the
// widgets upfront, so that the frames inside the popup don't get
// "reparented" in the widget tree.
//
// TODO(emilio, bug 1976324): Try to somehow remove this special-case,
// web-ext panel needs it to compute the "natural" bounds of their contents
// before showing the popup, but that seems like it could be tweaked.
return true;
}
if (IsDragPopup()) {
// Create widgets upfront for the drag popup for now, see bug 1976623.
return true;
}
return false;
}
void nsMenuPopupFrame::Init(nsIContent* aContent, nsContainerFrame* aParent,
nsIFrame* aPrevInFlow) {
nsBlockFrame::Init(aContent, aParent, aPrevInFlow);
CreatePopupView();
nsView* ourView = GetView();
const auto& el = PopupElement();
mPopupType = PopupType::Panel;
if (el.IsMenu()) {
mPopupType = PopupType::Menu;
} else if (el.IsXULElement(nsGkAtoms::tooltip)) {
mPopupType = PopupType::Tooltip;
}
if (PresContext()->IsChrome()) {
mInContentShell = false;
}
// Support incontentshell=false attribute to allow popups to be displayed
// outside of the content shell. Chrome only.
if (el.NodePrincipal()->IsSystemPrincipal()) {
if (el.GetXULBoolAttr(nsGkAtoms::incontentshell)) {
mInContentShell = true;
} else if (el.AttrValueIs(kNameSpaceID_None, nsGkAtoms::incontentshell,
nsGkAtoms::_false, eCaseMatters)) {
mInContentShell = false;
}
}
if (!ourView->HasWidget() && ShouldHaveWidgetWhenHidden()) {
CreateWidgetForView(ourView);
}
AddStateBits(NS_FRAME_IN_POPUP);
}
bool nsMenuPopupFrame::HasRemoteContent() const {
return !mInContentShell && mPopupType == PopupType::Panel &&
mContent->AsElement()->AttrValueIs(kNameSpaceID_None,
nsGkAtoms::remote, nsGkAtoms::_true,
eIgnoreCase);
}
bool nsMenuPopupFrame::IsNoAutoHide() const {
// Panels with noautohide="true" don't hide when the mouse is clicked
// outside of them, or when another application is made active. Non-autohide
// panels cannot be used in content windows.
return !mInContentShell && mPopupType == PopupType::Panel &&
mContent->AsElement()->AttrValueIs(kNameSpaceID_None,
nsGkAtoms::noautohide,
nsGkAtoms::_true, eIgnoreCase);
}
widget::PopupLevel nsMenuPopupFrame::GetPopupLevel(bool aIsNoAutoHide) const {
// The popup level is determined as follows, in this order:
// 1. non-panels (menus and tooltips) are always topmost
// 2. any specified level attribute
// 3. if a titlebar attribute is set, use the 'floating' level
// 4. if this is a noautohide panel, use the 'parent' level
// 5. use the platform-specific default level
// If this is not a panel, this is always a top-most popup.
if (mPopupType != PopupType::Panel) {
return PopupLevel::Top;
}
// If the level attribute has been set, use that.
static Element::AttrValuesArray strings[] = {nsGkAtoms::top,
nsGkAtoms::parent, nullptr};
switch (mContent->AsElement()->FindAttrValueIn(
kNameSpaceID_None, nsGkAtoms::level, strings, eCaseMatters)) {
case 0:
return PopupLevel::Top;
case 1:
return PopupLevel::Parent;
default:
break;
}
// If this panel is a noautohide panel, the default is the parent level.
if (aIsNoAutoHide) {
return PopupLevel::Parent;
}
// Otherwise, the result depends on the platform.
return StaticPrefs::ui_panel_default_level_parent() ? PopupLevel::Parent
: PopupLevel::Top;
}
void nsMenuPopupFrame::PrepareWidget(bool aForceRecreate) {
if (mExpirationState.IsTracked()) {
PopupExpirationTracker::Get()->RemoveObject(this);
}
nsView* ourView = GetView();
if (auto* widget = GetWidget()) {
nsCOMPtr<nsIWidget> parent = ComputeParentWidget();
if (aForceRecreate || widget->GetParent() != parent ||
widget->NeedsRecreateToReshow()) {
// Widget's WebRender resources needs to be cleared before creating new
// widget.
widget->ClearCachedWebrenderResources();
ourView->DestroyWidget();
}
}
if (!ourView->HasWidget()) {
CreateWidgetForView(ourView);
} else {
PropagateStyleToWidget();
}
}
already_AddRefed<nsIWidget> nsMenuPopupFrame::ComputeParentWidget() const {
auto popupLevel = GetPopupLevel(IsNoAutoHide());
// Panels which have a parent level need a parent widget. This allows them to
// always appear in front of the parent window but behind other windows that
// should be in front of it.
nsCOMPtr<nsIWidget> parentWidget;
if (popupLevel != PopupLevel::Top) {
nsCOMPtr<nsIDocShellTreeItem> dsti = PresContext()->GetDocShell();
if (!dsti) {
return nullptr;
}
nsCOMPtr<nsIDocShellTreeOwner> treeOwner;
dsti->GetTreeOwner(getter_AddRefs(treeOwner));
if (!treeOwner) {
return nullptr;
}
if (nsCOMPtr<nsIBaseWindow> baseWindow = do_QueryInterface(treeOwner)) {
parentWidget = baseWindow->GetMainWidget();
}
}
if (!parentWidget && mView && mView->GetParent()) {
parentWidget = mView->GetParent()->GetNearestWidget(nullptr);
}
return parentWidget.forget();
}
nsresult nsMenuPopupFrame::CreateWidgetForView(nsView* aView) {
// Create a widget for ourselves.
widget::InitData widgetData;
widgetData.mWindowType = widget::WindowType::Popup;
widgetData.mBorderStyle = widget::BorderStyle::Default;
widgetData.mClipSiblings = true;
widgetData.mPopupHint = mPopupType;
widgetData.mIsDragPopup = IsDragPopup();
const bool remote = HasRemoteContent();
const auto mode = nsLayoutUtils::GetFrameTransparency(this, this);
widgetData.mHasRemoteContent = remote;
widgetData.mTransparencyMode = mode;
widgetData.mPopupLevel = GetPopupLevel(IsNoAutoHide());
nsCOMPtr<nsIWidget> parentWidget = ComputeParentWidget();
if (NS_WARN_IF(!parentWidget)) {
return NS_ERROR_FAILURE;
}
nsresult rv = aView->CreateWidgetForPopup(&widgetData, parentWidget);
if (NS_FAILED(rv)) {
return rv;
}
nsIWidget* widget = aView->GetWidget();
MOZ_ASSERT(widget->GetParent() == parentWidget);
widget->SetTransparencyMode(mode);
PropagateStyleToWidget();
return NS_OK;
}
void nsMenuPopupFrame::PropagateStyleToWidget(WidgetStyleFlags aFlags) const {
if (aFlags.isEmpty()) {
return;
}
nsIWidget* widget = GetWidget();
if (!widget) {
return;
}
if (aFlags.contains(WidgetStyle::ColorScheme)) {
widget->SetColorScheme(Some(LookAndFeel::ColorSchemeForFrame(this)));
}
if (aFlags.contains(WidgetStyle::InputRegion)) {
widget->SetInputRegion(ComputeInputRegion(*Style(), *PresContext()));
}
if (aFlags.contains(WidgetStyle::Opacity)) {
widget->SetWindowOpacity(StyleUIReset()->mWindowOpacity);
}
if (aFlags.contains(WidgetStyle::Shadow)) {
widget->SetWindowShadowStyle(GetShadowStyle());
}
if (aFlags.contains(WidgetStyle::Transform)) {
widget->SetWindowTransform(ComputeWidgetTransform());
}
if (aFlags.contains(WidgetStyle::MicaBackdrop)) {
widget->SetMicaBackdrop(StyleDisplay()->EffectiveAppearance() ==
StyleAppearance::Menupopup);
}
}
bool nsMenuPopupFrame::IsMouseTransparent() const {
return ::IsMouseTransparent(*Style());
}
WindowShadow nsMenuPopupFrame::GetShadowStyle() const {
StyleWindowShadow shadow = StyleUIReset()->mWindowShadow;
if (shadow != StyleWindowShadow::Auto) {
MOZ_ASSERT(shadow == StyleWindowShadow::None);
return WindowShadow::None;
}
switch (StyleDisplay()->EffectiveAppearance()) {
case StyleAppearance::Tooltip:
return WindowShadow::Tooltip;
case StyleAppearance::Menupopup:
return WindowShadow::Menu;
default:
return WindowShadow::Panel;
}
}
void nsMenuPopupFrame::SetPopupState(nsPopupState aState) {
mPopupState = aState;
// Work around https://gitlab.gnome.org/GNOME/gtk/-/issues/4166
if (aState == ePopupShown && IS_WAYLAND_DISPLAY()) {
if (nsIWidget* widget = GetWidget()) {
widget->SetInputRegion(ComputeInputRegion(*Style(), *PresContext()));
}
}
}
// TODO: Convert this to MOZ_CAN_RUN_SCRIPT (bug 1415230, bug 1535398)
MOZ_CAN_RUN_SCRIPT_BOUNDARY NS_IMETHODIMP nsXULPopupShownEvent::Run() {
nsMenuPopupFrame* popup = do_QueryFrame(mPopup->GetPrimaryFrame());
// Set the state to visible if the popup is still open.
if (popup && popup->IsOpen()) {
popup->SetPopupState(ePopupShown);
}
if (!mPopup->IsXULElement(nsGkAtoms::tooltip)) {
nsCOMPtr<nsIObserverService> obsService =
mozilla::services::GetObserverService();
if (obsService) {
obsService->NotifyObservers(mPopup, "popup-shown", nullptr);
}
}
WidgetMouseEvent event(true, eXULPopupShown, nullptr,
WidgetMouseEvent::eReal);
return EventDispatcher::Dispatch(mPopup, mPresContext, &event);
}
NS_IMETHODIMP nsXULPopupShownEvent::HandleEvent(Event* aEvent) {
nsMenuPopupFrame* popup = do_QueryFrame(mPopup->GetPrimaryFrame());
// Ignore events not targeted at the popup itself (ie targeted at
// descendants):
if (mPopup != aEvent->GetTarget()) {
return NS_OK;
}
if (popup) {
// ResetPopupShownDispatcher will delete the reference to this, so keep
// another one until Run is finished.
RefPtr<nsXULPopupShownEvent> event = this;
// Only call Run if it the dispatcher was assigned. This avoids calling the
// Run method if the transitionend event fires multiple times.
if (popup->ClearPopupShownDispatcher()) {
return Run();
}
}
CancelListener();
return NS_OK;
}
void nsXULPopupShownEvent::CancelListener() {
mPopup->RemoveSystemEventListener(u"transitionend"_ns, this, false);
}
NS_IMPL_ISUPPORTS_INHERITED(nsXULPopupShownEvent, Runnable,
nsIDOMEventListener);
void nsMenuPopupFrame::DidSetComputedStyle(ComputedStyle* aOldStyle) {
nsBlockFrame::DidSetComputedStyle(aOldStyle);
if (!aOldStyle) {
return;
}
WidgetStyleFlags flags;
if (aOldStyle->StyleUI()->mColorScheme != StyleUI()->mColorScheme) {
flags += WidgetStyle::ColorScheme;
}
auto& newUI = *StyleUIReset();
auto& oldUI = *aOldStyle->StyleUIReset();
if (newUI.mWindowOpacity != oldUI.mWindowOpacity) {
flags += WidgetStyle::Opacity;
}
if (newUI.mMozWindowTransform != oldUI.mMozWindowTransform) {
flags += WidgetStyle::Transform;
}
if (newUI.mWindowShadow != oldUI.mWindowShadow) {
flags += WidgetStyle::Shadow;
}
if (aOldStyle->StyleDisplay()->EffectiveAppearance() !=
StyleDisplay()->EffectiveAppearance()) {
flags += WidgetStyle::MicaBackdrop;
}
const auto& pc = *PresContext();
auto oldRegion = ComputeInputRegion(*aOldStyle, pc);
auto newRegion = ComputeInputRegion(*Style(), pc);
if (oldRegion.mFullyTransparent != newRegion.mFullyTransparent ||
oldRegion.mMargin != newRegion.mMargin) {
flags += WidgetStyle::InputRegion;
}
PropagateStyleToWidget(flags);
}
nscoord nsMenuPopupFrame::IntrinsicISize(const IntrinsicSizeInput& aInput,
IntrinsicISizeType aType) {
nscoord iSize = nsBlockFrame::IntrinsicISize(aInput, aType);
if (!ShouldExpandToInflowParentOrAnchor()) {
return iSize;
}
// Make sure to accommodate for our scrollbar if needed. Do it only for
// menulists to match previous behavior.
//
// NOTE(emilio): This is somewhat hacky. The "right" fix (which would be
// using scrollbar-gutter: stable on the scroller) isn't great, because even
// though we want a stable gutter, we want to draw on top of the gutter when
// there's no scrollbar, otherwise it looks rather weird.
//
// Automatically accommodating for the scrollbar otherwise would be bug
// 764076, but that has its own set of problems.
if (ScrollContainerFrame* sf = GetScrollContainerFrame()) {
iSize += sf->GetDesiredScrollbarSizes().LeftRight();
}
nscoord menuListOrAnchorWidth = 0;
if (nsIFrame* menuList = GetInFlowParent()) {
menuListOrAnchorWidth = menuList->GetRect().width;
}
if (mAnchorType == MenuPopupAnchorType::Rect) {
menuListOrAnchorWidth = std::max(menuListOrAnchorWidth, mScreenRect.width);
}
// Input margin doesn't have contents, so account for it for popup sizing
// purposes.
menuListOrAnchorWidth +=
2 * StyleUIReset()->mMozWindowInputRegionMargin.ToAppUnits();
return std::max(iSize, menuListOrAnchorWidth);
}
void nsMenuPopupFrame::Reflow(nsPresContext* aPresContext,
ReflowOutput& aDesiredSize,
const ReflowInput& aReflowInput,
nsReflowStatus& aStatus) {
MarkInReflow();
DO_GLOBAL_REFLOW_COUNT("nsMenuPopupFrame");
MOZ_ASSERT(aStatus.IsEmpty(), "Caller should pass a fresh reflow status!");
const auto wm = GetWritingMode();
// Default to preserving our bounds.
aDesiredSize.SetSize(wm, GetLogicalSize(wm));
LayoutPopup(aPresContext, aDesiredSize, aReflowInput, aStatus);
aDesiredSize.SetBlockStartAscent(aDesiredSize.BSize(wm));
aDesiredSize.SetOverflowAreasToDesiredBounds();
FinishAndStoreOverflow(&aDesiredSize, aReflowInput.mStyleDisplay);
}
void nsMenuPopupFrame::EnsureActiveMenuListItemIsVisible() {
if (!IsMenuList() || !IsOpen()) {
return;
}
nsIFrame* frame = GetCurrentMenuItemFrame();
if (!frame) {
return;
}
RefPtr<mozilla::PresShell> presShell = PresShell();
presShell->ScrollFrameIntoView(
frame, Nothing(), ScrollAxis(), ScrollAxis(),
ScrollFlags::ScrollOverflowHidden | ScrollFlags::ScrollFirstAncestorOnly);
}
void nsMenuPopupFrame::LayoutPopup(nsPresContext* aPresContext,
ReflowOutput& aDesiredSize,
const ReflowInput& aReflowInput,
nsReflowStatus& aStatus) {
if (IsNativeMenu()) {
return;
}
SchedulePaint();
const bool isOpen = IsOpen();
if (!isOpen) {
// If the popup is not open, only do layout while showing or if we're a
// menulist.
//
// This is needed because the SelectParent code wants to limit the height of
// the popup before opening it.
//
// TODO(emilio): We should consider adding a way to do that more reliably
// instead, but this preserves existing behavior.
const bool needsLayout = mPopupState == ePopupShowing ||
mPopupState == ePopupPositioning || IsMenuList();
if (!needsLayout) {
RemoveStateBits(NS_FRAME_FIRST_REFLOW);
return;
}
}
// Do a first reflow, with all our content, in order to find our preferred
// size. Then, we do a second reflow with the updated dimensions.
const bool needsPrefSize = mPrefSize == nsSize(-1, -1) || IsSubtreeDirty();
if (needsPrefSize) {
// Get the preferred, minimum and maximum size. If the menu is sized to the
// popup, then the popup's width is the menu's width.
ReflowOutput preferredSize(aReflowInput);
nsBlockFrame::Reflow(aPresContext, preferredSize, aReflowInput, aStatus);
mPrefSize = preferredSize.PhysicalSize();
}
// Get our desired position and final size, now that we have a preferred size.
auto constraints = GetRects(mPrefSize);
const auto finalSize = constraints.mUsedRect.Size();
// We need to do an extra reflow if we haven't reflowed, our size doesn't
// match with our final intended size, or our bsize is unconstrained (in which
// case we need to specify the final size so that percentages work).
const bool needDefiniteReflow =
aReflowInput.ComputedBSize() == NS_UNCONSTRAINEDSIZE || !needsPrefSize ||
finalSize != mPrefSize;
if (needDefiniteReflow) {
ReflowInput constrainedReflowInput(aReflowInput);
const auto& bp = aReflowInput.ComputedPhysicalBorderPadding();
// TODO: writing-mode handling not terribly correct, but it doesn't matter.
const nsSize finalContentSize(finalSize.width - bp.LeftRight(),
finalSize.height - bp.TopBottom());
constrainedReflowInput.SetComputedISize(finalContentSize.width);
constrainedReflowInput.SetComputedBSize(finalContentSize.height);
constrainedReflowInput.SetIResize(finalSize.width != mPrefSize.width);
constrainedReflowInput.SetBResize([&] {
if (finalSize.height != mPrefSize.height) {
return true;
}
if (needsPrefSize &&
aReflowInput.ComputedBSize() == NS_UNCONSTRAINEDSIZE &&
aReflowInput.ComputedMaxBSize() == finalContentSize.height) {
// If we have measured, and maybe clamped our children via max-height,
// they might need to get percentages in the block axis re-resolved.
return true;
}
return false;
}());
aStatus.Reset();
nsBlockFrame::Reflow(aPresContext, aDesiredSize, constrainedReflowInput,
aStatus);
}
// Set our size, since nsAbsoluteContainingBlock won't.
SetRect(constraints.mUsedRect);
nsView* view = GetView();
if (isOpen) {
nsViewManager* viewManager = view->GetViewManager();
viewManager->ResizeView(view,
nsRect(nsPoint(), constraints.mUsedRect.Size()));
if (mPopupState == ePopupOpening) {
mPopupState = ePopupVisible;
}
viewManager->SetViewVisibility(view, ViewVisibility::Show);
SyncFrameViewProperties(view);
}
// Perform our move now. That will position the view and so on.
PerformMove(constraints);
// finally, if the popup just opened, send a popupshown event
bool openChanged = mIsOpenChanged;
if (openChanged) {
mIsOpenChanged = false;
// Make sure the current selection in a menulist is visible.
EnsureActiveMenuListItemIsVisible();
// If the animate attribute is set to open, check for a transition and wait
// for it to finish before firing the popupshown event.
if (LookAndFeel::GetInt(LookAndFeel::IntID::PanelAnimations) &&
mContent->AsElement()->AttrValueIs(kNameSpaceID_None,
nsGkAtoms::animate, nsGkAtoms::open,
eCaseMatters) &&
AnimationUtils::HasCurrentTransitions(mContent->AsElement())) {
mPopupShownDispatcher = new nsXULPopupShownEvent(mContent, aPresContext);
mContent->AddSystemEventListener(u"transitionend"_ns,
mPopupShownDispatcher, false, false);
return;
}
// If there are no transitions, fire the popupshown event right away.
nsCOMPtr<nsIRunnable> event =
new nsXULPopupShownEvent(GetContent(), aPresContext);
mContent->OwnerDoc()->Dispatch(event.forget());
}
}
bool nsMenuPopupFrame::IsMenuList() const {
return PopupElement().IsInMenuList();
}
bool nsMenuPopupFrame::ShouldExpandToInflowParentOrAnchor() const {
return IsMenuList() && !mContent->GetParent()->AsElement()->AttrValueIs(
kNameSpaceID_None, nsGkAtoms::sizetopopup,
nsGkAtoms::none, eCaseMatters);
}
nsIContent* nsMenuPopupFrame::GetTriggerContent(
nsMenuPopupFrame* aMenuPopupFrame) {
while (aMenuPopupFrame) {
if (aMenuPopupFrame->mTriggerContent) {
return aMenuPopupFrame->mTriggerContent;
}
auto* button = XULButtonElement::FromNodeOrNull(
aMenuPopupFrame->GetContent()->GetParent());
if (!button || !button->IsMenu()) {
break;
}
auto* popup = button->GetContainingPopupElement();
if (!popup) {
break;
}
// check up the menu hierarchy until a popup with a trigger node is found
aMenuPopupFrame = do_QueryFrame(popup->GetPrimaryFrame());
}
return nullptr;
}
void nsMenuPopupFrame::InitPositionFromAnchorAlign(const nsAString& aAnchor,
const nsAString& aAlign) {
mTriggerContent = nullptr;
if (aAnchor.EqualsLiteral("topleft")) {
mPopupAnchor = POPUPALIGNMENT_TOPLEFT;
} else if (aAnchor.EqualsLiteral("topright")) {
mPopupAnchor = POPUPALIGNMENT_TOPRIGHT;
} else if (aAnchor.EqualsLiteral("bottomleft")) {
mPopupAnchor = POPUPALIGNMENT_BOTTOMLEFT;
} else if (aAnchor.EqualsLiteral("bottomright")) {
mPopupAnchor = POPUPALIGNMENT_BOTTOMRIGHT;
} else if (aAnchor.EqualsLiteral("leftcenter")) {
mPopupAnchor = POPUPALIGNMENT_LEFTCENTER;
} else if (aAnchor.EqualsLiteral("rightcenter")) {
mPopupAnchor = POPUPALIGNMENT_RIGHTCENTER;
} else if (aAnchor.EqualsLiteral("topcenter")) {
mPopupAnchor = POPUPALIGNMENT_TOPCENTER;
} else if (aAnchor.EqualsLiteral("bottomcenter")) {
mPopupAnchor = POPUPALIGNMENT_BOTTOMCENTER;
} else {
mPopupAnchor = POPUPALIGNMENT_NONE;
}
if (aAlign.EqualsLiteral("topleft")) {
mPopupAlignment = POPUPALIGNMENT_TOPLEFT;
} else if (aAlign.EqualsLiteral("topright")) {
mPopupAlignment = POPUPALIGNMENT_TOPRIGHT;
} else if (aAlign.EqualsLiteral("bottomleft")) {
mPopupAlignment = POPUPALIGNMENT_BOTTOMLEFT;
} else if (aAlign.EqualsLiteral("bottomright")) {
mPopupAlignment = POPUPALIGNMENT_BOTTOMRIGHT;
} else if (aAlign.EqualsLiteral("leftcenter")) {
mPopupAlignment = POPUPALIGNMENT_LEFTCENTER;
} else if (aAlign.EqualsLiteral("rightcenter")) {
mPopupAlignment = POPUPALIGNMENT_RIGHTCENTER;
} else if (aAlign.EqualsLiteral("topcenter")) {
mPopupAlignment = POPUPALIGNMENT_TOPCENTER;
} else if (aAlign.EqualsLiteral("bottomcenter")) {
mPopupAlignment = POPUPALIGNMENT_BOTTOMCENTER;
} else {
mPopupAlignment = POPUPALIGNMENT_NONE;
}
mPosition = POPUPPOSITION_UNKNOWN;
}
static FlipType FlipFromAttribute(nsMenuPopupFrame* aFrame) {
nsAutoString flip;
aFrame->PopupElement().GetAttr(nsGkAtoms::flip, flip);
if (flip.EqualsLiteral("none")) {
return FlipType::None;
}
if (flip.EqualsLiteral("both")) {
return FlipType::Both;
}
if (flip.EqualsLiteral("slide")) {
return FlipType::Slide;
}
return FlipType::Default;
}
void nsMenuPopupFrame::InitializePopup(nsIContent* aAnchorContent,
nsIContent* aTriggerContent,
const nsAString& aPosition,
int32_t aXPos, int32_t aYPos,
MenuPopupAnchorType aAnchorType,
bool aAttributesOverride) {
PrepareWidget();
mPopupState = ePopupShowing;
mAnchorContent = aAnchorContent;
mAnchorType = aAnchorType;
const nscoord auPerCssPx = AppUnitsPerCSSPixel();
const nsPoint pos = CSSPixel::ToAppUnits(CSSIntPoint(aXPos, aYPos));
// When converted back to CSSIntRect it is (-1, -1, 0, 0) - as expected in
// nsXULPopupManager::Rollup
mScreenRect = nsRect(-auPerCssPx, -auPerCssPx, 0, 0);
mExtraMargin = pos;
// If we have no anchor node, anchor to the given position instead.
if (mAnchorType == MenuPopupAnchorType::Node && !aAnchorContent) {
mAnchorType = MenuPopupAnchorType::Point;
mScreenRect = nsRect(
pos + PresShell()->GetRootFrame()->GetScreenRectInAppUnits().TopLeft(),
nsSize());
mExtraMargin = {};
}
mTriggerContent = aTriggerContent;
mIsNativeMenu = false;
mIsTopLevelContextMenu = false;
mVFlip = false;
mHFlip = false;
mConstrainedByLayout = false;
mAlignmentOffset = 0;
mPositionedOffset = 0;
mPositionedByMoveToRect = false;
// if aAttributesOverride is true, then the popupanchor, popupalign and
// position attributes on the <menupopup> override those values passed in.
// If false, those attributes are only used if the values passed in are empty
if (aAnchorContent || aAnchorType == MenuPopupAnchorType::Rect) {
nsAutoString anchor, align, position;
mContent->AsElement()->GetAttr(nsGkAtoms::popupanchor, anchor);
mContent->AsElement()->GetAttr(nsGkAtoms::popupalign, align);
mContent->AsElement()->GetAttr(nsGkAtoms::position, position);
if (aAttributesOverride) {
// if the attributes are set, clear the offset position. Otherwise,
// the offset is used to adjust the position from the anchor point
if (anchor.IsEmpty() && align.IsEmpty() && position.IsEmpty()) {
position.Assign(aPosition);
}
} else if (!aPosition.IsEmpty()) {
position.Assign(aPosition);
}
mFlip = FlipFromAttribute(this);
position.CompressWhitespace();
int32_t spaceIdx = position.FindChar(' ');
// if there is a space in the position, assume it is the anchor and
// alignment as two separate tokens.
if (spaceIdx >= 0) {
InitPositionFromAnchorAlign(Substring(position, 0, spaceIdx),
Substring(position, spaceIdx + 1));
} else if (position.EqualsLiteral("before_start")) {
mPopupAnchor = POPUPALIGNMENT_TOPLEFT;
mPopupAlignment = POPUPALIGNMENT_BOTTOMLEFT;
mPosition = POPUPPOSITION_BEFORESTART;
} else if (position.EqualsLiteral("before_end")) {
mPopupAnchor = POPUPALIGNMENT_TOPRIGHT;
mPopupAlignment = POPUPALIGNMENT_BOTTOMRIGHT;
mPosition = POPUPPOSITION_BEFOREEND;
} else if (position.EqualsLiteral("after_start")) {
mPopupAnchor = POPUPALIGNMENT_BOTTOMLEFT;
mPopupAlignment = POPUPALIGNMENT_TOPLEFT;
mPosition = POPUPPOSITION_AFTERSTART;
} else if (position.EqualsLiteral("after_end")) {
mPopupAnchor = POPUPALIGNMENT_BOTTOMRIGHT;
mPopupAlignment = POPUPALIGNMENT_TOPRIGHT;
mPosition = POPUPPOSITION_AFTEREND;
} else if (position.EqualsLiteral("start_before")) {
mPopupAnchor = POPUPALIGNMENT_TOPLEFT;
mPopupAlignment = POPUPALIGNMENT_TOPRIGHT;
mPosition = POPUPPOSITION_STARTBEFORE;
} else if (position.EqualsLiteral("start_after")) {
mPopupAnchor = POPUPALIGNMENT_BOTTOMLEFT;
mPopupAlignment = POPUPALIGNMENT_BOTTOMRIGHT;
mPosition = POPUPPOSITION_STARTAFTER;
} else if (position.EqualsLiteral("end_before")) {
mPopupAnchor = POPUPALIGNMENT_TOPRIGHT;
mPopupAlignment = POPUPALIGNMENT_TOPLEFT;
mPosition = POPUPPOSITION_ENDBEFORE;
} else if (position.EqualsLiteral("end_after")) {
mPopupAnchor = POPUPALIGNMENT_BOTTOMRIGHT;
mPopupAlignment = POPUPALIGNMENT_BOTTOMLEFT;
mPosition = POPUPPOSITION_ENDAFTER;
} else if (position.EqualsLiteral("overlap")) {
mPopupAnchor = POPUPALIGNMENT_TOPLEFT;
mPopupAlignment = POPUPALIGNMENT_TOPLEFT;
mPosition = POPUPPOSITION_OVERLAP;
} else if (position.EqualsLiteral("selection")) {
mPopupAnchor = POPUPALIGNMENT_BOTTOMLEFT;
mPopupAlignment = POPUPALIGNMENT_TOPLEFT;
mPosition = POPUPPOSITION_SELECTION;
} else {
InitPositionFromAnchorAlign(anchor, align);
}
}
mUntransformedPopupAnchor = mPopupAnchor;
mUntransformedPopupAlignment = mPopupAlignment;
if (aAttributesOverride) {
// Use |left| and |top| dimension attributes to position the popup if
// present, as they may have been persisted.
nsAutoString left, top;
mContent->AsElement()->GetAttr(nsGkAtoms::left, left);
mContent->AsElement()->GetAttr(nsGkAtoms::top, top);
nsresult err;
if (!left.IsEmpty()) {
int32_t x = left.ToInteger(&err);
if (NS_SUCCEEDED(err)) {
mScreenRect.x = CSSPixel::ToAppUnits(x);
}
}
if (!top.IsEmpty()) {
int32_t y = top.ToInteger(&err);
if (NS_SUCCEEDED(err)) {
mScreenRect.y = CSSPixel::ToAppUnits(y);
}
}
}
}
void nsMenuPopupFrame::InitializePopupAtScreen(nsIContent* aTriggerContent,
int32_t aXPos, int32_t aYPos,
bool aIsContextMenu) {
PrepareWidget();
mPopupState = ePopupShowing;
mAnchorContent = nullptr;
mTriggerContent = aTriggerContent;
mScreenRect =
nsRect(CSSPixel::ToAppUnits(CSSIntPoint(aXPos, aYPos)), nsSize());
mExtraMargin = {};
mFlip = FlipFromAttribute(this);
mPopupAnchor = POPUPALIGNMENT_NONE;
mPopupAlignment = POPUPALIGNMENT_NONE;
mPosition = POPUPPOSITION_UNKNOWN;
mIsContextMenu = aIsContextMenu;
mIsTopLevelContextMenu = aIsContextMenu;
mIsNativeMenu = false;
mAnchorType = MenuPopupAnchorType::Point;
mPositionedOffset = 0;
mPositionedByMoveToRect = false;
}
void nsMenuPopupFrame::InitializePopupAsNativeContextMenu(
nsIContent* aTriggerContent, int32_t aXPos, int32_t aYPos) {
mTriggerContent = aTriggerContent;
mPopupState = ePopupShowing;
mAnchorContent = nullptr;
mScreenRect =
nsRect(CSSPixel::ToAppUnits(CSSIntPoint(aXPos, aYPos)), nsSize());
mExtraMargin = {};
mFlip = FlipType::Default;
mPopupAnchor = POPUPALIGNMENT_NONE;
mPopupAlignment = POPUPALIGNMENT_NONE;
mPosition = POPUPPOSITION_UNKNOWN;
mIsContextMenu = true;
mIsTopLevelContextMenu = true;
mIsNativeMenu = true;
mAnchorType = MenuPopupAnchorType::Point;
mPositionedOffset = 0;
mPositionedByMoveToRect = false;
}
void nsMenuPopupFrame::InitializePopupAtRect(nsIContent* aTriggerContent,
const nsAString& aPosition,
const nsIntRect& aRect,
bool aAttributesOverride) {
InitializePopup(nullptr, aTriggerContent, aPosition, 0, 0,
MenuPopupAnchorType::Rect, aAttributesOverride);
mScreenRect = ToAppUnits(aRect, AppUnitsPerCSSPixel());
}
void nsMenuPopupFrame::ShowPopup(bool aIsContextMenu) {
mIsContextMenu = aIsContextMenu;
InvalidateFrameSubtree();
if (mPopupState == ePopupShowing || mPopupState == ePopupPositioning) {
mPopupState = ePopupOpening;
mIsOpenChanged = true;
// Clear mouse capture when a popup is opened.
if (mPopupType == PopupType::Menu) {
if (auto* activeESM = EventStateManager::GetActiveEventStateManager()) {
EventStateManager::ClearGlobalActiveContent(activeESM);
}
PresShell::ReleaseCapturingContent();
}
if (RefPtr menu = PopupElement().GetContainingMenu()) {
menu->PopupOpened();
}
// We skip laying out children if we're closed, so make sure that we do a
// full dirty reflow when opening to pick up any potential change.
PresShell()->FrameNeedsReflow(
this, IntrinsicDirty::FrameAncestorsAndDescendants, NS_FRAME_IS_DIRTY);
if (mPopupType == PopupType::Menu) {
nsCOMPtr<nsISound> sound(do_GetService("@mozilla.org/sound;1"));
if (sound) {
sound->PlayEventSound(nsISound::EVENT_MENU_POPUP);
}
}
}
}
void nsMenuPopupFrame::ClearTriggerContentIncludingDocument() {
// clear the trigger content if the popup is being closed. But don't clear
// it if the popup is just being made invisible as a popuphiding or command
if (mTriggerContent) {
// if the popup had a trigger node set, clear the global window popup node
// as well
Document* doc = mContent->GetUncomposedDoc();
if (doc) {
if (nsPIDOMWindowOuter* win = doc->GetWindow()) {
nsCOMPtr<nsPIWindowRoot> root = win->GetTopWindowRoot();
if (root) {
root->SetPopupNode(nullptr);
}
}
}
}
mTriggerContent = nullptr;
}
void nsMenuPopupFrame::HidePopup(bool aDeselectMenu, nsPopupState aNewState,
bool aFromFrameDestruction) {
NS_ASSERTION(aNewState == ePopupClosed || aNewState == ePopupInvisible,
"popup being set to unexpected state");
ClearPopupShownDispatcher();
// don't hide the popup when it isn't open
if (mPopupState == ePopupClosed || mPopupState == ePopupShowing ||
mPopupState == ePopupPositioning) {
return;
}
if (aNewState == ePopupClosed) {
// clear the trigger content if the popup is being closed. But don't clear
// it if the popup is just being made invisible as a popuphiding or command
// event may want to retrieve it.
ClearTriggerContentIncludingDocument();
mAnchorContent = nullptr;
}
// when invisible and about to be closed, HidePopup has already been called,
// so just set the new state to closed and return
if (mPopupState == ePopupInvisible) {
if (aNewState == ePopupClosed) {
mPopupState = ePopupClosed;
}
return;
}
mPopupState = aNewState;
mIncrementalString.Truncate();
mIsOpenChanged = false;
mHFlip = mVFlip = false;
mConstrainedByLayout = false;
if (auto* widget = GetWidget()) {
widget->ClearCachedWebrenderResources();
if (!aFromFrameDestruction && !ShouldHaveWidgetWhenHidden()) {
PopupExpirationTracker::GetOrCreate().AddObject(this);
}
}
nsView* view = GetView();
nsViewManager* viewManager = view->GetViewManager();
viewManager->SetViewVisibility(view, ViewVisibility::Hide);
RefPtr popup = &PopupElement();
// XXX, bug 137033, In Windows, if mouse is outside the window when the
// menupopup closes, no mouse_enter/mouse_exit event will be fired to clear
// current hover state, we should clear it manually. This code may not the
// best solution, but we can leave it here until we find the better approach.
if (!aFromFrameDestruction &&
popup->State().HasState(dom::ElementState::HOVER)) {
EventStateManager* esm = PresContext()->EventStateManager();
esm->SetContentState(nullptr, dom::ElementState::HOVER);
}
popup->PopupClosed(aDeselectMenu);
}
nsPoint nsMenuPopupFrame::AdjustPositionForAnchorAlign(
nsRect& anchorRect, const nsSize& aPrefSize, FlipStyle& aHFlip,
FlipStyle& aVFlip) const {
// flip the anchor and alignment for right-to-left
int8_t popupAnchor(mPopupAnchor);
int8_t popupAlign(mPopupAlignment);
if (IsDirectionRTL()) {
// no need to flip the centered anchor types vertically
if (popupAnchor <= POPUPALIGNMENT_LEFTCENTER) {
popupAnchor = -popupAnchor;
}
popupAlign = -popupAlign;
}
nsRect originalAnchorRect(anchorRect);
// first, determine at which corner of the anchor the popup should appear
nsPoint pnt;
switch (popupAnchor) {
case POPUPALIGNMENT_LEFTCENTER:
pnt = nsPoint(anchorRect.x, anchorRect.y + anchorRect.height / 2);
anchorRect.y = pnt.y;
anchorRect.height = 0;
break;
case POPUPALIGNMENT_RIGHTCENTER:
pnt = nsPoint(anchorRect.XMost(), anchorRect.y + anchorRect.height / 2);
anchorRect.y = pnt.y;
anchorRect.height = 0;
break;
case POPUPALIGNMENT_TOPCENTER:
pnt = nsPoint(anchorRect.x + anchorRect.width / 2, anchorRect.y);
anchorRect.x = pnt.x;
anchorRect.width = 0;
break;
case POPUPALIGNMENT_BOTTOMCENTER:
pnt = nsPoint(anchorRect.x + anchorRect.width / 2, anchorRect.YMost());
anchorRect.x = pnt.x;
anchorRect.width = 0;
break;
case POPUPALIGNMENT_TOPRIGHT:
pnt = anchorRect.TopRight();
break;
case POPUPALIGNMENT_BOTTOMLEFT:
pnt = anchorRect.BottomLeft();
break;
case POPUPALIGNMENT_BOTTOMRIGHT:
pnt = anchorRect.BottomRight();
break;
case POPUPALIGNMENT_TOPLEFT:
default:
pnt = anchorRect.TopLeft();
break;
}
// If the alignment is on the right edge of the popup, move the popup left
// by the width. Similarly, if the alignment is on the bottom edge of the
// popup, move the popup up by the height. In addition, account for the
// margins of the popup on the edge on which it is aligned.
nsMargin margin = GetMargin();
switch (popupAlign) {
case POPUPALIGNMENT_LEFTCENTER:
pnt.MoveBy(margin.left, -aPrefSize.height / 2);
break;
case POPUPALIGNMENT_RIGHTCENTER:
pnt.MoveBy(-aPrefSize.width - margin.right, -aPrefSize.height / 2);
break;
case POPUPALIGNMENT_TOPCENTER:
pnt.MoveBy(-aPrefSize.width / 2, margin.top);
break;
case POPUPALIGNMENT_BOTTOMCENTER:
pnt.MoveBy(-aPrefSize.width / 2, -aPrefSize.height - margin.bottom);
break;
case POPUPALIGNMENT_TOPRIGHT:
pnt.MoveBy(-aPrefSize.width - margin.right, margin.top);
break;
case POPUPALIGNMENT_BOTTOMLEFT:
pnt.MoveBy(margin.left, -aPrefSize.height - margin.bottom);
break;
case POPUPALIGNMENT_BOTTOMRIGHT:
pnt.MoveBy(-aPrefSize.width - margin.right,
-aPrefSize.height - margin.bottom);
break;
case POPUPALIGNMENT_TOPLEFT:
default:
pnt.MoveBy(margin.left, margin.top);
break;
}
// If we aligning to the selected item in the popup, adjust the vertical
// position by the height of the menulist label and the selected item's
// position.
if (mPosition == POPUPPOSITION_SELECTION) {
MOZ_ASSERT(popupAnchor == POPUPALIGNMENT_BOTTOMLEFT ||
popupAnchor == POPUPALIGNMENT_BOTTOMRIGHT);
MOZ_ASSERT(popupAlign == POPUPALIGNMENT_TOPLEFT ||
popupAlign == POPUPALIGNMENT_TOPRIGHT);
// Only adjust the popup if it just opened, otherwise the popup will move
// around if its gets resized or the selection changed. Cache the value in
// mPositionedOffset and use that instead for any future calculations.
if (mIsOpenChanged) {
if (nsIFrame* selectedItemFrame = GetSelectedItemForAlignment()) {
const nscoord itemHeight = selectedItemFrame->GetRect().height;
const nscoord itemOffset =
selectedItemFrame->GetOffsetToIgnoringScrolling(this).y;
// We want to line-up the anchor rect with the selected item, but if the
// selected item is outside of our bounds, we don't want to shift the
// popup up in a way that our box would no longer intersect with the
// anchor.
nscoord maxOffset = aPrefSize.height - itemHeight;
if (const ScrollContainerFrame* sf = GetScrollContainerFrame()) {
// HACK: We ideally would want to use the offset from the bottom
// bottom of our scroll-frame to the bottom of our frame (so as to
// ensure that the bottom of the scrollport is inside the anchor
// rect).
//
// But at this point of the code, the scroll frame may not be laid out
// with a definite size (might be overflowing us).
//
// So, we assume the offset from the bottom is symmetric to the offset
// from the top. This holds for all the popups where this matters
// (menulists on macOS, effectively), and seems better than somehow
// moving the popup after the fact as we used to do.
maxOffset -= sf->GetOffsetTo(this).y;
}
mPositionedOffset =
originalAnchorRect.height + std::min(itemOffset, maxOffset);
}
}
pnt.y -= mPositionedOffset;
}
// Flipping horizontally is allowed as long as the popup is above or below
// the anchor. This will happen if both the anchor and alignment are top or
// both are bottom, but different values. Similarly, flipping vertically is
// allowed if the popup is to the left or right of the anchor. In this case,
// the values of the constants are such that both must be positive or both
// must be negative. A special case, used for overlap, allows flipping
// vertically as well.
// If we are flipping in both directions, we want to set a flip style both
// horizontally and vertically. However, we want to flip on the inside edge
// of the anchor. Consider the example of a typical dropdown menu.
// Vertically, we flip the popup on the outside edges of the anchor menu,
// however horizontally, we want to to use the inside edges so the popup
// still appears underneath the anchor menu instead of floating off the
// side of the menu.
switch (popupAnchor) {
case POPUPALIGNMENT_LEFTCENTER:
case POPUPALIGNMENT_RIGHTCENTER:
aHFlip = FlipStyle::Outside;
aVFlip = FlipStyle::Inside;
break;
case POPUPALIGNMENT_TOPCENTER:
case POPUPALIGNMENT_BOTTOMCENTER:
aHFlip = FlipStyle::Inside;
aVFlip = FlipStyle::Outside;
break;
default: {
FlipStyle anchorEdge =
mFlip == FlipType::Both ? FlipStyle::Inside : FlipStyle::None;
aHFlip = (popupAnchor == -popupAlign) ? FlipStyle::Outside : anchorEdge;
if (((popupAnchor > 0) == (popupAlign > 0)) ||
(popupAnchor == POPUPALIGNMENT_TOPLEFT &&
popupAlign == POPUPALIGNMENT_TOPLEFT)) {
aVFlip = FlipStyle::Outside;
} else {
aVFlip = anchorEdge;
}
break;
}
}
return pnt;
}
nsIFrame* nsMenuPopupFrame::GetSelectedItemForAlignment() const {
// This method adjusts a menulist's popup such that the selected item is under
// the cursor, aligned with the menulist label.
nsCOMPtr<nsIDOMXULSelectControlElement> select;
if (mAnchorContent) {
select = mAnchorContent->AsElement()->AsXULSelectControl();
}
if (!select) {
// If there isn't an anchor, then try just getting the parent of the popup.
select = mContent->GetParent()->AsElement()->AsXULSelectControl();
if (!select) {
return nullptr;
}
}
nsCOMPtr<Element> selectedElement;
select->GetSelectedItem(getter_AddRefs(selectedElement));
return selectedElement ? selectedElement->GetPrimaryFrame() : nullptr;
}
nscoord nsMenuPopupFrame::SlideOrResize(nscoord& aScreenPoint, nscoord aSize,
nscoord aScreenBegin,
nscoord aScreenEnd,
nscoord* aOffset) const {
// The popup may be positioned such that either the left/top or bottom/right
// is outside the screen - but never both.
nscoord newPos =
std::max(aScreenBegin, std::min(aScreenEnd - aSize, aScreenPoint));
*aOffset = newPos - aScreenPoint;
aScreenPoint = newPos;
return std::min(aSize, aScreenEnd - aScreenPoint);
}
nscoord nsMenuPopupFrame::FlipOrResize(nscoord& aScreenPoint, nscoord aSize,
nscoord aScreenBegin, nscoord aScreenEnd,
nscoord aAnchorBegin, nscoord aAnchorEnd,
nscoord aMarginBegin, nscoord aMarginEnd,
FlipStyle aFlip, bool aEndAligned,
bool* aFlipSide) const {
// The flip side argument will be set to true if there wasn't room and we
// flipped to the opposite side.
*aFlipSide = false;
// all of the coordinates used here are in app units relative to the screen
nscoord popupSize = aSize;
if (aScreenPoint < aScreenBegin) {
// at its current position, the popup would extend past the left or top
// edge of the screen, so it will have to be moved or resized.
if (aFlip != FlipStyle::None) {
// for inside flips, we flip on the opposite side of the anchor
nscoord startpos =
aFlip == FlipStyle::Outside ? aAnchorBegin : aAnchorEnd;
nscoord endpos = aFlip == FlipStyle::Outside ? aAnchorEnd : aAnchorBegin;
// check whether there is more room to the left and right (or top and
// bottom) of the anchor and put the popup on the side with more room.
if (startpos - aScreenBegin >= aScreenEnd - endpos) {
aScreenPoint = aScreenBegin;
popupSize = startpos - aScreenPoint - aMarginEnd;
*aFlipSide = !aEndAligned;
} else {
// If the newly calculated position is different than the existing
// position, flip such that the popup is to the right or bottom of the
// anchor point instead . However, when flipping use the same margin
// size.
nscoord newScreenPoint = endpos + aMarginEnd;
if (newScreenPoint != aScreenPoint) {
*aFlipSide = aEndAligned;
aScreenPoint = newScreenPoint;
// check if the new position is still off the right or bottom edge of
// the screen. If so, resize the popup.
if (aScreenPoint + aSize > aScreenEnd) {
popupSize = aScreenEnd - aScreenPoint;
}
}
}
} else {
aScreenPoint = aScreenBegin;
}
} else if (aScreenPoint + aSize > aScreenEnd) {
// at its current position, the popup would extend past the right or
// bottom edge of the screen, so it will have to be moved or resized.
if (aFlip != FlipStyle::None) {
// for inside flips, we flip on the opposite side of the anchor
nscoord startpos =
aFlip == FlipStyle::Outside ? aAnchorBegin : aAnchorEnd;
nscoord endpos = aFlip == FlipStyle::Outside ? aAnchorEnd : aAnchorBegin;
// check whether there is more room to the left and right (or top and
// bottom) of the anchor and put the popup on the side with more room.
if (aScreenEnd - endpos >= startpos - aScreenBegin) {
*aFlipSide = aEndAligned;
if (mIsContextMenu) {
aScreenPoint = aScreenEnd - aSize;
} else {
aScreenPoint = endpos + aMarginBegin;
popupSize = aScreenEnd - aScreenPoint;
}
} else {
// if the newly calculated position is different than the existing
// position, we flip such that the popup is to the left or top of the
// anchor point instead.
nscoord newScreenPoint = startpos - aSize - aMarginBegin;
if (newScreenPoint != aScreenPoint) {
*aFlipSide = !aEndAligned;
aScreenPoint = newScreenPoint;
// check if the new position is still off the left or top edge of the
// screen. If so, resize the popup.
if (aScreenPoint < aScreenBegin) {
aScreenPoint = aScreenBegin;
if (!mIsContextMenu) {
popupSize = startpos - aScreenPoint - aMarginBegin;
}
}
}
}
} else {
aScreenPoint = aScreenEnd - aSize;
}
}
// Make sure that the point is within the screen boundaries and that the
// size isn't off the edge of the screen. This can happen when a large
// positive or negative margin is used.
if (aScreenPoint < aScreenBegin) {
aScreenPoint = aScreenBegin;
}
if (aScreenPoint > aScreenEnd) {
aScreenPoint = aScreenEnd - aSize;
}
// If popupSize ended up being negative, or the original size was actually
// smaller than the calculated popup size, just use the original size instead.
if (popupSize <= 0 || aSize < popupSize) {
popupSize = aSize;
}
return std::min(popupSize, aScreenEnd - aScreenPoint);
}
nsRect nsMenuPopupFrame::ComputeAnchorRect(nsPresContext* aRootPresContext,
nsIFrame* aAnchorFrame) const {
// Get the root frame for a reference
nsIFrame* rootFrame = aRootPresContext->PresShell()->GetRootFrame();
// The dimensions of the anchor
nsRect anchorRect = aAnchorFrame->GetRectRelativeToSelf();
// Relative to the root
anchorRect = nsLayoutUtils::TransformFrameRectToAncestor(
aAnchorFrame, anchorRect, rootFrame);
// Relative to the screen
anchorRect.MoveBy(rootFrame->GetScreenRectInAppUnits().TopLeft());
// In its own app units
return anchorRect.ScaleToOtherAppUnitsRoundOut(
aRootPresContext->AppUnitsPerDevPixel(),
PresContext()->AppUnitsPerDevPixel());
}
static nsIFrame* MaybeDelegatedAnchorFrame(nsIFrame* aFrame) {
if (!aFrame) {
return nullptr;
}
if (auto* element = Element::FromNodeOrNull(aFrame->GetContent())) {
if (element->HasAttr(nsGkAtoms::delegatesanchor)) {
for (nsIFrame* f : aFrame->PrincipalChildList()) {
if (!f->IsPlaceholderFrame()) {
return f;
}
}
}
}
return aFrame;
}
auto nsMenuPopupFrame::GetRects(const nsSize& aPrefSize) const -> Rects {
if (NS_WARN_IF(aPrefSize == nsSize(-1, -1))) {
// Return early if the popup hasn't been laid out yet. On Windows, this can
// happen when using a drag popup before it opens.
return {};
}
nsPresContext* pc = PresContext();
nsIFrame* rootFrame = pc->PresShell()->GetRootFrame();
NS_ASSERTION(rootFrame->GetView() && GetView() &&
rootFrame->GetView() == GetView()->GetParent(),
"rootFrame's view is not our view's parent???");
// Indicators of whether the popup should be flipped or resized.
FlipStyle hFlip = FlipStyle::None;
FlipStyle vFlip = FlipStyle::None;
const nsMargin margin = GetMargin();
// the screen rectangle of the root frame, in dev pixels.
const nsRect rootScreenRect = rootFrame->GetScreenRectInAppUnits();
const bool isNoAutoHide = IsNoAutoHide();
const PopupLevel popupLevel = GetPopupLevel(isNoAutoHide);
Rects result;
// Set the popup's size to the preferred size. Below, this size will be
// adjusted to fit on the screen or within the content area. If the anchor is
// sized to the popup, use the anchor's width instead of the preferred width.
result.mUsedRect = nsRect(nsPoint(), aPrefSize);
const bool anchored = IsAnchored();
if (anchored) {
// In order to deal with transforms, we need the root prescontext:
nsPresContext* rootPc = pc->GetRootPresContext();
if (NS_WARN_IF(!rootPc)) {
// If we can't reach a root pres context, don't bother continuing.
return result;
}
result.mAnchorRect = result.mUntransformedAnchorRect = [&] {
// If anchored to a rectangle, use that rectangle. Otherwise, determine
// the rectangle from the anchor.
if (mAnchorType == MenuPopupAnchorType::Rect) {
return mScreenRect;
}
// if the frame is not specified, use the anchor node passed to OpenPopup.
// If that wasn't specified either, use the root frame. Note that
// mAnchorContent might be a different document so its presshell must be
// used.
nsIFrame* anchorFrame = GetAnchorFrame();
if (!anchorFrame) {
return rootScreenRect;
}
return ComputeAnchorRect(rootPc, anchorFrame);
}();
// if we are anchored, there are certain things we don't want to do when
// repositioning the popup to fit on the screen, such as end up positioned
// over the anchor, for instance a popup appearing over the menu label.
// When doing this reposition, we want to move the popup to the side with
// the most room. The combination of anchor and alignment dictate if we
// readjust above/below or to the left/right.
if (mAnchorContent || mAnchorType == MenuPopupAnchorType::Rect) {
// move the popup according to the anchor and alignment. This will also
// tell us which axis the popup is flush against in case we have to move
// it around later. The AdjustPositionForAnchorAlign method accounts for
// the popup's margin.
result.mUsedRect.MoveTo(AdjustPositionForAnchorAlign(
result.mAnchorRect, aPrefSize, hFlip, vFlip));
} else {
// With no anchor, the popup is positioned relative to the root frame.
result.mUsedRect.MoveTo(result.mAnchorRect.TopLeft() +
nsPoint(margin.left, margin.top));
}
} else {
// Not anchored, use mScreenRect
result.mUsedRect.MoveTo(mScreenRect.TopLeft());
result.mAnchorRect = result.mUntransformedAnchorRect =
nsRect(mScreenRect.TopLeft(), nsSize());
// Right-align RTL context menus, and apply margin and offsets as per the
// platform conventions.
if (mIsContextMenu && IsDirectionRTL()) {
result.mUsedRect.x -= aPrefSize.Width();
result.mUsedRect.MoveBy(-margin.right, margin.top);
} else {
result.mUsedRect.MoveBy(margin.left, margin.top);
}
#ifdef XP_MACOSX
// On macOS, tooltips follow standard flip rule but other popups like
// context menus flip horizontally, not vertically.
if (mPopupType == PopupType::Tooltip) {
vFlip = FlipStyle::Outside;
} else {
hFlip = FlipStyle::Outside;
}
#else
// On Windows and Linux, other OS screen positioned popups can be flipped
// vertically. Only the context menu can be flipped horizontally as well, in
// order to avoid showing the context menu accidentally under the mouse.
vFlip = FlipStyle::Outside;
if (mIsContextMenu) {
hFlip = FlipStyle::Outside;
}
#endif // #ifdef XP_MACOSX
}
const int32_t a2d = pc->AppUnitsPerDevPixel();
nsView* view = GetView();
NS_ASSERTION(view, "popup with no view");
nsIWidget* widget = view->GetWidget();
// If a panel has flip="none", don't constrain or flip it.
// Also, always do this for content shells, so that the popup doesn't extend
// outside the containing frame.
if (mInContentShell || mFlip != FlipType::None) {
const Maybe<nsRect> constraintRect =
GetConstraintRect(result.mAnchorRect, rootScreenRect, popupLevel);
if (constraintRect) {
// Ensure that anchorRect is on the constraint rect.
result.mAnchorRect = result.mAnchorRect.Intersect(*constraintRect);
// Shrink the popup down if it is larger than the constraint size
if (result.mUsedRect.width > constraintRect->width) {
result.mUsedRect.width = constraintRect->width;
}
if (result.mUsedRect.height > constraintRect->height) {
result.mUsedRect.height = constraintRect->height;
}
result.mConstrainedByLayout = true;
}
if (IS_WAYLAND_DISPLAY() && widget) {
// Shrink the popup down if it's larger than popup size received from
// Wayland compositor. We don't know screen size on Wayland so this is the
// only info we have there.
const nsSize waylandSize = LayoutDeviceIntRect::ToAppUnits(
widget->GetMoveToRectPopupSize(), a2d);
if (waylandSize.width > 0 && result.mUsedRect.width > waylandSize.width) {
LOG_WAYLAND("Wayland constraint width [%p]: %d to %d", widget,
result.mUsedRect.width, waylandSize.width);
result.mUsedRect.width = waylandSize.width;
}
if (waylandSize.height > 0 &&
result.mUsedRect.height > waylandSize.height) {
LOG_WAYLAND("Wayland constraint height [%p]: %d to %d", widget,
result.mUsedRect.height, waylandSize.height);
result.mUsedRect.height = waylandSize.height;
}
if (RefPtr<widget::Screen> s = widget->GetWidgetScreen()) {
const nsSize screenSize =
LayoutDeviceIntSize::ToAppUnits(s->GetAvailRect().Size(), a2d);
if (result.mUsedRect.height > screenSize.height) {
LOG_WAYLAND("Wayland constraint height to screen [%p]: %d to %d",
widget, result.mUsedRect.height, screenSize.height);
result.mUsedRect.height = screenSize.height;
}
if (result.mUsedRect.width > screenSize.width) {
LOG_WAYLAND("Wayland constraint widthto screen [%p]: %d to %d",
widget, result.mUsedRect.width, screenSize.width);
result.mUsedRect.width = screenSize.width;
}
}
}
// At this point the anchor (anchorRect) is within the available screen
// area (constraintRect) and the popup is known to be no larger than the
// screen.
if (constraintRect) {
// We might want to "slide" an arrow if the panel is of the correct type -
// but we can only slide on one axis - the other axis must be "flipped or
// resized" as normal.
bool slideHorizontal = false, slideVertical = false;
if (mFlip == FlipType::Slide) {
int8_t position = GetAlignmentPosition();
slideHorizontal = position >= POPUPPOSITION_BEFORESTART &&
position <= POPUPPOSITION_AFTEREND;
slideVertical = position >= POPUPPOSITION_STARTBEFORE &&
position <= POPUPPOSITION_ENDAFTER;
}
// Next, check if there is enough space to show the popup at full size
// when positioned at screenPoint. If not, flip the popups to the opposite
// side of their anchor point, or resize them as necessary.
if (slideHorizontal) {
result.mUsedRect.width = SlideOrResize(
result.mUsedRect.x, result.mUsedRect.width, constraintRect->x,
constraintRect->XMost(), &result.mAlignmentOffset);
} else {
const bool endAligned =
IsDirectionRTL()
? mPopupAlignment == POPUPALIGNMENT_TOPLEFT ||
mPopupAlignment == POPUPALIGNMENT_BOTTOMLEFT ||
mPopupAlignment == POPUPALIGNMENT_LEFTCENTER
: mPopupAlignment == POPUPALIGNMENT_TOPRIGHT ||
mPopupAlignment == POPUPALIGNMENT_BOTTOMRIGHT ||
mPopupAlignment == POPUPALIGNMENT_RIGHTCENTER;
result.mUsedRect.width = FlipOrResize(
result.mUsedRect.x, result.mUsedRect.width, constraintRect->x,
constraintRect->XMost(), result.mAnchorRect.x,
result.mAnchorRect.XMost(), margin.left, margin.right, hFlip,
endAligned, &result.mHFlip);
}
if (slideVertical) {
result.mUsedRect.height = SlideOrResize(
result.mUsedRect.y, result.mUsedRect.height, constraintRect->y,
constraintRect->YMost(), &result.mAlignmentOffset);
} else {
bool endAligned = mPopupAlignment == POPUPALIGNMENT_BOTTOMLEFT ||
mPopupAlignment == POPUPALIGNMENT_BOTTOMRIGHT ||
mPopupAlignment == POPUPALIGNMENT_BOTTOMCENTER;
result.mUsedRect.height = FlipOrResize(
result.mUsedRect.y, result.mUsedRect.height, constraintRect->y,
constraintRect->YMost(), result.mAnchorRect.y,
result.mAnchorRect.YMost(), margin.top, margin.bottom, vFlip,
endAligned, &result.mVFlip);
}
#ifdef DEBUG
NS_ASSERTION(constraintRect->Contains(result.mUsedRect),
"Popup is offscreen");
if (!constraintRect->Contains(result.mUsedRect)) {
NS_WARNING(nsPrintfCString("Popup is offscreen (%s vs. %s)",
ToString(constraintRect).c_str(),
ToString(result.mUsedRect).c_str())
.get());
}
#endif
}
}
// snap the popup's position in screen coordinates to device pixels, see
// bug 622507, bug 961431
result.mUsedRect.x = pc->RoundAppUnitsToNearestDevPixels(result.mUsedRect.x);
result.mUsedRect.y = pc->RoundAppUnitsToNearestDevPixels(result.mUsedRect.y);
// determine the x and y position of the view by subtracting the desired
// screen position from the screen position of the root frame.
result.mViewPoint = result.mUsedRect.TopLeft() - rootScreenRect.TopLeft();
// Offset the position by the width and height of the borders and titlebar.
// Even though GetClientOffset should return (0, 0) when there is no titlebar
// or borders, we skip these calculations anyway for non-panels to save time
// since they will never have a titlebar.
if (mPopupType == PopupType::Panel && widget) {
result.mClientOffset = widget->GetClientOffset();
result.mViewPoint +=
LayoutDeviceIntPoint::ToAppUnits(result.mClientOffset, a2d);
}
return result;
}
void nsMenuPopupFrame::SetPopupPosition(bool aIsMove) {
if (aIsMove && (mPrefSize.width == -1 || mPrefSize.height == -1)) {
return;
}
auto rects = GetRects(mPrefSize);
if (rects.mUsedRect.Size() != mRect.Size()) {
MOZ_ASSERT(!HasAnyStateBits(NS_FRAME_IN_REFLOW));
// We need to resize on top of moving, trigger an actual reflow.
PresShell()->FrameNeedsReflow(this, IntrinsicDirty::FrameAndAncestors,
NS_FRAME_IS_DIRTY);
return;
}
PerformMove(rects);
}
void nsMenuPopupFrame::PerformMove(const Rects& aRects) {
auto* ps = PresShell();
// We're just moving, sync frame position and offset as needed.
ps->GetViewManager()->MoveViewTo(GetView(), aRects.mViewPoint.x,
aRects.mViewPoint.y);
// Now that we've positioned the view, sync up the frame's origin.
nsBlockFrame::SetPosition(aRects.mViewPoint -
GetParent()->GetOffsetTo(ps->GetRootFrame()));
// If the popup is in the positioned state or if it is shown and the position
// or size changed, dispatch a popuppositioned event if the popup wants it.
if (mPopupState == ePopupPositioning ||
(mPopupState == ePopupShown &&
!aRects.mUsedRect.IsEqualEdges(mUsedScreenRect)) ||
(mPopupState == ePopupShown &&
aRects.mAlignmentOffset != mAlignmentOffset)) {
mUsedScreenRect = aRects.mUsedRect;
if (!HasAnyStateBits(NS_FRAME_FIRST_REFLOW) && !mPendingPositionedEvent) {
mPendingPositionedEvent =
nsXULPopupPositionedEvent::DispatchIfNeeded(mContent->AsElement());
}
}
if (!mPositionedByMoveToRect) {
mUntransformedAnchorRect = aRects.mUntransformedAnchorRect;
}
mAlignmentOffset = aRects.mAlignmentOffset;
mLastClientOffset = aRects.mClientOffset;
mHFlip = aRects.mHFlip;
mVFlip = aRects.mVFlip;
mConstrainedByLayout = aRects.mConstrainedByLayout;
// If this is a noautohide popup, set the screen coordinates of the popup.
// This way, the popup stays at the location where it was opened even when the
// window is moved. Popups at the parent level follow the parent window as it
// is moved and remained anchored, so we want to maintain the anchoring
// instead.
//
// FIXME: This suffers from issues like bug 1823552, where constraints imposed
// by the anchor are lost, but this is super-old behavior.
const bool fixPositionToPoint =
IsNoAutoHide() && (GetPopupLevel() != PopupLevel::Parent ||
mAnchorType == MenuPopupAnchorType::Rect);
if (fixPositionToPoint) {
// Account for the margin that will end up being added to the screen
// coordinate the next time SetPopupPosition is called.
const auto& margin = GetMargin();
mAnchorType = MenuPopupAnchorType::Point;
mScreenRect.x = aRects.mUsedRect.x - margin.left;
mScreenRect.y = aRects.mUsedRect.y - margin.top;
}
// For anchored popups that shouldn't follow the anchor, fix the original
// anchor rect.
if (IsAnchored() && !ShouldFollowAnchor() && !mUsedScreenRect.IsEmpty() &&
mAnchorType != MenuPopupAnchorType::Rect) {
mAnchorType = MenuPopupAnchorType::Rect;
mScreenRect = aRects.mUntransformedAnchorRect;
}
}
Maybe<nsRect> nsMenuPopupFrame::GetConstraintRect(
const nsRect& aAnchorRect, const nsRect& aRootScreenRect,
PopupLevel aPopupLevel) const {
const nsPresContext* pc = PresContext();
const int32_t a2d = PresContext()->AppUnitsPerDevPixel();
Maybe<nsRect> result;
auto AddConstraint = [&result](const nsRect& aConstraint) {
if (result) {
*result = result->Intersect(aConstraint);
} else {
result.emplace(aConstraint);
}
};
// Determine the available screen space. It will be reduced by the OS chrome
// such as menubars. It addition, for content shells, it will be the area of
// the content rather than the screen.
if (IS_WAYLAND_DISPLAY()) {
// In Wayland we can't use the screen rect, because we can't know the
// absolute window position. MoveToRect usually deals with this, but we
// can't use it unconditionally. Tooltips are presumed small enough, and
// they can open basically at any time with any other open menu, so we
// constrain them to the window area, see bug 1941237.
// TODO(emilio, stransky): Do we want to constrain other popups to the
// window area, if the window is big enough or maximized?
if (mPopupType == PopupType::Tooltip) {
AddConstraint(aRootScreenRect);
}
} else {
const DesktopToLayoutDeviceScale scale =
pc->DeviceContext()->GetDesktopToDeviceScale();
// For content shells, get the screen where the root frame is located. This
// is because we need to constrain the content to this content area, so we
// should use the same screen. Otherwise, use the screen where the anchor is
// located.
const nsRect& rect = mInContentShell ? aRootScreenRect : aAnchorRect;
auto desktopRect = DesktopIntRect::RoundOut(
LayoutDeviceRect::FromAppUnits(rect, a2d) / scale);
desktopRect.width = std::max(1, desktopRect.width);
desktopRect.height = std::max(1, desktopRect.height);
RefPtr<nsIScreen> screen =
widget::ScreenManager::GetSingleton().ScreenForRect(desktopRect);
MOZ_ASSERT(screen, "We always fall back to the primary screen");
// Non-top-level popups (which will always be panels) should never overlap
// the OS bar.
const bool canOverlapOSBar =
aPopupLevel == PopupLevel::Top &&
LookAndFeel::GetInt(LookAndFeel::IntID::MenusCanOverlapOSBar) &&
!mInContentShell;
// Get the total screen area if the popup is allowed to overlap it.
const auto screenRect =
canOverlapOSBar ? screen->GetRect() : screen->GetAvailRect();
AddConstraint(LayoutDeviceRect::ToAppUnits(screenRect, a2d));
}
if (mInContentShell) {
// For content shells, clip to the client area rather than the screen area
AddConstraint(aRootScreenRect);
} else if (!mOverrideConstraintRect.IsEmpty()) {
AddConstraint(mOverrideConstraintRect);
// This is currently only used for <select> elements where we want to
// constrain vertically to the screen but not horizontally, so do the
// intersection and then reset the horizontal values.
//
// FIXME(emilio): This doesn't make any sense to me...
result->x = mOverrideConstraintRect.x;
result->width = mOverrideConstraintRect.width;
}
// Expand the allowable screen rect by the input margin (which can't be
// interacted with).
if (result) {
const nscoord inputMargin =
StyleUIReset()->mMozWindowInputRegionMargin.ToAppUnits();
result->Inflate(inputMargin);
}
return result;
}
ConsumeOutsideClicksResult nsMenuPopupFrame::ConsumeOutsideClicks() {
if (mContent->AsElement()->AttrValueIs(kNameSpaceID_None,
nsGkAtoms::consumeoutsideclicks,
nsGkAtoms::_true, eCaseMatters)) {
return ConsumeOutsideClicks_True;
}
if (mContent->AsElement()->AttrValueIs(kNameSpaceID_None,
nsGkAtoms::consumeoutsideclicks,
nsGkAtoms::_false, eCaseMatters)) {
return ConsumeOutsideClicks_ParentOnly;
}
if (mContent->AsElement()->AttrValueIs(kNameSpaceID_None,
nsGkAtoms::consumeoutsideclicks,
nsGkAtoms::never, eCaseMatters)) {
return ConsumeOutsideClicks_Never;
}
nsCOMPtr<nsIContent> parentContent = mContent->GetParent();
if (parentContent) {
dom::NodeInfo* ni = parentContent->NodeInfo();
if (ni->Equals(nsGkAtoms::menulist, kNameSpaceID_XUL)) {
return ConsumeOutsideClicks_True; // Consume outside clicks for combo
// boxes on all platforms
}
#if defined(XP_WIN)
// Don't consume outside clicks for menus in Windows
if (ni->Equals(nsGkAtoms::menu, kNameSpaceID_XUL) ||
ni->Equals(nsGkAtoms::popupset, kNameSpaceID_XUL) ||
((ni->Equals(nsGkAtoms::button, kNameSpaceID_XUL) ||
ni->Equals(nsGkAtoms::toolbarbutton, kNameSpaceID_XUL)) &&
parentContent->AsElement()->AttrValueIs(
kNameSpaceID_None, nsGkAtoms::type, nsGkAtoms::menu,
eCaseMatters))) {
return ConsumeOutsideClicks_Never;
}
#endif
}
return ConsumeOutsideClicks_True;
}
static ScrollContainerFrame* DoGetScrollContainerFrame(const nsIFrame* aFrame) {
if (const ScrollContainerFrame* sf = do_QueryFrame(aFrame)) {
return const_cast<ScrollContainerFrame*>(sf);
}
for (nsIFrame* childFrame : aFrame->PrincipalChildList()) {
if (auto* sf = DoGetScrollContainerFrame(childFrame)) {
return sf;
}
}
return nullptr;
}
// XXXroc this is megalame. Fossicking around for a frame of the right
// type is a recipe for disaster in the long term.
ScrollContainerFrame* nsMenuPopupFrame::GetScrollContainerFrame() const {
return DoGetScrollContainerFrame(this);
}
void nsMenuPopupFrame::ChangeByPage(bool aIsUp) {
// Only scroll by page within menulists.
if (!IsMenuList()) {
return;
}
ScrollContainerFrame* scrollContainerFrame = GetScrollContainerFrame();
RefPtr popup = &PopupElement();
XULButtonElement* currentMenu = popup->GetActiveMenuChild();
XULButtonElement* newMenu = nullptr;
if (!currentMenu) {
// If there is no current menu item, get the first item. When moving up,
// just use this as the newMenu and leave currentMenu null so that no check
// for a later element is performed. When moving down, set currentMenu so
// that we look for one page down from the first item.
newMenu = popup->GetFirstMenuItem();
if (!aIsUp) {
currentMenu = newMenu;
}
}
if (currentMenu && currentMenu->GetPrimaryFrame()) {
const nscoord scrollHeight =
scrollContainerFrame ? scrollContainerFrame->GetScrollPortRect().height
: mRect.height;
const nsRect currentRect = currentMenu->GetPrimaryFrame()->GetRect();
const XULButtonElement* startMenu = currentMenu;
// Get the position of the current item and add or subtract one popup's
// height to or from it.
const nscoord targetPos = aIsUp ? currentRect.YMost() - scrollHeight
: currentRect.y + scrollHeight;
// Look for the next child which is just past the target position. This
// child will need to be selected.
for (; currentMenu;
currentMenu = aIsUp ? popup->GetPrevMenuItemFrom(*currentMenu)
: popup->GetNextMenuItemFrom(*currentMenu)) {
if (!currentMenu->GetPrimaryFrame()) {
continue;
}
const nsRect curRect = currentMenu->GetPrimaryFrame()->GetRect();
const nscoord curPos = aIsUp ? curRect.y : curRect.YMost();
// If the right position was found, break out. Otherwise, look for another
// item.
if (aIsUp ? (curPos < targetPos) : (curPos > targetPos)) {
if (!newMenu || newMenu == startMenu) {
newMenu = currentMenu;
}
break;
}
// Assign this item to newMenu. This item will be selected in case we
// don't find any more.
newMenu = currentMenu;
}
}
// Select the new menuitem.
if (RefPtr newMenuRef = newMenu) {
popup->SetActiveMenuChild(newMenuRef);
}
}
dom::XULPopupElement& nsMenuPopupFrame::PopupElement() const {
auto* popup = dom::XULPopupElement::FromNode(GetContent());
MOZ_DIAGNOSTIC_ASSERT(popup);
return *popup;
}
XULButtonElement* nsMenuPopupFrame::GetCurrentMenuItem() const {
return PopupElement().GetActiveMenuChild();
}
nsIFrame* nsMenuPopupFrame::GetCurrentMenuItemFrame() const {
auto* child = GetCurrentMenuItem();
return child ? child->GetPrimaryFrame() : nullptr;
}
void nsMenuPopupFrame::HandleEnterKeyPress(WidgetEvent& aEvent) {
mIncrementalString.Truncate();
RefPtr popup = &PopupElement();
popup->HandleEnterKeyPress(aEvent);
}
XULButtonElement* nsMenuPopupFrame::FindMenuWithShortcut(
mozilla::dom::KeyboardEvent& aKeyEvent, bool& aDoAction) {
uint32_t charCode = aKeyEvent.CharCode();
uint32_t keyCode = aKeyEvent.KeyCode();
aDoAction = false;
// Enumerate over our list of frames.
const bool isMenu = !IsMenuList();
TimeStamp keyTime = aKeyEvent.WidgetEventPtr()->mTimeStamp;
if (charCode == 0) {
if (keyCode == dom::KeyboardEvent_Binding::DOM_VK_BACK_SPACE) {
if (!isMenu && !mIncrementalString.IsEmpty()) {
mIncrementalString.SetLength(mIncrementalString.Length() - 1);
return nullptr;
}
#ifdef XP_WIN
if (nsCOMPtr<nsISound> sound = do_GetService("@mozilla.org/sound;1")) {
sound->Beep();
}
#endif // #ifdef XP_WIN
}
return nullptr;
}
char16_t uniChar = ToLowerCase(static_cast<char16_t>(charCode));
if (isMenu) {
// Menu supports only first-letter navigation
mIncrementalString = uniChar;
} else if (IsWithinIncrementalTime(keyTime)) {
mIncrementalString.Append(uniChar);
} else {
// Interval too long, treat as new typing
mIncrementalString = uniChar;
}
// See bug 188199 & 192346, if all letters in incremental string are same,
// just try to match the first one
nsAutoString incrementalString(mIncrementalString);
uint32_t charIndex = 1, stringLength = incrementalString.Length();
while (charIndex < stringLength &&
incrementalString[charIndex] == incrementalString[charIndex - 1]) {
charIndex++;
}
if (charIndex == stringLength) {
incrementalString.Truncate(1);
stringLength = 1;
}
sLastKeyTime = keyTime;
auto* item =
PopupElement().FindMenuWithShortcut(incrementalString, aDoAction);
if (item) {
return item;
}
// If we don't match anything, rollback the last typing
mIncrementalString.SetLength(mIncrementalString.Length() - 1);
// didn't find a matching menu item
#ifdef XP_WIN
// behavior on Windows - this item is in a menu popup off of the
// menu bar, so beep and do nothing else
if (isMenu) {
if (nsCOMPtr<nsISound> sound = do_GetService("@mozilla.org/sound;1")) {
sound->Beep();
}
}
#endif // #ifdef XP_WIN
return nullptr;
}
nsIWidget* nsMenuPopupFrame::GetWidget() const {
return mView ? mView->GetWidget() : nullptr;
}
// helpers /////////////////////////////////////////////////////////////
nsresult nsMenuPopupFrame::AttributeChanged(int32_t aNameSpaceID,
nsAtom* aAttribute,
AttrModType aModType)
{
nsresult rv =
nsBlockFrame::AttributeChanged(aNameSpaceID, aAttribute, aModType);
if (aAttribute == nsGkAtoms::left || aAttribute == nsGkAtoms::top) {
MoveToAttributePosition();
}
if (aAttribute == nsGkAtoms::remote && GetWidget()) {
// When the remote attribute changes, we need to create a new widget to
// ensure that it has the correct compositor and transparency settings to
// match the new value. Do that only if we already have a widget.
// TODO(emilio): We should consider doing it only when we get re-shown or
// so.
PrepareWidget(true);
}
if (aAttribute == nsGkAtoms::followanchor) {
if (nsXULPopupManager* pm = nsXULPopupManager::GetInstance()) {
pm->UpdateFollowAnchor(this);
}
}
if (aAttribute == nsGkAtoms::label) {
// set the label for the titlebar
nsView* view = GetView();
if (view) {
nsIWidget* widget = view->GetWidget();
if (widget) {
nsAutoString title;
mContent->AsElement()->GetAttr(nsGkAtoms::label, title);
if (!title.IsEmpty()) {
widget->SetTitle(title);
}
}
}
} else if (aAttribute == nsGkAtoms::ignorekeys) {
nsXULPopupManager* pm = nsXULPopupManager::GetInstance();
if (pm) {
nsAutoString ignorekeys;
mContent->AsElement()->GetAttr(nsGkAtoms::ignorekeys, ignorekeys);
pm->UpdateIgnoreKeys(ignorekeys.EqualsLiteral("true"));
}
}
return rv;
}
void nsMenuPopupFrame::MoveToAttributePosition() {
// Move the widget around when the user sets the |left| and |top| attributes.
// Note that this is not the best way to move the widget, as it results in
// lots of FE notifications and is likely to be slow as molasses. Use |moveTo|
// on the element if possible.
nsAutoString left, top;
mContent->AsElement()->GetAttr(nsGkAtoms::left, left);
mContent->AsElement()->GetAttr(nsGkAtoms::top, top);
nsresult err1, err2;
const CSSIntPoint pos(left.ToInteger(&err1), top.ToInteger(&err2));
if (NS_SUCCEEDED(err1) && NS_SUCCEEDED(err2)) {
MoveTo(pos, false);
}
PresShell()->FrameNeedsReflow(
this, IntrinsicDirty::FrameAncestorsAndDescendants, NS_FRAME_IS_DIRTY);
}
void nsMenuPopupFrame::Destroy(DestroyContext& aContext) {
// XXX: Currently we don't fire popuphidden for these popups, that seems wrong
// but alas, also pre-existing.
HidePopup(/* aDeselectMenu = */ false, ePopupClosed,
/* aFromFrameDestruction = */ true);
if (mExpirationState.IsTracked()) {
PopupExpirationTracker::Get()->RemoveObject(this);
}
if (RefPtr<nsXULPopupManager> pm = nsXULPopupManager::GetInstance()) {
pm->PopupDestroyed(this);
}
nsBlockFrame::Destroy(aContext);
}
nsMargin nsMenuPopupFrame::GetMargin() const {
nsMargin margin;
StyleMargin()->GetMargin(margin);
if (mIsTopLevelContextMenu) {
const CSSIntPoint offset(
LookAndFeel::GetInt(LookAndFeel::IntID::ContextMenuOffsetHorizontal),
LookAndFeel::GetInt(LookAndFeel::IntID::ContextMenuOffsetVertical));
auto auOffset = CSSIntPoint::ToAppUnits(offset);
margin.top += auOffset.y;
margin.bottom += auOffset.y;
margin.left += auOffset.x;
margin.right += auOffset.x;
}
if (mPopupType == PopupType::Tooltip && !IsAnchored()) {
const auto auOffset =
CSSPixel::ToAppUnits(LookAndFeel::TooltipOffsetVertical());
margin.top += auOffset;
margin.bottom += auOffset;
}
// TODO(emilio): We should consider make these properly mirrored (that is,
// changing -= to += here, and removing the rtl special case), but some tests
// rely on the old behavior of the anchor moving physically regardless of
// alignment...
margin.top += mExtraMargin.y;
margin.bottom -= mExtraMargin.y;
if (IsDirectionRTL()) {
margin.left -= mExtraMargin.x;
margin.right += mExtraMargin.x;
} else {
margin.left += mExtraMargin.x;
margin.right -= mExtraMargin.x;
}
return margin;
}
void nsMenuPopupFrame::DestroyWidgetIfNeeded() {
if (IsVisibleOrShowing()) {
MOZ_ASSERT_UNREACHABLE("Shouldn't be tracked while visible");
return;
}
if (auto* view = GetView()) {
view->DestroyWidget();
}
}
void nsMenuPopupFrame::MoveTo(const CSSPoint& aPos, bool aUpdateAttrs,
bool aByMoveToRect) {
nsIWidget* widget = GetWidget();
nsPoint appUnitsPos = CSSPixel::ToAppUnits(aPos);
const bool rtl = IsDirectionRTL();
// reposition the popup at the specified coordinates. Don't clear the anchor
// and position, because the popup can be reset to its anchor position by
// using (-1, -1) as coordinates.
//
// Subtract off the margin as it will be added to the position when
// SetPopupPosition is called.
{
nsMargin margin = GetMargin();
if (rtl && mIsContextMenu) {
appUnitsPos.x += margin.right + mRect.Width();
} else {
appUnitsPos.x -= margin.left;
}
appUnitsPos.y -= margin.top;
}
if (mScreenRect.TopLeft() == appUnitsPos &&
(!widget || widget->GetClientOffset() == mLastClientOffset)) {
return;
}
mPositionedByMoveToRect = aByMoveToRect;
mScreenRect.MoveTo(appUnitsPos);
if (mAnchorType == MenuPopupAnchorType::Rect) {
// This ensures that the anchor width is still honored, to prevent it from
// changing spuriously.
mScreenRect.height = 0;
// But we still need to make sure that our top left position ends up in
// appUnitsPos.
mPopupAlignment = rtl ? POPUPALIGNMENT_TOPRIGHT : POPUPALIGNMENT_TOPLEFT;
mPopupAnchor = rtl ? POPUPALIGNMENT_BOTTOMRIGHT : POPUPALIGNMENT_BOTTOMLEFT;
} else {
mAnchorType = MenuPopupAnchorType::Point;
}
SetPopupPosition(true);
RefPtr<Element> popup = mContent->AsElement();
if (aUpdateAttrs &&
(popup->HasAttr(nsGkAtoms::left) || popup->HasAttr(nsGkAtoms::top))) {
nsAutoString left, top;
left.AppendInt(RoundedToInt(aPos).x);
top.AppendInt(RoundedToInt(aPos).y);
popup->SetAttr(kNameSpaceID_None, nsGkAtoms::left, left, false);
popup->SetAttr(kNameSpaceID_None, nsGkAtoms::top, top, false);
}
}
void nsMenuPopupFrame::MoveToAnchor(nsIContent* aAnchorContent,
const nsAString& aPosition, int32_t aXPos,
int32_t aYPos, bool aAttributesOverride) {
NS_ASSERTION(IsVisibleOrShowing(),
"popup must be visible or showing to move it");
nsPopupState oldstate = mPopupState;
InitializePopup(aAnchorContent, mTriggerContent, aPosition, aXPos, aYPos,
MenuPopupAnchorType::Node, aAttributesOverride);
// InitializePopup changed the state so reset it.
mPopupState = oldstate;
// Pass false here so that flipping and adjusting to fit on the screen happen.
SetPopupPosition(false);
}
int8_t nsMenuPopupFrame::GetAlignmentPosition() const {
// The code below handles most cases of alignment, anchor and position values.
// Those that are not handled just return POPUPPOSITION_UNKNOWN.
if (mPosition == POPUPPOSITION_OVERLAP ||
mPosition == POPUPPOSITION_AFTERPOINTER ||
mPosition == POPUPPOSITION_SELECTION) {
return mPosition;
}
int8_t position = mPosition;
if (position == POPUPPOSITION_UNKNOWN) {
switch (mPopupAnchor) {
case POPUPALIGNMENT_BOTTOMRIGHT:
case POPUPALIGNMENT_BOTTOMLEFT:
case POPUPALIGNMENT_BOTTOMCENTER:
position = mPopupAlignment == POPUPALIGNMENT_TOPRIGHT
? POPUPPOSITION_AFTEREND
: POPUPPOSITION_AFTERSTART;
break;
case POPUPALIGNMENT_TOPRIGHT:
case POPUPALIGNMENT_TOPLEFT:
case POPUPALIGNMENT_TOPCENTER:
position = mPopupAlignment == POPUPALIGNMENT_BOTTOMRIGHT
? POPUPPOSITION_BEFOREEND
: POPUPPOSITION_BEFORESTART;
break;
case POPUPALIGNMENT_LEFTCENTER:
position = mPopupAlignment == POPUPALIGNMENT_BOTTOMRIGHT
? POPUPPOSITION_STARTAFTER
: POPUPPOSITION_STARTBEFORE;
break;
case POPUPALIGNMENT_RIGHTCENTER:
position = mPopupAlignment == POPUPALIGNMENT_BOTTOMLEFT
? POPUPPOSITION_ENDAFTER
: POPUPPOSITION_ENDBEFORE;
break;
default:
break;
}
}
if (mHFlip) {
position = POPUPPOSITION_HFLIP(position);
}
if (mVFlip) {
position = POPUPPOSITION_VFLIP(position);
}
return position;
}
/**
* KEEP THIS IN SYNC WITH nsIFrame::CreateView
* as much as possible. Until we get rid of views finally...
*/
void nsMenuPopupFrame::CreatePopupView() {
if (HasView()) {
return;
}
nsViewManager* viewManager = PresContext()->GetPresShell()->GetViewManager();
NS_ASSERTION(nullptr != viewManager, "null view manager");
// Create a view
nsView* parentView = viewManager->GetRootView();
auto visibility = ViewVisibility::Hide;
NS_ASSERTION(parentView, "no parent view");
// Create a view
nsView* view = viewManager->CreateView(GetRect(), parentView, visibility);
// XXX put view last in document order until we can do better
viewManager->InsertChild(parentView, view, nullptr, true);
// Remember our view
SetView(view);
NS_FRAME_LOG(
NS_FRAME_TRACE_CALLS,
("nsMenuPopupFrame::CreatePopupView: frame=%p view=%p", this, view));
}
bool nsMenuPopupFrame::ShouldFollowAnchor() const {
if (mAnchorType != MenuPopupAnchorType::Node || !mAnchorContent) {
return false;
}
// Follow anchor mode is used when followanchor="true" is set or for arrow
// panels.
if (mContent->AsElement()->AttrValueIs(kNameSpaceID_None,
nsGkAtoms::followanchor,
nsGkAtoms::_true, eCaseMatters)) {
return true;
}
if (mContent->AsElement()->AttrValueIs(kNameSpaceID_None,
nsGkAtoms::followanchor,
nsGkAtoms::_false, eCaseMatters)) {
return false;
}
return mPopupType == PopupType::Panel &&
mContent->AsElement()->AttrValueIs(kNameSpaceID_None, nsGkAtoms::type,
nsGkAtoms::arrow, eCaseMatters);
}
bool nsMenuPopupFrame::ShouldFollowAnchor(nsRect& aRect) {
if (!ShouldFollowAnchor()) {
return false;
}
if (nsIFrame* anchorFrame = GetAnchorFrame()) {
if (nsPresContext* rootPresContext = PresContext()->GetRootPresContext()) {
aRect = ComputeAnchorRect(rootPresContext, anchorFrame);
}
}
return true;
}
bool nsMenuPopupFrame::IsDirectionRTL() const {
const nsIFrame* anchor = GetAnchorFrame();
const nsIFrame* f = anchor ? anchor : this;
return f->StyleVisibility()->mDirection == StyleDirection::Rtl;
}
nsIFrame* nsMenuPopupFrame::GetAnchorFrame() const {
nsIContent* anchor = mAnchorContent;
if (!anchor) {
return nullptr;
}
return MaybeDelegatedAnchorFrame(anchor->GetPrimaryFrame());
}
void nsMenuPopupFrame::CheckForAnchorChange(nsRect& aRect) {
// Don't update if the popup isn't visible or we shouldn't be following the
// anchor.
if (!IsVisible() || !ShouldFollowAnchor()) {
return;
}
bool shouldHide = false;
nsPresContext* rootPresContext = PresContext()->GetRootPresContext();
// If the frame for the anchor has gone away, hide the popup.
nsIFrame* anchor = GetAnchorFrame();
if (!anchor || !rootPresContext) {
shouldHide = true;
} else if (!anchor->IsVisibleConsideringAncestors(
VISIBILITY_CROSS_CHROME_CONTENT_BOUNDARY)) {
// If the anchor is now inside something that is invisible, hide the popup.
shouldHide = true;
} else {
// If the anchor is now inside a hidden parent popup, hide the popup.
nsIFrame* frame = anchor;
while (frame) {
nsMenuPopupFrame* popup = do_QueryFrame(frame);
if (popup && popup->PopupState() != ePopupShown) {
shouldHide = true;
break;
}
frame = frame->GetParent();
}
}
if (shouldHide) {
nsXULPopupManager* pm = nsXULPopupManager::GetInstance();
if (pm) {
// As the caller will be iterating over the open popups, hide
// asyncronously.
pm->HidePopup(mContent->AsElement(),
{HidePopupOption::DeselectMenu, HidePopupOption::Async});
}
return;
}
nsRect anchorRect = ComputeAnchorRect(rootPresContext, anchor);
// If the rectangles are different, move the popup.
if (!anchorRect.IsEqualEdges(aRect)) {
aRect = anchorRect;
SetPopupPosition(true);
}
}
|