Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 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 | 1x 373x 373x 373x 373x 373x 373x 373x 373x 373x 373x 373x 373x 373x 373x 373x 373x 373x 373x 373x 373x 373x 373x 373x 373x 373x 373x 373x 373x 373x 373x 373x 373x 373x 373x 373x 373x 373x 373x 373x 373x 373x 373x 373x 373x 373x 373x 373x 373x 373x 373x 373x 373x 373x 373x 373x 373x 373x 373x 373x 373x 373x 373x 373x 373x 373x 373x 373x 373x 373x 373x 373x 373x 373x 373x 1x 1x 1x 1x 1x 373x 1x 2x 1x 375x 1x 546x 1x 305x 305x 72x 305x 305x 305x 305x 305x 305x 305x 305x 305x 305x 305x 305x 305x 1x 4x 1x 1x 1x 1x 1x 1x 1x 5666x 107x 5559x 1432x 5559x 1x 6x 1x 373x 373x 373x 1x 6x 6x 1x 1881x 1x 1x 26x 26x 26x 26x 26x 26x 26x 26x 26x 26x 26x 26x 26x 1x 72x 72x 72x 72x 1x 76x 76x 62x 1x 18569x 1x 4634x 4634x 4634x 288x 4346x 81x 4265x 81x 4184x 1x 1244x 1x 69x 1x 80x 80x 80x 80x 80x 80x 80x 4x 4x 4x 80x 80x 80x 80x 1x 89x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 1x 1x 81x 81x 81x 81x 81x 81x 81x 1x 81x 81x 76x 81x 81x 81x 81x 81x 81x 81x 81x 5x 4x 4x 5x 81x 81x 1x 4677x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 81x 81x 1x 4892x 4892x 2503x 4892x 4810x 82x 82x 82x 1x 409x 409x 409x 409x 409x 409x 409x 409x 409x 409x 409x 137x 272x 272x 17x 17x 9x 9x 9x 409x 1x 1x 3x 2x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 408x 408x 263x 408x 408x 408x 263x 408x 1x 9x 9x 9x 9x 9x 1x 8x 1x 85x 85x 2x 83x 1x 409x 409x 409x 409x 12x 12x 12x 12x 409x 409x 41x 368x 368x 368x 37x 37x 25x 25x 25x 25x 25x 25x 23x 23x 23x 11x 37x 37x 37x 37x 25x 343x 343x 343x 343x 4x 2x 2x 2x 2x 4x 339x 12x 12x 12x 12x 12x 12x 12x 5x 5x 5x 343x 343x 4x 4x 4x 2x 4x 4x 4x 1x 3x 1x 343x 326x 343x 343x 343x 343x 343x 343x 343x 343x 1x 2075x 2067x 8x 8x 8x 1x 7x 7x 7x 7x 7x 7x 2x 5x 2x 3x 5x 5x 5x 5x 2x 2x 2x 2x 2x 5x 5x 5x 5x 5x 5x 5x 1x 416x 1x 77x 77x 77x 15x 14x 6x 1x 1x 1x 1x 62x 3x 3x 3x 3x 5x 3x 2x 1x 5x 3x 3x 1x 1x 77x 76x 102x 72x 77x 154x 132x 71x 77x 77x 77x 1x 124x 5x 5x 5x 5x 124x 124x 124x 113x 113x 113x 5x 5x 5x 108x 59x 124x 1x 2x 2x 2x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 360x 360x 360x 360x 360x 360x 360x 360x 360x 1x 52x 52x 1x 1626x 1626x 1626x 1626x 1626x 1626x 71x 1626x 1239x 1239x 33x 14x 14x 33x 21x 21x 21x 1239x 1239x 1239x 81x 29x 29x 81x 53x 53x 53x 53x 53x 387x 316x 387x 1x 387x 1626x 1626x 1136x 1136x 1626x 1x 392x 392x 1x 1494x 115x 1379x 1379x 1209x 170x 1x 1852x 174x 1678x 1678x 1583x 95x 1x 1409x 1409x 324x 324x 59x 59x 55x 1085x 1085x 1354x 1x 726x 299x 726x 726x 726x 726x 1x 93x 93x 84x 9x 9x 1x 103x 103x 1x 102x 102x 102x 1x 93x 93x 1x 92x 1x 598x 598x 598x 598x 315x 315x 315x 312x 312x 312x 312x 643x 764x 598x 4x 598x 596x 594x 594x 594x 594x 2x 596x 596x 596x 596x 594x 594x 2x 2x 596x 596x 596x 596x 596x 596x 596x 598x 293x 293x 293x 305x 19x 19x 19x 598x 52x 52x 598x 305x 1x 1x 425x 425x 425x 425x 425x 370x 55x 55x 55x 55x 1x 1608x 1608x 1608x 1x 426x 1x 1x 1706x 1706x 1706x 524x 1182x 1706x 1706x 1706x 1706x 1706x 1x 1x 2132x 2132x 3x 3x 2132x 3x 3x 1x 312x 312x 312x 312x 312x 93x 1x 1x 30x 1x 2556x 1x 409x 409x 409x 39x 1x 1296x 1296x 1x 1x 9x 9x 9x 9x 5x 9x 1x 39x 39x 39x 39x 1x 1126x 1126x 1126x 1126x 24x 1102x 14964x 2888x 2888x 154x 14810x 14810x 15529x 769x 14760x 179x 179x 14581x 13862x 719x 1x 563x 563x 1x 563x 563x 563x 105x 105x 96x 96x 96x 96x 1x 563x 563x 563x 50x 50x 47x 47x 47x 47x 1x 75x 75x 1x 180x 40x 40x 40x 1x 125x 5x 5x 5x 1x 135x 135x 135x 135x 135x 135x 135x 135x 1x 8x 8x 8x 195x 97x 98x 98x 364x 98x 92x 6x 8x 8x 1x 8x 8x 6x 2x 1x 4x 1x 4x 1x 34x 34x 34x 34x 26x 8x 8x 8x 8x 8x 54x 54x 100x 54x 8x 16x 16x 16x 16x 54x 54x 54x 54x 54x 54x 54x 4x 50x 50x 50x 51x 26x 25x 25x 51x 51x 2x 2x 2x 2x 2x 1x 1x 49x 36x 36x 13x 13x 11x 8x 1x 26x 26x 26x 26x 26x 1x 9x 1x 1205x 22x 22x 1183x 1183x 47x 31x 16x 1136x 399x 737x 737x 328x 328x 328x 160x 593x 593x 511x 511x 82x 1x 648x 648x 648x 648x 47x 47x 601x 11x 11x 590x 9x 7x 7x 7x 7x 7x 7x 7x 9x 2x 2x 590x 583x 583x 590x 590x 12x 12x 12x 12x 590x 590x 1x 765x 131x 765x 11x 754x 754x 765x 765x 20x 11x 11x 765x 23x 14x 14x 765x 19x 19x 1x 9x 9x 9x 9x 9x 9x 1x 11x 11x 9x 1x 33x 33x 33x 33x 33x 33x 33x 33x 33x 33x 33x 33x 33x 1x 826x 1x 892x 892x 159x 159x 51x 892x 1x 863x 863x 16x 847x 847x 4x 843x 843x 843x 631x 212x 212x 212x 212x 843x 1x 180x 180x 180x 1x 110x 110x 110x 1x 4578x 1x 19069x 1x 2229x 1x 3947x 1x 2310x 1x 2310x 1x 305x 1x 910x 910x 910x 910x 910x 1x 848x 848x 1x 34x 34x 34x 1x 505x 2x 1x 25x 6x 25x 1x 53x 53x 53x 17x 17x 53x 53x 53x 31x 21x 10x 1x 135x 1x 1x 1x 387x 387x 3465x 3465x 1564x 1564x 11x 3465x 1957x 1957x 319x 319x 7x 387x 387x 387x 4x 387x 4x 4x | /*!
* VisualEditor ContentEditable Surface class.
*
* @copyright See AUTHORS.txt
*/
/**
* ContentEditable surface.
*
* @class
* @extends OO.ui.Element
* @mixes OO.EventEmitter
*
* @constructor
* @param {ve.dm.Surface} model Surface model to observe
* @param {ve.ui.Surface} ui Surface user interface
* @param {Object} [config] Configuration options
*/
ve.ce.Surface = function VeCeSurface( model, ui, config ) {
// Parent constructor
ve.ce.Surface.super.call( this, config );
// Mixin constructors
OO.EventEmitter.call( this );
// Properties
this.surface = ui;
this.model = model;
this.documentView = new ve.ce.Document( model.getDocument(), this );
this.attachedRoot = this.getDocument().getDocumentNode().getNodeFromOffset(
model.getDocument().getAttachedRoot().getOffset() + ( model.getDocument().getAttachedRoot().isWrapped() ? 1 : 0 )
);
this.selection = null;
this.readOnly = false;
this.reviewMode = false;
this.surfaceObserver = new ve.ce.SurfaceObserver( this );
this.$window = $( this.getElementWindow() );
this.$document = $( this.getElementDocument() );
this.$attachedRootNode = this.attachedRoot.$element.addClass( 've-ce-attachedRootNode' );
// Deprecated aliases
this.$documentNode = this.$attachedRootNode;
this.root = this.attachedRoot;
// Window.getSelection returns a live singleton representing the document's selection
this.nativeSelection = this.getElementWindow().getSelection();
ve.fixSelectionNodes( this.nativeSelection );
this.eventSequencer = new ve.EventSequencer( [
'keydown', 'keypress', 'keyup',
'compositionstart', 'compositionend',
'beforeinput', 'input', 'mousedown'
] );
// The last non-collapsed selection in this VE surface. This will be a NullSelection
// if there has never had a non-collapsed selection, or if the cursor is moved out of
// the surface and a selection is made elsewhere.
this.lastNonCollapsedDocumentSelection = new ve.dm.NullSelection();
this.renderLocks = 0;
this.dragging = false;
this.resizing = false;
this.focused = false;
this.deactivated = false;
this.activeNode = null;
this.contentBranchNodeChanged = false;
this.selectionLink = null;
this.delayedSequences = [];
this.$highlightsFocused = $( '<div>' );
this.$highlightsBlurred = $( '<div>' );
this.$highlights = $( '<div>' ).append(
this.$highlightsFocused, this.$highlightsBlurred
);
this.pointerEvents = null;
this.focusedBlockSlug = null;
this.focusedNode = null;
this.activeAnnotations = [];
this.contexedAnnotations = [];
this.previousActiveAnnotations = [];
// This is set on entering changeModel, then unset when leaving.
// It is used to test whether a reflected change event is emitted.
this.newModelSelection = null;
// Snapshot updated at keyDown. See storeKeyDownState.
this.keyDownState = {
event: null,
selectionState: null
};
this.cursorDirectionality = null;
this.unicorningNode = null;
this.setUnicorningRecursionGuard = false;
this.cursorHolderBefore = null;
this.cursorHolderAfter = null;
this.clipboardHandler = this.createClipboardHandler();
this.dragDropHandler = new ve.ce.DragDropHandler( this );
this.selectionManager = new ve.ce.SelectionManager( this );
// Events
this.model.connect( this, {
select: 'onModelSelect',
documentUpdate: 'onModelDocumentUpdate',
insertionAnnotationsChange: 'onInsertionAnnotationsChange'
} );
const synchronizer = this.getModel().synchronizer;
Iif ( synchronizer ) {
synchronizer.connect( this, {
wrongDoc: 'onSynchronizerWrongDoc',
pause: 'onSynchronizerPause'
} );
}
this.onDocumentMouseUpHandler = this.onDocumentMouseUp.bind( this );
this.$attachedRootNode.on( {
// Mouse events shouldn't be sequenced as the event sequencer
// is detached on blur
mousedown: this.onDocumentMouseDown.bind( this )
// mouseup is bound to the whole document on mousedown
} );
this.onWindowResizeHandler = ve.debounce( this.onWindowResize.bind( this ), 50 );
this.$window.on( 'resize', this.onWindowResizeHandler );
this.onDocumentFocusInOutHandler = this.onDocumentFocusInOut.bind( this );
this.$document.on( 'focusin focusout', this.onDocumentFocusInOutHandler );
this.debounceFocusChange = ve.debounce( this.onFocusChange.bind( this ) );
// If the document is blurred (but still has a selection) it is
// possible to clear the selection by clicking elsewhere without
// triggering a focus or blur event, so listen to mousedown globally.
this.$document.on( 'mousedown', this.debounceFocusChange );
// It is possible that when focusin fires, the selection is not yet inside
// the document. This happens if the selection is being moved inside itself,
// e.g. the whole html page was previously selected, including the attachedRootNode
// In this case the selection is not moved until mouseup. T157499
this.$attachedRootNode.on( 'mouseup', this.debounceFocusChange );
this.$attachedRootNode
.on( 'focus', 'a', () => {
// Opera <= 12 triggers 'blur' on document node before any link is
// focused and we don't want that
this.$attachedRootNode[ 0 ].focus();
} );
this.onDocumentSelectionChangeHandler = this.onDocumentSelectionChange.bind( this );
this.$document.on( 'selectionchange', this.onDocumentSelectionChangeHandler );
// Add listeners to the eventSequencer. They won't get called until
// eventSequencer.attach(node) has been called.
this.eventSequencer.on( {
keydown: this.onDocumentKeyDown.bind( this ),
keyup: this.onDocumentKeyUp.bind( this ),
keypress: this.onDocumentKeyPress.bind( this ),
beforeinput: this.onDocumentBeforeInput.bind( this ),
input: this.onDocumentInput.bind( this ),
compositionstart: this.onDocumentCompositionStart.bind( this )
} ).after( {
keydown: this.afterDocumentKeyDown.bind( this )
} );
this.mutationObserver = new MutationObserver( this.afterMutations.bind( this ) );
this.mutationObserver.observe(
this.$attachedRootNode[ 0 ],
{ childList: true, subtree: true }
);
// Initialization
// Support: Chrome
// Add 'notranslate' class to prevent Chrome's translate feature from
// completely messing up the CE DOM (T59124)
this.$element.addClass( 've-ce-surface notranslate' );
// Support: Edge
// Add translate="no" attribute to prevent Chromium Edge's translate feature from
// translating our editable surface, and leaving junk behind... (T267747)
// Some documentation out there says it respects class="notranslate", but it doesn't.
this.$element.attr( 'translate', 'no' );
this.$highlights.addClass( 've-ce-surface-highlights' );
this.$highlightsFocused.addClass( 've-ce-surface-highlights-focused' );
this.$highlightsBlurred.addClass( 've-ce-surface-highlights-blurred' );
// Add elements to the DOM
this.$highlights.append( this.getDragDropHandler().$dropMarker );
this.$element.append( this.$attachedRootNode, this.clipboardHandler.$element );
this.surface.$blockers.append( this.$highlights );
this.surface.$selections.append( this.selectionManager.$element );
};
/* Inheritance */
OO.inheritClass( ve.ce.Surface, OO.ui.Element );
OO.mixinClass( ve.ce.Surface, OO.EventEmitter );
/* Events */
/**
* @event ve.ce.Surface#relocationStart
*/
/**
* @event ve.ce.Surface#relocationEnd
*/
/**
* @event ve.ce.Surface#keyup
*/
/**
* When the surface or its contents changes position
* (only after initialize has already been called).
*
* @event ve.ce.Surface#position
* @param {boolean} [wasSynchronizing=false] The surface was positioned due to
* synchronization (ve.dm.SurfaceSynchronizer)
*/
/**
* Note that it's possible for a focus event to occur immediately after a blur event, if the focus
* moves to or from a FocusableNode. In this case the surface doesn't lose focus conceptually, but
* a pair of blur-focus events is emitted anyway.
*
* @event ve.ce.Surface#focus
*/
/**
* Note that it's possible for a focus event to occur immediately after a blur event, if the focus
* moves to or from a FocusableNode. In this case the surface doesn't lose focus conceptually, but
* a pair of blur-focus events is emitted anyway.
*
* @event ve.ce.Surface#blur
*/
/**
* Surface activation state has changed (i.e. on activate or deactivate)
*
* @event ve.ce.Surface#activation
*/
/* Static properties */
/**
* Values of InputEvent.inputType which map to a command
*
* Currently these are triggered when the user selects
* undo/redo from the context menu in Chrome, or uses the
* selection formatting tools on iOS.
*
* See https://w3c.github.io/input-events/
*
* commands like { collapsed: 'foo', uncollapsed: 'bar' }
* act conditionally depending whether the selection is
* collapsed
*
* A value of `null` will perform no action and
* preventDefault. A value of `undefined` will do nothing
* and let the event continue.
*
* @type {Object.<string,string|null|Object>}
*/
ve.ce.Surface.static.inputTypeCommands = {
historyUndo: 'undo',
historyRedo: 'redo',
formatBold: 'bold',
formatItalic: 'italic',
formatUnderline: 'underline',
formatStrikeThrough: 'strikethrough',
formatSuperscript: 'superscript',
formatSubscript: 'subscript',
formatJustifyFull: null,
formatJustifyCenter: null,
formatJustifyRight: null,
formatJustifyLeft: null,
formatIndent: 'indent',
formatOutdent: 'outdent',
formatRemove: 'clear',
formatSetBlockTextDirection: null,
formatSetInlineTextDirection: null,
formatBackColor: null,
formatFontColor: null,
formatFontName: null,
// Support: Firefox
// Delete content via context menu in Firefox. (T220629)
// If there is a non-collapsed selection, a delete content event can only ever just remove
// the selected content. The only time we know this event is fired is in Firefox, where
// no other change events are fired.
// If any other browsers fire this event with a selection this is harmless, as removing
// the content without moving the cursor is always the correct thing to do.
deleteContentBackward: { uncollapsed: 'backspace' }
};
/**
* Cursor holder template
*
* @static
* @property {HTMLElement}
*/
ve.ce.Surface.static.cursorHolderTemplate =
$( '<div>' )
.addClass( 've-ce-cursorHolder' )
.prop( 'contentEditable', 'true' )
.append(
// The image does not need a src for Firefox in spite of cursoring
// bug https://bugzilla.mozilla.org/show_bug.cgi?id=989012 , because
// you can cursor to ce=false blocks in Firefox (see bug
// https://bugzilla.mozilla.org/show_bug.cgi?id=1155031 )
$( '<img>' )
.addClass( 've-ce-cursorHolder-img' )
.attr( {
role: 'none',
alt: ''
} )
)
.get( 0 );
/* Methods */
/**
* Create a clipboard handler for the surface
*
* @return {ve.ce.ClipboardHandler}
*/
ve.ce.Surface.prototype.createClipboardHandler = function () {
return new ve.ce.ClipboardHandler( this );
};
/**
* Get the clipboard handler
*
* @return {ve.ce.ClipboardHandler}
*/
ve.ce.Surface.prototype.getClipboardHandler = function () {
return this.clipboardHandler;
};
/**
* Get the drag and drop handler
*
* @return {ve.ce.DragDropHandler}
*/
ve.ce.Surface.prototype.getDragDropHandler = function () {
return this.dragDropHandler;
};
/**
* Get the selection manager
*
* @return {ve.ce.SelectionManager}
*/
ve.ce.Surface.prototype.getSelectionManager = function () {
return this.selectionManager;
};
/**
* Destroy the surface, removing all DOM elements.
*/
ve.ce.Surface.prototype.destroy = function () {
const attachedRoot = this.attachedRoot;
// Support: Firefox, iOS
// FIXME T126041: Blur to make selection/cursor disappear (needed in Firefox
// in some cases, and in iOS to hide the keyboard)
if ( this.isFocused() ) {
this.blur();
}
// Detach observer and event sequencer
this.surfaceObserver.stopTimerLoop();
this.surfaceObserver.detach();
this.eventSequencer.detach();
// Make document node not live
attachedRoot.setLive( false );
// Disconnect events
this.model.disconnect( this );
// Disconnect DOM events on the document
this.$document.off( 'focusin focusout', this.onDocumentFocusInOutHandler );
this.$document.off( 'mousedown', this.debounceFocusChange );
this.$document.off( 'selectionchange', this.onDocumentSelectionChangeHandler );
Iif ( this.model.synchronizer ) {
// TODO: Move destroy to ve.dm.Surface#destroy
this.model.synchronizer.destroy();
this.model.synchronizer.disconnect( this );
}
// Disconnect DOM events on the window
this.$window.off( 'resize', this.onWindowResizeHandler );
// Remove DOM elements (also disconnects their events)
this.$element.remove();
this.$highlights.remove();
this.getSelectionManager().destroy();
};
/**
* Get linear model offest from a mouse event
*
* @param {Event} e
* @return {number} Linear model offset, or -1 if coordinates are out of bounds
*/
ve.ce.Surface.prototype.getOffsetFromEventCoords = function ( e ) {
return this.getOffsetFromCoords(
e.pageX - this.surface.$scrollContainer.scrollLeft(),
e.pageY - this.surface.$scrollContainer.scrollTop()
);
};
/**
* Get linear model offset from absolute coords
*
* @param {number} x X offset
* @param {number} y Y offset
* @return {number} Linear model offset, or -1 if coordinates are out of bounds
*/
ve.ce.Surface.prototype.getOffsetFromCoords = function ( x, y ) {
const doc = this.getElementDocument();
try {
let offset;
if ( doc.caretPositionFromPoint ) {
// Gecko
// http://dev.w3.org/csswg/cssom-view/#extensions-to-the-document-interface
const caretPosition = document.caretPositionFromPoint( x, y );
offset = ve.ce.getOffset( caretPosition.offsetNode, caretPosition.offset );
} else Eif ( doc.caretRangeFromPoint ) {
// Webkit
// http://www.w3.org/TR/2009/WD-cssom-view-20090804/
const range = document.caretRangeFromPoint( x, y );
offset = ve.ce.getOffset( range.startContainer, range.startOffset );
} else if ( document.body.createTextRange ) {
// Trident
// http://msdn.microsoft.com/en-gb/library/ie/ms536632(v=vs.85).aspx
const textRange = document.body.createTextRange();
textRange.moveToPoint( x, y );
textRange.pasteHTML( '<span class="ve-ce-textRange-drop-marker"> </span>' );
// eslint-disable-next-line no-jquery/no-global-selector
const $marker = $( '.ve-ce-textRange-drop-marker' );
offset = ve.ce.getOffset( $marker.get( 0 ), 0 );
$marker.remove();
}
return offset;
} catch ( e ) {
// Both ve.ce.getOffset and TextRange.moveToPoint can throw out of bounds exceptions
return -1;
}
};
/**
* Get selection view object
*
* @param {ve.dm.Selection} [selection] Optional selection model, defaults to current selection
* @return {ve.ce.Selection} Selection view
*/
ve.ce.Surface.prototype.getSelection = function ( selection ) {
if ( selection ) {
// Specific selection requested, bypass cache
return ve.ce.Selection.static.newFromModel( selection, this );
} else if ( !this.selection ) {
this.selection = ve.ce.Selection.static.newFromModel( this.getModel().getSelection(), this );
}
return this.selection;
};
/**
* Get block directionality at selection
*
* @return {string} 'rtl' or 'ltr'
*/
ve.ce.Surface.prototype.getSelectionDirectionality = function () {
return this.getSelection().getDirectionality( this.getDocument() );
};
/* Initialization */
/**
* Initialize surface.
*
* This should be called after the surface has been attached to the DOM.
*
* @fires ve.ce.Surface#position
*/
ve.ce.Surface.prototype.initialize = function () {
this.attachedRoot.setLive( true );
Iif ( $.client.profile().layout === 'gecko' ) {
// Support: Firefox < 64
// Turn off native object editing. This must be tried after the surface has been added to DOM.
// This is only needed in Gecko. In other engines, these properties are off by default,
// and turning them off again is expensive; see https://phabricator.wikimedia.org/T89928
// These are disabled by default since Firefox 64.
try {
this.$document[ 0 ].execCommand( 'enableObjectResizing', false, false );
this.$document[ 0 ].execCommand( 'enableInlineTableEditing', false, false );
} catch ( e ) { /* Silently ignore */ }
}
this.emit( 'position' );
};
/**
* Set the read-only state of the surface
*
* @param {boolean} readOnly Make surface read-only
*/
ve.ce.Surface.prototype.setReadOnly = function ( readOnly ) {
this.readOnly = !!readOnly;
this.$element.toggleClass( 've-ce-surface-readOnly', this.readOnly );
};
/**
* Check if the surface is read-only
*
* @return {boolean}
*/
ve.ce.Surface.prototype.isReadOnly = function () {
return this.readOnly;
};
/**
* Set the review mode state of the surface
*
* In review mode the surface can't be interacted with by the user
* (unlike the read-only mode where the user can select text and
* inspect nodes).
*
* Review mode does not restrict changes to the model by other means,
* so programmatic changes can still be made from other tools.
*
* @param {boolean} reviewMode Set surface to review mode
* @param {ve.ce.Node[]} highlightNodes Nodes to highlight while in review mode
*/
ve.ce.Surface.prototype.setReviewMode = function ( reviewMode, highlightNodes ) {
this.reviewMode = !!reviewMode;
this.$element.toggleClass( 've-ce-surface-reviewMode', this.reviewMode );
this.$element.toggleClass( 've-ce-surface-reviewMode-highlightNodes', this.reviewMode && !!highlightNodes );
if ( reviewMode && highlightNodes ) {
highlightNodes.forEach( ( node ) => {
node.$element
.addClass( 've-ce-surface-reviewMode-highlightNode' )
.parentsUntil( '.ve-ce-attachedRootNode' )
.addClass( 've-ce-surface-reviewMode-highlightNode' );
} );
} else {
this.$element.find( '.ve-ce-surface-reviewMode-highlightNode' )
.removeClass( 've-ce-surface-reviewMode-highlightNode' );
}
};
/**
* Give focus to the surface, reapplying the model selection, or selecting the first visible offset
* if the model selection is null.
*
* This is used when switching between surfaces, e.g. when closing a dialog window. Calling this
* function will also reapply the selection, even if the surface is already focused.
*/
ve.ce.Surface.prototype.focus = function () {
Iif ( !this.attachedRoot.isLive() ) {
OO.ui.warnDeprecation( 'Tried to focus an un-initialized surface view. Wait for the ve.ui.Surface `ready` event to fire.' );
return;
}
let selection = this.getSelection();
Iif ( selection.getModel().isNull() ) {
this.selectFirstVisibleStartContentOffset();
selection = this.getSelection();
}
// Focus the contentEditable for text selections, or the clipboard handler for focusedNode selections
Iif ( selection.isFocusedNode() ) {
this.clipboardHandler.$element[ 0 ].focus();
} else Eif ( selection.isNativeCursor() ) {
let nodeAndOffset;
try {
nodeAndOffset = this.getDocument().getNodeAndOffset( selection.getModel().getRange().start );
} catch ( e ) {
// Unexplained failures causing log spam: T262487
nodeAndOffset = null;
}
Eif ( nodeAndOffset ) {
$( nodeAndOffset.node ).closest( '[contenteditable=true]' )[ 0 ].focus();
}
}
// If we are calling focus after replacing a node the selection may be gone
// but onDocumentFocus won't fire so restore the selection here too.
this.onModelSelect();
// setTimeout: postpone until onDocumentFocus has been called
setTimeout( () => {
// Support: Chrome
// In some browsers (e.g. Chrome) giving the document node focus doesn't
// necessarily give you a selection (e.g. if the first child is a <figure>)
// so if the surface isn't 'focused' (has no selection) give it a selection
// manually
// TODO: rename isFocused and other methods to something which reflects
// the fact they actually mean "has a native selection"
Eif ( !this.isFocused() ) {
this.selectFirstVisibleStartContentOffset();
}
} );
// onDocumentFocus takes care of the rest
};
/**
* Blur the surface
*/
ve.ce.Surface.prototype.blur = function () {
Iif ( this.deactivated ) {
// Clear the model selection, so activate doesn't trigger another de-activate
this.getModel().setNullSelection();
this.activate();
}
this.removeRangesAndBlur();
// This won't trigger focusin/focusout events, so trigger focus change manually
this.onFocusChange();
Iif ( OO.ui.isMobile() ) {
this.updateActiveAnnotations();
this.contexedAnnotations = [];
}
};
/**
* Remove all native selection ranges, and blur any active element
*
* This should hide all virtual keyboards when present.
*/
ve.ce.Surface.prototype.removeRangesAndBlur = function () {
this.nativeSelection.removeAllRanges();
if ( this.getElementDocument().activeElement === this.$attachedRootNode[ 0 ] ) {
// Blurring the activeElement ensures the keyboard is hidden on iOS
this.getElementDocument().activeElement.blur();
}
};
/**
* Handler for focusin and focusout events. Filters events and debounces to #onFocusChange.
*
* @param {jQuery.Event} e focusin/out event
*/
ve.ce.Surface.prototype.onDocumentFocusInOut = function () {
this.debounceFocusChange();
};
/**
* Handle global focus change.
*/
ve.ce.Surface.prototype.onFocusChange = function () {
const surfaceNodes = [
this.$attachedRootNode[ 0 ],
this.clipboardHandler.$element[ 0 ],
this.$highlights[ 0 ]
];
const hasFocus = OO.ui.contains(
surfaceNodes,
this.nativeSelection.anchorNode,
true
) && OO.ui.contains(
surfaceNodes,
document.activeElement,
true
);
if ( this.deactivated ) {
Iif ( OO.ui.contains( this.$attachedRootNode[ 0 ], this.nativeSelection.anchorNode, true ) ) {
this.onDocumentFocus();
}
} else {
if ( hasFocus && !this.isFocused() ) {
this.onDocumentFocus();
} else if ( !hasFocus && this.isFocused() ) {
this.onDocumentBlur();
} else Iif ( hasFocus && OO.ui.contains( this.$highlights[ 0 ], document.activeElement, true ) ) {
// Focus ended up in the higlight, e.g. by click on an already visible highlight.
// Move the cursor back to clipboard handler as we do when focusableNode initially selected.
// Without this, arrow key navigation from the focusable node would stop working.
this.prepareClipboardHandlerForCopy();
}
}
};
/**
* Check if the surface is deactivated.
*
* @return {boolean} Surface is deactivated
*/
ve.ce.Surface.prototype.isDeactivated = function () {
return this.deactivated;
};
/**
* Check if the surface is visibly deactivated.
*
* Only true if the surface was decativated by the user
* in a way that is expected to change the rendering.
*
* @return {boolean} Surface is visibly deactivated
*/
ve.ce.Surface.prototype.isShownAsDeactivated = function () {
return this.deactivated && !this.getSelectionManager().showDeactivatedAsActivated;
};
/**
* Deactivate the surface, stopping the surface observer and replacing the native
* range with a fake rendered one.
*
* Used by dialogs so they can take focus without losing the original document selection.
*
* @param {boolean} [showAsActivated=true] Surface should still show as activated
* @param {boolean} [noSelectionChange=false] Don't change the native selection.
* @param {boolean} [hideSelection=false] Completely hide the selection
* @fires ve.ce.Surface#activation
*/
ve.ce.Surface.prototype.deactivate = function ( showAsActivated, noSelectionChange, hideSelection ) {
Eif ( !this.deactivated ) {
// Disable the surface observer, there can be no observable changes
// until the surface is activated
this.surfaceObserver.disable();
this.deactivated = true;
this.previousActiveAnnotations = this.activeAnnotations;
this.findAndExecuteDelayedSequences();
this.$element.addClass( 've-ce-surface-deactivated' );
// Remove ranges so the user can't accidentally type into the document,
// and so virtual keyboards are hidden.
if ( !noSelectionChange ) {
this.removeRangesAndBlur();
// iOS Safari will sometimes restore the selection immediately (T293661)
setTimeout( () => {
Iif (
// Surface may have been immediately re-activated deliberately
this.deactivated &&
OO.ui.contains( this.$attachedRootNode[ 0 ], this.nativeSelection.anchorNode, true )
) {
this.removeRangesAndBlur();
}
} );
}
Iif ( hideSelection ) {
this.getSelectionManager().hideDeactivatedSelection();
} else {
this.getSelectionManager().showDeactivatedSelection( showAsActivated );
}
this.clearKeyDownState();
this.emit( 'activation' );
}
};
/**
* Reactivate the surface and restore the native selection
*
* @fires ve.ce.Surface#activation
* @fires ve.dm.Surface#contextChange
*/
ve.ce.Surface.prototype.activate = function () {
if ( this.deactivated ) {
this.deactivated = false;
this.getSelectionManager().hideDeactivatedSelection();
this.surfaceObserver.enable();
this.$element.removeClass( 've-ce-surface-deactivated' );
Iif ( OO.ui.isMobile() ) {
// Activating triggers a context hide on mobile
this.model.emit( 'contextChange' );
}
const previousSelection = this.getModel().getSelection();
Iif ( OO.ui.contains( this.$attachedRootNode[ 0 ], this.nativeSelection.anchorNode, true ) ) {
// The selection has been placed back in the document, either by the user clicking
// or by the closing window updating the model. Poll in case it was the user clicking.
this.surfaceObserver.clear();
this.surfaceObserver.pollOnce();
} else {
// Clear focused node so onModelSelect re-selects it if necessary
this.focusedNode = null;
this.onModelSelect();
}
const newSelection = this.getModel().getSelection();
Iif (
previousSelection.getCoveringRange() &&
newSelection.getCoveringRange() &&
previousSelection.getCoveringRange().containsRange(
newSelection.getCoveringRange()
)
) {
// If the user reactivates by clicking on their previous selection, use that selection.
this.getModel().setSelection( previousSelection );
// Restore active annotations
if ( this.previousActiveAnnotations.length ) {
const annotationClasses = this.previousActiveAnnotations.map( ( ann ) => ann.constructor );
this.selectAnnotation( ( view ) => ve.isInstanceOfAny( view, annotationClasses ) );
}
}
this.emit( 'activation' );
}
};
/**
* Check if the surface has a native cursor selection
*
* On mobile platforms, this means it is likely the virtual
* keyboard is visible.
*
* @return {boolean} Surface has a native cursor selection
*/
ve.ce.Surface.prototype.hasNativeCursorSelection = function () {
return !this.isDeactivated() && this.getSelection().isNativeCursor();
};
/**
* Handle document focus events.
*
* This is triggered by a global focusin/focusout event noticing a selection on the document.
*
* @fires ve.ce.Surface#focus
*/
ve.ce.Surface.prototype.onDocumentFocus = function () {
Iif ( this.getModel().getSelection().isNull() ) {
// If the document is being focused by a non-mouse/non-touch user event,
// find the first content offset and place the cursor there.
this.selectFirstVisibleStartContentOffset();
}
this.eventSequencer.attach( this.$element );
this.surfaceObserver.startTimerLoop();
this.focused = true;
this.activate();
this.$element.addClass( 've-ce-surface-focused' );
this.emit( 'focus' );
};
/**
* Handle document blur events.
*
* This is triggered by a global focusin/focusout event noticing no selection on the document.
*
* @fires ve.ce.Surface#blur
*/
ve.ce.Surface.prototype.onDocumentBlur = function () {
const nullSelectionOnBlur = this.surface.nullSelectionOnBlur;
if ( !nullSelectionOnBlur ) {
// Set noSelectionChange as we already know the selection has left
// the document and we don't want #deactivate to move it again.
this.deactivate( false, true );
}
this.eventSequencer.detach();
this.surfaceObserver.stopTimerLoop();
this.surfaceObserver.pollOnce();
this.surfaceObserver.clear();
// Setting focused to false blocks selection change handler, so fire one last time here
this.onDocumentSelectionChange();
this.setDragging( false );
this.focused = false;
if ( nullSelectionOnBlur ) {
if ( this.focusedNode ) {
this.focusedNode.setFocused( false );
this.focusedNode = null;
}
this.getModel().setNullSelection();
}
this.$element.removeClass( 've-ce-surface-focused' );
this.emit( 'blur' );
};
/**
* Check if surface is focused.
*
* @return {boolean} Surface is focused
*/
ve.ce.Surface.prototype.isFocused = function () {
return this.focused;
};
/**
* Handle document mouse down events.
*
* @param {jQuery.Event} e Mouse down event
*/
ve.ce.Surface.prototype.onDocumentMouseDown = function ( e ) {
Eif ( e.which !== OO.ui.MouseButtons.LEFT ) {
Eif ( e.which === OO.ui.MouseButtons.MIDDLE ) {
this.clipboardHandler.prepareForMiddleClickPaste( e );
}
return;
}
const offset = this.getOffsetFromEventCoords( e );
if ( offset !== -1 ) {
const contexedAnnotations = this.annotationsAtNode(
e.target,
( view ) => this.surface.context.getRelatedSourcesFromModels( [ view.model ] ).length
);
if (
OO.ui.isMobile() &&
// The user has clicked on contexed annotations and ...
contexedAnnotations.length && (
// ... was previously on a focusable node or ...
this.focusedNode ||
// ... previously had different annotations selected ...
!(
// Shallow strict equality check
this.contexedAnnotations.length === contexedAnnotations.length &&
this.contexedAnnotations.every( ( ann, i ) => ann === contexedAnnotations[ i ] )
)
)
) {
const node = e.target;
setTimeout( () => {
this.getModel().setLinearSelection( new ve.Range( offset ) );
// HACK: Re-activate flag so selection is repositioned
this.activate();
this.deactivate( false, false, true );
this.updateActiveAnnotations( node );
} );
this.contexedAnnotations = contexedAnnotations;
e.preventDefault();
return;
}
this.contexedAnnotations = contexedAnnotations;
}
// Remember the mouse is down
this.setDragging( true );
// Bind mouseup to the whole document in case of dragging out of the surface
this.$document.on( 'mouseup', this.onDocumentMouseUpHandler );
this.surfaceObserver.stopTimerLoop();
// setTimeout: In some browsers the selection doesn't change until after the event
// so poll in the 'after' function.
// TODO: rewrite to use EventSequencer
setTimeout( this.afterDocumentMouseDown.bind( this, e, this.getSelection() ) );
// Handle triple click
if ( e.originalEvent.detail >= 3 ) {
// Browser default behaviour for triple click won't behave as we want
e.preventDefault();
const newFragment = this.getModel().getFragment()
// After double-clicking in an inline slug, we'll get a selection like
// <p><span><img />|</span></p><p>|Foo</p>. This selection spans a CBN boundary,
// so we can't expand to the nearest CBN. To handle this case and other possible
// cases where the selection spans a CBN boundary, collapse the selection before
// expanding it. If the selection is entirely within the same CBN as it should be,
// this won't change the result.
.collapseToStart()
// Cover the CBN we're in
.expandLinearSelection( 'closest', ve.dm.ContentBranchNode )
// …but that covered the entire CBN, we only want the contents
.adjustLinearSelection( 1, -1 );
// If something weird happened (e.g. no CBN found), newFragment will be null.
// Don't select it in that case, because that'll blur the surface.
if ( !newFragment.isNull() ) {
newFragment.select();
}
}
};
/**
* Deferred until after document mouse down
*
* @param {jQuery.Event} e Mouse down event
* @param {ve.ce.Selection} selectionBefore Selection before the mouse event
*/
ve.ce.Surface.prototype.afterDocumentMouseDown = function ( e, selectionBefore ) {
// TODO: guard with incRenderLock?
this.surfaceObserver.pollOnce();
if ( e.shiftKey ) {
this.fixShiftClickSelect( selectionBefore );
}
};
/**
* Handle document mouse up events.
*
* @param {jQuery.Event} e Mouse up event
*/
ve.ce.Surface.prototype.onDocumentMouseUp = function ( e ) {
this.$document.off( 'mouseup', this.onDocumentMouseUpHandler );
this.surfaceObserver.startTimerLoop();
// setTimeout: In some browsers the selection doesn't change until after the event
// so poll in the 'after' function
// TODO: rewrite to use EventSequencer
setTimeout( this.afterDocumentMouseUp.bind( this, e, this.getSelection() ) );
};
/**
* Deferred until after document mouse up
*
* @param {jQuery.Event} e Mouse up event
* @param {ve.ce.Selection} selectionBefore Selection before the mouse event
*/
ve.ce.Surface.prototype.afterDocumentMouseUp = function ( e, selectionBefore ) {
// TODO: guard with incRenderLock?
this.surfaceObserver.pollOnce();
if ( e.shiftKey ) {
this.fixShiftClickSelect( selectionBefore );
}
this.setDragging( false );
};
/**
* Fix shift-click selection
*
* Support: Chrome
* When shift-clicking on links Chrome tries to collapse the selection
* so check for this and fix manually.
*
* This can occur on mousedown or, if the existing selection covers the
* link, on mouseup.
*
* https://code.google.com/p/chromium/issues/detail?id=345745
*
* @param {ve.ce.Selection} selectionBefore Selection before the mouse event
*/
ve.ce.Surface.prototype.fixShiftClickSelect = function ( selectionBefore ) {
if ( !selectionBefore.isNativeCursor() ) {
return;
}
const newSelection = this.getSelection();
if ( newSelection.getModel().isCollapsed() && !newSelection.equals( selectionBefore ) ) {
this.getModel().setLinearSelection(
new ve.Range(
selectionBefore.getModel().getRange().from,
newSelection.getModel().getRange().to
)
);
}
};
/**
* Set a flag when the user is dragging a selection
*
* @param {boolean} dragging Dragging (mouse is down)
*/
ve.ce.Surface.prototype.setDragging = function ( dragging ) {
this.dragging = !!dragging;
// Class can be used to suppress hover states, such as branch slugs.
this.$element.toggleClass( 've-ce-surface-dragging', this.dragging );
};
/**
* Handle document selection change events.
*
* @param {jQuery.Event} e Selection change event
*/
ve.ce.Surface.prototype.onDocumentSelectionChange = function () {
const selection = this.getModel().getSelection();
if (
// There is a non-empty selection in the VE surface. Use this if middle-click-to-paste is triggered later.
!selection.isCollapsed() ||
// There is no surface selection, and a native selection has been made elsewhere.
// Null the lastNonCollapsedDocumentSelection so native middle-click-to-paste happens instead.
( selection.isNull() && this.nativeSelection.rangeCount && !this.nativeSelection.getRangeAt( 0 ).collapsed )
) {
this.lastNonCollapsedDocumentSelection = selection;
}
// selectionChange events are only emitted from window.document, so ignore
// any events which are fired when the document is blurred or deactivated.
if ( !this.focused || this.deactivated ) {
return;
}
this.fixupCursorPosition( 0, this.dragging );
this.updateActiveAnnotations();
this.surfaceObserver.pollOnceSelection();
};
/**
* Handle document key down events.
*
* @param {jQuery.Event} e Key down event
*/
ve.ce.Surface.prototype.onDocumentKeyDown = function ( e ) {
const selection = this.getModel().getSelection();
let updateFromModel = false;
Iif ( selection.isNull() ) {
return;
}
Iif ( e.which === 229 ) {
// Support: Chrome
// Ignore fake IME events (emitted in Chrome)
return;
}
this.surfaceObserver.stopTimerLoop();
this.incRenderLock();
try {
// TODO: is this correct?
this.surfaceObserver.pollOnce();
} finally {
this.decRenderLock();
}
this.storeKeyDownState( e );
if ( ve.ce.keyDownHandlerFactory.executeHandlersForKey( e.keyCode, selection.getName(), this, e ) ) {
updateFromModel = true;
} else {
const trigger = new ve.ui.Trigger( e );
if ( trigger.isComplete() ) {
const executed = this.surface.executeWithSource( trigger, false, 'trigger' );
if ( executed || this.isBlockedTrigger( trigger ) ) {
e.preventDefault();
e.stopPropagation();
updateFromModel = true;
}
}
}
if (
!e.isDefaultPrevented() &&
e.keyCode === OO.ui.Keys.TAB &&
// Not modified (excluding shift)
!( e.metaKey || e.ctrlKey || e.altKey )
) {
// Manually move focus to the next/previous focusable element (T341687)
const surfaceNode = this.$element[ 0 ];
const treeWalker = document.createTreeWalker(
document.body,
NodeFilter.SHOW_ELEMENT,
( n ) => {
if ( surfaceNode.contains( n ) ) {
return NodeFilter.FILTER_REJECT;
}
Eif ( OO.ui.isFocusableElement( $( n ) ) ) {
return NodeFilter.FILTER_ACCEPT;
}
return NodeFilter.FILTER_SKIP;
}
);
treeWalker.currentNode = surfaceNode;
Iif ( e.shiftKey ) {
treeWalker.previousNode();
} else {
treeWalker.nextNode();
}
Eif ( treeWalker.currentNode ) {
treeWalker.currentNode.focus();
e.preventDefault();
e.stopPropagation();
return;
}
}
Iif (
this.readOnly && !(
// Allowed keystrokes in readonly mode:
// Arrows, simple navigation
ve.ce.LinearArrowKeyDownHandler.static.keys.indexOf( e.keyCode ) !== -1 ||
// Potential commands:
// Function keys...
( e.keyCode >= 112 && e.keyCode <= 123 ) ||
// ... or anything modified (e.g. copy / select-all), excluding shift
e.metaKey || e.ctrlKey || e.altKey
// Keys already handled in keyDownHandlers above do not need to be exempt here
)
) {
e.preventDefault();
e.stopPropagation();
return;
}
if ( !updateFromModel ) {
this.incRenderLock();
}
try {
this.surfaceObserver.pollOnce();
} finally {
if ( !updateFromModel ) {
this.decRenderLock();
}
}
this.surfaceObserver.startTimerLoop();
};
/**
* Check if a trigger event is blocked from performing its default behaviour
*
* If any of these triggers can't execute on the surface, (e.g. the underline
* command has been disabled), we should still preventDefault so ContentEditable
* native commands don't occur, leaving the view out of sync with the model.
*
* @param {ve.ui.Trigger} trigger Trigger to check
* @return {boolean} Trigger should preventDefault
*/
ve.ce.Surface.prototype.isBlockedTrigger = function ( trigger ) {
const triggerString = trigger.toString(),
platformKey = ve.getSystemPlatform() === 'mac' ? 'mac' : 'pc',
blockedIfRegisteredTriggers = [ 'tab', 'shift+tab' ],
blockedTriggers = {
mac: [ 'cmd+b', 'cmd+i', 'cmd+u', 'cmd+z', 'cmd+y', 'cmd+shift+z', 'cmd+[', 'cmd+]' ],
pc: [ 'ctrl+b', 'ctrl+i', 'ctrl+u', 'ctrl+z', 'ctrl+y', 'ctrl+shift+z' ]
};
// Special case: only block Tab/Shift+Tab if indentation commands are enabled on this surface,
// otherwise allow them to change focus
if ( blockedIfRegisteredTriggers.indexOf( triggerString ) !== -1 ) {
return !!this.surface.triggerListener.getCommandByTrigger( triggerString );
}
return blockedTriggers[ platformKey ].indexOf( triggerString ) !== -1;
};
/**
* Handle document key press events.
*
* @param {jQuery.Event} e Key press event
*/
ve.ce.Surface.prototype.onDocumentKeyPress = function ( e ) {
let selection;
// Handle the case where keyPress Enter is fired without a matching keyDown. This can
// happen with OS X Romanising Korean IMEs on Firefox, when pressing Enter with
// uncommitted candidate text; see T120156. Behave as though keyDown Enter has been
// fired.
Iif (
e.keyCode === OO.ui.Keys.ENTER &&
!this.keyDownState.event &&
// We're only aware of cases of this happening with uncommitted candidate text,
// which implies a native selection. But we instead perform a weaker test - for
// a non-null selection - to match that same test in onDocumentKeyDown
!( ( selection = this.getModel().getSelection() ).isNull() )
) {
this.surfaceObserver.stopTimerLoop();
if ( ve.ce.keyDownHandlerFactory.executeHandlersForKey( e.keyCode, selection.getName(), this, e ) ) {
this.surfaceObserver.pollOnce();
}
this.surfaceObserver.startTimerLoop();
return;
}
// Filter out non-character keys. Doing this prevents:
// * Unexpected content deletion when selection is not collapsed and the user presses, for
// example, the Home key (Firefox fires 'keypress' for it)
// TODO: Should be covered with Selenium tests.
if (
// Catches most keys that don't produce output (charCode === 0, thus no character)
e.which === 0 || e.charCode === 0 ||
// Opera 12 doesn't always adhere to that convention
e.keyCode === OO.ui.Keys.TAB || e.keyCode === OO.ui.Keys.ESCAPE ||
// Ignore all keypresses with Ctrl / Cmd modifier keys
ve.ce.isShortcutKey( e )
) {
return;
}
this.handleInsertion();
};
/**
* Deferred until after document key down event
*
* @param {jQuery.Event} e keydown event
*/
ve.ce.Surface.prototype.afterDocumentKeyDown = function ( e ) {
const documentModel = this.getModel().getDocument(),
isArrow = (
e.keyCode === OO.ui.Keys.UP ||
e.keyCode === OO.ui.Keys.DOWN ||
e.keyCode === OO.ui.Keys.LEFT ||
e.keyCode === OO.ui.Keys.RIGHT
);
let keyDownSelectionState = null;
/**
* Determine whether a position is editable, and if so which focusable node it is in
*
* We can land inside ce=false in many browsers:
* - Firefox has normal cursor positions at most node boundaries inside ce=false
* - Chromium has superfluous cursor positions around a ce=false img
* - IE hardly restricts editing at all inside ce=false
* If ce=false then we have landed inside the focusable node.
* If we land in a non-text position, assume we should have hit the node
* immediately after the position we hit (in the direction of motion)
* If we land inside a sequence of grouped nodes, assume we should treat them as a
* unit instead of letting the cursor slip inside them.
*
* @private
* @param {Node} node DOM node of cursor position
* @param {number} offset Offset of cursor position
* @param {number} dir Cursor motion direction (1=forward, -1=backward)
* @return {ve.ce.Node|null} node, or null if not in a focusable node
*/
const getSurroundingFocusableNode = ( node, offset, dir ) => {
let focusNode;
if ( node.nodeType === Node.TEXT_NODE ) {
focusNode = node;
} else Eif ( dir > 0 && offset < node.childNodes.length ) {
focusNode = node.childNodes[ offset ];
} else if ( dir < 0 && offset > 0 ) {
focusNode = node.childNodes[ offset - 1 ];
} else {
focusNode = node;
}
Eif ( ve.isContentEditable( focusNode ) ) {
// We are allowed to be inside this focusable node (e.g. editing a
// table cell or caption).
return null;
}
return $( focusNode ).closest( '.ve-ce-focusableNode, .ve-ce-tableNode' ).data( 'view' ) || null;
};
/**
* Compute the direction of cursor movement, if any
*
* Even if the user pressed a cursor key in the interior of the document, there may not
* be any movement: browser BIDI and ce=false handling can be quite quirky.
*
* Furthermore, the keydown selection nodes may have become detached since keydown (e.g.
* if ve.ce.ContentBranchNode#renderContents has run).
*
* @return {number|null} negative for startwards, positive for endwards, null for none
*/
const getDirection = () => (
isArrow &&
keyDownSelectionState &&
ve.compareDocumentOrder(
this.nativeSelection.focusNode,
this.nativeSelection.focusOffset,
keyDownSelectionState.focusNode,
keyDownSelectionState.focusOffset
)
) || null;
if ( e !== this.keyDownState.event ) {
return;
}
keyDownSelectionState = this.keyDownState.selectionState;
this.clearKeyDownState();
if (
( e.keyCode === OO.ui.Keys.BACKSPACE || e.keyCode === OO.ui.Keys.DELETE ) &&
this.nativeSelection.focusNode
) {
const inNonSlug = this.nativeSelection.focusNode.nodeType === Node.ELEMENT_NODE &&
!this.nativeSelection.focusNode.classList.contains( 've-ce-branchNode-inlineSlug' );
if ( inNonSlug ) {
// In a non-slug element. Sync the DM, then see if we need a slug.
this.incRenderLock();
try {
this.surfaceObserver.pollOnce();
} finally {
this.decRenderLock();
}
const dmSelection = this.model.getSelection();
if ( dmSelection instanceof ve.dm.LinearSelection ) {
const dmFocus = dmSelection.getRange().end;
const ceNode = this.documentView.getBranchNodeFromOffset( dmFocus );
if ( ceNode && ceNode.getModel().hasSlugAtOffset( dmFocus ) ) {
ceNode.setupBlockSlugs();
}
}
}
// Remove then re-set the selection, to clear any browser-native preannotations.
// This should be IME-safe because delete/backspace key events should only happen
// when there is no IME candidate window open.
//
// Note that if an IME removes text otherwise than by delete/backspace, then
// browser-native preannotations might still get applied. This can happen: see
// https://phabricator.wikimedia.org/T116275 .
// That's nasty, but it's not a reason to leave the delete/backspace case broken.
const ceSelection = new ve.SelectionState( this.nativeSelection );
this.nativeSelection.removeAllRanges();
this.showSelectionState( ceSelection );
if ( inNonSlug ) {
return;
}
}
// Only fixup cursoring on linear selections.
Iif ( isArrow && !( this.model.getSelection() instanceof ve.dm.LinearSelection ) ) {
return;
}
// Restore the selection and stop, if we cursored out of a table edit cell.
// Assumption: if we cursored out of a table cell, then none of the fixups below this point
// would have got the selection back inside the cell. Therefore it's OK to check here.
Iif ( isArrow && this.restoreActiveNodeSelection() ) {
return;
}
// If we landed in a cursor holder, select the corresponding focusable node instead
// (which, for a table, will select the first cell). Else if we arrowed a collapsed
// cursor across a focusable node, select the node instead.
const $focusNode = $( this.nativeSelection.focusNode );
let direction;
let focusableNode;
let range;
// eslint-disable-next-line no-jquery/no-class-state
if ( $focusNode.hasClass( 've-ce-cursorHolder' ) ) {
// eslint-disable-next-line no-jquery/no-class-state
if ( $focusNode.hasClass( 've-ce-cursorHolder-after' ) ) {
direction = -1;
focusableNode = $focusNode.prev().data( 'view' );
} else {
direction = 1;
focusableNode = $focusNode.next().data( 'view' );
}
this.removeCursorHolders();
} else if (
// If we arrowed a collapsed cursor into/across a focusable node, select the node instead
isArrow &&
!e.ctrlKey &&
!e.altKey &&
!e.metaKey &&
keyDownSelectionState &&
keyDownSelectionState.isCollapsed &&
this.nativeSelection.isCollapsed &&
( direction = getDirection() ) !== null
) {
focusableNode = getSurroundingFocusableNode(
this.nativeSelection.focusNode,
this.nativeSelection.focusOffset,
direction
);
Eif ( !focusableNode ) {
let startOffset, endOffset, offsetDiff;
// Calculate the DM offsets of our motion
try {
startOffset = ve.ce.getOffset(
keyDownSelectionState.focusNode,
keyDownSelectionState.focusOffset
);
endOffset = ve.ce.getOffset(
this.nativeSelection.focusNode,
this.nativeSelection.focusOffset
);
offsetDiff = endOffset - startOffset;
} catch ( ex ) {
startOffset = endOffset = offsetDiff = undefined;
}
if ( Math.abs( offsetDiff ) === 2 ) {
// Test whether we crossed a focusable node
// (this applies even if we cursored up/down)
focusableNode = documentModel.documentNode
.getNodeFromOffset( ( startOffset + endOffset ) / 2 );
Iif ( focusableNode.isFocusable() ) {
range = new ve.Range( startOffset, endOffset );
} else {
focusableNode = undefined;
}
}
}
}
Iif (
isArrow &&
direction > 0 &&
this.getActiveNode() instanceof ve.ce.TableCaptionNode &&
this.getActiveNode() !== $focusNode.closest( '.ve-ce-tableCaptionNode' ).data( 'view' )
) {
// We cursored down out of the table caption; move to the first table cell
const tableNode = this.getActiveNode().getParent();
this.model.setSelection( new ve.dm.TableSelection( tableNode.getOuterRange(), 0, 0 ) );
}
if ( focusableNode ) {
Eif ( !range ) {
range = focusableNode.getOuterRange();
if ( direction < 0 ) {
range = range.flip();
}
}
Iif ( focusableNode instanceof ve.ce.TableNode ) {
if ( direction > 0 ) {
let captionNode;
if ( ( captionNode = focusableNode.getModel().getCaptionNode() ) ) {
this.model.setLinearSelection(
documentModel.getRelativeRange( new ve.Range( captionNode.getRange().start ), 1 )
);
} else {
this.model.setSelection( new ve.dm.TableSelection(
range, 0, 0
) );
}
} else {
const matrix = focusableNode.getModel().getMatrix();
const row = matrix.getRowCount() - 1;
const col = matrix.getColCount( row ) - 1;
this.model.setSelection( new ve.dm.TableSelection(
range, col, row
) );
}
} else {
this.model.setLinearSelection( range );
}
if ( e.keyCode === OO.ui.Keys.LEFT ) {
this.cursorDirectionality = direction > 0 ? 'rtl' : 'ltr';
} else if ( e.keyCode === OO.ui.Keys.RIGHT ) {
this.cursorDirectionality = direction < 0 ? 'rtl' : 'ltr';
}
// else up/down pressed; leave this.cursorDirectionality as null
// (it was set by setLinearSelection calling onModelSelect)
}
if ( direction === undefined ) {
direction = getDirection();
}
const fixupCursorForUnicorn = (
!e.shiftKey &&
( e.keyCode === OO.ui.Keys.LEFT || e.keyCode === OO.ui.Keys.RIGHT )
);
const removedUnicorns = this.cleanupUnicorns( fixupCursorForUnicorn );
Iif ( removedUnicorns ) {
this.surfaceObserver.pollOnceNoCallback();
} else {
this.incRenderLock();
try {
this.surfaceObserver.pollOnce();
} finally {
this.decRenderLock();
}
}
this.fixupCursorPosition( direction, e.shiftKey );
};
/**
* Check whether the DOM selection has moved out of the unicorned area (i.e. is not currently
* between two unicorns) and if so, set the model selection from the DOM selection, destroy the
* unicorns and return true. If there are no active unicorns, this function does nothing and
* returns false.
*
* If the unicorns are destroyed as a consequence of the user moving the cursor across a unicorn
* with the left/rightarrow keys, the cursor will have to be moved again to produce the cursor
* movement the user expected. Set the fixupCursor parameter to true to enable this behavior.
*
* @param {boolean} fixupCursor If destroying unicorns, fix up left/rightarrow cursor position
* @return {boolean} Whether unicorns have been destroyed
*/
ve.ce.Surface.prototype.cleanupUnicorns = function ( fixupCursor ) {
if ( !this.unicorningNode || !this.unicorningNode.unicorns ) {
return false;
}
const preUnicorn = this.unicorningNode.unicorns[ 0 ];
Iif ( !this.$attachedRootNode[ 0 ].contains( preUnicorn ) ) {
return false;
}
if ( this.nativeSelection.rangeCount === 0 ) {
// XXX do we want to clear unicorns in this case?
return false;
}
const range = this.nativeSelection.getRangeAt( 0 );
// Test whether the selection endpoint is between unicorns. If so, do nothing.
// Unicorns can only contain text, so just move backwards until we hit a non-text node.
let node = range.endContainer;
Eif ( node.nodeType === Node.ELEMENT_NODE ) {
node = range.endOffset > 0 ? node.childNodes[ range.endOffset - 1 ] : null;
}
while ( node !== null && node.nodeType === Node.TEXT_NODE ) {
node = node.previousSibling;
}
if ( node === preUnicorn ) {
return false;
}
// Selection endpoint is not between unicorns.
// Test whether it is before or after the pre-unicorn (i.e. before/after both unicorns)
let fixup;
if ( ve.compareDocumentOrder(
range.endContainer,
range.endOffset,
preUnicorn.parentNode,
ve.parentIndex( preUnicorn )
) <= 0 ) {
// Before the pre-unicorn (including in the equality case, because the selection
// endpoint is an offset between sibling positions)
fixup = -1;
} else {
// At or after the pre-unicorn (actually must be after the post-unicorn)
fixup = 1;
}
const contentBranchNodeBefore = this.getSelectedContentBranchNode();
Iif ( this.unicorningNode !== contentBranchNodeBefore ) {
this.setNotUnicorningAll();
return true;
}
// Apply the DOM selection to the model
const veRange = ve.ce.veRangeFromSelection( this.nativeSelection );
if ( veRange ) {
this.incRenderLock();
try {
// The most likely reason for this condition to not-pass is if we
// try to cleanup unicorns while the native selection is outside
// the model momentarily, as sometimes happens during paste.
this.changeModel( null, new ve.dm.LinearSelection( veRange ) );
Iif ( fixupCursor ) {
this.moveModelCursor( fixup );
}
} finally {
this.decRenderLock();
}
}
const contentBranchNodeAfter = this.getSelectedContentBranchNode();
Eif ( contentBranchNodeAfter ) {
contentBranchNodeAfter.renderContents();
}
Iif ( contentBranchNodeBefore && contentBranchNodeBefore !== contentBranchNodeAfter ) {
contentBranchNodeBefore.renderContents();
}
// Don't modify selection while pasting (T368598)
Eif ( !this.clipboardHandler.pasting ) {
this.showModelSelection();
}
return true;
};
/**
* Handle document key up events.
*
* @param {jQuery.Event} e Key up event
* @fires ve.ce.Surface#keyup
*/
ve.ce.Surface.prototype.onDocumentKeyUp = function () {
this.emit( 'keyup' );
};
/**
* Handle the insertion of a data transfer object
*
* @param {DataTransfer} dataTransfer Data transfer
* @param {boolean} isPaste Handlers being used for paste
* @param {ve.dm.SurfaceFragment} [targetFragment] Fragment to insert data items at, defaults to current selection
* @return {boolean} One more items was handled
*/
ve.ce.Surface.prototype.handleDataTransfer = function ( dataTransfer, isPaste, targetFragment ) {
const items = [],
htmlStringData = dataTransfer.getData( 'text/html' );
// Rules for clipboard content selection:
// 1. If the clipboard has only HTML, proceed parsing such HTML.
// 2. If the clipboard has only files, process them as-is.
// 3. If the clipboard has both:
// a. If the HTML in the clipboard contains only images and other elements with no text, process the image files.
// b. Otherwise, ignore the files and process the HTML.
//
// Notes:
// - If a file is pasted/dropped, it may have HTML fallback, such as an IMG node with alt text, for example.
// - HTML generated from some clients has an image fallback(!) that is a screenshot of the HTML snippet (e.g. LibreOffice Calc)
if ( !htmlStringData ) {
if ( dataTransfer.items ) {
for ( let i = 0, l = dataTransfer.items.length; i < l; i++ ) {
if ( dataTransfer.items[ i ].kind !== 'string' ) {
items.push( ve.ui.DataTransferItem.static.newFromItem( dataTransfer.items[ i ], htmlStringData ) );
}
}
} else Eif ( dataTransfer.files && dataTransfer.files.length ) {
for ( let i = 0, l = dataTransfer.files.length; i < l; i++ ) {
items.push( ve.ui.DataTransferItem.static.newFromBlob( dataTransfer.files[ i ], htmlStringData ) );
}
}
} else if ( dataTransfer.files && dataTransfer.files.length ) {
const htmlPreParse = $.parseHTML( htmlStringData );
let imgCount = 0;
let hasContent = false;
for ( let i = 0; i < htmlPreParse.length; i++ ) {
// Count images in root nodes
if ( htmlPreParse[ i ].nodeName === 'IMG' ) {
imgCount++;
} else if (
( htmlPreParse[ i ].nodeType === 1 || htmlPreParse[ i ].nodeType === 3 ) &&
htmlPreParse[ i ].textContent &&
htmlPreParse[ i ].textContent.trim() !== ''
) {
// Only count element nodes (type 1) or text nodes (type 3)
// that have non empty text content.
hasContent = true;
}
// Count images in children
if ( typeof htmlPreParse[ i ].querySelectorAll === 'function' ) {
imgCount += htmlPreParse[ i ].querySelectorAll( 'img' ).length;
}
}
if ( !hasContent && imgCount === dataTransfer.files.length ) {
for ( let i = 0, l = dataTransfer.files.length; i < l; i++ ) {
// TODO: should we use image node outerHTML instead of htmlStringData?
items.push( ve.ui.DataTransferItem.static.newFromBlob( dataTransfer.files[ i ], htmlStringData ) );
}
}
}
if ( dataTransfer.items ) {
// Extract "string" types.
for ( let i = 0, l = dataTransfer.items.length; i < l; i++ ) {
if (
dataTransfer.items[ i ].kind === 'string' &&
dataTransfer.items[ i ].type.slice( 0, 5 ) === 'text/'
) {
items.push( ve.ui.DataTransferItem.static.newFromString(
dataTransfer.getData( dataTransfer.items[ i ].type ),
dataTransfer.items[ i ].type,
htmlStringData
) );
}
}
}
// We care a little bit about the order of items, as the first one matched
// is going to be the one we handle, and don't trust dataTransfer.items to
// be in the fallback order we'd prefer. In practice, this just means that
// we want to text/html and text/plain to be at the end of the list, as
// they tend to show up as common fallbacks.
const pushItemToBack = function ( array, type ) {
for ( let j = 0, jlen = array.length; j < jlen; j++ ) {
if ( array[ j ].type === type ) {
return array.push( array.splice( j, 1 )[ 0 ] );
}
}
};
pushItemToBack( items, 'text/html' );
pushItemToBack( items, 'text/plain' );
return this.handleDataTransferItems( items, isPaste, targetFragment );
};
/**
* Handle the insertion of data transfer items
*
* @param {ve.ui.DataTransferItem[]} items Data transfer items
* @param {boolean} isPaste Handlers being used for paste
* @param {ve.dm.SurfaceFragment} [targetFragment] Fragment to insert data items at, defaults to current selection
* @return {boolean} One more items was handled
*/
ve.ce.Surface.prototype.handleDataTransferItems = function ( items, isPaste, targetFragment ) {
targetFragment = targetFragment || this.getModel().getFragment();
function insert( docOrData ) {
// For non-paste transfers, don't overwrite the selection
const resultFragment = !isPaste ? targetFragment.collapseToEnd() : targetFragment;
Iif ( docOrData instanceof ve.dm.Document ) {
const rootChildren = docOrData.getDocumentNode().children;
if (
rootChildren[ 0 ] &&
rootChildren[ 0 ].type === 'paragraph' &&
( !rootChildren[ 1 ] || rootChildren[ 1 ].type === 'internalList' )
) {
resultFragment.insertDocument(
docOrData,
rootChildren[ 0 ].getRange()
);
} else {
resultFragment.insertDocument( docOrData );
}
} else {
resultFragment.insertContent( docOrData );
}
// The resultFragment's selection now covers the inserted content;
// adjust selection to end of inserted content.
resultFragment.collapseToEnd().select();
}
const dataTransferHandlerFactory = this.getSurface().dataTransferHandlerFactory;
let handled = false;
for ( let i = 0, l = items.length; i < l; i++ ) {
const item = items[ i ];
const name = dataTransferHandlerFactory.getHandlerNameForItem( item, isPaste, this.clipboardHandler.isPasteSpecial() );
if ( name ) {
dataTransferHandlerFactory.create( name, this.surface, item )
.getInsertableData().done( insert );
handled = true;
break;
} else if ( isPaste && item.type === 'text/html' ) {
// Don't handle anything else if text/html is available, as it is handled specially in #afterPaste
break;
}
}
return handled;
};
/**
* Select all the contents within the current context
*/
ve.ce.Surface.prototype.selectAll = function () {
const selection = this.getModel().getSelection(),
dmDoc = this.getModel().getDocument();
if ( selection instanceof ve.dm.LinearSelection ) {
const activeNode = this.getActiveNode();
let range;
Iif ( activeNode ) {
range = activeNode.getRange();
range = new ve.Range( range.from + 1, range.to - 1 );
} else {
const documentRange = this.getModel().getDocument().getDocumentRange();
range = new ve.Range(
dmDoc.getNearestCursorOffset( 0, 1 ),
dmDoc.getNearestCursorOffset( documentRange.end, -1 )
);
}
this.getModel().setLinearSelection( range );
} else Eif ( selection instanceof ve.dm.TableSelection ) {
const matrix = selection.getTableNode( dmDoc ).getMatrix();
this.getModel().setSelection(
new ve.dm.TableSelection(
selection.tableRange,
0, 0, matrix.getMaxColCount() - 1, matrix.getRowCount() - 1
)
);
}
};
/**
* Handle beforeinput events.
*
* @param {jQuery.Event} e The input event
*/
ve.ce.Surface.prototype.onDocumentBeforeInput = function ( e ) {
if ( this.getSelection().isNativeCursor() ) {
const inputType = e.originalEvent ? e.originalEvent.inputType : null;
// Support: Chrome (Android, Gboard)
// Handle IMEs that emit text fragments with a trailing newline on Enter keypress (T312558)
if (
( inputType === 'insertText' || inputType === 'insertCompositionText' ) &&
e.originalEvent.data && e.originalEvent.data.slice( -1 ) === '\n'
) {
// The event will have inserted a newline into the CE view,
// so fix up the DM accordingly depending on the context.
this.eventSequencer.afterOne( {
beforeinput: this.fixupChromiumNativeEnter.bind( this )
} );
}
}
};
/**
* Remove unwanted DOM elements from the CE view, inserted by Chromium's native Enter handling.
* We preventDefault an Enter keydown event, but the native handling can still happen with some
* IME combinations, e.g. Gboard on Android Chromium in many languages including English when
* there is candidate text (T312558).
*/
ve.ce.Surface.prototype.fixupChromiumNativeEnter = function () {
const setCursorToEnd = ( element ) => {
if ( !element ) {
return;
}
const range = this.getElementDocument().createRange();
range.setStart( element, element.childNodes.length );
range.setEnd( element, element.childNodes.length );
this.nativeSelection.removeAllRanges();
this.nativeSelection.addRange( range );
};
let fixedUp = false;
// Test for Chromium native Enter inside a <li class="foo"><p class="bar">...</p></li>
// creating unwanted trailing <li class="foo"><p class="bar"><br></p></li>,
// assuming it (initially) leaves the selection in the original list item.
const listItemNode = $( this.nativeSelection.focusNode ).closest( 'li.ve-ce-branchNode' )[ 0 ];
if ( listItemNode ) {
const nextNode = listItemNode.nextElementSibling;
if ( nextNode && !$.data( nextNode, 'view' ) ) {
// We infer the native Enter action added a spurious DOM node that does
// not exist in the view. Remove it and flag that we need to perform a
// VE Enter action.
nextNode.parentNode.removeChild( nextNode );
fixedUp = true;
}
}
// Test for Chromium native Enter inside a <p class="foo"></p>, while there is
// candidate text, creating a spurious trailing <div><br></div>, and (immediately)
// putting the cursor inside it.
//
// Note if the paragraph is a grandchild of the list item, it's not clear under what
// circumstances Chromium creates a div vs a list item, so perform this check even if
// a fixup already happened in the lines of code above.
const div = $( this.nativeSelection.focusNode ).closest( 'div' )[ 0 ];
if ( div && this.$documentNode[ 0 ].contains( div ) && !$.data( div, 'view' ) ) {
// The div is inside a branch node, but has no view. We infer the native Enter
// action added a spurious DOM node that does not exist in the view. Remove it and
// flag that we need to perform a VE enter action.
setCursorToEnd( div.previousElementSibling );
div.parentNode.removeChild( div );
fixedUp = true;
}
// If we found nodes to fixup, that means the VE Enter handler never ran (since it would
// have prevented the Enter event), so execute it now to perform the context-appropriate
// operation.
if ( fixedUp ) {
// First, poll current node for content changes, because any autocorrect change
// will not have reached the model. The logic above ensures the cursor will be
// inside the ContentBranchNode where the user was typing in either case.
this.surfaceObserver.pollOnce();
ve.ce.keyDownHandlerFactory.lookup( 'linearEnter' ).static.execute( this, new Event( 'dummy' ) );
}
};
/**
* Handle input events.
*
* @param {jQuery.Event} e The input event
*/
ve.ce.Surface.prototype.onDocumentInput = function ( e ) {
// Synthetic events don't have the originalEvent property (T176104)
const inputType = e.originalEvent ? e.originalEvent.inputType : null;
// Special handling of NBSP insertions. T53045
// NBSPs are converted to normal spaces in ve.ce.TextState as they can be
// inserted by ContentEditable in unexpected places, or accidentally imported
// by copy-paste. Usually they are not intended, but if we detect an NBSP in
// an insertion event that means it was probably intentional, e.g. inserted
// by a specific keyboard shortcut, or IME sequence.
Iif (
this.getSelection().isNativeCursor() &&
( inputType === 'insertText' || inputType === 'insertCompositionText' ) &&
e.originalEvent.data === '\u00a0'
) {
// Wait for the insertion to happen
setTimeout( () => {
const fragment = this.getModel().getFragment().adjustLinearSelection( -1 );
let nbspContent = ' ';
if ( this.getSurface().getMode() === 'visual' ) {
nbspContent = ve.init.platform.decodeEntities( nbspContent );
}
// Check a plain space was inserted and replace it with an NBSP.
if ( fragment.getText() === ' ' ) {
fragment.insertContent( nbspContent ).collapseToEnd().select();
}
} );
}
let command;
const inputTypeCommands = this.constructor.static.inputTypeCommands;
Iif ( inputType && Object.prototype.hasOwnProperty.call( inputTypeCommands, inputType ) ) {
command = inputTypeCommands[ inputType ];
}
Iif ( command !== undefined ) {
// Conditionally descend into commands like { collapsed: 'foo', uncollapsed: 'bar' }
if ( command !== null && typeof command === 'object' ) {
if ( this.getSelection().getModel().isCollapsed() ) {
command = command.collapsed;
} else {
command = command.uncollapsed;
}
}
// command might be undefined again now
if ( command !== undefined ) {
if ( command === null ) {
e.preventDefault();
} else {
this.getSurface().executeCommand( command );
e.preventDefault();
}
return;
}
}
this.incRenderLock();
try {
this.surfaceObserver.pollOnce();
} finally {
this.decRenderLock();
}
};
/**
* Handle compositionstart events.
* Note that their meaning varies between browser/OS/IME combinations
*
* @param {jQuery.Event} e The compositionstart event
*/
ve.ce.Surface.prototype.onDocumentCompositionStart = function () {
// Eagerly trigger emulated deletion on certain selections, to ensure a ContentEditable
// native node merge never happens. See https://phabricator.wikimedia.org/T123716 .
Iif (
this.model.selection instanceof ve.dm.TableSelection &&
$.client.profile().layout === 'gecko'
) {
// Support: Firefox <= ~51
// Work around a segfault on blur+focus in Firefox compositionstart handlers.
// It would get triggered by handleInsertion emptying the table cell then putting
// a linear selection inside it. See:
// https://phabricator.wikimedia.org/T86589
// https://bugzilla.mozilla.org/show_bug.cgi?id=1230473
return;
}
this.handleInsertion();
};
/* Custom Events */
/**
* Handle model select events.
*
* @see ve.dm.Surface#method-change
*/
ve.ce.Surface.prototype.onModelSelect = function () {
const selection = this.getModel().getSelection();
setTimeout( this.findAndExecuteDelayedSequences.bind( this ) );
this.cursorDirectionality = null;
this.contentBranchNodeChanged = false;
this.selection = null;
if ( selection.isNull() ) {
this.removeCursorHolders();
}
if ( selection instanceof ve.dm.LinearSelection ) {
const blockSlug = this.findBlockSlug( selection.getRange() );
if ( blockSlug !== this.focusedBlockSlug ) {
if ( this.focusedBlockSlug ) {
this.focusedBlockSlug.classList.remove(
've-ce-branchNode-blockSlug-focused'
);
this.focusedBlockSlug = null;
}
if ( blockSlug ) {
blockSlug.classList.add( 've-ce-branchNode-blockSlug-focused' );
this.focusedBlockSlug = blockSlug;
this.prepareClipboardHandlerForCopy();
}
}
const focusedNode = this.findFocusedNode( selection.getRange() );
Iif ( this.isDeactivated() && !this.isShownAsDeactivated() && !blockSlug && !focusedNode ) {
// If deactivated without showing (e.g. by prepareClipboardHandlerForCopy),
// reactivate when changing selection (T221291)
// TODO: It is really messy that the surface can get reactivated based on the state of
// a flag that should just be used for rendering (isShownAsDeactivated). This led to
// T236400 so should be fixed.
this.activate();
}
// If focus has changed, update nodes and this.focusedNode
if ( focusedNode !== this.focusedNode ) {
if ( this.focusedNode ) {
this.focusedNode.setFocused( false );
this.focusedNode = null;
}
if ( focusedNode ) {
focusedNode.setFocused( true );
this.focusedNode = focusedNode;
// If dragging, we already have a native selection, so don't mess with it
Eif ( !this.dragging ) {
this.prepareClipboardHandlerForCopy();
// Since the selection is no longer in the root, clear the SurfaceObserver's
// selection state. Otherwise, if the user places the selection back into the root
// in exactly the same place where it was before, the observer won't consider that a change.
this.surfaceObserver.clear();
}
}
}
} else {
if ( selection instanceof ve.dm.TableSelection ) {
this.prepareClipboardHandlerForCopy();
}
if ( this.focusedNode ) {
this.focusedNode.setFocused( false );
}
this.focusedNode = null;
}
// Deactivate immediately if mobile and read-only to avoid showing keyboard (T281771)
Iif ( this.isReadOnly() && OO.ui.isMobile() ) {
this.deactivate( false, false, true );
}
// Ignore the selection if changeModelSelection is currently being
// called with the same (object-identical) selection object
// (i.e. if the model is calling us back)
if ( !this.isRenderingLocked() && selection !== this.newModelSelection ) {
this.showModelSelection();
this.cleanupUnicorns( false );
}
// Update the selection state in the SurfaceObserver
this.surfaceObserver.pollOnceNoCallback();
};
/**
* Prepare the clipboard handler for a copy event by selecting some text
*
* @param {boolean} force Force a native selection, even on mobile (used for click-to-copy)
*/
ve.ce.Surface.prototype.prepareClipboardHandlerForCopy = function ( force ) {
// As FF won't fire a copy event with nothing selected, create a native selection.
// If there is a focusedNode available, use its text content so that context menu
// items such as "Search for [SELECTED TEXT]" make sense. If the text is empty or
// whitespace, use a single unicode character as this is required for programmatic
// selection to work correctly in all browsers (e.g. Safari won't select a single space).
// clipboardHandler#onCopy will ignore this native selection and use the DM selection
if ( force || !OO.ui.isMobile() ) {
this.clipboardHandler.prepareForCopy();
} else E{
// Selecting the clipboard handler fails on mobile:
// * On iOS The selection stays visible and causes scrolling
// * The user is unlikely to be able to trigger a keyboard copy anyway
// Instead just deactivate the surface so the native cursor doesn't
// get in the way and the on screen keyboard doesn't show.
// TODO: Provide a copy tool in the context menu (T202278)
this.deactivate( true );
}
};
/**
* Get the focused node (optionally at a specified range), or null if one is not present
*
* @param {ve.Range} [range] Optional range to check for focused node, defaults to current selection's range
* @return {ve.ce.Node|null} Focused node
*/
ve.ce.Surface.prototype.getFocusedNode = function ( range ) {
if ( !range ) {
return this.focusedNode;
}
const selection = this.getModel().getSelection();
if (
selection instanceof ve.dm.LinearSelection &&
range.equalsSelection( selection.getRange() )
) {
return this.focusedNode;
}
return this.findFocusedNode( range );
};
/**
* Find the block slug a given range is in.
*
* @param {ve.Range} range Range to check
* @return {HTMLElement|null} Slug, or null if no slug or if range is not collapsed
* @throws {Error} If range is inside internal list
*/
ve.ce.Surface.prototype.findBlockSlug = function ( range ) {
if ( !range.isCollapsed() ) {
return null;
}
const node = this.documentView.getBranchNodeFromOffset( range.end );
if ( !node || !node.canHaveChildrenNotContent() ) {
// Node can not have block slugs (only inline slugs)
return null;
}
return node.getSlugAtOffset( range.end );
};
/**
* Find the focusedNode at a specified range
*
* @param {ve.Range} range Range to search at for a focusable node
* @return {ve.ce.Node|null} Focused node
*/
ve.ce.Surface.prototype.findFocusedNode = function ( range ) {
const documentNode = this.getDocument().getDocumentNode();
// Detect when only a single focusable element is selected
let startNode;
if ( !range.isCollapsed() ) {
startNode = documentNode.getNodeFromOffset( range.start + 1 );
if ( startNode && startNode.isFocusable() ) {
const endNode = documentNode.getNodeFromOffset( range.end - 1 );
if ( startNode === endNode ) {
return startNode;
}
}
} else {
// Check if the range is inside a focusable node with a collapsed selection
startNode = documentNode.getNodeFromOffset( range.start );
Iif ( startNode && startNode.isFocusable() ) {
return startNode;
}
}
return null;
};
/**
* Handle documentUpdate events on the surface model.
*
* @fires ve.ce.Surface#position
*/
ve.ce.Surface.prototype.onModelDocumentUpdate = function () {
if ( this.contentBranchNodeChanged ) {
// Update the selection state from model
this.onModelSelect();
}
// Update the state of the SurfaceObserver
this.surfaceObserver.pollOnceNoCallback();
const wasSynchronizing = !!( this.getModel().synchronizer && this.getModel().synchronizer.applying );
// setTimeout: Wait for other documentUpdate listeners to run before emitting
setTimeout( () => {
this.emit( 'position', wasSynchronizing );
} );
};
/**
* Handle insertionAnnotationsChange events on the surface model.
*
* @param {ve.dm.AnnotationSet} insertionAnnotations
*/
ve.ce.Surface.prototype.onInsertionAnnotationsChange = function () {
const changed = this.renderSelectedContentBranchNode();
if ( !changed ) {
return;
}
// Must re-apply the selection after re-rendering
this.forceShowModelSelection();
this.surfaceObserver.pollOnceNoCallback();
};
/**
* Get the ContentBranchNode containing the selection focus, if any
*
* @return {ve.ce.ContentBranchNode|null} ContentBranchNode containing selection focus, or null
*/
ve.ce.Surface.prototype.getSelectedContentBranchNode = function () {
const selection = this.model.getSelection();
if ( !( selection instanceof ve.dm.LinearSelection ) ) {
return null;
}
const node = this.documentView.getBranchNodeFromOffset( selection.getRange().to );
Iif ( !node || !( node instanceof ve.ce.ContentBranchNode ) ) {
return null;
}
return node;
};
/**
* Re-render the ContentBranchNode containing the selection focus, if any
*
* @return {boolean} Whether a re-render actually happened
*/
ve.ce.Surface.prototype.renderSelectedContentBranchNode = function () {
const node = this.getSelectedContentBranchNode();
if ( !node ) {
return false;
}
return node.renderContents();
};
/**
* Handle changes observed from the DOM
*
* These are normally caused by the user interacting directly with the contenteditable.
*
* @param {ve.ce.RangeState|null} oldState The prior range state, if any
* @param {ve.ce.RangeState} newState The changed range state
*/
ve.ce.Surface.prototype.handleObservedChanges = function ( oldState, newState ) {
const dmDoc = this.getModel().getDocument();
let insertedText = false,
removedText = false;
if ( newState.contentChanged ) {
Iif ( this.readOnly ) {
newState.node.renderContents();
this.showModelSelection();
return;
} else {
const transaction = newState.textState.getChangeTransaction(
oldState.textState,
dmDoc,
newState.node.getOffset(),
newState.node.unicornAnnotations
);
if ( transaction ) {
this.incRenderLock();
try {
this.changeModel( transaction );
} finally {
this.decRenderLock();
}
insertedText = transaction.operations.some( ( op ) => op.type === 'replace' && op.insert.length );
removedText = transaction.operations.some( ( op ) => op.type === 'replace' && op.remove.length );
}
}
}
if (
!this.readOnly &&
newState.branchNodeChanged &&
oldState &&
oldState.node &&
oldState.node.root &&
oldState.node instanceof ve.ce.ContentBranchNode
) {
oldState.node.renderContents();
}
if ( newState.selectionChanged && !(
// Ignore when the newRange is just a flipped oldRange
oldState &&
oldState.veRange &&
newState.veRange &&
!newState.veRange.isCollapsed() &&
oldState.veRange.equalsSelection( newState.veRange )
) ) {
let newSelection;
if ( newState.veRange ) {
if ( newState.veRange.isCollapsed() ) {
const offset = dmDoc.getNearestCursorOffset( newState.veRange.from, 0 );
Iif ( offset === -1 ) {
// First, if we're in a document which outright doesn't
// have any content to select, don't try to set one. These
// would be niche documents, since slugs normally exist
// and catch those cases.
newSelection = new ve.dm.NullSelection();
// TODO: Unset whatever native selection got us here, to match
// the model state (assuming it is in the CE document)
} else {
// If we're placing the cursor, make sure it winds up in a
// cursorable location. Failure to do this can result in
// strange behavior when inserting content immediately after
// clicking on the surface.
newSelection = new ve.dm.LinearSelection( new ve.Range( offset ) );
}
} else E{
newSelection = new ve.dm.LinearSelection( newState.veRange );
}
} else {
newSelection = new ve.dm.NullSelection();
}
this.incRenderLock();
try {
this.changeModel( null, newSelection );
if ( newSelection instanceof ve.dm.LinearSelection && newSelection.isCollapsed() ) {
const blockSlug = this.findBlockSlug( newSelection.getRange() );
if ( blockSlug ) {
// Set the DOM selection, in case the model selection did not change but
// the DOM selection did (T201599).
this.prepareClipboardHandlerForCopy();
this.surfaceObserver.pollOnceNoCallback();
}
}
} finally {
this.decRenderLock();
}
const removedUnicorns = this.cleanupUnicorns( false );
Iif ( removedUnicorns ) {
this.surfaceObserver.pollOnceNoCallback();
}
// Ensure we don't observe a selection that breaks out of the active node
const activeNode = this.getActiveNode();
const coveringRange = newSelection.getCoveringRange();
Iif ( activeNode && coveringRange ) {
const nodeRange = activeNode.getRange();
const containsStart = nodeRange.containsRange( new ve.Range( coveringRange.start ) );
const containsEnd = nodeRange.containsRange( new ve.Range( coveringRange.end ) );
// If the range starts xor ends in the active node, but not both, then it must
// span an active node boundary, so fixup.
if ( containsStart !== containsEnd ) {
newSelection = oldState && oldState.veRange ?
new ve.dm.LinearSelection( oldState.veRange ) :
new ve.dm.NullSelection();
// TODO: setTimeout: document purpose
setTimeout( () => {
this.changeModel( null, newSelection );
this.showModelSelection();
} );
}
}
// Support: Firefox
// Firefox lets you create multiple selections within a single paragraph
// which our model doesn't support, so detect and prevent these.
// This shouldn't create problems with IME candidates as only an explicit user
// action can create a multiple selection (CTRL+click), and we remove it
// immediately, so there can never be a multiple selection while the user is
// typing text; therefore the selection change will never commit IME candidates
// prematurely.
while ( this.nativeSelection.rangeCount > 1 ) {
// The current range is the last range, so remove ranges from the front
this.nativeSelection.removeRange( this.nativeSelection.getRangeAt( 0 ) );
}
}
if ( insertedText ) {
this.afterRenderLock( () => {
this.findAndExecuteSequences();
this.maybeSetBreakpoint();
} );
} else if ( removedText ) {
this.afterRenderLock( () => {
this.findAndExecuteSequences( false, true );
this.maybeSetBreakpoint();
} );
}
if ( newState.branchNodeChanged && newState.node ) {
this.updateCursorHolders();
this.showModelSelection();
}
if ( !insertedText ) {
// Two likely cases here:
// 1. The cursor moved. If so, fire off a breakpoint to catch any transactions
// that were pending, in case a word was being typed.
// 2. Text was deleted. If so, make a breakpoint. A future enhancement could be
// to make this only break after a sequence of deletes. (Maybe combine new
// breakpoints with the former breakpoint based on the new transactions?)
this.getModel().breakpoint();
}
};
/**
* Create a slug out of a DOM element
*
* @param {HTMLElement} element Slug element
* @fires ve.ce.Surface#position
*/
ve.ce.Surface.prototype.createSlug = function ( element ) {
const offset = ve.ce.getOffsetOfSlug( element ),
documentModel = this.getModel().getDocument(),
slugHeight = element.scrollHeight;
this.changeModel( ve.dm.TransactionBuilder.static.newFromInsertion(
documentModel, offset, [
{ type: 'paragraph', internal: { generated: 'slug' } },
{ type: '/paragraph' }
]
), new ve.dm.LinearSelection( new ve.Range( offset + 1 ) ) );
// Animate the slug open
const $slug = this.getDocument().getDocumentNode().getNodeFromOffset( offset + 1 ).$element;
const verticalPadding = $slug.innerHeight() - $slug.height();
const targetMargin = $slug.css( 'margin' );
const targetPadding = $slug.css( 'padding' );
$slug.addClass( 've-ce-branchNode-newSlug' ).css( 'min-height', slugHeight - verticalPadding );
requestAnimationFrame( () => {
$slug.addClass( 've-ce-branchNode-newSlug-open' ).css( {
margin: targetMargin,
padding: targetPadding,
'min-height': $slug.css( 'line-height' )
} );
$slug.one( 'transitionend', () => {
this.emit( 'position' );
// Animation finished, cleanup
$slug
.removeClass( 've-ce-branchNode-newSlug ve-ce-branchNode-newSlug-open' )
.css( { margin: '', padding: '', 'min-height': '' } );
} );
} );
this.onModelSelect();
};
/**
* Move cursor if it is between annotation nails
*
* @param {number} direction Direction of travel, 1=forwards, -1=backwards, 0=unknown
* @param {boolean} extend Whether the anchor should stay where it is
*
* TODO: Improve name
*/
ve.ce.Surface.prototype.fixupCursorPosition = function ( direction, extend ) {
// Default to moving start-wards, to mimic typical Chromium behaviour
direction = direction > 0 ? 1 : -1;
Iif ( this.nativeSelection.rangeCount === 0 ) {
return;
}
let node = this.nativeSelection.focusNode;
let offset = this.nativeSelection.focusOffset;
if ( node.nodeType !== Node.ELEMENT_NODE ) {
return;
}
const previousNode = node.childNodes[ offset - 1 ];
const nextNode = node.childNodes[ offset ];
Eif (
!(
previousNode &&
previousNode.nodeType === Node.ELEMENT_NODE && (
previousNode.classList.contains( 've-ce-nail-pre-open' ) ||
previousNode.classList.contains( 've-ce-nail-pre-close' )
)
) && !(
nextNode &&
nextNode.nodeType === Node.ELEMENT_NODE && (
nextNode.classList.contains( 've-ce-nail-post-open' ) ||
nextNode.classList.contains( 've-ce-nail-post-close' )
)
)
) {
return;
}
// Between nails: cross the one in the specified direction
let fixedPosition = ve.adjacentDomPosition(
{ node: node, offset: offset },
direction,
{ stop: ve.isHardCursorStep }
);
node = fixedPosition.node;
offset = fixedPosition.offset;
if ( direction === -1 ) {
// Support: Firefox
// Moving startwards: left-bias the fixed position
// Avoids Firefox bug "cursor disappears at left of img inside link":
// https://bugzilla.mozilla.org/show_bug.cgi?id=1175495
fixedPosition = ve.adjacentDomPosition(
fixedPosition,
direction,
{ stop: ve.isHardCursorStep }
);
if ( fixedPosition.node.nodeType === Node.TEXT_NODE ) {
// Have crossed into a text node; go back to its end
node = fixedPosition.node;
offset = fixedPosition.node.length;
}
}
this.showSelectionState( new ve.SelectionState( {
anchorNode: extend ? this.nativeSelection.anchorNode : node,
anchorOffset: extend ? this.nativeSelection.anchorOffset : offset,
focusNode: node,
focusOffset: offset
} ) );
};
/**
* Find sequence matches at the current surface offset
*
* @param {boolean} [isPaste=false] Whether this in the context of a paste
* @param {boolean} [isDelete=false] Whether this is after content being deleted
* @return {ve.ui.SequenceRegistry.Match[]}
*/
ve.ce.Surface.prototype.findMatchingSequences = function ( isPaste, isDelete ) {
const selection = this.getSelection();
Iif ( !selection.isNativeCursor() ) {
return [];
}
return this.getSurface().sequenceRegistry.findMatching(
this.getModel().getDocument().data,
selection.getModel().getCoveringRange().end,
isPaste,
isDelete
);
};
/**
* Find sequence matches at the current surface offset and execute them
*
* @param {boolean} [isPaste=false] Whether this in the context of a paste
* @param {boolean} [isDelete=false] Whether this is after content being deleted
*/
ve.ce.Surface.prototype.findAndExecuteSequences = function ( isPaste, isDelete ) {
this.executeSequences( this.findMatchingSequences( isPaste, isDelete ) );
};
// Deprecated alias
ve.ce.Surface.prototype.checkSequences = ve.ce.Surface.prototype.findAndExecuteSequences;
/**
* Check if any of the previously delayed sequences no longer match with current offset,
* and therefore should be executed.
*/
ve.ce.Surface.prototype.findAndExecuteDelayedSequences = function () {
const sequences = [],
selection = this.getSelection();
let matchingSequences;
if ( this.deactivated || !selection.isNativeCursor() ) {
matchingSequences = [];
} else {
matchingSequences = this.findMatchingSequences();
}
const matchingByName = {};
let i;
for ( i = 0; i < matchingSequences.length; i++ ) {
matchingByName[ matchingSequences[ i ].sequence.getName() ] = matchingSequences[ i ];
}
for ( i = 0; i < this.delayedSequences.length; i++ ) {
const matchingSeq = matchingByName[ this.delayedSequences[ i ].sequence.getName() ];
if (
!matchingSeq ||
matchingSeq.range.start !== this.delayedSequences[ i ].range.start
) {
// This sequence stopped matching; execute it with the previously saved range
this.delayedSequences[ i ].wasDelayed = true;
sequences.push( this.delayedSequences[ i ] );
}
}
// Discard any delayed sequences; they will be checked for again when the user starts typing
this.delayedSequences = [];
this.executeSequences( sequences );
};
// Deprecated alias
ve.ce.Surface.prototype.checkDelayedSequences = ve.ce.Surface.prototype.findAndExecuteDelayedSequences;
/**
* Execute matched sequences
*
* @param {ve.ui.SequenceRegistry.Match[]} sequences
*/
ve.ce.Surface.prototype.executeSequences = function ( sequences ) {
let executed = false;
// sequences.length will likely be 0 or 1 so don't cache
for ( let i = 0; i < sequences.length; i++ ) {
Iif ( sequences[ i ].sequence.delayed && !sequences[ i ].wasDelayed ) {
// Save the sequence and match range for execution later
this.delayedSequences.push( sequences[ i ] );
} else {
executed = sequences[ i ].sequence.execute( this.surface, sequences[ i ].range ) || executed;
}
}
if ( executed ) {
this.delayedSequences = [];
this.showModelSelection();
}
};
/**
* See if the just-entered content fits our criteria for setting a history breakpoint
*/
ve.ce.Surface.prototype.maybeSetBreakpoint = function () {
const selection = this.getSelection();
Iif ( !selection.isNativeCursor() ) {
return;
}
// We have just entered text, probably. We want to know whether we just
// created a word break. We can't check the current offset, since the
// common case is that being at the end of the string, which is inherently
// a word break. So, we check whether the previous offset is a word break,
// which should catch cases where we have hit space or added punctuation.
// We use getWordRange because it handles the unicode cases, and accounts
// for single-character words where a space back is a word break because
// it's the *start* of a word.
// Note: Text input which isn't using word breaks, for whatever reason,
// will get breakpoints set by the fallback timer anyway. This is the
// main reason to not debounce that timer here, as then a reasonable
// typist with such text would never get a breakpoint set. The compromise
// position here will occasionally get a breakpoint set in the middle of
// the first word typed.
const offset = selection.getModel().getCoveringRange().end - 1;
const data = this.getModel().getDocument().data;
if ( data.getWordRange( offset ).end === offset ) {
this.getModel().breakpoint();
}
};
/**
* Handle window resize event.
*
* @param {jQuery.Event} e Window resize event
* @fires ve.ce.Surface#position
*/
ve.ce.Surface.prototype.onWindowResize = function () {
this.emit( 'position' );
if ( OO.ui.isMobile() && !ve.init.platform.constructor.static.isIos() ) {
// A resize event on mobile is probably a keyboard open/close (or rotate).
// Either way, ensure the cursor is still visible (T204388).
// On iOS, window is resized whenever you start scrolling down and the "address bar" is
// minimized. So don't scroll back up…
this.getSurface().scrollSelectionIntoView();
}
};
/**
* Set the active node
*
* @param {ve.ce.Node|null} node Active node
*/
ve.ce.Surface.prototype.setActiveNode = function ( node ) {
this.activeNode = node;
};
/**
* Get the active node
*
* @return {ve.ce.Node|null} Active node
*/
ve.ce.Surface.prototype.getActiveNode = function () {
return this.activeNode;
};
/* Utilities */
/**
* Store a state snapshot at a keydown event, to be used in an after-keydown handler
*
* A ve.SelectionState object is stored, but only when the key event is a cursor key.
* (It would be misleading to save selection properties for key events where the DOM might get
* modified, because anchorNode/focusNode are live and mutable, and so the offsets may come to
* point confusingly to different places than they did when the selection was saved).
*
* @param {jQuery.Event|null} e Key down event; must be active when this call is made
*/
ve.ce.Surface.prototype.storeKeyDownState = function ( e ) {
this.keyDownState.event = e;
this.keyDownState.selectionState = null;
if ( this.nativeSelection.rangeCount > 0 && e && (
e.keyCode === OO.ui.Keys.UP ||
e.keyCode === OO.ui.Keys.DOWN ||
e.keyCode === OO.ui.Keys.LEFT ||
e.keyCode === OO.ui.Keys.RIGHT
) ) {
this.keyDownState.selectionState = new ve.SelectionState( this.nativeSelection );
}
};
/**
* Clear a stored state snapshot from a key down event
*/
ve.ce.Surface.prototype.clearKeyDownState = function () {
this.keyDownState.event = null;
this.keyDownState.selectionState = null;
};
/**
* Move the DM surface cursor
*
* @param {number} offset Distance to move (negative = toward document start)
*/
ve.ce.Surface.prototype.moveModelCursor = function ( offset ) {
const selection = this.model.getSelection();
if ( selection instanceof ve.dm.LinearSelection ) {
this.model.setLinearSelection( this.model.getDocument().getRelativeRange(
selection.getRange(),
offset,
'character',
false
) );
}
};
/**
* Get the directionality at the current focused node
*
* @return {string} 'ltr' or 'rtl'
*/
ve.ce.Surface.prototype.getFocusedNodeDirectionality = function () {
// Use stored directionality if we have one.
Iif ( this.cursorDirectionality ) {
return this.cursorDirectionality;
}
// Else fall back on the CSS directionality of the focused node at the DM selection focus,
// which is less reliable because it does not take plaintext bidi into account.
// (range.to will actually be at the edge of the focused node, but the
// CSS directionality will be the same).
const range = this.model.getSelection().getRange();
let cursorNode = this.getDocument().getNodeAndOffset( range.to ).node;
if ( cursorNode.nodeType === Node.TEXT_NODE ) {
cursorNode = cursorNode.parentNode;
}
return $( cursorNode ).css( 'direction' );
};
/**
* Restore the selection from the model if expands outside the active node
*
* This is only useful if the DOM selection and the model selection are out of sync.
*
* @return {boolean} Whether the selection was restored
*/
ve.ce.Surface.prototype.restoreActiveNodeSelection = function () {
const activeNode = this.getActiveNode(),
activeRange = activeNode && activeNode.getRange();
let currentRange;
Iif (
activeRange &&
( currentRange = ve.ce.veRangeFromSelection( this.nativeSelection ) ) &&
( !currentRange.isCollapsed() || activeNode.trapsCursor() ) &&
!activeRange.containsRange( currentRange )
) {
this.showModelSelection();
return true;
} else {
return false;
}
};
/**
* Find a ce=false branch node that a native cursor movement from here *might* skip
*
* If a node is returned, then it might get skipped by a single native cursor
* movement in the specified direction from the closest branch node at the
* current cursor focus. However, if null is returned, then any single such
* movement is guaranteed *not* to skip an uneditable branch node.
*
* Note we cannot predict precisely where/with which cursor key we might step out
* of the current closest branch node, because it is difficult to predict the
* behaviour of left/rightarrow (because of bidi visual cursoring) and
* up/downarrow (because of wrapping).
*
* @param {number} direction -1 for before the cursor, +1 for after
* @return {Node|null} Potentially cursor-adjacent uneditable branch node, or null
*/
ve.ce.Surface.prototype.findAdjacentUneditableBranchNode = function ( direction ) {
const activeNode = this.getActiveNode(),
forward = direction > 0;
let node = $( this.nativeSelection.focusNode ).closest(
'.ve-ce-branchNode,.ve-ce-leafNode,.ve-ce-surface-clipboardHandler'
)[ 0 ];
if ( !node || node.classList.contains( 've-ce-surface-clipboardHandler' ) ) {
return null;
}
// Walk in document order till we find a ContentBranchNode (in which case
// return null) or a FocusableNode/TableNode (in which case return the node)
// or run out of nodes (in which case return null)
while ( true ) {
// Step up until we find a sibling
while ( !( forward ? node.nextSibling : node.previousSibling ) ) {
node = node.parentNode;
if ( node === null ) {
// Reached the document start/end
return null;
}
}
// Step back
node = forward ? node.nextSibling : node.previousSibling;
// Check and step down
while ( true ) {
if (
$.data( node, 'view' ) instanceof ve.ce.ContentBranchNode ||
// We shouldn't ever hit a raw text node, because they
// should all be wrapped in CBNs or focusable nodes, but
// just in case…
node.nodeType === Node.TEXT_NODE
) {
// This is cursorable (must have content or slugs)
return null;
}
if ( $( node ).is( '.ve-ce-focusableNode,.ve-ce-tableNode' ) ) {
Iif ( activeNode ) {
const viewNode = $( node ).data( 'view' );
if ( !activeNode.getRange().containsRange( viewNode.getRange() ) ) {
// Node is outside the active node
return null;
}
}
return node;
}
if ( !node.childNodes || node.childNodes.length === 0 ) {
break;
}
node = forward ? node.firstChild : node.lastChild;
}
}
};
/**
* Insert cursor holders, if they might be required as a cursor target
*/
ve.ce.Surface.prototype.updateCursorHolders = function () {
this.updateCursorHolderBefore();
this.updateCursorHolderAfter();
};
/**
* Insert cursor holder between selection focus and subsequent ce=false node, if required as a cursor target
*/
ve.ce.Surface.prototype.updateCursorHolderBefore = function () {
const doc = this.getElementDocument(),
nodeBelow = this.findAdjacentUneditableBranchNode( 1 );
if (
!( nodeBelow === null && this.cursorHolderBefore === null ) &&
!( nodeBelow && this.cursorHolderBefore && nodeBelow.nextSibling === this.cursorHolderBefore )
) {
// cursorHolderBefore is not correct for nodeBelow; update it
this.removeCursorHolderBefore();
if ( nodeBelow ) {
this.cursorHolderBefore = doc.importNode( this.constructor.static.cursorHolderTemplate, true );
this.cursorHolderBefore.classList.add( 've-ce-cursorHolder-before' );
Iif ( ve.inputDebug ) {
this.cursorHolderBefore.classList.add( 've-ce-cursorHolder-debug' );
}
// this.cursorHolderBefore is a Node
// eslint-disable-next-line no-jquery/no-append-html
$( nodeBelow ).before( this.cursorHolderBefore );
}
}
};
/**
* Insert cursor holder between selection focus and preceding ce=false node, if required as a cursor target
*/
ve.ce.Surface.prototype.updateCursorHolderAfter = function () {
const doc = this.getElementDocument(),
nodeAbove = this.findAdjacentUneditableBranchNode( -1 );
if (
!( nodeAbove === null && this.cursorHolderAfter === null ) &&
!( nodeAbove && this.cursorHolderAfter && nodeAbove.nextSibling === this.cursorHolderAfter )
) {
// cursorHolderAfter is not correct for nodeAbove; update it
this.removeCursorHolderAfter();
if ( nodeAbove ) {
this.cursorHolderAfter = doc.importNode( this.constructor.static.cursorHolderTemplate, true );
this.cursorHolderAfter.classList.add( 've-ce-cursorHolder-after' );
Iif ( ve.inputDebug ) {
this.cursorHolderAfter.classList.add( 've-ce-cursorHolder-debug' );
}
// this.cursorHolderAfter is a Node
// eslint-disable-next-line no-jquery/no-append-html
$( nodeAbove ).after( this.cursorHolderAfter );
}
}
};
/**
* Remove cursor holders, if they exist
*/
ve.ce.Surface.prototype.removeCursorHolders = function () {
this.removeCursorHolderBefore();
this.removeCursorHolderAfter();
};
/**
* Remove cursorHolderBefore, if it exists
*/
ve.ce.Surface.prototype.removeCursorHolderBefore = function () {
if ( this.cursorHolderBefore ) {
Eif ( this.cursorHolderBefore.parentNode ) {
this.cursorHolderBefore.parentNode.removeChild( this.cursorHolderBefore );
}
this.cursorHolderBefore = null;
}
};
/**
* Remove cursorHolderAfter, if it exists
*/
ve.ce.Surface.prototype.removeCursorHolderAfter = function () {
if ( this.cursorHolderAfter ) {
Eif ( this.cursorHolderAfter.parentNode ) {
this.cursorHolderAfter.parentNode.removeChild( this.cursorHolderAfter );
}
this.cursorHolderAfter = null;
}
};
/**
* Handle insertion of content.
*/
ve.ce.Surface.prototype.handleInsertion = function () {
const surfaceModel = this.getModel(),
fragment = surfaceModel.getFragment();
let selection = this.getSelection();
Iif ( selection instanceof ve.ce.TableSelection ) {
// Collapse table selection to anchor cell
surfaceModel.setSelection( selection.getModel().collapseToFrom() );
// Delete the current contents
ve.ce.keyDownHandlerFactory.lookup( 'tableDelete' ).static.execute( this );
// Place selection inside the cell
this.documentView.getBranchNodeFromOffset( selection.getModel().tableRange.start + 1 ).setEditing( true );
// Selection has changed, update
selection = this.getSelection();
} else Iif ( selection.isFocusedNode() ) {
// Don't allow a user to delete a non-table focusable node just by typing
return;
}
Iif ( !( selection instanceof ve.ce.LinearSelection ) ) {
return;
}
const range = selection.getModel().getRange();
// Handles removing expanded selection before inserting new text
Iif (
this.selectionSplitsNailedAnnotation() ||
( !range.isCollapsed() && !this.documentView.rangeInsideOneLeafNode( range ) )
) {
// Remove the selection to force its re-application from the DM (even if the
// DM is too granular to detect the selection change)
surfaceModel.setNullSelection();
fragment.removeContent().collapseToStart().select();
this.surfaceObserver.clear();
this.storeKeyDownState( this.keyDownState.event );
this.surfaceObserver.stopTimerLoop();
this.surfaceObserver.pollOnce();
}
};
/**
* Place the selection at the next content offset which is selectable.
*
* For the purposes of this method, offsets within ve.ce.ActiveNode's
* are not considered selectable when they are not active.
*
* @param {number} startOffset Offset to start from
* @param {number} direction Search direction, -1 for left and 1 for right
* @param {number} [endOffset] End offset to stop searching at
* @return {number} Content offset, or -1 of not found
*/
ve.ce.Surface.prototype.getRelativeSelectableContentOffset = function ( startOffset, direction, endOffset ) {
const documentView = this.getDocument(),
linearData = this.getModel().getDocument().data;
let nextOffset = linearData.getRelativeOffset(
startOffset,
direction,
( offset ) => {
// Check we are at a content offset, according to the model
if ( !linearData.isContentOffset( offset ) ) {
return false;
}
const branchNode = documentView.getBranchNodeFromOffset( offset );
Iif ( !branchNode ) {
// This shouldn't happen in a content offset
return false;
}
// traverseUpstream stops on a false return
const noAutoFocusContainer = branchNode.traverseUpstream( ( node ) => node.autoFocus() );
if ( noAutoFocusContainer ) {
// Don't try to place the cursor in a node which has a container with autoFocus set to false
return false;
}
return true;
}
);
Iif (
endOffset !== undefined && (
( direction > 0 && nextOffset > endOffset ) ||
( direction < 0 && nextOffset < endOffset )
)
) {
nextOffset = -1;
}
return nextOffset;
};
/**
* Select the offset returned by #getRelativeSelectableContentOffset
*
* @param {number} startOffset
* @param {number} direction
* @param {number} [endOffset]
*/
ve.ce.Surface.prototype.selectRelativeSelectableContentOffset = function ( startOffset, direction, endOffset ) {
const offset = this.getRelativeSelectableContentOffset( startOffset, direction, endOffset );
if ( offset !== -1 ) {
// Found an offset
this.getModel().setLinearSelection( new ve.Range( offset ) );
} else {
// Nowhere sensible to put the cursor
this.getModel().setNullSelection();
}
};
/**
* Select the first content offset which is selectable.
*
* See #selectRelativeSelectableContentOffset for the definition of selectable.
*/
ve.ce.Surface.prototype.selectFirstSelectableContentOffset = function () {
this.selectRelativeSelectableContentOffset(
this.getModel().getDocument().getAttachedRoot().getOffset(),
1
);
};
/**
* Select the last content offset which is selectable.
*
* See #selectRelativeSelectableContentOffset for the definition of selectable.
*/
ve.ce.Surface.prototype.selectLastSelectableContentOffset = function () {
this.selectRelativeSelectableContentOffset(
this.getModel().getDocument().getDocumentRange().end,
-1
);
};
/**
* Get an approximate range covering data visible in the viewport
*
* It is assumed that vertical offset increases as you progress through the DM.
* Items with custom positioning may throw off results given by this method, so
* it should only be treated as an approximation.
*
* If the document doesn't contain any content offsets (e.g. it only contains
* a transclusion), the returned range will cover the entire document. If the
* single element is particularly large this might be very distinct from the
* visible content.
*
* @param {boolean} [covering=false] Get a range which fully covers the viewport, otherwise
* get a range which is full contained within the viewport.
* @param {number} [padding=0] Increase computed size of viewport by this amount at the top and bottom
* @return {ve.Range|null} Range covering data visible in the viewport, null if the surface is not attached
*/
ve.ce.Surface.prototype.getViewportRange = function ( covering, padding ) {
const documentModel = this.getModel().getDocument(),
data = documentModel.data,
dimensions = this.surface.getViewportDimensions();
if ( !dimensions ) {
// Surface is not attached
return null;
}
padding = padding || 0;
const top = Math.max( 0, dimensions.top - padding );
const bottom = dimensions.bottom + ( padding * 2 );
const documentRange = this.attachedRoot === this.getDocument().getDocumentNode() ?
this.getModel().getDocument().getDocumentRange() :
this.attachedRoot.getRange();
const highestIgnoreChildrenNode = ( childNode ) => {
let ignoreChildrenNode = null;
childNode.traverseUpstream( ( node ) => {
Iif ( node.shouldIgnoreChildren() ) {
ignoreChildrenNode = node;
}
} );
return ignoreChildrenNode;
};
/**
* @param {number} offset Vertical offset to find
* @param {ve.Range} range Document range
* @param {string} side Side of the viewport align with, 'bottom' or 'top'
* @param {boolean} isStart Find the start of the range, otherwise the end
* @return {number} DM offset
*/
const binarySearch = ( offset, range, side, isStart ) => {
let start = range.start,
end = range.end,
lastLength = Infinity;
while ( range.getLength() < lastLength ) {
lastLength = range.getLength();
let mid = Math.round( ( range.start + range.end ) / 2 );
let midNode = documentModel.documentNode.getNodeFromOffset( mid );
const ignoreChildrenNode = highestIgnoreChildrenNode( midNode );
Iif ( ignoreChildrenNode ) {
const nodeRange = ignoreChildrenNode.getOuterRange();
mid = side === 'top' ? nodeRange.end : nodeRange.start;
} else {
mid = data.getNearestContentOffset( mid );
if ( mid === -1 ) {
// There is no content offset available in this document.
// Return early, with a range that'll be covering the entire document.
return isStart ? start : end;
}
// Never search outisde the original range
mid = Math.max( Math.min( mid, range.end ), range.start );
}
let rect = null;
while ( !rect ) {
// Try to create a selection of one character for more reliable
// behaviour when text wraps.
let contentRange;
if ( data.isContentOffset( mid + 1 ) ) {
contentRange = new ve.Range( mid, mid + 1 );
} else if ( data.isContentOffset( mid - 1 ) ) {
contentRange = new ve.Range( mid - 1, mid );
} else E{
contentRange = new ve.Range( mid );
}
rect = this.getSelection( new ve.dm.LinearSelection( contentRange ) ).getSelectionBoundingRect();
// Node at contentRange is not rendered, find rendered parent
if ( !rect ) {
Iif ( !midNode ) {
throw new Error( 'Offset has no rendered node container' );
}
const midNodeRange = midNode.getOuterRange();
// Find the nearest content offset outside the invisible node
mid = side === 'top' ?
data.getRelativeContentOffset( midNodeRange.end, 1 ) :
data.getRelativeContentOffset( midNodeRange.start, -1 );
// Never search outisde the original range
mid = Math.max( Math.min( mid, range.end ), range.start );
// Check we didn't end up inside the invisible node again
if ( midNodeRange.containsRange( new ve.Range( mid ) ) ) {
return isStart ? start : end;
}
// Ensure we check parent in next iteration
midNode = midNode.parent;
}
}
if ( rect[ side ] >= offset ) {
end = mid;
range = new ve.Range( range.start, end );
} else {
start = mid;
range = new ve.Range( start, range.end );
}
}
return side === 'bottom' ? start : end;
};
return new ve.Range(
binarySearch( top, documentRange, covering ? 'bottom' : 'top', true ),
binarySearch( bottom, documentRange, covering ? 'top' : 'bottom', false )
);
};
/**
* Move the selection to the first visible "start content offset" in the viewport
*
* Where "start content offset" is the first offset within a content branch node.
*
* The following are used as fallbacks when such offsets can't be found:
* - The first visible content offset (at any position in the CBN)
* - The first selectable content offset in the doc (if fallbackToFirst is set)
*
* @param {boolean} [fallbackToFirst=false] Whether to select the first content offset if a visible offset can't be found
*/
ve.ce.Surface.prototype.selectFirstVisibleStartContentOffset = function ( fallbackToFirst ) {
// When scrolled. add about one line height of padding so the browser doesn't try to scroll the line above the cursor into view
const dimensions = this.surface.getViewportDimensions();
const offset = dimensions && dimensions.top ? -20 : 0;
const visibleRange = this.getViewportRange( false, offset );
Iif ( visibleRange ) {
const model = this.getModel();
let startNodeOffset = -1;
const contentOffset = this.getRelativeSelectableContentOffset( Math.max( visibleRange.start - 1, 0 ), 1, visibleRange.end );
if ( contentOffset !== -1 ) {
const branchNodeRange = model.getDocument().getBranchNodeFromOffset( contentOffset ).getRange();
if ( contentOffset === branchNodeRange.start ) {
// We luckily landed and the start of a branch node
startNodeOffset = contentOffset;
} else {
// We are in the middle of a branch node, move to the end, then find the next
// content offset, which should be the start of the next CBN
const nextContentOffset = this.getRelativeSelectableContentOffset( branchNodeRange.end, 1, visibleRange.end );
// If there isn't a content offset after the end of the current node, fallback to the mid-node contentOffset
startNodeOffset = nextContentOffset !== -1 ? nextContentOffset : contentOffset;
}
}
if ( startNodeOffset !== -1 ) {
// Found an offset
model.setLinearSelection( new ve.Range( startNodeOffset ) );
} else {
// Nowhere sensible to put the cursor
model.setNullSelection();
}
}
Iif ( fallbackToFirst && this.getSelection().getModel().isNull() ) {
// If a visible range couldn't be determined, or a selection couldn't
// be made for some reason, fall back to the actual first content offset.
this.selectFirstSelectableContentOffset();
}
};
/**
* Apply a DM selection to the DOM, even if the old DOM selection is different but DM-equivalent
*
* @return {boolean} Whether the selection actually changed
*/
ve.ce.Surface.prototype.forceShowModelSelection = function () {
return this.showModelSelection( true );
};
/**
* Apply a DM selection to the DOM
*
* @param {boolean} [force=false] Replace the DOM selection if it is different but DM-equivalent
* @return {boolean} Whether the selection actually changed
*/
ve.ce.Surface.prototype.showModelSelection = function ( force ) {
if ( this.deactivated ) {
// setTimeout: Defer until view has updated
setTimeout( () => this.getSelectionManager().updateDeactivatedSelection() );
return false;
}
const selection = this.getSelection();
let modelRange;
if ( selection.getModel().isNull() ) {
if (
!this.nativeSelection.focusNode ||
!this.$element[ 0 ].contains( this.nativeSelection.focusNode )
) {
// Native selection is already null, or outside the document
return false;
}
modelRange = null;
} else {
if ( !selection.isNativeCursor() || this.focusedBlockSlug ) {
// Model selection is an emulated selection (e.g. table). The view is certain to
// match it already, because there is no way to change the view selection when
// an emulated selection is showing.
return false;
}
modelRange = selection.getModel().getRange();
if ( !force && this.$attachedRootNode.get( 0 ).contains(
this.nativeSelection.focusNode
) ) {
// See whether the model range implied by the DOM selection is already equal to
// the actual model range. This is necessary because one model selection can
// correspond to many DOM selections, and we don't want to change a DOM
// selection that is already valid to an arbitrary different DOM selection.
let impliedModelRange;
try {
impliedModelRange = new ve.Range(
ve.ce.getOffset(
this.nativeSelection.anchorNode,
this.nativeSelection.anchorOffset
),
ve.ce.getOffset(
this.nativeSelection.focusNode,
this.nativeSelection.focusOffset
)
);
} catch ( e ) {
// The nativeSelection appears to end up outside the documentNode
// sometimes, e.g. when deleting in Safari (T306218)
impliedModelRange = null;
}
if ( modelRange.equals( impliedModelRange ) ) {
// Current native selection fits model range; don't change
return false;
}
}
}
const changed = this.showSelectionState( this.getSelectionState( modelRange ) );
// Support: Chrome
// Fixes T131674, which is only triggered with Chromium-style ce=false cursoring
// restrictions (but other cases of non-updated cursor holders can probably occur
// in other browsers).
if ( changed ) {
this.updateCursorHolders();
return true;
}
return false;
};
/**
* Apply a selection state to the DOM
*
* If the browser cannot show a backward selection, fall back to the forward equivalent
*
* @param {ve.SelectionState} selection The selection state to show
* @return {boolean} Whether the selection actually changed
*/
ve.ce.Surface.prototype.showSelectionState = function ( selection ) {
const sel = this.nativeSelection;
let extendedBackwards = false,
newSel = selection;
if ( newSel.equalsSelection( sel ) ) {
this.updateActiveAnnotations();
return false;
}
if ( !newSel.getNativeRange( this.getElementDocument() ) ) {
// You can still set a linear selection if the document doesn't have any cursorable positions.
// That's when you end up here.
sel.removeAllRanges();
return true;
}
if ( newSel.isBackwards ) {
if ( ve.supportsSelectionExtend ) {
// Set the range at the anchor, and extend backwards to the focus
const range = this.getElementDocument().createRange();
range.setStart( newSel.anchorNode, newSel.anchorOffset );
sel.removeAllRanges();
sel.addRange( range );
try {
sel.extend( newSel.focusNode, newSel.focusOffset );
extendedBackwards = true;
} catch ( e ) {
// Support: Firefox
// Firefox sometimes fails when nodes are different
// see https://bugzilla.mozilla.org/show_bug.cgi?id=921444
}
}
if ( !extendedBackwards ) {
// Fallback: Apply the corresponding forward selection
newSel = newSel.flip();
Iif ( newSel.equalsSelection( sel ) ) {
this.updateActiveAnnotations();
return false;
}
}
}
if ( !extendedBackwards ) {
// Forward selection
sel.removeAllRanges();
sel.addRange( newSel.getNativeRange( this.getElementDocument() ) );
}
// Setting a range doesn't give focus in all browsers so make sure this happens
// Also set focus after range to prevent scrolling to top
const $focusTarget = $( newSel.focusNode ).closest( '[contenteditable=true]' );
if ( $focusTarget.get( 0 ) === this.getElementDocument().activeElement ) {
// Already focused, do nothing.
} else if ( $focusTarget.length && !OO.ui.contains( $focusTarget.get( 0 ), this.getElementDocument().activeElement ) ) {
// Check $focusTarget is non-empty (T259531)
// Note: contains *doesn't* include === here. This is desired, as the
// common case for getting here is when pressing backspace when the
// cursor is in the middle of a block of text (thus both are a <div>),
// and we don't want to scroll away from the caret.
const scrollTop = this.surface.$scrollContainer.scrollTop();
$focusTarget.trigger( 'focus' );
// Support: Safari
// Safari tries to scroll the CE surface into view when focusing,
// causing unwanted page jumps (T258847)
this.surface.$scrollContainer.scrollTop( scrollTop );
} else E{
// Scroll the node into view
ve.scrollIntoView(
$( newSel.focusNode ).closest( '*' ).get( 0 )
);
}
this.updateActiveAnnotations();
return true;
};
/**
* Update the activeAnnotations property and apply CSS classes accordingly
*
* An active annotation is one containing the DOM cursor, which may not be well
* defined at annotation boundaries, except for links which use nails.
*
* Also the order of .activeAnnotations may not be well defined.
*
* @param {boolean|Node} [fromModelOrNode] If `true`, gather annotations from the model,
* instead of the cusor focus point. If a Node is passed, gather annotations from that node.
* @fires ve.dm.Surface#contextChange
*/
ve.ce.Surface.prototype.updateActiveAnnotations = function ( fromModelOrNode ) {
const canBeActive = function ( view ) {
return view.canBeActive();
};
let activeAnnotations;
if ( fromModelOrNode === true ) {
activeAnnotations = this.annotationsAtModelSelection( canBeActive );
} else Iif ( fromModelOrNode instanceof Node ) {
activeAnnotations = this.annotationsAtNode( fromModelOrNode, canBeActive );
} else {
activeAnnotations = this.annotationsAtFocus( canBeActive );
}
let changed = false;
// Iterate over previously active annotations
this.activeAnnotations.forEach( ( annotation ) => {
// If not in the new list, turn off
if ( activeAnnotations.indexOf( annotation ) === -1 ) {
annotation.$element.removeClass( 've-ce-annotation-active' );
changed = true;
}
} );
// Iterate over newly active annotations
activeAnnotations.forEach( ( annotation ) => {
// If not in the old list, turn on
if ( this.activeAnnotations.indexOf( annotation ) === -1 ) {
annotation.$element.addClass( 've-ce-annotation-active' );
changed = true;
}
} );
if ( changed ) {
this.activeAnnotations = activeAnnotations;
this.model.emit( 'contextChange' );
}
};
/**
* Update the selection to contain the contents of a node
*
* @param {HTMLElement} node
* @param {string} [collapse] Collaspse to 'start' or 'end'
* @return {boolean} Whether the selection changed
*/
ve.ce.Surface.prototype.selectNodeContents = function ( node, collapse ) {
Iif ( !node ) {
return false;
}
let anchor = ve.ce.nextCursorOffset( node.childNodes[ 0 ] );
let focus = ve.ce.previousCursorOffset( node.childNodes[ node.childNodes.length - 1 ] );
Iif ( collapse === 'start' ) {
focus = anchor;
} else Iif ( collapse === 'end' ) {
anchor = focus;
}
return this.showSelectionState( new ve.SelectionState( {
anchorNode: anchor.node,
anchorOffset: anchor.offset, // Past the nail
focusNode: focus.node,
focusOffset: focus.offset, // Before the nail
isCollapsed: false
} ) );
};
/**
* Select the inner contents of the closest annotation
*
* @param {Function} [filter] Function to filter view nodes by.
*/
ve.ce.Surface.prototype.selectAnnotation = function ( filter ) {
const annotations = this.annotationsAtModelSelection( filter );
if ( annotations.length ) {
this.selectNodeContents( annotations[ 0 ].$element[ 0 ] );
}
};
/**
* Get the annotation views at the current model selection
*
* TODO: This doesn't work for annotations that span fewer
* than one character, as getNodeAndOffset will never return
* an offset inside that annotation.
*
* @param {Function} [filter] Function to filter view nodes by.
* @param {number} [offset] Model offset. Defaults to start of current selection.
* @return {ve.ce.Annotation[]} Annotation views
*/
ve.ce.Surface.prototype.annotationsAtModelSelection = function ( filter, offset ) {
const documentRange = this.getModel().getDocument().getDocumentRange();
Eif ( offset === undefined ) {
offset = this.getModel().getSelection().getCoveringRange().start;
}
// getNodeAndOffset can throw when offset is out of bounds (T262354)
// and other undiagnosed situations (T136780, T262487, T259154, T262303)
// TODO: For annotation boundaries we have to search one place left and right
// to find the text inside the annotation. This will give too many results for
// adjancent annotations, and will fail for one character annotations. (T221967)
let nodeAndOffset;
let annotations = [];
Eif ( offset > documentRange.start ) {
try {
nodeAndOffset = this.getDocument().getNodeAndOffset( offset - 1 );
} catch ( e ) {
nodeAndOffset = null;
}
annotations = nodeAndOffset ? this.annotationsAtNode( nodeAndOffset.node, filter ) : [];
}
Eif ( offset < documentRange.end ) {
try {
nodeAndOffset = this.getDocument().getNodeAndOffset( offset + 1 );
} catch ( e ) {
nodeAndOffset = null;
}
annotations = OO.unique( annotations.concat( nodeAndOffset ? this.annotationsAtNode( nodeAndOffset.node, filter ) : [] ) );
}
return annotations;
};
/**
* Get the annotation views containing the cursor focus
*
* @param {Function} [filter] Function to filter view nodes by.
* @return {ve.ce.Annotation[]} Annotation views
*/
ve.ce.Surface.prototype.annotationsAtFocus = function ( filter ) {
return this.annotationsAtNode( this.nativeSelection.focusNode, filter );
};
/**
* Get the annotation views containing the cursor focus
*
* Only returns annotations which can be active.
*
* @param {Node} node Node at which to search for annotations
* @param {Function} [filter] Function to filter view nodes by. Takes one argument which
* is the view node and returns a boolean.
* @return {ve.ce.Annotation[]} Annotation views
*/
ve.ce.Surface.prototype.annotationsAtNode = function ( node, filter ) {
const annotations = [];
$( node ).parents( '.ve-ce-annotation' ).addBack( '.ve-ce-annotation' ).each( ( i, element ) => {
const view = $( element ).data( 'view' );
if ( view && ( !filter || filter( view ) ) ) {
annotations.push( view );
}
} );
return annotations;
};
/**
* Get a SelectionState corresponding to a ve.Range.
*
* If either endpoint of the ve.Range is not a cursor offset, adjust the SelectionState
* endpoints to be at cursor offsets. For a collapsed selection, the adjustment preserves
* collapsedness; for a non-collapsed selection, the adjustment is in the direction that
* grows the selection (thereby avoiding collapsing or reversing the selection).
*
* @param {ve.Range|null} range Range to get selection for
* @return {ve.SelectionState} The selection
*/
ve.ce.Surface.prototype.getSelectionState = function ( range ) {
const dmDoc = this.getModel().getDocument();
if ( !range ) {
return ve.SelectionState.static.newNullSelection();
}
// Anchor/focus at the nearest correct position in the direction that
// grows the selection.
const from = dmDoc.getNearestCursorOffset( range.from, range.isBackwards() ? 1 : -1 );
if ( from === -1 ) {
return ve.SelectionState.static.newNullSelection();
}
let anchor;
try {
anchor = this.documentView.getNodeAndOffset( from );
} catch ( e ) {
return ve.SelectionState.static.newNullSelection();
}
let focus;
if ( range.isCollapsed() ) {
focus = anchor;
} else {
const to = dmDoc.getNearestCursorOffset( range.to, range.isBackwards() ? -1 : 1 );
Iif ( to === -1 ) {
return ve.SelectionState.static.newNullSelection();
}
try {
focus = this.documentView.getNodeAndOffset( to );
} catch ( e ) {
return ve.SelectionState.static.newNullSelection();
}
}
return new ve.SelectionState( {
anchorNode: anchor.node,
anchorOffset: anchor.offset,
focusNode: focus.node,
focusOffset: focus.offset,
isBackwards: range.isBackwards()
} );
};
/**
* Get a native range object for a specified ve.Range
*
* Native ranges are only used by linear selections. They don't show whether the selection
* is backwards, so they should be used for measurement only.
*
* @param {ve.Range} [range] Optional range to get the native range for, defaults to current selection's range
* @return {Range|null} Native range object, or null if there is no suitable selection
*/
ve.ce.Surface.prototype.getNativeRange = function ( range ) {
let selectionState;
Iif ( !range ) {
// If no range specified, or range is equivalent to current native selection,
// then use the current native selection
selectionState = new ve.SelectionState( this.nativeSelection );
} else {
selectionState = this.getSelectionState( range );
}
return selectionState.getNativeRange( this.getElementDocument() );
};
/**
* Append passed highlights to highlight container.
*
* @param {jQuery} $highlights Highlights to append
* @param {boolean} focused Highlights are currently focused
*/
ve.ce.Surface.prototype.appendHighlights = function ( $highlights, focused ) {
// Only one item can be blurred-highlighted at a time, so remove the others.
// Remove by detaching so they don't lose their event handlers, in case they
// are attached again.
this.$highlightsBlurred.children().detach();
if ( focused ) {
this.$highlightsFocused.append( $highlights );
} else E{
this.$highlightsBlurred.append( $highlights );
}
};
/* Getters */
/**
* Get the top-level surface.
*
* @return {ve.ui.Surface}
*/
ve.ce.Surface.prototype.getSurface = function () {
return this.surface;
};
/**
* Get the surface model.
*
* @return {ve.dm.Surface} Surface model
*/
ve.ce.Surface.prototype.getModel = function () {
return this.model;
};
/**
* Get the document view.
*
* @return {ve.ce.Document} Document view
*/
ve.ce.Surface.prototype.getDocument = function () {
return this.documentView;
};
/**
* Check whether there are any render locks
*
* @return {boolean} Render is locked
*/
ve.ce.Surface.prototype.isRenderingLocked = function () {
return this.renderLocks > 0 && !this.readOnly;
};
/**
* Add a single render lock (to disable rendering)
*/
ve.ce.Surface.prototype.incRenderLock = function () {
this.renderLocks++;
};
/**
* Remove a single render lock
*/
ve.ce.Surface.prototype.decRenderLock = function () {
this.renderLocks--;
};
/**
* Escape the current render lock
*
* @param {Function} callback Function to run after render lock
*/
ve.ce.Surface.prototype.afterRenderLock = function ( callback ) {
// TODO: implement an actual tracking system that makes sure renderlock is
// 0 when this is done.
// setTimeout: postpone until there is definitely no render lock
setTimeout( callback );
};
/**
* Change the model only, not the CE surface
*
* This avoids event storms when the CE surface is already correct
*
* @param {ve.dm.Transaction|ve.dm.Transaction[]|null} transactions One or more transactions to
* process, or null to process none
* @param {ve.dm.Selection} selection New selection
* @throws {Error} If calls to this method are nested
*/
ve.ce.Surface.prototype.changeModel = function ( transactions, selection ) {
Iif ( this.newModelSelection !== null ) {
throw new Error( 'Nested change of newModelSelection' );
}
this.newModelSelection = selection;
try {
this.model.change( transactions, selection );
} finally {
this.newModelSelection = null;
}
};
/**
* Inform the surface that one of its ContentBranchNodes' rendering has changed.
*
* @see ve.ce.ContentBranchNode#renderContents
*/
ve.ce.Surface.prototype.setContentBranchNodeChanged = function () {
this.contentBranchNodeChanged = true;
this.clearKeyDownState();
};
/**
* Set the node that has the current unicorn.
*
* If another node currently has a unicorn, it will be rerendered, which will
* cause it to release its unicorn.
*
* @param {ve.ce.ContentBranchNode|null} node The node claiming the unicorn, null to release (by rerendering) without claiming
*/
ve.ce.Surface.prototype.setUnicorning = function ( node ) {
Iif ( this.setUnicorningRecursionGuard ) {
throw new Error( 'setUnicorning recursing' );
}
Iif ( this.unicorningNode && this.unicorningNode !== node ) {
this.setUnicorningRecursionGuard = true;
try {
this.unicorningNode.renderContents();
} finally {
this.setUnicorningRecursionGuard = false;
}
}
this.unicorningNode = node;
};
/**
* Release the current unicorn held by a given node, without rerendering
*
* If the node doesn't hold the current unicorn, nothing happens.
*
* @param {ve.ce.ContentBranchNode} node The node releasing the unicorn
*/
ve.ce.Surface.prototype.setNotUnicorning = function ( node ) {
if ( this.unicorningNode === node ) {
this.unicorningNode = null;
}
};
/**
* Ensure that no node has a unicorn.
*
* If the given node currently has the unicorn, it will be released and
* no rerender will happen. If another node has the unicorn, that node
* will be rerendered to get rid of the unicorn.
*
* @param {ve.ce.ContentBranchNode} node The node releasing the unicorn
*/
ve.ce.Surface.prototype.setNotUnicorningAll = function ( node ) {
if ( this.unicorningNode === node ) {
// Don't call back node.renderContents()
this.unicorningNode = null;
}
this.setUnicorning( null );
};
/**
* Get list of selected nodes and annotations.
*
* Exclude active annotations unless the CE focus is inside a link
*
* @return {ve.dm.Model[]} Selected models
*/
ve.ce.Surface.prototype.getSelectedModels = function () {
Iif ( !( this.model.selection instanceof ve.dm.LinearSelection ) ) {
return [];
}
let models = this.model.getFragment().getSelectedModels();
if ( this.model.selection.isCollapsed() ) {
const fragmentAfter = this.model.getLinearFragment(
new ve.Range(
this.model.selection.range.start,
this.model.selection.range.start + 1
)
);
models = OO.unique( [].concat(
models,
fragmentAfter.getSelectedModels()
) );
}
const activeModels = this.activeAnnotations.map( ( view ) => view.getModel() );
Iif ( this.model.sourceMode ) {
return models;
} else {
return models.filter( ( annModel ) => {
// If the model is an annotation that can be active, only show it if it *is* active
if ( annModel instanceof ve.dm.Annotation && ve.ce.annotationFactory.canAnnotationBeActive( annModel.getType() ) ) {
return activeModels.indexOf( annModel ) !== -1;
}
return true;
} );
}
};
/**
* Tests whether the selection covers part but not all of a nailed annotation
*
* @return {boolean} True if a nailed annotation is split either at the focus or at the anchor (or both)
*/
ve.ce.Surface.prototype.selectionSplitsNailedAnnotation = function () {
return ve.ce.nailedAnnotationAt( this.nativeSelection.anchorNode ) !==
ve.ce.nailedAnnotationAt( this.nativeSelection.focusNode );
};
/**
* Called when the synchronizer reconnects and their is a server doc ID mismatch
*/
ve.ce.Surface.prototype.onSynchronizerWrongDoc = function () {
OO.ui.alert(
ve.msg( 'visualeditor-rebase-missing-document-error' ),
{ title: ve.msg( 'visualeditor-rebase-missing-document-title' ) }
);
};
/**
* Handle pause events from the synchronizer
*
* Drops the opacity of the surface to indicate that no updates are
* being received from other users.
*/
ve.ce.Surface.prototype.onSynchronizerPause = function () {
this.$element.toggleClass( 've-ce-surface-paused', !!this.model.synchronizer.paused );
};
/**
* Handler for mutation observer
*
* Identifies deleted DOM nodes, and finds and deletes corresponding model structural nodes.
* Mutation observers run asynchronously (on the microtask queue) so the current document state
* may differ from when the mutations happened. Therefore this handler rechecks node attachment,
* document ranges etc.
*
* @param {MutationRecord[]} mutationRecords Records of the mutations observed
*/
ve.ce.Surface.prototype.afterMutations = function ( mutationRecords ) {
const removedNodes = [];
mutationRecords.forEach( ( mutationRecord ) => {
Iif ( !mutationRecord.removedNodes ) {
return;
}
mutationRecord.removedNodes.forEach( ( removedNode ) => {
const view = $.data( removedNode, 'view' );
if ( view && view.isContent && !view.isContent() ) {
removedNodes.push( view );
}
} );
mutationRecord.addedNodes.forEach( ( addedNode ) => {
const view = $.data( addedNode, 'view' );
if ( view && view.isContent && !view.isContent() ) {
const idx = removedNodes.indexOf( view );
if ( idx !== -1 ) {
// This is a move, not a removal. See T365052#9811638
removedNodes.splice( idx, 1 );
}
}
} );
} );
const removals = removedNodes.map( ( node ) => ( { node: node, range: node.getOuterRange() } ) );
removals.sort( ( x, y ) => x.range.start - y.range.start );
for ( let i = 0, iLen = removals.length; i < iLen; i++ ) {
// Remove any overlapped range (which in a tree must be a nested range)
Iif ( i > 0 && removals[ i ].range.start < removals[ i - 1 ].range.end ) {
removals.splice( i, 1 );
i--;
continue;
}
}
removals.forEach( ( removal ) => {
const tx = ve.dm.TransactionBuilder.static.newFromRemoval(
this.getModel().getDocument(),
removal.node.getOuterRange()
);
this.getModel().change( tx );
} );
};
|