1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691
|
/* -*- 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 "ARIAMap.h"
#include "CachedTableAccessible.h"
#include "RemoteAccessible.h"
#include "mozilla/a11y/CacheConstants.h"
#include "mozilla/a11y/DocAccessibleParent.h"
#include "mozilla/a11y/DocManager.h"
#include "mozilla/a11y/Platform.h"
#include "mozilla/a11y/TableAccessible.h"
#include "mozilla/a11y/TableCellAccessible.h"
#include "mozilla/dom/Element.h"
#include "mozilla/dom/BrowserParent.h"
#include "mozilla/dom/CanonicalBrowsingContext.h"
#include "mozilla/gfx/Matrix.h"
#include "nsAccessibilityService.h"
#include "nsAccUtils.h"
#include "nsFocusManager.h"
#include "nsTextEquivUtils.h"
#include "Pivot.h"
#include "Relation.h"
#include "mozilla/a11y/RelationType.h"
#include "xpcAccessibleDocument.h"
#ifdef A11Y_LOG
# include "Logging.h"
# define VERIFY_CACHE(domain) \
if (logging::IsEnabled(logging::eCache)) { \
(void)mDoc->SendVerifyCache(mID, domain, mCachedFields); \
}
#else
# define VERIFY_CACHE(domain) \
do { \
} while (0)
#endif
namespace mozilla {
namespace a11y {
// Domain sets we need commonly for functions in this file.
static constexpr uint64_t kNecessaryBoundsDomains =
CacheDomain::Bounds | CacheDomain::TransformMatrix | CacheDomain::Style |
CacheDomain::ScrollPosition | CacheDomain::APZ;
static constexpr uint64_t kNecessaryStateDomains =
CacheDomain::State | CacheDomain::Viewport;
void RemoteAccessible::Shutdown() {
MOZ_DIAGNOSTIC_ASSERT(!IsDoc());
xpcAccessibleDocument* xpcDoc =
GetAccService()->GetCachedXPCDocument(Document());
if (xpcDoc) {
xpcDoc->NotifyOfShutdown(static_cast<RemoteAccessible*>(this));
}
if (IsTable() || IsTableCell()) {
CachedTableAccessible::Invalidate(this);
}
// Remove this acc's relation map from the doc's map of
// reverse relations. Prune forward relations associated with this
// acc's reverse relations. This also removes the acc's map of reverse
// rels from the mDoc's mReverseRelations.
PruneRelationsOnShutdown();
// XXX Ideally this wouldn't be necessary, but it seems OuterDoc
// accessibles can be destroyed before the doc they own.
uint32_t childCount = mChildren.Length();
if (!IsOuterDoc()) {
for (uint32_t idx = 0; idx < childCount; idx++) mChildren[idx]->Shutdown();
} else {
if (childCount > 1) {
MOZ_CRASH("outer doc has too many documents!");
} else if (childCount == 1) {
mChildren[0]->AsDoc()->Unbind();
}
}
mChildren.Clear();
ProxyDestroyed(static_cast<RemoteAccessible*>(this));
// mDoc owns this RemoteAccessible, so RemoveAccessible deletes this.
mDoc->RemoveAccessible(static_cast<RemoteAccessible*>(this));
}
void RemoteAccessible::SetChildDoc(DocAccessibleParent* aChildDoc) {
MOZ_ASSERT(aChildDoc);
MOZ_ASSERT(mChildren.Length() == 0);
mChildren.AppendElement(aChildDoc);
aChildDoc->mIndexInParent = 0;
}
void RemoteAccessible::ClearChildDoc(DocAccessibleParent* aChildDoc) {
MOZ_ASSERT(aChildDoc);
// This is possible if we're replacing one document with another: Doc 1
// has not had a chance to remove itself, but was already replaced by Doc 2
// in SetChildDoc(). This could result in two subsequent calls to
// ClearChildDoc() even though mChildren.Length() == 1.
MOZ_ASSERT(mChildren.Length() <= 1);
mChildren.RemoveElement(aChildDoc);
}
uint32_t RemoteAccessible::EmbeddedChildCount() {
size_t count = 0, kids = mChildren.Length();
for (size_t i = 0; i < kids; i++) {
if (mChildren[i]->IsEmbeddedObject()) {
count++;
}
}
return count;
}
int32_t RemoteAccessible::IndexOfEmbeddedChild(Accessible* aChild) {
size_t index = 0, kids = mChildren.Length();
for (size_t i = 0; i < kids; i++) {
if (mChildren[i]->IsEmbeddedObject()) {
if (mChildren[i] == aChild) {
return index;
}
index++;
}
}
return -1;
}
Accessible* RemoteAccessible::EmbeddedChildAt(uint32_t aChildIdx) {
size_t index = 0, kids = mChildren.Length();
for (size_t i = 0; i < kids; i++) {
if (!mChildren[i]->IsEmbeddedObject()) {
continue;
}
if (index == aChildIdx) {
return mChildren[i];
}
index++;
}
return nullptr;
}
LocalAccessible* RemoteAccessible::OuterDocOfRemoteBrowser() const {
auto tab = static_cast<dom::BrowserParent*>(mDoc->Manager());
dom::Element* frame = tab->GetOwnerElement();
NS_ASSERTION(frame, "why isn't the tab in a frame!");
if (!frame) return nullptr;
DocAccessible* chromeDoc = GetExistingDocAccessible(frame->OwnerDoc());
return chromeDoc ? chromeDoc->GetAccessible(frame) : nullptr;
}
void RemoteAccessible::SetParent(RemoteAccessible* aParent) {
MOZ_ASSERT(!IsDoc() || !AsDoc()->IsTopLevel(),
"Top level doc should not have remote parent");
MOZ_ASSERT(!IsDoc() || !aParent || !aParent->IsDoc(),
"Doc can't be direct parent of another doc");
MOZ_ASSERT(!IsDoc() || !aParent || aParent->IsOuterDoc(),
"Doc's parent must be OuterDoc");
mParent = aParent;
if (!aParent) {
mIndexInParent = -1;
}
}
RemoteAccessible* RemoteAccessible::RemoteParent() const {
MOZ_ASSERT(!IsDoc() || !AsDoc()->IsTopLevel() || !mParent,
"Top level doc should not have RemoteParent");
MOZ_ASSERT(!IsDoc() || !mParent || mParent->mDoc != mDoc,
"Doc's parent should be in another doc");
MOZ_ASSERT(!IsDoc() || !mParent || mParent->IsOuterDoc(),
"Doc's parent should be in another doc");
return mParent;
}
void RemoteAccessible::ApplyCache(CacheUpdateType aUpdateType,
AccAttributes* aFields) {
if (!aFields) {
MOZ_ASSERT_UNREACHABLE("ApplyCache called with aFields == null");
return;
}
const nsTArray<bool> relUpdatesNeeded = PreProcessRelations(aFields);
if (auto maybeViewportCache =
aFields->GetAttribute<nsTArray<uint64_t>>(CacheKey::Viewport)) {
// Updating the viewport cache means the offscreen state of this
// document's accessibles has changed. Update the HashSet we use for
// checking offscreen state here.
MOZ_ASSERT(IsDoc(),
"Fetched the viewport cache from a non-doc accessible?");
AsDoc()->mOnScreenAccessibles.Clear();
for (auto id : *maybeViewportCache) {
AsDoc()->mOnScreenAccessibles.Insert(id);
}
}
if (aUpdateType == CacheUpdateType::Initial) {
mCachedFields = aFields;
} else {
if (!mCachedFields) {
// The fields cache can be uninitialized if there were no cache-worthy
// fields in the initial cache push.
// We don't do a simple assign because we don't want to store the
// DeleteEntry entries.
mCachedFields = new AccAttributes();
}
mCachedFields->Update(aFields);
}
if (IsTextLeaf()) {
RemoteAccessible* parent = RemoteParent();
if (parent && parent->IsHyperText()) {
parent->InvalidateCachedHyperTextOffsets();
}
}
PostProcessRelations(relUpdatesNeeded);
}
ENameValueFlag RemoteAccessible::Name(nsString& aName) const {
if (RequestDomainsIfInactive(CacheDomain::NameAndDescription |
CacheDomain::Text | CacheDomain::Relations) ||
!mCachedFields) {
aName.SetIsVoid(true);
return eNameOK;
}
if (IsText()) {
mCachedFields->GetAttribute(CacheKey::Text, aName);
return eNameOK;
}
if (mCachedFields->GetAttribute(CacheKey::Name, aName)) {
VERIFY_CACHE(CacheDomain::NameAndDescription);
return eNameOK;
}
if (auto maybeAriaLabelIds = mCachedFields->GetAttribute<nsTArray<uint64_t>>(
nsGkAtoms::aria_labelledby)) {
RemoteAccIterator iter(*maybeAriaLabelIds, Document());
nsTextEquivUtils::GetTextEquivFromAccIterable(this, &iter, aName);
aName.CompressWhitespace();
}
if (!aName.IsEmpty()) {
return eNameFromRelations;
}
if (auto accRelMapEntry = mDoc->mReverseRelations.Lookup(ID())) {
nsTArray<uint64_t> relationCandidateIds;
for (const auto& data : kRelationTypeAtoms) {
if (data.mAtom != nsGkAtoms::_for || data.mValidTag != nsGkAtoms::label) {
continue;
}
if (auto labelIds = accRelMapEntry.Data().Lookup(&data)) {
RemoteAccIterator iter(*labelIds, Document());
nsTextEquivUtils::GetTextEquivFromAccIterable(this, &iter, aName);
aName.CompressWhitespace();
}
}
aName.CompressWhitespace();
}
if (!aName.IsEmpty()) {
return eNameFromRelations;
}
ArrayAccIterator iter(LegendsOrCaptions());
nsTextEquivUtils::GetTextEquivFromAccIterable(this, &iter, aName);
aName.CompressWhitespace();
if (!aName.IsEmpty()) {
return eNameFromRelations;
}
nsTextEquivUtils::GetNameFromSubtree(this, aName);
if (!aName.IsEmpty()) {
return eNameFromSubtree;
}
if (mCachedFields->GetAttribute(CacheKey::Tooltip, aName)) {
VERIFY_CACHE(CacheDomain::NameAndDescription);
return eNameFromTooltip;
}
if (mCachedFields->GetAttribute(CacheKey::CssAltContent, aName)) {
VERIFY_CACHE(CacheDomain::NameAndDescription);
return eNameOK;
}
MOZ_ASSERT(aName.IsEmpty());
aName.SetIsVoid(true);
return eNameOK;
}
EDescriptionValueFlag RemoteAccessible::Description(
nsString& aDescription) const {
if (RequestDomainsIfInactive(CacheDomain::NameAndDescription)) {
return eDescriptionOK;
}
EDescriptionValueFlag descFlag = eDescriptionOK;
if (mCachedFields) {
auto cachedDescriptionFlag =
mCachedFields->GetAttribute<int32_t>(CacheKey::DescriptionValueFlag);
if (cachedDescriptionFlag) {
descFlag = static_cast<EDescriptionValueFlag>(*cachedDescriptionFlag);
}
mCachedFields->GetAttribute(CacheKey::Description, aDescription);
VERIFY_CACHE(CacheDomain::NameAndDescription);
}
return descFlag;
}
void RemoteAccessible::Value(nsString& aValue) const {
if (RequestDomainsIfInactive(
CacheDomain::Value | // CurValue, etc.
CacheDomain::Actions | // ActionAncestor (HasPrimaryAction)
CacheDomain::State | // GetSelectedItem
CacheDomain::Viewport // GetSelectedItem
)) {
return;
}
if (mCachedFields) {
if (mCachedFields->HasAttribute(CacheKey::TextValue)) {
mCachedFields->GetAttribute(CacheKey::TextValue, aValue);
VERIFY_CACHE(CacheDomain::Value);
return;
}
if (HasNumericValue()) {
double checkValue = CurValue();
if (!std::isnan(checkValue)) {
aValue.AppendFloat(checkValue);
}
return;
}
const nsRoleMapEntry* roleMapEntry = ARIARoleMap();
// Value of textbox is a textified subtree.
if ((roleMapEntry && roleMapEntry->Is(nsGkAtoms::textbox)) ||
(IsGeneric() && IsEditableRoot())) {
nsTextEquivUtils::GetTextEquivFromSubtree(this, aValue);
return;
}
if (IsCombobox()) {
// For combo boxes, rely on selection state to determine the value.
const Accessible* option =
const_cast<RemoteAccessible*>(this)->GetSelectedItem(0);
if (option) {
option->Name(aValue);
} else {
// If no selected item, determine the value from descendant elements.
nsTextEquivUtils::GetTextEquivFromSubtree(this, aValue);
}
return;
}
if (IsTextLeaf() || IsImage()) {
if (const Accessible* actionAcc = ActionAncestor()) {
if (const_cast<Accessible*>(actionAcc)->State() & states::LINKED) {
// Text and image descendants of links expose the link URL as the
// value.
return actionAcc->Value(aValue);
}
}
}
}
}
double RemoteAccessible::CurValue() const {
if (RequestDomainsIfInactive(CacheDomain::Value)) {
return UnspecifiedNaN<double>();
}
if (mCachedFields) {
if (auto value =
mCachedFields->GetAttribute<double>(CacheKey::NumericValue)) {
VERIFY_CACHE(CacheDomain::Value);
return *value;
}
}
return UnspecifiedNaN<double>();
}
double RemoteAccessible::MinValue() const {
if (RequestDomainsIfInactive(CacheDomain::Value)) {
return UnspecifiedNaN<double>();
}
if (mCachedFields) {
if (auto min = mCachedFields->GetAttribute<double>(CacheKey::MinValue)) {
VERIFY_CACHE(CacheDomain::Value);
return *min;
}
}
return UnspecifiedNaN<double>();
}
double RemoteAccessible::MaxValue() const {
if (RequestDomainsIfInactive(CacheDomain::Value)) {
return UnspecifiedNaN<double>();
}
if (mCachedFields) {
if (auto max = mCachedFields->GetAttribute<double>(CacheKey::MaxValue)) {
VERIFY_CACHE(CacheDomain::Value);
return *max;
}
}
return UnspecifiedNaN<double>();
}
double RemoteAccessible::Step() const {
if (RequestDomainsIfInactive(CacheDomain::Value)) {
return UnspecifiedNaN<double>();
}
if (mCachedFields) {
if (auto step = mCachedFields->GetAttribute<double>(CacheKey::Step)) {
VERIFY_CACHE(CacheDomain::Value);
return *step;
}
}
return UnspecifiedNaN<double>();
}
bool RemoteAccessible::SetCurValue(double aValue) {
if (RequestDomainsIfInactive(CacheDomain::Value | // MinValue, MaxValue
CacheDomain::State | // State
CacheDomain::Viewport // State
)) {
return false;
}
if (!HasNumericValue() || IsProgress()) {
return false;
}
const uint32_t kValueCannotChange = states::READONLY | states::UNAVAILABLE;
if (State() & kValueCannotChange) {
return false;
}
double checkValue = MinValue();
if (!std::isnan(checkValue) && aValue < checkValue) {
return false;
}
checkValue = MaxValue();
if (!std::isnan(checkValue) && aValue > checkValue) {
return false;
}
(void)mDoc->SendSetCurValue(mID, aValue);
return true;
}
bool RemoteAccessible::ContainsPoint(int32_t aX, int32_t aY) {
ASSERT_DOMAINS_ACTIVE(CacheDomain::TextBounds | // GetCachedTextLines
kNecessaryBoundsDomains);
if (!BoundsWithOffset(Nothing(), true).Contains(aX, aY)) {
return false;
}
if (!IsTextLeaf()) {
if (IsImage() || IsImageMap() || !HasChildren() ||
RefPtr{DisplayStyle()} != nsGkAtoms::inlinevalue) {
// This isn't an inline element that might contain text, so we don't need
// to walk lines. It's enough that our rect contains the point.
return true;
}
// Non-image inline elements with children can wrap across lines just like
// text leaves; see below.
// Walk the children, which will walk the lines of text in any text leaves.
uint32_t count = ChildCount();
for (uint32_t c = 0; c < count; ++c) {
RemoteAccessible* child = RemoteChildAt(c);
if (child->Role() == roles::TEXT_CONTAINER && child->IsClipped()) {
// There is a clipped child. This is a candidate for fuzzy hit testing.
// See RemoteAccessible::DoFuzzyHittesting.
return true;
}
if (child->ContainsPoint(aX, aY)) {
return true;
}
}
// None of our descendants contain the point, so nor do we.
return false;
}
// This is a text leaf. The text might wrap across lines, which means our
// rect might cover a wider area than the actual text. For example, if the
// text begins in the middle of the first line and wraps on to the second,
// the rect will cover the start of the first line and the end of the second.
auto lines = GetCachedTextLines();
if (!lines) {
// This means the text is empty or occupies a single line (but does not
// begin the line). In that case, the Bounds check above is sufficient,
// since there's only one rect.
return true;
}
uint32_t length = lines->Length();
MOZ_ASSERT(length > 0,
"Line starts shouldn't be in cache if there aren't any");
if (length == 0 || (length == 1 && (*lines)[0] == 0)) {
// This means the text begins and occupies a single line. Again, the Bounds
// check above is sufficient.
return true;
}
// Walk the lines of the text. Even if this text doesn't start at the
// beginning of a line (i.e. lines[0] > 0), we always want to consider its
// first line.
int32_t lineStart = 0;
for (uint32_t index = 0; index <= length; ++index) {
int32_t lineEnd;
if (index < length) {
int32_t nextLineStart = (*lines)[index];
if (nextLineStart == 0) {
// This Accessible starts at the beginning of a line. Here, we always
// treat 0 as the first line start anyway.
MOZ_ASSERT(index == 0);
continue;
}
lineEnd = nextLineStart - 1;
} else {
// This is the last line.
lineEnd = static_cast<int32_t>(nsAccUtils::TextLength(this)) - 1;
}
MOZ_ASSERT(lineEnd >= lineStart);
nsRect lineRect = GetCachedCharRect(lineStart);
if (lineEnd > lineStart) {
nsRect lineEndRect = GetCachedCharRect(lineEnd);
if (lineEndRect.IsEmpty() && lineEnd - 1 > lineStart) {
// The line feed character at the end of a line in pre-formatted text
// doesn't have a useful rect. Use the previous character. Otherwise,
// lineRect won't span the line of text and we'll miss characters.
lineEndRect = GetCachedCharRect(lineEnd - 1);
}
lineRect.UnionRect(lineRect, lineEndRect);
}
if (BoundsWithOffset(Some(lineRect), true).Contains(aX, aY)) {
return true;
}
lineStart = lineEnd + 1;
}
return false;
}
RemoteAccessible* RemoteAccessible::DoFuzzyHittesting() {
ASSERT_DOMAINS_ACTIVE(CacheDomain::Bounds);
uint32_t childCount = ChildCount();
if (!childCount) {
return nullptr;
}
// Check if this match has a clipped child.
// This usually indicates invisible text, and we're
// interested in returning the inner text content
// even if it doesn't contain the point we're hittesting.
RemoteAccessible* clippedContainer = nullptr;
for (uint32_t i = 0; i < childCount; i++) {
RemoteAccessible* child = RemoteChildAt(i);
if (child->Role() == roles::TEXT_CONTAINER) {
if (child->IsClipped()) {
clippedContainer = child;
break;
}
}
}
// If we found a clipped container, descend it in search of
// meaningful text leaves. Ignore non-text-leaf/text-container
// siblings.
RemoteAccessible* container = clippedContainer;
while (container) {
RemoteAccessible* textLeaf = nullptr;
bool continueSearch = false;
childCount = container->ChildCount();
for (uint32_t i = 0; i < childCount; i++) {
RemoteAccessible* child = container->RemoteChildAt(i);
if (child->Role() == roles::TEXT_CONTAINER) {
container = child;
continueSearch = true;
break;
}
if (child->IsTextLeaf()) {
textLeaf = child;
// Don't break here -- it's possible a text container
// exists as another sibling, and we should descend as
// deep as possible.
}
}
if (textLeaf) {
return textLeaf;
}
if (!continueSearch) {
// We didn't find anything useful in this set of siblings.
// Don't keep searching
break;
}
}
return nullptr;
}
Accessible* RemoteAccessible::ChildAtPoint(
int32_t aX, int32_t aY, LocalAccessible::EWhichChildAtPoint aWhichChild) {
if (RequestDomainsIfInactive(
kNecessaryBoundsDomains |
CacheDomain::TextBounds // GetCachedTextLines (via ContainsPoint)
)) {
return nullptr;
}
// Elements that are partially on-screen should have their bounds masked by
// their containing scroll area so hittesting yields results that are
// consistent with the content's visual representation. Pass this value to
// bounds calculation functions to indicate that we're hittesting.
const bool hitTesting = true;
if (IsOuterDoc() && aWhichChild == EWhichChildAtPoint::DirectChild) {
// This is an iframe, which is as deep as the viewport cache goes. The
// caller wants a direct child, which can only be the embedded document.
if (BoundsWithOffset(Nothing(), hitTesting).Contains(aX, aY)) {
return RemoteFirstChild();
}
return nullptr;
}
RemoteAccessible* lastMatch = nullptr;
// If `this` is a document, use its viewport cache instead of
// the cache of its parent document.
if (DocAccessibleParent* doc = IsDoc() ? AsDoc() : mDoc) {
if (!doc->mCachedFields) {
// A client call might arrive after we've constructed doc but before we
// get a cache push for it.
return nullptr;
}
if (auto maybeViewportCache =
doc->mCachedFields->GetAttribute<nsTArray<uint64_t>>(
CacheKey::Viewport)) {
// The retrieved viewport cache contains acc IDs in hittesting order.
// That is, items earlier in the list have z-indexes that are larger than
// those later in the list. If you were to build a tree by z-index, where
// chilren have larger z indices than their parents, iterating this list
// is essentially a postorder tree traversal.
const nsTArray<uint64_t>& viewportCache = *maybeViewportCache;
for (auto id : viewportCache) {
RemoteAccessible* acc = doc->GetAccessible(id);
if (!acc) {
// This can happen if the acc died in between
// pushing the viewport cache and doing this hittest
continue;
}
if (acc->IsOuterDoc() &&
aWhichChild == EWhichChildAtPoint::DeepestChild &&
acc->BoundsWithOffset(Nothing(), hitTesting).Contains(aX, aY)) {
// acc is an iframe, which is as deep as the viewport cache goes. This
// iframe contains the requested point.
RemoteAccessible* innerDoc = acc->RemoteFirstChild();
if (innerDoc) {
MOZ_ASSERT(innerDoc->IsDoc());
// Search the embedded document's viewport cache so we return the
// deepest descendant in that embedded document.
Accessible* deepestAcc = innerDoc->ChildAtPoint(
aX, aY, EWhichChildAtPoint::DeepestChild);
MOZ_ASSERT(!deepestAcc || deepestAcc->IsRemote());
lastMatch = deepestAcc ? deepestAcc->AsRemote() : nullptr;
break;
}
// If there is no embedded document, the iframe itself is the deepest
// descendant.
lastMatch = acc;
break;
}
if (acc == this) {
MOZ_ASSERT(!acc->IsOuterDoc());
// Even though we're searching from the doc's cache
// this call shouldn't pass the boundary defined by
// the acc this call originated on. If we hit `this`,
// return our most recent match.
if (!lastMatch &&
BoundsWithOffset(Nothing(), hitTesting).Contains(aX, aY)) {
// If we haven't found a match, but `this` contains the point we're
// looking for, set it as our temp last match so we can
// (potentially) do fuzzy hittesting on it below.
lastMatch = acc;
}
break;
}
if (acc->ContainsPoint(aX, aY)) {
// Because our rects are in hittesting order, the
// first match we encounter is guaranteed to be the
// deepest match.
lastMatch = acc;
break;
}
}
if (lastMatch) {
RemoteAccessible* fuzzyMatch = lastMatch->DoFuzzyHittesting();
lastMatch = fuzzyMatch ? fuzzyMatch : lastMatch;
}
}
}
if (aWhichChild == EWhichChildAtPoint::DirectChild && lastMatch) {
// lastMatch is the deepest match. Walk up to the direct child of this.
RemoteAccessible* parent = lastMatch->RemoteParent();
for (;;) {
if (parent == this) {
break;
}
if (!parent || parent->IsDoc()) {
// `this` is not an ancestor of lastMatch. Ignore lastMatch.
lastMatch = nullptr;
break;
}
lastMatch = parent;
parent = parent->RemoteParent();
}
} else if (aWhichChild == EWhichChildAtPoint::DeepestChild && lastMatch &&
!IsDoc() && !IsAncestorOf(lastMatch)) {
// If we end up with a match that is not in the ancestor chain
// of the accessible this call originated on, we should ignore it.
// This can happen when the aX, aY given are outside `this`.
lastMatch = nullptr;
}
if (!lastMatch && BoundsWithOffset(Nothing(), hitTesting).Contains(aX, aY)) {
// Even though the hit target isn't inside `this`, the point is still
// within our bounds, so fall back to `this`.
return this;
}
return lastMatch;
}
Maybe<nsRect> RemoteAccessible::RetrieveCachedBounds() const {
if (!mCachedFields) {
return Nothing();
}
ASSERT_DOMAINS_ACTIVE(CacheDomain::Bounds);
Maybe<const UniquePtr<nsRect>&> maybeRect =
mCachedFields->GetAttribute<UniquePtr<nsRect>>(
CacheKey::ParentRelativeBounds);
if (maybeRect) {
return Some(*(*maybeRect));
}
return Nothing();
}
void RemoteAccessible::ApplyCrossDocOffset(nsRect& aBounds) const {
if (!IsDoc()) {
// We should only apply cross-doc offsets to documents. If we're anything
// else, return early here.
return;
}
RemoteAccessible* parentAcc = RemoteParent();
if (!parentAcc || !parentAcc->IsOuterDoc()) {
return;
}
ASSERT_DOMAINS_ACTIVE(CacheDomain::Bounds);
Maybe<const nsTArray<int32_t>&> maybeOffset =
parentAcc->mCachedFields->GetAttribute<nsTArray<int32_t>>(
CacheKey::CrossDocOffset);
if (!maybeOffset) {
return;
}
MOZ_ASSERT(maybeOffset->Length() == 2);
const nsTArray<int32_t>& offset = *maybeOffset;
// Our retrieved value is in app units, so we don't need to do any
// unit conversion here.
aBounds.MoveBy(offset[0], offset[1]);
}
bool RemoteAccessible::ApplyTransform(nsRect& aCumulativeBounds) const {
ASSERT_DOMAINS_ACTIVE(CacheDomain::TransformMatrix);
// First, attempt to retrieve the transform from the cache.
Maybe<const UniquePtr<gfx::Matrix4x4>&> maybeTransform =
mCachedFields->GetAttribute<UniquePtr<gfx::Matrix4x4>>(
CacheKey::TransformMatrix);
if (!maybeTransform) {
return false;
}
auto mtxInPixels = gfx::Matrix4x4Typed<CSSPixel, CSSPixel>::FromUnknownMatrix(
*(*maybeTransform));
// Our matrix is in CSS Pixels, so we need our rect to be in CSS
// Pixels too. Convert before applying.
auto boundsInPixels = CSSRect::FromAppUnits(aCumulativeBounds);
boundsInPixels = mtxInPixels.TransformBounds(boundsInPixels);
aCumulativeBounds = CSSRect::ToAppUnits(boundsInPixels);
return true;
}
bool RemoteAccessible::ApplyScrollOffset(nsRect& aBounds,
float aResolution) const {
ASSERT_DOMAINS_ACTIVE(CacheDomain::ScrollPosition);
Maybe<const nsTArray<int32_t>&> maybeScrollPosition =
mCachedFields->GetAttribute<nsTArray<int32_t>>(CacheKey::ScrollPosition);
if (!maybeScrollPosition || maybeScrollPosition->Length() != 2) {
return false;
}
// Our retrieved value is in app units, so we don't need to do any
// unit conversion here.
const nsTArray<int32_t>& scrollPosition = *maybeScrollPosition;
// Scroll position is an inverse representation of scroll offset (since the
// further the scroll bar moves down the page, the further the page content
// moves up/closer to the origin).
nsPoint scrollOffset(-scrollPosition[0], -scrollPosition[1]);
aBounds.MoveBy(scrollOffset.x * aResolution * aResolution,
scrollOffset.y * aResolution * aResolution);
// Return true here even if the scroll offset was 0,0 because the RV is used
// as a scroll container indicator. Non-scroll containers won't have cached
// scroll position.
return true;
}
void RemoteAccessible::ApplyVisualViewportOffset(nsRect& aBounds) const {
ASSERT_DOMAINS_ACTIVE(CacheDomain::APZ);
MOZ_ASSERT(IsDoc(), "Attempting to get visual viewport data from non-doc?");
Maybe<const nsTArray<int32_t>&> maybeViewportOffset =
mCachedFields->GetAttribute<nsTArray<int32_t>>(
CacheKey::VisualViewportOffset);
if (!maybeViewportOffset || maybeViewportOffset->Length() != 2) {
return;
}
// Our retrieved value is in app units, so we don't need to do any
// unit conversion here.
const nsTArray<int32_t>& viewportOffset = *maybeViewportOffset;
// Like scroll position, this offset is an inverse representation: the
// further the visual viewport moves, the further the page content
// moves up/closer to the origin
aBounds.MoveBy(-viewportOffset[0], -viewportOffset[1]);
}
nsRect RemoteAccessible::BoundsInAppUnits() const {
if (RequestDomainsIfInactive(kNecessaryBoundsDomains)) {
return {};
}
if (dom::CanonicalBrowsingContext* cbc = mDoc->GetBrowsingContext()->Top()) {
if (dom::BrowserParent* bp = cbc->GetBrowserParent()) {
DocAccessibleParent* topDoc = bp->GetTopLevelDocAccessible();
if (topDoc && topDoc->mCachedFields) {
auto appUnitsPerDevPixel = topDoc->mCachedFields->GetAttribute<int32_t>(
CacheKey::AppUnitsPerDevPixel);
MOZ_ASSERT(appUnitsPerDevPixel);
return LayoutDeviceIntRect::ToAppUnits(Bounds(), *appUnitsPerDevPixel);
}
}
}
return LayoutDeviceIntRect::ToAppUnits(Bounds(), AppUnitsPerCSSPixel());
}
bool RemoteAccessible::IsFixedPos() const {
ASSERT_DOMAINS_ACTIVE(CacheDomain::Style);
MOZ_ASSERT(mCachedFields);
if (auto maybePosition =
mCachedFields->GetAttribute<RefPtr<nsAtom>>(CacheKey::CssPosition)) {
return *maybePosition == nsGkAtoms::fixed;
}
return false;
}
bool RemoteAccessible::IsOverflowHidden() const {
ASSERT_DOMAINS_ACTIVE(CacheDomain::Style);
MOZ_ASSERT(mCachedFields);
if (auto maybeOverflow =
mCachedFields->GetAttribute<RefPtr<nsAtom>>(CacheKey::CSSOverflow)) {
return *maybeOverflow == nsGkAtoms::hidden;
}
return false;
}
bool RemoteAccessible::IsClipped() const {
ASSERT_DOMAINS_ACTIVE(CacheDomain::Bounds);
MOZ_ASSERT(mCachedFields);
if (mCachedFields->GetAttribute<bool>(CacheKey::IsClipped)) {
return true;
}
return false;
}
LayoutDeviceIntRect RemoteAccessible::BoundsWithOffset(
Maybe<nsRect> aOffset, bool aBoundsAreForHittesting) const {
if (RequestDomainsIfInactive(kNecessaryBoundsDomains)) {
return LayoutDeviceIntRect{};
}
Maybe<nsRect> maybeBounds = RetrieveCachedBounds();
if (maybeBounds) {
nsRect bounds = *maybeBounds;
// maybeBounds is parent-relative. However, the transform matrix we cache
// (if any) is meant to operate on self-relative rects. Therefore, make
// bounds self-relative until after we transform.
bounds.MoveTo(0, 0);
const DocAccessibleParent* topDoc = IsDoc() ? AsDoc() : nullptr;
if (aOffset.isSome()) {
// The rect we've passed in is in app units, so no conversion needed.
nsRect internalRect = *aOffset;
bounds.SetRectX(bounds.x + internalRect.x, internalRect.width);
bounds.SetRectY(bounds.y + internalRect.y, internalRect.height);
}
(void)ApplyTransform(bounds);
// Now apply the parent-relative offset.
bounds.MoveBy(maybeBounds->TopLeft());
ApplyCrossDocOffset(bounds);
Maybe<float> res =
mDoc->mCachedFields->GetAttribute<float>(CacheKey::Resolution);
MOZ_ASSERT(res, "No cached document resolution found.");
const float resolution = res.valueOr(1.0f);
LayoutDeviceIntRect devPxBounds;
const Accessible* acc = Parent();
bool encounteredFixedContainer = IsFixedPos();
while (acc && acc->IsRemote()) {
// Return early if we're hit testing and our cumulative bounds are empty,
// since walking the ancestor chain won't produce any hits.
if (aBoundsAreForHittesting && bounds.IsEmpty()) {
return LayoutDeviceIntRect{};
}
RemoteAccessible* remoteAcc = const_cast<Accessible*>(acc)->AsRemote();
if (Maybe<nsRect> maybeRemoteBounds = remoteAcc->RetrieveCachedBounds()) {
nsRect remoteBounds = *maybeRemoteBounds;
// We need to take into account a non-1 resolution set on the
// presshell. This happens with async pinch zooming, among other
// things. We can't reliably query this value in the parent process,
// so we retrieve it from the document's cache.
if (remoteAcc->IsDoc()) {
// Apply our visual viewport offset, which is non-zero when
// pinch zoom has been applied. Do this before we scale by
// resolution as this offset is unscaled.
remoteAcc->ApplyVisualViewportOffset(bounds);
// Apply the document's resolution to the bounds we've gathered
// thus far. We do this before applying the document's offset
// because document accs should not have their bounds scaled by
// their own resolution. They should be scaled by the resolution
// of their containing document (if any).
Maybe<float> res =
remoteAcc->AsDoc()->mCachedFields->GetAttribute<float>(
CacheKey::Resolution);
MOZ_ASSERT(res, "No cached document resolution found.");
bounds.ScaleRoundOut(res.valueOr(1.0f));
topDoc = remoteAcc->AsDoc();
}
// We don't account for the document offset of iframes when
// computing parent-relative bounds. Instead, we store this value
// separately on all iframes and apply it here. See the comments in
// LocalAccessible::BundleFieldsForCache where we set the
// nsGkAtoms::crossorigin attribute.
remoteAcc->ApplyCrossDocOffset(remoteBounds);
if (!encounteredFixedContainer) {
// Apply scroll offset, if applicable. Only the contents of an
// element are affected by its scroll offset, which is why this call
// happens in this loop instead of both inside and outside of
// the loop (like ApplyTransform).
// Never apply scroll offsets past a fixed container.
const bool hasScrollArea =
remoteAcc->ApplyScrollOffset(bounds, resolution);
// If we are hit testing and the Accessible has a scroll area, ensure
// that the bounds we've calculated so far are constrained to the
// bounds of the scroll area. Without this, we'll "hit" the off-screen
// portions of accs that are are partially (but not fully) within the
// scroll area. This is also a problem for accs with overflow:hidden;
if (aBoundsAreForHittesting &&
(hasScrollArea || remoteAcc->IsOverflowHidden())) {
nsRect selfRelativeVisibleBounds(0, 0, remoteBounds.width,
remoteBounds.height);
bounds = bounds.SafeIntersect(selfRelativeVisibleBounds);
}
}
if (remoteAcc->IsDoc()) {
// Fixed elements are document relative, so if we've hit a
// document we're now subject to that document's styling
// (including scroll offsets that operate on it).
// This ordering is important, we don't want to apply scroll
// offsets on this doc's content.
encounteredFixedContainer = false;
}
if (!encounteredFixedContainer) {
// The transform matrix we cache (if any) is meant to operate on
// self-relative rects. Therefore, we must apply the transform before
// we make bounds parent-relative.
(void)remoteAcc->ApplyTransform(bounds);
// Regardless of whether this is a doc, we should offset `bounds`
// by the bounds retrieved here. This is how we build screen
// coordinates from relative coordinates.
bounds.MoveBy(remoteBounds.X(), remoteBounds.Y());
}
if (remoteAcc->IsFixedPos()) {
encounteredFixedContainer = true;
}
// we can't just break here if we're scroll suppressed because we still
// need to find the top doc.
}
acc = acc->Parent();
}
MOZ_ASSERT(topDoc);
if (topDoc) {
// We use the top documents app-units-per-dev-pixel even though
// theoretically nested docs can have different values. Practically,
// that isn't likely since we only offer zoom controls for the top
// document and all subdocuments inherit from it.
auto appUnitsPerDevPixel = topDoc->mCachedFields->GetAttribute<int32_t>(
CacheKey::AppUnitsPerDevPixel);
MOZ_ASSERT(appUnitsPerDevPixel);
if (appUnitsPerDevPixel) {
// Convert our existing `bounds` rect from app units to dev pixels
devPxBounds = LayoutDeviceIntRect::FromAppUnitsToNearest(
bounds, *appUnitsPerDevPixel);
}
}
#if !defined(ANDROID)
// This block is not thread safe because it queries a LocalAccessible.
// It is also not needed in Android since the only local accessible is
// the outer doc browser that has an offset of 0.
// acc could be null if the OuterDocAccessible died before the top level
// DocAccessibleParent.
if (LocalAccessible* localAcc =
acc ? const_cast<Accessible*>(acc)->AsLocal() : nullptr) {
// LocalAccessible::Bounds returns screen-relative bounds in
// dev pixels.
LayoutDeviceIntRect localBounds = localAcc->Bounds();
// The root document will always have an APZ resolution of 1,
// so we don't factor in its scale here. We also don't scale
// by GetFullZoom because LocalAccessible::Bounds already does
// that.
devPxBounds.MoveBy(localBounds.X(), localBounds.Y());
}
#endif
return devPxBounds;
}
return LayoutDeviceIntRect();
}
LayoutDeviceIntRect RemoteAccessible::Bounds() const {
if (RequestDomainsIfInactive(kNecessaryBoundsDomains)) {
return {};
}
return BoundsWithOffset(Nothing());
}
Relation RemoteAccessible::RelationByType(RelationType aType) const {
if (RequestDomainsIfInactive(
CacheDomain::Relations | // relations info, DOMName attribute
CacheDomain::Value | // Value
CacheDomain::DOMNodeIDAndClass | // DOMNodeID
CacheDomain::GroupInfo // GetOrCreateGroupInfo
)) {
return Relation();
}
// We are able to handle some relations completely in the
// parent process, without the help of the cache. Those
// relations are enumerated here. Other relations, whose
// types are stored in kRelationTypeAtoms, are processed
// below using the cache.
if (aType == RelationType::CONTAINING_TAB_PANE) {
if (dom::CanonicalBrowsingContext* cbc = mDoc->GetBrowsingContext()) {
if (dom::CanonicalBrowsingContext* topCbc = cbc->Top()) {
if (dom::BrowserParent* bp = topCbc->GetBrowserParent()) {
return Relation(bp->GetTopLevelDocAccessible());
}
}
}
return Relation();
}
if (aType == RelationType::LINKS_TO && Role() == roles::LINK) {
Pivot p = Pivot(mDoc);
nsString href;
Value(href);
int32_t i = href.FindChar('#');
int32_t len = static_cast<int32_t>(href.Length());
if (i != -1 && i < (len - 1)) {
nsDependentSubstring anchorName = Substring(href, i + 1, len);
MustPruneSameDocRule rule;
Accessible* nameMatch = nullptr;
for (Accessible* match = p.Next(mDoc, rule); match;
match = p.Next(match, rule)) {
nsString currID;
match->DOMNodeID(currID);
MOZ_ASSERT(match->IsRemote());
if (anchorName.Equals(currID)) {
return Relation(match->AsRemote());
}
if (!nameMatch) {
nsString currName = match->AsRemote()->GetCachedHTMLNameAttribute();
if (match->TagName() == nsGkAtoms::a && anchorName.Equals(currName)) {
// If we find an element with a matching ID, we should return
// that, but if we don't we should return the first anchor with
// a matching name. To avoid doing two traversals, store the first
// name match here.
nameMatch = match;
}
}
}
return nameMatch ? Relation(nameMatch->AsRemote()) : Relation();
}
return Relation();
}
// Handle ARIA tree, treegrid parent/child relations. Each of these cases
// relies on cached group info. To find the parent of an accessible, use the
// unified conceptual parent.
if (aType == RelationType::NODE_CHILD_OF) {
const nsRoleMapEntry* roleMapEntry = ARIARoleMap();
if (roleMapEntry && (roleMapEntry->role == roles::OUTLINEITEM ||
roleMapEntry->role == roles::LISTITEM ||
roleMapEntry->role == roles::ROW)) {
if (const AccGroupInfo* groupInfo =
const_cast<RemoteAccessible*>(this)->GetOrCreateGroupInfo()) {
return Relation(groupInfo->ConceptualParent());
}
}
return Relation();
}
// To find the children of a parent, provide an iterator through its items.
if (aType == RelationType::NODE_PARENT_OF) {
const nsRoleMapEntry* roleMapEntry = ARIARoleMap();
if (roleMapEntry && (roleMapEntry->role == roles::OUTLINEITEM ||
roleMapEntry->role == roles::LISTITEM ||
roleMapEntry->role == roles::ROW ||
roleMapEntry->role == roles::OUTLINE ||
roleMapEntry->role == roles::LIST ||
roleMapEntry->role == roles::TREE_TABLE)) {
return Relation(new ItemIterator(this));
}
return Relation();
}
if (aType == RelationType::MEMBER_OF) {
Relation rel = Relation();
// HTML radio buttons with cached names should be grouped.
if (IsHTMLRadioButton()) {
nsString name = GetCachedHTMLNameAttribute();
if (name.IsEmpty()) {
return rel;
}
RemoteAccessible* ancestor = RemoteParent();
while (ancestor && ancestor->Role() != roles::FORM && ancestor != mDoc) {
ancestor = ancestor->RemoteParent();
}
if (ancestor) {
// Sometimes we end up with an unparented acc here, potentially
// because the acc is being moved. See bug 1807639.
// Pivot expects to be created with a non-null mRoot.
Pivot p = Pivot(ancestor);
PivotRadioNameRule rule(name);
Accessible* match = p.Next(ancestor, rule);
while (match) {
rel.AppendTarget(match->AsRemote());
match = p.Next(match, rule);
}
}
return rel;
}
if (IsARIARole(nsGkAtoms::radio)) {
// ARIA radio buttons should be grouped by their radio group
// parent, if one exists.
RemoteAccessible* currParent = RemoteParent();
while (currParent && currParent->Role() != roles::RADIO_GROUP) {
currParent = currParent->RemoteParent();
}
if (currParent && currParent->Role() == roles::RADIO_GROUP) {
// If we found a radiogroup parent, search for all
// roles::RADIOBUTTON children and add them to our relation.
// This search will include the radio button this method
// was called from, which is expected.
Pivot p = Pivot(currParent);
PivotRoleRule rule(roles::RADIOBUTTON);
Accessible* match = p.Next(currParent, rule);
while (match) {
MOZ_ASSERT(match->IsRemote(),
"We should only be traversing the remote tree.");
rel.AppendTarget(match->AsRemote());
match = p.Next(match, rule);
}
}
}
// By webkit's standard, aria radio buttons do not get grouped
// if they lack a group parent, so we return an empty
// relation here if the above check fails.
return rel;
}
Relation rel;
if (!mCachedFields) {
return rel;
}
auto GetDirectRelationFromCache =
[](const RemoteAccessible* aAcc,
RelationType aRelType) -> Maybe<const nsTArray<uint64_t>&> {
for (const auto& data : kRelationTypeAtoms) {
if (data.mType != aRelType ||
(data.mValidTag && aAcc->TagName() != data.mValidTag)) {
continue;
}
if (auto maybeIds = aAcc->mCachedFields->GetAttribute<nsTArray<uint64_t>>(
data.mAtom)) {
if (data.mAtom == nsGkAtoms::target) {
if (!maybeIds->IsEmpty() &&
!nsAccUtils::IsValidDetailsTargetForAnchor(
aAcc->mDoc->GetAccessible(maybeIds->ElementAt(0)), aAcc)) {
continue;
}
}
// Relations can have several cached attributes in order of precedence,
// if one is found we use it.
return maybeIds;
}
}
return Nothing();
};
if (auto maybeIds = GetDirectRelationFromCache(this, aType)) {
rel.AppendIter(new RemoteAccIterator(*maybeIds, Document()));
}
if (auto accRelMapEntry = mDoc->mReverseRelations.Lookup(ID())) {
// A list of candidate IDs that might have a relation of type aType
// pointing to us. We keep a list so we don't evaluate or add the same
// target more than once.
nsTArray<uint64_t> relationCandidateIds;
for (const auto& data : kRelationTypeAtoms) {
if (data.mReverseType != aType) {
continue;
}
auto reverseIdsEntry = accRelMapEntry.Data().Lookup(&data);
if (!reverseIdsEntry) {
continue;
}
for (auto id : *reverseIdsEntry) {
if (relationCandidateIds.Contains(id)) {
// If multiple attributes point to the same target, only
// include it once. Our assumption is that there is a 1:1
// relationship between relation and reverse relation *types*.
continue;
}
relationCandidateIds.AppendElement(id);
RemoteAccessible* relatedAcc = mDoc->GetAccessible(id);
if (!relatedAcc) {
continue;
}
if (auto maybeIds =
GetDirectRelationFromCache(relatedAcc, data.mType)) {
if (maybeIds->Contains(ID())) {
// The candidate target has the forward relation type pointing
// to us, so we can add it as a target.
rel.AppendTarget(relatedAcc);
}
}
}
}
}
// We handle these relations here rather than before cached relations because
// the cached relations need to take precedence. For example, a <figure> with
// both aria-labelledby and a <figcaption> must return two LABELLED_BY
// targets: the aria-labelledby and then the <figcaption>.
if (aType == RelationType::LABELLED_BY) {
rel.AppendIter(new ArrayAccIterator(LegendsOrCaptions()));
} else if (aType == RelationType::LABEL_FOR) {
if (RemoteAccessible* labelTarget = LegendOrCaptionFor()) {
rel.AppendTarget(labelTarget);
}
}
return rel;
}
nsTArray<Accessible*> RemoteAccessible::LegendsOrCaptions() const {
nsTArray<Accessible*> children;
auto AddChildWithTag = [this, &children](nsAtom* aTarget) {
uint32_t count = ChildCount();
for (uint32_t c = 0; c < count; ++c) {
Accessible* child = ChildAt(c);
MOZ_ASSERT(child);
if (child->TagName() == aTarget) {
children.AppendElement(child);
}
}
};
auto tag = TagName();
if (tag == nsGkAtoms::figure) {
AddChildWithTag(nsGkAtoms::figcaption);
} else if (tag == nsGkAtoms::fieldset) {
AddChildWithTag(nsGkAtoms::legend);
} else if (tag == nsGkAtoms::table) {
AddChildWithTag(nsGkAtoms::caption);
}
return children;
}
RemoteAccessible* RemoteAccessible::LegendOrCaptionFor() const {
auto tag = TagName();
if (tag == nsGkAtoms::figcaption) {
if (RemoteAccessible* parent = RemoteParent()) {
if (parent->TagName() == nsGkAtoms::figure) {
return parent;
}
}
} else if (tag == nsGkAtoms::legend) {
if (RemoteAccessible* parent = RemoteParent()) {
if (parent->TagName() == nsGkAtoms::fieldset) {
return parent;
}
}
} else if (tag == nsGkAtoms::caption) {
if (RemoteAccessible* parent = RemoteParent()) {
if (parent->TagName() == nsGkAtoms::table) {
return parent;
}
}
}
return nullptr;
}
void RemoteAccessible::AppendTextTo(nsAString& aText, uint32_t aStartOffset,
uint32_t aLength) {
if (IsText()) {
if (RequestDomainsIfInactive(CacheDomain::Text)) {
return;
}
if (mCachedFields) {
if (auto text = mCachedFields->GetAttribute<nsString>(CacheKey::Text)) {
aText.Append(Substring(*text, aStartOffset, aLength));
}
VERIFY_CACHE(CacheDomain::Text);
}
return;
}
if (aStartOffset != 0 || aLength == 0) {
return;
}
if (IsHTMLBr()) {
aText += kForcedNewLineChar;
} else if (RemoteParent() && nsAccUtils::MustPrune(RemoteParent())) {
// Expose the embedded object accessible as imaginary embedded object
// character if its parent hypertext accessible doesn't expose children to
// AT.
aText += kImaginaryEmbeddedObjectChar;
} else {
aText += kEmbeddedObjectChar;
}
}
nsTArray<bool> RemoteAccessible::PreProcessRelations(AccAttributes* aFields) {
if (!DomainsAreActive(CacheDomain::Relations)) {
return {};
}
nsTArray<bool> updateTracker(std::size(kRelationTypeAtoms));
for (auto const& data : kRelationTypeAtoms) {
if (data.mValidTag) {
// The relation we're currently processing only applies to particular
// elements. Check to see if we're one of them.
nsAtom* tag = TagName();
if (!tag) {
// TagName() returns null on an initial cache push -- check aFields
// for a tag name instead.
if (auto maybeTag =
aFields->GetAttribute<RefPtr<nsAtom>>(CacheKey::TagName)) {
tag = *maybeTag;
}
}
MOZ_ASSERT(
tag || IsTextLeaf() || IsDoc(),
"Could not fetch tag via TagName() or from initial cache push!");
if (tag != data.mValidTag) {
// If this rel doesn't apply to us, do no pre-processing. Also,
// note in our updateTracker that we should do no post-processing.
updateTracker.AppendElement(false);
continue;
}
}
nsStaticAtom* const relAtom = data.mAtom;
auto newRelationTargets =
aFields->GetAttribute<nsTArray<uint64_t>>(relAtom);
bool shouldAddNewImplicitRels =
newRelationTargets && newRelationTargets->Length();
// Remove existing implicit relations if we need to perform an update, or
// if we've received a DeleteEntry(). Only do this if mCachedFields is
// initialized. If mCachedFields is not initialized, we still need to
// construct the update array so we correctly handle reverse rels in
// PostProcessRelations.
if ((shouldAddNewImplicitRels ||
aFields->GetAttribute<DeleteEntry>(relAtom)) &&
mCachedFields) {
ASSERT_DOMAINS_ACTIVE(CacheDomain::Relations);
if (auto maybeOldIDs =
mCachedFields->GetAttribute<nsTArray<uint64_t>>(relAtom)) {
for (uint64_t id : *maybeOldIDs) {
// For each target, fetch its reverse relation map
// We need to call `Lookup` here instead of `LookupOrInsert` because
// it's possible the ID we're querying is from an acc that has since
// been Shutdown(), and so has intentionally removed its reverse rels
// from the doc's reverse rel cache.
if (auto reverseRels = Document()->mReverseRelations.Lookup(id)) {
// Then fetch its reverse relation's ID list. This should be safe
// to do via LookupOrInsert because by the time we've gotten here,
// we know the acc and `this` are still alive in the doc. If we hit
// the following assert, we don't have parity on implicit/explicit
// rels and something is wrong.
nsTArray<uint64_t>& reverseRelIDs =
reverseRels->LookupOrInsert(&data);
// There might be other reverse relations stored for this acc, so
// remove our ID instead of deleting the array entirely.
DebugOnly<bool> removed = reverseRelIDs.RemoveElement(ID());
MOZ_ASSERT(removed, "Can't find old reverse relation");
}
}
}
}
updateTracker.AppendElement(shouldAddNewImplicitRels);
}
return updateTracker;
}
void RemoteAccessible::PostProcessRelations(const nsTArray<bool>& aToUpdate) {
if (!DomainsAreActive(CacheDomain::Relations)) {
return;
}
size_t updateCount = aToUpdate.Length();
MOZ_ASSERT(updateCount == std::size(kRelationTypeAtoms),
"Did not note update status for every relation type!");
for (size_t i = 0; i < updateCount; i++) {
if (aToUpdate.ElementAt(i)) {
// Since kRelationTypeAtoms was used to generate aToUpdate, we
// know the ith entry of aToUpdate corresponds to the relation type in
// the ith entry of kRelationTypeAtoms. Fetch the related data here.
auto const& data = kRelationTypeAtoms[i];
const nsTArray<uint64_t>& newIDs =
*mCachedFields->GetAttribute<nsTArray<uint64_t>>(data.mAtom);
for (uint64_t id : newIDs) {
auto& relations = Document()->mReverseRelations.LookupOrInsert(id);
nsTArray<uint64_t>& ids = relations.LookupOrInsert(&data);
ids.AppendElement(ID());
}
}
}
}
void RemoteAccessible::PruneRelationsOnShutdown() {
auto reverseRels = mDoc->mReverseRelations.Lookup(ID());
if (!reverseRels) {
return;
}
for (auto const& data : kRelationTypeAtoms) {
// Fetch the list of targets for this reverse relation
auto reverseTargetList = reverseRels->Lookup(&data);
if (!reverseTargetList) {
continue;
}
for (uint64_t id : *reverseTargetList) {
// For each target, retrieve its corresponding forward relation target
// list
RemoteAccessible* affectedAcc = mDoc->GetAccessible(id);
if (!affectedAcc) {
// It's possible the affect acc also shut down, in which case
// we don't have anything to update.
continue;
}
if (auto forwardTargetList =
affectedAcc->mCachedFields
->GetMutableAttribute<nsTArray<uint64_t>>(data.mAtom)) {
forwardTargetList->RemoveElement(ID());
if (!forwardTargetList->Length()) {
// The ID we removed was the only thing in the list, so remove the
// entry from the cache entirely -- don't leave an empty array.
affectedAcc->mCachedFields->Remove(data.mAtom);
}
}
}
}
// Remove this ID from the document's map of reverse relations.
reverseRels.Remove();
}
uint32_t RemoteAccessible::GetCachedTextLength() {
if (RequestDomainsIfInactive(CacheDomain::Text)) {
return 0;
}
MOZ_ASSERT(!HasChildren());
if (!mCachedFields) {
return 0;
}
VERIFY_CACHE(CacheDomain::Text);
auto text = mCachedFields->GetAttribute<nsString>(CacheKey::Text);
if (!text) {
return 0;
}
return text->Length();
}
Maybe<const nsTArray<int32_t>&> RemoteAccessible::GetCachedTextLines() {
if (RequestDomainsIfInactive(CacheDomain::TextBounds)) {
return Nothing();
}
MOZ_ASSERT(!HasChildren());
if (!mCachedFields) {
return Nothing();
}
VERIFY_CACHE(CacheDomain::TextBounds);
return mCachedFields->GetAttribute<nsTArray<int32_t>>(
CacheKey::TextLineStarts);
}
nsRect RemoteAccessible::GetCachedCharRect(int32_t aOffset) {
ASSERT_DOMAINS_ACTIVE(CacheDomain::TextBounds);
MOZ_ASSERT(IsText());
if (!mCachedFields) {
return nsRect();
}
if (Maybe<const nsTArray<int32_t>&> maybeCharData =
mCachedFields->GetAttribute<nsTArray<int32_t>>(
CacheKey::TextBounds)) {
const nsTArray<int32_t>& charData = *maybeCharData;
const int32_t index = aOffset * kNumbersInRect;
if (index < static_cast<int32_t>(charData.Length())) {
return nsRect(charData[index], charData[index + 1], charData[index + 2],
charData[index + 3]);
}
// It is valid for a client to call this with an offset 1 after the last
// character because of the insertion point at the end of text boxes.
MOZ_ASSERT(index == static_cast<int32_t>(charData.Length()));
}
return nsRect();
}
void RemoteAccessible::DOMNodeID(nsString& aID) const {
if (RequestDomainsIfInactive(CacheDomain::DOMNodeIDAndClass)) {
return;
}
if (mCachedFields) {
mCachedFields->GetAttribute(CacheKey::DOMNodeID, aID);
VERIFY_CACHE(CacheDomain::DOMNodeIDAndClass);
}
}
void RemoteAccessible::DOMNodeClass(nsString& aClass) const {
if (mCachedFields) {
mCachedFields->GetAttribute(CacheKey::DOMNodeClass, aClass);
VERIFY_CACHE(CacheDomain::DOMNodeIDAndClass);
}
}
void RemoteAccessible::ScrollToPoint(uint32_t aScrollType, int32_t aX,
int32_t aY) {
(void)mDoc->SendScrollToPoint(mID, aScrollType, aX, aY);
}
bool RemoteAccessible::IsScrollable() const {
if (RequestDomainsIfInactive(CacheDomain::ScrollPosition)) {
return false;
}
return mCachedFields && mCachedFields->HasAttribute(CacheKey::ScrollPosition);
}
bool RemoteAccessible::IsPopover() const {
return mCachedFields && mCachedFields->HasAttribute(CacheKey::PopupType);
}
bool RemoteAccessible::IsEditable() const {
if (RequestDomainsIfInactive(CacheDomain::State)) {
return false;
}
if (mCachedFields) {
if (auto rawState =
mCachedFields->GetAttribute<uint64_t>(CacheKey::State)) {
VERIFY_CACHE(CacheDomain::State);
return (*rawState & states::EDITABLE) != 0;
}
}
return false;
}
#if !defined(XP_WIN)
void RemoteAccessible::Announce(const nsString& aAnnouncement,
uint16_t aPriority) {
(void)mDoc->SendAnnounce(mID, aAnnouncement, aPriority);
}
#endif // !defined(XP_WIN)
int32_t RemoteAccessible::ValueRegion() const {
MOZ_ASSERT(TagName() == nsGkAtoms::meter,
"Accessing value region on non-meter element?");
if (mCachedFields) {
if (auto region =
mCachedFields->GetAttribute<int32_t>(CacheKey::ValueRegion)) {
return *region;
}
}
// Expose sub-optimal (but not critical) as the value region, as a fallback.
return 0;
}
void RemoteAccessible::ScrollSubstringToPoint(int32_t aStartOffset,
int32_t aEndOffset,
uint32_t aCoordinateType,
int32_t aX, int32_t aY) {
(void)mDoc->SendScrollSubstringToPoint(mID, aStartOffset, aEndOffset,
aCoordinateType, aX, aY);
}
RefPtr<const AccAttributes> RemoteAccessible::GetCachedTextAttributes() {
if (RequestDomainsIfInactive(CacheDomain::Text)) {
return nullptr;
}
MOZ_ASSERT(IsText() || IsHyperText());
if (mCachedFields) {
auto attrs = mCachedFields->GetAttributeRefPtr<AccAttributes>(
CacheKey::TextAttributes);
VERIFY_CACHE(CacheDomain::Text);
return attrs;
}
return nullptr;
}
std::pair<LayoutDeviceIntRect, nsIWidget*> RemoteAccessible::GetCaretRect() {
nsIWidget* widget = nullptr;
LocalAccessible* outerDoc = OuterDocOfRemoteBrowser();
if (outerDoc) {
widget = nsContentUtils::WidgetForContent(outerDoc->GetContent());
}
return {mDoc->GetCachedCaretRect(), widget};
}
already_AddRefed<AccAttributes> RemoteAccessible::DefaultTextAttributes() {
if (RequestDomainsIfInactive(CacheDomain::Text)) {
return nullptr;
}
RefPtr<AccAttributes> result = new AccAttributes();
for (RemoteAccessible* parent = this; parent;
parent = parent->RemoteParent()) {
if (!parent->IsHyperText()) {
// We are only interested in hypertext nodes for defaults, not in text
// leafs or non hypertext nodes.
continue;
}
if (RefPtr<const AccAttributes> parentAttrs =
parent->GetCachedTextAttributes()) {
// Update our text attributes with any parent entries we don't have.
parentAttrs->CopyTo(result, true);
}
}
return result.forget();
}
const AccAttributes* RemoteAccessible::GetCachedARIAAttributes() const {
ASSERT_DOMAINS_ACTIVE(CacheDomain::ARIA);
if (mCachedFields) {
auto attrs = mCachedFields->GetAttributeWeakPtr<AccAttributes>(
CacheKey::ARIAAttributes);
VERIFY_CACHE(CacheDomain::ARIA);
return attrs;
}
return nullptr;
}
nsString RemoteAccessible::GetCachedHTMLNameAttribute() const {
ASSERT_DOMAINS_ACTIVE(CacheDomain::Relations);
if (mCachedFields) {
if (auto maybeName =
mCachedFields->GetAttribute<nsString>(CacheKey::DOMName)) {
return *maybeName;
}
}
return nsString();
}
uint64_t RemoteAccessible::State() {
if (RequestDomainsIfInactive(
CacheDomain::State | // State attributes
CacheDomain::Style | // for Opacity (via ApplyImplicitState)
CacheDomain::Viewport // necessary to build mOnScreenAccessibles
)) {
return 0;
}
uint64_t state = 0;
if (mCachedFields) {
if (auto rawState =
mCachedFields->GetAttribute<uint64_t>(CacheKey::State)) {
VERIFY_CACHE(CacheDomain::State);
state = *rawState;
}
ApplyImplicitState(state);
auto* cbc = mDoc->GetBrowsingContext();
if (cbc && !cbc->IsActive()) {
// If our browsing context is _not_ active, we're in a background tab
// and inherently offscreen.
state |= states::OFFSCREEN;
} else {
// If we're in an active browsing context, there are a few scenarios we
// need to address:
// - We are an iframe document in the visual viewport
// - We are an iframe document out of the visual viewport
// - We are non-iframe content in the visual viewport
// - We are non-iframe content out of the visual viewport
// We assume top level tab docs are on screen if their BC is active, so
// we don't need additional handling for them here.
if (!mDoc->IsTopLevel()) {
// Here we handle iframes and iframe content.
// We use an iframe's outer doc's position in the embedding document's
// viewport to determine if the iframe has been scrolled offscreen.
Accessible* docParent = mDoc->Parent();
// In rare cases, we might not have an outer doc yet. Return if that's
// the case.
if (NS_WARN_IF(!docParent || !docParent->IsRemote())) {
return state;
}
RemoteAccessible* outerDoc = docParent->AsRemote();
DocAccessibleParent* embeddingDocument = outerDoc->Document();
if (embeddingDocument &&
!embeddingDocument->mOnScreenAccessibles.Contains(outerDoc->ID())) {
// Our embedding document's viewport cache doesn't contain the ID of
// our outer doc, so this iframe (and any of its content) is
// offscreen.
state |= states::OFFSCREEN;
} else if (this != mDoc && !mDoc->mOnScreenAccessibles.Contains(ID())) {
// Our embedding document's viewport cache contains the ID of our
// outer doc, but the iframe's viewport cache doesn't contain our ID.
// We are offscreen.
state |= states::OFFSCREEN;
}
} else if (this != mDoc && !mDoc->mOnScreenAccessibles.Contains(ID())) {
// We are top level tab content (but not a top level tab doc).
// If our tab doc's viewport cache doesn't contain our ID, we're
// offscreen.
state |= states::OFFSCREEN;
}
}
}
return state;
}
already_AddRefed<AccAttributes> RemoteAccessible::Attributes() {
RefPtr<AccAttributes> attributes = new AccAttributes();
if (RequestDomainsIfInactive(CacheDomain::ARIA | // GetCachedARIAAttributes
CacheDomain::NameAndDescription | // Name
CacheDomain::Text | // Name
CacheDomain::Value | // Value
CacheDomain::Actions | // Value
CacheDomain::Style | // DisplayStyle
CacheDomain::GroupInfo | // GroupPosition
CacheDomain::State | // State
CacheDomain::Viewport | // State
CacheDomain::Table | // TableIsProbablyForLayout
CacheDomain::DOMNodeIDAndClass | // DOMNodeID
CacheDomain::Relations)) {
return attributes.forget();
}
nsAccessibilityService* accService = GetAccService();
if (!accService) {
// The service can be shut down before RemoteAccessibles. If it is shut
// down, we can't calculate some attributes. We're about to die anyway.
return attributes.forget();
}
if (mCachedFields) {
// We use GetAttribute instead of GetAttributeRefPtr because we need
// nsAtom, not const nsAtom.
if (auto tag =
mCachedFields->GetAttribute<RefPtr<nsAtom>>(CacheKey::TagName)) {
attributes->SetAttribute(nsGkAtoms::tag, *tag);
}
bool hierarchical = false;
uint32_t itemCount = AccGroupInfo::TotalItemCount(this, &hierarchical);
if (itemCount) {
attributes->SetAttribute(nsGkAtoms::child_item_count,
static_cast<int32_t>(itemCount));
}
if (hierarchical) {
attributes->SetAttribute(nsGkAtoms::tree, true);
}
if (auto inputType =
mCachedFields->GetAttribute<RefPtr<nsAtom>>(CacheKey::InputType)) {
attributes->SetAttribute(nsGkAtoms::textInputType, *inputType);
}
if (RefPtr<nsAtom> display = DisplayStyle()) {
attributes->SetAttribute(nsGkAtoms::display, display);
}
if (TableCellAccessible* cell = AsTableCell()) {
TableAccessible* table = cell->Table();
uint32_t row = cell->RowIdx();
uint32_t col = cell->ColIdx();
int32_t cellIdx = table->CellIndexAt(row, col);
if (cellIdx != -1) {
attributes->SetAttribute(nsGkAtoms::tableCellIndex, cellIdx);
}
}
if (bool layoutGuess = TableIsProbablyForLayout()) {
attributes->SetAttribute(nsGkAtoms::layout_guess, layoutGuess);
}
accService->MarkupAttributes(this, attributes);
const nsRoleMapEntry* roleMap = ARIARoleMap();
nsAutoString role;
mCachedFields->GetAttribute(CacheKey::ARIARole, role);
if (role.IsEmpty()) {
if (roleMap && roleMap->roleAtom != nsGkAtoms::_empty) {
// Single, known role.
attributes->SetAttribute(nsGkAtoms::xmlroles, roleMap->roleAtom);
} else if (nsAtom* landmark = LandmarkRole()) {
// Landmark role from markup; e.g. HTML <main>.
attributes->SetAttribute(nsGkAtoms::xmlroles, landmark);
}
} else {
// Unknown role or multiple roles.
attributes->SetAttribute(nsGkAtoms::xmlroles, std::move(role));
}
if (roleMap) {
nsAutoString live;
if (nsAccUtils::GetLiveAttrValue(roleMap->liveAttRule, live)) {
attributes->SetAttribute(nsGkAtoms::aria_live, std::move(live));
}
}
if (auto ariaAttrs = GetCachedARIAAttributes()) {
ariaAttrs->CopyTo(attributes);
}
nsAccUtils::SetLiveContainerAttributes(attributes, this);
nsString id;
DOMNodeID(id);
if (!id.IsEmpty()) {
attributes->SetAttribute(nsGkAtoms::id, std::move(id));
}
nsString className;
DOMNodeClass(className);
if (!className.IsEmpty()) {
attributes->SetAttribute(nsGkAtoms::_class, std::move(className));
}
if (IsImage()) {
nsString src;
mCachedFields->GetAttribute(CacheKey::SrcURL, src);
if (!src.IsEmpty()) {
attributes->SetAttribute(nsGkAtoms::src, std::move(src));
}
}
if (IsTextField()) {
nsString placeholder;
mCachedFields->GetAttribute(CacheKey::HTMLPlaceholder, placeholder);
if (!placeholder.IsEmpty()) {
attributes->SetAttribute(nsGkAtoms::placeholder,
std::move(placeholder));
attributes->Remove(nsGkAtoms::aria_placeholder);
}
}
nsString popupType;
mCachedFields->GetAttribute(CacheKey::PopupType, popupType);
if (!popupType.IsEmpty()) {
attributes->SetAttribute(nsGkAtoms::ispopup, std::move(popupType));
}
if (auto hasActions =
mCachedFields->GetAttribute<bool>(CacheKey::HasActions)) {
attributes->SetAttribute(nsGkAtoms::hasActions, *hasActions);
}
nsString detailsFrom;
if (mCachedFields->HasAttribute(nsGkAtoms::aria_details)) {
detailsFrom.AssignLiteral("aria-details");
} else if (mCachedFields->HasAttribute(nsGkAtoms::commandfor)) {
detailsFrom.AssignLiteral("command-for");
} else if (mCachedFields->HasAttribute(nsGkAtoms::popovertarget)) {
detailsFrom.AssignLiteral("popover-target");
} else if (mCachedFields->HasAttribute(nsGkAtoms::target)) {
detailsFrom.AssignLiteral("css-anchor");
}
if (!detailsFrom.IsEmpty()) {
attributes->SetAttribute(nsGkAtoms::details_from, std::move(detailsFrom));
}
}
nsAutoString name;
if (Name(name) != eNameFromSubtree && !name.IsVoid()) {
attributes->SetAttribute(nsGkAtoms::explicit_name, true);
}
// Expose the string value via the valuetext attribute. We test for the value
// interface because we don't want to expose traditional Value() information
// such as URLs on links and documents, or text in an input.
// XXX This is only needed for ATK, since other APIs have native ways to
// retrieve value text. We should probably move this into ATK specific code.
// For now, we do this because LocalAccessible does it.
if (HasNumericValue()) {
nsString valuetext;
Value(valuetext);
attributes->SetAttribute(nsGkAtoms::aria_valuetext, std::move(valuetext));
}
return attributes.forget();
}
nsAtom* RemoteAccessible::TagName() const {
if (mCachedFields) {
if (auto tag =
mCachedFields->GetAttribute<RefPtr<nsAtom>>(CacheKey::TagName)) {
return *tag;
}
}
return nullptr;
}
already_AddRefed<nsAtom> RemoteAccessible::DisplayStyle() const {
if (RequestDomainsIfInactive(CacheDomain::Style)) {
return nullptr;
}
if (mCachedFields) {
if (auto display =
mCachedFields->GetAttribute<RefPtr<nsAtom>>(CacheKey::CSSDisplay)) {
RefPtr<nsAtom> result = *display;
return result.forget();
}
}
return nullptr;
}
float RemoteAccessible::Opacity() const {
if (RequestDomainsIfInactive(CacheDomain::Style)) {
return 1.0f;
}
if (mCachedFields) {
if (auto opacity = mCachedFields->GetAttribute<float>(CacheKey::Opacity)) {
return *opacity;
}
}
return 1.0f;
}
WritingMode RemoteAccessible::GetWritingMode() const {
if (RequestDomainsIfInactive(CacheDomain::Style)) {
return WritingMode();
}
if (mCachedFields) {
if (auto wm =
mCachedFields->GetAttribute<WritingMode>(CacheKey::WritingMode)) {
return *wm;
}
}
return WritingMode();
}
void RemoteAccessible::LiveRegionAttributes(nsAString* aLive,
nsAString* aRelevant,
Maybe<bool>* aAtomic,
nsAString* aBusy) const {
if (RequestDomainsIfInactive(CacheDomain::ARIA)) {
return;
}
if (!mCachedFields) {
return;
}
auto attrs = GetCachedARIAAttributes();
if (!attrs) {
return;
}
if (aLive) {
attrs->GetAttribute(nsGkAtoms::aria_live, *aLive);
}
if (aRelevant) {
attrs->GetAttribute(nsGkAtoms::aria_relevant, *aRelevant);
}
if (aAtomic) {
if (auto value =
attrs->GetAttribute<RefPtr<nsAtom>>(nsGkAtoms::aria_atomic)) {
*aAtomic = Some(*value == nsGkAtoms::_true);
}
}
if (aBusy) {
attrs->GetAttribute(nsGkAtoms::aria_busy, *aBusy);
}
}
Maybe<bool> RemoteAccessible::ARIASelected() const {
if (RequestDomainsIfInactive(CacheDomain::State)) {
return Nothing();
}
if (mCachedFields) {
return mCachedFields->GetAttribute<bool>(CacheKey::ARIASelected);
}
return Nothing();
}
nsAtom* RemoteAccessible::GetPrimaryAction() const {
if (mCachedFields) {
ASSERT_DOMAINS_ACTIVE(CacheDomain::Actions);
if (auto action = mCachedFields->GetAttribute<RefPtr<nsAtom>>(
CacheKey::PrimaryAction)) {
return *action;
}
}
return nullptr;
}
uint8_t RemoteAccessible::ActionCount() const {
uint8_t actionCount = 0;
if (RequestDomainsIfInactive(CacheDomain::Actions)) {
return actionCount;
}
if (mCachedFields) {
if (HasPrimaryAction() || ActionAncestor()) {
actionCount++;
}
if (mCachedFields->HasAttribute(CacheKey::HasLongdesc)) {
actionCount++;
}
VERIFY_CACHE(CacheDomain::Actions);
}
return actionCount;
}
void RemoteAccessible::ActionNameAt(uint8_t aIndex, nsAString& aName) {
if (RequestDomainsIfInactive(CacheDomain::Actions)) {
return;
}
if (mCachedFields) {
aName.Truncate();
nsAtom* action = GetPrimaryAction();
bool hasActionAncestor = !action && ActionAncestor();
switch (aIndex) {
case 0:
if (action) {
action->ToString(aName);
} else if (hasActionAncestor) {
aName.AssignLiteral("clickAncestor");
} else if (mCachedFields->HasAttribute(CacheKey::HasLongdesc)) {
aName.AssignLiteral("showlongdesc");
}
break;
case 1:
if ((action || hasActionAncestor) &&
mCachedFields->HasAttribute(CacheKey::HasLongdesc)) {
aName.AssignLiteral("showlongdesc");
}
break;
default:
break;
}
}
VERIFY_CACHE(CacheDomain::Actions);
}
bool RemoteAccessible::DoAction(uint8_t aIndex) const {
if (RequestDomainsIfInactive(CacheDomain::Actions)) {
return false;
}
if (ActionCount() < aIndex + 1) {
return false;
}
(void)mDoc->SendDoActionAsync(mID, aIndex);
return true;
}
KeyBinding RemoteAccessible::AccessKey() const {
if (RequestDomainsIfInactive(CacheDomain::Actions)) {
return {};
}
if (mCachedFields) {
if (auto value =
mCachedFields->GetAttribute<uint64_t>(CacheKey::AccessKey)) {
return KeyBinding(*value);
}
}
return KeyBinding();
}
void RemoteAccessible::SelectionRanges(nsTArray<TextRange>* aRanges) const {
Document()->SelectionRanges(aRanges);
}
bool RemoteAccessible::RemoveFromSelection(int32_t aSelectionNum) {
MOZ_ASSERT(IsHyperText());
if (SelectionCount() <= aSelectionNum) {
return false;
}
(void)mDoc->SendRemoveTextSelection(mID, aSelectionNum);
return true;
}
void RemoteAccessible::ARIAGroupPosition(int32_t* aLevel, int32_t* aSetSize,
int32_t* aPosInSet) const {
if (RequestDomainsIfInactive(CacheDomain::GroupInfo)) {
return;
}
if (!mCachedFields) {
return;
}
if (aLevel) {
if (auto level =
mCachedFields->GetAttribute<int32_t>(nsGkAtoms::aria_level)) {
*aLevel = *level;
}
}
if (aSetSize) {
if (auto setsize =
mCachedFields->GetAttribute<int32_t>(nsGkAtoms::aria_setsize)) {
*aSetSize = *setsize;
}
}
if (aPosInSet) {
if (auto posinset =
mCachedFields->GetAttribute<int32_t>(nsGkAtoms::aria_posinset)) {
*aPosInSet = *posinset;
}
}
}
AccGroupInfo* RemoteAccessible::GetGroupInfo() const {
// Interpret a call to GetGroupInfo as a signal that the AT will want group
// info information. CacheKey::GroupInfo is not in CacheDomain::GroupInfo, so
// this isn't strictly necessary, but is likely helpful.
if (RequestDomainsIfInactive(CacheDomain::GroupInfo)) {
return nullptr;
}
if (!mCachedFields) {
return nullptr;
}
if (auto groupInfo = mCachedFields->GetAttribute<UniquePtr<AccGroupInfo>>(
CacheKey::GroupInfo)) {
return groupInfo->get();
}
return nullptr;
}
AccGroupInfo* RemoteAccessible::GetOrCreateGroupInfo() {
if (RequestDomainsIfInactive(CacheDomain::GroupInfo)) {
return nullptr;
}
AccGroupInfo* groupInfo = GetGroupInfo();
if (groupInfo) {
return groupInfo;
}
groupInfo = AccGroupInfo::CreateGroupInfo(this);
if (groupInfo) {
if (!mCachedFields) {
mCachedFields = new AccAttributes();
}
mCachedFields->SetAttribute(CacheKey::GroupInfo, groupInfo);
}
return groupInfo;
}
void RemoteAccessible::InvalidateGroupInfo() {
if (mCachedFields) {
mCachedFields->Remove(CacheKey::GroupInfo);
}
}
void RemoteAccessible::GetPositionAndSetSize(int32_t* aPosInSet,
int32_t* aSetSize) {
// Note: Required domains come from requirements of RelationByType.
if (RequestDomainsIfInactive(CacheDomain::Relations | CacheDomain::Value |
CacheDomain::DOMNodeIDAndClass |
CacheDomain::GroupInfo)) {
return;
}
if (IsHTMLRadioButton()) {
*aSetSize = 0;
Relation rel = RelationByType(RelationType::MEMBER_OF);
while (Accessible* radio = rel.Next()) {
++*aSetSize;
if (radio == this) {
*aPosInSet = *aSetSize;
}
}
return;
}
Accessible::GetPositionAndSetSize(aPosInSet, aSetSize);
}
bool RemoteAccessible::HasPrimaryAction() const {
if (RequestDomainsIfInactive(CacheDomain::Actions)) {
return false;
}
return mCachedFields && mCachedFields->HasAttribute(CacheKey::PrimaryAction);
}
void RemoteAccessible::TakeFocus() const {
(void)mDoc->SendTakeFocus(mID);
auto* bp = static_cast<dom::BrowserParent*>(mDoc->Manager());
MOZ_ASSERT(bp);
if (nsFocusManager::GetFocusedElementStatic() == bp->GetOwnerElement()) {
// This remote document tree is already focused. We don't need to do
// anything else.
return;
}
// Otherwise, we need to focus the <browser> or <iframe> element embedding the
// remote document in the parent process. If `this` is in an OOP iframe, we
// first need to focus the embedder iframe (and any ancestor OOP iframes). If
// the parent process embedder element were already focused, that would happen
// automatically, but it isn't. We can't simply focus the parent process
// embedder element before calling mDoc->SendTakeFocus because that would
// cause the remote document to restore focus to the last focused element,
// which we don't want.
DocAccessibleParent* embeddedDoc = mDoc;
Accessible* embedder = mDoc->Parent();
while (embedder) {
MOZ_ASSERT(embedder->IsOuterDoc());
RemoteAccessible* embedderRemote = embedder->AsRemote();
if (!embedderRemote) {
// This is the element in the parent process which embeds the remote
// document.
embedder->TakeFocus();
break;
}
// This is a remote <iframe>.
if (embeddedDoc->IsTopLevelInContentProcess()) {
// We only need to focus OOP iframes because these are where we cross
// process boundaries.
(void)embedderRemote->mDoc->SendTakeFocus(embedderRemote->mID);
}
embeddedDoc = embedderRemote->mDoc;
embedder = embeddedDoc->Parent();
}
}
void RemoteAccessible::ScrollTo(uint32_t aHow) const {
(void)mDoc->SendScrollTo(mID, aHow);
}
////////////////////////////////////////////////////////////////////////////////
// SelectAccessible
void RemoteAccessible::SelectedItems(nsTArray<Accessible*>* aItems) {
if (RequestDomainsIfInactive(kNecessaryStateDomains)) {
return;
}
Pivot p = Pivot(this);
PivotStateRule rule(states::SELECTED);
for (Accessible* selected = p.First(rule); selected;
selected = p.Next(selected, rule)) {
aItems->AppendElement(selected);
}
}
uint32_t RemoteAccessible::SelectedItemCount() {
if (RequestDomainsIfInactive(kNecessaryStateDomains)) {
return 0;
}
uint32_t count = 0;
Pivot p = Pivot(this);
PivotStateRule rule(states::SELECTED);
for (Accessible* selected = p.First(rule); selected;
selected = p.Next(selected, rule)) {
count++;
}
return count;
}
Accessible* RemoteAccessible::GetSelectedItem(uint32_t aIndex) {
if (RequestDomainsIfInactive(kNecessaryStateDomains)) {
return nullptr;
}
uint32_t index = 0;
Accessible* selected = nullptr;
Pivot p = Pivot(this);
PivotStateRule rule(states::SELECTED);
for (selected = p.First(rule); selected && index < aIndex;
selected = p.Next(selected, rule)) {
index++;
}
return selected;
}
bool RemoteAccessible::IsItemSelected(uint32_t aIndex) {
if (RequestDomainsIfInactive(kNecessaryStateDomains)) {
return false;
}
uint32_t index = 0;
Accessible* selectable = nullptr;
Pivot p = Pivot(this);
PivotStateRule rule(states::SELECTABLE);
for (selectable = p.First(rule); selectable && index < aIndex;
selectable = p.Next(selectable, rule)) {
index++;
}
return selectable && selectable->State() & states::SELECTED;
}
bool RemoteAccessible::AddItemToSelection(uint32_t aIndex) {
if (RequestDomainsIfInactive(kNecessaryStateDomains)) {
return false;
}
uint32_t index = 0;
Accessible* selectable = nullptr;
Pivot p = Pivot(this);
PivotStateRule rule(states::SELECTABLE);
for (selectable = p.First(rule); selectable && index < aIndex;
selectable = p.Next(selectable, rule)) {
index++;
}
if (selectable) selectable->SetSelected(true);
return static_cast<bool>(selectable);
}
bool RemoteAccessible::RemoveItemFromSelection(uint32_t aIndex) {
if (RequestDomainsIfInactive(kNecessaryStateDomains)) {
return false;
}
uint32_t index = 0;
Accessible* selectable = nullptr;
Pivot p = Pivot(this);
PivotStateRule rule(states::SELECTABLE);
for (selectable = p.First(rule); selectable && index < aIndex;
selectable = p.Next(selectable, rule)) {
index++;
}
if (selectable) selectable->SetSelected(false);
return static_cast<bool>(selectable);
}
bool RemoteAccessible::SelectAll() {
if (RequestDomainsIfInactive(kNecessaryStateDomains)) {
return false;
}
if ((State() & states::MULTISELECTABLE) == 0) {
return false;
}
bool success = false;
Accessible* selectable = nullptr;
Pivot p = Pivot(this);
PivotStateRule rule(states::SELECTABLE);
for (selectable = p.First(rule); selectable;
selectable = p.Next(selectable, rule)) {
success = true;
selectable->SetSelected(true);
}
return success;
}
bool RemoteAccessible::UnselectAll() {
if (RequestDomainsIfInactive(kNecessaryStateDomains)) {
return false;
}
if ((State() & states::MULTISELECTABLE) == 0) {
return false;
}
bool success = false;
Accessible* selectable = nullptr;
Pivot p = Pivot(this);
PivotStateRule rule(states::SELECTABLE);
for (selectable = p.First(rule); selectable;
selectable = p.Next(selectable, rule)) {
success = true;
selectable->SetSelected(false);
}
return success;
}
void RemoteAccessible::TakeSelection() { (void)mDoc->SendTakeSelection(mID); }
void RemoteAccessible::SetSelected(bool aSelect) {
(void)mDoc->SendSetSelected(mID, aSelect);
}
TableAccessible* RemoteAccessible::AsTable() {
if (IsTable()) {
return CachedTableAccessible::GetFrom(this);
}
return nullptr;
}
TableCellAccessible* RemoteAccessible::AsTableCell() {
if (IsTableCell()) {
return CachedTableCellAccessible::GetFrom(this);
}
return nullptr;
}
bool RemoteAccessible::TableIsProbablyForLayout() {
if (RequestDomainsIfInactive(CacheDomain::Table)) {
return false;
}
if (mCachedFields) {
if (auto layoutGuess =
mCachedFields->GetAttribute<bool>(CacheKey::TableLayoutGuess)) {
return *layoutGuess;
}
}
return false;
}
nsTArray<int32_t>& RemoteAccessible::GetCachedHyperTextOffsets() {
if (mCachedFields) {
if (auto offsets = mCachedFields->GetMutableAttribute<nsTArray<int32_t>>(
CacheKey::HyperTextOffsets)) {
return *offsets;
}
}
nsTArray<int32_t> newOffsets;
if (!mCachedFields) {
mCachedFields = new AccAttributes();
}
mCachedFields->SetAttribute(CacheKey::HyperTextOffsets,
std::move(newOffsets));
return *mCachedFields->GetMutableAttribute<nsTArray<int32_t>>(
CacheKey::HyperTextOffsets);
}
Maybe<int32_t> RemoteAccessible::GetIntARIAAttr(nsAtom* aAttrName) const {
if (RequestDomainsIfInactive(CacheDomain::ARIA)) {
return Nothing();
}
if (auto attrs = GetCachedARIAAttributes()) {
if (auto val = attrs->GetAttribute<int32_t>(aAttrName)) {
return val;
}
}
return Nothing();
}
bool RemoteAccessible::GetStringARIAAttr(nsAtom* aAttrName,
nsAString& aAttrValue) const {
if (RequestDomainsIfInactive(CacheDomain::ARIA)) {
return false;
}
if (aAttrName == nsGkAtoms::role) {
if (mCachedFields->GetAttribute(CacheKey::ARIARole, aAttrValue)) {
// Unknown, or multiple roles.
return true;
}
if (const nsRoleMapEntry* roleMap = ARIARoleMap()) {
if (roleMap->roleAtom != nsGkAtoms::_empty) {
// Non-empty rolemap, stringify it and return true.
roleMap->roleAtom->ToString(aAttrValue);
return true;
}
}
}
if (auto attrs = GetCachedARIAAttributes()) {
return attrs->GetAttribute(aAttrName, aAttrValue);
}
return false;
}
bool RemoteAccessible::ARIAAttrValueIs(nsAtom* aAttrName,
nsAtom* aAttrValue) const {
if (RequestDomainsIfInactive(CacheDomain::ARIA)) {
return false;
}
if (aAttrName == nsGkAtoms::role) {
nsAutoString roleStr;
if (mCachedFields->GetAttribute(CacheKey::ARIARole, roleStr)) {
return aAttrValue->Equals(roleStr);
}
if (const nsRoleMapEntry* roleMap = ARIARoleMap()) {
return roleMap->roleAtom == aAttrValue;
}
}
if (auto attrs = GetCachedARIAAttributes()) {
if (auto val = attrs->GetAttribute<RefPtr<nsAtom>>(aAttrName)) {
return *val == aAttrValue;
}
}
return false;
}
bool RemoteAccessible::HasARIAAttr(nsAtom* aAttrName) const {
if (RequestDomainsIfInactive(CacheDomain::ARIA)) {
return false;
}
if (aAttrName == nsGkAtoms::role) {
if (const nsRoleMapEntry* roleMap = ARIARoleMap()) {
if (roleMap->roleAtom != nsGkAtoms::_empty) {
return true;
}
}
return mCachedFields->HasAttribute(CacheKey::ARIARole);
}
if (auto attrs = GetCachedARIAAttributes()) {
return attrs->HasAttribute(aAttrName);
}
return false;
}
void RemoteAccessible::Language(nsAString& aLocale) {
if (RequestDomainsIfInactive(CacheDomain::Text)) {
return;
}
if (IsHyperText() || IsText()) {
for (RemoteAccessible* parent = this; parent;
parent = parent->RemoteParent()) {
// Climb up the tree to find where the nearest language attribute is.
if (RefPtr<const AccAttributes> attrs =
parent->GetCachedTextAttributes()) {
if (attrs->GetAttribute(nsGkAtoms::language, aLocale)) {
return;
}
}
}
} else if (mCachedFields) {
mCachedFields->GetAttribute(CacheKey::Language, aLocale);
}
}
void RemoteAccessible::ReplaceText(const nsAString& aText) {
(void)mDoc->SendReplaceText(mID, aText);
}
void RemoteAccessible::InsertText(const nsAString& aText, int32_t aPosition) {
(void)mDoc->SendInsertText(mID, aText, aPosition);
}
void RemoteAccessible::CopyText(int32_t aStartPos, int32_t aEndPos) {
(void)mDoc->SendCopyText(mID, aStartPos, aEndPos);
}
void RemoteAccessible::CutText(int32_t aStartPos, int32_t aEndPos) {
(void)mDoc->SendCutText(mID, aStartPos, aEndPos);
}
void RemoteAccessible::DeleteText(int32_t aStartPos, int32_t aEndPos) {
(void)mDoc->SendDeleteText(mID, aStartPos, aEndPos);
}
void RemoteAccessible::PasteText(int32_t aPosition) {
(void)mDoc->SendPasteText(mID, aPosition);
}
size_t RemoteAccessible::SizeOfIncludingThis(MallocSizeOf aMallocSizeOf) {
return aMallocSizeOf(this) + SizeOfExcludingThis(aMallocSizeOf);
}
size_t RemoteAccessible::SizeOfExcludingThis(MallocSizeOf aMallocSizeOf) {
size_t size = 0;
// Count attributes.
if (mCachedFields) {
size += mCachedFields->SizeOfIncludingThis(aMallocSizeOf);
}
// We don't recurse into mChildren because they're already counted in their
// document's mAccessibles.
size += mChildren.ShallowSizeOfExcludingThis(aMallocSizeOf);
return size;
}
} // namespace a11y
} // namespace mozilla
|