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 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785 4786 4787 4788 4789 4790 4791 4792 4793 4794 4795 4796 4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 4838 4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862 4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 4877 4878 4879 4880 4881 4882 4883 4884 4885 4886 4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 4915 4916 4917 4918 4919 4920 4921 4922 4923 4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 4938 4939 4940 4941 4942 4943 4944 4945 4946 4947 4948 4949 4950 4951 4952 4953 4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 4976 4977 4978 4979 4980 4981 4982 4983 4984 4985 4986 4987 4988 4989 4990 4991 4992 4993 4994 4995 4996 4997 4998 4999 5000 5001 5002 5003 5004 5005 5006 5007 5008 5009 5010 5011 5012 5013 5014 5015 5016 5017 5018 5019 5020 5021 5022 5023 5024 5025 5026 5027 5028 5029 5030 5031 5032 5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 5058 5059 5060 5061 5062 5063 5064 5065 5066 5067 5068 5069 5070 5071 5072 5073 5074 5075 5076 5077 5078 5079 5080 5081 5082 5083 5084 5085 5086 5087 5088 5089 5090 5091 5092 5093 5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124 5125 5126 5127 5128 5129 5130 5131 5132 5133 5134 5135 5136 5137 5138 5139 5140 5141 5142 5143 5144 5145 5146 5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 5161 5162 5163 5164 5165 5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 5200 5201 5202 5203 5204 5205 5206 5207 5208 5209 5210 5211 5212 5213 5214 5215 5216 5217 5218 5219 5220 5221 5222 5223 5224 5225 5226 5227 5228 5229 5230 5231 5232 5233 5234 5235 5236 5237 5238 5239 5240 5241 5242 5243 5244 5245 5246 5247 5248 5249 5250 5251 5252 5253 5254 5255 5256 5257 5258 5259 5260 5261 5262 5263 5264 5265 5266 5267 5268 5269 5270 5271 5272 5273 5274 5275 5276 5277 5278 5279 5280 5281 5282 5283 5284 5285 5286 5287 5288 5289 5290 5291 5292 5293 5294 5295 5296 5297 5298 5299 5300 5301 5302 5303 5304 5305 5306 5307 5308 5309 5310 5311 5312 5313 5314 5315 5316 5317 5318 5319 5320 5321 5322 5323 5324 5325 5326 5327 5328 5329 5330 5331 5332 5333 5334 5335 5336 5337 5338 5339 5340 5341 5342 5343 5344 5345 5346 5347 5348 5349 5350 5351 5352 5353 5354 5355 5356 5357 5358 5359 5360 5361 5362 5363 5364 5365 5366 5367 5368 5369 5370 5371 5372 5373 5374 5375 5376 5377 5378 5379 5380 5381 5382 5383 5384 5385 5386 5387 5388 5389 5390 5391 5392 5393 5394 5395 5396 5397 5398 5399 5400 5401 5402 5403 5404 5405 5406 5407 5408 5409 5410 5411 5412 5413 5414 5415 5416 5417 5418 5419 5420 5421 5422 5423 5424 5425 5426 5427 5428 5429 5430 5431 5432 5433 5434 5435 5436 5437 5438 5439 5440 5441 5442 5443 5444 5445 5446 5447 5448 5449 5450 5451 5452 5453 5454 5455 5456 5457 5458 5459 5460 5461 5462 5463 5464 5465 5466 5467 5468 5469 5470 5471 5472 5473 5474 5475 5476 5477 5478 5479 5480 5481 5482 5483 5484 5485 5486 5487 5488 5489 5490 5491 5492 5493 5494 5495 5496 5497 5498 5499 5500 5501 5502 5503 5504 5505 5506 5507 5508 5509 5510 5511 5512 5513 5514 5515 5516 5517 5518 5519 5520 5521 5522 5523 5524 5525 5526 5527 5528 5529 5530 5531 5532 5533 5534 5535 5536 5537 5538 5539 5540 5541 5542 5543 5544 5545 5546 5547 5548 5549 5550 5551 5552 5553 5554 5555 5556 5557 5558 5559 5560 5561 5562 5563 5564 5565 5566 5567 5568 5569 5570 5571 5572 5573 5574 5575 5576 5577 5578 5579 5580 5581 5582 5583 5584 5585 5586 5587 5588 5589 5590 5591 5592 5593 5594 5595 5596 5597 5598 5599 5600 5601 5602 5603 5604 5605 5606 5607 5608 5609 5610 5611 5612 5613 5614 5615 5616 5617 5618 5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 5659 5660 5661 5662 5663 5664 5665 5666 5667 5668 5669 5670 5671 5672 5673 5674 5675 5676 5677 5678 5679 5680 5681
|
/* -*- 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 "nsFocusManager.h"
#include <algorithm>
#include "BrowserChild.h"
#include "ChildIterator.h"
#include "ContentParent.h"
#include "LayoutConstants.h"
#include "mozilla/AccessibleCaretEventHub.h"
#include "mozilla/ContentEvents.h"
#include "mozilla/EventDispatcher.h"
#include "mozilla/EventStateManager.h"
#include "mozilla/FocusModel.h"
#include "mozilla/HTMLEditor.h"
#include "mozilla/IMEStateManager.h"
#include "mozilla/LookAndFeel.h"
#include "mozilla/Maybe.h"
#include "mozilla/PointerLockManager.h"
#include "mozilla/Preferences.h"
#include "mozilla/PresShell.h"
#include "mozilla/Services.h"
#include "mozilla/StaticPrefs_accessibility.h"
#include "mozilla/StaticPrefs_full_screen_api.h"
#include "mozilla/Try.h"
#include "mozilla/Unused.h"
#include "mozilla/dom/BrowserBridgeChild.h"
#include "mozilla/dom/BrowserParent.h"
#include "mozilla/dom/ContentChild.h"
#include "mozilla/dom/Document.h"
#include "mozilla/dom/DocumentInlines.h"
#include "mozilla/dom/Element.h"
#include "mozilla/dom/ElementBinding.h"
#include "mozilla/dom/HTMLAreaElement.h"
#include "mozilla/dom/HTMLImageElement.h"
#include "mozilla/dom/HTMLInputElement.h"
#include "mozilla/dom/HTMLSlotElement.h"
#include "mozilla/dom/Selection.h"
#include "mozilla/dom/Text.h"
#include "mozilla/dom/WindowGlobalChild.h"
#include "mozilla/dom/WindowGlobalParent.h"
#include "mozilla/dom/XULPopupElement.h"
#include "mozilla/widget/IMEData.h"
#include "nsCaret.h"
#include "nsContentUtils.h"
#include "nsFrameLoader.h"
#include "nsFrameLoaderOwner.h"
#include "nsFrameSelection.h"
#include "nsFrameTraversal.h"
#include "nsGkAtoms.h"
#include "nsHTMLDocument.h"
#include "nsIAppWindow.h"
#include "nsIBaseWindow.h"
#include "nsIContentInlines.h"
#include "nsIDOMXULMenuListElement.h"
#include "nsIDocShell.h"
#include "nsIDocShellTreeOwner.h"
#include "nsIFormControl.h"
#include "nsIInterfaceRequestorUtils.h"
#include "nsIObserverService.h"
#include "nsIPrincipal.h"
#include "nsIScriptError.h"
#include "nsIScriptObjectPrincipal.h"
#include "nsIWebNavigation.h"
#include "nsIXULRuntime.h"
#include "nsLayoutUtils.h"
#include "nsMenuPopupFrame.h"
#include "nsNetUtil.h"
#include "nsPIDOMWindow.h"
#include "nsQueryObject.h"
#include "nsRange.h"
#include "nsTextControlFrame.h"
#include "nsThreadUtils.h"
#include "nsViewManager.h"
#include "nsXULPopupManager.h"
#ifdef ACCESSIBILITY
# include "nsAccessibilityService.h"
#endif
using namespace mozilla;
using namespace mozilla::dom;
using namespace mozilla::widget;
// Two types of focus pr logging are available:
// 'Focus' for normal focus manager calls
// 'FocusNavigation' for tab and document navigation
LazyLogModule gFocusLog("Focus");
LazyLogModule gFocusNavigationLog("FocusNavigation");
#define LOGFOCUS(args) MOZ_LOG(gFocusLog, mozilla::LogLevel::Debug, args)
#define LOGFOCUSNAVIGATION(args) \
MOZ_LOG(gFocusNavigationLog, mozilla::LogLevel::Debug, args)
#define LOGTAG(log, format, content) \
if (MOZ_LOG_TEST(log, LogLevel::Debug)) { \
nsAutoCString tag("(none)"_ns); \
if (content) { \
content->NodeInfo()->NameAtom()->ToUTF8String(tag); \
} \
MOZ_LOG(log, LogLevel::Debug, (format, tag.get())); \
}
#define LOGCONTENT(format, content) LOGTAG(gFocusLog, format, content)
#define LOGCONTENTNAVIGATION(format, content) \
LOGTAG(gFocusNavigationLog, format, content)
struct nsDelayedBlurOrFocusEvent {
nsDelayedBlurOrFocusEvent(EventMessage aEventMessage, PresShell* aPresShell,
Document* aDocument, EventTarget* aTarget,
EventTarget* aRelatedTarget)
: mPresShell(aPresShell),
mDocument(aDocument),
mTarget(aTarget),
mEventMessage(aEventMessage),
mRelatedTarget(aRelatedTarget) {}
nsDelayedBlurOrFocusEvent(const nsDelayedBlurOrFocusEvent& aOther)
: mPresShell(aOther.mPresShell),
mDocument(aOther.mDocument),
mTarget(aOther.mTarget),
mEventMessage(aOther.mEventMessage) {}
RefPtr<PresShell> mPresShell;
nsCOMPtr<Document> mDocument;
nsCOMPtr<EventTarget> mTarget;
EventMessage mEventMessage;
nsCOMPtr<EventTarget> mRelatedTarget;
};
inline void ImplCycleCollectionUnlink(nsDelayedBlurOrFocusEvent& aField) {
aField.mPresShell = nullptr;
aField.mDocument = nullptr;
aField.mTarget = nullptr;
aField.mRelatedTarget = nullptr;
}
inline void ImplCycleCollectionTraverse(
nsCycleCollectionTraversalCallback& aCallback,
nsDelayedBlurOrFocusEvent& aField, const char* aName, uint32_t aFlags = 0) {
CycleCollectionNoteChild(
aCallback, static_cast<nsIDocumentObserver*>(aField.mPresShell.get()),
aName, aFlags);
CycleCollectionNoteChild(aCallback, aField.mDocument.get(), aName, aFlags);
CycleCollectionNoteChild(aCallback, aField.mTarget.get(), aName, aFlags);
CycleCollectionNoteChild(aCallback, aField.mRelatedTarget.get(), aName,
aFlags);
}
NS_INTERFACE_MAP_BEGIN_CYCLE_COLLECTION(nsFocusManager)
NS_INTERFACE_MAP_ENTRY(nsIFocusManager)
NS_INTERFACE_MAP_ENTRY(nsIObserver)
NS_INTERFACE_MAP_ENTRY(nsISupportsWeakReference)
NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, nsIFocusManager)
NS_INTERFACE_MAP_END
NS_IMPL_CYCLE_COLLECTING_ADDREF(nsFocusManager)
NS_IMPL_CYCLE_COLLECTING_RELEASE(nsFocusManager)
NS_IMPL_CYCLE_COLLECTION_WEAK(nsFocusManager, mActiveWindow,
mActiveBrowsingContextInContent,
mActiveBrowsingContextInChrome, mFocusedWindow,
mFocusedBrowsingContextInContent,
mFocusedBrowsingContextInChrome, mFocusedElement,
mWindowBeingLowered, mDelayedBlurFocusEvents)
StaticRefPtr<nsFocusManager> nsFocusManager::sInstance;
bool nsFocusManager::sTestMode = false;
uint64_t nsFocusManager::sFocusActionCounter = 0;
static const char* kObservedPrefs[] = {"accessibility.browsewithcaret",
"focusmanager.testmode", nullptr};
nsFocusManager::nsFocusManager()
: mActionIdForActiveBrowsingContextInContent(0),
mActionIdForActiveBrowsingContextInChrome(0),
mActionIdForFocusedBrowsingContextInContent(0),
mActionIdForFocusedBrowsingContextInChrome(0),
mActiveBrowsingContextInContentSetFromOtherProcess(false),
mEventHandlingNeedsFlush(false) {}
nsFocusManager::~nsFocusManager() {
Preferences::UnregisterCallbacks(nsFocusManager::PrefChanged, kObservedPrefs,
this);
nsCOMPtr<nsIObserverService> obs = mozilla::services::GetObserverService();
if (obs) {
obs->RemoveObserver(this, "xpcom-shutdown");
}
}
// static
nsresult nsFocusManager::Init() {
sInstance = new nsFocusManager();
sTestMode = Preferences::GetBool("focusmanager.testmode", false);
Preferences::RegisterCallbacks(nsFocusManager::PrefChanged, kObservedPrefs,
sInstance.get());
nsCOMPtr<nsIObserverService> obs = mozilla::services::GetObserverService();
if (obs) {
obs->AddObserver(sInstance, "xpcom-shutdown", true);
}
return NS_OK;
}
// static
void nsFocusManager::Shutdown() { sInstance = nullptr; }
// static
void nsFocusManager::PrefChanged(const char* aPref, void* aSelf) {
if (RefPtr<nsFocusManager> fm = static_cast<nsFocusManager*>(aSelf)) {
fm->PrefChanged(aPref);
}
}
void nsFocusManager::PrefChanged(const char* aPref) {
nsDependentCString pref(aPref);
if (pref.EqualsLiteral("accessibility.browsewithcaret")) {
UpdateCaretForCaretBrowsingMode();
} else if (pref.EqualsLiteral("focusmanager.testmode")) {
sTestMode = Preferences::GetBool("focusmanager.testmode", false);
}
}
NS_IMETHODIMP
nsFocusManager::Observe(nsISupports* aSubject, const char* aTopic,
const char16_t* aData) {
if (!nsCRT::strcmp(aTopic, "xpcom-shutdown")) {
mActiveWindow = nullptr;
mActiveBrowsingContextInContent = nullptr;
mActionIdForActiveBrowsingContextInContent = 0;
mActionIdForFocusedBrowsingContextInContent = 0;
mActiveBrowsingContextInChrome = nullptr;
mActionIdForActiveBrowsingContextInChrome = 0;
mActionIdForFocusedBrowsingContextInChrome = 0;
mFocusedWindow = nullptr;
mFocusedBrowsingContextInContent = nullptr;
mFocusedBrowsingContextInChrome = nullptr;
mFocusedElement = nullptr;
mWindowBeingLowered = nullptr;
mDelayedBlurFocusEvents.Clear();
}
return NS_OK;
}
static bool ActionIdComparableAndLower(uint64_t aActionId,
uint64_t aReference) {
MOZ_ASSERT(aActionId, "Uninitialized action id");
auto [actionProc, actionId] =
nsContentUtils::SplitProcessSpecificId(aActionId);
auto [refProc, refId] = nsContentUtils::SplitProcessSpecificId(aReference);
return actionProc == refProc && actionId < refId;
}
// given a frame content node, retrieve the nsIDOMWindow displayed in it
static nsPIDOMWindowOuter* GetContentWindow(nsIContent* aContent) {
if (Document* doc = aContent->GetComposedDoc()) {
if (Document* subdoc = doc->GetSubDocumentFor(aContent)) {
return subdoc->GetWindow();
}
}
return nullptr;
}
bool nsFocusManager::IsFocused(nsIContent* aContent) {
if (!aContent || !mFocusedElement) {
return false;
}
return aContent == mFocusedElement;
}
bool nsFocusManager::IsTestMode() { return sTestMode; }
bool nsFocusManager::IsInActiveWindow(BrowsingContext* aBC) const {
RefPtr<BrowsingContext> top = aBC->Top();
if (XRE_IsParentProcess()) {
top = top->Canonical()->TopCrossChromeBoundary();
}
return IsSameOrAncestor(top, GetActiveBrowsingContext());
}
// get the current window for the given content node
static nsPIDOMWindowOuter* GetCurrentWindow(nsIContent* aContent) {
Document* doc = aContent->GetComposedDoc();
return doc ? doc->GetWindow() : nullptr;
}
// static
Element* nsFocusManager::GetFocusedDescendant(
nsPIDOMWindowOuter* aWindow, SearchRange aSearchRange,
nsPIDOMWindowOuter** aFocusedWindow) {
NS_ENSURE_TRUE(aWindow, nullptr);
*aFocusedWindow = nullptr;
Element* currentElement = nullptr;
nsPIDOMWindowOuter* window = aWindow;
for (;;) {
*aFocusedWindow = window;
currentElement = window->GetFocusedElement();
if (!currentElement || aSearchRange == eOnlyCurrentWindow) {
break;
}
window = GetContentWindow(currentElement);
if (!window) {
break;
}
if (aSearchRange == eIncludeAllDescendants) {
continue;
}
MOZ_ASSERT(aSearchRange == eIncludeVisibleDescendants);
// If the child window doesn't have PresShell, it means the window is
// invisible.
nsIDocShell* docShell = window->GetDocShell();
if (!docShell) {
break;
}
if (!docShell->GetPresShell()) {
break;
}
}
NS_IF_ADDREF(*aFocusedWindow);
return currentElement;
}
// static
InputContextAction::Cause nsFocusManager::GetFocusMoveActionCause(
uint32_t aFlags) {
if (aFlags & nsIFocusManager::FLAG_BYTOUCH) {
return InputContextAction::CAUSE_TOUCH;
} else if (aFlags & nsIFocusManager::FLAG_BYMOUSE) {
return InputContextAction::CAUSE_MOUSE;
} else if (aFlags & nsIFocusManager::FLAG_BYKEY) {
return InputContextAction::CAUSE_KEY;
} else if (aFlags & nsIFocusManager::FLAG_BYLONGPRESS) {
return InputContextAction::CAUSE_LONGPRESS;
}
return InputContextAction::CAUSE_UNKNOWN;
}
NS_IMETHODIMP
nsFocusManager::GetActiveWindow(mozIDOMWindowProxy** aWindow) {
MOZ_ASSERT(XRE_IsParentProcess(),
"Must not be called outside the parent process.");
NS_IF_ADDREF(*aWindow = mActiveWindow);
return NS_OK;
}
NS_IMETHODIMP
nsFocusManager::GetActiveBrowsingContext(BrowsingContext** aBrowsingContext) {
NS_IF_ADDREF(*aBrowsingContext = GetActiveBrowsingContext());
return NS_OK;
}
void nsFocusManager::FocusWindow(nsPIDOMWindowOuter* aWindow,
CallerType aCallerType) {
if (RefPtr<nsFocusManager> fm = sInstance) {
fm->SetFocusedWindowWithCallerType(aWindow, aCallerType);
}
}
NS_IMETHODIMP
nsFocusManager::GetFocusedWindow(mozIDOMWindowProxy** aFocusedWindow) {
NS_IF_ADDREF(*aFocusedWindow = mFocusedWindow);
return NS_OK;
}
NS_IMETHODIMP
nsFocusManager::GetFocusedContentBrowsingContext(
BrowsingContext** aBrowsingContext) {
MOZ_DIAGNOSTIC_ASSERT(
XRE_IsParentProcess(),
"We only have use cases for this in the parent process");
NS_IF_ADDREF(*aBrowsingContext = GetFocusedBrowsingContextInChrome());
return NS_OK;
}
NS_IMETHODIMP
nsFocusManager::GetActiveContentBrowsingContext(
BrowsingContext** aBrowsingContext) {
MOZ_DIAGNOSTIC_ASSERT(
XRE_IsParentProcess(),
"We only have use cases for this in the parent process");
NS_IF_ADDREF(*aBrowsingContext = GetActiveBrowsingContextInChrome());
return NS_OK;
}
nsresult nsFocusManager::SetFocusedWindowWithCallerType(
mozIDOMWindowProxy* aWindowToFocus, CallerType aCallerType) {
LOGFOCUS(("<<SetFocusedWindow begin>>"));
nsCOMPtr<nsPIDOMWindowOuter> windowToFocus =
nsPIDOMWindowOuter::From(aWindowToFocus);
NS_ENSURE_TRUE(windowToFocus, NS_ERROR_FAILURE);
nsCOMPtr<Element> frameElement = windowToFocus->GetFrameElementInternal();
Maybe<uint64_t> existingActionId;
if (frameElement) {
// pass false for aFocusChanged so that the caret does not get updated
// and scrolling does not occur.
existingActionId = SetFocusInner(frameElement, 0, false, true);
} else if (auto* bc = windowToFocus->GetBrowsingContext();
bc && !bc->IsTop()) {
// No frameElement means windowToFocus is an OOP iframe, so
// the above SetFocusInner is not called. That means the focus
// of the currently focused BC is not going to be cleared. So
// we do that manually here.
if (RefPtr<BrowsingContext> focusedBC = GetFocusedBrowsingContext()) {
// If focusedBC is an ancestor of bc, blur will be handled
// correctly by nsFocusManager::AdjustWindowFocus.
if (!IsSameOrAncestor(focusedBC, bc)) {
existingActionId.emplace(sInstance->GenerateFocusActionId());
Blur(focusedBC, nullptr, true, true, false, existingActionId.value());
}
}
} else {
// this is a top-level window. If the window has a child frame focused,
// clear the focus. Otherwise, focus should already be in this frame, or
// already cleared. This ensures that focus will be in this frame and not
// in a child.
if (Element* el = windowToFocus->GetFocusedElement()) {
if (nsCOMPtr<nsPIDOMWindowOuter> childWindow = GetContentWindow(el)) {
ClearFocus(windowToFocus);
}
}
}
nsCOMPtr<nsPIDOMWindowOuter> rootWindow = windowToFocus->GetPrivateRoot();
const uint64_t actionId = existingActionId.isSome()
? existingActionId.value()
: sInstance->GenerateFocusActionId();
if (rootWindow) {
RaiseWindow(rootWindow, aCallerType, actionId);
}
LOGFOCUS(("<<SetFocusedWindow end actionid: %" PRIu64 ">>", actionId));
return NS_OK;
}
NS_IMETHODIMP nsFocusManager::SetFocusedWindow(
mozIDOMWindowProxy* aWindowToFocus) {
return SetFocusedWindowWithCallerType(aWindowToFocus, CallerType::System);
}
NS_IMETHODIMP
nsFocusManager::GetFocusedElement(Element** aFocusedElement) {
RefPtr<Element> focusedElement = mFocusedElement;
focusedElement.forget(aFocusedElement);
return NS_OK;
}
uint32_t nsFocusManager::GetLastFocusMethod(nsPIDOMWindowOuter* aWindow) const {
nsPIDOMWindowOuter* window = aWindow ? aWindow : mFocusedWindow.get();
uint32_t method = window ? window->GetFocusMethod() : 0;
NS_ASSERTION((method & METHOD_MASK) == method, "invalid focus method");
return method;
}
NS_IMETHODIMP
nsFocusManager::GetLastFocusMethod(mozIDOMWindowProxy* aWindow,
uint32_t* aLastFocusMethod) {
*aLastFocusMethod = GetLastFocusMethod(nsPIDOMWindowOuter::From(aWindow));
return NS_OK;
}
NS_IMETHODIMP
nsFocusManager::SetFocus(Element* aElement, uint32_t aFlags) {
LOGFOCUS(("<<SetFocus begin>>"));
NS_ENSURE_ARG(aElement);
SetFocusInner(aElement, aFlags, true, true);
LOGFOCUS(("<<SetFocus end>>"));
return NS_OK;
}
NS_IMETHODIMP
nsFocusManager::ElementIsFocusable(Element* aElement, uint32_t aFlags,
bool* aIsFocusable) {
NS_ENSURE_TRUE(aElement, NS_ERROR_INVALID_ARG);
*aIsFocusable = !!FlushAndCheckIfFocusable(aElement, aFlags);
return NS_OK;
}
MOZ_CAN_RUN_SCRIPT_BOUNDARY NS_IMETHODIMP
nsFocusManager::MoveFocus(mozIDOMWindowProxy* aWindow, Element* aStartElement,
uint32_t aType, uint32_t aFlags, Element** aElement) {
*aElement = nullptr;
LOGFOCUS(("<<MoveFocus begin Type: %d Flags: %x>>", aType, aFlags));
if (MOZ_LOG_TEST(gFocusLog, LogLevel::Debug) && mFocusedWindow) {
Document* doc = mFocusedWindow->GetExtantDoc();
if (doc && doc->GetDocumentURI()) {
LOGFOCUS((" Focused Window: %p %s", mFocusedWindow.get(),
doc->GetDocumentURI()->GetSpecOrDefault().get()));
}
}
LOGCONTENT(" Current Focus: %s", mFocusedElement.get());
// use FLAG_BYMOVEFOCUS when switching focus with MoveFocus unless one of
// the other focus methods is already set, or we're just moving to the root
// or caret position.
if (aType != MOVEFOCUS_ROOT && aType != MOVEFOCUS_CARET &&
(aFlags & METHOD_MASK) == 0) {
aFlags |= FLAG_BYMOVEFOCUS;
}
nsCOMPtr<nsPIDOMWindowOuter> window;
if (aStartElement) {
window = GetCurrentWindow(aStartElement);
} else {
window = aWindow ? nsPIDOMWindowOuter::From(aWindow) : mFocusedWindow.get();
}
NS_ENSURE_TRUE(window, NS_ERROR_FAILURE);
// Flush to ensure that focusability of descendants is computed correctly.
if (RefPtr<Document> doc = window->GetExtantDoc()) {
doc->FlushPendingNotifications(FlushType::EnsurePresShellInitAndFrames);
}
bool noParentTraversal = aFlags & FLAG_NOPARENTFRAME;
nsCOMPtr<nsIContent> newFocus;
nsresult rv = DetermineElementToMoveFocus(window, aStartElement, aType,
noParentTraversal, true,
getter_AddRefs(newFocus));
if (rv == NS_SUCCESS_DOM_NO_OPERATION) {
return NS_OK;
}
NS_ENSURE_SUCCESS(rv, rv);
LOGCONTENTNAVIGATION("Element to be focused: %s", newFocus.get());
if (newFocus && newFocus->IsElement()) {
// for caret movement, pass false for the aFocusChanged argument,
// otherwise the caret will end up moving to the focus position. This
// would be a problem because the caret would move to the beginning of the
// focused link making it impossible to navigate the caret over a link.
SetFocusInner(MOZ_KnownLive(newFocus->AsElement()), aFlags,
aType != MOVEFOCUS_CARET, true);
*aElement = do_AddRef(newFocus->AsElement()).take();
} else if (aType == MOVEFOCUS_ROOT || aType == MOVEFOCUS_CARET) {
// no content was found, so clear the focus for these two types.
ClearFocus(window);
}
LOGFOCUS(("<<MoveFocus end>>"));
return NS_OK;
}
NS_IMETHODIMP
nsFocusManager::ClearFocus(mozIDOMWindowProxy* aWindow) {
LOGFOCUS(("<<ClearFocus begin>>"));
// if the window to clear is the focused window or an ancestor of the
// focused window, then blur the existing focused content. Otherwise, the
// focus is somewhere else so just update the current node.
NS_ENSURE_TRUE(aWindow, NS_ERROR_INVALID_ARG);
nsCOMPtr<nsPIDOMWindowOuter> window = nsPIDOMWindowOuter::From(aWindow);
if (IsSameOrAncestor(window, GetFocusedBrowsingContext())) {
RefPtr<BrowsingContext> bc = window->GetBrowsingContext();
RefPtr<BrowsingContext> focusedBC = GetFocusedBrowsingContext();
const bool isAncestor = (focusedBC != bc);
RefPtr<BrowsingContext> ancestorBC = isAncestor ? bc : nullptr;
if (Blur(focusedBC, ancestorBC, isAncestor, true, false,
GenerateFocusActionId())) {
// if we are clearing the focus on an ancestor of the focused window,
// the ancestor will become the new focused window, so focus it
if (isAncestor) {
// Intentionally use a new actionId here because the above
// Blur() will clear the focus of the ancestors of focusedBC, and
// this Focus() call might need to update the focus of those ancestors,
// so it needs to have a newer actionId to make that happen.
Focus(window, nullptr, 0, true, false, false, true,
GenerateFocusActionId());
}
}
} else {
window->SetFocusedElement(nullptr);
}
LOGFOCUS(("<<ClearFocus end>>"));
return NS_OK;
}
NS_IMETHODIMP
nsFocusManager::GetFocusedElementForWindow(mozIDOMWindowProxy* aWindow,
bool aDeep,
mozIDOMWindowProxy** aFocusedWindow,
Element** aElement) {
*aElement = nullptr;
if (aFocusedWindow) {
*aFocusedWindow = nullptr;
}
NS_ENSURE_TRUE(aWindow, NS_ERROR_INVALID_ARG);
nsCOMPtr<nsPIDOMWindowOuter> window = nsPIDOMWindowOuter::From(aWindow);
nsCOMPtr<nsPIDOMWindowOuter> focusedWindow;
RefPtr<Element> focusedElement =
GetFocusedDescendant(window,
aDeep ? nsFocusManager::eIncludeAllDescendants
: nsFocusManager::eOnlyCurrentWindow,
getter_AddRefs(focusedWindow));
focusedElement.forget(aElement);
if (aFocusedWindow) {
NS_IF_ADDREF(*aFocusedWindow = focusedWindow);
}
return NS_OK;
}
NS_IMETHODIMP
nsFocusManager::MoveCaretToFocus(mozIDOMWindowProxy* aWindow) {
nsCOMPtr<nsIWebNavigation> webnav = do_GetInterface(aWindow);
nsCOMPtr<nsIDocShellTreeItem> dsti = do_QueryInterface(webnav);
if (dsti) {
if (dsti->ItemType() != nsIDocShellTreeItem::typeChrome) {
nsCOMPtr<nsIDocShell> docShell = do_QueryInterface(dsti);
NS_ENSURE_TRUE(docShell, NS_ERROR_FAILURE);
// don't move the caret for editable documents
bool isEditable;
docShell->GetEditable(&isEditable);
if (isEditable) {
return NS_OK;
}
RefPtr<PresShell> presShell = docShell->GetPresShell();
NS_ENSURE_TRUE(presShell, NS_ERROR_FAILURE);
nsCOMPtr<nsPIDOMWindowOuter> window = nsPIDOMWindowOuter::From(aWindow);
if (RefPtr<Element> focusedElement = window->GetFocusedElement()) {
MoveCaretToFocus(presShell, focusedElement);
}
}
}
return NS_OK;
}
void nsFocusManager::WindowRaised(mozIDOMWindowProxy* aWindow,
uint64_t aActionId) {
if (!aWindow) {
return;
}
nsCOMPtr<nsPIDOMWindowOuter> window = nsPIDOMWindowOuter::From(aWindow);
BrowsingContext* bc = window->GetBrowsingContext();
if (MOZ_LOG_TEST(gFocusLog, LogLevel::Debug)) {
LOGFOCUS(("Window %p Raised [Currently: %p %p] actionid: %" PRIu64, aWindow,
mActiveWindow.get(), mFocusedWindow.get(), aActionId));
Document* doc = window->GetExtantDoc();
if (doc && doc->GetDocumentURI()) {
LOGFOCUS((" Raised Window: %p %s", aWindow,
doc->GetDocumentURI()->GetSpecOrDefault().get()));
}
if (mActiveWindow) {
doc = mActiveWindow->GetExtantDoc();
if (doc && doc->GetDocumentURI()) {
LOGFOCUS((" Active Window: %p %s", mActiveWindow.get(),
doc->GetDocumentURI()->GetSpecOrDefault().get()));
}
}
}
if (XRE_IsParentProcess()) {
if (mActiveWindow == window) {
// The window is already active, so there is no need to focus anything,
// but make sure that the right widget is focused. This is a special case
// for Windows because when restoring a minimized window, a second
// activation will occur and the top-level widget could be focused instead
// of the child we want. We solve this by calling SetFocus to ensure that
// what the focus manager thinks should be the current widget is actually
// focused.
EnsureCurrentWidgetFocused(CallerType::System);
return;
}
// lower the existing window, if any. This shouldn't happen usually.
if (nsCOMPtr<nsPIDOMWindowOuter> activeWindow = mActiveWindow) {
WindowLowered(activeWindow, aActionId);
}
} else if (bc->IsTop()) {
BrowsingContext* active = GetActiveBrowsingContext();
if (active == bc && !mActiveBrowsingContextInContentSetFromOtherProcess) {
// EnsureCurrentWidgetFocused() should not be necessary with
// PuppetWidget.
return;
}
if (active && active != bc) {
if (active->IsInProcess()) {
nsCOMPtr<nsPIDOMWindowOuter> activeWindow = active->GetDOMWindow();
WindowLowered(activeWindow, aActionId);
}
// No else, because trying to lower other-process windows
// from here can result in the BrowsingContext no longer
// existing in the parent process by the time it deserializes
// the IPC message.
}
}
nsCOMPtr<nsIDocShellTreeItem> docShellAsItem = window->GetDocShell();
// If there's no docShellAsItem, this window must have been closed,
// in that case there is no tree owner.
if (!docShellAsItem) {
return;
}
// set this as the active window
if (XRE_IsParentProcess()) {
mActiveWindow = window;
} else if (bc->IsTop()) {
SetActiveBrowsingContextInContent(bc, aActionId,
false /* aIsEnteringBFCache */);
}
// ensure that the window is enabled and visible
nsCOMPtr<nsIDocShellTreeOwner> treeOwner;
docShellAsItem->GetTreeOwner(getter_AddRefs(treeOwner));
if (nsCOMPtr<nsIBaseWindow> baseWindow = do_QueryInterface(treeOwner)) {
bool isEnabled = true;
if (NS_SUCCEEDED(baseWindow->GetEnabled(&isEnabled)) && !isEnabled) {
return;
}
baseWindow->SetVisibility(true);
}
if (XRE_IsParentProcess()) {
// Unsetting top-level focus upon lowering was inhibited to accommodate
// ATOK, so we need to do it here.
BrowserParent::UnsetTopLevelWebFocusAll();
ActivateOrDeactivate(window, true);
}
// Retrieve the last focused element within the window that was raised.
MoveFocusToWindowAfterRaise(window, aActionId);
}
void nsFocusManager::MoveFocusToWindowAfterRaise(nsPIDOMWindowOuter* aWindow,
uint64_t aActionId) {
nsCOMPtr<nsPIDOMWindowOuter> currentWindow;
RefPtr<Element> currentFocus = GetFocusedDescendant(
aWindow, eIncludeAllDescendants, getter_AddRefs(currentWindow));
NS_ASSERTION(currentWindow, "window raised with no window current");
if (!currentWindow) {
return;
}
// We use mFocusedWindow here is basically for the case that iframe navigate
// from a.com to b.com for example, so it ends up being loaded in a different
// process after Fission, but
// currentWindow->GetBrowsingContext() == GetFocusedBrowsingContext() would
// still be true because focused browsing context is synced, and we won't
// fire a focus event while focusing if we use it as condition.
Focus(currentWindow, currentFocus, /* aFlags = */ 0,
/* aIsNewDocument = */ currentWindow != mFocusedWindow,
/* aFocusChanged = */ false,
/* aWindowRaised = */ true, /* aAdjustWidget = */ true, aActionId);
}
void nsFocusManager::WindowLowered(mozIDOMWindowProxy* aWindow,
uint64_t aActionId) {
if (!aWindow) {
return;
}
nsCOMPtr<nsPIDOMWindowOuter> window = nsPIDOMWindowOuter::From(aWindow);
if (MOZ_LOG_TEST(gFocusLog, LogLevel::Debug)) {
LOGFOCUS(("Window %p Lowered [Currently: %p %p]", aWindow,
mActiveWindow.get(), mFocusedWindow.get()));
Document* doc = window->GetExtantDoc();
if (doc && doc->GetDocumentURI()) {
LOGFOCUS((" Lowered Window: %s",
doc->GetDocumentURI()->GetSpecOrDefault().get()));
}
if (mActiveWindow) {
doc = mActiveWindow->GetExtantDoc();
if (doc && doc->GetDocumentURI()) {
LOGFOCUS((" Active Window: %s",
doc->GetDocumentURI()->GetSpecOrDefault().get()));
}
}
}
if (XRE_IsParentProcess()) {
if (mActiveWindow != window) {
return;
}
} else {
BrowsingContext* bc = window->GetBrowsingContext();
BrowsingContext* active = GetActiveBrowsingContext();
if (active != bc->Top()) {
return;
}
}
// clear the mouse capture as the active window has changed
PresShell::ReleaseCapturingContent();
// In addition, reset the drag state to ensure that we are no longer in
// drag-select mode.
if (mFocusedWindow) {
nsCOMPtr<nsIDocShell> docShell = mFocusedWindow->GetDocShell();
if (docShell) {
if (PresShell* presShell = docShell->GetPresShell()) {
RefPtr<nsFrameSelection> frameSelection = presShell->FrameSelection();
frameSelection->SetDragState(false);
}
}
}
if (XRE_IsParentProcess()) {
ActivateOrDeactivate(window, false);
}
// keep track of the window being lowered, so that attempts to raise the
// window can be prevented until we return. Otherwise, focus can get into
// an unusual state.
mWindowBeingLowered = window;
if (XRE_IsParentProcess()) {
mActiveWindow = nullptr;
} else {
BrowsingContext* bc = window->GetBrowsingContext();
if (bc == bc->Top()) {
SetActiveBrowsingContextInContent(nullptr, aActionId,
false /* aIsEnteringBFCache */);
}
}
if (mFocusedWindow) {
Blur(nullptr, nullptr, true, true, false, aActionId);
}
mWindowBeingLowered = nullptr;
}
void nsFocusManager::FocusedElementMayHaveMoved(nsIContent* aContent,
nsINode* aOldParent) {
if (!aOldParent) {
return;
}
if (aOldParent->IsElement() &&
!aOldParent->AsElement()->State().HasState(ElementState::FOCUS_WITHIN)) {
return;
}
nsPIDOMWindowOuter* window = aContent->OwnerDoc()->GetWindow();
if (!window) {
return;
}
Element* focusedElement = window->GetFocusedElement();
if (!focusedElement) {
return;
}
if (!nsContentUtils::ContentIsHostIncludingDescendantOf(focusedElement,
aContent)) {
return;
}
if (aOldParent->IsElement()) {
// Clear the old ancestor chain.
NotifyFocusStateChange(aOldParent->AsElement(), nullptr, 0, false, false);
}
// XXX This is not very optimal.
// Clear the ancestor chain of focused element.
NotifyFocusStateChange(focusedElement, nullptr, 0, false, false);
// And set the correct states.
NotifyFocusStateChange(focusedElement, nullptr, 0, true, false);
}
void nsFocusManager::ContentInserted(nsIContent* aChild,
const ContentInsertInfo& aInfo) {
FocusedElementMayHaveMoved(aChild, aInfo.mOldParent);
}
void nsFocusManager::ContentAppended(nsIContent* aFirstNewContent,
const ContentAppendInfo& aInfo) {
FocusedElementMayHaveMoved(aFirstNewContent, aInfo.mOldParent);
}
nsresult nsFocusManager::ContentRemoved(Document* aDocument,
nsIContent* aContent,
const ContentRemoveInfo& aInfo) {
NS_ENSURE_ARG(aDocument);
NS_ENSURE_ARG(aContent);
if (aInfo.mNewParent) {
// Handled upon insertion in ContentAppended/Inserted.
return NS_OK;
}
nsPIDOMWindowOuter* windowPtr = aDocument->GetWindow();
if (!windowPtr) {
return NS_OK;
}
// if the content is currently focused in the window, or is an
// shadow-including inclusive ancestor of the currently focused element,
// reset the focus within that window.
Element* previousFocusedElementPtr = windowPtr->GetFocusedElement();
if (!previousFocusedElementPtr) {
return NS_OK;
}
if (!nsContentUtils::ContentIsHostIncludingDescendantOf(
previousFocusedElementPtr, aContent)) {
return NS_OK;
}
RefPtr<nsPIDOMWindowOuter> window = windowPtr;
RefPtr<Element> previousFocusedElement = previousFocusedElementPtr;
RefPtr<Element> newFocusedElement = [&]() -> Element* {
if (auto* sr = ShadowRoot::FromNode(aContent)) {
if (sr->IsUAWidget() && sr->Host()->IsHTMLElement(nsGkAtoms::input)) {
return sr->Host();
}
}
return nullptr;
}();
window->SetFocusedElement(newFocusedElement);
// if this window is currently focused, clear the global focused
// element as well, but don't fire any events.
if (window->GetBrowsingContext() == GetFocusedBrowsingContext()) {
mFocusedElement = newFocusedElement;
} else if (Document* subdoc =
aDocument->GetSubDocumentFor(previousFocusedElement)) {
// Check if the node that was focused is an iframe or similar by looking if
// it has a subdocument. This would indicate that this focused iframe
// and its descendants will be going away. We will need to move the focus
// somewhere else, so just clear the focus in the toplevel window so that no
// element is focused.
//
// The Fission case is handled in FlushAndCheckIfFocusable().
if (nsCOMPtr<nsIDocShell> docShell = subdoc->GetDocShell()) {
nsCOMPtr<nsPIDOMWindowOuter> childWindow = docShell->GetWindow();
if (childWindow &&
IsSameOrAncestor(childWindow, GetFocusedBrowsingContext())) {
if (XRE_IsParentProcess()) {
nsCOMPtr<nsPIDOMWindowOuter> activeWindow = mActiveWindow;
ClearFocus(activeWindow);
} else {
BrowsingContext* active = GetActiveBrowsingContext();
if (active) {
if (active->IsInProcess()) {
nsCOMPtr<nsPIDOMWindowOuter> activeWindow =
active->GetDOMWindow();
ClearFocus(activeWindow);
} else {
mozilla::dom::ContentChild* contentChild =
mozilla::dom::ContentChild::GetSingleton();
MOZ_ASSERT(contentChild);
contentChild->SendClearFocus(active);
}
} // no else, because ClearFocus does nothing with nullptr
}
}
}
}
// Notify the editor in case we removed its ancestor limiter.
if (previousFocusedElement->IsEditable()) {
if (nsIDocShell* const docShell = aDocument->GetDocShell()) {
if (HTMLEditor* const htmlEditor = docShell->GetHTMLEditor()) {
Selection* const selection = htmlEditor->GetSelection();
if (selection && selection->GetFrameSelection() &&
previousFocusedElement ==
selection->GetFrameSelection()->GetAncestorLimiter()) {
// The editing host may be being removed right now. So, it's already
// removed from the child chain of the parent node, but it still know
// the parent node. This could cause unexpected result at scheduling
// paint of the caret. Therefore, we should call FinalizeSelection
// after unblocking to run the script.
nsContentUtils::AddScriptRunner(
NewRunnableMethod("HTMLEditor::FinalizeSelection", htmlEditor,
&HTMLEditor::FinalizeSelection));
}
}
}
}
if (!newFocusedElement) {
NotifyFocusStateChange(previousFocusedElement, newFocusedElement, 0,
/* aGettingFocus = */ false, false);
} else {
// We should already have the right state, which is managed by the <input>
// widget.
MOZ_ASSERT(newFocusedElement->State().HasState(ElementState::FOCUS));
}
// If we changed focused element and the element still has focus, let's
// notify IME of focus. Note that if new focus move has already occurred
// by running script, we should not let IMEStateManager of outdated focus
// change.
if (mFocusedElement == newFocusedElement && mFocusedWindow == window) {
RefPtr<nsPresContext> presContext(aDocument->GetPresContext());
IMEStateManager::OnChangeFocus(presContext, newFocusedElement,
InputContextAction::Cause::CAUSE_UNKNOWN);
}
return NS_OK;
}
void nsFocusManager::WindowShown(mozIDOMWindowProxy* aWindow,
bool aNeedsFocus) {
if (!aWindow) {
return;
}
nsCOMPtr<nsPIDOMWindowOuter> window = nsPIDOMWindowOuter::From(aWindow);
if (MOZ_LOG_TEST(gFocusLog, LogLevel::Debug)) {
LOGFOCUS(("Window %p Shown [Currently: %p %p]", window.get(),
mActiveWindow.get(), mFocusedWindow.get()));
Document* doc = window->GetExtantDoc();
if (doc && doc->GetDocumentURI()) {
LOGFOCUS(("Shown Window: %s",
doc->GetDocumentURI()->GetSpecOrDefault().get()));
}
if (mFocusedWindow) {
doc = mFocusedWindow->GetExtantDoc();
if (doc && doc->GetDocumentURI()) {
LOGFOCUS((" Focused Window: %s",
doc->GetDocumentURI()->GetSpecOrDefault().get()));
}
}
}
if (XRE_IsParentProcess()) {
if (BrowsingContext* bc = window->GetBrowsingContext()) {
if (bc->IsTop()) {
bc->SetIsActiveBrowserWindow(bc->GetIsActiveBrowserWindow());
}
}
}
if (XRE_IsParentProcess()) {
if (mFocusedWindow != window) {
return;
}
} else {
BrowsingContext* bc = window->GetBrowsingContext();
if (!bc || mFocusedBrowsingContextInContent != bc) {
return;
}
// Sync the window for a newly-created OOP iframe
// Set actionId to zero to signify that it should be ignored.
SetFocusedWindowInternal(window, 0, false);
}
if (aNeedsFocus) {
nsCOMPtr<nsPIDOMWindowOuter> currentWindow;
RefPtr<Element> currentFocus = GetFocusedDescendant(
window, eIncludeAllDescendants, getter_AddRefs(currentWindow));
if (currentWindow) {
Focus(currentWindow, currentFocus, 0, true, false, false, true,
GenerateFocusActionId());
}
} else {
// Sometimes, an element in a window can be focused before the window is
// visible, which would mean that the widget may not be properly focused.
// When the window becomes visible, make sure the right widget is focused.
EnsureCurrentWidgetFocused(CallerType::System);
}
}
void nsFocusManager::WindowHidden(mozIDOMWindowProxy* aWindow,
uint64_t aActionId, bool aIsEnteringBFCache) {
// if there is no window or it is not the same or an ancestor of the
// currently focused window, just return, as the current focus will not
// be affected.
if (!aWindow) {
return;
}
nsCOMPtr<nsPIDOMWindowOuter> window = nsPIDOMWindowOuter::From(aWindow);
if (MOZ_LOG_TEST(gFocusLog, LogLevel::Debug)) {
LOGFOCUS(("Window %p Hidden [Currently: %p %p] actionid: %" PRIu64,
window.get(), mActiveWindow.get(), mFocusedWindow.get(),
aActionId));
nsAutoCString spec;
Document* doc = window->GetExtantDoc();
if (doc && doc->GetDocumentURI()) {
LOGFOCUS((" Hide Window: %s",
doc->GetDocumentURI()->GetSpecOrDefault().get()));
}
if (mFocusedWindow) {
doc = mFocusedWindow->GetExtantDoc();
if (doc && doc->GetDocumentURI()) {
LOGFOCUS((" Focused Window: %s",
doc->GetDocumentURI()->GetSpecOrDefault().get()));
}
}
if (mActiveWindow) {
doc = mActiveWindow->GetExtantDoc();
if (doc && doc->GetDocumentURI()) {
LOGFOCUS((" Active Window: %s",
doc->GetDocumentURI()->GetSpecOrDefault().get()));
}
}
}
if (!IsSameOrAncestor(window, mFocusedWindow)) {
return;
}
// at this point, we know that the window being hidden is either the focused
// window, or an ancestor of the focused window. Either way, the focus is no
// longer valid, so it needs to be updated.
const RefPtr<Element> oldFocusedElement = std::move(mFocusedElement);
nsCOMPtr<nsIDocShell> focusedDocShell = mFocusedWindow->GetDocShell();
if (!focusedDocShell) {
return;
}
const RefPtr<PresShell> presShell = focusedDocShell->GetPresShell();
if (oldFocusedElement && oldFocusedElement->IsInComposedDoc()) {
NotifyFocusStateChange(oldFocusedElement, nullptr, 0, false, false);
window->UpdateCommands(u"focus"_ns);
if (presShell) {
RefPtr<Document> composedDoc = oldFocusedElement->GetComposedDoc();
SendFocusOrBlurEvent(eBlur, presShell, composedDoc, oldFocusedElement,
false);
}
}
const RefPtr<nsPresContext> focusedPresContext =
presShell ? presShell->GetPresContext() : nullptr;
IMEStateManager::OnChangeFocus(focusedPresContext, nullptr,
GetFocusMoveActionCause(0));
if (presShell) {
SetCaretVisible(presShell, false, nullptr);
}
// If a window is being "hidden" because its BrowsingContext is changing
// remoteness, we don't want to handle docshell destruction by moving focus.
// Instead, the focused browsing context should stay the way it is (so that
// the newly "shown" window in the other process knows to take focus) and
// we should just null out the process-local field.
nsCOMPtr<nsIDocShell> docShellBeingHidden = window->GetDocShell();
// Check if we're currently hiding a non-remote nsDocShell due to its
// BrowsingContext navigating to become remote. Normally, when a focused
// subframe is hidden, focus is moved to the frame element, but focus should
// stay with the BrowsingContext when performing a process switch. We don't
// need to consider process switches where the hiding docshell is already
// remote (ie. GetEmbedderElement is nullptr), as shifting remoteness to the
// frame element is handled elsewhere.
if (docShellBeingHidden &&
nsDocShell::Cast(docShellBeingHidden)->WillChangeProcess() &&
docShellBeingHidden->GetBrowsingContext()->GetEmbedderElement()) {
if (mFocusedWindow != window) {
// The window being hidden is an ancestor of the focused window.
#ifdef DEBUG
BrowsingContext* ancestor = window->GetBrowsingContext();
BrowsingContext* bc = mFocusedWindow->GetBrowsingContext();
for (;;) {
if (!bc) {
MOZ_ASSERT(false, "Should have found ancestor");
}
bc = bc->GetParent();
if (ancestor == bc) {
break;
}
}
#endif
// This call adjusts the focused browsing context and window.
// The latter gets nulled out immediately below.
SetFocusedWindowInternal(window, aActionId);
}
mFocusedWindow = nullptr;
window->SetFocusedElement(nullptr);
return;
}
// if the docshell being hidden is being destroyed, then we want to move
// focus somewhere else. Call ClearFocus on the toplevel window, which
// will have the effect of clearing the focus and moving the focused window
// to the toplevel window. But if the window isn't being destroyed, we are
// likely just loading a new document in it, so we want to maintain the
// focused window so that the new document gets properly focused.
bool beingDestroyed = !docShellBeingHidden;
if (docShellBeingHidden) {
docShellBeingHidden->IsBeingDestroyed(&beingDestroyed);
}
if (beingDestroyed) {
// There is usually no need to do anything if a toplevel window is going
// away, as we assume that WindowLowered will be called. However, this may
// not happen if nsIAppStartup::eForceQuit is used to quit, and can cause
// a leak. So if the active window is being destroyed, call WindowLowered
// directly.
if (XRE_IsParentProcess()) {
nsCOMPtr<nsPIDOMWindowOuter> activeWindow = mActiveWindow;
if (activeWindow == mFocusedWindow || activeWindow == window) {
WindowLowered(activeWindow, aActionId);
} else {
ClearFocus(activeWindow);
}
} else {
BrowsingContext* active = GetActiveBrowsingContext();
if (active) {
if (nsCOMPtr<nsPIDOMWindowOuter> activeWindow =
active->GetDOMWindow()) {
if ((mFocusedWindow &&
mFocusedWindow->GetBrowsingContext() == active) ||
(window->GetBrowsingContext() == active)) {
WindowLowered(activeWindow, aActionId);
} else {
ClearFocus(activeWindow);
}
} // else do nothing when an out-of-process iframe is torn down
}
}
return;
}
if (!XRE_IsParentProcess() &&
mActiveBrowsingContextInContent ==
docShellBeingHidden->GetBrowsingContext() &&
mActiveBrowsingContextInContent->GetIsInBFCache()) {
SetActiveBrowsingContextInContent(nullptr, aActionId, aIsEnteringBFCache);
}
// if the window being hidden is an ancestor of the focused window, adjust
// the focused window so that it points to the one being hidden. This
// ensures that the focused window isn't in a chain of frames that doesn't
// exist any more.
if (window != mFocusedWindow) {
nsCOMPtr<nsIDocShellTreeItem> dsti =
mFocusedWindow ? mFocusedWindow->GetDocShell() : nullptr;
if (dsti) {
nsCOMPtr<nsIDocShellTreeItem> parentDsti;
dsti->GetInProcessParent(getter_AddRefs(parentDsti));
if (parentDsti) {
if (nsCOMPtr<nsPIDOMWindowOuter> parentWindow =
parentDsti->GetWindow()) {
parentWindow->SetFocusedElement(nullptr);
}
}
}
SetFocusedWindowInternal(window, aActionId);
}
}
void nsFocusManager::FireDelayedEvents(Document* aDocument) {
MOZ_ASSERT(aDocument);
// fire any delayed focus and blur events in the same order that they were
// added
for (uint32_t i = 0; i < mDelayedBlurFocusEvents.Length(); i++) {
if (mDelayedBlurFocusEvents[i].mDocument == aDocument) {
if (!aDocument->GetInnerWindow() ||
!aDocument->GetInnerWindow()->IsCurrentInnerWindow()) {
// If the document was navigated away from or is defunct, don't bother
// firing events on it. Note the symmetry between this condition and
// the similar one in Document.cpp:FireOrClearDelayedEvents.
mDelayedBlurFocusEvents.RemoveElementAt(i);
--i;
} else if (!aDocument->EventHandlingSuppressed()) {
EventMessage message = mDelayedBlurFocusEvents[i].mEventMessage;
nsCOMPtr<EventTarget> target = mDelayedBlurFocusEvents[i].mTarget;
RefPtr<PresShell> presShell = mDelayedBlurFocusEvents[i].mPresShell;
nsCOMPtr<EventTarget> relatedTarget =
mDelayedBlurFocusEvents[i].mRelatedTarget;
mDelayedBlurFocusEvents.RemoveElementAt(i);
FireFocusOrBlurEvent(message, presShell, target, false, false,
relatedTarget);
--i;
}
}
}
}
void nsFocusManager::WasNuked(nsPIDOMWindowOuter* aWindow) {
MOZ_ASSERT(aWindow, "Expected non-null window.");
if (aWindow == mActiveWindow) {
// TODO(emilio, bug 1933555): Figure out if we can assert below.
// MOZ_ASSERT_UNREACHABLE("How come we're nuking a window that's still
// active?");
mActiveWindow = nullptr;
SetActiveBrowsingContextInChrome(nullptr, GenerateFocusActionId());
}
if (aWindow == mFocusedWindow) {
mFocusedWindow = nullptr;
SetFocusedBrowsingContext(nullptr, GenerateFocusActionId());
mFocusedElement = nullptr;
}
}
nsFocusManager::BlurredElementInfo::BlurredElementInfo(Element& aElement)
: mElement(aElement) {}
nsFocusManager::BlurredElementInfo::~BlurredElementInfo() = default;
// https://drafts.csswg.org/selectors-4/#the-focus-visible-pseudo
static bool ShouldMatchFocusVisible(nsPIDOMWindowOuter* aWindow,
const Element& aElement,
int32_t aFocusFlags) {
// If we were explicitly requested to show the ring, do it.
if (aFocusFlags & nsIFocusManager::FLAG_SHOWRING) {
return true;
}
if (aFocusFlags & nsIFocusManager::FLAG_NOSHOWRING) {
return false;
}
if (aWindow->ShouldShowFocusRing()) {
// The window decision also trumps any other heuristic.
return true;
}
// Any element which supports keyboard input (such as an input element, or any
// other element which may trigger a virtual keyboard to be shown on focus if
// a physical keyboard is not present) should always match :focus-visible when
// focused.
{
if (aElement.IsHTMLElement(nsGkAtoms::textarea) || aElement.IsEditable()) {
return true;
}
if (auto* input = HTMLInputElement::FromNode(aElement)) {
if (input->IsSingleLineTextControl()) {
return true;
}
}
}
switch (nsFocusManager::GetFocusMoveActionCause(aFocusFlags)) {
case InputContextAction::CAUSE_KEY:
// If the user interacts with the page via the keyboard, the currently
// focused element should match :focus-visible (i.e. keyboard usage may
// change whether this pseudo-class matches even if it doesn't affect
// :focus).
return true;
case InputContextAction::CAUSE_UNKNOWN:
// We render outlines if the last "known" focus method was by key or there
// was no previous known focus method, otherwise we don't.
return aWindow->UnknownFocusMethodShouldShowOutline();
case InputContextAction::CAUSE_MOUSE:
case InputContextAction::CAUSE_TOUCH:
case InputContextAction::CAUSE_LONGPRESS:
// If the user interacts with the page via a pointing device, such that
// the focus is moved to a new element which does not support user input,
// the newly focused element should not match :focus-visible.
return false;
case InputContextAction::CAUSE_UNKNOWN_CHROME:
case InputContextAction::CAUSE_UNKNOWN_DURING_KEYBOARD_INPUT:
case InputContextAction::CAUSE_UNKNOWN_DURING_NON_KEYBOARD_INPUT:
// TODO(emilio): We could return some of these though, looking at
// UserActivation. We may want to suppress focus rings for unknown /
// programatic focus if the user is interacting with the page but not
// during keyboard input, or such.
MOZ_ASSERT_UNREACHABLE(
"These don't get returned by GetFocusMoveActionCause");
break;
}
return false;
}
/* static */
void nsFocusManager::NotifyFocusStateChange(Element* aElement,
Element* aElementToFocus,
int32_t aFlags, bool aGettingFocus,
bool aShouldShowFocusRing) {
MOZ_ASSERT_IF(aElementToFocus, !aGettingFocus);
nsIContent* commonAncestor = nullptr;
if (aElementToFocus) {
commonAncestor = nsContentUtils::GetCommonFlattenedTreeAncestor(
aElement, aElementToFocus);
}
if (aGettingFocus) {
ElementState stateToAdd = ElementState::FOCUS;
if (aShouldShowFocusRing) {
stateToAdd |= ElementState::FOCUSRING;
}
aElement->AddStates(stateToAdd);
for (nsIContent* host = aElement->GetContainingShadowHost(); host;
host = host->GetContainingShadowHost()) {
host->AsElement()->AddStates(ElementState::FOCUS);
}
} else {
constexpr auto kStatesToRemove =
ElementState::FOCUS | ElementState::FOCUSRING;
aElement->RemoveStates(kStatesToRemove);
for (nsIContent* host = aElement->GetContainingShadowHost(); host;
host = host->GetContainingShadowHost()) {
host->AsElement()->RemoveStates(kStatesToRemove);
}
}
// Special case for <input type="checkbox"> and <input type="radio">.
// The other browsers cancel active state when they gets lost focus, but
// does not do it for the other elements such as <button> and <a href="...">.
// Additionally, they may be activated with <label>, but they will get focus
// at `click`, but activated at `mousedown`. Therefore, we need to cancel
// active state at moving focus.
if (RefPtr<nsPresContext> presContext =
aElement->GetPresContext(Element::PresContextFor::eForComposedDoc)) {
RefPtr<EventStateManager> esm = presContext->EventStateManager();
auto* activeInputElement =
HTMLInputElement::FromNodeOrNull(esm->GetActiveContent());
if (activeInputElement &&
(activeInputElement->ControlType() == FormControlType::InputCheckbox ||
activeInputElement->ControlType() == FormControlType::InputRadio) &&
!activeInputElement->State().HasState(ElementState::FOCUS)) {
esm->SetContentState(nullptr, ElementState::ACTIVE);
}
}
for (nsIContent* content = aElement; content && content != commonAncestor;
content = content->GetFlattenedTreeParent()) {
Element* element = Element::FromNode(content);
if (!element) {
continue;
}
if (aGettingFocus) {
if (element->State().HasState(ElementState::FOCUS_WITHIN)) {
break;
}
element->AddStates(ElementState::FOCUS_WITHIN);
} else {
element->RemoveStates(ElementState::FOCUS_WITHIN);
}
}
}
// static
void nsFocusManager::EnsureCurrentWidgetFocused(CallerType aCallerType) {
if (!mFocusedWindow || sTestMode) return;
// get the main child widget for the focused window and ensure that the
// platform knows that this widget is focused.
nsCOMPtr<nsIDocShell> docShell = mFocusedWindow->GetDocShell();
if (!docShell) {
return;
}
RefPtr<PresShell> presShell = docShell->GetPresShell();
if (!presShell) {
return;
}
nsViewManager* vm = presShell->GetViewManager();
if (!vm) {
return;
}
nsCOMPtr<nsIWidget> widget = vm->GetRootWidget();
if (!widget) {
return;
}
widget->SetFocus(nsIWidget::Raise::No, aCallerType);
}
void nsFocusManager::ActivateOrDeactivate(nsPIDOMWindowOuter* aWindow,
bool aActive) {
MOZ_ASSERT(XRE_IsParentProcess());
if (!aWindow) {
return;
}
if (BrowsingContext* bc = aWindow->GetBrowsingContext()) {
MOZ_ASSERT(bc->IsTop());
RefPtr<CanonicalBrowsingContext> chromeTop =
bc->Canonical()->TopCrossChromeBoundary();
MOZ_ASSERT(bc == chromeTop);
chromeTop->SetIsActiveBrowserWindow(aActive);
chromeTop->CallOnTopDescendants(
[aActive](CanonicalBrowsingContext* aBrowsingContext) {
aBrowsingContext->SetIsActiveBrowserWindow(aActive);
return CallState::Continue;
},
CanonicalBrowsingContext::TopDescendantKind::All);
}
if (aWindow->GetExtantDoc()) {
nsContentUtils::DispatchEventOnlyToChrome(
aWindow->GetExtantDoc(),
nsGlobalWindowInner::Cast(aWindow->GetCurrentInnerWindow()),
aActive ? u"activate"_ns : u"deactivate"_ns, CanBubble::eYes,
Cancelable::eYes, nullptr);
}
}
// Retrieves innerWindowId of the window of the last focused element to
// log a warning to the website console.
void LogWarningFullscreenWindowRaise(Element* aElement) {
nsCOMPtr<nsFrameLoaderOwner> frameLoaderOwner(do_QueryInterface(aElement));
NS_ENSURE_TRUE_VOID(frameLoaderOwner);
RefPtr<nsFrameLoader> frameLoader = frameLoaderOwner->GetFrameLoader();
NS_ENSURE_TRUE_VOID(frameLoaderOwner);
RefPtr<BrowsingContext> browsingContext = frameLoader->GetBrowsingContext();
NS_ENSURE_TRUE_VOID(browsingContext);
WindowGlobalParent* windowGlobalParent =
browsingContext->Canonical()->GetCurrentWindowGlobal();
NS_ENSURE_TRUE_VOID(windowGlobalParent);
// Log to console
nsAutoString localizedMsg;
nsTArray<nsString> params;
nsresult rv = nsContentUtils::FormatLocalizedString(
nsContentUtils::eDOM_PROPERTIES, "FullscreenExitWindowFocus", params,
localizedMsg);
NS_ENSURE_SUCCESS_VOID(rv);
Unused << nsContentUtils::ReportToConsoleByWindowID(
localizedMsg, nsIScriptError::warningFlag, "DOM"_ns,
windowGlobalParent->InnerWindowId(),
SourceLocation(windowGlobalParent->GetDocumentURI()));
}
// Ensure that when an embedded popup with a noautofocus attribute
// like a date picker is opened and focused, the parent page does not blur
static bool IsEmeddededInNoautofocusPopup(BrowsingContext& aBc) {
auto* embedder = aBc.GetEmbedderElement();
if (!embedder) {
return false;
}
nsIFrame* f = embedder->GetPrimaryFrame();
if (!f || !f->HasAnyStateBits(NS_FRAME_IN_POPUP)) {
return false;
}
nsIFrame* menuPopup =
nsLayoutUtils::GetClosestFrameOfType(f, LayoutFrameType::MenuPopup);
MOZ_ASSERT(menuPopup, "NS_FRAME_IN_POPUP lied?");
return static_cast<nsMenuPopupFrame*>(menuPopup)
->PopupElement()
.GetXULBoolAttr(nsGkAtoms::noautofocus);
}
Maybe<uint64_t> nsFocusManager::SetFocusInner(Element* aNewContent,
int32_t aFlags,
bool aFocusChanged,
bool aAdjustWidget) {
// if the element is not focusable, just return and leave the focus as is
RefPtr<Element> elementToFocus =
FlushAndCheckIfFocusable(aNewContent, aFlags);
if (!elementToFocus) {
return Nothing();
}
const RefPtr<BrowsingContext> focusedBrowsingContext =
GetFocusedBrowsingContext();
// check if the element to focus is a frame (iframe) containing a child
// document. Frames are never directly focused; instead focusing a frame
// means focus what is inside the frame. To do this, the descendant content
// within the frame is retrieved and that will be focused instead.
nsCOMPtr<nsPIDOMWindowOuter> newWindow;
nsCOMPtr<nsPIDOMWindowOuter> subWindow = GetContentWindow(elementToFocus);
if (subWindow) {
elementToFocus = GetFocusedDescendant(subWindow, eIncludeAllDescendants,
getter_AddRefs(newWindow));
// since a window is being refocused, clear aFocusChanged so that the
// caret position isn't updated.
aFocusChanged = false;
}
// unless it was set above, retrieve the window for the element to focus
if (!newWindow) {
newWindow = GetCurrentWindow(elementToFocus);
}
RefPtr<BrowsingContext> newBrowsingContext;
if (newWindow) {
newBrowsingContext = newWindow->GetBrowsingContext();
}
// if the element is already focused, just return. Note that this happens
// after the frame check above so that we compare the element that will be
// focused rather than the frame it is in.
if (!newWindow || (newBrowsingContext == GetFocusedBrowsingContext() &&
elementToFocus == mFocusedElement)) {
return Nothing();
}
MOZ_ASSERT(newBrowsingContext);
BrowsingContext* browsingContextToFocus = newBrowsingContext;
if (RefPtr<nsFrameLoaderOwner> flo = do_QueryObject(elementToFocus)) {
// Only look at pre-existing browsing contexts. If this function is
// called during reflow, calling GetBrowsingContext() could cause frame
// loader initialization at a time when it isn't safe.
if (BrowsingContext* bc = flo->GetExtantBrowsingContext()) {
// If focus is already in the subtree rooted at bc, return early
// to match the single-process focus semantics. Otherwise, we'd
// blur and immediately refocus whatever is focused.
BrowsingContext* walk = focusedBrowsingContext;
while (walk) {
if (walk == bc) {
return Nothing();
}
walk = walk->GetParent();
}
browsingContextToFocus = bc;
}
}
// don't allow focus to be placed in docshells or descendants of docshells
// that are being destroyed. Also, ensure that the page hasn't been
// unloaded. The prevents content from being refocused during an unload event.
nsCOMPtr<nsIDocShell> newDocShell = newWindow->GetDocShell();
nsCOMPtr<nsIDocShell> docShell = newDocShell;
while (docShell) {
bool inUnload;
docShell->GetIsInUnload(&inUnload);
if (inUnload) {
return Nothing();
}
bool beingDestroyed;
docShell->IsBeingDestroyed(&beingDestroyed);
if (beingDestroyed) {
return Nothing();
}
BrowsingContext* bc = docShell->GetBrowsingContext();
nsCOMPtr<nsIDocShellTreeItem> parentDsti;
docShell->GetInProcessParent(getter_AddRefs(parentDsti));
docShell = do_QueryInterface(parentDsti);
if (!docShell && !XRE_IsParentProcess()) {
// We don't have an in-process parent, but let's see if we have
// an in-process ancestor or if an out-of-process ancestor
// is discarded.
do {
bc = bc->GetParent();
if (bc && bc->IsDiscarded()) {
return Nothing();
}
} while (bc && !bc->IsInProcess());
if (bc) {
docShell = bc->GetDocShell();
} else {
docShell = nullptr;
}
}
}
bool focusMovesToDifferentBC =
(focusedBrowsingContext != browsingContextToFocus);
if (focusedBrowsingContext && focusMovesToDifferentBC &&
nsContentUtils::IsHandlingKeyBoardEvent() &&
!nsContentUtils::LegacyIsCallerChromeOrNativeCode()) {
MOZ_ASSERT(browsingContextToFocus,
"BrowsingContext to focus should be non-null.");
nsIPrincipal* focusedPrincipal = nullptr;
nsIPrincipal* newPrincipal = nullptr;
if (XRE_IsParentProcess()) {
if (WindowGlobalParent* focusedWindowGlobalParent =
focusedBrowsingContext->Canonical()->GetCurrentWindowGlobal()) {
focusedPrincipal = focusedWindowGlobalParent->DocumentPrincipal();
}
if (WindowGlobalParent* newWindowGlobalParent =
browsingContextToFocus->Canonical()->GetCurrentWindowGlobal()) {
newPrincipal = newWindowGlobalParent->DocumentPrincipal();
}
} else if (focusedBrowsingContext->IsInProcess() &&
browsingContextToFocus->IsInProcess()) {
nsCOMPtr<nsIScriptObjectPrincipal> focused =
do_QueryInterface(focusedBrowsingContext->GetDOMWindow());
nsCOMPtr<nsIScriptObjectPrincipal> newFocus =
do_QueryInterface(browsingContextToFocus->GetDOMWindow());
MOZ_ASSERT(focused && newFocus,
"BrowsingContext should always have a window here.");
focusedPrincipal = focused->GetPrincipal();
newPrincipal = newFocus->GetPrincipal();
}
if (!focusedPrincipal || !newPrincipal) {
return Nothing();
}
if (!focusedPrincipal->Subsumes(newPrincipal)) {
NS_WARNING("Not allowed to focus the new window!");
return Nothing();
}
}
// to check if the new element is in the active window, compare the
// new root docshell for the new element with the active window's docshell.
RefPtr<BrowsingContext> newRootBrowsingContext = nullptr;
bool isElementInActiveWindow = false;
if (XRE_IsParentProcess()) {
nsCOMPtr<nsPIDOMWindowOuter> newRootWindow = nullptr;
nsCOMPtr<nsIDocShellTreeItem> dsti = newWindow->GetDocShell();
if (dsti) {
nsCOMPtr<nsIDocShellTreeItem> root;
dsti->GetInProcessRootTreeItem(getter_AddRefs(root));
newRootWindow = root ? root->GetWindow() : nullptr;
isElementInActiveWindow =
(mActiveWindow && newRootWindow == mActiveWindow);
}
if (newRootWindow) {
newRootBrowsingContext = newRootWindow->GetBrowsingContext();
}
} else {
// XXX This is wrong for `<iframe mozbrowser>` and for XUL
// `<browser remote="true">`. See:
// https://searchfox.org/mozilla-central/rev/8a63fc190b39ed6951abb4aef4a56487a43962bc/dom/base/nsFrameLoader.cpp#229-232
newRootBrowsingContext = newBrowsingContext->Top();
// to check if the new element is in the active window, compare the
// new root docshell for the new element with the active window's docshell.
isElementInActiveWindow =
(GetActiveBrowsingContext() == newRootBrowsingContext);
}
// Exit fullscreen if a website focuses another window
if (StaticPrefs::full_screen_api_exit_on_windowRaise() &&
!isElementInActiveWindow && (aFlags & FLAG_RAISE)) {
if (XRE_IsParentProcess()) {
if (Document* doc = mActiveWindow ? mActiveWindow->GetDoc() : nullptr) {
Document::ClearPendingFullscreenRequests(doc);
if (doc->GetFullscreenElement()) {
LogWarningFullscreenWindowRaise(mFocusedElement);
Document::AsyncExitFullscreen(doc);
}
}
} else {
BrowsingContext* activeBrowsingContext = GetActiveBrowsingContext();
if (activeBrowsingContext) {
nsIDocShell* shell = activeBrowsingContext->GetDocShell();
if (shell) {
if (Document* doc = shell->GetDocument()) {
Document::ClearPendingFullscreenRequests(doc);
if (doc->GetFullscreenElement()) {
Document::AsyncExitFullscreen(doc);
}
}
} else {
mozilla::dom::ContentChild* contentChild =
mozilla::dom::ContentChild::GetSingleton();
MOZ_ASSERT(contentChild);
contentChild->SendMaybeExitFullscreen(activeBrowsingContext);
}
}
}
}
// if the FLAG_NOSWITCHFRAME flag is used, only allow the focus to be
// shifted away from the current element if the new shell to focus is
// the same or an ancestor shell of the currently focused shell.
bool allowFrameSwitch = !(aFlags & FLAG_NOSWITCHFRAME) ||
IsSameOrAncestor(newWindow, focusedBrowsingContext);
// if the element is in the active window, frame switching is allowed and
// the content is in a visible window, fire blur and focus events.
bool sendFocusEvent =
isElementInActiveWindow && allowFrameSwitch && IsWindowVisible(newWindow);
// Don't allow to steal the focus from chrome nodes if the caller cannot
// access them.
if (sendFocusEvent && mFocusedElement &&
mFocusedElement->OwnerDoc() != aNewContent->OwnerDoc() &&
mFocusedElement->NodePrincipal()->IsSystemPrincipal() &&
!nsContentUtils::LegacyIsCallerNativeCode() &&
!nsContentUtils::CanCallerAccess(mFocusedElement)) {
sendFocusEvent = false;
}
LOGCONTENT("Shift Focus: %s", elementToFocus.get());
LOGFOCUS((" Flags: %x Current Window: %p New Window: %p Current Element: %p",
aFlags, mFocusedWindow.get(), newWindow.get(),
mFocusedElement.get()));
const uint64_t actionId = GenerateFocusActionId();
LOGFOCUS(
(" In Active Window: %d Moves to different BrowsingContext: %d "
"SendFocus: %d actionid: %" PRIu64,
isElementInActiveWindow, focusMovesToDifferentBC, sendFocusEvent,
actionId));
if (sendFocusEvent) {
Maybe<BlurredElementInfo> blurredInfo;
if (mFocusedElement) {
blurredInfo.emplace(*mFocusedElement);
}
// return if blurring fails or the focus changes during the blur
if (focusedBrowsingContext) {
// find the common ancestor of the currently focused window and the new
// window. The ancestor will need to have its currently focused node
// cleared once the document has been blurred. Otherwise, we'll be in a
// state where a document is blurred yet the chain of windows above it
// still points to that document.
// For instance, in the following frame tree:
// A
// B C
// D
// D is focused and we want to focus C. Once D has been blurred, we need
// to clear out the focus in A, otherwise A would still maintain that B
// was focused, and B that D was focused.
RefPtr<BrowsingContext> commonAncestor =
focusMovesToDifferentBC
? GetCommonAncestor(newWindow, focusedBrowsingContext)
: nullptr;
const bool needToClearFocusedElement = [&] {
if (focusedBrowsingContext->IsChrome()) {
// Always reset focused element if focus is currently in chrome
// window, unless we're moving focus to a popup.
return !IsEmeddededInNoautofocusPopup(*browsingContextToFocus);
}
if (focusedBrowsingContext->Top() != browsingContextToFocus->Top()) {
// Only reset focused element if focus moves within the same top-level
// content window.
return false;
}
// XXX for the case that we try to focus an
// already-focused-remote-frame, we would still send blur and focus
// IPC to it, but they will not generate blur or focus event, we don't
// want to reset activeElement on the remote frame.
return focusMovesToDifferentBC || focusedBrowsingContext->IsInProcess();
}();
const bool remainActive =
focusMovesToDifferentBC &&
IsEmeddededInNoautofocusPopup(*browsingContextToFocus);
// TODO: MOZ_KnownLive is required due to bug 1770680
if (!Blur(MOZ_KnownLive(needToClearFocusedElement
? focusedBrowsingContext.get()
: nullptr),
commonAncestor, focusMovesToDifferentBC, aAdjustWidget,
remainActive, actionId, elementToFocus)) {
return Some(actionId);
}
}
Focus(newWindow, elementToFocus, aFlags, focusMovesToDifferentBC,
aFocusChanged, false, aAdjustWidget, actionId, blurredInfo);
} else {
// otherwise, for inactive windows and when the caller cannot steal the
// focus, update the node in the window, and raise the window if desired.
if (allowFrameSwitch) {
AdjustWindowFocus(newBrowsingContext, true, IsWindowVisible(newWindow),
actionId, false /* aShouldClearAncestorFocus */,
nullptr /* aAncestorBrowsingContextToFocus */);
}
// set the focus node and method as needed
uint32_t focusMethod =
aFocusChanged ? aFlags & METHODANDRING_MASK
: newWindow->GetFocusMethod() |
(aFlags & (FLAG_SHOWRING | FLAG_NOSHOWRING));
newWindow->SetFocusedElement(elementToFocus, focusMethod);
if (aFocusChanged) {
if (nsCOMPtr<nsIDocShell> docShell = newWindow->GetDocShell()) {
RefPtr<PresShell> presShell = docShell->GetPresShell();
if (presShell && presShell->DidInitialize()) {
ScrollIntoView(presShell, elementToFocus, aFlags);
}
}
}
// update the commands even when inactive so that the attributes for that
// window are up to date.
if (allowFrameSwitch) {
newWindow->UpdateCommands(u"focus"_ns);
}
if (aFlags & FLAG_RAISE) {
if (newRootBrowsingContext) {
if (XRE_IsParentProcess() || newRootBrowsingContext->IsInProcess()) {
nsCOMPtr<nsPIDOMWindowOuter> outerWindow =
newRootBrowsingContext->GetDOMWindow();
RaiseWindow(outerWindow,
aFlags & FLAG_NONSYSTEMCALLER ? CallerType::NonSystem
: CallerType::System,
actionId);
} else {
mozilla::dom::ContentChild* contentChild =
mozilla::dom::ContentChild::GetSingleton();
MOZ_ASSERT(contentChild);
contentChild->SendRaiseWindow(newRootBrowsingContext,
aFlags & FLAG_NONSYSTEMCALLER
? CallerType::NonSystem
: CallerType::System,
actionId);
}
}
}
}
return Some(actionId);
}
static BrowsingContext* GetParentIgnoreChromeBoundary(BrowsingContext* aBC) {
// Chrome BrowsingContexts are only available in the parent process, so if
// we're in a content process, we only worry about the context tree.
if (XRE_IsParentProcess()) {
return aBC->Canonical()->GetParentCrossChromeBoundary();
}
return aBC->GetParent();
}
bool nsFocusManager::IsSameOrAncestor(BrowsingContext* aPossibleAncestor,
BrowsingContext* aContext) const {
if (!aPossibleAncestor) {
return false;
}
for (BrowsingContext* bc = aContext; bc;
bc = GetParentIgnoreChromeBoundary(bc)) {
if (bc == aPossibleAncestor) {
return true;
}
}
return false;
}
bool nsFocusManager::IsSameOrAncestor(nsPIDOMWindowOuter* aPossibleAncestor,
nsPIDOMWindowOuter* aWindow) const {
if (aWindow && aPossibleAncestor) {
return IsSameOrAncestor(aPossibleAncestor->GetBrowsingContext(),
aWindow->GetBrowsingContext());
}
return false;
}
bool nsFocusManager::IsSameOrAncestor(nsPIDOMWindowOuter* aPossibleAncestor,
BrowsingContext* aContext) const {
if (aPossibleAncestor) {
return IsSameOrAncestor(aPossibleAncestor->GetBrowsingContext(), aContext);
}
return false;
}
bool nsFocusManager::IsSameOrAncestor(BrowsingContext* aPossibleAncestor,
nsPIDOMWindowOuter* aWindow) const {
if (aWindow) {
return IsSameOrAncestor(aPossibleAncestor, aWindow->GetBrowsingContext());
}
return false;
}
mozilla::dom::BrowsingContext* nsFocusManager::GetCommonAncestor(
nsPIDOMWindowOuter* aWindow, mozilla::dom::BrowsingContext* aContext) {
NS_ENSURE_TRUE(aWindow && aContext, nullptr);
if (XRE_IsParentProcess()) {
nsCOMPtr<nsIDocShellTreeItem> dsti1 = aWindow->GetDocShell();
NS_ENSURE_TRUE(dsti1, nullptr);
nsCOMPtr<nsIDocShellTreeItem> dsti2 = aContext->GetDocShell();
NS_ENSURE_TRUE(dsti2, nullptr);
AutoTArray<nsIDocShellTreeItem*, 30> parents1, parents2;
do {
parents1.AppendElement(dsti1);
nsCOMPtr<nsIDocShellTreeItem> parentDsti1;
dsti1->GetInProcessParent(getter_AddRefs(parentDsti1));
dsti1.swap(parentDsti1);
} while (dsti1);
do {
parents2.AppendElement(dsti2);
nsCOMPtr<nsIDocShellTreeItem> parentDsti2;
dsti2->GetInProcessParent(getter_AddRefs(parentDsti2));
dsti2.swap(parentDsti2);
} while (dsti2);
uint32_t pos1 = parents1.Length();
uint32_t pos2 = parents2.Length();
nsIDocShellTreeItem* parent = nullptr;
uint32_t len;
for (len = std::min(pos1, pos2); len > 0; --len) {
nsIDocShellTreeItem* child1 = parents1.ElementAt(--pos1);
nsIDocShellTreeItem* child2 = parents2.ElementAt(--pos2);
if (child1 != child2) {
break;
}
parent = child1;
}
return parent ? parent->GetBrowsingContext() : nullptr;
}
BrowsingContext* bc1 = aWindow->GetBrowsingContext();
NS_ENSURE_TRUE(bc1, nullptr);
BrowsingContext* bc2 = aContext;
AutoTArray<BrowsingContext*, 30> parents1, parents2;
do {
parents1.AppendElement(bc1);
bc1 = bc1->GetParent();
} while (bc1);
do {
parents2.AppendElement(bc2);
bc2 = bc2->GetParent();
} while (bc2);
uint32_t pos1 = parents1.Length();
uint32_t pos2 = parents2.Length();
BrowsingContext* parent = nullptr;
uint32_t len;
for (len = std::min(pos1, pos2); len > 0; --len) {
BrowsingContext* child1 = parents1.ElementAt(--pos1);
BrowsingContext* child2 = parents2.ElementAt(--pos2);
if (child1 != child2) {
break;
}
parent = child1;
}
return parent;
}
bool nsFocusManager::AdjustInProcessWindowFocus(
BrowsingContext* aBrowsingContext, bool aCheckPermission, bool aIsVisible,
uint64_t aActionId, bool aShouldClearAncestorFocus,
BrowsingContext* aAncestorBrowsingContextToFocus) {
MOZ_ASSERT_IF(aAncestorBrowsingContextToFocus, aShouldClearAncestorFocus);
if (ActionIdComparableAndLower(aActionId,
mActionIdForFocusedBrowsingContextInContent)) {
LOGFOCUS(
("Ignored an attempt to adjust an in-process BrowsingContext [%p] as "
"focused from another process due to stale action id %" PRIu64 ".",
aBrowsingContext, aActionId));
return false;
}
BrowsingContext* bc = aBrowsingContext;
bool needToNotifyOtherProcess = false;
while (bc) {
// get the containing <iframe> or equivalent element so that it can be
// focused below.
nsCOMPtr<Element> frameElement = bc->GetEmbedderElement();
BrowsingContext* parent = bc->GetParent();
if (!parent && XRE_IsParentProcess()) {
CanonicalBrowsingContext* canonical = bc->Canonical();
RefPtr<WindowGlobalParent> embedder =
canonical->GetEmbedderWindowGlobal();
if (embedder) {
parent = embedder->BrowsingContext();
}
}
bc = parent;
if (!bc) {
break;
}
if (!frameElement && XRE_IsContentProcess()) {
needToNotifyOtherProcess = true;
continue;
}
nsCOMPtr<nsPIDOMWindowOuter> window = bc->GetDOMWindow();
MOZ_ASSERT(window);
// if the parent window is visible but the original window was not, then we
// have likely moved up and out from a hidden tab to the browser window, or
// a similar such arrangement. Stop adjusting the current nodes.
if (IsWindowVisible(window) != aIsVisible) {
break;
}
// When aCheckPermission is true, we should check whether the caller can
// access the window or not. If it cannot access, we should stop the
// adjusting.
if (aCheckPermission && !nsContentUtils::LegacyIsCallerNativeCode() &&
!nsContentUtils::CanCallerAccess(window->GetCurrentInnerWindow())) {
break;
}
if (aShouldClearAncestorFocus) {
// This is the BrowsingContext that receives the focus, no need to clear
// its focused element and the rest of the ancestors.
if (window->GetBrowsingContext() == aAncestorBrowsingContextToFocus) {
break;
}
window->SetFocusedElement(nullptr);
continue;
}
if (frameElement != window->GetFocusedElement()) {
window->SetFocusedElement(frameElement);
RefPtr<nsFrameLoaderOwner> loaderOwner = do_QueryObject(frameElement);
MOZ_ASSERT(loaderOwner);
RefPtr<nsFrameLoader> loader = loaderOwner->GetFrameLoader();
if (loader && loader->IsRemoteFrame() &&
GetFocusedBrowsingContext() == bc) {
Blur(nullptr, nullptr, true, true, false, aActionId);
}
}
}
return needToNotifyOtherProcess;
}
void nsFocusManager::AdjustWindowFocus(
BrowsingContext* aBrowsingContext, bool aCheckPermission, bool aIsVisible,
uint64_t aActionId, bool aShouldClearAncestorFocus,
BrowsingContext* aAncestorBrowsingContextToFocus) {
MOZ_ASSERT_IF(aAncestorBrowsingContextToFocus, aShouldClearAncestorFocus);
if (AdjustInProcessWindowFocus(aBrowsingContext, aCheckPermission, aIsVisible,
aActionId, aShouldClearAncestorFocus,
aAncestorBrowsingContextToFocus)) {
// Some ancestors of aBrowsingContext isn't in this process, so notify other
// processes to adjust their focused element.
mozilla::dom::ContentChild* contentChild =
mozilla::dom::ContentChild::GetSingleton();
MOZ_ASSERT(contentChild);
contentChild->SendAdjustWindowFocus(aBrowsingContext, aIsVisible, aActionId,
aShouldClearAncestorFocus,
aAncestorBrowsingContextToFocus);
}
}
bool nsFocusManager::IsWindowVisible(nsPIDOMWindowOuter* aWindow) {
if (!aWindow || nsGlobalWindowOuter::Cast(aWindow)->IsFrozen()) {
return false;
}
// Check if the inner window is frozen as well. This can happen when a focus
// change occurs while restoring a previous page.
auto* innerWindow =
nsGlobalWindowInner::Cast(aWindow->GetCurrentInnerWindow());
if (!innerWindow || innerWindow->IsFrozen()) {
return false;
}
nsCOMPtr<nsIDocShell> docShell = aWindow->GetDocShell();
nsCOMPtr<nsIBaseWindow> baseWin(do_QueryInterface(docShell));
if (!baseWin) {
return false;
}
bool visible = false;
baseWin->GetVisibility(&visible);
return visible;
}
bool nsFocusManager::IsNonFocusableRoot(nsIContent* aContent) {
MOZ_ASSERT(aContent, "aContent must not be NULL");
MOZ_ASSERT(aContent->IsInComposedDoc(), "aContent must be in a document");
// If the uncomposed document of aContent is in designMode, the root element
// is not focusable.
// NOTE: Most elements whose uncomposed document is in design mode are not
// focusable, just the document is focusable. However, if it's in a
// shadow tree, it may be focus able even if the shadow host is in
// design mode.
// Also, if aContent is not editable and it's not in designMode, it's not
// focusable.
// And in userfocusignored context nothing is focusable.
Document* doc = aContent->GetComposedDoc();
NS_ASSERTION(doc, "aContent must have current document");
return aContent == doc->GetRootElement() &&
(aContent->IsInDesignMode() || !aContent->IsEditable());
}
Element* nsFocusManager::FlushAndCheckIfFocusable(Element* aElement,
uint32_t aFlags) {
if (!aElement) {
return nullptr;
}
nsCOMPtr<Document> doc = aElement->GetComposedDoc();
// can't focus elements that are not in documents
if (!doc) {
LOGCONTENT("Cannot focus %s because content not in document", aElement)
return nullptr;
}
// Make sure that our frames are up to date while ensuring the presshell is
// also initialized in case we come from a script calling focus() early.
mEventHandlingNeedsFlush = false;
doc->FlushPendingNotifications(FlushType::EnsurePresShellInitAndFrames);
PresShell* presShell = doc->GetPresShell();
if (!presShell) {
return nullptr;
}
// If this is an iframe that doesn't have an in-process subdocument, it is
// either an OOP iframe or an in-process iframe without lazy about:blank
// creation having taken place. In the OOP case, iframe is always focusable.
// In the in-process case, create the initial about:blank for in-process
// BrowsingContexts in order to have the `GetSubDocumentFor` call after this
// block return something.
//
// TODO(emilio): This block can probably go after bug 543435 lands.
if (RefPtr<nsFrameLoaderOwner> flo = do_QueryObject(aElement)) {
if (!aElement->IsXULElement()) {
// Only look at pre-existing browsing contexts. If this function is
// called during reflow, calling GetBrowsingContext() could cause frame
// loader initialization at a time when it isn't safe.
if (BrowsingContext* bc = flo->GetExtantBrowsingContext()) {
// This call may create a documentViewer-created about:blank.
// That's intentional, so we can move focus there.
Unused << bc->GetDocument();
}
}
}
return GetTheFocusableArea(aElement, aFlags);
}
bool nsFocusManager::Blur(BrowsingContext* aBrowsingContextToClear,
BrowsingContext* aAncestorBrowsingContextToFocus,
bool aIsLeavingDocument, bool aAdjustWidget,
bool aRemainActive, uint64_t aActionId,
Element* aElementToFocus) {
if (XRE_IsParentProcess()) {
return BlurImpl(aBrowsingContextToClear, aAncestorBrowsingContextToFocus,
aIsLeavingDocument, aAdjustWidget, aRemainActive,
aElementToFocus, aActionId);
}
mozilla::dom::ContentChild* contentChild =
mozilla::dom::ContentChild::GetSingleton();
MOZ_ASSERT(contentChild);
bool windowToClearHandled = false;
bool ancestorWindowToFocusHandled = false;
RefPtr<BrowsingContext> focusedBrowsingContext = GetFocusedBrowsingContext();
if (focusedBrowsingContext && focusedBrowsingContext->IsDiscarded()) {
focusedBrowsingContext = nullptr;
}
if (!focusedBrowsingContext) {
mFocusedElement = nullptr;
return true;
}
if (aBrowsingContextToClear && aBrowsingContextToClear->IsDiscarded()) {
aBrowsingContextToClear = nullptr;
}
if (aAncestorBrowsingContextToFocus &&
aAncestorBrowsingContextToFocus->IsDiscarded()) {
aAncestorBrowsingContextToFocus = nullptr;
}
// XXX should more early returns from BlurImpl be hoisted here to avoid
// processing aBrowsingContextToClear and aAncestorBrowsingContextToFocus in
// other processes when BlurImpl returns early in this process? Or should the
// IPC messages for those be sent by BlurImpl itself, in which case they could
// arrive late?
if (focusedBrowsingContext->IsInProcess()) {
if (aBrowsingContextToClear && !aBrowsingContextToClear->IsInProcess()) {
MOZ_RELEASE_ASSERT(!(aAncestorBrowsingContextToFocus &&
!aAncestorBrowsingContextToFocus->IsInProcess()),
"Both aBrowsingContextToClear and "
"aAncestorBrowsingContextToFocus are "
"out-of-process.");
contentChild->SendSetFocusedElement(aBrowsingContextToClear, false);
}
if (aAncestorBrowsingContextToFocus &&
!aAncestorBrowsingContextToFocus->IsInProcess()) {
contentChild->SendSetFocusedElement(aAncestorBrowsingContextToFocus,
true);
}
return BlurImpl(aBrowsingContextToClear, aAncestorBrowsingContextToFocus,
aIsLeavingDocument, aAdjustWidget, aRemainActive,
aElementToFocus, aActionId);
}
if (aBrowsingContextToClear && aBrowsingContextToClear->IsInProcess()) {
nsPIDOMWindowOuter* windowToClear = aBrowsingContextToClear->GetDOMWindow();
MOZ_ASSERT(windowToClear);
windowToClear->SetFocusedElement(nullptr);
windowToClearHandled = true;
}
if (aAncestorBrowsingContextToFocus &&
aAncestorBrowsingContextToFocus->IsInProcess()) {
nsPIDOMWindowOuter* ancestorWindowToFocus =
aAncestorBrowsingContextToFocus->GetDOMWindow();
MOZ_ASSERT(ancestorWindowToFocus);
ancestorWindowToFocus->SetFocusedElement(nullptr, 0, true);
ancestorWindowToFocusHandled = true;
}
// The expectation is that the blurring would eventually result in an IPC
// message doing this anyway, but this doesn't happen if the focus is in OOP
// iframe which won't try to bounce an IPC message to its parent frame.
SetFocusedWindowInternal(nullptr, aActionId);
contentChild->SendBlurToParent(
focusedBrowsingContext, aBrowsingContextToClear,
aAncestorBrowsingContextToFocus, aIsLeavingDocument, aAdjustWidget,
windowToClearHandled, ancestorWindowToFocusHandled, aActionId);
return true;
}
void nsFocusManager::BlurFromOtherProcess(
mozilla::dom::BrowsingContext* aFocusedBrowsingContext,
mozilla::dom::BrowsingContext* aBrowsingContextToClear,
mozilla::dom::BrowsingContext* aAncestorBrowsingContextToFocus,
bool aIsLeavingDocument, bool aAdjustWidget, uint64_t aActionId) {
if (aFocusedBrowsingContext != GetFocusedBrowsingContext()) {
return;
}
BlurImpl(aBrowsingContextToClear, aAncestorBrowsingContextToFocus,
aIsLeavingDocument, aAdjustWidget, /* aRemainActive = */ false,
nullptr, aActionId);
}
bool nsFocusManager::BlurImpl(BrowsingContext* aBrowsingContextToClear,
BrowsingContext* aAncestorBrowsingContextToFocus,
bool aIsLeavingDocument, bool aAdjustWidget,
bool aRemainActive, Element* aElementToFocus,
uint64_t aActionId) {
LOGFOCUS(("<<Blur begin actionid: %" PRIu64 ">>", aActionId));
// hold a reference to the focused content, which may be null
RefPtr<Element> element = mFocusedElement;
if (element) {
if (!element->IsInComposedDoc()) {
mFocusedElement = nullptr;
return true;
}
}
RefPtr<BrowsingContext> focusedBrowsingContext = GetFocusedBrowsingContext();
// hold a reference to the focused window
nsCOMPtr<nsPIDOMWindowOuter> window;
if (focusedBrowsingContext) {
window = focusedBrowsingContext->GetDOMWindow();
}
if (!window) {
mFocusedElement = nullptr;
return true;
}
nsCOMPtr<nsIDocShell> docShell = window->GetDocShell();
if (!docShell) {
if (XRE_IsContentProcess() &&
ActionIdComparableAndLower(
aActionId, mActionIdForFocusedBrowsingContextInContent)) {
// Unclear if this ever happens.
LOGFOCUS(
("Ignored an attempt to null out focused BrowsingContext when "
"docShell is null due to a stale action id %" PRIu64 ".",
aActionId));
return true;
}
mFocusedWindow = nullptr;
// Setting focused BrowsingContext to nullptr to avoid leaking in print
// preview.
SetFocusedBrowsingContext(nullptr, aActionId);
mFocusedElement = nullptr;
return true;
}
// Keep a ref to presShell since dispatching the DOM event may cause
// the document to be destroyed.
RefPtr<PresShell> presShell = docShell->GetPresShell();
if (!presShell) {
if (XRE_IsContentProcess() &&
ActionIdComparableAndLower(
aActionId, mActionIdForFocusedBrowsingContextInContent)) {
// Unclear if this ever happens.
LOGFOCUS(
("Ignored an attempt to null out focused BrowsingContext when "
"presShell is null due to a stale action id %" PRIu64 ".",
aActionId));
return true;
}
mFocusedElement = nullptr;
mFocusedWindow = nullptr;
// Setting focused BrowsingContext to nullptr to avoid leaking in print
// preview.
SetFocusedBrowsingContext(nullptr, aActionId);
return true;
}
const RefPtr<nsPresContext> focusedPresContext =
GetActiveBrowsingContext() ? presShell->GetPresContext() : nullptr;
IMEStateManager::OnChangeFocus(focusedPresContext, nullptr,
GetFocusMoveActionCause(0));
// now adjust the actual focus, by clearing the fields in the focus manager
// and in the window.
mFocusedElement = nullptr;
if (aBrowsingContextToClear) {
nsPIDOMWindowOuter* windowToClear = aBrowsingContextToClear->GetDOMWindow();
if (windowToClear) {
windowToClear->SetFocusedElement(nullptr);
}
}
LOGCONTENT("Element %s has been blurred", element.get());
// Don't fire blur event on the root content which isn't editable.
bool sendBlurEvent =
element && element->IsInComposedDoc() && !IsNonFocusableRoot(element);
if (element) {
if (sendBlurEvent) {
NotifyFocusStateChange(element, aElementToFocus, 0, false, false);
}
if (!aRemainActive) {
bool windowBeingLowered = !aBrowsingContextToClear &&
!aAncestorBrowsingContextToFocus &&
aIsLeavingDocument && aAdjustWidget;
// If the object being blurred is a remote browser, deactivate remote
// content
if (BrowserParent* remote = BrowserParent::GetFrom(element)) {
MOZ_ASSERT(XRE_IsParentProcess());
// Let's deactivate all remote browsers.
BrowsingContext* topLevelBrowsingContext = remote->GetBrowsingContext();
topLevelBrowsingContext->PreOrderWalk([&](BrowsingContext* aContext) {
if (WindowGlobalParent* windowGlobalParent =
aContext->Canonical()->GetCurrentWindowGlobal()) {
if (RefPtr<BrowserParent> browserParent =
windowGlobalParent->GetBrowserParent()) {
browserParent->Deactivate(windowBeingLowered, aActionId);
LOGFOCUS(
("%s remote browser deactivated %p, %d, actionid: %" PRIu64,
aContext == topLevelBrowsingContext ? "Top-level"
: "OOP iframe",
browserParent.get(), windowBeingLowered, aActionId));
}
}
});
}
// Same as above but for out-of-process iframes
if (BrowserBridgeChild* bbc = BrowserBridgeChild::GetFrom(element)) {
bbc->Deactivate(windowBeingLowered, aActionId);
LOGFOCUS(
("Out-of-process iframe deactivated %p, %d, actionid: %" PRIu64,
bbc, windowBeingLowered, aActionId));
}
}
}
bool result = true;
if (sendBlurEvent) {
// if there is an active window, update commands. If there isn't an active
// window, then this was a blur caused by the active window being lowered,
// so there is no need to update the commands
if (GetActiveBrowsingContext()) {
window->UpdateCommands(u"focus"_ns);
}
SendFocusOrBlurEvent(eBlur, presShell, element->GetComposedDoc(), element,
false, false, aElementToFocus);
}
// if we are leaving the document or the window was lowered, make the caret
// invisible.
if (aIsLeavingDocument || !GetActiveBrowsingContext()) {
SetCaretVisible(presShell, false, nullptr);
}
RefPtr<AccessibleCaretEventHub> eventHub =
presShell->GetAccessibleCaretEventHub();
if (eventHub) {
eventHub->NotifyBlur(aIsLeavingDocument || !GetActiveBrowsingContext());
}
// at this point, it is expected that this window will be still be
// focused, but the focused element will be null, as it was cleared before
// the event. If this isn't the case, then something else was focused during
// the blur event above and we should just return. However, if
// aIsLeavingDocument is set, a new document is desired, so make sure to
// blur the document and window.
if (GetFocusedBrowsingContext() != window->GetBrowsingContext() ||
(mFocusedElement != nullptr && !aIsLeavingDocument)) {
result = false;
} else if (aIsLeavingDocument) {
window->TakeFocus(false, 0);
// clear the focus so that the ancestor frame hierarchy is in the correct
// state. Pass true because aAncestorBrowsingContextToFocus is thought to be
// focused at this point.
if (aAncestorBrowsingContextToFocus) {
nsPIDOMWindowOuter* ancestorWindowToFocus =
aAncestorBrowsingContextToFocus->GetDOMWindow();
if (ancestorWindowToFocus) {
ancestorWindowToFocus->SetFocusedElement(nullptr, 0, true);
}
// When the focus of aBrowsingContextToClear is cleared, it should
// also clear its ancestors's focus because ancestors should no longer
// be considered aBrowsingContextToClear is focused.
//
// We don't need to do this when aBrowsingContextToClear and
// aAncestorBrowsingContextToFocus is equal because ancestors don't
// care about this.
if (aBrowsingContextToClear &&
aBrowsingContextToClear != aAncestorBrowsingContextToFocus) {
AdjustWindowFocus(
aBrowsingContextToClear, false,
IsWindowVisible(aBrowsingContextToClear->GetDOMWindow()), aActionId,
true /* aShouldClearAncestorFocus */,
aAncestorBrowsingContextToFocus);
}
}
SetFocusedWindowInternal(nullptr, aActionId);
mFocusedElement = nullptr;
RefPtr<Document> doc = window->GetExtantDoc();
if (doc) {
SendFocusOrBlurEvent(eBlur, presShell, doc, doc, false);
}
if (!GetFocusedBrowsingContext()) {
nsCOMPtr<nsPIDOMWindowInner> innerWindow =
window->GetCurrentInnerWindow();
// MOZ_KnownLive due to bug 1506441
SendFocusOrBlurEvent(
eBlur, presShell, doc,
MOZ_KnownLive(nsGlobalWindowInner::Cast(innerWindow)), false);
}
// check if a different window was focused
result = (!GetFocusedBrowsingContext() && GetActiveBrowsingContext());
} else if (GetActiveBrowsingContext()) {
// Otherwise, the blur of the element without blurring the document
// occurred normally. Call UpdateCaret to redisplay the caret at the right
// location within the document. This is needed to ensure that the caret
// used for caret browsing is made visible again when an input field is
// blurred.
UpdateCaret(false, true, nullptr);
}
return result;
}
void nsFocusManager::ActivateRemoteFrameIfNeeded(Element& aElement,
uint64_t aActionId) {
if (BrowserParent* remote = BrowserParent::GetFrom(&aElement)) {
remote->Activate(aActionId);
LOGFOCUS(
("Remote browser activated %p, actionid: %" PRIu64, remote, aActionId));
}
// Same as above but for out-of-process iframes
if (BrowserBridgeChild* bbc = BrowserBridgeChild::GetFrom(&aElement)) {
bbc->Activate(aActionId);
LOGFOCUS(("Out-of-process iframe activated %p, actionid: %" PRIu64, bbc,
aActionId));
}
}
void nsFocusManager::FixUpFocusBeforeFrameLoaderChange(Element& aElement,
BrowsingContext* aBc) {
// If focus is out of process we don't need to do anything.
if (!mFocusedWindow || !aBc) {
return;
}
auto* docShell = aBc->GetDocShell();
if (!docShell) {
return;
}
if (!IsSameOrAncestor(docShell->GetWindow(), mFocusedWindow)) {
// The window about to go away is not focused.
return;
}
LOGFOCUS(("About to swap frame loaders on focused in-process window %p",
mFocusedWindow.get()));
mFocusedWindow = GetCurrentWindow(&aElement);
mFocusedElement = &aElement;
}
void nsFocusManager::FixUpFocusAfterFrameLoaderChange(Element& aElement) {
MOZ_ASSERT(mFocusedElement == &aElement);
MOZ_ASSERT(nsContentUtils::IsSafeToRunScript());
if (GetContentWindow(&aElement)) {
// This will focus the content window.
SetFocusInner(&aElement, 0, false, false);
} else {
// If we're remote, activate the frame.
ActivateRemoteFrameIfNeeded(aElement, GenerateFocusActionId());
}
RefPtr<nsPresContext> presContext = aElement.OwnerDoc()->GetPresContext();
IMEStateManager::OnChangeFocus(presContext, &aElement,
InputContextAction::CAUSE_UNKNOWN);
}
void nsFocusManager::Focus(
nsPIDOMWindowOuter* aWindow, Element* aElement, uint32_t aFlags,
bool aIsNewDocument, bool aFocusChanged, bool aWindowRaised,
bool aAdjustWidget, uint64_t aActionId,
const Maybe<BlurredElementInfo>& aBlurredElementInfo) {
LOGFOCUS(("<<Focus begin actionid: %" PRIu64 ">>", aActionId));
if (!aWindow) {
return;
}
// Keep a reference to the presShell since dispatching the DOM event may
// cause the document to be destroyed.
nsCOMPtr<nsIDocShell> docShell = aWindow->GetDocShell();
if (!docShell) {
return;
}
const RefPtr<PresShell> presShell = docShell->GetPresShell();
if (!presShell) {
return;
}
bool focusInOtherContentProcess = false;
// Keep mochitest-browser-chrome harness happy by ignoring
// focusInOtherContentProcess in the chrome process, because the harness
// expects that.
if (!XRE_IsParentProcess()) {
if (RefPtr<nsFrameLoaderOwner> flo = do_QueryObject(aElement)) {
// Only look at pre-existing browsing contexts. If this function is
// called during reflow, calling GetBrowsingContext() could cause frame
// loader initialization at a time when it isn't safe.
if (BrowsingContext* bc = flo->GetExtantBrowsingContext()) {
focusInOtherContentProcess = !bc->IsInProcess();
}
}
if (ActionIdComparableAndLower(
aActionId, mActionIdForFocusedBrowsingContextInContent)) {
// Unclear if this ever happens.
LOGFOCUS(
("Ignored an attempt to focus an element due to stale action id "
"%" PRIu64 ".",
aActionId));
return;
}
}
// If the focus actually changed, set the focus method (mouse, keyboard, etc).
// Otherwise, just get the current focus method and use that. This ensures
// that the method is set during the document and window focus events.
uint32_t focusMethod = aFocusChanged
? aFlags & METHODANDRING_MASK
: aWindow->GetFocusMethod() |
(aFlags & (FLAG_SHOWRING | FLAG_NOSHOWRING));
if (!IsWindowVisible(aWindow)) {
// if the window isn't visible, for instance because it is a hidden tab,
// update the current focus and scroll it into view but don't do anything
// else
if (RefPtr elementToFocus = FlushAndCheckIfFocusable(aElement, aFlags)) {
aWindow->SetFocusedElement(elementToFocus, focusMethod);
if (aFocusChanged) {
ScrollIntoView(presShell, elementToFocus, aFlags);
}
}
return;
}
LOGCONTENT("Element %s has been focused", aElement);
if (MOZ_LOG_TEST(gFocusLog, LogLevel::Debug)) {
Document* docm = aWindow->GetExtantDoc();
if (docm) {
LOGCONTENT(" from %s", docm->GetRootElement());
}
LOGFOCUS(
(" [Newdoc: %d FocusChanged: %d Raised: %d Flags: %x actionid: %" PRIu64
"]",
aIsNewDocument, aFocusChanged, aWindowRaised, aFlags, aActionId));
}
if (aIsNewDocument) {
// if this is a new document, update the parent chain of frames so that
// focus can be traversed from the top level down to the newly focused
// window.
RefPtr<BrowsingContext> bc = aWindow->GetBrowsingContext();
AdjustWindowFocus(bc, false, IsWindowVisible(aWindow), aActionId,
false /* aShouldClearAncestorFocus */,
nullptr /* aAncestorBrowsingContextToFocus */);
}
// indicate that the window has taken focus.
if (aWindow->TakeFocus(true, focusMethod)) {
aIsNewDocument = true;
}
SetFocusedWindowInternal(aWindow, aActionId);
if (aAdjustWidget && !sTestMode) {
if (nsViewManager* vm = presShell->GetViewManager()) {
nsCOMPtr<nsIWidget> widget = vm->GetRootWidget();
if (widget)
widget->SetFocus(nsIWidget::Raise::No, aFlags & FLAG_NONSYSTEMCALLER
? CallerType::NonSystem
: CallerType::System);
}
}
// if switching to a new document, first fire the focus event on the
// document and then the window.
if (aIsNewDocument) {
RefPtr<Document> doc = aWindow->GetExtantDoc();
// The focus change should be notified to IMEStateManager from here if:
// * the focused element is in design mode or
// * nobody gets focus and the document is in design mode
// since any element whose uncomposed document is in design mode won't
// receive focus event.
if (doc && ((aElement && aElement->IsInDesignMode()) ||
(!aElement && doc->IsInDesignMode()))) {
RefPtr<nsPresContext> presContext = presShell->GetPresContext();
IMEStateManager::OnChangeFocus(presContext, nullptr,
GetFocusMoveActionCause(aFlags));
}
if (doc && !focusInOtherContentProcess) {
SendFocusOrBlurEvent(eFocus, presShell, doc, doc, aWindowRaised);
}
if (GetFocusedBrowsingContext() == aWindow->GetBrowsingContext() &&
!mFocusedElement && !focusInOtherContentProcess) {
nsCOMPtr<nsPIDOMWindowInner> innerWindow =
aWindow->GetCurrentInnerWindow();
// MOZ_KnownLive due to bug 1506441
SendFocusOrBlurEvent(
eFocus, presShell, doc,
MOZ_KnownLive(nsGlobalWindowInner::Cast(innerWindow)), aWindowRaised);
}
}
// check to ensure that the element is still focusable, and that nothing
// else was focused during the events above.
// Note that the focusing element may have already been moved to another
// document/window. In that case, we should stop setting focus to it
// because setting focus to the new window would cause redirecting focus
// again and again.
RefPtr elementToFocus =
aElement && aElement->IsInComposedDoc() &&
aElement->GetComposedDoc() == aWindow->GetExtantDoc()
? FlushAndCheckIfFocusable(aElement, aFlags)
: nullptr;
if (elementToFocus && !mFocusedElement &&
GetFocusedBrowsingContext() == aWindow->GetBrowsingContext()) {
mFocusedElement = elementToFocus;
nsIContent* focusedNode = aWindow->GetFocusedElement();
const bool sendFocusEvent = elementToFocus->IsInComposedDoc() &&
!IsNonFocusableRoot(elementToFocus);
const bool isRefocus = focusedNode && focusedNode == elementToFocus;
const bool shouldShowFocusRing =
sendFocusEvent &&
ShouldMatchFocusVisible(aWindow, *elementToFocus, aFlags);
aWindow->SetFocusedElement(elementToFocus, focusMethod, false);
const RefPtr<nsPresContext> presContext = presShell->GetPresContext();
if (sendFocusEvent) {
NotifyFocusStateChange(elementToFocus, nullptr, aFlags,
/* aGettingFocus = */ true, shouldShowFocusRing);
// If this is a remote browser, focus its widget and activate remote
// content. Note that we might no longer be in the same document,
// due to the events we fired above when aIsNewDocument.
if (presShell->GetDocument() == elementToFocus->GetComposedDoc()) {
ActivateRemoteFrameIfNeeded(*elementToFocus, aActionId);
}
IMEStateManager::OnChangeFocus(presContext, elementToFocus,
GetFocusMoveActionCause(aFlags));
// as long as this focus wasn't because a window was raised, update the
// commands
// XXXndeakin P2 someone could adjust the focus during the update
if (!aWindowRaised) {
aWindow->UpdateCommands(u"focus"_ns);
}
// If the focused element changed, scroll it into view
if (aFocusChanged) {
ScrollIntoView(presShell, elementToFocus, aFlags);
}
if (!focusInOtherContentProcess) {
RefPtr<Document> composedDocument = elementToFocus->GetComposedDoc();
RefPtr<Element> relatedTargetElement =
aBlurredElementInfo ? aBlurredElementInfo->mElement.get() : nullptr;
SendFocusOrBlurEvent(eFocus, presShell, composedDocument,
elementToFocus, aWindowRaised, isRefocus,
relatedTargetElement);
}
} else {
// We should notify IMEStateManager of actual focused element even if it
// won't get focus event because the other IMEStateManager users do not
// want to depend on this check, but IMEStateManager wants to verify
// passed focused element for avoidng to overrride nested calls.
IMEStateManager::OnChangeFocus(presContext, elementToFocus,
GetFocusMoveActionCause(aFlags));
if (!aWindowRaised) {
aWindow->UpdateCommands(u"focus"_ns);
}
if (aFocusChanged) {
// If the focused element changed, scroll it into view
ScrollIntoView(presShell, elementToFocus, aFlags);
}
}
} else {
if (!mFocusedElement && mFocusedWindow == aWindow) {
// When there is no focused element, IMEStateManager needs to adjust IME
// enabled state with the document.
RefPtr<nsPresContext> presContext = presShell->GetPresContext();
IMEStateManager::OnChangeFocus(presContext, nullptr,
GetFocusMoveActionCause(aFlags));
}
if (!aWindowRaised) {
aWindow->UpdateCommands(u"focus"_ns);
}
}
// update the caret visibility and position to match the newly focused
// element. However, don't update the position if this was a focus due to a
// mouse click as the selection code would already have moved the caret as
// needed. If this is a different document than was focused before, also
// update the caret's visibility. If this is the same document, the caret
// visibility should be the same as before so there is no need to update it.
if (mFocusedElement == elementToFocus) {
RefPtr<Element> focusedElement = mFocusedElement;
UpdateCaret(aFocusChanged && !(aFlags & FLAG_BYMOUSE), aIsNewDocument,
focusedElement);
}
}
class FocusBlurEvent : public Runnable {
public:
FocusBlurEvent(EventTarget* aTarget, EventMessage aEventMessage,
nsPresContext* aContext, bool aWindowRaised, bool aIsRefocus,
EventTarget* aRelatedTarget)
: mozilla::Runnable("FocusBlurEvent"),
mTarget(aTarget),
mContext(aContext),
mEventMessage(aEventMessage),
mWindowRaised(aWindowRaised),
mIsRefocus(aIsRefocus),
mRelatedTarget(aRelatedTarget) {}
// TODO: Convert this to MOZ_CAN_RUN_SCRIPT (bug 1415230, bug 1535398)
MOZ_CAN_RUN_SCRIPT_BOUNDARY NS_IMETHOD Run() override {
InternalFocusEvent event(true, mEventMessage);
event.mFlags.mBubbles = false;
event.mFlags.mCancelable = false;
event.mFromRaise = mWindowRaised;
event.mIsRefocus = mIsRefocus;
event.mRelatedTarget = mRelatedTarget;
return EventDispatcher::Dispatch(mTarget, mContext, &event);
}
const nsCOMPtr<EventTarget> mTarget;
const RefPtr<nsPresContext> mContext;
EventMessage mEventMessage;
bool mWindowRaised;
bool mIsRefocus;
nsCOMPtr<EventTarget> mRelatedTarget;
};
class FocusInOutEvent : public Runnable {
public:
FocusInOutEvent(EventTarget* aTarget, EventMessage aEventMessage,
nsPresContext* aContext,
nsPIDOMWindowOuter* aOriginalFocusedWindow,
nsIContent* aOriginalFocusedContent,
EventTarget* aRelatedTarget)
: mozilla::Runnable("FocusInOutEvent"),
mTarget(aTarget),
mContext(aContext),
mEventMessage(aEventMessage),
mOriginalFocusedWindow(aOriginalFocusedWindow),
mOriginalFocusedContent(aOriginalFocusedContent),
mRelatedTarget(aRelatedTarget) {}
// TODO: Convert this to MOZ_CAN_RUN_SCRIPT (bug 1415230, bug 1535398)
MOZ_CAN_RUN_SCRIPT_BOUNDARY NS_IMETHOD Run() override {
nsCOMPtr<nsIContent> originalWindowFocus =
mOriginalFocusedWindow ? mOriginalFocusedWindow->GetFocusedElement()
: nullptr;
// Blink does not check that focus is the same after blur, but WebKit does.
// Opt to follow Blink's behavior (see bug 687787).
if (mEventMessage == eFocusOut ||
originalWindowFocus == mOriginalFocusedContent) {
InternalFocusEvent event(true, mEventMessage);
event.mFlags.mBubbles = true;
event.mFlags.mCancelable = false;
event.mRelatedTarget = mRelatedTarget;
return EventDispatcher::Dispatch(mTarget, mContext, &event);
}
return NS_OK;
}
const nsCOMPtr<EventTarget> mTarget;
const RefPtr<nsPresContext> mContext;
EventMessage mEventMessage;
nsCOMPtr<nsPIDOMWindowOuter> mOriginalFocusedWindow;
nsCOMPtr<nsIContent> mOriginalFocusedContent;
nsCOMPtr<EventTarget> mRelatedTarget;
};
static Document* GetDocumentHelper(EventTarget* aTarget) {
if (!aTarget) {
return nullptr;
}
if (const nsINode* node = nsINode::FromEventTarget(aTarget)) {
return node->OwnerDoc();
}
nsPIDOMWindowInner* win = nsPIDOMWindowInner::FromEventTarget(aTarget);
return win ? win->GetExtantDoc() : nullptr;
}
void nsFocusManager::FireFocusInOrOutEvent(
EventMessage aEventMessage, PresShell* aPresShell, EventTarget* aTarget,
nsPIDOMWindowOuter* aCurrentFocusedWindow,
nsIContent* aCurrentFocusedContent, EventTarget* aRelatedTarget) {
NS_ASSERTION(aEventMessage == eFocusIn || aEventMessage == eFocusOut,
"Wrong event type for FireFocusInOrOutEvent");
nsContentUtils::AddScriptRunner(new FocusInOutEvent(
aTarget, aEventMessage, aPresShell->GetPresContext(),
aCurrentFocusedWindow, aCurrentFocusedContent, aRelatedTarget));
}
void nsFocusManager::SendFocusOrBlurEvent(EventMessage aEventMessage,
PresShell* aPresShell,
Document* aDocument,
EventTarget* aTarget,
bool aWindowRaised, bool aIsRefocus,
EventTarget* aRelatedTarget) {
NS_ASSERTION(aEventMessage == eFocus || aEventMessage == eBlur,
"Wrong event type for SendFocusOrBlurEvent");
nsCOMPtr<Document> eventTargetDoc = GetDocumentHelper(aTarget);
nsCOMPtr<Document> relatedTargetDoc = GetDocumentHelper(aRelatedTarget);
// set aRelatedTarget to null if it's not in the same document as aTarget
if (eventTargetDoc != relatedTargetDoc) {
aRelatedTarget = nullptr;
}
if (aDocument && aDocument->EventHandlingSuppressed()) {
// if this event was already queued, remove it and append it to the end
mDelayedBlurFocusEvents.RemoveElementsBy([&](const auto& event) {
return event.mEventMessage == aEventMessage &&
event.mPresShell == aPresShell && event.mDocument == aDocument &&
event.mTarget == aTarget && event.mRelatedTarget == aRelatedTarget;
});
mDelayedBlurFocusEvents.EmplaceBack(aEventMessage, aPresShell, aDocument,
aTarget, aRelatedTarget);
return;
}
// If mDelayedBlurFocusEvents queue is not empty, check if there are events
// that belongs to this doc, if yes, fire them first.
if (aDocument && !aDocument->EventHandlingSuppressed() &&
mDelayedBlurFocusEvents.Length()) {
FireDelayedEvents(aDocument);
}
FireFocusOrBlurEvent(aEventMessage, aPresShell, aTarget, aWindowRaised,
aIsRefocus, aRelatedTarget);
}
void nsFocusManager::FireFocusOrBlurEvent(EventMessage aEventMessage,
PresShell* aPresShell,
EventTarget* aTarget,
bool aWindowRaised, bool aIsRefocus,
EventTarget* aRelatedTarget) {
nsCOMPtr<nsPIDOMWindowOuter> currentWindow = mFocusedWindow;
nsCOMPtr<nsPIDOMWindowInner> targetWindow = do_QueryInterface(aTarget);
nsCOMPtr<Document> targetDocument = do_QueryInterface(aTarget);
nsCOMPtr<nsIContent> currentFocusedContent =
currentWindow ? currentWindow->GetFocusedElement() : nullptr;
#ifdef ACCESSIBILITY
nsAccessibilityService* accService = GetAccService();
if (accService) {
if (aEventMessage == eFocus) {
accService->NotifyOfDOMFocus(aTarget);
} else {
accService->NotifyOfDOMBlur(aTarget);
}
}
#endif
aPresShell->ScheduleContentRelevancyUpdate(
ContentRelevancyReason::FocusInSubtree);
nsContentUtils::AddScriptRunner(
new FocusBlurEvent(aTarget, aEventMessage, aPresShell->GetPresContext(),
aWindowRaised, aIsRefocus, aRelatedTarget));
// Check that the target is not a window or document before firing
// focusin/focusout. Other browsers do not fire focusin/focusout on window,
// despite being required in the spec, so follow their behavior.
//
// As for document, we should not even fire focus/blur, but until then, we
// need this check. targetDocument should be removed once bug 1228802 is
// resolved.
if (!targetWindow && !targetDocument) {
EventMessage focusInOrOutMessage =
aEventMessage == eFocus ? eFocusIn : eFocusOut;
FireFocusInOrOutEvent(focusInOrOutMessage, aPresShell, aTarget,
currentWindow, currentFocusedContent, aRelatedTarget);
}
}
void nsFocusManager::ScrollIntoView(PresShell* aPresShell, nsIContent* aContent,
uint32_t aFlags) {
if (aFlags & FLAG_NOSCROLL) {
return;
}
// If the noscroll flag isn't set, scroll the newly focused element into view.
const ScrollAxis axis(WhereToScroll::Center, WhenToScroll::IfNotVisible);
aPresShell->ScrollContentIntoView(aContent, axis, axis,
ScrollFlags::ScrollOverflowHidden);
// Scroll the input / textarea selection into view, unless focused with the
// mouse, see bug 572649.
if (aFlags & FLAG_BYMOUSE) {
return;
}
// ScrollContentIntoView flushes layout, so no need to flush again here.
if (nsTextControlFrame* tf = do_QueryFrame(aContent->GetPrimaryFrame())) {
tf->ScrollSelectionIntoViewAsync(nsTextControlFrame::ScrollAncestors::Yes);
}
}
void nsFocusManager::RaiseWindow(nsPIDOMWindowOuter* aWindow,
CallerType aCallerType, uint64_t aActionId) {
// don't raise windows that are already raised or are in the process of
// being lowered
if (!aWindow || aWindow == mWindowBeingLowered) {
return;
}
if (XRE_IsParentProcess()) {
if (aWindow == mActiveWindow) {
if (!mFocusedWindow ||
!IsSameOrAncestor(aWindow->GetBrowsingContext(),
mFocusedWindow->GetBrowsingContext())) {
MoveFocusToWindowAfterRaise(aWindow, aActionId);
}
return;
}
} else {
BrowsingContext* bc = aWindow->GetBrowsingContext();
// TODO: Deeper OOP frame hierarchies are
// https://bugzilla.mozilla.org/show_bug.cgi?id=1661227
if (bc == GetActiveBrowsingContext()) {
return;
}
if (bc == GetFocusedBrowsingContext()) {
return;
}
}
if (sTestMode) {
// In test mode, emulate raising the window. WindowRaised takes
// care of lowering the present active window. This happens in
// a separate runnable to avoid touching multiple windows in
// the current runnable.
NS_DispatchToCurrentThread(NS_NewRunnableFunction(
"nsFocusManager::RaiseWindow",
// TODO: Convert this to MOZ_CAN_RUN_SCRIPT (bug 1770093)
[self = RefPtr{this}, window = nsCOMPtr{aWindow}]()
MOZ_CAN_RUN_SCRIPT_BOUNDARY -> void {
self->WindowRaised(window, GenerateFocusActionId());
}));
return;
}
if (XRE_IsContentProcess()) {
BrowsingContext* bc = aWindow->GetBrowsingContext();
if (!bc->IsTop()) {
// Assume the raise below will succeed and run the raising synchronously
// in this process to make the focus event that is observable in this
// process fire in the right order relative to mouseup when we are here
// thanks to a mousedown.
WindowRaised(aWindow, aActionId);
}
}
nsCOMPtr<nsIBaseWindow> treeOwnerAsWin =
do_QueryInterface(aWindow->GetDocShell());
if (treeOwnerAsWin) {
nsCOMPtr<nsIWidget> widget;
treeOwnerAsWin->GetMainWidget(getter_AddRefs(widget));
if (widget) {
widget->SetFocus(nsIWidget::Raise::Yes, aCallerType);
}
}
}
void nsFocusManager::UpdateCaretForCaretBrowsingMode() {
RefPtr<Element> focusedElement = mFocusedElement;
UpdateCaret(false, true, focusedElement);
}
void nsFocusManager::UpdateCaret(bool aMoveCaretToFocus, bool aUpdateVisibility,
nsIContent* aContent) {
LOGFOCUS(("Update Caret: %d %d", aMoveCaretToFocus, aUpdateVisibility));
if (!mFocusedWindow) {
return;
}
// this is called when a document is focused or when the caretbrowsing
// preference is changed
nsCOMPtr<nsIDocShell> focusedDocShell = mFocusedWindow->GetDocShell();
if (!focusedDocShell) {
return;
}
if (focusedDocShell->ItemType() == nsIDocShellTreeItem::typeChrome) {
return; // Never browse with caret in chrome
}
bool browseWithCaret = StaticPrefs::accessibility_browsewithcaret();
const RefPtr<PresShell> presShell = focusedDocShell->GetPresShell();
if (!presShell) {
return;
}
// If this is an editable document which isn't contentEditable, or a
// contentEditable document and the node to focus is contentEditable,
// return, so that we don't mess with caret visibility.
bool isEditable = false;
focusedDocShell->GetEditable(&isEditable);
if (isEditable) {
Document* doc = presShell->GetDocument();
bool isContentEditableDoc =
doc &&
doc->GetEditingState() == Document::EditingState::eContentEditable;
bool isFocusEditable = aContent && aContent->HasFlag(NODE_IS_EDITABLE);
if (!isContentEditableDoc || isFocusEditable) {
return;
}
}
if (!isEditable && aMoveCaretToFocus) {
MoveCaretToFocus(presShell, aContent);
}
// The above MoveCaretToFocus call may run scripts which
// may clear mFocusWindow
if (!mFocusedWindow) {
return;
}
if (!aUpdateVisibility) {
return;
}
// XXXndeakin this doesn't seem right. It should be checking for this only
// on the nearest ancestor frame which is a chrome frame. But this is
// what the existing code does, so just leave it for now.
if (!browseWithCaret) {
nsCOMPtr<Element> docElement = mFocusedWindow->GetFrameElementInternal();
if (docElement)
browseWithCaret = docElement->AttrValueIs(
kNameSpaceID_None, nsGkAtoms::showcaret, u"true"_ns, eCaseMatters);
}
SetCaretVisible(presShell, browseWithCaret, aContent);
}
void nsFocusManager::MoveCaretToFocus(PresShell* aPresShell,
nsIContent* aContent) {
nsCOMPtr<Document> doc = aPresShell->GetDocument();
if (doc) {
RefPtr<nsFrameSelection> frameSelection = aPresShell->FrameSelection();
RefPtr<Selection> domSelection = &frameSelection->NormalSelection();
MOZ_ASSERT(domSelection);
// First clear the selection. This way, if there is no currently focused
// content, the selection will just be cleared.
domSelection->RemoveAllRanges(IgnoreErrors());
if (aContent) {
ErrorResult rv;
RefPtr<nsRange> newRange = doc->CreateRange(rv);
if (NS_WARN_IF(rv.Failed())) {
rv.SuppressException();
return;
}
// Set the range to the start of the currently focused node
// Make sure it's collapsed
newRange->SelectNodeContents(*aContent, IgnoreErrors());
if (!aContent->GetFirstChild() || aContent->IsHTMLFormControlElement()) {
// If current focus node is a leaf, set range to before the
// node by using the parent as a container.
// This prevents it from appearing as selected.
newRange->SetStartBefore(*aContent, IgnoreErrors());
newRange->SetEndBefore(*aContent, IgnoreErrors());
}
domSelection->AddRangeAndSelectFramesAndNotifyListeners(*newRange,
IgnoreErrors());
domSelection->CollapseToStart(IgnoreErrors());
}
}
}
nsresult nsFocusManager::SetCaretVisible(PresShell* aPresShell, bool aVisible,
nsIContent* aContent) {
// When browsing with caret, make sure caret is visible after new focus
// Return early if there is no caret. This can happen for the testcase
// for bug 308025 where a window is closed in a blur handler.
RefPtr<nsCaret> caret = aPresShell->GetCaret();
if (!caret) {
return NS_OK;
}
bool caretVisible = caret->IsVisible();
if (!aVisible && !caretVisible) {
return NS_OK;
}
RefPtr<nsFrameSelection> frameSelection;
if (aContent) {
NS_ASSERTION(aContent->GetComposedDoc() == aPresShell->GetDocument(),
"Wrong document?");
nsIFrame* focusFrame = aContent->GetPrimaryFrame();
if (focusFrame) {
frameSelection = focusFrame->GetFrameSelection();
}
}
RefPtr<nsFrameSelection> docFrameSelection = aPresShell->FrameSelection();
if (docFrameSelection && caret &&
(frameSelection == docFrameSelection || !aContent)) {
Selection& domSelection = docFrameSelection->NormalSelection();
// First, hide the caret to prevent attempting to show it in
// SetCaretDOMSelection
aPresShell->SetCaretEnabled(false);
// Tell the caret which selection to use
caret->SetSelection(&domSelection);
// In content, we need to set the caret. The only special case is edit
// fields, which have a different frame selection from the document.
// They will take care of making the caret visible themselves.
aPresShell->SetCaretReadOnly(false);
aPresShell->SetCaretEnabled(aVisible);
}
return NS_OK;
}
void nsFocusManager::GetSelectionLocation(Document* aDocument,
PresShell* aPresShell,
nsIContent** aStartContent,
nsIContent** aEndContent) {
*aStartContent = *aEndContent = nullptr;
nsPresContext* presContext = aPresShell->GetPresContext();
NS_ASSERTION(presContext, "mPresContent is null!!");
RefPtr<Selection> domSelection =
&aPresShell->ConstFrameSelection()->NormalSelection();
MOZ_ASSERT(domSelection);
const nsRange* domRange = domSelection->GetRangeAt(0);
if (!domRange || !domRange->IsPositioned()) {
return;
}
nsIContent* start = nsIContent::FromNode(domRange->GetStartContainer());
nsIContent* end = nsIContent::FromNode(domRange->GetEndContainer());
if (nsIContent* child = domRange->StartRef().GetChildAtOffset()) {
start = child;
}
if (nsIContent* child = domRange->EndRef().GetChildAtOffset()) {
end = child;
}
// Next check to see if our caret is at the very end of a text node. If so,
// the caret is actually sitting in front of the next logical frame's primary
// node - so for this case we need to change the content to that node.
// Note that if the text does not have text frame, we do not need to retreive
// caret frame. This could occur if text frame has only collapsisble white-
// spaces and is around a block boundary or an ancestor of it is invisible.
// XXX If there is a visible text sibling, should we return it in the former
// case?
if (auto* text = Text::FromNodeOrNull(start);
text && text->GetPrimaryFrame() &&
text->TextDataLength() == domRange->StartOffset() &&
domSelection->IsCollapsed()) {
nsIFrame* startFrame = start->GetPrimaryFrame();
// Yes, indeed we were at the end of the last node
const Element* const limiter =
domSelection && domSelection->GetAncestorLimiter()
? domSelection->GetAncestorLimiter()
: nullptr;
nsFrameIterator frameIterator(presContext, startFrame,
nsFrameIterator::Type::Leaf,
false, // aVisual
false, // aLockInScrollView
true, // aFollowOOFs
false, // aSkipPopupChecks
limiter);
nsIFrame* newCaretFrame = nullptr;
nsIContent* newCaretContent = start;
const bool endOfSelectionInStartNode = start == end;
do {
// Continue getting the next frame until the primary content for the
// frame we are on changes - we don't want to be stuck in the same
// place
frameIterator.Next();
newCaretFrame = frameIterator.CurrentItem();
if (!newCaretFrame) {
break;
}
newCaretContent = newCaretFrame->GetContent();
} while (!newCaretContent || newCaretContent == start);
if (newCaretFrame && newCaretContent) {
// If the caret is exactly at the same position of the new frame,
// then we can use the newCaretFrame and newCaretContent for our
// position
nsRect caretRect;
if (nsIFrame* frame = nsCaret::GetGeometry(domSelection, &caretRect)) {
nsPoint caretWidgetOffset;
nsIWidget* widget = frame->GetNearestWidget(caretWidgetOffset);
caretRect.MoveBy(caretWidgetOffset);
nsPoint newCaretOffset;
nsIWidget* newCaretWidget =
newCaretFrame->GetNearestWidget(newCaretOffset);
if (widget == newCaretWidget && caretRect.TopLeft() == newCaretOffset) {
// The caret is at the start of the new element.
startFrame = newCaretFrame;
start = newCaretContent;
if (endOfSelectionInStartNode) {
end = newCaretContent; // Ensure end of selection is
// not before start
}
}
}
}
}
NS_IF_ADDREF(*aStartContent = start);
NS_IF_ADDREF(*aEndContent = end);
}
nsresult nsFocusManager::DetermineElementToMoveFocus(
nsPIDOMWindowOuter* aWindow, nsIContent* aStartContent, int32_t aType,
bool aNoParentTraversal, bool aNavigateByKey, nsIContent** aNextContent) {
*aNextContent = nullptr;
// This is used for document navigation only. It will be set to true if we
// start navigating from a starting point. If this starting point is near the
// end of the document (for example, an element on a statusbar), and there
// are no child documents or panels before the end of the document, then we
// will need to ensure that we don't consider the root chrome window when we
// loop around and instead find the next child document/panel, as focus is
// already in that window. This flag will be cleared once we navigate into
// another document.
bool mayFocusRoot = (aStartContent != nullptr);
nsCOMPtr<nsIContent> startContent = aStartContent;
if (!startContent && aType != MOVEFOCUS_CARET) {
if (aType == MOVEFOCUS_FORWARDDOC || aType == MOVEFOCUS_BACKWARDDOC) {
// When moving between documents, make sure to get the right
// starting content in a descendant.
nsCOMPtr<nsPIDOMWindowOuter> focusedWindow;
startContent = GetFocusedDescendant(aWindow, eIncludeAllDescendants,
getter_AddRefs(focusedWindow));
} else if (aType != MOVEFOCUS_LASTDOC) {
// Otherwise, start at the focused node. If MOVEFOCUS_LASTDOC is used,
// then we are document-navigating backwards from chrome to the content
// process, and we don't want to use this so that we start from the end
// of the document.
startContent = aWindow->GetFocusedElement();
}
}
nsCOMPtr<Document> doc;
if (startContent)
doc = startContent->GetComposedDoc();
else
doc = aWindow->GetExtantDoc();
if (!doc) return NS_OK;
// True if we are navigating by document (F6/Shift+F6) or false if we are
// navigating by element (Tab/Shift+Tab).
const bool forDocumentNavigation =
aType == MOVEFOCUS_FORWARDDOC || aType == MOVEFOCUS_BACKWARDDOC ||
aType == MOVEFOCUS_FIRSTDOC || aType == MOVEFOCUS_LASTDOC;
// If moving to the root or first document, find the root element and return.
if (aType == MOVEFOCUS_ROOT || aType == MOVEFOCUS_FIRSTDOC) {
NS_IF_ADDREF(*aNextContent = GetRootForFocus(aWindow, doc, false, false));
if (!*aNextContent && aType == MOVEFOCUS_FIRSTDOC) {
// When looking for the first document, if the root wasn't focusable,
// find the next focusable document.
aType = MOVEFOCUS_FORWARDDOC;
} else {
return NS_OK;
}
}
// rootElement and presShell may be set to sub-document's ones so that they
// cannot be `const`.
RefPtr<Element> rootElement = doc->GetRootElement();
NS_ENSURE_TRUE(rootElement, NS_OK);
RefPtr<PresShell> presShell = doc->GetPresShell();
NS_ENSURE_TRUE(presShell, NS_OK);
if (aType == MOVEFOCUS_FIRST) {
if (!aStartContent) {
startContent = rootElement;
}
return GetNextTabbableContent(presShell, startContent, nullptr,
startContent, true, 1, false, false,
aNavigateByKey, false, false, aNextContent);
}
if (aType == MOVEFOCUS_LAST) {
if (!aStartContent) {
startContent = rootElement;
}
return GetNextTabbableContent(presShell, startContent, nullptr,
startContent, false, 0, false, false,
aNavigateByKey, false, false, aNextContent);
}
bool forward = (aType == MOVEFOCUS_FORWARD || aType == MOVEFOCUS_FORWARDDOC ||
aType == MOVEFOCUS_CARET);
bool doNavigation = true;
bool ignoreTabIndex = false;
// when a popup is open, we want to ensure that tab navigation occurs only
// within the most recently opened panel. If a popup is open, its frame will
// be stored in popupFrame.
nsIFrame* popupFrame = nullptr;
int32_t tabIndex = forward ? 1 : 0;
if (startContent) {
nsIFrame* frame = startContent->GetPrimaryFrame();
tabIndex = (frame && !startContent->IsHTMLElement(nsGkAtoms::area))
? frame->IsFocusable().mTabIndex
: startContent->IsFocusableWithoutStyle().mTabIndex;
// if the current element isn't tabbable, ignore the tabindex and just
// look for the next element. The root content won't have a tabindex
// so just treat this as the beginning of the tab order.
if (tabIndex < 0) {
tabIndex = 1;
if (startContent != rootElement) {
ignoreTabIndex = true;
}
}
// check if the focus is currently inside a popup. Elements such as the
// autocomplete widget use the noautofocus attribute to allow the focus to
// remain outside the popup when it is opened.
if (frame) {
popupFrame = nsLayoutUtils::GetClosestFrameOfType(
frame, LayoutFrameType::MenuPopup);
}
if (popupFrame && !forDocumentNavigation) {
// Don't navigate outside of a popup, so pretend that the
// root content is the popup itself
rootElement = popupFrame->GetContent()->AsElement();
NS_ASSERTION(rootElement, "Popup frame doesn't have a content node");
} else if (!forward) {
// If focus moves backward and when current focused node is root
// content or <body> element which is editable by contenteditable
// attribute, focus should move to its parent document.
if (startContent == rootElement) {
doNavigation = false;
} else {
Document* doc = startContent->GetComposedDoc();
if (startContent ==
nsLayoutUtils::GetEditableRootContentByContentEditable(doc)) {
doNavigation = false;
}
}
}
} else {
if (aType != MOVEFOCUS_CARET) {
// if there is no focus, yet a panel is open, focus the first item in
// the panel
nsXULPopupManager* pm = nsXULPopupManager::GetInstance();
if (pm) {
popupFrame = pm->GetTopPopup(PopupType::Panel);
}
}
if (popupFrame) {
// When there is a popup open, and no starting content, start the search
// at the topmost popup.
startContent = popupFrame->GetContent();
NS_ASSERTION(startContent, "Popup frame doesn't have a content node");
// Unless we are searching for documents, set the root content to the
// popup as well, so that we don't tab-navigate outside the popup.
// When navigating by documents, we start at the popup but can navigate
// outside of it to look for other panels and documents.
if (!forDocumentNavigation) {
rootElement = startContent->AsElement();
}
doc = startContent ? startContent->GetComposedDoc() : nullptr;
} else {
// Otherwise, for content shells, start from the location of the caret.
nsCOMPtr<nsIDocShell> docShell = aWindow->GetDocShell();
if (docShell && docShell->ItemType() != nsIDocShellTreeItem::typeChrome) {
nsCOMPtr<nsIContent> endSelectionContent;
GetSelectionLocation(doc, presShell, getter_AddRefs(startContent),
getter_AddRefs(endSelectionContent));
// If the selection is on the rootElement, then there is no selection
if (startContent == rootElement) {
startContent = nullptr;
}
if (aType == MOVEFOCUS_CARET) {
// GetFocusInSelection finds a focusable link near the caret.
// If there is no start content though, don't do this to avoid
// focusing something unexpected.
if (startContent) {
GetFocusInSelection(aWindow, startContent, endSelectionContent,
aNextContent);
}
return NS_OK;
}
if (startContent) {
// when starting from a selection, we always want to find the next or
// previous element in the document. So the tabindex on elements
// should be ignored.
ignoreTabIndex = true;
// If selection starts from a focusable and tabbable element, we want
// to make it focused rather than next/previous one.
if (startContent->IsElement() && startContent->GetPrimaryFrame() &&
startContent->GetPrimaryFrame()->IsFocusable().IsTabbable()) {
startContent =
forward ? (startContent->GetPreviousSibling()
? startContent->GetPreviousSibling()
// We don't need to get previous leaf node
// because it may be too far from
// startContent. We just want the previous
// node immediately before startContent.
: startContent->GetParent())
// We want the next node immdiately after startContent.
// Therefore, we don't want its first child.
: startContent->GetNextNonChildNode();
// If we reached the root element, we should treat it as there is no
// selection as same as above.
if (startContent == rootElement) {
startContent = nullptr;
}
}
}
}
if (!startContent) {
// otherwise, just use the root content as the starting point
startContent = rootElement;
NS_ENSURE_TRUE(startContent, NS_OK);
}
}
}
// Check if the starting content is the same as the content assigned to the
// retargetdocumentfocus attribute. Is so, we don't want to start searching
// from there but instead from the beginning of the document. Otherwise, the
// content that appears before the retargetdocumentfocus element will never
// get checked as it will be skipped when the focus is retargetted to it.
if (forDocumentNavigation && nsContentUtils::IsChromeDoc(doc)) {
nsAutoString retarget;
if (rootElement->GetAttr(nsGkAtoms::retargetdocumentfocus, retarget)) {
nsIContent* retargetElement = doc->GetElementById(retarget);
// The common case here is the urlbar where focus is on the anonymous
// input inside the textbox, but the retargetdocumentfocus attribute
// refers to the textbox. The Contains check will return false and the
// IsInclusiveDescendantOf check will return true in this case.
if (retargetElement &&
(retargetElement == startContent ||
(!retargetElement->Contains(startContent) &&
startContent->IsInclusiveDescendantOf(retargetElement)))) {
startContent = rootElement;
}
}
}
NS_ASSERTION(startContent, "starting content not set");
// keep a reference to the starting content. If we find that again, it means
// we've iterated around completely and we don't want to adjust the focus.
// The skipOriginalContentCheck will be set to true only for the first time
// GetNextTabbableContent is called. This ensures that we don't break out
// when nothing is focused to start with. Specifically,
// GetNextTabbableContent first checks the root content -- which happens to
// be the same as the start content -- when nothing is focused and tabbing
// forward. Without skipOriginalContentCheck set to true, we'd end up
// returning right away and focusing nothing. Luckily, GetNextTabbableContent
// will never wrap around on its own, and can only return the original
// content when it is called a second time or later.
bool skipOriginalContentCheck = true;
const nsCOMPtr<nsIContent> originalStartContent = startContent;
LOGCONTENTNAVIGATION("Focus Navigation Start Content %s", startContent.get());
LOGFOCUSNAVIGATION((" Forward: %d Tabindex: %d Ignore: %d DocNav: %d",
forward, tabIndex, ignoreTabIndex,
forDocumentNavigation));
while (doc) {
if (doNavigation) {
nsCOMPtr<nsIContent> nextFocus;
// TODO: MOZ_KnownLive is reruired due to bug 1770680
nsresult rv = GetNextTabbableContent(
presShell, rootElement,
MOZ_KnownLive(skipOriginalContentCheck ? nullptr
: originalStartContent.get()),
startContent, forward, tabIndex, ignoreTabIndex,
forDocumentNavigation, aNavigateByKey, false, false,
getter_AddRefs(nextFocus));
NS_ENSURE_SUCCESS(rv, rv);
if (rv == NS_SUCCESS_DOM_NO_OPERATION) {
// Navigation was redirected to a child process, so just return.
return NS_OK;
}
// found a content node to focus.
if (nextFocus) {
LOGCONTENTNAVIGATION("Next Content: %s", nextFocus.get());
// as long as the found node was not the same as the starting node,
// set it as the return value. For document navigation, we can return
// the same element in case there is only one content node that could
// be returned, for example, in a child process document.
if (nextFocus != originalStartContent || forDocumentNavigation) {
nextFocus.forget(aNextContent);
}
return NS_OK;
}
if (popupFrame && !forDocumentNavigation) {
// in a popup, so start again from the beginning of the popup. However,
// if we already started at the beginning, then there isn't anything to
// focus, so just return
if (startContent != rootElement) {
startContent = rootElement;
tabIndex = forward ? 1 : 0;
continue;
}
return NS_OK;
}
}
doNavigation = true;
skipOriginalContentCheck = forDocumentNavigation;
ignoreTabIndex = false;
if (aNoParentTraversal) {
if (startContent == rootElement) {
return NS_OK;
}
startContent = rootElement;
tabIndex = forward ? 1 : 0;
continue;
}
// Reached the beginning or end of the document. Next, navigate up to the
// parent document and try again.
nsCOMPtr<nsPIDOMWindowOuter> piWindow = doc->GetWindow();
NS_ENSURE_TRUE(piWindow, NS_ERROR_FAILURE);
nsCOMPtr<nsIDocShell> docShell = piWindow->GetDocShell();
NS_ENSURE_TRUE(docShell, NS_ERROR_FAILURE);
// Get the frame element this window is inside and, from that, get the
// parent document and presshell. If there is no enclosing frame element,
// then this is a top-level, embedded or remote window.
startContent = piWindow->GetFrameElementInternal();
if (startContent) {
doc = startContent->GetComposedDoc();
NS_ENSURE_TRUE(doc, NS_ERROR_FAILURE);
rootElement = doc->GetRootElement();
presShell = doc->GetPresShell();
// We can focus the root element now that we have moved to another
// document.
mayFocusRoot = true;
nsIFrame* frame = startContent->GetPrimaryFrame();
if (!frame) {
return NS_OK;
}
tabIndex = frame->IsFocusable().mTabIndex;
if (tabIndex < 0) {
tabIndex = 1;
ignoreTabIndex = true;
}
// if the frame is inside a popup, make sure to scan only within the
// popup. This handles the situation of tabbing amongst elements
// inside an iframe which is itself inside a popup. Otherwise,
// navigation would move outside the popup when tabbing outside the
// iframe.
if (!forDocumentNavigation) {
popupFrame = nsLayoutUtils::GetClosestFrameOfType(
frame, LayoutFrameType::MenuPopup);
if (popupFrame) {
rootElement = popupFrame->GetContent()->AsElement();
NS_ASSERTION(rootElement, "Popup frame doesn't have a content node");
}
}
} else {
if (aNavigateByKey) {
// There is no parent, so move the focus to the parent process.
if (auto* child = BrowserChild::GetFrom(docShell)) {
child->SendMoveFocus(forward, forDocumentNavigation);
// Blur the current element.
RefPtr<BrowsingContext> focusedBC = GetFocusedBrowsingContext();
if (focusedBC && focusedBC->IsInProcess()) {
Blur(focusedBC, nullptr, true, true, false,
GenerateFocusActionId());
} else {
nsCOMPtr<nsPIDOMWindowOuter> window = docShell->GetWindow();
window->SetFocusedElement(nullptr);
}
return NS_OK;
}
}
// If we have reached the end of the top-level document, focus the
// first element in the top-level document. This should always happen
// when navigating by document forwards but when navigating backwards,
// only do this if we started in another document or within a popup frame.
// If the focus started in this window outside a popup however, we should
// continue by looping around to the end again.
if (forDocumentNavigation && (forward || mayFocusRoot || popupFrame)) {
// HTML content documents can have their root element focused by
// pressing F6(a focus ring appears around the entire content area
// frame). This root appears in the tab order before all of the elements
// in the document. Chrome documents however cannot be focused directly,
// so instead we focus the first focusable element within the window.
// For example, the urlbar.
RefPtr<Element> rootElementForFocus =
GetRootForFocus(piWindow, doc, true, true);
return FocusFirst(rootElementForFocus, aNextContent,
true /* aReachedToEndForDocumentNavigation */);
}
// Once we have hit the top-level and have iterated to the end again, we
// just want to break out next time we hit this spot to prevent infinite
// iteration.
mayFocusRoot = true;
// reset the tab index and start again from the beginning or end
startContent = rootElement;
tabIndex = forward ? 1 : 0;
}
// wrapped all the way around and didn't find anything to move the focus
// to, so just break out
if (startContent == originalStartContent) {
break;
}
}
return NS_OK;
}
uint32_t nsFocusManager::ProgrammaticFocusFlags(const FocusOptions& aOptions) {
uint32_t flags = FLAG_BYJS;
if (aOptions.mPreventScroll) {
flags |= FLAG_NOSCROLL;
}
if (aOptions.mFocusVisible.WasPassed()) {
flags |= aOptions.mFocusVisible.Value() ? FLAG_SHOWRING : FLAG_NOSHOWRING;
}
if (UserActivation::IsHandlingKeyboardInput()) {
flags |= FLAG_BYKEY;
}
// TODO: We could do a similar thing if we're handling mouse input, but that
// changes focusability of some elements so may be more risky.
return flags;
}
static bool IsHostOrSlot(const nsIContent* aContent) {
return aContent && (aContent->GetShadowRoot() ||
aContent->IsHTMLElement(nsGkAtoms::slot));
}
// Helper class to iterate contents in scope by traversing flattened tree
// in tree order
class MOZ_STACK_CLASS ScopedContentTraversal {
public:
ScopedContentTraversal(nsIContent* aStartContent, nsIContent* aOwner)
: mCurrent(aStartContent), mOwner(aOwner) {
MOZ_ASSERT(aStartContent);
}
void Next();
void Prev();
void Reset() { SetCurrent(mOwner); }
nsIContent* GetCurrent() const { return mCurrent; }
private:
void SetCurrent(nsIContent* aContent) { mCurrent = aContent; }
nsIContent* mCurrent;
nsIContent* mOwner;
};
void ScopedContentTraversal::Next() {
MOZ_ASSERT(mCurrent);
// Get mCurrent's first child if it's in the same scope.
if (!IsHostOrSlot(mCurrent) || mCurrent == mOwner) {
StyleChildrenIterator iter(mCurrent);
nsIContent* child = iter.GetNextChild();
if (child) {
SetCurrent(child);
return;
}
}
// If mOwner has no children, END traversal
if (mCurrent == mOwner) {
SetCurrent(nullptr);
return;
}
nsIContent* current = mCurrent;
while (1) {
// Create parent's iterator and move to current
nsIContent* parent = current->GetFlattenedTreeParent();
StyleChildrenIterator parentIter(parent);
parentIter.Seek(current);
// Get next sibling of current
if (nsIContent* next = parentIter.GetNextChild()) {
SetCurrent(next);
return;
}
// If no next sibling and parent is mOwner, END traversal
if (parent == mOwner) {
SetCurrent(nullptr);
return;
}
current = parent;
}
}
void ScopedContentTraversal::Prev() {
MOZ_ASSERT(mCurrent);
nsIContent* parent;
nsIContent* last;
if (mCurrent == mOwner) {
// Get last child of mOwner
StyleChildrenIterator ownerIter(mOwner, false /* aStartAtBeginning */);
last = ownerIter.GetPreviousChild();
parent = last;
} else {
// Create parent's iterator and move to mCurrent
parent = mCurrent->GetFlattenedTreeParent();
StyleChildrenIterator parentIter(parent);
parentIter.Seek(mCurrent);
// Get previous sibling
last = parentIter.GetPreviousChild();
}
while (last) {
parent = last;
if (IsHostOrSlot(parent)) {
// Skip contents in other scopes
break;
}
// Find last child
StyleChildrenIterator iter(parent, false /* aStartAtBeginning */);
last = iter.GetPreviousChild();
}
// If parent is mOwner and no previous sibling remains, END traversal
SetCurrent(parent == mOwner ? nullptr : parent);
}
static bool IsOpenPopoverWithInvoker(nsIContent* aContent) {
if (auto* popover = Element::FromNode(aContent)) {
return popover && popover->IsPopoverOpen() &&
popover->GetPopoverData()->GetInvoker();
}
return false;
}
static nsIContent* InvokerForPopoverShowingState(nsIContent* aContent) {
Element* invoker = Element::FromNode(aContent);
if (!invoker) {
return nullptr;
}
nsGenericHTMLElement* popover = invoker->GetEffectivePopoverTargetElement();
if (popover && popover->IsPopoverOpen() &&
popover->GetPopoverData()->GetInvoker() == invoker) {
return aContent;
}
return nullptr;
}
/**
* Returns scope owner of aContent.
* A scope owner is either a shadow host, or slot.
*/
static nsIContent* FindScopeOwner(nsIContent* aContent) {
nsIContent* currentContent = aContent;
while (currentContent) {
nsIContent* parent = currentContent->GetFlattenedTreeParent();
// Shadow host / Slot
if (IsHostOrSlot(parent)) {
return parent;
}
currentContent = parent;
}
return nullptr;
}
/**
* Host and Slot elements need to be handled as if they had tabindex 0 even
* when they don't have the attribute. This is a helper method to get the
* right value for focus navigation. If aIsFocusable is passed, it is set to
* true if the element itself is focusable.
*/
static int32_t HostOrSlotTabIndexValue(const nsIContent* aContent,
bool* aIsFocusable = nullptr) {
MOZ_ASSERT(IsHostOrSlot(aContent));
if (aIsFocusable) {
nsIFrame* frame = aContent->GetPrimaryFrame();
*aIsFocusable = frame && frame->IsFocusable().mTabIndex >= 0;
}
const nsAttrValue* attrVal =
aContent->AsElement()->GetParsedAttr(nsGkAtoms::tabindex);
if (!attrVal) {
return 0;
}
if (attrVal->Type() == nsAttrValue::eInteger) {
return attrVal->GetIntegerValue();
}
return -1;
}
nsIContent* nsFocusManager::GetNextTabbableContentInScope(
nsIContent* aOwner, nsIContent* aStartContent,
nsIContent* aOriginalStartContent, bool aForward, int32_t aCurrentTabIndex,
bool aIgnoreTabIndex, bool aForDocumentNavigation, bool aNavigateByKey,
bool aSkipOwner, bool aReachedToEndForDocumentNavigation) {
MOZ_ASSERT(
IsHostOrSlot(aOwner) || IsOpenPopoverWithInvoker(aOwner),
"Scope owner should be host, slot or an open popover with invoker set.");
// XXX: Why don't we ignore tabindex when the current tabindex < 0?
MOZ_ASSERT_IF(aCurrentTabIndex < 0, aIgnoreTabIndex);
if (!aSkipOwner && (aForward && aOwner == aStartContent)) {
if (nsIFrame* frame = aOwner->GetPrimaryFrame()) {
auto focusable = frame->IsFocusable();
if (focusable && focusable.mTabIndex >= 0) {
return aOwner;
}
}
}
//
// Iterate contents in scope
//
ScopedContentTraversal contentTraversal(aStartContent, aOwner);
nsCOMPtr<nsIContent> iterContent;
nsIContent* firstNonChromeOnly =
aStartContent->IsInNativeAnonymousSubtree()
? aStartContent->FindFirstNonChromeOnlyAccessContent()
: nullptr;
while (1) {
// Iterate tab index to find corresponding contents in scope
while (1) {
// Iterate remaining contents in scope to find next content to focus
// Get next content
aForward ? contentTraversal.Next() : contentTraversal.Prev();
iterContent = contentTraversal.GetCurrent();
if (firstNonChromeOnly && firstNonChromeOnly == iterContent) {
// We just broke out from the native anonymous content, so move
// to the previous/next node of the native anonymous owner.
if (aForward) {
contentTraversal.Next();
} else {
contentTraversal.Prev();
}
iterContent = contentTraversal.GetCurrent();
}
if (!iterContent) {
// Reach the end
break;
}
int32_t tabIndex = 0;
if (IsHostOrSlot(iterContent)) {
tabIndex = HostOrSlotTabIndexValue(iterContent);
} else {
nsIFrame* frame = iterContent->GetPrimaryFrame();
if (!frame) {
continue;
}
tabIndex = frame->IsFocusable().mTabIndex;
}
if (tabIndex < 0 || !(aIgnoreTabIndex || tabIndex == aCurrentTabIndex)) {
continue;
}
if (!IsHostOrSlot(iterContent)) {
nsCOMPtr<nsIContent> elementInFrame;
bool checkSubDocument = true;
if (aForDocumentNavigation &&
TryDocumentNavigation(iterContent, &checkSubDocument,
getter_AddRefs(elementInFrame))) {
return elementInFrame;
}
if (!checkSubDocument) {
if (aReachedToEndForDocumentNavigation &&
nsContentUtils::IsChromeDoc(iterContent->GetComposedDoc())) {
// aReachedToEndForDocumentNavigation is true means
// 1. This is a document navigation (i.e, VK_F6, Control + Tab)
// 2. This is the top-level document (Note that we may start from
// a subdocument)
// 3. We've searched through the this top-level document already
if (!GetRootForChildDocument(iterContent)) {
// We'd like to focus the first focusable element of this
// top-level chrome document.
return iterContent;
}
}
continue;
}
if (TryToMoveFocusToSubDocument(iterContent, aOriginalStartContent,
aForward, aForDocumentNavigation,
aNavigateByKey,
aReachedToEndForDocumentNavigation,
getter_AddRefs(elementInFrame))) {
return elementInFrame;
}
// Found content to focus
return iterContent;
}
// Search in scope owned by iterContent
nsIContent* contentToFocus = GetNextTabbableContentInScope(
iterContent, iterContent, aOriginalStartContent, aForward,
aForward ? 1 : 0, aIgnoreTabIndex, aForDocumentNavigation,
aNavigateByKey, false /* aSkipOwner */,
aReachedToEndForDocumentNavigation);
if (contentToFocus) {
return contentToFocus;
}
};
// If already at lowest priority tab (0), end search completely.
// A bit counterintuitive but true, tabindex order goes 1, 2, ... 32767, 0
if (aCurrentTabIndex == (aForward ? 0 : 1)) {
break;
}
// We've been just trying to find some focusable element, and haven't, so
// bail out.
if (aIgnoreTabIndex) {
break;
}
// Continue looking for next highest priority tabindex
aCurrentTabIndex = GetNextTabIndex(aOwner, aCurrentTabIndex, aForward);
contentTraversal.Reset();
}
// Return scope owner at last for backward navigation if its tabindex
// is non-negative
if (!aSkipOwner && !aForward) {
if (nsIFrame* frame = aOwner->GetPrimaryFrame()) {
auto focusable = frame->IsFocusable();
if (focusable && focusable.mTabIndex >= 0) {
return aOwner;
}
}
}
return nullptr;
}
nsIContent* nsFocusManager::GetNextTabbableContentInAncestorScopes(
nsIContent* aStartOwner, nsCOMPtr<nsIContent>& aStartContent /* inout */,
nsIContent* aOriginalStartContent, bool aForward, int32_t* aCurrentTabIndex,
bool* aIgnoreTabIndex, bool aForDocumentNavigation, bool aNavigateByKey,
bool aReachedToEndForDocumentNavigation) {
MOZ_ASSERT(aStartOwner == FindScopeOwner(aStartContent),
"aStartOWner should be the scope owner of aStartContent");
MOZ_ASSERT(IsHostOrSlot(aStartOwner), "scope owner should be host or slot");
nsCOMPtr<nsIContent> owner = aStartOwner;
nsCOMPtr<nsIContent> startContent = aStartContent;
while (IsHostOrSlot(owner)) {
int32_t tabIndex = 0;
if (IsHostOrSlot(startContent)) {
tabIndex = HostOrSlotTabIndexValue(startContent);
} else if (nsIFrame* frame = startContent->GetPrimaryFrame()) {
tabIndex = frame->IsFocusable().mTabIndex;
} else {
tabIndex = startContent->IsFocusableWithoutStyle().mTabIndex;
}
nsIContent* contentToFocus = GetNextTabbableContentInScope(
owner, startContent, aOriginalStartContent, aForward, tabIndex,
tabIndex < 0, aForDocumentNavigation, aNavigateByKey,
false /* aSkipOwner */, aReachedToEndForDocumentNavigation);
if (contentToFocus) {
return contentToFocus;
}
startContent = owner;
owner = FindScopeOwner(startContent);
}
// If not found in shadow DOM, search from the top level shadow host in light
// DOM
aStartContent = startContent;
*aCurrentTabIndex = HostOrSlotTabIndexValue(startContent);
if (*aCurrentTabIndex < 0) {
*aIgnoreTabIndex = true;
}
return nullptr;
}
static nsIContent* GetTopLevelScopeOwner(nsIContent* aContent) {
nsIContent* topLevelScopeOwner = nullptr;
while (aContent) {
if (HTMLSlotElement* slot = aContent->GetAssignedSlot()) {
aContent = slot;
topLevelScopeOwner = aContent;
} else if (ShadowRoot* shadowRoot = aContent->GetContainingShadow()) {
aContent = shadowRoot->Host();
topLevelScopeOwner = aContent;
} else {
aContent = aContent->GetParent();
if (aContent && (HTMLSlotElement::FromNode(aContent) ||
IsOpenPopoverWithInvoker(aContent))) {
topLevelScopeOwner = aContent;
}
}
}
return topLevelScopeOwner;
}
nsresult nsFocusManager::GetNextTabbableContent(
PresShell* aPresShell, nsIContent* aRootContent,
nsIContent* aOriginalStartContent, nsIContent* aStartContent, bool aForward,
int32_t aCurrentTabIndex, bool aIgnoreTabIndex, bool aForDocumentNavigation,
bool aNavigateByKey, bool aSkipPopover,
bool aReachedToEndForDocumentNavigation, nsIContent** aResultContent) {
*aResultContent = nullptr;
if (!aStartContent) {
return NS_OK;
}
nsCOMPtr<nsIContent> startContent = aStartContent;
nsCOMPtr<nsIContent> currentTopLevelScopeOwner =
GetTopLevelScopeOwner(startContent);
LOGCONTENTNAVIGATION("GetNextTabbable: %s", startContent);
LOGFOCUSNAVIGATION((" tabindex: %d", aCurrentTabIndex));
// If startContent is a shadow host or slot in forward navigation,
// search in scope owned by startContent
if (aForward && IsHostOrSlot(startContent)) {
nsIContent* contentToFocus = GetNextTabbableContentInScope(
startContent, startContent, aOriginalStartContent, aForward, 1,
aIgnoreTabIndex, aForDocumentNavigation, aNavigateByKey,
true /* aSkipOwner */, aReachedToEndForDocumentNavigation);
if (contentToFocus) {
NS_ADDREF(*aResultContent = contentToFocus);
return NS_OK;
}
}
// If startContent is a popover invoker, search the popover scope.
if (!aSkipPopover) {
if (InvokerForPopoverShowingState(startContent)) {
if (aForward) {
RefPtr<nsIContent> popover =
startContent->GetEffectivePopoverTargetElement();
nsIContent* contentToFocus = GetNextTabbableContentInScope(
popover, popover, aOriginalStartContent, aForward, 1,
aIgnoreTabIndex, aForDocumentNavigation, aNavigateByKey,
true /* aSkipOwner */, aReachedToEndForDocumentNavigation);
if (contentToFocus) {
NS_ADDREF(*aResultContent = contentToFocus);
return NS_OK;
}
}
}
}
// If startContent is in a scope owned by Shadow DOM search from scope
// including startContent
if (nsCOMPtr<nsIContent> owner = FindScopeOwner(startContent)) {
nsIContent* contentToFocus = GetNextTabbableContentInAncestorScopes(
owner, startContent /* inout */, aOriginalStartContent, aForward,
&aCurrentTabIndex, &aIgnoreTabIndex, aForDocumentNavigation,
aNavigateByKey, aReachedToEndForDocumentNavigation);
if (contentToFocus) {
NS_ADDREF(*aResultContent = contentToFocus);
return NS_OK;
}
}
// If we reach here, it means no next tabbable content in shadow DOM.
// We need to continue searching in light DOM, starting at the top level
// shadow host in light DOM (updated startContent) and its tabindex
// (updated aCurrentTabIndex).
MOZ_ASSERT(!FindScopeOwner(startContent),
"startContent should not be owned by Shadow DOM at this point");
nsPresContext* presContext = aPresShell->GetPresContext();
bool getNextFrame = true;
nsCOMPtr<nsIContent> iterStartContent = startContent;
nsIContent* topLevelScopeStartContent = startContent;
// Iterate tab index to find corresponding contents
while (1) {
nsIFrame* frame = iterStartContent->GetPrimaryFrame();
// if there is no frame, look for another content node that has a frame
while (!frame) {
// if the root content doesn't have a frame, just return
if (iterStartContent == aRootContent) {
return NS_OK;
}
// look for the next or previous content node in tree order
iterStartContent = aForward ? iterStartContent->GetNextNode()
: iterStartContent->GetPrevNode();
if (!iterStartContent) {
break;
}
frame = iterStartContent->GetPrimaryFrame();
// Host without frame, enter its scope.
if (!frame && iterStartContent->GetShadowRoot()) {
int32_t tabIndex = HostOrSlotTabIndexValue(iterStartContent);
if (tabIndex >= 0 &&
(aIgnoreTabIndex || aCurrentTabIndex == tabIndex)) {
nsIContent* contentToFocus = GetNextTabbableContentInScope(
iterStartContent, iterStartContent, aOriginalStartContent,
aForward, aForward ? 1 : 0, aIgnoreTabIndex,
aForDocumentNavigation, aNavigateByKey, true /* aSkipOwner */,
aReachedToEndForDocumentNavigation);
if (contentToFocus) {
NS_ADDREF(*aResultContent = contentToFocus);
return NS_OK;
}
}
}
// we've already skipped over the initial focused content, so we
// don't want to traverse frames.
getNextFrame = false;
}
Maybe<nsFrameIterator> frameIterator;
if (frame) {
// For tab navigation, pass false for aSkipPopupChecks so that we don't
// iterate into or out of a popup. For document naviation pass true to
// ignore these boundaries.
frameIterator.emplace(presContext, frame, nsFrameIterator::Type::PreOrder,
false, // aVisual
false, // aLockInScrollView
true, // aFollowOOFs
aForDocumentNavigation // aSkipPopupChecks
);
MOZ_ASSERT(frameIterator);
if (iterStartContent == aRootContent) {
if (!aForward) {
frameIterator->Last();
} else if (aRootContent->IsFocusableWithoutStyle()) {
frameIterator->Next();
}
frame = frameIterator->CurrentItem();
} else if (getNextFrame &&
(!iterStartContent ||
!iterStartContent->IsHTMLElement(nsGkAtoms::area))) {
// Need to do special check in case we're in an imagemap which has
// multiple content nodes per frame, so don't skip over the starting
// frame.
frame = frameIterator->Traverse(aForward);
}
}
nsIContent* oldTopLevelScopeOwner = nullptr;
// Walk frames to find something tabbable matching aCurrentTabIndex
while (frame) {
// Try to find the topmost scope owner, since we want to skip the node
// that is not owned by document in frame traversal.
const nsCOMPtr<nsIContent> currentContent = frame->GetContent();
if (currentTopLevelScopeOwner) {
oldTopLevelScopeOwner = currentTopLevelScopeOwner;
}
currentTopLevelScopeOwner = GetTopLevelScopeOwner(currentContent);
// We handle popover case separately.
if (currentTopLevelScopeOwner &&
currentTopLevelScopeOwner == oldTopLevelScopeOwner &&
!IsOpenPopoverWithInvoker(currentTopLevelScopeOwner)) {
// We're within non-document scope, continue.
do {
if (aForward) {
frameIterator->Next();
} else {
frameIterator->Prev();
}
frame = frameIterator->CurrentItem();
// For the usage of GetPrevContinuation, see the comment
// at the end of while (frame) loop.
} while (frame && frame->GetPrevContinuation());
continue;
}
// Stepping out popover scope.
// For forward, search for the next tabbable content after invoker.
// For backward, we should get back to the invoker if the invoker is
// focusable. Otherwise search for the next tabbable content after
// invoker.
if (oldTopLevelScopeOwner &&
IsOpenPopoverWithInvoker(oldTopLevelScopeOwner) &&
currentTopLevelScopeOwner != oldTopLevelScopeOwner) {
auto* popover = oldTopLevelScopeOwner->AsElement();
RefPtr<Element> invoker = popover->GetPopoverData()->GetInvoker();
MOZ_ASSERT(invoker, "IsOpenPopoverWithInvoker guarantees this");
RefPtr<Element> rootElement = invoker;
if (auto* doc = invoker->GetComposedDoc()) {
rootElement = doc->GetRootElement();
}
if (aForward) {
if (nsIFrame* frame = invoker->GetPrimaryFrame()) {
int32_t tabIndex = frame->IsFocusable().mTabIndex;
if (tabIndex >= 0 &&
(aIgnoreTabIndex || aCurrentTabIndex == tabIndex)) {
nsresult rv = GetNextTabbableContent(
aPresShell, rootElement, nullptr, invoker, true, tabIndex,
false, false, aNavigateByKey, true,
aReachedToEndForDocumentNavigation, aResultContent);
if (NS_SUCCEEDED(rv) && *aResultContent) {
return rv;
}
}
}
} else if (invoker) {
nsIFrame* frame = invoker->GetPrimaryFrame();
if (frame && frame->IsFocusable()) {
invoker.forget(aResultContent);
return NS_OK;
}
nsresult rv = GetNextTabbableContent(
aPresShell, rootElement, aOriginalStartContent, invoker, false, 0,
true, false, aNavigateByKey, true,
aReachedToEndForDocumentNavigation, aResultContent);
if (NS_SUCCEEDED(rv) && *aResultContent) {
return rv;
}
}
}
if (!aForward && InvokerForPopoverShowingState(currentContent)) {
int32_t tabIndex = frame->IsFocusable().mTabIndex;
if (tabIndex >= 0 &&
(aIgnoreTabIndex || aCurrentTabIndex == tabIndex)) {
RefPtr<nsIContent> popover =
currentContent->GetEffectivePopoverTargetElement();
nsIContent* contentToFocus = GetNextTabbableContentInScope(
popover, popover, aOriginalStartContent, aForward, 0,
aIgnoreTabIndex, aForDocumentNavigation, aNavigateByKey,
true /* aSkipOwner */, aReachedToEndForDocumentNavigation);
if (contentToFocus) {
NS_ADDREF(*aResultContent = contentToFocus);
return NS_OK;
}
}
}
// For document navigation, check if this element is an open panel. Since
// panels aren't focusable (tabIndex would be -1), we'll just assume that
// for document navigation, the tabIndex is 0.
if (aForDocumentNavigation && currentContent && (aCurrentTabIndex == 0) &&
currentContent->IsXULElement(nsGkAtoms::panel)) {
nsMenuPopupFrame* popupFrame = do_QueryFrame(frame);
// Check if the panel is open. Closed panels are ignored since you can't
// focus anything in them.
if (popupFrame && popupFrame->IsOpen()) {
// When moving backward, skip the popup we started in otherwise it
// will be selected again.
bool validPopup = true;
if (!aForward) {
nsIContent* content = topLevelScopeStartContent;
while (content) {
if (content == currentContent) {
validPopup = false;
break;
}
content = content->GetParent();
}
}
if (validPopup) {
// Since a panel isn't focusable itself, find the first focusable
// content within the popup. If there isn't any focusable content
// in the popup, skip this popup and continue iterating through the
// frames. We pass the panel itself (currentContent) as the starting
// and root content, so that we only find content within the panel.
// Note also that we pass false for aForDocumentNavigation since we
// want to locate the first content, not the first document.
nsresult rv = GetNextTabbableContent(
aPresShell, currentContent, nullptr, currentContent, true, 1,
false, false, aNavigateByKey, false,
aReachedToEndForDocumentNavigation, aResultContent);
if (NS_SUCCEEDED(rv) && *aResultContent) {
return rv;
}
}
}
}
// As of now, 2018/04/12, sequential focus navigation is still
// in the obsolete Shadow DOM specification.
// http://w3c.github.io/webcomponents/spec/shadow/#sequential-focus-navigation
// "if ELEMENT is focusable, a shadow host, or a slot element,
// append ELEMENT to NAVIGATION-ORDER."
// and later in "For each element ELEMENT in NAVIGATION-ORDER: "
// hosts and slots are handled before other elements.
if (currentTopLevelScopeOwner &&
!IsOpenPopoverWithInvoker(currentTopLevelScopeOwner)) {
bool focusableHostSlot;
int32_t tabIndex = HostOrSlotTabIndexValue(currentTopLevelScopeOwner,
&focusableHostSlot);
// Host or slot itself isn't focusable or going backwards, enter its
// scope.
if ((!aForward || !focusableHostSlot) && tabIndex >= 0 &&
(aIgnoreTabIndex || aCurrentTabIndex == tabIndex)) {
nsIContent* contentToFocus = GetNextTabbableContentInScope(
currentTopLevelScopeOwner, currentTopLevelScopeOwner,
aOriginalStartContent, aForward, aForward ? 1 : 0,
aIgnoreTabIndex, aForDocumentNavigation, aNavigateByKey,
true /* aSkipOwner */, aReachedToEndForDocumentNavigation);
if (contentToFocus) {
NS_ADDREF(*aResultContent = contentToFocus);
return NS_OK;
}
// If we've wrapped around already, then carry on.
if (aOriginalStartContent &&
currentTopLevelScopeOwner ==
GetTopLevelScopeOwner(aOriginalStartContent)) {
// FIXME: Shouldn't this return null instead? aOriginalStartContent
// isn't focusable after all.
NS_ADDREF(*aResultContent = aOriginalStartContent);
return NS_OK;
}
}
// There is no next tabbable content in currentTopLevelScopeOwner's
// scope. We should continue the loop in order to skip all contents that
// is in currentTopLevelScopeOwner's scope.
continue;
}
MOZ_ASSERT(
!GetTopLevelScopeOwner(currentContent) ||
IsOpenPopoverWithInvoker(GetTopLevelScopeOwner(currentContent)),
"currentContent should be in top-level-scope at this point unless "
"for popover case");
// TabIndex not set defaults to 0 for form elements, anchors and other
// elements that are normally focusable. Tabindex defaults to -1
// for elements that are not normally focusable.
// The returned computed tabindex from IsFocusable() is as follows:
// clang-format off
// < 0 not tabbable at all
// == 0 in normal tab order (last after positive tabindexed items)
// > 0 can be tabbed to in the order specified by this value
// clang-format on
int32_t tabIndex = frame->IsFocusable().mTabIndex;
LOGCONTENTNAVIGATION("Next Tabbable %s:", frame->GetContent());
LOGFOCUSNAVIGATION(
(" with tabindex: %d expected: %d", tabIndex, aCurrentTabIndex));
if (tabIndex >= 0) {
NS_ASSERTION(currentContent,
"IsFocusable set a tabindex for a frame with no content");
if (!aForDocumentNavigation &&
currentContent->IsHTMLElement(nsGkAtoms::img) &&
currentContent->AsElement()->HasAttr(nsGkAtoms::usemap)) {
// This is an image with a map. Image map areas are not traversed by
// nsFrameIterator so look for the next or previous area element.
nsIContent* areaContent = GetNextTabbableMapArea(
aForward, aCurrentTabIndex, currentContent->AsElement(),
iterStartContent);
if (areaContent) {
NS_ADDREF(*aResultContent = areaContent);
return NS_OK;
}
} else if (aIgnoreTabIndex || aCurrentTabIndex == tabIndex) {
// break out if we've wrapped around to the start again.
if (aOriginalStartContent &&
currentContent == aOriginalStartContent) {
NS_ADDREF(*aResultContent = currentContent);
return NS_OK;
}
// If this is a remote child browser, call NavigateDocument to have
// the child process continue the navigation. Return a special error
// code to have the caller return early. If the child ends up not
// being focusable in some way, the child process will call back
// into document navigation again by calling MoveFocus.
if (BrowserParent* remote = BrowserParent::GetFrom(currentContent)) {
if (aNavigateByKey) {
remote->NavigateByKey(aForward, aForDocumentNavigation);
return NS_SUCCESS_DOM_NO_OPERATION;
}
return NS_OK;
}
// Same as above but for out-of-process iframes
if (auto* bbc = BrowserBridgeChild::GetFrom(currentContent)) {
if (aNavigateByKey) {
bbc->NavigateByKey(aForward, aForDocumentNavigation);
return NS_SUCCESS_DOM_NO_OPERATION;
}
return NS_OK;
}
// Next, for document navigation, check if this a non-remote child
// document.
bool checkSubDocument = true;
if (aForDocumentNavigation &&
TryDocumentNavigation(currentContent, &checkSubDocument,
aResultContent)) {
return NS_OK;
}
if (checkSubDocument) {
// found a node with a matching tab index. Check if it is a child
// frame. If so, navigate into the child frame instead.
if (TryToMoveFocusToSubDocument(
currentContent, aOriginalStartContent, aForward,
aForDocumentNavigation, aNavigateByKey,
aReachedToEndForDocumentNavigation, aResultContent)) {
MOZ_ASSERT(*aResultContent);
return NS_OK;
}
// otherwise, use this as the next content node to tab to, unless
// this was the element we started on. This would happen for
// instance on an element with child frames, where frame navigation
// could return the original element again. In that case, just skip
// it. Also, if the next content node is the root content, then
// return it. This latter case would happen only if someone made a
// popup focusable.
else if (currentContent == aRootContent ||
currentContent != startContent) {
NS_ADDREF(*aResultContent = currentContent);
return NS_OK;
}
} else if (currentContent && aReachedToEndForDocumentNavigation &&
nsContentUtils::IsChromeDoc(
currentContent->GetComposedDoc())) {
// aReachedToEndForDocumentNavigation is true means
// 1. This is a document navigation (i.e, VK_F6, Control + Tab)
// 2. This is the top-level document (Note that we may start from
// a subdocument)
// 3. We've searched through the this top-level document already
if (!GetRootForChildDocument(currentContent)) {
// We'd like to focus the first focusable element of this
// top-level chrome document.
if (currentContent == aRootContent ||
currentContent != startContent) {
NS_ADDREF(*aResultContent = currentContent);
return NS_OK;
}
}
}
}
} else if (aOriginalStartContent &&
currentContent == aOriginalStartContent) {
// not focusable, so return if we have wrapped around to the original
// content. This is necessary in case the original starting content was
// not focusable.
//
// FIXME: Shouldn't this return null instead? currentContent isn't
// focusable after all.
NS_ADDREF(*aResultContent = currentContent);
return NS_OK;
}
// Move to the next or previous frame, but ignore continuation frames
// since only the first frame should be involved in focusability.
// Otherwise, a loop will occur in the following example:
// <span tabindex="1">...<a/><a/>...</span>
// where the text wraps onto multiple lines. Tabbing from the second
// link can find one of the span's continuation frames between the link
// and the end of the span, and the span would end up getting focused
// again.
do {
if (aForward) {
frameIterator->Next();
} else {
frameIterator->Prev();
}
frame = frameIterator->CurrentItem();
} while (frame && frame->GetPrevContinuation());
}
// If already at lowest priority tab (0), end search completely.
// A bit counterintuitive but true, tabindex order goes 1, 2, ... 32767, 0
if (aCurrentTabIndex == (aForward ? 0 : 1)) {
break;
}
// continue looking for next highest priority tabindex
aCurrentTabIndex =
GetNextTabIndex(aRootContent, aCurrentTabIndex, aForward);
startContent = iterStartContent = aRootContent;
currentTopLevelScopeOwner = GetTopLevelScopeOwner(startContent);
}
return NS_OK;
}
bool nsFocusManager::TryDocumentNavigation(nsIContent* aCurrentContent,
bool* aCheckSubDocument,
nsIContent** aResultContent) {
*aCheckSubDocument = true;
if (RefPtr<Element> rootElementForChildDocument =
GetRootForChildDocument(aCurrentContent)) {
// If GetRootForChildDocument returned something then call
// FocusFirst to find the root or first element to focus within
// the child document. If this is a frameset though, skip this and
// fall through to normal tab navigation to iterate into
// the frameset's frames and locate the first focusable frame.
if (!rootElementForChildDocument->IsHTMLElement(nsGkAtoms::frameset)) {
*aCheckSubDocument = false;
Unused << FocusFirst(rootElementForChildDocument, aResultContent,
false /* aReachedToEndForDocumentNavigation */);
return *aResultContent != nullptr;
}
} else {
// Set aCheckSubDocument to false, as this was neither a frame
// type element or a child document that was focusable.
*aCheckSubDocument = false;
}
return false;
}
bool nsFocusManager::TryToMoveFocusToSubDocument(
nsIContent* aCurrentContent, nsIContent* aOriginalStartContent,
bool aForward, bool aForDocumentNavigation, bool aNavigateByKey,
bool aReachedToEndForDocumentNavigation, nsIContent** aResultContent) {
Document* doc = aCurrentContent->GetComposedDoc();
NS_ASSERTION(doc, "content not in document");
Document* subdoc = doc->GetSubDocumentFor(aCurrentContent);
if (subdoc && !subdoc->EventHandlingSuppressed()) {
if (RefPtr<Element> rootElement = subdoc->GetRootElement()) {
if (RefPtr<PresShell> subPresShell = subdoc->GetPresShell()) {
nsresult rv = GetNextTabbableContent(
subPresShell, rootElement, aOriginalStartContent, rootElement,
aForward, (aForward ? 1 : 0), false, aForDocumentNavigation,
aNavigateByKey, false, aReachedToEndForDocumentNavigation,
aResultContent);
NS_ENSURE_SUCCESS(rv, false);
if (*aResultContent) {
return true;
}
if (rootElement->IsEditable()) {
// Only move to the root element with a valid reason
*aResultContent = rootElement;
NS_ADDREF(*aResultContent);
return true;
}
}
}
}
return false;
}
nsIContent* nsFocusManager::GetNextTabbableMapArea(bool aForward,
int32_t aCurrentTabIndex,
Element* aImageContent,
nsIContent* aStartContent) {
if (aImageContent->IsInComposedDoc()) {
HTMLImageElement* imgElement = HTMLImageElement::FromNode(aImageContent);
// The caller should check the element type, so we can assert here.
MOZ_ASSERT(imgElement);
nsCOMPtr<nsIContent> mapContent = imgElement->FindImageMap();
if (!mapContent) {
return nullptr;
}
// First see if the the start content is in this map
Maybe<uint32_t> indexOfStartContent =
mapContent->ComputeIndexOf(aStartContent);
nsIContent* scanStartContent;
Focusable focusable;
if (indexOfStartContent.isNothing() ||
((focusable = aStartContent->IsFocusableWithoutStyle()) &&
focusable.mTabIndex != aCurrentTabIndex)) {
// If aStartContent is in this map we must start iterating past it.
// We skip the case where aStartContent has tabindex == aStartContent
// since the next tab ordered element might be before it
// (or after for backwards) in the child list.
scanStartContent =
aForward ? mapContent->GetFirstChild() : mapContent->GetLastChild();
} else {
scanStartContent = aForward ? aStartContent->GetNextSibling()
: aStartContent->GetPreviousSibling();
}
for (nsCOMPtr<nsIContent> areaContent = scanStartContent; areaContent;
areaContent = aForward ? areaContent->GetNextSibling()
: areaContent->GetPreviousSibling()) {
focusable = areaContent->IsFocusableWithoutStyle();
if (focusable && focusable.mTabIndex == aCurrentTabIndex) {
return areaContent;
}
}
}
return nullptr;
}
int32_t nsFocusManager::GetNextTabIndex(nsIContent* aParent,
int32_t aCurrentTabIndex,
bool aForward) {
int32_t tabIndex, childTabIndex;
StyleChildrenIterator iter(aParent);
if (aForward) {
tabIndex = 0;
for (nsIContent* child = iter.GetNextChild(); child;
child = iter.GetNextChild()) {
// Skip child's descendants if child is a shadow host or slot, as they are
// in the focus navigation scope owned by child's shadow root
if (!IsHostOrSlot(child)) {
childTabIndex = GetNextTabIndex(child, aCurrentTabIndex, aForward);
if (childTabIndex > aCurrentTabIndex && childTabIndex != tabIndex) {
tabIndex = (tabIndex == 0 || childTabIndex < tabIndex) ? childTabIndex
: tabIndex;
}
}
nsAutoString tabIndexStr;
if (child->IsElement()) {
child->AsElement()->GetAttr(nsGkAtoms::tabindex, tabIndexStr);
}
nsresult ec;
int32_t val = tabIndexStr.ToInteger(&ec);
if (NS_SUCCEEDED(ec) && val > aCurrentTabIndex && val != tabIndex) {
tabIndex = (tabIndex == 0 || val < tabIndex) ? val : tabIndex;
}
}
} else { /* !aForward */
tabIndex = 1;
for (nsIContent* child = iter.GetNextChild(); child;
child = iter.GetNextChild()) {
// Skip child's descendants if child is a shadow host or slot, as they are
// in the focus navigation scope owned by child's shadow root
if (!IsHostOrSlot(child)) {
childTabIndex = GetNextTabIndex(child, aCurrentTabIndex, aForward);
if ((aCurrentTabIndex == 0 && childTabIndex > tabIndex) ||
(childTabIndex < aCurrentTabIndex && childTabIndex > tabIndex)) {
tabIndex = childTabIndex;
}
}
nsAutoString tabIndexStr;
if (child->IsElement()) {
child->AsElement()->GetAttr(nsGkAtoms::tabindex, tabIndexStr);
}
nsresult ec;
int32_t val = tabIndexStr.ToInteger(&ec);
if (NS_SUCCEEDED(ec)) {
if ((aCurrentTabIndex == 0 && val > tabIndex) ||
(val < aCurrentTabIndex && val > tabIndex)) {
tabIndex = val;
}
}
}
}
return tabIndex;
}
nsresult nsFocusManager::FocusFirst(Element* aRootElement,
nsIContent** aNextContent,
bool aReachedToEndForDocumentNavigation) {
if (!aRootElement) {
return NS_OK;
}
Document* doc = aRootElement->GetComposedDoc();
if (doc) {
if (nsContentUtils::IsChromeDoc(doc)) {
// If the redirectdocumentfocus attribute is set, redirect the focus to a
// specific element. This is primarily used to retarget the focus to the
// urlbar during document navigation.
nsAutoString retarget;
if (aRootElement->GetAttr(nsGkAtoms::retargetdocumentfocus, retarget)) {
RefPtr<Element> element = doc->GetElementById(retarget);
nsCOMPtr<nsIContent> retargetElement =
FlushAndCheckIfFocusable(element, 0);
if (retargetElement) {
retargetElement.forget(aNextContent);
return NS_OK;
}
}
}
nsCOMPtr<nsIDocShell> docShell = doc->GetDocShell();
if (docShell->ItemType() == nsIDocShellTreeItem::typeChrome) {
// If the found content is in a chrome shell, navigate forward one
// tabbable item so that the first item is focused. Note that we
// always go forward and not back here.
if (RefPtr<PresShell> presShell = doc->GetPresShell()) {
return GetNextTabbableContent(
presShell, aRootElement, nullptr, aRootElement, true, 1, false,
aReachedToEndForDocumentNavigation, true, false,
aReachedToEndForDocumentNavigation, aNextContent);
}
}
}
NS_ADDREF(*aNextContent = aRootElement);
return NS_OK;
}
Element* nsFocusManager::GetRootForFocus(nsPIDOMWindowOuter* aWindow,
Document* aDocument,
bool aForDocumentNavigation,
bool aCheckVisibility) {
if (!aForDocumentNavigation) {
nsCOMPtr<nsIDocShell> docShell = aWindow->GetDocShell();
if (docShell->ItemType() == nsIDocShellTreeItem::typeChrome) {
return nullptr;
}
}
if (aCheckVisibility && !IsWindowVisible(aWindow)) return nullptr;
// If the body is contenteditable, use the editor's root element rather than
// the actual root element.
RefPtr<Element> rootElement =
nsLayoutUtils::GetEditableRootContentByContentEditable(aDocument);
if (!rootElement || !rootElement->GetPrimaryFrame()) {
rootElement = aDocument->GetRootElement();
if (!rootElement) {
return nullptr;
}
}
if (aCheckVisibility && !rootElement->GetPrimaryFrame()) {
return nullptr;
}
// Finally, check if this is a frameset
if (aDocument && aDocument->IsHTMLOrXHTML()) {
Element* htmlChild = aDocument->GetHtmlChildElement(nsGkAtoms::frameset);
if (htmlChild) {
// In document navigation mode, return the frameset so that navigation
// descends into the child frames.
return aForDocumentNavigation ? htmlChild : nullptr;
}
}
return rootElement;
}
Element* nsFocusManager::GetRootForChildDocument(nsIContent* aContent) {
// Check for elements that represent child documents, that is, browsers,
// editors or frames from a frameset. We don't include iframes since we
// consider them to be an integral part of the same window or page.
if (!aContent || !(aContent->IsXULElement(nsGkAtoms::browser) ||
aContent->IsXULElement(nsGkAtoms::editor) ||
aContent->IsHTMLElement(nsGkAtoms::frame))) {
return nullptr;
}
Document* doc = aContent->GetComposedDoc();
if (!doc) {
return nullptr;
}
Document* subdoc = doc->GetSubDocumentFor(aContent);
if (!subdoc || subdoc->EventHandlingSuppressed()) {
return nullptr;
}
nsCOMPtr<nsPIDOMWindowOuter> window = subdoc->GetWindow();
return GetRootForFocus(window, subdoc, true, true);
}
static bool IsLink(nsIContent* aContent) {
return aContent->IsElement() && aContent->AsElement()->IsLink();
}
void nsFocusManager::GetFocusInSelection(nsPIDOMWindowOuter* aWindow,
nsIContent* aStartSelection,
nsIContent* aEndSelection,
nsIContent** aFocusedContent) {
*aFocusedContent = nullptr;
nsCOMPtr<nsIContent> testContent = aStartSelection;
nsCOMPtr<nsIContent> nextTestContent = aEndSelection;
nsCOMPtr<nsIContent> currentFocus = aWindow->GetFocusedElement();
// We now have the correct start node in selectionContent!
// Search for focusable elements, starting with selectionContent
// Method #1: Keep going up while we look - an ancestor might be focusable
// We could end the loop earlier, such as when we're no longer
// in the same frame, by comparing selectionContent->GetPrimaryFrame()
// with a variable holding the starting selectionContent
while (testContent) {
// Keep testing while selectionContent is equal to something,
// eventually we'll run out of ancestors
if (testContent == currentFocus || IsLink(testContent)) {
testContent.forget(aFocusedContent);
return;
}
// Get the parent
testContent = testContent->GetParent();
if (!testContent) {
// We run this loop again, checking the ancestor chain of the selection's
// end point
testContent = nextTestContent;
nextTestContent = nullptr;
}
}
// We couldn't find an anchor that was an ancestor of the selection start
// Method #2: look for anchor in selection's primary range (depth first
// search)
nsCOMPtr<nsIContent> selectionNode = aStartSelection;
nsCOMPtr<nsIContent> endSelectionNode = aEndSelection;
nsCOMPtr<nsIContent> testNode;
do {
testContent = selectionNode;
// We're looking for any focusable link that could be part of the
// main document's selection.
if (testContent == currentFocus || IsLink(testContent)) {
testContent.forget(aFocusedContent);
return;
}
nsIContent* testNode = selectionNode->GetFirstChild();
if (testNode) {
selectionNode = testNode;
continue;
}
if (selectionNode == endSelectionNode) {
break;
}
testNode = selectionNode->GetNextSibling();
if (testNode) {
selectionNode = testNode;
continue;
}
do {
// GetParent is OK here, instead of GetParentNode, because the only case
// where the latter returns something different from the former is when
// GetParentNode is the document. But in that case we would simply get
// null for selectionNode when setting it to testNode->GetNextSibling()
// (because a document has no next sibling). And then the next iteration
// of this loop would get null for GetParentNode anyway, and break out of
// all the loops.
testNode = selectionNode->GetParent();
if (!testNode || testNode == endSelectionNode) {
selectionNode = nullptr;
break;
}
selectionNode = testNode->GetNextSibling();
if (selectionNode) {
break;
}
selectionNode = testNode;
} while (true);
} while (selectionNode && selectionNode != endSelectionNode);
}
static void MaybeUnlockPointer(BrowsingContext* aCurrentFocusedContext) {
if (!PointerLockManager::IsInLockContext(aCurrentFocusedContext)) {
PointerLockManager::Unlock("FocusChange");
}
}
class PointerUnlocker : public Runnable {
public:
PointerUnlocker() : mozilla::Runnable("PointerUnlocker") {
MOZ_ASSERT(XRE_IsParentProcess());
MOZ_ASSERT(!PointerUnlocker::sActiveUnlocker);
PointerUnlocker::sActiveUnlocker = this;
}
~PointerUnlocker() {
if (PointerUnlocker::sActiveUnlocker == this) {
PointerUnlocker::sActiveUnlocker = nullptr;
}
}
NS_IMETHOD Run() override {
if (PointerUnlocker::sActiveUnlocker == this) {
PointerUnlocker::sActiveUnlocker = nullptr;
}
NS_ENSURE_STATE(nsFocusManager::GetFocusManager());
nsPIDOMWindowOuter* focused =
nsFocusManager::GetFocusManager()->GetFocusedWindow();
MaybeUnlockPointer(focused ? focused->GetBrowsingContext() : nullptr);
return NS_OK;
}
static PointerUnlocker* sActiveUnlocker;
};
PointerUnlocker* PointerUnlocker::sActiveUnlocker = nullptr;
void nsFocusManager::SetFocusedBrowsingContext(BrowsingContext* aContext,
uint64_t aActionId) {
if (XRE_IsParentProcess()) {
return;
}
MOZ_ASSERT(!ActionIdComparableAndLower(
aActionId, mActionIdForFocusedBrowsingContextInContent));
mFocusedBrowsingContextInContent = aContext;
mActionIdForFocusedBrowsingContextInContent = aActionId;
if (aContext) {
// We don't send the unset but instead expect the set from
// elsewhere to take care of it. XXX Is that bad?
MOZ_ASSERT(aContext->IsInProcess());
mozilla::dom::ContentChild* contentChild =
mozilla::dom::ContentChild::GetSingleton();
MOZ_ASSERT(contentChild);
contentChild->SendSetFocusedBrowsingContext(aContext, aActionId);
}
}
void nsFocusManager::SetFocusedBrowsingContextFromOtherProcess(
BrowsingContext* aContext, uint64_t aActionId) {
MOZ_ASSERT(!XRE_IsParentProcess());
MOZ_ASSERT(aContext);
if (ActionIdComparableAndLower(aActionId,
mActionIdForFocusedBrowsingContextInContent)) {
// Unclear if this ever happens.
LOGFOCUS(
("Ignored an attempt to set an in-process BrowsingContext [%p] as "
"focused from another process due to stale action id %" PRIu64 ".",
aContext, aActionId));
return;
}
if (aContext->IsInProcess()) {
// This message has been in transit for long enough that
// the process association of aContext has changed since
// the other content process sent the message, because
// an iframe in that process became an out-of-process
// iframe while the IPC broadcast that we're receiving
// was in-flight. Let's just ignore this.
LOGFOCUS(
("Ignored an attempt to set an in-process BrowsingContext [%p] as "
"focused from another process, actionid: %" PRIu64 ".",
aContext, aActionId));
return;
}
mFocusedBrowsingContextInContent = aContext;
mActionIdForFocusedBrowsingContextInContent = aActionId;
mFocusedElement = nullptr;
mFocusedWindow = nullptr;
}
bool nsFocusManager::SetFocusedBrowsingContextInChrome(
mozilla::dom::BrowsingContext* aContext, uint64_t aActionId) {
MOZ_ASSERT(aActionId);
if (ProcessPendingFocusedBrowsingContextActionId(aActionId)) {
MOZ_DIAGNOSTIC_ASSERT(!ActionIdComparableAndLower(
aActionId, mActionIdForFocusedBrowsingContextInChrome));
mFocusedBrowsingContextInChrome = aContext;
mActionIdForFocusedBrowsingContextInChrome = aActionId;
return true;
}
return false;
}
BrowsingContext* nsFocusManager::GetFocusedBrowsingContextInChrome() {
return mFocusedBrowsingContextInChrome;
}
void nsFocusManager::BrowsingContextDetached(BrowsingContext* aContext) {
if (mFocusedBrowsingContextInChrome == aContext) {
mFocusedBrowsingContextInChrome = nullptr;
// Deliberately not adjusting the corresponding action id, because
// we don't want changes from the past to take effect.
}
if (mActiveBrowsingContextInChrome == aContext) {
mActiveBrowsingContextInChrome = nullptr;
// Deliberately not adjusting the corresponding action id, because
// we don't want changes from the past to take effect.
}
}
void nsFocusManager::SetActiveBrowsingContextInContent(
mozilla::dom::BrowsingContext* aContext, uint64_t aActionId,
bool aIsEnteringBFCache) {
MOZ_ASSERT(!XRE_IsParentProcess());
MOZ_ASSERT(!aContext || aContext->IsInProcess());
mozilla::dom::ContentChild* contentChild =
mozilla::dom::ContentChild::GetSingleton();
MOZ_ASSERT(contentChild);
if (ActionIdComparableAndLower(aActionId,
mActionIdForActiveBrowsingContextInContent)) {
LOGFOCUS(
("Ignored an attempt to set an in-process BrowsingContext [%p] as "
"the active browsing context due to a stale action id %" PRIu64 ".",
aContext, aActionId));
return;
}
if (aContext != mActiveBrowsingContextInContent) {
if (aContext) {
contentChild->SendSetActiveBrowsingContext(aContext, aActionId);
} else if (mActiveBrowsingContextInContent &&
!(BFCacheInParent() && aIsEnteringBFCache)) {
// No need to tell the parent process to update the active browsing
// context to null if we are entering BFCache, because the browsing
// context that is about to show will update it.
//
// We want to sync this over only if this isn't happening
// due to the active BrowsingContext switching processes,
// in which case the BrowserChild has already marked itself
// as destroying.
nsPIDOMWindowOuter* outer =
mActiveBrowsingContextInContent->GetDOMWindow();
if (outer) {
nsPIDOMWindowInner* inner = outer->GetCurrentInnerWindow();
if (inner) {
WindowGlobalChild* globalChild = inner->GetWindowGlobalChild();
if (globalChild) {
RefPtr<BrowserChild> browserChild = globalChild->GetBrowserChild();
if (browserChild && !browserChild->IsDestroyed()) {
contentChild->SendUnsetActiveBrowsingContext(
mActiveBrowsingContextInContent, aActionId);
}
}
}
}
}
}
mActiveBrowsingContextInContentSetFromOtherProcess = false;
mActiveBrowsingContextInContent = aContext;
mActionIdForActiveBrowsingContextInContent = aActionId;
MaybeUnlockPointer(aContext);
}
void nsFocusManager::SetActiveBrowsingContextFromOtherProcess(
BrowsingContext* aContext, uint64_t aActionId) {
MOZ_ASSERT(!XRE_IsParentProcess());
MOZ_ASSERT(aContext);
if (ActionIdComparableAndLower(aActionId,
mActionIdForActiveBrowsingContextInContent)) {
LOGFOCUS(
("Ignored an attempt to set active BrowsingContext [%p] from "
"another process due to a stale action id %" PRIu64 ".",
aContext, aActionId));
return;
}
if (aContext->IsInProcess()) {
// This message has been in transit for long enough that
// the process association of aContext has changed since
// the other content process sent the message, because
// an iframe in that process became an out-of-process
// iframe while the IPC broadcast that we're receiving
// was in-flight. Let's just ignore this.
LOGFOCUS(
("Ignored an attempt to set an in-process BrowsingContext [%p] as "
"active from another process. actionid: %" PRIu64,
aContext, aActionId));
return;
}
mActiveBrowsingContextInContentSetFromOtherProcess = true;
mActiveBrowsingContextInContent = aContext;
mActionIdForActiveBrowsingContextInContent = aActionId;
MaybeUnlockPointer(aContext);
}
void nsFocusManager::UnsetActiveBrowsingContextFromOtherProcess(
BrowsingContext* aContext, uint64_t aActionId) {
MOZ_ASSERT(!XRE_IsParentProcess());
MOZ_ASSERT(aContext);
if (ActionIdComparableAndLower(aActionId,
mActionIdForActiveBrowsingContextInContent)) {
LOGFOCUS(
("Ignored an attempt to unset the active BrowsingContext [%p] from "
"another process due to stale action id: %" PRIu64 ".",
aContext, aActionId));
return;
}
if (mActiveBrowsingContextInContent == aContext) {
mActiveBrowsingContextInContent = nullptr;
mActionIdForActiveBrowsingContextInContent = aActionId;
MaybeUnlockPointer(nullptr);
} else {
LOGFOCUS(
("Ignored an attempt to unset the active BrowsingContext [%p] from "
"another process. actionid: %" PRIu64,
aContext, aActionId));
}
}
void nsFocusManager::ReviseActiveBrowsingContext(
uint64_t aOldActionId, mozilla::dom::BrowsingContext* aContext,
uint64_t aNewActionId) {
MOZ_ASSERT(XRE_IsContentProcess());
if (mActionIdForActiveBrowsingContextInContent == aOldActionId) {
LOGFOCUS(("Revising the active BrowsingContext [%p]. old actionid: %" PRIu64
", new "
"actionid: %" PRIu64,
aContext, aOldActionId, aNewActionId));
mActiveBrowsingContextInContent = aContext;
mActionIdForActiveBrowsingContextInContent = aNewActionId;
} else {
LOGFOCUS(
("Ignored a stale attempt to revise the active BrowsingContext [%p]. "
"old actionid: %" PRIu64 ", new actionid: %" PRIu64,
aContext, aOldActionId, aNewActionId));
}
}
void nsFocusManager::ReviseFocusedBrowsingContext(
uint64_t aOldActionId, mozilla::dom::BrowsingContext* aContext,
uint64_t aNewActionId) {
MOZ_ASSERT(XRE_IsContentProcess());
if (mActionIdForFocusedBrowsingContextInContent == aOldActionId) {
LOGFOCUS(
("Revising the focused BrowsingContext [%p]. old actionid: %" PRIu64
", new "
"actionid: %" PRIu64,
aContext, aOldActionId, aNewActionId));
mFocusedBrowsingContextInContent = aContext;
mActionIdForFocusedBrowsingContextInContent = aNewActionId;
mFocusedElement = nullptr;
} else {
LOGFOCUS(
("Ignored a stale attempt to revise the focused BrowsingContext [%p]. "
"old actionid: %" PRIu64 ", new actionid: %" PRIu64,
aContext, aOldActionId, aNewActionId));
}
}
bool nsFocusManager::SetActiveBrowsingContextInChrome(
mozilla::dom::BrowsingContext* aContext, uint64_t aActionId) {
MOZ_ASSERT(aActionId);
if (ProcessPendingActiveBrowsingContextActionId(aActionId, aContext)) {
MOZ_DIAGNOSTIC_ASSERT(!ActionIdComparableAndLower(
aActionId, mActionIdForActiveBrowsingContextInChrome));
mActiveBrowsingContextInChrome = aContext;
mActionIdForActiveBrowsingContextInChrome = aActionId;
return true;
}
return false;
}
uint64_t nsFocusManager::GetActionIdForActiveBrowsingContextInChrome() const {
return mActionIdForActiveBrowsingContextInChrome;
}
uint64_t nsFocusManager::GetActionIdForFocusedBrowsingContextInChrome() const {
return mActionIdForFocusedBrowsingContextInChrome;
}
BrowsingContext* nsFocusManager::GetActiveBrowsingContextInChrome() {
return mActiveBrowsingContextInChrome;
}
void nsFocusManager::InsertNewFocusActionId(uint64_t aActionId) {
LOGFOCUS(("InsertNewFocusActionId %" PRIu64, aActionId));
MOZ_ASSERT(XRE_IsParentProcess());
MOZ_ASSERT(!mPendingActiveBrowsingContextActions.Contains(aActionId));
mPendingActiveBrowsingContextActions.AppendElement(aActionId);
MOZ_ASSERT(!mPendingFocusedBrowsingContextActions.Contains(aActionId));
mPendingFocusedBrowsingContextActions.AppendElement(aActionId);
}
static void RemoveContentInitiatedActionsUntil(
nsTArray<uint64_t>& aPendingActions,
nsTArray<uint64_t>::index_type aUntil) {
nsTArray<uint64_t>::index_type i = 0;
while (i < aUntil) {
auto [actionProc, actionId] =
nsContentUtils::SplitProcessSpecificId(aPendingActions[i]);
Unused << actionId;
if (actionProc) {
aPendingActions.RemoveElementAt(i);
--aUntil;
continue;
}
++i;
}
}
bool nsFocusManager::ProcessPendingActiveBrowsingContextActionId(
uint64_t aActionId, bool aSettingToNonNull) {
MOZ_ASSERT(XRE_IsParentProcess());
auto index = mPendingActiveBrowsingContextActions.IndexOf(aActionId);
if (index == nsTArray<uint64_t>::NoIndex) {
return false;
}
// When aSettingToNonNull is true, we need to remove one more
// element to remove the action id itself in addition to
// removing the older ones.
if (aSettingToNonNull) {
index++;
}
auto [actionProc, actionId] =
nsContentUtils::SplitProcessSpecificId(aActionId);
Unused << actionId;
if (actionProc) {
// Action from content: We allow parent-initiated actions
// to take precedence over content-initiated ones, so we
// remove only prior content-initiated actions.
RemoveContentInitiatedActionsUntil(mPendingActiveBrowsingContextActions,
index);
} else {
// Action from chrome
mPendingActiveBrowsingContextActions.RemoveElementsAt(0, index);
}
return true;
}
bool nsFocusManager::ProcessPendingFocusedBrowsingContextActionId(
uint64_t aActionId) {
MOZ_ASSERT(XRE_IsParentProcess());
auto index = mPendingFocusedBrowsingContextActions.IndexOf(aActionId);
if (index == nsTArray<uint64_t>::NoIndex) {
return false;
}
auto [actionProc, actionId] =
nsContentUtils::SplitProcessSpecificId(aActionId);
Unused << actionId;
if (actionProc) {
// Action from content: We allow parent-initiated actions
// to take precedence over content-initiated ones, so we
// remove only prior content-initiated actions.
RemoveContentInitiatedActionsUntil(mPendingFocusedBrowsingContextActions,
index);
} else {
// Action from chrome
mPendingFocusedBrowsingContextActions.RemoveElementsAt(0, index);
}
return true;
}
// static
uint64_t nsFocusManager::GenerateFocusActionId() {
uint64_t id =
nsContentUtils::GenerateProcessSpecificId(++sFocusActionCounter);
if (XRE_IsParentProcess()) {
nsFocusManager* fm = GetFocusManager();
if (fm) {
fm->InsertNewFocusActionId(id);
}
} else {
mozilla::dom::ContentChild* contentChild =
mozilla::dom::ContentChild::GetSingleton();
MOZ_ASSERT(contentChild);
contentChild->SendInsertNewFocusActionId(id);
}
LOGFOCUS(("GenerateFocusActionId %" PRIu64, id));
return id;
}
static bool IsInPointerLockContext(nsPIDOMWindowOuter* aWin) {
return PointerLockManager::IsInLockContext(aWin ? aWin->GetBrowsingContext()
: nullptr);
}
void nsFocusManager::SetFocusedWindowInternal(nsPIDOMWindowOuter* aWindow,
uint64_t aActionId,
bool aSyncBrowsingContext) {
if (XRE_IsParentProcess() && !PointerUnlocker::sActiveUnlocker &&
IsInPointerLockContext(mFocusedWindow) &&
!IsInPointerLockContext(aWindow)) {
nsCOMPtr<nsIRunnable> runnable = new PointerUnlocker();
NS_DispatchToCurrentThread(runnable);
}
// Update the last focus time on any affected documents
if (aWindow && aWindow != mFocusedWindow) {
const TimeStamp now(TimeStamp::Now());
for (Document* doc = aWindow->GetExtantDoc(); doc;
doc = doc->GetInProcessParentDocument()) {
doc->SetLastFocusTime(now);
}
}
// This function may be called with zero action id to indicate that the
// action id should be ignored.
if (XRE_IsContentProcess() && aActionId &&
ActionIdComparableAndLower(aActionId,
mActionIdForFocusedBrowsingContextInContent)) {
// Unclear if this ever happens.
LOGFOCUS(
("Ignored an attempt to set an in-process BrowsingContext as "
"focused due to stale action id %" PRIu64 ".",
aActionId));
return;
}
mFocusedWindow = aWindow;
BrowsingContext* bc = aWindow ? aWindow->GetBrowsingContext() : nullptr;
if (aSyncBrowsingContext) {
MOZ_ASSERT(aActionId,
"aActionId must not be zero if aSyncBrowsingContext is true");
SetFocusedBrowsingContext(bc, aActionId);
} else if (XRE_IsContentProcess()) {
MOZ_ASSERT(mFocusedBrowsingContextInContent == bc,
"Not syncing BrowsingContext even when different.");
}
}
void nsFocusManager::NotifyOfReFocus(Element& aElement) {
nsPIDOMWindowOuter* window = GetCurrentWindow(&aElement);
if (!window || window != mFocusedWindow) {
return;
}
if (!aElement.IsInComposedDoc() || IsNonFocusableRoot(&aElement)) {
return;
}
nsIDocShell* docShell = window->GetDocShell();
if (!docShell) {
return;
}
RefPtr<PresShell> presShell = docShell->GetPresShell();
if (!presShell) {
return;
}
RefPtr<nsPresContext> presContext = presShell->GetPresContext();
if (!presContext) {
return;
}
IMEStateManager::OnReFocus(*presContext, aElement);
}
void nsFocusManager::MarkUncollectableForCCGeneration(uint32_t aGeneration) {
if (!sInstance) {
return;
}
if (sInstance->mActiveWindow) {
sInstance->mActiveWindow->MarkUncollectableForCCGeneration(aGeneration);
}
if (sInstance->mFocusedWindow) {
sInstance->mFocusedWindow->MarkUncollectableForCCGeneration(aGeneration);
}
if (sInstance->mWindowBeingLowered) {
sInstance->mWindowBeingLowered->MarkUncollectableForCCGeneration(
aGeneration);
}
if (sInstance->mFocusedElement) {
sInstance->mFocusedElement->OwnerDoc()->MarkUncollectableForCCGeneration(
aGeneration);
}
}
bool nsFocusManager::CanSkipFocus(nsIContent* aContent) {
if (!aContent) {
return false;
}
if (mFocusedElement == aContent) {
return true;
}
nsIDocShell* ds = aContent->OwnerDoc()->GetDocShell();
if (!ds) {
return true;
}
if (XRE_IsParentProcess()) {
nsCOMPtr<nsIDocShellTreeItem> root;
ds->GetInProcessRootTreeItem(getter_AddRefs(root));
nsCOMPtr<nsPIDOMWindowOuter> newRootWindow =
root ? root->GetWindow() : nullptr;
if (mActiveWindow != newRootWindow) {
nsPIDOMWindowOuter* outerWindow = aContent->OwnerDoc()->GetWindow();
if (outerWindow && outerWindow->GetFocusedElement() == aContent) {
return true;
}
}
} else {
BrowsingContext* bc = aContent->OwnerDoc()->GetBrowsingContext();
BrowsingContext* top = bc ? bc->Top() : nullptr;
if (GetActiveBrowsingContext() != top) {
nsPIDOMWindowOuter* outerWindow = aContent->OwnerDoc()->GetWindow();
if (outerWindow && outerWindow->GetFocusedElement() == aContent) {
return true;
}
}
}
return false;
}
static IsFocusableFlags FocusManagerFlagsToIsFocusableFlags(uint32_t aFlags) {
auto flags = IsFocusableFlags(0);
if (aFlags & nsIFocusManager::FLAG_BYMOUSE) {
flags |= IsFocusableFlags::WithMouse;
}
return flags;
}
/* static */
Element* nsFocusManager::GetTheFocusableArea(Element* aTarget,
uint32_t aFlags) {
MOZ_ASSERT(aTarget);
nsIFrame* frame = aTarget->GetPrimaryFrame();
if (!frame) {
return nullptr;
}
// If focus target is the document element of its Document.
if (aTarget == aTarget->OwnerDoc()->GetRootElement()) {
// the root content can always be focused,
// except in userfocusignored context.
return aTarget;
}
// If focus target is an area element with one or more shapes that are
// focusable areas.
if (auto* area = HTMLAreaElement::FromNode(aTarget)) {
return IsAreaElementFocusable(*area) ? area : nullptr;
}
// For these 3 steps mentioned in the spec
// 1. If focus target is an element with one or more scrollable regions that
// are focusable areas
// 2. If focus target is a navigable
// 3. If focus target is a navigable container with a non-null content
// navigable
// nsIFrame::IsFocusable will effectively perform the checks for them.
IsFocusableFlags flags = FocusManagerFlagsToIsFocusableFlags(aFlags);
if (frame->IsFocusable(flags)) {
return aTarget;
}
// If focus target is a shadow host whose shadow root's delegates focus is
// true
if (ShadowRoot* root = aTarget->GetShadowRoot()) {
if (root->DelegatesFocus()) {
// If focus target is a shadow-including inclusive ancestor of the
// currently focused area of a top-level browsing context's DOM anchor,
// then return the already-focused element.
if (nsPIDOMWindowInner* innerWindow =
aTarget->OwnerDoc()->GetInnerWindow()) {
if (Element* focusedElement = innerWindow->GetFocusedElement()) {
if (focusedElement->IsShadowIncludingInclusiveDescendantOf(aTarget)) {
return focusedElement;
}
}
}
if (Element* firstFocusable = root->GetFocusDelegate(flags)) {
return firstFocusable;
}
}
}
return nullptr;
}
/* static */
bool nsFocusManager::IsAreaElementFocusable(HTMLAreaElement& aArea) {
nsIFrame* frame = aArea.GetPrimaryFrame();
if (!frame) {
return false;
}
// HTML areas do not have their own frame, and the img frame we get from
// GetPrimaryFrame() is not relevant as to whether it is focusable or
// not, so we have to do all the relevant checks manually for them.
return frame->IsVisibleConsideringAncestors() &&
aArea.IsFocusableWithoutStyle();
}
nsresult NS_NewFocusManager(nsIFocusManager** aResult) {
NS_IF_ADDREF(*aResult = nsFocusManager::GetFocusManager());
return NS_OK;
}
|