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
|
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=2 et sw=2 tw=80: */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#include "TextLeafRange.h"
#include "HyperTextAccessible-inl.h"
#include "mozilla/a11y/Accessible.h"
#include "mozilla/a11y/CacheConstants.h"
#include "mozilla/a11y/DocAccessible.h"
#include "mozilla/a11y/DocAccessibleParent.h"
#include "mozilla/a11y/LocalAccessible.h"
#include "mozilla/BinarySearch.h"
#include "mozilla/Casting.h"
#include "mozilla/dom/AbstractRange.h"
#include "mozilla/dom/CharacterData.h"
#include "mozilla/dom/HTMLInputElement.h"
#include "mozilla/PresShell.h"
#include "mozilla/intl/Segmenter.h"
#include "mozilla/intl/WordBreaker.h"
#include "mozilla/StaticPrefs_layout.h"
#include "mozilla/TextEditor.h"
#include "nsAccUtils.h"
#include "nsBlockFrame.h"
#include "nsFocusManager.h"
#include "nsFrameSelection.h"
#include "nsIAccessiblePivot.h"
#include "nsILineIterator.h"
#include "nsINode.h"
#include "nsStyleStructInlines.h"
#include "nsTArray.h"
#include "nsTextFrame.h"
#include "nsUnicharUtils.h"
#include "Pivot.h"
#include "TextAttrs.h"
#include "TextRange.h"
using mozilla::intl::WordBreaker;
using FindWordOptions = mozilla::intl::WordBreaker::FindWordOptions;
namespace mozilla::a11y {
/*** Helpers ***/
/**
* These two functions convert between rendered and content text offsets.
* When text DOM nodes are rendered, the rendered text often does not contain
* all the whitespace from the source. For example, by default, the text
* "a b" will be rendered as "a b"; i.e. multiple spaces are compressed to
* one. TextLeafAccessibles contain rendered text, but when we query layout, we
* need to provide offsets into the original content text. Similarly, layout
* returns content offsets, but we need to convert them to rendered offsets to
* map them to TextLeafAccessibles.
*/
static int32_t RenderedToContentOffset(LocalAccessible* aAcc,
uint32_t aRenderedOffset) {
nsTextFrame* frame = do_QueryFrame(aAcc->GetFrame());
if (!frame) {
MOZ_ASSERT(!aAcc->HasOwnContent() || aAcc->IsHTMLBr(),
"No text frame because this is a XUL label[value] text leaf or "
"a BR element.");
return static_cast<int32_t>(aRenderedOffset);
}
if (frame->StyleText()->WhiteSpaceIsSignificant() &&
frame->StyleText()->NewlineIsSignificant(frame)) {
// Spaces and new lines aren't altered, so the content and rendered offsets
// are the same. This happens in pre-formatted text and text fields.
return static_cast<int32_t>(aRenderedOffset);
}
nsIFrame::RenderedText text =
frame->GetRenderedText(aRenderedOffset, aRenderedOffset + 1,
nsIFrame::TextOffsetType::OffsetsInRenderedText,
nsIFrame::TrailingWhitespace::DontTrim);
return text.mOffsetWithinNodeText;
}
static uint32_t ContentToRenderedOffset(LocalAccessible* aAcc,
int32_t aContentOffset) {
nsTextFrame* frame = do_QueryFrame(aAcc->GetFrame());
if (!frame) {
MOZ_ASSERT(!aAcc->HasOwnContent(),
"No text frame because this is a XUL label[value] text leaf.");
return aContentOffset;
}
if (frame->StyleText()->WhiteSpaceIsSignificant() &&
frame->StyleText()->NewlineIsSignificant(frame)) {
// Spaces and new lines aren't altered, so the content and rendered offsets
// are the same. This happens in pre-formatted text and text fields.
return aContentOffset;
}
nsIFrame::RenderedText text =
frame->GetRenderedText(aContentOffset, aContentOffset + 1,
nsIFrame::TextOffsetType::OffsetsInContentText,
nsIFrame::TrailingWhitespace::DontTrim);
return text.mOffsetWithinNodeRenderedText;
}
class LeafRule : public PivotRule {
public:
explicit LeafRule(bool aIgnoreListItemMarker)
: mIgnoreListItemMarker(aIgnoreListItemMarker) {}
virtual uint16_t Match(Accessible* aAcc) override {
if (aAcc->IsOuterDoc()) {
// Treat an embedded doc as a single character in this document, but do
// not descend inside it.
return nsIAccessibleTraversalRule::FILTER_MATCH |
nsIAccessibleTraversalRule::FILTER_IGNORE_SUBTREE;
}
if (mIgnoreListItemMarker && aAcc->Role() == roles::LISTITEM_MARKER) {
// Ignore list item markers if configured to do so.
return nsIAccessibleTraversalRule::FILTER_IGNORE;
}
// We deliberately include Accessibles such as empty input elements and
// empty containers, as these can be at the start of a line.
if (!aAcc->HasChildren()) {
return nsIAccessibleTraversalRule::FILTER_MATCH;
}
return nsIAccessibleTraversalRule::FILTER_IGNORE;
}
private:
bool mIgnoreListItemMarker;
};
static HyperTextAccessible* HyperTextFor(LocalAccessible* aAcc) {
for (LocalAccessible* acc = aAcc; acc; acc = acc->LocalParent()) {
if (HyperTextAccessible* ht = acc->AsHyperText()) {
return ht;
}
}
return nullptr;
}
static Accessible* NextLeaf(Accessible* aOrigin, bool aIsEditable = false,
bool aIgnoreListItemMarker = false) {
MOZ_ASSERT(aOrigin);
Accessible* doc = nsAccUtils::DocumentFor(aOrigin);
Pivot pivot(doc);
auto rule = LeafRule(aIgnoreListItemMarker);
Accessible* leaf = pivot.Next(aOrigin, rule);
if (aIsEditable && leaf) {
return leaf->Parent() && (leaf->Parent()->State() & states::EDITABLE)
? leaf
: nullptr;
}
return leaf;
}
static Accessible* PrevLeaf(Accessible* aOrigin, bool aIsEditable = false,
bool aIgnoreListItemMarker = false) {
MOZ_ASSERT(aOrigin);
Accessible* doc = nsAccUtils::DocumentFor(aOrigin);
Pivot pivot(doc);
auto rule = LeafRule(aIgnoreListItemMarker);
Accessible* leaf = pivot.Prev(aOrigin, rule);
if (aIsEditable && leaf) {
return leaf->Parent() && (leaf->Parent()->State() & states::EDITABLE)
? leaf
: nullptr;
}
return leaf;
}
static nsIFrame* GetFrameInBlock(const LocalAccessible* aAcc) {
dom::HTMLInputElement* input =
dom::HTMLInputElement::FromNodeOrNull(aAcc->GetContent());
if (!input) {
if (LocalAccessible* parent = aAcc->LocalParent()) {
input = dom::HTMLInputElement::FromNodeOrNull(parent->GetContent());
}
}
if (input) {
// If this is a single line input (or a leaf of an input) we want to return
// the top frame of the input element and not the text leaf's frame because
// the leaf may be inside of an embedded block frame in the input's shadow
// DOM that we aren't interested in.
return input->GetPrimaryFrame();
}
return aAcc->GetFrame();
}
/**
* Returns true if the given frames are on different lines.
*/
static bool AreFramesOnDifferentLines(nsIFrame* aFrame1, nsIFrame* aFrame2) {
MOZ_ASSERT(aFrame1 && aFrame2);
if (aFrame1 == aFrame2) {
// This can happen if two Accessibles share the same frame; e.g. image maps.
return false;
}
auto [block1, lineFrame1] = aFrame1->GetContainingBlockForLine(
/* aLockScroll */ false);
if (!block1) {
// Error; play it safe.
return true;
}
auto [block2, lineFrame2] = aFrame2->GetContainingBlockForLine(
/* aLockScroll */ false);
if (lineFrame1 == lineFrame2) {
return false;
}
if (block1 != block2) {
// These frames are in different blocks, so they're on different lines.
return true;
}
if (nsBlockFrame* block = do_QueryFrame(block1)) {
// If we have a block frame, it's faster for us to use
// BlockInFlowLineIterator because it uses the line cursor.
bool found = false;
block->SetupLineCursorForQuery();
nsBlockInFlowLineIterator it1(block, lineFrame1, &found);
if (!found) {
// Error; play it safe.
return true;
}
found = false;
nsBlockInFlowLineIterator it2(block, lineFrame2, &found);
return !found || it1.GetLineList() != it2.GetLineList() ||
it1.GetLine() != it2.GetLine();
}
AutoAssertNoDomMutations guard;
nsILineIterator* it = block1->GetLineIterator();
MOZ_ASSERT(it, "GetLineIterator impl in line-container blocks is infallible");
int32_t line1 = it->FindLineContaining(lineFrame1);
if (line1 < 0) {
// Error; play it safe.
return true;
}
int32_t line2 = it->FindLineContaining(lineFrame2, line1);
return line1 != line2;
}
static bool IsLocalAccAtLineStart(LocalAccessible* aAcc) {
if (aAcc->NativeRole() == roles::LISTITEM_MARKER) {
// A bullet always starts a line.
return true;
}
// Splitting of content across lines is handled by layout.
// nsIFrame::IsLogicallyAtLineEdge queries whether a frame is the first frame
// on its line. However, we can't use that because the first frame on a line
// might not be included in the a11y tree; e.g. an empty span, or space
// in the DOM after a line break which is stripped when rendered. Instead, we
// get the line number for this Accessible's frame and the line number for the
// previous leaf Accessible's frame and compare them.
Accessible* prev = PrevLeaf(aAcc);
LocalAccessible* prevLocal = prev ? prev->AsLocal() : nullptr;
if (!prevLocal) {
// There's nothing before us, so this is the start of the first line.
return true;
}
if (prevLocal->NativeRole() == roles::LISTITEM_MARKER) {
// If there is a bullet immediately before us and we're inside the same
// list item, this is not the start of a line.
LocalAccessible* listItem = prevLocal->LocalParent();
MOZ_ASSERT(listItem);
LocalAccessible* doc = listItem->Document();
MOZ_ASSERT(doc);
for (LocalAccessible* parent = aAcc->LocalParent(); parent && parent != doc;
parent = parent->LocalParent()) {
if (parent == listItem) {
return false;
}
}
}
nsIFrame* thisFrame = GetFrameInBlock(aAcc);
if (!thisFrame) {
return false;
}
nsIFrame* prevFrame = GetFrameInBlock(prevLocal);
if (!prevFrame) {
return false;
}
// The previous leaf might cross lines. We want to compare against the last
// line.
prevFrame = prevFrame->LastContinuation();
// if the lines are different, that means there's nothing before us on the
// same line, so we're at the start.
return AreFramesOnDifferentLines(thisFrame, prevFrame);
}
/**
* There are many kinds of word break, but we only need to treat punctuation and
* space specially.
*/
enum WordBreakClass { eWbcSpace = 0, eWbcPunct, eWbcOther };
static WordBreakClass GetWordBreakClass(char16_t aChar) {
// Based on IsSelectionInlineWhitespace and IsSelectionNewline in
// layout/generic/nsTextFrame.cpp.
const char16_t kCharNbsp = 0xA0;
switch (aChar) {
case ' ':
case kCharNbsp:
case '\t':
case '\f':
case '\n':
case '\r':
return eWbcSpace;
default:
break;
}
return mozilla::IsPunctuationForWordSelect(aChar) ? eWbcPunct : eWbcOther;
}
/**
* Words can cross Accessibles. To work out whether we're at the start of a
* word, we might have to check the previous leaf. This class handles querying
* the previous WordBreakClass, crossing Accessibles if necessary.
*/
class PrevWordBreakClassWalker {
public:
PrevWordBreakClassWalker(Accessible* aAcc, const nsAString& aText,
int32_t aOffset)
: mAcc(aAcc), mText(aText), mOffset(aOffset) {
mClass = GetWordBreakClass(mText.CharAt(mOffset));
}
WordBreakClass CurClass() { return mClass; }
Maybe<WordBreakClass> PrevClass() {
for (;;) {
if (!PrevChar()) {
return Nothing();
}
WordBreakClass curClass = GetWordBreakClass(mText.CharAt(mOffset));
if (curClass != mClass) {
mClass = curClass;
return Some(curClass);
}
}
MOZ_ASSERT_UNREACHABLE();
return Nothing();
}
bool IsStartOfGroup() {
if (!PrevChar()) {
// There are no characters before us.
return true;
}
WordBreakClass curClass = GetWordBreakClass(mText.CharAt(mOffset));
// We wanted to peek at the previous character, not really move to it.
++mOffset;
return curClass != mClass;
}
private:
bool PrevChar() {
if (mOffset > 0) {
--mOffset;
return true;
}
if (!mAcc) {
// PrevChar was called already and failed.
return false;
}
mAcc = PrevLeaf(mAcc);
if (!mAcc) {
return false;
}
mText.Truncate();
mAcc->AppendTextTo(mText);
mOffset = static_cast<int32_t>(mText.Length()) - 1;
return true;
}
Accessible* mAcc;
nsAutoString mText;
int32_t mOffset;
WordBreakClass mClass;
};
/**
* WordBreaker breaks at all space, punctuation, etc. We want to emulate
* layout, so that's not what we want. This function determines whether this
* is acceptable as the start of a word for our purposes.
*/
static bool IsAcceptableWordStart(Accessible* aAcc, const nsAutoString& aText,
int32_t aOffset) {
PrevWordBreakClassWalker walker(aAcc, aText, aOffset);
if (!walker.IsStartOfGroup()) {
// If we're not at the start of a WordBreaker group, this can't be the
// start of a word.
return false;
}
WordBreakClass curClass = walker.CurClass();
if (curClass == eWbcSpace) {
// Space isn't the start of a word.
return false;
}
Maybe<WordBreakClass> prevClass = walker.PrevClass();
if (curClass == eWbcPunct && (!prevClass || prevClass.value() != eWbcSpace)) {
// Punctuation isn't the start of a word (unless it is after space).
return false;
}
if (!prevClass || prevClass.value() != eWbcPunct) {
// If there's nothing before this or the group before this isn't
// punctuation, this is the start of a word.
return true;
}
// At this point, we know the group before this is punctuation.
if (!StaticPrefs::layout_word_select_stop_at_punctuation()) {
// When layout.word_select.stop_at_punctuation is false (defaults to true),
// if there is punctuation before this, this is not the start of a word.
return false;
}
Maybe<WordBreakClass> prevPrevClass = walker.PrevClass();
if (!prevPrevClass || prevPrevClass.value() == eWbcSpace) {
// If there is punctuation before this and space (or nothing) before the
// punctuation, this is not the start of a word.
return false;
}
return true;
}
class BlockRule : public PivotRule {
public:
virtual uint16_t Match(Accessible* aAcc) override {
if (RefPtr<nsAtom>(aAcc->DisplayStyle()) == nsGkAtoms::block ||
aAcc->IsHTMLListItem() || aAcc->IsTableRow() || aAcc->IsTableCell()) {
return nsIAccessibleTraversalRule::FILTER_MATCH;
}
return nsIAccessibleTraversalRule::FILTER_IGNORE;
}
};
/**
* Find DOM ranges which map to text attributes overlapping the requested
* LocalAccessible and offsets. This includes ranges that begin or end outside
* of the given LocalAccessible. Note that the offset arguments are rendered
* offsets, but because the returned ranges are DOM ranges, those offsets are
* content offsets. See the documentation for
* dom::Selection::GetRangesForIntervalArray for information about the
* aAllowAdjacent argument.
*/
static nsTArray<std::pair<nsTArray<dom::AbstractRange*>, nsStaticAtom*>>
FindDOMTextOffsetAttributes(LocalAccessible* aAcc, int32_t aRenderedStart,
int32_t aRenderedEnd, bool aAllowAdjacent = false) {
nsTArray<std::pair<nsTArray<dom::AbstractRange*>, nsStaticAtom*>> result;
if (!aAcc->IsTextLeaf() || !aAcc->HasOwnContent() ||
!aAcc->GetContent()->IsText()) {
return result;
}
nsIFrame* frame = aAcc->GetFrame();
RefPtr<nsFrameSelection> frameSel =
frame ? frame->GetFrameSelection() : nullptr;
if (!frameSel) {
return result;
}
nsINode* node = aAcc->GetNode();
uint32_t contentStart = RenderedToContentOffset(aAcc, aRenderedStart);
uint32_t contentEnd =
aRenderedEnd == nsIAccessibleText::TEXT_OFFSET_END_OF_TEXT
? dom::CharacterData::FromNode(node)->TextLength()
: RenderedToContentOffset(aAcc, aRenderedEnd);
const std::pair<mozilla::SelectionType, nsStaticAtom*>
kSelectionTypesToAttributes[] = {
{SelectionType::eSpellCheck, nsGkAtoms::spelling},
{SelectionType::eTargetText, nsGkAtoms::mark},
};
size_t highlightCount = frameSel->HighlightSelectionCount();
result.SetCapacity(std::size(kSelectionTypesToAttributes) + highlightCount);
auto appendRanges = [&](dom::Selection* aDomSel, nsStaticAtom* aAttr) {
nsTArray<dom::AbstractRange*> domRanges;
aDomSel->GetAbstractRangesForIntervalArray(
node, contentStart, node, contentEnd, aAllowAdjacent, &domRanges);
if (!domRanges.IsEmpty()) {
result.AppendElement(std::make_pair(std::move(domRanges), aAttr));
}
};
for (auto [selType, attr] : kSelectionTypesToAttributes) {
dom::Selection* domSel = frameSel->GetSelection(selType);
if (!domSel) {
continue;
}
appendRanges(domSel, attr);
}
for (size_t h = 0; h < highlightCount; ++h) {
RefPtr<dom::Selection> domSel = frameSel->HighlightSelection(h);
MOZ_ASSERT(domSel);
nsStaticAtom* attr = nullptr;
MOZ_ASSERT(domSel->HighlightSelectionData().mHighlight);
switch (domSel->HighlightSelectionData().mHighlight->Type()) {
case dom::HighlightType::Highlight:
attr = nsGkAtoms::mark;
break;
case dom::HighlightType::Spelling_error:
attr = nsGkAtoms::spelling;
break;
case dom::HighlightType::Grammar_error:
attr = nsGkAtoms::grammar;
break;
}
MOZ_ASSERT(attr);
appendRanges(domSel, attr);
}
return result;
}
/**
* Given two DOM nodes get DOM Selection object that is common
* to both of them.
*/
static dom::Selection* GetDOMSelection(const nsIContent* aStartContent,
const nsIContent* aEndContent) {
nsIFrame* startFrame = aStartContent->GetPrimaryFrame();
const nsFrameSelection* startFrameSel =
startFrame ? startFrame->GetConstFrameSelection() : nullptr;
nsIFrame* endFrame = aEndContent->GetPrimaryFrame();
const nsFrameSelection* endFrameSel =
endFrame ? endFrame->GetConstFrameSelection() : nullptr;
if (startFrameSel != endFrameSel) {
// Start and end point don't share the same selection state.
// This could happen when both points aren't in the same editable.
return nullptr;
}
return startFrameSel ? &startFrameSel->NormalSelection() : nullptr;
}
std::pair<nsIContent*, uint32_t> TextLeafPoint::ToDOMPoint(
bool aIncludeGenerated) const {
if (!(*this) || !mAcc->IsLocal()) {
MOZ_ASSERT_UNREACHABLE("Invalid point");
return {nullptr, 0};
}
nsIContent* content = mAcc->AsLocal()->GetContent();
nsIFrame* frame = content ? content->GetPrimaryFrame() : nullptr;
MOZ_ASSERT(frame);
if (!aIncludeGenerated && frame && frame->IsGeneratedContentFrame()) {
// List markers accessibles represent the generated content element,
// before/after text accessibles represent the child text nodes.
auto generatedElement = content->IsGeneratedContentContainerForMarker()
? content
: content->GetParentElement();
auto parent = generatedElement ? generatedElement->GetParent() : nullptr;
MOZ_ASSERT(parent);
if (parent) {
if (generatedElement->IsGeneratedContentContainerForAfter()) {
// Use the end offset of the parent element for trailing generated
// content.
return {parent, parent->GetChildCount()};
}
if (generatedElement->IsGeneratedContentContainerForBefore() ||
generatedElement->IsGeneratedContentContainerForMarker()) {
// Use the start offset of the parent element for leading generated
// content.
return {parent, 0};
}
MOZ_ASSERT_UNREACHABLE("Unknown generated content type!");
}
}
if (mAcc->IsTextLeaf()) {
// For text nodes, DOM uses a character offset within the node.
return {content, RenderedToContentOffset(mAcc->AsLocal(), mOffset)};
}
if (!mAcc->IsHyperText()) {
// For non-text nodes (e.g. images), DOM points use the child index within
// the parent. mOffset could be 0 (for the start of the node) or 1 (for the
// end of the node). mOffset could be 1 if this is the last Accessible in a
// container and the point is at the end of the container.
MOZ_ASSERT(mOffset == 0 || mOffset == 1);
nsIContent* parent = content->GetParent();
MOZ_ASSERT(parent);
// ComputeIndexOf() could return Nothing if this is an anonymous child.
if (auto childIndex = parent->ComputeIndexOf(content)) {
return {parent, mOffset == 0 ? *childIndex : *childIndex + 1};
}
}
// This could be an empty editable container, whitespace or an empty doc. In
// any case, the offset inside should be 0.
MOZ_ASSERT(mOffset == 0);
if (RefPtr<TextControlElement> textControlElement =
TextControlElement::FromNodeOrNull(content)) {
// This is an empty input, use the shadow root's element.
if (RefPtr<TextEditor> textEditor = textControlElement->GetTextEditor()) {
if (textEditor->IsEmpty()) {
MOZ_ASSERT(mOffset == 0);
return {textEditor->GetRoot(), 0};
}
}
}
return {content, 0};
}
static bool IsLineBreakContinuation(nsTextFrame* aContinuation) {
// A fluid continuation always means a new line.
if (aContinuation->HasAnyStateBits(NS_FRAME_IS_FLUID_CONTINUATION)) {
return true;
}
// If both this continuation and the previous continuation are bidi
// continuations, this continuation might be both a bidi split and on a new
// line.
if (!aContinuation->HasAnyStateBits(NS_FRAME_IS_BIDI)) {
return true;
}
nsTextFrame* prev = aContinuation->GetPrevContinuation();
if (!prev) {
// aContinuation is the primary frame. We can't be sure if this starts a new
// line, as there might be other nodes before it. That is handled by
// IsLocalAccAtLineStart.
return false;
}
if (!prev->HasAnyStateBits(NS_FRAME_IS_BIDI)) {
return true;
}
return AreFramesOnDifferentLines(aContinuation, prev);
}
static bool IsCaretValid(TextLeafPoint aPoint) {
Accessible* acc = aPoint.mAcc;
if (!acc->IsHyperText()) {
acc = acc->Parent();
}
if (!(acc->State() & states::EDITABLE)) {
return true;
}
// The caret is within editable content.
Accessible* focus = FocusMgr() ? FocusMgr()->FocusedAccessible() : nullptr;
if (!focus) {
return false;
}
// If the focus isn't an editor, the caret can't be inside an editor. This
// can happen, for example, when a text input is the last element in a
// container and a user clicks in the empty area at the end of the container.
// In this case, the caret is actually at the end of the container outside the
// input. This can also happen if there is an empty area in a container before
// an input and a user clicks there. TextLeafPoint can't represent either of
// these cases and it's generally not useful. We must not normalize this to
// the nearest leaf because this would put the caret inside an editor which
// isn't focused. Instead, we pretend there is no caret. See bug 1950748 for
// more details.
return focus->State() & states::EDITABLE;
}
/*** TextLeafPoint ***/
TextLeafPoint::TextLeafPoint(Accessible* aAcc, int32_t aOffset) {
MOZ_ASSERT(aOffset >= 0 ||
aOffset == nsIAccessibleText::TEXT_OFFSET_END_OF_TEXT);
if (!aAcc) {
// Construct an invalid point.
mAcc = nullptr;
mOffset = 0;
return;
}
// Even though an OuterDoc contains a document, we treat it as a leaf because
// we don't want to move into another document.
if (!aAcc->IsOuterDoc() && aAcc->HasChildren()) {
// Find a leaf. This might not necessarily be a TextLeafAccessible; it
// could be an empty container.
auto GetChild = [&aOffset](Accessible* acc) -> Accessible* {
if (acc->IsOuterDoc()) {
return nullptr;
}
return aOffset != nsIAccessibleText::TEXT_OFFSET_END_OF_TEXT
? acc->FirstChild()
: acc->LastChild();
};
for (Accessible* acc = GetChild(aAcc); acc; acc = GetChild(acc)) {
mAcc = acc;
}
mOffset = aOffset != nsIAccessibleText::TEXT_OFFSET_END_OF_TEXT
? 0
: nsAccUtils::TextLength(mAcc);
return;
}
mAcc = aAcc;
mOffset = aOffset != nsIAccessibleText::TEXT_OFFSET_END_OF_TEXT
? aOffset
: nsAccUtils::TextLength(mAcc);
}
bool TextLeafPoint::operator<(const TextLeafPoint& aPoint) const {
if (mAcc == aPoint.mAcc) {
return mOffset < aPoint.mOffset;
}
return mAcc->IsBefore(aPoint.mAcc);
}
bool TextLeafPoint::operator<=(const TextLeafPoint& aPoint) const {
return *this == aPoint || *this < aPoint;
}
bool TextLeafPoint::IsDocEdge(nsDirection aDirection) const {
if (aDirection == eDirPrevious) {
return mOffset == 0 && !PrevLeaf(mAcc);
}
return mOffset == static_cast<int32_t>(nsAccUtils::TextLength(mAcc)) &&
!NextLeaf(mAcc);
}
bool TextLeafPoint::IsLeafAfterListItemMarker() const {
Accessible* prev = PrevLeaf(mAcc);
return prev && prev->Role() == roles::LISTITEM_MARKER &&
prev->Parent()->IsAncestorOf(mAcc);
}
bool TextLeafPoint::IsEmptyLastLine() const {
if (mAcc->IsHTMLBr() && mOffset == 1) {
return true;
}
if (!mAcc->IsTextLeaf()) {
return false;
}
if (mOffset < static_cast<int32_t>(nsAccUtils::TextLength(mAcc))) {
return false;
}
nsAutoString text;
mAcc->AppendTextTo(text, mOffset - 1, 1);
return text.CharAt(0) == '\n';
}
char16_t TextLeafPoint::GetChar() const {
nsAutoString text;
mAcc->AppendTextTo(text, mOffset, 1);
return text.CharAt(0);
}
TextLeafPoint TextLeafPoint::FindPrevLineStartSameLocalAcc(
bool aIncludeOrigin) const {
LocalAccessible* acc = mAcc->AsLocal();
MOZ_ASSERT(acc);
if (mOffset == 0) {
if (aIncludeOrigin && IsLocalAccAtLineStart(acc)) {
return *this;
}
return TextLeafPoint();
}
nsIFrame* frame = acc->GetFrame();
if (!frame) {
// This can happen if this is an empty element with display: contents. In
// that case, this Accessible contains no lines.
return TextLeafPoint();
}
if (!frame->IsTextFrame()) {
if (IsLocalAccAtLineStart(acc)) {
return TextLeafPoint(acc, 0);
}
return TextLeafPoint();
}
// Each line of a text node is rendered as a continuation frame. Get the
// continuation containing the origin.
int32_t origOffset = mOffset;
origOffset = RenderedToContentOffset(acc, origOffset);
nsTextFrame* continuation = nullptr;
int32_t unusedOffsetInContinuation = 0;
frame->GetChildFrameContainingOffset(
origOffset, true, &unusedOffsetInContinuation, (nsIFrame**)&continuation);
MOZ_ASSERT(continuation);
int32_t lineStart = continuation->GetContentOffset();
if (lineStart > 0 && (
// A line starts at the origin, but the caller
// doesn't want this included.
(!aIncludeOrigin && lineStart == origOffset) ||
!IsLineBreakContinuation(continuation))) {
// Go back one more, skipping continuations that aren't line breaks or the
// primary frame.
for (nsTextFrame* prev = continuation->GetPrevContinuation(); prev;
prev = prev->GetPrevContinuation()) {
continuation = prev;
if (IsLineBreakContinuation(continuation)) {
break;
}
}
MOZ_ASSERT(continuation);
lineStart = continuation->GetContentOffset();
}
MOZ_ASSERT(lineStart >= 0);
MOZ_ASSERT(lineStart == 0 || IsLineBreakContinuation(continuation));
if (lineStart == 0 && !IsLocalAccAtLineStart(acc)) {
// This is the first line of this text node, but there is something else
// on the same line before this text node, so don't return this as a line
// start.
return TextLeafPoint();
}
lineStart = static_cast<int32_t>(ContentToRenderedOffset(acc, lineStart));
return TextLeafPoint(acc, lineStart);
}
TextLeafPoint TextLeafPoint::FindNextLineStartSameLocalAcc(
bool aIncludeOrigin) const {
LocalAccessible* acc = mAcc->AsLocal();
MOZ_ASSERT(acc);
if (aIncludeOrigin && mOffset == 0 && IsLocalAccAtLineStart(acc)) {
return *this;
}
nsIFrame* frame = acc->GetFrame();
if (!frame) {
// This can happen if this is an empty element with display: contents. In
// that case, this Accessible contains no lines.
return TextLeafPoint();
}
if (!frame->IsTextFrame()) {
// There can't be multiple lines in a non-text leaf.
return TextLeafPoint();
}
// Each line of a text node is rendered as a continuation frame. Get the
// continuation containing the origin.
int32_t origOffset = mOffset;
origOffset = RenderedToContentOffset(acc, origOffset);
nsTextFrame* continuation = nullptr;
int32_t unusedOffsetInContinuation = 0;
frame->GetChildFrameContainingOffset(
origOffset, true, &unusedOffsetInContinuation, (nsIFrame**)&continuation);
MOZ_ASSERT(continuation);
if (
// A line starts at the origin and the caller wants this included.
aIncludeOrigin && continuation->GetContentOffset() == origOffset &&
IsLineBreakContinuation(continuation) &&
// If this is the first line of this text node (offset 0), don't treat it
// as a line start if there's something else on the line before this text
// node.
!(origOffset == 0 && !IsLocalAccAtLineStart(acc))) {
return *this;
}
// Get the next continuation, skipping continuations that aren't line breaks.
while ((continuation = continuation->GetNextContinuation())) {
if (IsLineBreakContinuation(continuation)) {
break;
}
}
if (!continuation) {
return TextLeafPoint();
}
int32_t lineStart = continuation->GetContentOffset();
lineStart = static_cast<int32_t>(ContentToRenderedOffset(acc, lineStart));
return TextLeafPoint(acc, lineStart);
}
TextLeafPoint TextLeafPoint::FindLineStartSameRemoteAcc(
nsDirection aDirection, bool aIncludeOrigin) const {
RemoteAccessible* acc = mAcc->AsRemote();
MOZ_ASSERT(acc);
auto lines = acc->GetCachedTextLines();
if (!lines) {
return TextLeafPoint();
}
size_t index;
// If BinarySearch returns true, mOffset is in the array and index points at
// it. If BinarySearch returns false, mOffset is not in the array and index
// points at the next line start after mOffset.
if (BinarySearch(*lines, 0, lines->Length(), mOffset, &index)) {
if (aIncludeOrigin) {
return *this;
}
if (aDirection == eDirNext) {
// We don't want to include the origin. Get the next line start.
++index;
}
}
MOZ_ASSERT(index <= lines->Length());
if ((aDirection == eDirNext && index == lines->Length()) ||
(aDirection == eDirPrevious && index == 0)) {
return TextLeafPoint();
}
// index points at the line start after mOffset.
if (aDirection == eDirPrevious) {
--index;
}
return TextLeafPoint(mAcc, lines->ElementAt(index));
}
TextLeafPoint TextLeafPoint::FindLineStartSameAcc(
nsDirection aDirection, bool aIncludeOrigin,
bool aIgnoreListItemMarker) const {
TextLeafPoint boundary;
if (aIgnoreListItemMarker && aIncludeOrigin && mOffset == 0 &&
IsLeafAfterListItemMarker()) {
// If:
// (1) we are ignoring list markers
// (2) we should include origin
// (3) we are at the start of a leaf that follows a list item marker
// ...then return this point.
return *this;
}
if (mAcc->IsLocal()) {
boundary = aDirection == eDirNext
? FindNextLineStartSameLocalAcc(aIncludeOrigin)
: FindPrevLineStartSameLocalAcc(aIncludeOrigin);
} else {
boundary = FindLineStartSameRemoteAcc(aDirection, aIncludeOrigin);
}
if (aIgnoreListItemMarker && aDirection == eDirPrevious && !boundary &&
mOffset != 0 && IsLeafAfterListItemMarker()) {
// If:
// (1) we are ignoring list markers
// (2) we are searching backwards in accessible
// (3) we did not find a line start before this point
// (4) we are in a leaf that follows a list item marker
// ...then return the first point in this accessible.
boundary = TextLeafPoint(mAcc, 0);
}
return boundary;
}
TextLeafPoint TextLeafPoint::FindPrevWordStartSameAcc(
bool aIncludeOrigin) const {
if (mOffset == 0 && !aIncludeOrigin) {
// We can't go back any further and the caller doesn't want the origin
// included, so there's nothing more to do.
return TextLeafPoint();
}
nsAutoString text;
mAcc->AppendTextTo(text);
TextLeafPoint lineStart = *this;
if (!aIncludeOrigin || (lineStart.mOffset == 1 && text.Length() == 1 &&
text.CharAt(0) == '\n')) {
// We're not interested in a line that starts here, either because
// aIncludeOrigin is false or because we're at the end of a line break
// node.
--lineStart.mOffset;
}
// A word never starts with a line feed character. If there are multiple
// consecutive line feed characters and we're after the first of them, the
// previous line start will be a line feed character. Skip this and any prior
// consecutive line feed first.
for (; lineStart.mOffset >= 0 && text.CharAt(lineStart.mOffset) == '\n';
--lineStart.mOffset) {
}
if (lineStart.mOffset < 0) {
// There's no line start for our purposes.
lineStart = TextLeafPoint();
} else {
lineStart =
lineStart.FindLineStartSameAcc(eDirPrevious, /* aIncludeOrigin */ true);
}
// Keep walking backward until we find an acceptable word start.
intl::WordRange word;
if (mOffset == 0) {
word.mBegin = 0;
} else if (mOffset == static_cast<int32_t>(text.Length())) {
word = WordBreaker::FindWord(
text, mOffset - 1,
StaticPrefs::layout_word_select_stop_at_punctuation()
? FindWordOptions::StopAtPunctuation
: FindWordOptions::None);
} else {
word = WordBreaker::FindWord(
text, mOffset,
StaticPrefs::layout_word_select_stop_at_punctuation()
? FindWordOptions::StopAtPunctuation
: FindWordOptions::None);
}
for (;; word = WordBreaker::FindWord(
text, word.mBegin - 1,
StaticPrefs::layout_word_select_stop_at_punctuation()
? FindWordOptions::StopAtPunctuation
: FindWordOptions::None)) {
if (!aIncludeOrigin && static_cast<int32_t>(word.mBegin) == mOffset) {
// A word possibly starts at the origin, but the caller doesn't want this
// included.
MOZ_ASSERT(word.mBegin != 0);
continue;
}
if (lineStart && static_cast<int32_t>(word.mBegin) < lineStart.mOffset) {
// A line start always starts a new word.
return lineStart;
}
if (IsAcceptableWordStart(mAcc, text, static_cast<int32_t>(word.mBegin))) {
break;
}
if (word.mBegin == 0) {
// We can't go back any further.
if (lineStart) {
// A line start always starts a new word.
return lineStart;
}
return TextLeafPoint();
}
}
return TextLeafPoint(mAcc, static_cast<int32_t>(word.mBegin));
}
TextLeafPoint TextLeafPoint::FindNextWordStartSameAcc(
bool aIncludeOrigin) const {
nsAutoString text;
mAcc->AppendTextTo(text);
int32_t wordStart = mOffset;
if (aIncludeOrigin) {
if (wordStart == 0) {
if (IsAcceptableWordStart(mAcc, text, 0)) {
return *this;
}
} else {
// The origin might start a word, so search from just before it.
--wordStart;
}
}
TextLeafPoint lineStart = FindLineStartSameAcc(eDirNext, aIncludeOrigin);
if (lineStart) {
// A word never starts with a line feed character. If there are multiple
// consecutive line feed characters, lineStart will point at the second of
// them. Skip this and any subsequent consecutive line feed.
for (; lineStart.mOffset < static_cast<int32_t>(text.Length()) &&
text.CharAt(lineStart.mOffset) == '\n';
++lineStart.mOffset) {
}
if (lineStart.mOffset == static_cast<int32_t>(text.Length())) {
// There's no line start for our purposes.
lineStart = TextLeafPoint();
}
}
// Keep walking forward until we find an acceptable word start.
intl::WordBreakIteratorUtf16 wordBreakIter(text);
int32_t previousPos = wordStart;
Maybe<uint32_t> nextBreak = wordBreakIter.Seek(wordStart);
for (;;) {
if (!nextBreak || *nextBreak == text.Length()) {
if (lineStart) {
// A line start always starts a new word.
return lineStart;
}
if (StaticPrefs::layout_word_select_stop_at_punctuation()) {
// If layout.word_select.stop_at_punctuation is true, we have to look
// for punctuation class since it may not break state in UAX#29.
for (int32_t i = previousPos + 1;
i < static_cast<int32_t>(text.Length()); i++) {
if (IsAcceptableWordStart(mAcc, text, i)) {
return TextLeafPoint(mAcc, i);
}
}
}
return TextLeafPoint();
}
wordStart = AssertedCast<int32_t>(*nextBreak);
if (lineStart && wordStart > lineStart.mOffset) {
// A line start always starts a new word.
return lineStart;
}
if (IsAcceptableWordStart(mAcc, text, wordStart)) {
break;
}
if (StaticPrefs::layout_word_select_stop_at_punctuation()) {
// If layout.word_select.stop_at_punctuation is true, we have to look
// for punctuation class since it may not break state in UAX#29.
for (int32_t i = previousPos + 1; i < wordStart; i++) {
if (IsAcceptableWordStart(mAcc, text, i)) {
return TextLeafPoint(mAcc, i);
}
}
}
previousPos = wordStart;
nextBreak = wordBreakIter.Next();
}
return TextLeafPoint(mAcc, wordStart);
}
/* static */
TextLeafPoint TextLeafPoint::GetCaret(Accessible* aAcc) {
if (LocalAccessible* localAcc = aAcc->AsLocal()) {
// Use HyperTextAccessible::CaretOffset. Eventually, we'll want to move
// that code into TextLeafPoint, but existing code depends on it living in
// HyperTextAccessible (including caret events).
HyperTextAccessible* ht = HyperTextFor(localAcc);
if (!ht) {
return TextLeafPoint();
}
int32_t htOffset = ht->CaretOffset();
if (htOffset == -1) {
return TextLeafPoint();
}
TextLeafPoint point = ht->ToTextLeafPoint(htOffset);
if (!point) {
// Bug 1905021: This happens in the wild, but we don't understand why.
// ToTextLeafPoint should only fail if the HyperText offset is invalid,
// but CaretOffset shouldn't return an invalid offset.
MOZ_ASSERT_UNREACHABLE(
"Got HyperText CaretOffset but ToTextLeafPoint failed");
return point;
}
if (!IsCaretValid(point)) {
return TextLeafPoint();
}
nsIFrame* frame = ht->GetFrame();
RefPtr<nsFrameSelection> sel = frame ? frame->GetFrameSelection() : nullptr;
if (sel && sel->GetHint() == CaretAssociationHint::Before) {
// CaretAssociationHint::Before can mean that the caret is at the end of
// a line. However, this can also occur in a few other situations:
// 1. The caret is before the start of a node in the middle of a line.
// This happens when moving the cursor forward to a new node.
// 2. The user clicks the mouse on a character other than the first in a
// node.
// 3. The caret is somewhere other than the start of a line and the user
// presses down or up arrow to move by line.
if (point.mOffset <
static_cast<int32_t>(nsAccUtils::TextLength(point.mAcc))) {
// The caret is at the end of a line if the point is at the start of a
// line but not at the start of a paragraph.
point.mIsEndOfLineInsertionPoint =
point.FindPrevLineStartSameLocalAcc(/* aIncludeOrigin */ true) ==
point &&
!point.IsParagraphStart();
} else {
// This is the end of a node. CaretAssociationHint::Before is only used
// at the end of a node if the caret is at the end of a line.
point.mIsEndOfLineInsertionPoint = true;
}
}
return point;
}
// Ideally, we'd cache the caret as a leaf, but our events are based on
// HyperText for now.
DocAccessibleParent* remoteDoc = aAcc->AsRemote()->Document();
auto [ht, htOffset] = remoteDoc->GetCaret();
if (!ht) {
return TextLeafPoint();
}
TextLeafPoint point = ht->ToTextLeafPoint(htOffset);
if (!point) {
// The caret offset should usually be in sync with the tree. However, tree
// and selection updates happen using separate IPDL calls, so it's possible
// for a client caret query to arrive between them. Thus, we can end up
// with an invalid caret here.
return point;
}
if (!IsCaretValid(point)) {
return TextLeafPoint();
}
point.mIsEndOfLineInsertionPoint = remoteDoc->IsCaretAtEndOfLine();
return point;
}
TextLeafPoint TextLeafPoint::AdjustEndOfLine() const {
MOZ_ASSERT(mIsEndOfLineInsertionPoint);
// Use the last character on the line so that we search for word and line
// boundaries on the current line, not the next line.
return TextLeafPoint(mAcc, mOffset)
.FindBoundary(nsIAccessibleText::BOUNDARY_CHAR, eDirPrevious);
}
TextLeafPoint TextLeafPoint::FindBoundary(AccessibleTextBoundary aBoundaryType,
nsDirection aDirection,
BoundaryFlags aFlags) const {
if (mIsEndOfLineInsertionPoint) {
// In this block, we deliberately don't propagate mIsEndOfLineInsertionPoint
// to derived points because otherwise, a call to FindBoundary on the
// returned point would also return the same point.
if (aBoundaryType == nsIAccessibleText::BOUNDARY_CHAR ||
aBoundaryType == nsIAccessibleText::BOUNDARY_CLUSTER) {
if (aDirection == eDirNext || (aDirection == eDirPrevious &&
aFlags & BoundaryFlags::eIncludeOrigin)) {
// The caller wants the current or next character/cluster. Return no
// character, since otherwise, this would move past the first character
// on the next line.
return TextLeafPoint(mAcc, mOffset);
}
// The caller wants the previous character/cluster. Return that as normal.
return TextLeafPoint(mAcc, mOffset)
.FindBoundary(aBoundaryType, aDirection, aFlags);
}
// For any other boundary, we need to start on this line, not the next, even
// though mOffset refers to the next.
return AdjustEndOfLine().FindBoundary(aBoundaryType, aDirection, aFlags);
}
bool inEditableAndStopInIt = (aFlags & BoundaryFlags::eStopInEditable) &&
mAcc->Parent() &&
(mAcc->Parent()->State() & states::EDITABLE);
if (aBoundaryType == nsIAccessibleText::BOUNDARY_LINE_END) {
return FindLineEnd(aDirection,
inEditableAndStopInIt
? aFlags
: (aFlags & ~BoundaryFlags::eStopInEditable));
}
if (aBoundaryType == nsIAccessibleText::BOUNDARY_WORD_END) {
return FindWordEnd(aDirection,
inEditableAndStopInIt
? aFlags
: (aFlags & ~BoundaryFlags::eStopInEditable));
}
if ((aBoundaryType == nsIAccessibleText::BOUNDARY_LINE_START ||
aBoundaryType == nsIAccessibleText::BOUNDARY_PARAGRAPH) &&
(aFlags & BoundaryFlags::eIncludeOrigin) && aDirection == eDirPrevious &&
IsEmptyLastLine()) {
// If we're at an empty line at the end of an Accessible, we don't want to
// walk into the previous line. For example, this can happen if the caret
// is positioned on an empty line at the end of a textarea.
return *this;
}
bool includeOrigin = !!(aFlags & BoundaryFlags::eIncludeOrigin);
bool ignoreListItemMarker = !!(aFlags & BoundaryFlags::eIgnoreListItemMarker);
Accessible* lastAcc = nullptr;
for (TextLeafPoint searchFrom = *this; searchFrom;
searchFrom = searchFrom.NeighborLeafPoint(
aDirection, inEditableAndStopInIt, ignoreListItemMarker)) {
lastAcc = searchFrom.mAcc;
if (ignoreListItemMarker && searchFrom == *this &&
searchFrom.mAcc->Role() == roles::LISTITEM_MARKER) {
continue;
}
TextLeafPoint boundary;
// Search for the boundary within the current Accessible.
switch (aBoundaryType) {
case nsIAccessibleText::BOUNDARY_CHAR:
if (includeOrigin) {
boundary = searchFrom;
} else if (aDirection == eDirPrevious && searchFrom.mOffset > 0) {
boundary.mAcc = searchFrom.mAcc;
boundary.mOffset = searchFrom.mOffset - 1;
} else if (aDirection == eDirNext &&
searchFrom.mOffset + 1 <
static_cast<int32_t>(
nsAccUtils::TextLength(searchFrom.mAcc))) {
boundary.mAcc = searchFrom.mAcc;
boundary.mOffset = searchFrom.mOffset + 1;
}
break;
case nsIAccessibleText::BOUNDARY_WORD_START:
if (aDirection == eDirPrevious) {
boundary = searchFrom.FindPrevWordStartSameAcc(includeOrigin);
} else {
boundary = searchFrom.FindNextWordStartSameAcc(includeOrigin);
}
break;
case nsIAccessibleText::BOUNDARY_LINE_START:
boundary = searchFrom.FindLineStartSameAcc(aDirection, includeOrigin,
ignoreListItemMarker);
break;
case nsIAccessibleText::BOUNDARY_PARAGRAPH:
boundary = searchFrom.FindParagraphSameAcc(aDirection, includeOrigin,
ignoreListItemMarker);
break;
case nsIAccessibleText::BOUNDARY_CLUSTER:
boundary = searchFrom.FindClusterSameAcc(aDirection, includeOrigin);
break;
default:
MOZ_ASSERT_UNREACHABLE();
break;
}
if (boundary) {
return boundary;
}
// The start/end of the Accessible might be a boundary. If so, we must stop
// on it.
includeOrigin = true;
}
MOZ_ASSERT(lastAcc);
// No further leaf was found. Use the start/end of the first/last leaf.
return TextLeafPoint(
lastAcc, aDirection == eDirPrevious
? 0
: static_cast<int32_t>(nsAccUtils::TextLength(lastAcc)));
}
TextLeafPoint TextLeafPoint::FindLineEnd(nsDirection aDirection,
BoundaryFlags aFlags) const {
if (aDirection == eDirPrevious && IsEmptyLastLine()) {
// If we're at an empty line at the end of an Accessible, we don't want to
// walk into the previous line. For example, this can happen if the caret
// is positioned on an empty line at the end of a textarea.
// Because we want the line end, we must walk back to the line feed
// character.
return FindBoundary(nsIAccessibleText::BOUNDARY_CHAR, eDirPrevious,
aFlags & ~BoundaryFlags::eIncludeOrigin);
}
if ((aFlags & BoundaryFlags::eIncludeOrigin) && IsLineFeedChar()) {
return *this;
}
if (aDirection == eDirPrevious && !(aFlags & BoundaryFlags::eIncludeOrigin)) {
// If there is a line feed immediately before us, return that.
TextLeafPoint prevChar =
FindBoundary(nsIAccessibleText::BOUNDARY_CHAR, eDirPrevious,
aFlags & ~BoundaryFlags::eIncludeOrigin);
if (prevChar.IsLineFeedChar()) {
return prevChar;
}
}
TextLeafPoint searchFrom = *this;
if (aDirection == eDirNext && IsLineFeedChar()) {
// If we search for the next line start from a line feed, we'll get the
// character immediately following the line feed. We actually want the
// next line start after that. Skip the line feed.
searchFrom = FindBoundary(nsIAccessibleText::BOUNDARY_CHAR, eDirNext,
aFlags & ~BoundaryFlags::eIncludeOrigin);
}
TextLeafPoint lineStart = searchFrom.FindBoundary(
nsIAccessibleText::BOUNDARY_LINE_START, aDirection, aFlags);
if (aDirection == eDirNext && IsEmptyLastLine()) {
// There is a line feed immediately before us, but that's actually the end
// of the previous line, not the end of our empty line. Don't walk back.
return lineStart;
}
// If there is a line feed before this line start (at the end of the previous
// line), we must return that.
TextLeafPoint prevChar =
lineStart.FindBoundary(nsIAccessibleText::BOUNDARY_CHAR, eDirPrevious,
aFlags & ~BoundaryFlags::eIncludeOrigin);
if (prevChar && prevChar.IsLineFeedChar()) {
return prevChar;
}
return lineStart;
}
bool TextLeafPoint::IsSpace() const {
return GetWordBreakClass(GetChar()) == eWbcSpace;
}
TextLeafPoint TextLeafPoint::FindWordEnd(nsDirection aDirection,
BoundaryFlags aFlags) const {
char16_t origChar = GetChar();
const bool origIsSpace = GetWordBreakClass(origChar) == eWbcSpace;
bool prevIsSpace = false;
if (aDirection == eDirPrevious ||
((aFlags & BoundaryFlags::eIncludeOrigin) && origIsSpace) || !origChar) {
TextLeafPoint prev =
FindBoundary(nsIAccessibleText::BOUNDARY_CHAR, eDirPrevious,
aFlags & ~BoundaryFlags::eIncludeOrigin);
if (aDirection == eDirPrevious && prev == *this) {
return *this; // Can't go any further.
}
prevIsSpace = prev.IsSpace();
if ((aFlags & BoundaryFlags::eIncludeOrigin) &&
(origIsSpace || IsDocEdge(eDirNext)) && !prevIsSpace) {
// The origin is space or end of document, but the previous
// character is not. This means we're at the end of a word.
return *this;
}
}
TextLeafPoint boundary = *this;
if (aDirection == eDirPrevious && !prevIsSpace) {
// If there isn't space immediately before us, first find the start of the
// previous word.
boundary = FindBoundary(nsIAccessibleText::BOUNDARY_WORD_START,
eDirPrevious, aFlags);
} else if (aDirection == eDirNext &&
(origIsSpace || (!origChar && prevIsSpace))) {
// We're within the space at the end of the word. Skip over the space. We
// can do that by searching for the next word start.
boundary = FindBoundary(nsIAccessibleText::BOUNDARY_WORD_START, eDirNext,
aFlags & ~BoundaryFlags::eIncludeOrigin);
if (boundary.IsSpace()) {
// The next word starts with a space. This can happen if there is a space
// after or at the start of a block element.
return boundary;
}
}
if (aDirection == eDirNext) {
BoundaryFlags flags = aFlags;
if (IsDocEdge(eDirPrevious)) {
// If this is the start of the doc don't be inclusive in the word-start
// search because there is no preceding block where this could be a
// word-end for.
flags &= ~BoundaryFlags::eIncludeOrigin;
}
boundary = boundary.FindBoundary(nsIAccessibleText::BOUNDARY_WORD_START,
eDirNext, flags);
}
// At this point, boundary is either the start of a word or at a space. A
// word ends at the beginning of consecutive space. Therefore, skip back to
// the start of any space before us.
TextLeafPoint prev = boundary;
for (;;) {
prev = prev.FindBoundary(nsIAccessibleText::BOUNDARY_CHAR, eDirPrevious,
aFlags & ~BoundaryFlags::eIncludeOrigin);
if (prev == boundary) {
break; // Can't go any further.
}
if (!prev.IsSpace()) {
break;
}
boundary = prev;
}
return boundary;
}
TextLeafPoint TextLeafPoint::FindParagraphSameAcc(
nsDirection aDirection, bool aIncludeOrigin,
bool aIgnoreListItemMarker) const {
if (aIncludeOrigin && IsDocEdge(eDirPrevious)) {
// The top of the document is a paragraph boundary.
return *this;
}
if (aIgnoreListItemMarker && aIncludeOrigin && mOffset == 0 &&
IsLeafAfterListItemMarker()) {
// If we are in a list item and the previous sibling is
// a bullet, the 0 offset in this leaf is a line start.
return *this;
}
if (mAcc->IsTextLeaf() &&
// We don't want to copy strings unnecessarily. See below for the context
// of these individual conditions.
((aIncludeOrigin && mOffset > 0) || aDirection == eDirNext ||
mOffset >= 2)) {
// If there is a line feed, a new paragraph begins after it.
nsAutoString text;
mAcc->AppendTextTo(text);
if (aIncludeOrigin && mOffset > 0 && text.CharAt(mOffset - 1) == '\n') {
return TextLeafPoint(mAcc, mOffset);
}
int32_t lfOffset = -1;
if (aDirection == eDirNext) {
lfOffset = text.FindChar('\n', mOffset);
} else if (mOffset >= 2) {
// A line feed at mOffset - 1 means the origin begins a new paragraph,
// but we already handled aIncludeOrigin above. Therefore, we search from
// mOffset - 2.
lfOffset = text.RFindChar('\n', mOffset - 2);
}
if (lfOffset != -1 && lfOffset + 1 < static_cast<int32_t>(text.Length())) {
return TextLeafPoint(mAcc, lfOffset + 1);
}
}
if (aIgnoreListItemMarker && mOffset > 0 && aDirection == eDirPrevious &&
IsLeafAfterListItemMarker()) {
// No line breaks were found in the preceding text to this offset.
// If we are in a list item and the previous sibling is
// a bullet, the 0 offset in this leaf is a line start.
return TextLeafPoint(mAcc, 0);
}
// Check whether this Accessible begins a paragraph.
if ((!aIncludeOrigin && mOffset == 0) ||
(aDirection == eDirNext && mOffset > 0)) {
// The caller isn't interested in whether this Accessible begins a
// paragraph.
return TextLeafPoint();
}
Accessible* prevLeaf = PrevLeaf(mAcc);
BlockRule blockRule;
Pivot pivot(nsAccUtils::DocumentFor(mAcc));
Accessible* prevBlock = pivot.Prev(mAcc, blockRule);
// Check if we're the first leaf after a block element.
if (prevBlock) {
if (
// If there's no previous leaf, we must be the first leaf after the
// block.
!prevLeaf ||
// A block can be a leaf; e.g. an empty div or paragraph.
prevBlock == prevLeaf) {
return TextLeafPoint(mAcc, 0);
}
if (prevBlock->IsAncestorOf(mAcc)) {
// We're inside the block.
if (!prevBlock->IsAncestorOf(prevLeaf)) {
// The previous leaf isn't inside the block. That means we're the first
// leaf in the block.
return TextLeafPoint(mAcc, 0);
}
} else {
// We aren't inside the block, so the block ends before us.
if (prevBlock->IsAncestorOf(prevLeaf)) {
// The previous leaf is inside the block. That means we're the first
// leaf after the block. This case is necessary because a block causes a
// paragraph break both before and after it.
return TextLeafPoint(mAcc, 0);
}
}
}
if (!prevLeaf || prevLeaf->IsHTMLBr()) {
// We're the first leaf after a line break or the start of the document.
return TextLeafPoint(mAcc, 0);
}
if (prevLeaf->IsTextLeaf()) {
// There's a text leaf before us. Check if it ends with a line feed.
nsAutoString text;
prevLeaf->AppendTextTo(text, nsAccUtils::TextLength(prevLeaf) - 1, 1);
if (text.CharAt(0) == '\n') {
return TextLeafPoint(mAcc, 0);
}
}
return TextLeafPoint();
}
TextLeafPoint TextLeafPoint::FindClusterSameAcc(nsDirection aDirection,
bool aIncludeOrigin) const {
// We don't support clusters which cross nodes. We can live with that because
// editor doesn't seem to fully support this either.
if (aIncludeOrigin && mOffset == 0) {
// Since we don't cross nodes, offset 0 always begins a cluster.
return *this;
}
if (aDirection == eDirPrevious) {
if (mOffset == 0) {
// We can't go back any further.
return TextLeafPoint();
}
if (!aIncludeOrigin && mOffset == 1) {
// Since we don't cross nodes, offset 0 always begins a cluster. We can't
// take this fast path if aIncludeOrigin is true because offset 1 might
// start a cluster, but we don't know that yet.
return TextLeafPoint(mAcc, 0);
}
}
nsAutoString text;
mAcc->AppendTextTo(text);
if (text.IsEmpty()) {
return TextLeafPoint();
}
if (aDirection == eDirNext &&
mOffset == static_cast<int32_t>(text.Length())) {
return TextLeafPoint();
}
// There is GraphemeClusterBreakReverseIteratorUtf16, but it "doesn't
// handle conjoining Jamo and emoji". Therefore, we must use
// GraphemeClusterBreakIteratorUtf16 even when moving backward.
// GraphemeClusterBreakIteratorUtf16::Seek() always starts from the beginning
// and repeatedly calls Next(), regardless of the seek offset. The best we
// can do is call Next() until we find the offset we need.
intl::GraphemeClusterBreakIteratorUtf16 iter(text);
// Since we don't cross nodes, offset 0 always begins a cluster.
int32_t prevCluster = 0;
while (Maybe<uint32_t> next = iter.Next()) {
int32_t cluster = static_cast<int32_t>(*next);
if (aIncludeOrigin && cluster == mOffset) {
return *this;
}
if (aDirection == eDirPrevious) {
if (cluster >= mOffset) {
return TextLeafPoint(mAcc, prevCluster);
}
prevCluster = cluster;
} else if (cluster > mOffset) {
MOZ_ASSERT(aDirection == eDirNext);
return TextLeafPoint(mAcc, cluster);
}
}
return TextLeafPoint();
}
void TextLeafPoint::AddTextOffsetAttributes(AccAttributes* aAttrs) const {
auto expose = [aAttrs](nsAtom* aAttr) {
if (aAttr == nsGkAtoms::spelling || aAttr == nsGkAtoms::grammar) {
// XXX We don't correctly handle exposure of overlapping spelling and
// grammar errors. See bug 1944217. For now, we expose the one we most
// recently encountered.
aAttrs->SetAttribute(nsGkAtoms::invalid, aAttr);
} else if (aAttr == nsGkAtoms::mark) {
aAttrs->SetAttribute(aAttr, true);
}
};
if (LocalAccessible* acc = mAcc->AsLocal()) {
auto ranges = FindDOMTextOffsetAttributes(acc, mOffset, mOffset + 1);
for (auto& [domRanges, attr] : ranges) {
MOZ_ASSERT(domRanges.Length() >= 1);
expose(attr);
}
return;
}
RemoteAccessible* acc = mAcc->AsRemote();
MOZ_ASSERT(acc);
if (RequestDomainsIfInactive(CacheDomain::TextOffsetAttributes)) {
return;
}
if (!acc->mCachedFields) {
return;
}
auto offsetAttrs =
acc->mCachedFields->GetAttribute<nsTArray<TextOffsetAttribute>>(
CacheKey::TextOffsetAttributes);
if (!offsetAttrs) {
return;
}
// offsetAttrs is sorted by mStartOffset, but ranges can overlap each other.
// Thus, we must check all ranges with an encompassing start offset.
for (const TextOffsetAttribute& range : *offsetAttrs) {
if (range.mStartOffset > mOffset) {
// offsetAttrs is sorted by mStartOffset. Therefor, there aren't any
// ranges of interest after this.
break;
}
if (range.mEndOffset != TextOffsetAttribute::kOutsideLeaf &&
range.mEndOffset <= mOffset) {
// range ends inside mAcc but before mOffset, so it doesn't encompass us.
continue;
}
// mOffset is within range.
expose(range.mAttribute);
}
}
TextLeafPoint TextLeafPoint::FindTextOffsetAttributeSameAcc(
nsDirection aDirection, bool aIncludeOrigin) const {
if (!aIncludeOrigin && mOffset == 0 && aDirection == eDirPrevious) {
return TextLeafPoint();
}
if (LocalAccessible* acc = mAcc->AsLocal()) {
nsINode* node = acc->GetNode();
// There are multiple selection types. The ranges for each selection type
// are sorted, but the ranges aren't sorted between selection types.
// Therefore, we need to look for the closest matching offset in each
// selection type. We keep track of that in the dest variable as we check
// each selection type.
int32_t dest = -1;
if (aDirection == eDirNext) {
// We want to find both start and end points, so we pass true for
// aAllowAdjacent.
auto ranges = FindDOMTextOffsetAttributes(
acc, mOffset, nsIAccessibleText::TEXT_OFFSET_END_OF_TEXT,
/* aAllowAdjacent */ true);
for (auto& [domRanges, attr] : ranges) {
for (dom::AbstractRange* domRange : domRanges) {
if (domRange->GetStartContainer() == node) {
int32_t matchOffset = static_cast<int32_t>(ContentToRenderedOffset(
acc, static_cast<int32_t>(domRange->StartOffset())));
if (aIncludeOrigin && matchOffset == mOffset) {
return *this;
}
if (matchOffset > mOffset) {
if (dest == -1 || matchOffset <= dest) {
dest = matchOffset;
}
// ranges is sorted by start, so there can't be a closer range
// offset after this. This is the only case where we can break
// out of the loop. In the cases below, we must keep iterating
// because the end offsets aren't sorted.
break;
}
}
if (domRange->GetEndContainer() == node) {
int32_t matchOffset = static_cast<int32_t>(ContentToRenderedOffset(
acc, static_cast<int32_t>(domRange->EndOffset())));
if (aIncludeOrigin && matchOffset == mOffset) {
return *this;
}
if (matchOffset > mOffset && (dest == -1 || matchOffset <= dest)) {
dest = matchOffset;
}
}
}
}
} else {
auto ranges = FindDOMTextOffsetAttributes(acc, 0, mOffset,
/* aAllowAdjacent */ true);
for (auto& [domRanges, attr] : ranges) {
for (dom::AbstractRange* domRange : Reversed(domRanges)) {
if (domRange->GetEndContainer() == node) {
int32_t matchOffset = static_cast<int32_t>(ContentToRenderedOffset(
acc, static_cast<int32_t>(domRange->EndOffset())));
if (aIncludeOrigin && matchOffset == mOffset) {
return *this;
}
if (matchOffset < mOffset && (dest == -1 || matchOffset >= dest)) {
dest = matchOffset;
}
}
if (domRange->GetStartContainer() == node) {
int32_t matchOffset = static_cast<int32_t>(ContentToRenderedOffset(
acc, static_cast<int32_t>(domRange->StartOffset())));
if (aIncludeOrigin && matchOffset == mOffset) {
return *this;
}
if (matchOffset < mOffset && (dest == -1 || matchOffset >= dest)) {
dest = matchOffset;
}
}
}
}
}
if (dest == -1) {
return TextLeafPoint();
}
return TextLeafPoint(mAcc, dest);
}
RemoteAccessible* acc = mAcc->AsRemote();
MOZ_ASSERT(acc);
if (RequestDomainsIfInactive(CacheDomain::TextOffsetAttributes)) {
return TextLeafPoint();
}
if (!acc->mCachedFields) {
return TextLeafPoint();
}
auto offsetAttrs =
acc->mCachedFields->GetAttribute<nsTArray<TextOffsetAttribute>>(
CacheKey::TextOffsetAttributes);
if (!offsetAttrs) {
return TextLeafPoint();
}
// offsetAttrs is sorted by mStartOffset, but ranges can overlap each other.
// Therefore, we must consider all ranges with an encompassing start offset.
// An earlier range might end after a later range, so we keep track of the
// closest offset in the dest variable and adjust that as we iterate.
int32_t dest = -1;
for (const TextOffsetAttribute& range : *offsetAttrs) {
// Although range end offsets are exclusive, we must still treat them as a
// boundary, since the end of a range still means a change in text
// attributes and text offset attribute ranges do not have to be adjacent.
if (aIncludeOrigin &&
(range.mStartOffset == mOffset || range.mEndOffset == mOffset)) {
return *this;
}
if (aDirection == eDirNext) {
if (range.mStartOffset > mOffset) {
if (dest == -1 || range.mStartOffset < dest) {
// range.mStartOffset is the closest offset we've seen thus far.
dest = range.mStartOffset;
}
// offsetAttrs is sorted by mStartOffset, so there can't be a closer
// range offset after this.
break;
}
if (range.mEndOffset > mOffset &&
(dest == -1 || range.mEndOffset < dest)) {
// range.mEndOffset is the closest offset we've seen thus far.
dest = range.mEndOffset;
}
} else {
if (range.mEndOffset != TextOffsetAttribute::kOutsideLeaf &&
range.mEndOffset < mOffset && range.mEndOffset > dest) {
// range.mEndOffset is the closest offset we've seen thus far.
dest = range.mEndOffset;
}
if (range.mStartOffset >= mOffset) {
// offsetAttrs is sorted by mStartOffset, so any range hereafter is in
// the wrong direction.
break;
}
if (range.mStartOffset != TextOffsetAttribute::kOutsideLeaf &&
range.mStartOffset > dest) {
// range.mStartOffset is the closest offset we've seen thus far.
dest = range.mStartOffset;
}
}
}
if (dest == -1) {
// There's no boundary in the requested direction.
return TextLeafPoint();
}
return TextLeafPoint(mAcc, dest);
}
TextLeafPoint TextLeafPoint::NeighborLeafPoint(
nsDirection aDirection, bool aIsEditable,
bool aIgnoreListItemMarker) const {
Accessible* acc = aDirection == eDirPrevious
? PrevLeaf(mAcc, aIsEditable, aIgnoreListItemMarker)
: NextLeaf(mAcc, aIsEditable, aIgnoreListItemMarker);
if (!acc) {
return TextLeafPoint();
}
return TextLeafPoint(
acc, aDirection == eDirPrevious
? static_cast<int32_t>(nsAccUtils::TextLength(acc)) - 1
: 0);
}
LayoutDeviceIntRect TextLeafPoint::ComputeBoundsFromFrame() const {
LocalAccessible* local = mAcc->AsLocal();
MOZ_ASSERT(local, "Can't compute bounds in frame from non-local acc");
nsIFrame* frame = local->GetFrame();
MOZ_ASSERT(frame, "No frame found for acc!");
if (!frame || !frame->IsTextFrame()) {
return local->Bounds();
}
// Substring must be entirely within the same text node.
MOZ_ASSERT(frame->IsPrimaryFrame(),
"Cannot compute content offset on non-primary frame");
nsIFrame::RenderedText text = frame->GetRenderedText(
mOffset, mOffset + 1, nsIFrame::TextOffsetType::OffsetsInRenderedText,
nsIFrame::TrailingWhitespace::DontTrim);
int32_t contentOffset = text.mOffsetWithinNodeText;
int32_t contentOffsetInFrame;
// Get the right frame continuation -- not really a child, but a sibling of
// the primary frame passed in
nsresult rv = frame->GetChildFrameContainingOffset(
contentOffset, true, &contentOffsetInFrame, &frame);
NS_ENSURE_SUCCESS(rv, LayoutDeviceIntRect());
// Start with this frame's screen rect, which we will shrink based on
// the char we care about within it.
nsRect frameScreenRect = frame->GetScreenRectInAppUnits();
// Add the point where the char starts to the frameScreenRect
nsPoint frameTextStartPoint;
rv = frame->GetPointFromOffset(contentOffset, &frameTextStartPoint);
NS_ENSURE_SUCCESS(rv, LayoutDeviceIntRect());
// Use the next offset to calculate the width
// XXX(morgan) does this work for vertical text?
nsPoint frameTextEndPoint;
rv = frame->GetPointFromOffset(contentOffset + 1, &frameTextEndPoint);
NS_ENSURE_SUCCESS(rv, LayoutDeviceIntRect());
frameScreenRect.SetRectX(
frameScreenRect.X() +
std::min(frameTextStartPoint.x, frameTextEndPoint.x),
mozilla::Abs(frameTextStartPoint.x - frameTextEndPoint.x));
nsPresContext* presContext = local->Document()->PresContext();
return LayoutDeviceIntRect::FromAppUnitsToNearest(
frameScreenRect, presContext->AppUnitsPerDevPixel());
}
LayoutDeviceIntRect TextLeafPoint::InsertionPointBounds() const {
if (TextLeafPoint::GetCaret(mAcc) == *this) {
for (Accessible* acc = mAcc; acc; acc = acc->Parent()) {
if (HyperTextAccessibleBase* ht = acc->AsHyperTextBase()) {
return ht->GetCaretRect().first;
}
}
}
LayoutDeviceIntRect currentBounds = CharBounds();
if (currentBounds.IsEmpty()) {
return LayoutDeviceIntRect();
}
// When 'reversed' is true we calculate the writing direction using a
// neighboring character that is past the current one (eg. in LTR the
// character to the right.)
bool reversed = false;
// We are conservative here and stay within the bounds of the editable so
// we don't get confused with other text-flows outside of this block.
TextLeafPoint neighborChar =
FindBoundary(nsIAccessibleText::BOUNDARY_CHAR, eDirPrevious,
BoundaryFlags::eStopInEditable);
if (*this == neighborChar) {
// If the current char is the first, use the next char past the current
// to extrapolate the writing direction.
neighborChar = FindBoundary(nsIAccessibleText::BOUNDARY_CHAR, eDirNext,
BoundaryFlags::eStopInEditable);
reversed = true;
} else {
if (*this ==
FindBoundary(
nsIAccessibleText::BOUNDARY_LINE_START, eDirPrevious,
BoundaryFlags::eStopInEditable | BoundaryFlags::eIncludeOrigin)) {
// If this char is a newline the previous char will be on the previous
// line either equal or past the current one (eg. in LTR the previous char
// will be to the right of the current instead of the left.)
reversed = true;
}
}
LayoutDeviceIntRect neighborBounds = neighborChar.CharBounds();
if (neighborBounds.IsEmpty()) {
// Either the point is invalid or the accessible is not visible.
// We tried, didn't we..
return LayoutDeviceIntRect();
}
// An axis-agnostic function that determines writing direction and aligns
// the caret where insertion point should be.
auto alignRectToInsertion = [](int32_t neighborStart, bool reversed,
int32_t& currentStart,
int32_t& currentLength) {
// The caret is always 1px wide (or tall, in vertical text).
const int32_t caretLength = 1;
int32_t delta = (neighborStart - currentStart);
if (reversed) {
delta *= -1;
}
if (delta > 0) {
// Previous character is to the end (eg. right in ltr) of the current one,
// or next character is to the start (eg. left in ltr) of the current one.
// Align the caret to the end of the current character.
currentStart += currentLength - caretLength;
}
currentLength = caretLength;
};
WritingMode wm = mAcc->GetWritingMode();
if (wm == WritingMode() && mAcc->Parent()) {
// mAcc is probably a text leaf with no stored writing mode, use its parent.
wm = mAcc->Parent()->GetWritingMode();
}
if (!wm.IsVertical()) {
// Horizontal text.
alignRectToInsertion(neighborBounds.x, reversed, currentBounds.x,
currentBounds.width);
} else {
// Vertical text
alignRectToInsertion(neighborBounds.y, reversed, currentBounds.y,
currentBounds.height);
}
return currentBounds;
}
/* static */
nsTArray<TextOffsetAttribute> TextLeafPoint::GetTextOffsetAttributes(
LocalAccessible* aAcc) {
nsINode* node = aAcc->GetNode();
auto ranges = FindDOMTextOffsetAttributes(
aAcc, 0, nsIAccessibleText::TEXT_OFFSET_END_OF_TEXT);
size_t capacity = 0;
for (auto& [domRanges, attr] : ranges) {
capacity += domRanges.Length();
}
nsTArray<TextOffsetAttribute> offsets(capacity);
for (auto& [domRanges, attr] : ranges) {
for (dom::AbstractRange* domRange : domRanges) {
TextOffsetAttribute& data = *offsets.AppendElement();
data.mAttribute = attr;
if (domRange->GetStartContainer() == node) {
data.mStartOffset = static_cast<int32_t>(ContentToRenderedOffset(
aAcc, static_cast<int32_t>(domRange->StartOffset())));
} else {
// This range overlaps aAcc, but starts before it.
// This can only happen for the first range.
MOZ_ASSERT(domRange == *domRanges.begin());
data.mStartOffset = TextOffsetAttribute::kOutsideLeaf;
}
if (domRange->GetEndContainer() == node) {
data.mEndOffset = static_cast<int32_t>(ContentToRenderedOffset(
aAcc, static_cast<int32_t>(domRange->EndOffset())));
} else {
// This range overlaps aAcc, but ends after it.
// This can only happen for the last range.
MOZ_ASSERT(domRange == *domRanges.rbegin());
data.mEndOffset = TextOffsetAttribute::kOutsideLeaf;
}
}
}
offsets.Sort();
return offsets;
}
/* static */
void TextLeafPoint::UpdateCachedTextOffsetAttributes(
dom::Document* aDocument, const dom::AbstractRange& aRange) {
DocAccessible* docAcc = GetExistingDocAccessible(aDocument);
if (!docAcc) {
return;
}
LocalAccessible* startAcc = docAcc->GetAccessible(aRange.GetStartContainer());
LocalAccessible* endAcc = docAcc->GetAccessible(aRange.GetEndContainer());
if (!startAcc || !endAcc) {
return;
}
for (Accessible* acc = startAcc; acc; acc = NextLeaf(acc)) {
if (acc->IsTextLeaf()) {
docAcc->QueueCacheUpdate(acc->AsLocal(),
CacheDomain::TextOffsetAttributes);
}
if (acc == endAcc) {
// Subtle: We check this here rather than in the loop condition because
// we want to include endAcc but stop once we reach it. Putting it in the
// loop condition would mean we stop at endAcc, but we would also exclude
// it; i.e. we wouldn't push the cache for it.
break;
}
}
}
already_AddRefed<AccAttributes> TextLeafPoint::GetTextAttributesLocalAcc(
bool aIncludeDefaults) const {
LocalAccessible* acc = mAcc->AsLocal();
MOZ_ASSERT(acc);
MOZ_ASSERT(acc->IsText());
// TextAttrsMgr wants a HyperTextAccessible.
LocalAccessible* parent = acc->LocalParent();
if (!parent) {
// This should only happen if a client query occurs after a hide event is
// queued for acc and after acc is detached from the document, but before
// the event is fired and thus before acc is shut down.
MOZ_ASSERT(!acc->IsInDocument());
return nullptr;
}
HyperTextAccessible* hyperAcc = parent->AsHyperText();
MOZ_ASSERT(hyperAcc);
RefPtr<AccAttributes> attributes = new AccAttributes();
if (hyperAcc) {
TextAttrsMgr mgr(hyperAcc, aIncludeDefaults, acc);
mgr.GetAttributes(attributes);
}
return attributes.forget();
}
already_AddRefed<AccAttributes> TextLeafPoint::GetTextAttributes(
bool aIncludeDefaults) const {
if (!mAcc->IsText()) {
return nullptr;
}
RefPtr<AccAttributes> attrs;
if (mAcc->IsLocal()) {
attrs = GetTextAttributesLocalAcc(aIncludeDefaults);
} else {
if (aIncludeDefaults) {
attrs = mAcc->AsRemote()->DefaultTextAttributes();
} else {
attrs = new AccAttributes();
}
if (auto thisAttrs = mAcc->AsRemote()->GetCachedTextAttributes()) {
thisAttrs->CopyTo(attrs);
}
}
AddTextOffsetAttributes(attrs);
return attrs.forget();
}
TextLeafPoint TextLeafPoint::FindTextAttrsStart(nsDirection aDirection,
bool aIncludeOrigin) const {
if (mIsEndOfLineInsertionPoint) {
return AdjustEndOfLine().FindTextAttrsStart(aDirection, aIncludeOrigin);
}
RefPtr<const AccAttributes> lastAttrs;
if (mAcc->IsText()) {
lastAttrs = GetTextAttributes();
}
if (aIncludeOrigin && aDirection == eDirNext && mOffset == 0) {
if (!mAcc->IsText()) {
// Anything other than text breaks an attrs run.
return *this;
}
// Even when searching forward, the only way to know whether the origin is
// the start of a text attrs run is to compare with the previous sibling.
TextLeafPoint point;
point.mAcc = mAcc->PrevSibling();
if (!point.mAcc || !point.mAcc->IsText()) {
return *this;
}
RefPtr<const AccAttributes> attrs = point.GetTextAttributes();
if (attrs && lastAttrs && !attrs->Equal(lastAttrs)) {
return *this;
}
}
TextLeafPoint lastPoint = *this;
// If we're at the start of the container and searching for a previous start,
// start the search from the previous leaf. Otherwise, we'll miss the previous
// start.
const bool shouldTraversePrevLeaf = [&]() {
const bool shouldTraverse =
!aIncludeOrigin && aDirection == eDirPrevious && mOffset == 0;
Accessible* prevSibling = mAcc->PrevSibling();
if (prevSibling) {
return shouldTraverse && !prevSibling->IsText();
}
return shouldTraverse;
}();
if (shouldTraversePrevLeaf) {
// Go to the previous leaf and start the search from there, if it exists.
Accessible* prevLeaf = PrevLeaf(mAcc);
if (!prevLeaf) {
return *this;
}
lastPoint = TextLeafPoint(
prevLeaf, static_cast<int32_t>(nsAccUtils::TextLength(prevLeaf)));
}
// This loop searches within a container (that is, it only looks at siblings).
// We might cross containers before or after this loop, but not within it.
for (;;) {
if (TextLeafPoint offsetAttr = lastPoint.FindTextOffsetAttributeSameAcc(
aDirection, aIncludeOrigin && lastPoint.mAcc == mAcc)) {
// An offset attribute starts or ends somewhere in the Accessible we're
// considering. This causes an attribute change, so return that point.
return offsetAttr;
}
TextLeafPoint point;
point.mAcc = aDirection == eDirNext ? lastPoint.mAcc->NextSibling()
: lastPoint.mAcc->PrevSibling();
if (!point.mAcc || !point.mAcc->IsText()) {
break;
}
RefPtr<const AccAttributes> attrs = point.GetTextAttributes();
if (((!lastAttrs || !attrs) && attrs != lastAttrs) ||
(attrs && !attrs->Equal(lastAttrs))) {
// The attributes change here. If we're moving forward, we want to return
// this point.
if (aDirection == eDirNext) {
return point;
}
// Otherwise, we're moving backward and we've now moved before the start
// point of the current text attributes run.
const auto attrsStart = TextLeafPoint(lastPoint.mAcc, 0);
// Return the current text attributes run start point if:
// 1. The caller wants this function to include the origin in the
// search (aIncludeOrigin implies that we must return the first text
// attributes run start point that we find, even if that point is the
// origin)
// 2. Our search did not begin on the text attributes run start point
if (aIncludeOrigin || attrsStart != *this) {
return attrsStart;
}
// Otherwise, the origin was the attributes run start point and the caller
// wants this function to ignore it in its search. Keep searching.
}
lastPoint = point;
if (aDirection == eDirPrevious) {
// On the next iteration, we want to search for offset attributes from the
// end of this Accessible.
lastPoint.mOffset =
static_cast<int32_t>(nsAccUtils::TextLength(point.mAcc));
}
lastAttrs = attrs;
}
// We couldn't move any further in this container.
if (aDirection == eDirPrevious) {
// Treat the start of a container as a format boundary.
return TextLeafPoint(lastPoint.mAcc, 0);
}
// If we're at the end of the container then we have to use the start of the
// next leaf.
Accessible* nextLeaf = NextLeaf(lastPoint.mAcc);
if (nextLeaf) {
return TextLeafPoint(nextLeaf, 0);
}
// If there's no next leaf, then fall back to the end of the last point.
return TextLeafPoint(
lastPoint.mAcc,
static_cast<int32_t>(nsAccUtils::TextLength(lastPoint.mAcc)));
}
LayoutDeviceIntRect TextLeafPoint::CharBounds() const {
if (!mAcc) {
return LayoutDeviceIntRect();
}
if (mAcc->IsHTMLBr()) {
// HTML <br> elements don't provide character bounds, but do provide text (a
// line feed). They also have 0 width and/or height, depending on the
// doctype and writing mode. Expose minimum 1 x 1 so clients treat it as an
// actual rectangle; e.g. when the caret is positioned on a <br>.
LayoutDeviceIntRect bounds = mAcc->Bounds();
if (bounds.width == 0) {
bounds.width = 1;
}
if (bounds.height == 0) {
bounds.height = 1;
}
return bounds;
}
if (!mAcc->IsTextLeaf()) {
// This could be an empty container. Alternatively, it could be a list
// bullet,which does provide text but doesn't support character bounds. In
// either case, return the Accessible's bounds.
return mAcc->Bounds();
}
auto maybeAdjustLineFeedBounds = [this](LayoutDeviceIntRect& aBounds) {
if (!IsLineFeedChar()) {
return;
}
// Line feeds have a 0 width or height, depending on the writing mode.
// Use 1 instead so that clients treat it as an actual rectangle; e.g. when
// displaying the caret when it is positioned on a line feed.
MOZ_ASSERT(aBounds.IsZeroArea());
if (aBounds.width == 0) {
aBounds.width = 1;
}
if (aBounds.height == 0) {
aBounds.height = 1;
}
};
if (LocalAccessible* local = mAcc->AsLocal()) {
if (mOffset >= 0 &&
static_cast<uint32_t>(mOffset) >= nsAccUtils::TextLength(local)) {
// It's valid for a caller to query the length because the caret might be
// at the end of editable text. In that case, we should just silently
// return. However, we assert that the offset isn't greater than the
// length.
NS_ASSERTION(
static_cast<uint32_t>(mOffset) <= nsAccUtils::TextLength(local),
"Wrong in offset");
return LayoutDeviceIntRect();
}
LayoutDeviceIntRect bounds = ComputeBoundsFromFrame();
// This document may have a resolution set, we will need to multiply
// the document-relative coordinates by that value and re-apply the doc's
// screen coordinates.
nsPresContext* presContext = local->Document()->PresContext();
nsIFrame* rootFrame = presContext->PresShell()->GetRootFrame();
LayoutDeviceIntRect orgRectPixels =
LayoutDeviceIntRect::FromAppUnitsToNearest(
rootFrame->GetScreenRectInAppUnits(),
presContext->AppUnitsPerDevPixel());
bounds.MoveBy(-orgRectPixels.X(), -orgRectPixels.Y());
bounds.ScaleRoundOut(presContext->PresShell()->GetResolution());
bounds.MoveBy(orgRectPixels.X(), orgRectPixels.Y());
maybeAdjustLineFeedBounds(bounds);
return bounds;
}
if (RequestDomainsIfInactive(CacheDomain::TextBounds)) {
return LayoutDeviceIntRect();
}
RemoteAccessible* remote = mAcc->AsRemote();
if (!remote->mCachedFields) {
return LayoutDeviceIntRect();
}
nsRect charBounds = remote->GetCachedCharRect(mOffset);
// A character can have 0 width, but we still want its other coordinates.
// Thus, we explicitly test for an all-0 rect here to determine whether this
// is a valid char rect, rather than using IsZeroArea or IsEmpty.
if (!charBounds.IsEqualRect(0, 0, 0, 0)) {
LayoutDeviceIntRect bounds = remote->BoundsWithOffset(Some(charBounds));
maybeAdjustLineFeedBounds(bounds);
return bounds;
}
return LayoutDeviceIntRect();
}
bool TextLeafPoint::ContainsPoint(int32_t aX, int32_t aY) {
if (mAcc && !mAcc->IsText()) {
// If we're dealing with an empty embedded object, use the
// accessible's non-text bounds.
return mAcc->Bounds().Contains(aX, aY);
}
return CharBounds().Contains(aX, aY);
}
/*** TextLeafRange ***/
bool TextLeafRange::Crop(Accessible* aContainer) {
TextLeafPoint containerStart(aContainer, 0);
TextLeafPoint containerEnd(aContainer,
nsIAccessibleText::TEXT_OFFSET_END_OF_TEXT);
if (mEnd < containerStart || containerEnd < mStart) {
// The range ends before the container, or starts after it.
return false;
}
if (mStart < containerStart) {
// If range start is before container start, adjust range start to
// start of container.
mStart = containerStart;
}
if (containerEnd < mEnd) {
// If range end is after container end, adjust range end to end of
// container.
mEnd = containerEnd;
}
return true;
}
LayoutDeviceIntRect TextLeafRange::Bounds() const {
// We can't simply query the first and last character, and union their bounds.
// They might reside on different lines, so a simple union may yield an
// incorrect width. We should use the length of the longest spanned line for
// our width. To achieve this, walk all the lines and union them into the
// result rectangle.
LayoutDeviceIntRect result;
const bool succeeded = WalkLineRects(
[&result](TextLeafRange aLine, LayoutDeviceIntRect aLineRect) {
result.UnionRect(result, aLineRect);
});
if (!succeeded) {
return {};
}
return result;
}
nsTArray<LayoutDeviceIntRect> TextLeafRange::LineRects() const {
// Get the bounds of the content so we can restrict our lines to just the
// text visible within the bounds of the document.
Maybe<LayoutDeviceIntRect> contentBounds;
if (Accessible* doc = nsAccUtils::DocumentFor(mStart.mAcc)) {
contentBounds.emplace(doc->Bounds());
}
nsTArray<LayoutDeviceIntRect> lineRects;
WalkLineRects([&lineRects, &contentBounds](TextLeafRange aLine,
LayoutDeviceIntRect aLineRect) {
// Clip the bounds to the bounds of the content area.
bool boundsVisible = true;
if (contentBounds.isSome()) {
boundsVisible = aLineRect.IntersectRect(aLineRect, *contentBounds);
}
if (boundsVisible) {
lineRects.AppendElement(aLineRect);
}
});
return lineRects;
}
TextLeafPoint TextLeafRange::TextLeafPointAtScreenPoint(int32_t aX,
int32_t aY) const {
// Step backwards one character to make the endPoint inclusive. This means we
// can use operator!= when comparing against endPoint below (which is very
// fast), rather than operator< (which might be significantly slower).
const TextLeafPoint endPoint =
mEnd.FindBoundary(nsIAccessibleText::BOUNDARY_CHAR, eDirPrevious);
// If there are no characters in this container, we might have moved endPoint
// before mStart. In that case, we shouldn't try to move farther forward, as
// that might result in an infinite loop.
TextLeafPoint point = mStart;
if (mStart <= endPoint) {
for (; !point.ContainsPoint(aX, aY) && point != endPoint;
point =
point.FindBoundary(nsIAccessibleText::BOUNDARY_CHAR, eDirNext)) {
}
}
return point;
}
bool TextLeafRange::SetSelection(int32_t aSelectionNum, bool aSetFocus) const {
if (!mStart || !mEnd || mStart.mAcc->IsLocal() != mEnd.mAcc->IsLocal()) {
return false;
}
if (mStart.mAcc->IsRemote()) {
DocAccessibleParent* doc = mStart.mAcc->AsRemote()->Document();
if (doc != mEnd.mAcc->AsRemote()->Document()) {
return false;
}
(void)doc->SendSetTextSelection(mStart.mAcc->ID(), mStart.mOffset,
mEnd.mAcc->ID(), mEnd.mOffset,
aSelectionNum, aSetFocus);
return true;
}
bool reversed = mEnd < mStart;
auto [startContent, startContentOffset] =
!reversed ? mStart.ToDOMPoint(false) : mEnd.ToDOMPoint(false);
auto [endContent, endContentOffset] =
!reversed ? mEnd.ToDOMPoint(false) : mStart.ToDOMPoint(false);
if (!startContent || !endContent) {
return false;
}
RefPtr<dom::Selection> domSel = GetDOMSelection(startContent, endContent);
if (!domSel) {
return false;
}
HyperTextAccessible* hyp = nullptr;
if (mStart.mAcc->IsHyperText()) {
hyp = mStart.mAcc->AsLocal()->AsHyperText();
} else {
Accessible* parent = mStart.mAcc->Parent();
if (parent) {
hyp = parent->AsLocal()->AsHyperText();
// Note that hyp will still be null here if the parent is not a HyperText.
// That's okay.
}
}
// Before setting the selection range, we need to ensure that the editor
// is initialized. (See bug 804927.)
// Otherwise, it's possible that lazy editor initialization will override
// the selection we set here and leave the caret at the end of the text.
// By calling GetEditor here, we ensure that editor initialization is
// completed before we set the selection.
RefPtr<EditorBase> editor;
if (hyp) {
editor = hyp->GetEditor();
}
// XXX isFocusable will be false if mStart is not a direct child of the
// contentEditable. However, contentEditables generally don't mess with
// selection when they are focused. This has also been our behavior for a very
// long time.
const bool isFocusable = hyp && hyp->InteractiveState() & states::FOCUSABLE;
// If the Accessible is focusable, focus it before setting the selection to
// override the control's own selection changes on focus if any; e.g. inputs
// that do select all on focus. This also ensures that the user can interact
// with wherever they've moved the caret. See bug 524115.
if (aSetFocus && isFocusable) {
hyp->TakeFocus();
}
uint32_t rangeCount = 0;
if (aSelectionNum == kRemoveAllExistingSelectedRanges) {
domSel->RemoveAllRanges(IgnoreErrors());
} else {
rangeCount = domSel->RangeCount();
}
RefPtr<nsRange> domRange = nullptr;
const bool newRange =
aSelectionNum == static_cast<int32_t>(rangeCount) || aSelectionNum < 0;
if (newRange) {
domRange = nsRange::Create(startContent);
} else {
domRange = domSel->GetRangeAt(AssertedCast<uint32_t>(aSelectionNum));
}
if (!domRange) {
return false;
}
domRange->SetStart(startContent, startContentOffset);
domRange->SetEnd(endContent, endContentOffset);
// If this is not a new range, notify selection listeners that the existing
// selection range has changed. Otherwise, just add the new range.
if (!newRange) {
domSel->RemoveRangeAndUnselectFramesAndNotifyListeners(*domRange,
IgnoreErrors());
}
IgnoredErrorResult err;
domSel->AddRangeAndSelectFramesAndNotifyListeners(*domRange, err);
if (err.Failed()) {
return false;
}
// Changing the direction of the selection assures that the caret
// will be at the logical end of the selection.
domSel->SetDirection(reversed ? eDirPrevious : eDirNext);
// Make sure the selection is visible. See bug 1170242.
domSel->ScrollIntoView(nsISelectionController::SELECTION_FOCUS_REGION,
ScrollAxis(), ScrollAxis(),
ScrollFlags::ScrollOverflowHidden);
if (aSetFocus && mStart == mEnd && !isFocusable) {
// We're moving the caret. Notify nsFocusManager so that the focus position
// is correct. See bug 546068.
if (nsFocusManager* DOMFocusManager = nsFocusManager::GetFocusManager()) {
MOZ_ASSERT(mStart.mAcc->AsLocal()->Document());
dom::Document* domDoc =
mStart.mAcc->AsLocal()->Document()->DocumentNode();
MOZ_ASSERT(domDoc);
nsCOMPtr<nsPIDOMWindowOuter> window = domDoc->GetWindow();
RefPtr<dom::Element> result;
DOMFocusManager->MoveFocus(
window, nullptr, nsIFocusManager::MOVEFOCUS_CARET,
nsIFocusManager::FLAG_BYMOVEFOCUS, getter_AddRefs(result));
}
}
return true;
}
/* static */
void TextLeafRange::GetSelection(Accessible* aAcc,
nsTArray<TextLeafRange>& aRanges) {
// Use HyperTextAccessibleBase::SelectionRanges. Eventually, we'll want to
// move that code into TextLeafPoint, but events and caching are based on
// HyperText offsets for now.
HyperTextAccessibleBase* hyp = aAcc->AsHyperTextBase();
if (!hyp) {
return;
}
AutoTArray<TextRange, 1> hypRanges;
hyp->CroppedSelectionRanges(hypRanges);
aRanges.SetCapacity(hypRanges.Length());
for (TextRange& hypRange : hypRanges) {
TextLeafPoint start =
hypRange.StartContainer()->AsHyperTextBase()->ToTextLeafPoint(
hypRange.StartOffset());
TextLeafPoint end =
hypRange.EndContainer()->AsHyperTextBase()->ToTextLeafPoint(
hypRange.EndOffset());
aRanges.EmplaceBack(start, end);
}
}
void TextLeafRange::ScrollIntoView(uint32_t aScrollType) const {
if (!mStart || !mEnd || mStart.mAcc->IsLocal() != mEnd.mAcc->IsLocal()) {
return;
}
if (mStart.mAcc->IsRemote()) {
DocAccessibleParent* doc = mStart.mAcc->AsRemote()->Document();
if (doc != mEnd.mAcc->AsRemote()->Document()) {
// Can't scroll range that spans docs.
return;
}
(void)doc->SendScrollTextLeafRangeIntoView(mStart.mAcc->ID(),
mStart.mOffset, mEnd.mAcc->ID(),
mEnd.mOffset, aScrollType);
return;
}
auto [startContent, startContentOffset] = mStart.ToDOMPoint();
auto [endContent, endContentOffset] = mEnd.ToDOMPoint();
if (!startContent || !endContent) {
return;
}
ErrorResult er;
RefPtr<nsRange> domRange = nsRange::Create(startContent, startContentOffset,
endContent, endContentOffset, er);
if (er.Failed()) {
return;
}
nsCoreUtils::ScrollSubstringTo(mStart.mAcc->AsLocal()->GetFrame(), domRange,
aScrollType);
}
nsTArray<TextLeafRange> TextLeafRange::VisibleLines(
Accessible* aContainer) const {
MOZ_ASSERT(aContainer);
nsTArray<TextLeafRange> lines;
if (mStart == mEnd) {
return lines;
}
// We want to restrict our lines to those visible within aContainer.
LayoutDeviceIntRect containerBounds = aContainer->Bounds();
WalkLineRects([&lines, &containerBounds](TextLeafRange aLine,
LayoutDeviceIntRect aLineRect) {
// XXX This doesn't correctly handle lines that are scrolled out where the
// scroll container is a descendant of aContainer. Such lines might
// intersect with containerBounds, but the scroll container could be a
// descendant of aContainer and should thus exclude this line. See bug
// 1945010 for more details.
if (aLineRect.Intersects(containerBounds)) {
lines.AppendElement(aLine);
}
});
return lines;
}
bool TextLeafRange::WalkLineRects(LineRectCallback aCallback) const {
if (mEnd < mStart) {
return false;
}
if (mStart == mEnd) {
// Return the insertion point bounds for the offset if range is collapsed.
aCallback(*this, mStart.InsertionPointBounds());
return true;
}
bool locatedFinalLine = false;
TextLeafPoint currPoint = mStart;
// Union the first and last chars of each line to create a line rect.
while (!locatedFinalLine) {
TextLeafPoint nextLineStartPoint = currPoint.FindBoundary(
nsIAccessibleText::BOUNDARY_LINE_START, eDirNext);
// If currPoint is at the end of the document, nextLineStartPoint will be
// equal to currPoint. However, this can only happen if mEnd is also the end
// of the document.
MOZ_ASSERT(nextLineStartPoint != currPoint || nextLineStartPoint == mEnd);
if (mEnd <= nextLineStartPoint) {
// nextLineStart is past the end of the range. Constrain this last line to
// the end of the range.
nextLineStartPoint = mEnd;
locatedFinalLine = true;
}
// Fetch the last point in the current line by going back one char from the
// start of the next line.
TextLeafPoint lastPointInLine = nextLineStartPoint.FindBoundary(
nsIAccessibleText::BOUNDARY_CHAR, eDirPrevious);
MOZ_ASSERT(currPoint <= lastPointInLine);
LayoutDeviceIntRect currLineRect = currPoint.CharBounds();
currLineRect.UnionRect(currLineRect, lastPointInLine.CharBounds());
// The range we pass must include the last character and range ends are
// exclusive, hence the use of nextLineStartPoint.
TextLeafRange currLine = TextLeafRange(currPoint, nextLineStartPoint);
aCallback(currLine, currLineRect);
currPoint = nextLineStartPoint;
}
return true;
}
TextLeafRange::Iterator TextLeafRange::Iterator::BeginIterator(
const TextLeafRange& aRange) {
Iterator result(aRange);
result.mSegmentStart = aRange.mStart;
if (aRange.mStart.mAcc == aRange.mEnd.mAcc) {
result.mSegmentEnd = aRange.mEnd;
} else {
result.mSegmentEnd = TextLeafPoint(
aRange.mStart.mAcc, nsIAccessibleText::TEXT_OFFSET_END_OF_TEXT);
}
return result;
}
TextLeafRange::Iterator TextLeafRange::Iterator::EndIterator(
const TextLeafRange& aRange) {
Iterator result(aRange);
result.mSegmentEnd = TextLeafPoint();
result.mSegmentStart = TextLeafPoint();
return result;
}
TextLeafRange::Iterator& TextLeafRange::Iterator::operator++() {
if (mSegmentEnd.mAcc == mRange.mEnd.mAcc) {
mSegmentEnd = TextLeafPoint();
mSegmentStart = TextLeafPoint();
return *this;
}
if (Accessible* nextLeaf = NextLeaf(mSegmentEnd.mAcc)) {
mSegmentStart = TextLeafPoint(nextLeaf, 0);
if (nextLeaf == mRange.mEnd.mAcc) {
mSegmentEnd = TextLeafPoint(nextLeaf, mRange.mEnd.mOffset);
} else {
mSegmentEnd =
TextLeafPoint(nextLeaf, nsIAccessibleText::TEXT_OFFSET_END_OF_TEXT);
}
} else {
mSegmentEnd = TextLeafPoint();
mSegmentStart = TextLeafPoint();
}
return *this;
}
} // namespace mozilla::a11y
|