1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785 4786 4787 4788 4789 4790 4791 4792 4793 4794 4795 4796 4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 4838 4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862 4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 4877 4878 4879 4880 4881 4882 4883 4884 4885 4886 4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 4915 4916 4917 4918 4919 4920 4921 4922 4923 4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 4938 4939 4940 4941 4942 4943 4944 4945 4946 4947 4948 4949 4950 4951 4952 4953 4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 4976 4977 4978 4979 4980 4981 4982 4983 4984 4985 4986 4987 4988 4989 4990 4991 4992 4993 4994 4995 4996 4997 4998 4999 5000 5001 5002 5003 5004 5005 5006 5007 5008 5009 5010 5011 5012 5013 5014 5015 5016 5017 5018 5019 5020 5021 5022 5023 5024 5025 5026 5027 5028 5029 5030 5031 5032 5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 5058 5059 5060 5061 5062 5063 5064 5065 5066 5067 5068 5069 5070 5071 5072 5073 5074 5075 5076 5077 5078 5079 5080 5081 5082 5083 5084 5085 5086 5087 5088 5089 5090 5091 5092 5093 5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124 5125 5126 5127 5128 5129 5130 5131 5132 5133 5134 5135 5136 5137 5138 5139 5140 5141 5142 5143 5144 5145 5146 5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 5161 5162 5163 5164 5165 5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 5200 5201 5202 5203 5204 5205 5206 5207 5208 5209 5210 5211 5212 5213 5214 5215 5216 5217 5218 5219 5220 5221 5222 5223 5224 5225 5226 5227 5228 5229 5230 5231 5232 5233 5234 5235 5236 5237 5238 5239 5240 5241 5242 5243 5244 5245 5246 5247 5248 5249 5250 5251 5252 5253 5254 5255 5256 5257 5258 5259 5260 5261 5262 5263 5264 5265 5266 5267 5268 5269 5270 5271 5272 5273 5274 5275 5276 5277 5278 5279 5280 5281 5282 5283 5284 5285 5286 5287 5288 5289 5290 5291 5292 5293 5294 5295 5296 5297 5298 5299 5300 5301 5302 5303 5304 5305 5306 5307 5308 5309 5310 5311 5312 5313 5314 5315 5316 5317 5318 5319 5320 5321 5322 5323 5324 5325 5326 5327 5328 5329 5330 5331 5332 5333 5334 5335 5336 5337 5338 5339 5340 5341 5342 5343 5344 5345 5346 5347 5348 5349 5350 5351 5352 5353 5354 5355 5356 5357 5358 5359 5360 5361 5362 5363 5364 5365 5366 5367 5368 5369 5370 5371 5372 5373 5374 5375 5376 5377 5378 5379 5380 5381 5382 5383 5384 5385 5386 5387 5388 5389 5390 5391 5392 5393 5394 5395 5396 5397 5398 5399 5400 5401 5402 5403 5404 5405 5406 5407 5408 5409 5410 5411 5412 5413 5414 5415 5416 5417 5418 5419 5420 5421 5422 5423 5424 5425 5426 5427 5428 5429 5430 5431 5432 5433 5434 5435 5436 5437 5438 5439 5440 5441 5442 5443 5444 5445 5446 5447 5448 5449 5450 5451 5452 5453 5454 5455 5456 5457 5458 5459 5460 5461 5462 5463 5464 5465 5466 5467 5468 5469 5470 5471 5472 5473 5474 5475 5476 5477 5478 5479 5480 5481 5482 5483 5484 5485 5486 5487 5488 5489 5490 5491 5492 5493 5494 5495 5496 5497 5498 5499 5500 5501 5502 5503 5504 5505 5506 5507 5508 5509 5510 5511 5512 5513 5514 5515 5516 5517 5518 5519 5520 5521 5522 5523 5524 5525 5526 5527 5528 5529 5530 5531 5532 5533 5534 5535 5536 5537 5538 5539 5540 5541 5542 5543 5544 5545 5546 5547 5548 5549 5550 5551 5552 5553 5554 5555 5556 5557 5558 5559 5560 5561 5562 5563 5564 5565 5566 5567 5568 5569 5570 5571 5572 5573 5574 5575 5576 5577 5578 5579 5580 5581 5582 5583 5584 5585 5586 5587 5588 5589 5590 5591 5592 5593 5594 5595 5596 5597 5598 5599 5600 5601 5602 5603 5604 5605 5606 5607 5608 5609 5610 5611 5612 5613 5614 5615 5616 5617 5618 5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 5659 5660 5661 5662 5663 5664 5665 5666 5667 5668 5669 5670 5671 5672 5673 5674 5675 5676 5677 5678 5679 5680 5681 5682 5683 5684 5685 5686 5687 5688 5689 5690 5691 5692 5693 5694 5695 5696 5697 5698 5699 5700 5701 5702 5703 5704 5705 5706 5707 5708 5709 5710 5711 5712 5713 5714 5715 5716 5717 5718 5719 5720 5721 5722 5723 5724 5725 5726 5727 5728 5729 5730 5731 5732 5733 5734 5735 5736 5737 5738 5739 5740 5741 5742 5743 5744 5745 5746 5747 5748 5749 5750 5751 5752 5753 5754 5755 5756 5757 5758 5759 5760 5761 5762 5763 5764 5765 5766 5767 5768 5769 5770 5771 5772 5773 5774 5775 5776 5777 5778 5779 5780 5781 5782 5783 5784 5785 5786 5787 5788 5789 5790 5791 5792 5793 5794 5795 5796 5797 5798 5799 5800 5801 5802 5803 5804 5805 5806 5807 5808 5809 5810 5811 5812 5813 5814 5815 5816 5817 5818 5819 5820 5821 5822 5823 5824 5825 5826 5827 5828 5829 5830 5831 5832 5833 5834 5835 5836 5837 5838 5839 5840 5841 5842 5843 5844 5845 5846 5847 5848 5849 5850 5851 5852 5853 5854 5855 5856 5857 5858 5859 5860 5861 5862 5863 5864 5865 5866 5867 5868 5869 5870 5871 5872 5873 5874 5875 5876 5877 5878 5879 5880 5881 5882 5883 5884 5885 5886 5887 5888 5889 5890 5891 5892 5893 5894 5895 5896 5897 5898 5899 5900 5901 5902 5903 5904 5905 5906 5907 5908 5909 5910 5911 5912 5913 5914 5915 5916 5917 5918 5919 5920 5921 5922 5923 5924 5925 5926 5927 5928 5929 5930 5931 5932 5933 5934 5935 5936 5937 5938 5939 5940 5941 5942 5943 5944 5945 5946 5947 5948 5949 5950 5951 5952 5953 5954 5955 5956 5957 5958 5959 5960 5961 5962 5963 5964 5965 5966 5967 5968 5969 5970 5971 5972 5973 5974 5975 5976 5977 5978 5979 5980 5981 5982 5983 5984 5985 5986 5987 5988 5989 5990 5991 5992 5993 5994 5995 5996 5997 5998 5999 6000 6001 6002 6003 6004 6005 6006 6007 6008 6009 6010 6011 6012 6013 6014 6015 6016 6017 6018 6019 6020 6021 6022 6023 6024 6025 6026 6027 6028 6029 6030 6031 6032 6033 6034 6035 6036 6037 6038 6039 6040 6041 6042 6043 6044 6045 6046 6047 6048 6049 6050 6051 6052 6053 6054 6055 6056 6057 6058 6059 6060 6061 6062 6063 6064 6065 6066 6067 6068 6069 6070 6071 6072 6073 6074 6075 6076 6077 6078 6079 6080 6081 6082 6083 6084 6085 6086 6087 6088 6089 6090 6091 6092 6093 6094 6095 6096 6097 6098 6099 6100 6101 6102 6103 6104 6105 6106 6107 6108 6109 6110 6111 6112 6113 6114 6115 6116 6117 6118 6119 6120 6121 6122 6123 6124 6125 6126 6127 6128 6129 6130 6131 6132 6133 6134 6135 6136 6137 6138 6139 6140 6141 6142 6143 6144 6145 6146 6147 6148 6149 6150 6151 6152 6153 6154 6155 6156 6157 6158 6159 6160 6161 6162 6163 6164 6165 6166 6167 6168 6169 6170 6171 6172 6173 6174 6175 6176 6177 6178 6179 6180 6181 6182 6183 6184 6185 6186 6187 6188 6189 6190 6191 6192 6193 6194 6195 6196 6197 6198 6199 6200 6201 6202 6203 6204 6205 6206 6207 6208 6209 6210 6211 6212 6213 6214 6215 6216 6217 6218 6219 6220 6221 6222 6223 6224 6225 6226 6227 6228 6229 6230 6231 6232 6233 6234 6235 6236 6237 6238 6239 6240 6241 6242 6243 6244 6245 6246 6247 6248 6249 6250 6251 6252 6253 6254 6255 6256 6257 6258 6259 6260 6261 6262 6263 6264 6265 6266 6267 6268 6269 6270 6271 6272 6273 6274 6275 6276 6277 6278 6279 6280 6281 6282 6283 6284 6285 6286 6287 6288 6289 6290 6291 6292 6293 6294 6295 6296 6297 6298 6299 6300 6301 6302 6303 6304 6305 6306 6307 6308 6309 6310 6311 6312 6313 6314 6315 6316 6317 6318 6319 6320 6321 6322 6323 6324 6325 6326 6327 6328 6329 6330 6331 6332 6333 6334 6335 6336 6337 6338 6339 6340 6341 6342 6343 6344 6345 6346 6347 6348 6349 6350 6351 6352 6353 6354 6355 6356 6357 6358 6359 6360 6361 6362 6363 6364 6365 6366 6367 6368 6369 6370 6371 6372 6373 6374 6375 6376 6377 6378 6379 6380 6381 6382 6383 6384 6385 6386 6387 6388 6389 6390 6391 6392 6393 6394 6395 6396 6397 6398 6399 6400 6401 6402 6403 6404 6405 6406 6407 6408 6409 6410 6411 6412 6413 6414 6415 6416 6417 6418 6419 6420 6421 6422 6423 6424 6425 6426 6427 6428 6429 6430 6431 6432 6433 6434 6435 6436 6437 6438 6439 6440 6441 6442 6443 6444 6445 6446 6447 6448 6449 6450 6451 6452 6453 6454 6455 6456 6457 6458 6459 6460 6461 6462 6463 6464 6465 6466 6467 6468 6469 6470 6471 6472 6473 6474 6475 6476 6477 6478 6479 6480 6481 6482 6483 6484 6485 6486 6487 6488 6489 6490 6491 6492 6493 6494 6495 6496 6497 6498 6499 6500 6501 6502 6503 6504 6505 6506 6507 6508 6509 6510 6511 6512 6513 6514 6515 6516 6517 6518 6519 6520 6521 6522 6523 6524 6525 6526 6527 6528 6529 6530 6531 6532 6533 6534 6535 6536 6537 6538 6539 6540 6541 6542 6543 6544 6545 6546 6547 6548 6549 6550 6551 6552 6553 6554 6555 6556 6557 6558 6559 6560 6561 6562 6563 6564 6565 6566 6567 6568 6569 6570 6571 6572 6573 6574 6575 6576 6577 6578 6579 6580 6581 6582 6583 6584 6585 6586 6587 6588 6589 6590 6591 6592 6593 6594 6595 6596 6597 6598 6599 6600 6601 6602 6603 6604 6605 6606 6607 6608 6609 6610 6611 6612 6613 6614 6615 6616 6617 6618 6619 6620 6621 6622 6623 6624 6625 6626 6627 6628 6629 6630 6631 6632 6633 6634 6635 6636 6637 6638 6639 6640 6641 6642 6643 6644 6645 6646 6647 6648 6649 6650 6651 6652 6653 6654 6655 6656 6657 6658 6659 6660 6661 6662 6663 6664 6665 6666 6667 6668 6669 6670 6671 6672 6673 6674 6675 6676 6677 6678 6679 6680 6681 6682 6683 6684 6685 6686 6687 6688 6689 6690 6691 6692 6693 6694 6695 6696 6697 6698 6699 6700 6701 6702 6703 6704 6705 6706 6707 6708 6709 6710 6711 6712 6713 6714 6715 6716 6717 6718 6719 6720 6721 6722 6723 6724 6725 6726 6727 6728 6729 6730 6731 6732 6733 6734 6735 6736 6737 6738 6739 6740 6741 6742 6743 6744 6745 6746 6747 6748 6749 6750 6751 6752 6753 6754 6755 6756 6757 6758 6759 6760 6761 6762 6763 6764 6765 6766 6767 6768 6769 6770 6771 6772 6773 6774 6775 6776 6777 6778 6779 6780 6781 6782 6783 6784 6785 6786 6787 6788 6789 6790 6791 6792 6793 6794 6795 6796 6797 6798 6799 6800 6801 6802 6803 6804 6805 6806 6807 6808 6809 6810 6811 6812 6813 6814 6815 6816 6817 6818 6819 6820 6821 6822 6823 6824 6825 6826 6827 6828 6829 6830 6831 6832 6833 6834 6835 6836
|
/*
* Copyright (C) 2014, Google Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 3. Neither the name of Apple Computer, Inc. ("Apple") nor the names of
* its contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#include "third_party/blink/renderer/modules/accessibility/ax_object_cache_impl.h"
#include <algorithm>
#include <iterator>
#include <numeric>
#include <optional>
#include "base/auto_reset.h"
#include "base/check.h"
#include "base/containers/contains.h"
#include "base/memory/scoped_refptr.h"
#include "base/metrics/histogram_macros.h"
#include "base/notreached.h"
#include "mojo/public/cpp/bindings/pending_remote.h"
#include "services/metrics/public/cpp/ukm_builders.h"
#include "services/metrics/public/cpp/ukm_recorder.h"
#include "third_party/abseil-cpp/absl/cleanup/cleanup.h"
#include "third_party/blink/public/mojom/render_accessibility.mojom-blink.h"
#include "third_party/blink/public/platform/task_type.h"
#include "third_party/blink/public/web/web_local_frame_client.h"
#include "third_party/blink/public/web/web_plugin_container.h"
#include "third_party/blink/renderer/core/accessibility/scoped_blink_ax_event_intent.h"
#include "third_party/blink/renderer/core/display_lock/display_lock_utilities.h"
#include "third_party/blink/renderer/core/dom/document.h"
#include "third_party/blink/renderer/core/dom/document_lifecycle.h"
#include "third_party/blink/renderer/core/dom/dom_node_ids.h"
#include "third_party/blink/renderer/core/dom/node_traversal.h"
#include "third_party/blink/renderer/core/dom/pseudo_element.h"
#include "third_party/blink/renderer/core/dom/slot_assignment_engine.h"
#include "third_party/blink/renderer/core/editing/editing_utilities.h"
#include "third_party/blink/renderer/core/editing/markers/document_marker_controller.h"
#include "third_party/blink/renderer/core/events/event_util.h"
#include "third_party/blink/renderer/core/execution_context/agent.h"
#include "third_party/blink/renderer/core/frame/local_frame.h"
#include "third_party/blink/renderer/core/frame/local_frame_client.h"
#include "third_party/blink/renderer/core/frame/local_frame_view.h"
#include "third_party/blink/renderer/core/frame/settings.h"
#include "third_party/blink/renderer/core/frame/visual_viewport.h"
#include "third_party/blink/renderer/core/frame/web_local_frame_impl.h"
#include "third_party/blink/renderer/core/html/canvas/html_canvas_element.h"
#include "third_party/blink/renderer/core/html/forms/html_button_element.h"
#include "third_party/blink/renderer/core/html/forms/html_input_element.h"
#include "third_party/blink/renderer/core/html/forms/html_label_element.h"
#include "third_party/blink/renderer/core/html/forms/html_option_element.h"
#include "third_party/blink/renderer/core/html/forms/html_select_element.h"
#include "third_party/blink/renderer/core/html/forms/listed_element.h"
#include "third_party/blink/renderer/core/html/html_area_element.h"
#include "third_party/blink/renderer/core/html/html_embed_element.h"
#include "third_party/blink/renderer/core/html/html_frame_owner_element.h"
#include "third_party/blink/renderer/core/html/html_head_element.h"
#include "third_party/blink/renderer/core/html/html_image_element.h"
#include "third_party/blink/renderer/core/html/html_map_element.h"
#include "third_party/blink/renderer/core/html/html_menu_element.h"
#include "third_party/blink/renderer/core/html/html_object_element.h"
#include "third_party/blink/renderer/core/html/html_olist_element.h"
#include "third_party/blink/renderer/core/html/html_plugin_element.h"
#include "third_party/blink/renderer/core/html/html_progress_element.h"
#include "third_party/blink/renderer/core/html/html_script_element.h"
#include "third_party/blink/renderer/core/html/html_slot_element.h"
#include "third_party/blink/renderer/core/html/html_style_element.h"
#include "third_party/blink/renderer/core/html/html_table_cell_element.h"
#include "third_party/blink/renderer/core/html/html_table_element.h"
#include "third_party/blink/renderer/core/html/html_table_row_element.h"
#include "third_party/blink/renderer/core/html/html_title_element.h"
#include "third_party/blink/renderer/core/html/html_ulist_element.h"
#include "third_party/blink/renderer/core/html/shadow/shadow_element_names.h"
#include "third_party/blink/renderer/core/html_names.h"
#include "third_party/blink/renderer/core/input_type_names.h"
#include "third_party/blink/renderer/core/layout/hit_test_location.h"
#include "third_party/blink/renderer/core/layout/hit_test_result.h"
#include "third_party/blink/renderer/core/layout/inline/abstract_inline_text_box.h"
#include "third_party/blink/renderer/core/layout/inline/inline_cursor.h"
#include "third_party/blink/renderer/core/layout/layout_block_flow.h"
#include "third_party/blink/renderer/core/layout/layout_image.h"
#include "third_party/blink/renderer/core/layout/layout_inline.h"
#include "third_party/blink/renderer/core/layout/layout_text.h"
#include "third_party/blink/renderer/core/layout/layout_view.h"
#include "third_party/blink/renderer/core/layout/table/layout_table.h"
#include "third_party/blink/renderer/core/layout/table/layout_table_cell.h"
#include "third_party/blink/renderer/core/layout/table/layout_table_row.h"
#include "third_party/blink/renderer/core/page/chrome_client.h"
#include "third_party/blink/renderer/core/page/focus_controller.h"
#include "third_party/blink/renderer/core/page/page.h"
#include "third_party/blink/renderer/core/page/page_animator.h"
#include "third_party/blink/renderer/core/style/content_data.h"
#include "third_party/blink/renderer/core/svg/svg_graphics_element.h"
#include "third_party/blink/renderer/core/svg/svg_style_element.h"
#include "third_party/blink/renderer/modules/accessibility/aria_notification.h"
#include "third_party/blink/renderer/modules/accessibility/ax_block_flow_iterator.h"
#include "third_party/blink/renderer/modules/accessibility/ax_image_map_link.h"
#include "third_party/blink/renderer/modules/accessibility/ax_inline_text_box.h"
#include "third_party/blink/renderer/modules/accessibility/ax_media_control.h"
#include "third_party/blink/renderer/modules/accessibility/ax_media_element.h"
#include "third_party/blink/renderer/modules/accessibility/ax_node_object.h"
#include "third_party/blink/renderer/modules/accessibility/ax_object-inl.h"
#include "third_party/blink/renderer/modules/accessibility/ax_object.h"
#include "third_party/blink/renderer/modules/accessibility/ax_progress_indicator.h"
#include "third_party/blink/renderer/modules/accessibility/ax_relation_cache.h"
#include "third_party/blink/renderer/modules/accessibility/ax_slider.h"
#include "third_party/blink/renderer/modules/accessibility/ax_validation_message.h"
#include "third_party/blink/renderer/platform/graphics/dom_node_id.h"
#include "third_party/blink/renderer/platform/instrumentation/tracing/trace_event.h"
#include "third_party/blink/renderer/platform/wtf/functional.h"
#include "ui/accessibility/accessibility_features.h"
#include "ui/accessibility/ax_common.h"
#include "ui/accessibility/ax_enums.mojom-blink.h"
#include "ui/accessibility/ax_event.h"
#include "ui/accessibility/ax_location_and_scroll_updates.h"
#include "ui/accessibility/ax_mode.h"
#include "ui/accessibility/ax_node.h"
#include "ui/accessibility/ax_role_properties.h"
#include "ui/accessibility/mojom/ax_location_and_scroll_updates.mojom-blink.h"
#include "ui/accessibility/mojom/ax_relative_bounds.mojom-blink.h"
#if AX_FAIL_FAST_BUILD()
#include "third_party/blink/renderer/modules/accessibility/ax_debug_utils.h"
#endif
// Prevent code that runs during the lifetime of the stack from altering the
// document lifecycle, for the main document, and the popup document if present.
#if DCHECK_IS_ON()
#define SCOPED_DISALLOW_LIFECYCLE_TRANSITION() \
DocumentLifecycle::DisallowTransitionScope scoped(document_->Lifecycle()); \
DocumentLifecycle::DisallowTransitionScope scoped2( \
popup_document_ ? popup_document_->Lifecycle() \
: document_->Lifecycle());
#else
#define SCOPED_DISALLOW_LIFECYCLE_TRANSITION()
#endif // DCHECK_IS_ON()
namespace blink {
using mojom::blink::FormControlType;
namespace {
// Represents a missing AXId in the context of an AXInlineTextBox mapping.
constexpr int kMissingAXId = 0;
// Number of extra off-screen nodes to serialize when the AXMode kOnScreenOnly
// is on.
constexpr int kNumExtraNodesToSerialize = 1;
bool IsInitialEmptyDocument(const Document& document) {
// Do not fire for initial empty top document. This helps avoid thrashing the
// a11y tree, causing an extra serialization.
// TODO(accessibility) This is an ugly special case -- find a better way.
// Note: Document::IsInitialEmptyDocument() did not work -- should it?
if (document.body() && document.body()->hasChildren())
return false;
if (document.head() && document.head()->hasChildren())
return false;
if (document.ParentDocument())
return false;
// No contents and not a child document, return true if about::blank.
return document.Url().IsAboutBlankURL();
}
// Return true if display locked or inside slot recalc, false otherwise.
// Also returns false if not a safe time to perform the check.
bool IsDisplayLocked(const Node* node, bool inclusive = false) {
if (!node)
return false;
// The IsDisplayLockedPreventingPaint() function may attempt to do
// a flat tree traversal of ancestors. If we're in a flat tree traversal
// forbidden scope, return false. Additionally, flat tree traversal
// might call AssignedSlot, so if we're in a slot assignment recalc
// forbidden scope, return false.
if (node->GetDocument().IsFlatTreeTraversalForbidden() ||
node->GetDocument()
.GetSlotAssignmentEngine()
.HasPendingSlotAssignmentRecalc()) {
return false; // Cannot safely perform this check now.
}
return DisplayLockUtilities::IsDisplayLockedPreventingPaint(node, inclusive);
}
bool IsDisplayLocked(const LayoutObject* object) {
bool inclusive = false;
while (object) {
if (const auto* node = object->GetNode())
return IsDisplayLocked(node, inclusive);
inclusive = true;
object = object->Parent();
}
return false;
}
bool IsActive(Document& document) {
return document.IsActive() && !document.IsDetached();
}
bool HasAriaCellRole(Element* elem) {
DCHECK(elem);
const AtomicString& role_str =
AXObject::AriaAttribute(*elem, html_names::kRoleAttr);
if (role_str.empty())
return false;
return ui::IsCellOrTableHeader(
AXObject::FirstValidRoleInRoleString(role_str));
}
// Return true if whitespace is not necessary to keep adjacent_node separate
// in screen reader output from surrounding nodes.
bool CanIgnoreSpaceNextTo(LayoutObject* layout_object,
bool is_after,
int counter = 0) {
if (!layout_object)
return true;
if (counter > 3)
return false; // Don't recurse more than 3 times.
auto* elem = DynamicTo<Element>(layout_object->GetNode());
// Can usually ignore space next to a <br>.
// Exception: if the space was next to a <br> with an ARIA role.
if (layout_object->IsBR()) {
// As an example of a <br> with a role, Google Docs uses:
// <span contenteditable=false> <br role="presentation></span>.
// This construct hides the <br> from the AX tree and uses the space
// instead, presenting a hard line break as a soft line break.
DCHECK(elem);
return !is_after ||
!AXObject::HasAriaAttribute(*elem, html_names::kRoleAttr);
}
// If adjacent to a whitespace character, the current space can be ignored.
if (layout_object->IsText()) {
auto* layout_text = To<LayoutText>(layout_object);
if (layout_text->HasEmptyText())
return false;
if (layout_text->TransformedText()
.Impl()
->ContainsOnlyWhitespaceOrEmpty()) {
return true;
}
auto adjacent_char =
is_after ? layout_text->FirstCharacterAfterWhitespaceCollapsing()
: layout_text->LastCharacterAfterWhitespaceCollapsing();
return adjacent_char == ' ' || adjacent_char == '\n' ||
adjacent_char == '\t';
}
// Keep spaces between images and other visible content, in case the image is
// used inline as a symbol mimicking text. This is not necessary for other
// types of images, such as a canvas.
// Note that relying the layout object via IsLayoutImage() was a cause of
// flakiness, as the layout object could change to a LayoutBlockFlow if the
// image failed to load. However, we still check IsLayoutImage() in order
// to detect CSS images, which don't have the same issue of changing layout.
if (layout_object->IsLayoutImage() || IsA<HTMLImageElement>(elem) ||
(IsA<HTMLInputElement>(elem) &&
To<HTMLInputElement>(elem)->FormControlType() ==
FormControlType::kInputImage)) {
return false;
}
// Do not keep spaces between blocks.
if (!layout_object->IsLayoutInline())
return true;
// If next to an element that a screen reader will always read separately,
// the the space can be ignored.
// Elements that are naturally focusable even without a tabindex tend
// to be rendered separately even if there is no space between them.
// Some ARIA roles act like table cells and don't need adjacent whitespace to
// indicate separation.
// False negatives are acceptable in that they merely lead to extra whitespace
// static text nodes.
if (elem && HasAriaCellRole(elem))
return true;
// Test against the appropriate child text node.
auto* layout_inline = To<LayoutInline>(layout_object);
LayoutObject* child =
is_after ? layout_inline->FirstChild() : layout_inline->LastChild();
if (!child && elem) {
// No children of inline element. Check adjacent sibling in same direction.
Node* adjacent_node =
is_after ? NodeTraversal::NextIncludingPseudoSkippingChildren(*elem)
: NodeTraversal::PreviousAbsoluteSiblingIncludingPseudo(*elem);
return adjacent_node &&
CanIgnoreSpaceNextTo(adjacent_node->GetLayoutObject(), is_after,
++counter);
}
return CanIgnoreSpaceNextTo(child, is_after, ++counter);
}
bool CanIgnoreSpace(const LayoutText& layout_text) {
Node* node = layout_text.GetNode();
// Will now look at sibling nodes. We need the closest element to the
// whitespace markup-wise, e.g. tag1 in these examples:
// [whitespace] <tag1><tag2>x</tag2></tag1>
// <span>[whitespace]</span> <tag1><tag2>x</tag2></tag1>.
// Do not use LayoutTreeBuilderTraversal or FlatTreeTraversal as this may need
// to be called during slot assignment, when flat tree traversal is forbidden.
Node* prev_node =
NodeTraversal::PreviousAbsoluteSiblingIncludingPseudo(*node);
if (!prev_node)
return false;
Node* next_node = NodeTraversal::NextIncludingPseudoSkippingChildren(*node);
if (!next_node)
return false;
// Ignore extra whitespace-only text if a sibling will be presented
// separately by screen readers whether whitespace is there or not.
if (CanIgnoreSpaceNextTo(prev_node->GetLayoutObject(), false) ||
CanIgnoreSpaceNextTo(next_node->GetLayoutObject(), true)) {
return false;
}
// If the prev/next node is also a text node and the adjacent character is
// not whitespace, CanIgnoreSpaceNextTo will return false. In some cases that
// is what we want; in other cases it is not. Examples:
//
// 1a: <p><span>Hello</span><span>[whitespace]</span><span>World</span></p>
// 1b: <p><span>Hello</span>[whitespace]<span>World</span></p>
// 2: <div><ul><li style="display:inline;">x</li>[whitespace]</ul>y</div>
//
// In the first case, we want to preserve the whitespace (crbug.com/435765).
// In the second case, the whitespace in the markup is not relevant because
// the "x" is separated from the "y" by virtue of being inside a different
// block. In order to distinguish these two scenarios, we can use the
// LayoutBox associated with each node. For the first scenario, each node's
// LayoutBox is the LayoutBlockFlow associated with the <p>. For the second
// scenario, the LayoutBox of "x" and the whitespace is the LayoutBlockFlow
// associated with the <ul>; the LayoutBox of "y" is the one associated with
// the <div>.
LayoutBox* box = layout_text.EnclosingBox();
if (!box)
return false;
if (prev_node->GetLayoutObject() && prev_node->GetLayoutObject()->IsText()) {
LayoutBox* prev_box = prev_node->GetLayoutObject()->EnclosingBox();
if (prev_box != box)
return false;
}
if (next_node->GetLayoutObject() && next_node->GetLayoutObject()->IsText()) {
LayoutBox* next_box = next_node->GetLayoutObject()->EnclosingBox();
if (next_box != box)
return false;
}
return true;
}
bool IsLayoutTextRelevantForAccessibility(const LayoutText& layout_text) {
if (!layout_text.Parent())
return false;
#if DCHECK_IS_ON()
Node* node = layout_text.GetNode();
DCHECK(node); // Anonymous text is processed earlier, doesn't reach here.
DCHECK(node->GetDocument().Lifecycle().GetState() >=
DocumentLifecycle::kAfterPerformLayout)
<< "Unclean document at lifecycle "
<< node->GetDocument().Lifecycle().ToString();
#endif
// Ignore empty text.
if (layout_text.HasEmptyText())
return false;
// Always keep if anything other than collapsible whitespace.
if (!layout_text.IsAllCollapsibleWhitespace() || layout_text.IsBR())
return true;
// Use previous decision for this whitespace. This is helpful for performance,
// consistency (flake reduction) and code simplicity, as we do not need to
// recompute block subtrees when inline nodes change. It also helps ensure
// that whitespace nodes do not change whether they store a layout object
// at inopportune times.
if (std::optional<bool> ignore_whitespace =
layout_text.IgnoreWhitespaceForAccessibility();
ignore_whitespace.has_value()) {
return *ignore_whitespace;
}
// Compute ignored value for whitespace and record decision.
bool ignore_whitespace = CanIgnoreSpace(layout_text);
// Memoize the result.
layout_text.SetIgnoreWhitespaceForAccessibility(ignore_whitespace);
return ignore_whitespace;
}
bool IsHiddenTextNodeRelevantForAccessibility(const Text& text_node,
bool is_display_locked) {
// Children of an <iframe> tag will always be replaced by a new Document,
// either loaded from the iframe src or empty. In fact, we don't even parse
// them and they are treated like one text node. Consider irrelevant.
if (AXObject::IsFrame(text_node.parentElement()))
return false;
// Layout has more info available to determine if whitespace is relevant.
// If display-locked, layout object may be missing or stale:
// Assume that all display-locked text nodes are relevant, but only create
// an AXNodeObject in order to avoid using a stale layout object.
if (is_display_locked)
return true;
// If unrendered + no parent, it is in a shadow tree. Consider irrelevant.
if (!text_node.parentElement()) {
DCHECK(text_node.IsInShadowTree());
return false;
}
// If unrendered and in <canvas>, consider even whitespace relevant.
if (text_node.parentElement()->IsInCanvasSubtree())
return true;
// Must be unrendered because of CSS. Consider relevant if non-whitespace.
// Allowing rendered non-whitespace to be considered relevant will allow
// use for accessible relations such as labelledby and describedby.
return !text_node.ContainsOnlyWhitespaceOrEmpty();
}
bool IsShadowContentRelevantForAccessibility(const Node* node) {
DCHECK(node->ContainingShadowRoot());
// Return false if inside a shadow tree of something that can't have children,
// for example, an <img> has a user agent shadow root containing a <span> for
// the alt text. Do not create an accessible for that as it would be unable
// to have a parent that has it as a child.
if (!AXObject::CanHaveChildren(To<Element>(*node->OwnerShadowHost()))) {
return false;
}
if (node->IsInUserAgentShadowRoot()) {
// Native <img> create extra child nodes to hold alt text, which are not
// allowed as children. Note: images can have image map children, but these
// are moved from the <map> descendants and are not descendants of the
// image. See AXNodeObject::AddImageMapChildren().
if (IsA<HTMLImageElement>(node->OwnerShadowHost())) {
return false;
}
// aria-hidden subtrees can safely be pruned when it's in a UA shadow root.
// Make an exception for file input, which needs to gather its name from
// aria-hidden contents.
if (const Element* element = DynamicTo<Element>(node)) {
if (element->FastGetAttribute(html_names::kAriaHiddenAttr) == "true") {
return false;
}
// <select>'s autofill preview should not be included in the accessibility
// tree.
if (element->ShadowPseudoId() ==
shadow_element_names::kSelectAutofillPreview) {
return false;
}
}
}
// If inside a <object>/<embed>, the shadow content is relevant only if it is
// fallback content.
if (const HTMLPlugInElement* plugin_element =
DynamicTo<HTMLPlugInElement>(node->OwnerShadowHost())) {
return plugin_element->UseFallbackContent();
}
// All other shadow content is relevant.
return true;
}
bool IsLayoutObjectRelevantForAccessibility(const LayoutObject& layout_object) {
if (layout_object.IsAnonymous()) {
// Anonymous means there is no DOM node, and it's been inserted by the
// layout engine within the tree. An example is an anonymous block that is
// inserted as a parent of an inline where there are block siblings.
return AXObjectCacheImpl::IsRelevantPseudoElementDescendant(layout_object);
}
if (layout_object.IsText())
return IsLayoutTextRelevantForAccessibility(To<LayoutText>(layout_object));
// An AXImageMapLink will be created, which does not store the LayoutObject.
if (IsA<HTMLAreaElement>(layout_object.GetNode()))
return false;
return true;
}
bool IsSubtreePrunedForAccessibility(const Element* node) {
if (IsA<HTMLAreaElement>(node) && !IsA<HTMLMapElement>(node->parentNode()))
return true; // <area> without parent <map> is not relevant.
if (IsA<HTMLMapElement>(node))
return true; // Contains children for an img, but is not its own object.
if (node->HasTagName(html_names::kColgroupTag) ||
node->HasTagName(html_names::kColTag)) {
return true; // Affects table layout, but doesn't get it's own AXObject.
}
if (node->IsPseudoElement()) {
if (!AXObjectCacheImpl::IsRelevantPseudoElement(*node))
return true;
}
if (const HTMLSlotElement* slot =
ToHTMLSlotElementIfSupportsAssignmentOrNull(node)) {
if (!AXObjectCacheImpl::IsRelevantSlotElement(*slot))
return true;
}
// An HTML <title> does not require an AXObject: the document's name is
// retrieved directly via the inner text.
if (IsA<HTMLTitleElement>(node))
return true;
return false;
}
// Return true if node is head/style/script or any descendant of those.
// Also returns true for descendants of any type of frame, because the frame
// itself is in the tree, but not DOM descendants (their contents are in a
// different document).
bool IsInPrunableHiddenContainerInclusive(const Node& node,
bool parent_ax_known,
bool is_display_locked) {
int max_depth_to_check = INT_MAX;
if (parent_ax_known) {
// Optimization: only need to check the current object if the parent the
// parent_ax is already known, because it we are attempting to add this
// object from something already relevant in the AX tree, and therefore
// can't be inside a <head>, <style>, <script> or SVG <style> element.
// However, there is an edge case that if it is display locked content
// we must also check the parent, which can be visible and included
// in the tree. This edge case is handled to satisfy tests and is not
// likely to be a real-world condition.
max_depth_to_check = is_display_locked ? 2 : 1;
}
for (const Node* ancestor = &node; ancestor;
ancestor = ancestor->parentElement()) {
// Objects inside <head> are pruned.
if (IsA<HTMLHeadElement>(ancestor))
return true;
// Objects inside a <style> are pruned.
if (IsA<HTMLStyleElement>(ancestor))
return true;
// Objects inside a <script> are true.
if (IsA<HTMLScriptElement>(ancestor))
return true;
// Elements inside of a frame/iframe are true unless inside a document
// that is a child of the frame. In the case where descendants are allowed,
// they will be in a different document, and therefore this loop will not
// reach the frame/iframe.
if (AXObject::IsFrame(ancestor))
return true;
// Style elements in SVG are not display: none, unlike HTML style
// elements, but they are still hidden along with their contents and thus
// treated as true for accessibility.
if (IsA<SVGStyleElement>(ancestor))
return true;
if (--max_depth_to_check <= 0)
break;
}
// All other nodes are relevant, even if hidden.
return false;
}
// -----------------------------------------------------------------------------
// DetermineAXObjectType() determines what type of AXObject should be created
// for the given node and layout_object.
// * Pass in the Node, the LayoutObject or both.
// * Passing in |parent_ax_known| when there is known parent is an optimization
// and does not affect the return value.
// Some general rules:
// * If neither the node nor layout object are relevant for accessibility, will
// return kPruneSubtree, which will cause no AXObject to be created, and
// result in the entire subtree being pruned at that point.
// * If the node is part of a forbidden subtree, then kPruneSubtree is used.
// * If both the node and layout are relevant, kCreateFromLayout is preferred,
// otherwise: kCreateFromNode for relevant nodes, kCreateFromLayout for layout.
// -----------------------------------------------------------------------------
AXObjectType DetermineAXObjectType(const Node* node,
const LayoutObject* layout_object,
ui::AXMode ax_mode,
bool parent_ax_known) {
DCHECK(layout_object || node);
bool is_display_locked =
node ? IsDisplayLocked(node) : IsDisplayLocked(layout_object);
if (is_display_locked) {
if (!ax_mode.has_mode(ui::AXMode::kScreenReader)) {
// When screen readers are not present, it is safe to prune display-locked
// content, avoid performance degradation of content-visibility.
return kPruneSubtree;
}
layout_object = nullptr;
}
DCHECK(!node || !layout_object || layout_object->GetNode() == node);
bool is_node_relevant = false;
if (node) {
if (!node->isConnected()) {
return kPruneSubtree;
}
if (node->ContainingShadowRoot() &&
!IsShadowContentRelevantForAccessibility(node)) {
return kPruneSubtree;
}
if (!IsA<Element>(node) && !IsA<Text>(node)) {
// All remaining types, such as the document node, doctype node.
return layout_object ? kCreateFromLayout : kPruneSubtree;
}
if (const Element* element = DynamicTo<Element>(node)) {
if (IsSubtreePrunedForAccessibility(element))
return kPruneSubtree;
else
is_node_relevant = true;
} else { // Text is the only remaining type.
if (layout_object) {
// If there's layout for this text, it will either be pruned or an
// AXNodeObject with layout will be created for it. The logic of whether
// to return kCreateFromLayout or kPruneSubtree will come purely from
// is_layout_relevant further down.
return IsLayoutObjectRelevantForAccessibility(*layout_object)
? kCreateFromLayout
: kPruneSubtree;
} else {
// Otherwise, base the decision on the best info we have on the node.
is_node_relevant = IsHiddenTextNodeRelevantForAccessibility(
To<Text>(*node), is_display_locked);
}
}
}
bool is_layout_relevant =
layout_object && IsLayoutObjectRelevantForAccessibility(*layout_object);
// Prune if neither the LayoutObject nor Node are relevant.
if (!is_layout_relevant && !is_node_relevant)
return kPruneSubtree;
// If a node is not rendered, prune if it is in head/style/script or a DOM
// descendant of an iframe.
if (!is_layout_relevant && IsInPrunableHiddenContainerInclusive(
*node, parent_ax_known, is_display_locked)) {
return kPruneSubtree;
}
return is_layout_relevant ? kCreateFromLayout : kCreateFromNode;
}
const int kSizeMb = 1000000;
const int kSize10Mb = 10 * kSizeMb;
const int kSizeGb = 1000 * kSizeMb;
const int kBucketCount = 100;
void LogNodeDataSizeDistribution(
const ui::AXNodeData::AXNodeDataSize& node_data_size) {
UMA_HISTOGRAM_CUSTOM_COUNTS(
"Accessibility.Performance.AXObjectCacheImpl.Incremental.Int",
base::saturated_cast<int>(node_data_size.int_attribute_size), 1,
kSize10Mb, kBucketCount);
UMA_HISTOGRAM_CUSTOM_COUNTS(
"Accessibility.Performance.AXObjectCacheImpl.Incremental.Float",
base::saturated_cast<int>(node_data_size.float_attribute_size), 1,
kSize10Mb, kBucketCount);
UMA_HISTOGRAM_CUSTOM_COUNTS(
"Accessibility.Performance.AXObjectCacheImpl.Incremental.Bool",
base::saturated_cast<int>(node_data_size.bool_attribute_size), 1, kSizeMb,
kBucketCount);
UMA_HISTOGRAM_CUSTOM_COUNTS(
"Accessibility.Performance.AXObjectCacheImpl.Incremental.String",
base::saturated_cast<int>(node_data_size.string_attribute_size), 1,
kSizeGb, kBucketCount);
UMA_HISTOGRAM_CUSTOM_COUNTS(
"Accessibility.Performance.AXObjectCacheImpl.Incremental.IntList",
base::saturated_cast<int>(node_data_size.int_list_attribhute_size), 1,
kSize10Mb, kBucketCount);
UMA_HISTOGRAM_CUSTOM_COUNTS(
"Accessibility.Performance.AXObjectCacheImpl.Incremental.StringList",
base::saturated_cast<int>(node_data_size.string_list_attribute_size), 1,
kSizeGb, kBucketCount);
UMA_HISTOGRAM_CUSTOM_COUNTS(
"Accessibility.Performance.AXObjectCacheImpl.Incremental.HTML",
base::saturated_cast<int>(node_data_size.html_attribute_size), 1, kSizeGb,
kBucketCount);
UMA_HISTOGRAM_CUSTOM_COUNTS(
"Accessibility.Performance.AXObjectCacheImpl.Incremental.ChildIds",
base::saturated_cast<int>(node_data_size.child_ids_size), 1, kSize10Mb,
kBucketCount);
}
// Rreturns true if `layout_object`represent a text that is all white spaces and
// is all collapsed. This means that this object will not be accessed by an
// InlineCursor.
static bool IsAllCollapsedWhiteSpace(const LayoutObject& layout_object) {
if (const auto* layout_text = DynamicTo<LayoutText>(&layout_object)) {
if (layout_text->StyleRef().ShouldCollapseWhiteSpaces() &&
layout_text->TransformedText()
.IsAllSpecialCharacters<Character::IsCollapsibleSpace>()) {
return true;
}
}
return false;
}
// Returns the previous LayoutObject representing text that is in the same line
// as `layout_object`, nullptr if there are none. `layout_object`must be a child
// of `block_flow`.
LayoutObject* PreviousLayoutObjectTextOnLine(
const LayoutObject& layout_object,
const LayoutBlockFlow& block_flow) {
LayoutObject* previous = layout_object.PreviousInPreOrder(&block_flow);
while (previous) {
if (IsA<LayoutText>(previous)) {
InlineCursor cursor;
cursor.MoveToIncludingCulledInline(*previous);
while (cursor) {
if (cursor.Current()->IsInlineBox() ||
cursor.Current()->IsLineBreak()) {
return nullptr;
}
cursor.MoveToNextForSameLayoutObject();
}
return previous;
}
previous = previous->PreviousInPreOrder(&block_flow);
}
return nullptr;
}
} // namespace
#define DEBUG_STRING_CASE(ReasonName) \
case TreeUpdateReason::ReasonName: \
return #ReasonName
static std::string TreeUpdateReasonAsDebugString(
const TreeUpdateReason& reason) {
switch (reason) {
DEBUG_STRING_CASE(kActiveDescendantChanged);
DEBUG_STRING_CASE(kAriaExpandedChanged);
DEBUG_STRING_CASE(kAriaPressedChanged);
DEBUG_STRING_CASE(kAriaSelectedChanged);
DEBUG_STRING_CASE(kChildInserted);
DEBUG_STRING_CASE(kCSSAnchorChanged);
DEBUG_STRING_CASE(kDelayEventFromPostNotification);
DEBUG_STRING_CASE(kDidShowMenuListPopup);
DEBUG_STRING_CASE(kEditableTextContentChanged);
DEBUG_STRING_CASE(kFocusableChanged);
DEBUG_STRING_CASE(kIdChanged);
DEBUG_STRING_CASE(kMarkDocumentDirty);
DEBUG_STRING_CASE(kMaybeDisallowImplicitSelection);
DEBUG_STRING_CASE(kNewRelationTargetDirty);
DEBUG_STRING_CASE(kNodeIsAttached);
DEBUG_STRING_CASE(kNodeGainedFocus);
DEBUG_STRING_CASE(kNodeLostFocus);
DEBUG_STRING_CASE(kPostNotificationFromHandleLoadComplete);
DEBUG_STRING_CASE(kPostNotificationFromHandleLoadStart);
DEBUG_STRING_CASE(kPostNotificationFromHandleScrolledToAnchor);
DEBUG_STRING_CASE(kReferenceTargetChanged);
DEBUG_STRING_CASE(kRemoveValidationMessageObjectFromFocusedUIElement);
DEBUG_STRING_CASE(kRestoreParentOrPrune);
DEBUG_STRING_CASE(
kRemoveValidationMessageObjectFromValidationMessageObject);
DEBUG_STRING_CASE(kRoleChangeFromAriaHasPopup);
DEBUG_STRING_CASE(kRoleChangeFromImageMapName);
DEBUG_STRING_CASE(kRoleChangeFromRoleOrType);
DEBUG_STRING_CASE(kRoleMaybeChangedFromEventListener);
DEBUG_STRING_CASE(kRoleMaybeChangedFromHref);
DEBUG_STRING_CASE(kRoleMaybeChangedOnSelect);
DEBUG_STRING_CASE(kSectionOrRegionRoleMaybeChangedFromLabel);
DEBUG_STRING_CASE(kSectionOrRegionRoleMaybeChangedFromLabelledBy);
DEBUG_STRING_CASE(kSectionOrRegionRoleMaybeChangedFromTitle);
DEBUG_STRING_CASE(kTextChangedOnNode);
DEBUG_STRING_CASE(kTextChangedOnClosestNodeForLayoutObject);
DEBUG_STRING_CASE(kTextMarkerDataAdded);
DEBUG_STRING_CASE(kUpdateActiveMenuOption);
DEBUG_STRING_CASE(kUpdateAriaOwns);
DEBUG_STRING_CASE(kUpdateTableRole);
DEBUG_STRING_CASE(kUseMapAttributeChanged);
DEBUG_STRING_CASE(kValidationMessageVisibilityChanged);
DEBUG_STRING_CASE(kChildrenChanged);
DEBUG_STRING_CASE(kMarkAXObjectDirty);
DEBUG_STRING_CASE(kMarkAXSubtreeDirty);
DEBUG_STRING_CASE(kTextChangedOnLayoutObject);
}
NOTREACHED();
}
std::string AXObjectCacheImpl::TreeUpdateParams::ToString() {
std::ostringstream str;
str << "Tree update: " << TreeUpdateReasonAsDebugString(update_reason);
if (event != ax::mojom::blink::Event::kNone) {
str << " with event " << event;
}
return str.str();
}
// static
AXObjectCache* AXObjectCacheImpl::Create(Document& document,
const ui::AXMode& ax_mode,
bool for_snapshot_only) {
return MakeGarbageCollected<AXObjectCacheImpl>(document, ax_mode,
for_snapshot_only);
}
AXObjectCacheImpl::AXObjectCacheImpl(Document& document,
const ui::AXMode& ax_mode,
bool for_snapshot_only)
: document_(document),
#if DCHECK_IS_ON()
// TODO(accessibility): turn on the UI checker for devtools.
internal_ui_checker_on_(GetDocument().Url().Protocol() == "chrome"),
#else
internal_ui_checker_on_(false),
#endif
ax_mode_(ax_mode),
validation_message_axid_(0),
active_aria_modal_dialog_(nullptr),
render_accessibility_host_(document.GetExecutionContext()),
ax_tree_source_(BlinkAXTreeSource::Create(*this)),
for_snapshot_only_(for_snapshot_only) {
lifecycle_.AdvanceTo(AXObjectCacheLifecycle::kDeferTreeUpdates);
if (for_snapshot_only) {
// Inline text boxes are not supported in snapshots, as they are extra noise
// and expensive. If they are needed in the future, remove this line.
CHECK(!ax_mode.has_mode(ui::AXMode::kInlineTextBoxes));
}
}
AXObjectCacheImpl::~AXObjectCacheImpl() {
CHECK(HasBeenDisposed());
}
// This is called shortly before the AXObjectCache is deleted.
// The destruction of the AXObjectCache will do most of the cleanup.
void AXObjectCacheImpl::Dispose() {
lifecycle_.AdvanceTo(AXObjectCacheLifecycle::kDisposing);
// Detach all objects now. This prevents more work from occurring if we wait
// for the rendering engine to detach each node individually, because that
// will cause the renderer to attempt to potentially repair parents, and
// detach each child individually as Detach() calls ClearChildren().
for (auto& entry : objects_) {
AXObject* obj = entry.value;
obj->Detach();
}
// Destroy any pending task to serialize the tree.
weak_factory_for_serialization_pipeline_.Invalidate();
weak_factory_for_loc_updates_pipeline_.Invalidate();
lifecycle_.AdvanceTo(AXObjectCacheLifecycle::kDisposed);
}
void AXObjectCacheImpl::AddInspectorAgent(InspectorAccessibilityAgent* agent) {
agents_.insert(agent);
}
void AXObjectCacheImpl::RemoveInspectorAgent(
InspectorAccessibilityAgent* agent) {
agents_.erase(agent);
}
void AXObjectCacheImpl::EnsureRelationCacheAndInitialTree() {
if (!relation_cache_) {
relation_cache_ = std::make_unique<AXRelationCache>(this);
relation_cache_->Init();
// Build out initial tree so that AXObjects exist for
// AXRelationCache::ProcessUpdatesWithCleanLayout();
// Creating the root will cause its descendants to be created as well.
if (!Get(document_)) {
CreateAndInit(document_, document_->GetLayoutView(), nullptr);
}
}
}
void AXObjectCacheImpl::EnsureSerializer() {
if (!ax_tree_serializer_) {
ax_tree_serializer_ = std::make_unique<ui::AXTreeSerializer<
const AXObject*, HeapVector<Member<const AXObject>>, ui::AXTreeUpdate*,
ui::AXTreeData*, ui::AXNodeData>>(ax_tree_source_,
/*crash_on_error*/ true);
}
}
AXObject* AXObjectCacheImpl::Root() {
if (AXObject* root = Get(document_)) {
return root;
}
CommitAXUpdates(GetDocument(), /*force*/ true);
return Get(document_);
}
AXObject* AXObjectCacheImpl::ObjectFromAXID(AXID id) const {
auto it = objects_.find(id);
return it != objects_.end() ? it->value : nullptr;
}
AXObject* AXObjectCacheImpl::FirstObjectWithRole(ax::mojom::blink::Role role) {
const AXObject* root = Root();
if (!root || root->IsDetached()) {
return nullptr;
}
return root->FirstObjectWithRole(role);
}
Node* AXObjectCacheImpl::FocusedNode() const {
Node* focused_node = document_->FocusedElement();
if (!focused_node)
focused_node = document_;
// A popup is showing: return the focus within instead of the focus in the
// main document. Do not do this for HTML <select>, which has special
// focus manager using the kActiveDescendantId.
if (GetPopupDocumentIfShowing() && !IsA<HTMLSelectElement>(focused_node)) {
if (Node* focus_in_popup = GetPopupDocumentIfShowing()->FocusedElement())
return focus_in_popup;
}
return focused_node;
}
void AXObjectCacheImpl::UpdateLifecycleIfNeeded(Document& document) {
DCHECK(document.defaultView());
DCHECK(document.GetFrame());
DCHECK(document.View());
document.View()->UpdateAllLifecyclePhasesExceptPaint(
DocumentUpdateReason::kAccessibility);
}
void AXObjectCacheImpl::UpdateAXForAllDocuments() {
#if DCHECK_IS_ON()
DCHECK(!IsFrozen())
<< "Don't call UpdateAXForAllDocuments() here; layout and a11y are "
"already clean at the start of serialization.";
DCHECK(!updating_layout_and_ax_) << "Undesirable recursion.";
base::AutoReset<bool> updating(&updating_layout_and_ax_, true);
#endif
// First update the layout for the main and popup document.
UpdateLifecycleIfNeeded(GetDocument());
if (Document* popup_document = GetPopupDocumentIfShowing())
UpdateLifecycleIfNeeded(*popup_document);
// Next flush all accessibility events and dirty objects, for both the main
// and popup document, and update tree if needed.
if (IsDirty() || HasObjectsPendingSerialization()) {
CommitAXUpdates(GetDocument(), /*force*/ true);
}
}
AXObject* AXObjectCacheImpl::FocusedObject() const {
#if DCHECK_IS_ON()
DCHECK(GetDocument().Lifecycle().GetState() >=
DocumentLifecycle::kAfterPerformLayout);
if (GetPopupDocumentIfShowing()) {
DCHECK(GetPopupDocumentIfShowing()->Lifecycle().GetState() >=
DocumentLifecycle::kAfterPerformLayout);
}
#endif
AXObject* obj = Get(FocusedNode());
if (!obj) {
// In rare cases it's possible for the focus to not exist in the tree.
// An example would be a focused element inside of an image map that
// gets trimmed.
// In these cases, treat the focus as on the root object itself, so that
// AT users have some starting point.
DLOG(ERROR) << "The focus was not part of the a11y tree: " << FocusedNode();
return Get(document_);
}
// The HTML element, for example, is focusable but has an AX object that is
// not included in the tree.
if (!obj->IsIncludedInTree()) {
obj = obj->ParentObjectIncludedInTree();
}
return obj;
}
AXObject* AXObjectCacheImpl::EnsureFocusedObject() {
DCHECK(lifecycle_.StateAllowsImmediateTreeUpdates());
AXObject* obj = Get(FocusedNode());
if (obj) {
if (!obj->IsAriaHidden()) {
return obj;
}
// Repair illegal usage of aria-hidden: it should never contain the focus.
// The aria-hidden will be ignored when this occurs.
DiscardBadAriaHiddenBecauseOfFocus(*obj);
}
// Now return the focused object of its included in the tree, otherwise
// return an included ancestor of the focus.
obj = FocusedObject();
CHECK(obj) << "Object could not be recreated with aria-hidden off.";
CHECK(!obj->IsAriaHidden())
<< obj << "\nGet(FocusedNode()): " << Get(FocusedNode());
return obj;
}
const ui::AXMode& AXObjectCacheImpl::GetAXMode() const {
return ax_mode_;
}
void AXObjectCacheImpl::SetAXMode(const ui::AXMode& ax_mode) {
ax_mode_ = ax_mode;
}
bool AXObjectCacheImpl::IsScreenReaderActive() const {
return ax_mode_.has_mode(ui::AXMode::kScreenReader);
}
AXObject* AXObjectCacheImpl::Get(const LayoutObject* layout_object,
AXObject* parent_for_repair) const {
if (!layout_object)
return nullptr;
if (Node* node = layout_object->GetNode()) {
// If there is a node, it is preferred for backing the AXObject.
DCHECK(!layout_object_mapping_.Contains(layout_object));
return Get(node);
}
auto it_id = layout_object_mapping_.find(layout_object);
if (it_id == layout_object_mapping_.end()) {
return nullptr;
}
AXID ax_id = it_id->value;
DCHECK(!WTF::IsHashTraitsDeletedValue<HashTraits<AXID>>(ax_id));
auto it_result = objects_.find(ax_id);
AXObject* result = it_result != objects_.end() ? it_result->value : nullptr;
DCHECK(result) << "Had AXID for Node but no entry in objects_";
DCHECK(result->IsAXNodeObject());
// Do not allow detached objects except when disposing entire tree.
DCHECK(!result->IsDetached() || IsDisposing())
<< "Detached AXNodeObject in map: " << "AXID#" << ax_id
<< " LayoutObject=" << layout_object;
if (result->ParentObject()) {
DCHECK(!parent_for_repair || parent_for_repair == result->ParentObject())
<< "If there is both a previous parent, and a parent supplied for "
"repair, they must match.";
} else if (parent_for_repair) {
result->SetParent(parent_for_repair);
}
// If there is no node for the AXObject, then it is an anonymous layout
// object (e.g. a pseudo-element or object introduced to match the structure
// of content). Such objects can only be created or destroyed via creation of
// their parents and recursion via AddPseudoElementChildrenFromLayoutTree.
DCHECK(!result->IsMissingParent() || !result->GetNode())
<< "Had AXObject but is missing parent: " << layout_object << " "
<< result;
return result;
}
AXObject* AXObjectCacheImpl::Get(const Node* node) const {
if (!node)
return nullptr;
AXID node_id = static_cast<AXID>(DOMNodeIds::ExistingIdForNode(node));
if (!node_id) {
// An ID hasn't yet been generated for this DOM node, but ::CreateAndInit()
// will ensure a DOMNodeID is generated by using node->GetDomNodeId().
// Therefore if an id doesn't exist for a DOM node, it means that it can't
// have an associated AXObject.
return nullptr;
}
auto it_result = objects_.find(node_id);
if (it_result == objects_.end()) {
return nullptr;
}
AXObject* result = it_result->value;
DCHECK(result) << "AXID#" << node_id
<< " in map, but matches an AXObject of null, for " << node;
// When shutting down, allow detached nodes to be in the map, and do not
// attempt invalidations.
if (IsDisposing()) {
return result->IsDetached() ? nullptr : result;
}
DCHECK(!result->IsDetached()) << "Detached object was in map.";
return result;
}
AXObject* AXObjectCacheImpl::Get(
const LayoutObject* object,
AXBlockFlowIterator::FragmentIndex index) const {
if (!object) {
return nullptr;
}
auto iter = layout_object_to_inline_text_boxes_.find(object);
if (iter == layout_object_to_inline_text_boxes_.end()) {
return nullptr;
}
const AXInlineTextBoxFragmentMapping& mapping = iter->value;
const auto fragment_key = index - mapping.starting_index;
if (fragment_key >= mapping.ids.size()) {
// The AXInlineTextBox is already gone and its position in the vector does
// not even exist.
return nullptr;
}
AXID ax_id = mapping.ids[fragment_key];
if (!ax_id) {
// A 0-value indicates that this is pointing to a non-valid AXInlineTextBox.
return nullptr;
}
auto result_it = objects_.find(ax_id);
AXObject* result = result_it != objects_.end() ? result_it->value : nullptr;
#if DCHECK_IS_ON()
DCHECK(result) << "Had AXID for inline text box but no entry in objects_";
DCHECK(result->IsAXInlineTextBox());
// Do not allow detached objects except when disposing entire tree.
DCHECK(!result->IsDetached() || IsDisposing())
<< "Detached AXInlineTextBox in map: " << "AXID#" << ax_id;
#endif
return result;
}
AXObject* AXObjectCacheImpl::Get(AbstractInlineTextBox* inline_text_box) const {
if (!inline_text_box)
return nullptr;
auto it_ax = inline_text_box_object_mapping_.find(inline_text_box);
AXID ax_id =
it_ax != inline_text_box_object_mapping_.end() ? it_ax->value : 0;
if (!ax_id)
return nullptr;
DCHECK(!WTF::IsHashTraitsEmptyOrDeletedValue<HashTraits<AXID>>(ax_id));
auto it_result = objects_.find(ax_id);
AXObject* result = it_result != objects_.end() ? it_result->value : nullptr;
#if DCHECK_IS_ON()
DCHECK(result) << "Had AXID for inline text box but no entry in objects_";
DCHECK(result->IsAXInlineTextBox());
// Do not allow detached objects except when disposing entire tree.
DCHECK(!result->IsDetached() || IsDisposing())
<< "Detached AXInlineTextBox in map: " << "AXID#" << ax_id
<< " Node=" << inline_text_box->GetText();
#endif
return result;
}
AXObject* AXObjectCacheImpl::GetPositionedObjectForAnchor(const AXObject* obj) {
return relation_cache_->GetPositionedObjectForAnchor(obj);
}
AXObject* AXObjectCacheImpl::GetAnchorForPositionedObject(const AXObject* obj) {
return relation_cache_->GetAnchorForPositionedObject(obj);
}
AXObject* AXObjectCacheImpl::GetAXImageForMap(const HTMLMapElement& map) {
// Find first child node of <map> that has an AXObject and return it's
// parent, which should be a native image.
Node* child = NodeTraversal::FirstChild(map);
while (child) {
if (AXObject* ax_child = Get(child)) {
if (AXObject* ax_image = ax_child->ParentObject()) {
if (ax_image->IsDetached()) {
return nullptr;
}
DCHECK(IsA<HTMLImageElement>(ax_image->GetNode()))
<< "Expected image AX parent of <map>'s DOM child, got: "
<< ax_image->GetNode() << "\n* Map's DOM child was: " << child
<< "\n* ax_image: " << ax_image;
return ax_image;
}
}
child = NodeTraversal::NextSibling(*child);
}
return nullptr;
}
AXObject* AXObjectCacheImpl::CreateFromRenderer(LayoutObject* layout_object) {
Node* node = layout_object->GetNode();
// media element
if (node && node->IsMediaElement())
return AccessibilityMediaElement::Create(layout_object, *this);
if (node && node->IsMediaControlElement())
return AccessibilityMediaControl::Create(layout_object, *this);
if (auto* html_input_element = DynamicTo<HTMLInputElement>(node)) {
FormControlType type = html_input_element->FormControlType();
if (type == FormControlType::kInputRange) {
return MakeGarbageCollected<AXSlider>(layout_object, *this);
}
}
if (IsA<HTMLProgressElement>(node)) {
return MakeGarbageCollected<AXProgressIndicator>(layout_object, *this);
}
return MakeGarbageCollected<AXNodeObject>(layout_object, *this);
}
// static
bool AXObjectCacheImpl::IsRelevantSlotElement(const HTMLSlotElement& slot) {
DCHECK(AXObject::CanSafelyUseFlatTreeTraversalNow(slot.GetDocument()));
DCHECK(slot.SupportsAssignment());
if (slot.IsInUserAgentShadowRoot() &&
IsA<HTMLSelectElement>(slot.OwnerShadowHost())) {
if (RuntimeEnabledFeatures::CustomizableSelectEnabled()) {
if (slot.GetIdAttribute() ==
shadow_element_names::kSelectPopoverOptions) {
return true;
}
} else if (slot.GetIdAttribute() == shadow_element_names::kSelectOptions) {
return true;
}
}
// HasAssignedNodesNoRecalc() will return false when the slot is not in the
// flat tree. We must also return true when the slot has ordinary children
// (fallback content).
return slot.HasAssignedNodesNoRecalc() || slot.hasChildren();
}
// static
bool AXObjectCacheImpl::IsRelevantPseudoElement(const Node& node) {
DCHECK(node.IsPseudoElement());
std::optional<String> alt_text =
AXNodeObject::GetCSSAltText(To<Element>(&node));
if (alt_text && alt_text->empty()) {
return false;
}
if (!node.GetLayoutObject())
return false;
// ::before, ::after, ::marker, ::scroll-marker, ::scroll-*-buttons and
// ::scroll-marker-group are relevant. Allowing these pseudo elements ensures
// that all visible descendant pseudo content will be reached, despite only
// being able to walk layout inside of pseudo content. However, AXObjects
// aren't created for
// ::first-letter subtrees. The text of ::first-letter is already available in
// the child text node of the element that the CSS ::first letter applied to.
if (To<PseudoElement>(node).CanGenerateContent()) {
// By common convention it's the <select> itself that is
// clickable/accessible, not the ::picker-icon, which becomes redundant in
// the a11y tree.
if (node.IsPickerIconPseudoElement()) {
return false;
}
// option::checkmark is decorative and redundant with the checked state of
// the option element.
if (node.IsCheckPseudoElement()) {
return false;
}
// Scroll control pseudo elements are always relevant when they have a
// layout object (which is checked above).
if (node.IsScrollControlPseudoElement()) {
return true;
}
// Ignore non-inline whitespace content, which is used by many pages as
// a "Micro Clearfix Hack" to clear floats without extra HTML tags. See
// http://nicolasgallagher.com/micro-clearfix-hack/
if (node.GetLayoutObject()->IsInline())
return true; // Inline: not a clearfix hack.
if (!node.parentNode()->GetLayoutObject() ||
node.parentNode()->GetLayoutObject()->IsInline()) {
return true; // Parent inline: not a clearfix hack.
}
const ComputedStyle* style = node.GetLayoutObject()->Style();
DCHECK(style);
ContentData* content_data = style->GetContentData();
if (!content_data)
return true;
if (!content_data->IsText())
return true; // Not text: not a clearfix hack.
if (!To<TextContentData>(content_data)
->GetText()
.ContainsOnlyWhitespaceOrEmpty()) {
return true; // Not whitespace: not a clearfix hack.
}
return false; // Is the clearfix hack: ignore pseudo element.
}
// ::first-letter is relevant if and only if its parent layout object is a
// relevant pseudo element. If it's not a pseudo element, then this the
// ::first-letter text would end up being repeated in the AX Tree.
if (node.IsFirstLetterPseudoElement()) {
LayoutObject* layout_parent = node.GetLayoutObject()->Parent();
DCHECK(layout_parent);
Node* layout_parent_node = layout_parent->GetNode();
return layout_parent_node && layout_parent_node->IsPseudoElement() &&
IsRelevantPseudoElement(*layout_parent_node);
}
// The remaining possible pseudo element types are not relevant.
if (node.IsBackdropPseudoElement() || node.IsViewTransitionPseudoElement()) {
return false;
}
// If this is reached, then a new pseudo element type was added and is not
// yet handled by accessibility. See PseudoElementTagName() in
// pseudo_element.cc for all possible types.
SANITIZER_NOTREACHED() << "Unhandled type of pseudo element on: " << node;
return false;
}
// static
bool AXObjectCacheImpl::IsRelevantPseudoElementDescendant(
const LayoutObject& layout_object) {
if (layout_object.IsText() && To<LayoutText>(layout_object).HasEmptyText())
return false;
const LayoutObject* ancestor = &layout_object;
while (true) {
ancestor = ancestor->Parent();
if (!ancestor)
return false;
if (ancestor->IsPseudoElement()) {
// When an ancestor is exposed using CSS alt text, descendants are pruned.
if (AXNodeObject::GetCSSAltText(To<Element>(ancestor->GetNode()))) {
return false;
}
return IsRelevantPseudoElement(*ancestor->GetNode());
}
if (!ancestor->IsAnonymous())
return false;
}
}
AXObject* AXObjectCacheImpl::CreateFromNode(Node* node) {
if (auto* area = DynamicTo<HTMLAreaElement>(node))
return MakeGarbageCollected<AXImageMapLink>(area, *this);
return MakeGarbageCollected<AXNodeObject>(node, *this);
}
AXObject* AXObjectCacheImpl::CreateFromInlineTextBox(
AbstractInlineTextBox* inline_text_box) {
return MakeGarbageCollected<AXInlineTextBox>(inline_text_box, *this);
}
AXObject* AXObjectCacheImpl::CreateFromBlockFlowIterator(
AXBlockFlowIterator::FragmentIndex index) {
return MakeGarbageCollected<AXInlineTextBox>(index, *this);
}
AXObject* AXObjectCacheImpl::GetOrCreate(const Node* node, AXObject* parent) {
return GetOrCreate(const_cast<Node*>(node), parent);
}
AXObject* AXObjectCacheImpl::GetOrCreate(Node* node, AXObject* parent) {
CHECK(lifecycle_.StateAllowsImmediateTreeUpdates())
<< "Only create AXObjects while processing AX events and tree: " << node
<< " " << *this;
if (!node)
return nullptr;
CHECK(parent);
if (AXObject* obj = Get(node)) {
// The object already exists.
CHECK(!obj->IsDetached());
if (!obj->IsMissingParent()) {
return obj;
}
// The parent is provided when the object is being added to the parent.
// This is expected when re-adding a child to a parent via
// AXNodeObject::AddChildren(), as the parent on previous children
// will have been cleared immediately before re-adding any of them.
obj->SetParent(parent);
CHECK(!obj->IsMissingParent());
return obj;
}
return CreateAndInit(node, node->GetLayoutObject(), parent);
}
// Caller must provide a node, a layout object, or both (where they match).
AXObject* AXObjectCacheImpl::CreateAndInit(Node* node,
LayoutObject* layout_object,
AXObject* parent) {
// New AXObjects cannot be created when the tree is frozen.
// In this state, the tree should already be complete because
// of FinalizeTree().
CHECK(lifecycle_.StateAllowsImmediateTreeUpdates())
<< "Only create AXObjects while processing AX events and tree: " << node
<< " " << layout_object << " " << *this;
#if DCHECK_IS_ON()
DCHECK(node || layout_object);
DCHECK(!node || !layout_object || layout_object->GetNode() == node);
DCHECK(parent || node == document_);
DCHECK(!parent || parent->CanHaveChildren());
DCHECK(GetDocument().Lifecycle().GetState() >=
DocumentLifecycle::kAfterPerformLayout)
<< "Unclean document at lifecycle "
<< GetDocument().Lifecycle().ToString();
#endif // DCHECK_IS_ON()
if (IsA<Document>(node) && parent) {
// Root of a popup document:
if (IsA<HTMLSelectElement>(parent->GetNode())) {
// HTML <select> has a popup that duplicates nodes from the main
// document, and therefore we ignore that popup and any nodes in it.
return nullptr;
}
if (!GetPopupDocumentIfShowing()) {
// The popup document is either not showing yet, or is no longer showing.
return nullptr;
}
// All other document nodes with a parent must match the current popup.
CHECK_EQ(node, GetPopupDocumentIfShowing());
}
// Determine the type of accessibility object to be created.
AXObjectType ax_type =
DetermineAXObjectType(node, layout_object, GetAXMode(), parent);
if (ax_type == kPruneSubtree) {
return nullptr;
}
#if DCHECK_IS_ON()
if (node) {
DCHECK(layout_object || ax_type != kCreateFromLayout);
DCHECK(node->isConnected());
DCHECK(node->GetDocument().GetFrame())
<< "Creating AXObject in a dead document: " << node;
DCHECK(node->IsElementNode() || node->IsTextNode() ||
node->IsDocumentNode())
<< "Should only attempt to create AXObjects for the following types of "
"node types: document, element and text."
<< "\n* Node is: " << node;
} else {
// No node: will create an AXNodeObject using the LayoutObject.
DCHECK(layout_object->GetDocument().GetFrame())
<< "Creating AXObject in a dead document: " << layout_object;
DCHECK_EQ(ax_type, kCreateFromLayout);
DCHECK(!IsA<LayoutView>(layout_object))
<< "AXObject for document is always created with a node.";
}
#endif
// If there is a DOM node, use its dom_node_id, otherwise, generate an AXID.
// The dom_node_id can be used even if there is also a layout object.
AXID axid;
if (node) {
axid = static_cast<AXID>(node->GetDomNodeId());
if (ax_tree_serializer_) {
// In the case where axid is being reused, because a previous AXObject
// existed for the same node, ensure that the serializer sees it as new.
ax_tree_serializer_->MarkNodeDirty(axid);
}
} else {
axid = GenerateAXID();
}
DCHECK(!base::Contains(objects_, axid));
// Create the new AXObject.
AXObject* new_obj = nullptr;
if (ax_type == kCreateFromLayout) {
// Prefer to create from renderer if there is a layout object because
// AXLayoutObjects can provide information about bounding boxes.
if (!node) {
DCHECK(!layout_object_mapping_.Contains(layout_object))
<< "Already have an AXObject for " << layout_object;
layout_object_mapping_.Set(layout_object, axid);
}
new_obj = CreateFromRenderer(layout_object);
} else {
new_obj = CreateFromNode(node);
}
DCHECK(new_obj) << "Could not create AXObject.";
// Give the AXObject its ID and initialize.
AssociateAXID(new_obj, axid);
new_obj->Init(parent);
MaybeDisallowImplicitSelectionWithCleanLayout(new_obj);
#if AX_FAIL_FAST_BUILD()
Element* element = DynamicTo<Element>(node);
if (element && !element->IsPseudoElement()) {
// Ensure that the relation cache is properly initialized with information
// from this element.
relation_cache_->CheckRelationsCached(*element);
}
#endif
// Eagerly fill out new subtrees.
new_obj->UpdateChildrenIfNecessary();
return new_obj;
}
AXObject* AXObjectCacheImpl::GetOrCreate(LayoutObject* layout_object,
AXObject* parent) {
CHECK(lifecycle_.StateAllowsImmediateTreeUpdates())
<< layout_object << " " << *this;
CHECK(parent);
if (!layout_object)
return nullptr;
if (AXObject* obj = Get(layout_object, parent)) {
return obj;
}
return CreateAndInit(layout_object->GetNode(), layout_object, parent);
}
AXObject* AXObjectCacheImpl::GetOrCreate(
AXBlockFlowIterator::FragmentIndex index,
AXObject* parent) {
CHECK(lifecycle_.StateAllowsImmediateTreeUpdates());
CHECK(parent);
CHECK(parent->GetLayoutObject());
// Inline textboxes are included if and only if the parent is unignored.
// If the parent is ignored but included in tree, the inline textbox is
// still withheld.
if (parent->IsIgnored() || !parent->GetLayoutObject()) {
return nullptr;
}
if (AXObject* obj = Get(parent->GetLayoutObject(), index)) {
#if DCHECK_IS_ON()
DCHECK(!obj->IsDetached())
<< "AXObject for inline text box should not be detached: " << obj;
// AXInlineTextbox objects can't get a new parent, unlike other types of
// accessible objects that can get a new parent because they moved or
// because of aria-owns.
// AXInlineTextbox objects are only added via AddChildren() on static text
// or line break parents. The children are cleared, and detached from their
// parent before AddChildren() executes. There should be no previous parent.
DCHECK(parent->RoleValue() == ax::mojom::blink::Role::kStaticText ||
parent->RoleValue() == ax::mojom::blink::Role::kLineBreak);
DCHECK(!obj->ParentObject() || obj->ParentObject() == parent)
<< "Mismatched old and new parent:" << "\n* Old parent: "
<< obj->ParentObject() << "\n* New parent: " << parent;
DCHECK(ui::CanHaveInlineTextBoxChildren(parent->RoleValue()))
<< "Unexpected parent of inline text box: " << parent->RoleValue();
#endif
CHECK(obj->ParentObject() == parent);
return obj;
}
if (IsFrozen()) {
return nullptr;
}
Member<AXObject> new_obj = CreateFromBlockFlowIterator(index);
AXID ax_id = AssociateAXID(new_obj);
// If the value already exists, this returns an iterator to the mapping with
// where the id is stored.
auto result = layout_object_to_inline_text_boxes_.insert(
parent->GetLayoutObject(), AXInlineTextBoxFragmentMapping());
AXInlineTextBoxFragmentMapping& mapping = result.stored_value->value;
if (result.is_new_entry) {
mapping.starting_index = index;
mapping.ids.reserve(2);
mapping.ids.push_back(ax_id);
} else {
DCHECK(index > mapping.starting_index)
<< "The first fragment must be the one creating this mapping, since "
"they "
"are created in sequence.";
const auto fragment_key = index - mapping.starting_index;
// Initialize up to `fragment_key`, so we can access it below.
for (wtf_size_t i = mapping.ids.size(); i <= fragment_key; ++i) {
mapping.ids.push_back(kMissingAXId);
}
mapping.ids[fragment_key] = ax_id;
}
mapping.size++;
new_obj->Init(parent);
return new_obj;
}
AXObject* AXObjectCacheImpl::GetOrCreate(AbstractInlineTextBox* inline_text_box,
AXObject* parent) {
CHECK(lifecycle_.StateAllowsImmediateTreeUpdates())
<< "Only create AXObjects while processing AX events and tree." << *this;
if (!inline_text_box)
return nullptr;
if (!parent) {
LayoutText* layout_text_parent = inline_text_box->GetLayoutText();
DCHECK(layout_text_parent);
parent = Get(layout_text_parent);
if (!parent) {
DCHECK(inline_text_box->GetText().ContainsOnlyWhitespaceOrEmpty() ||
IsFrozen() ||
!IsRelevantPseudoElementDescendant(*layout_text_parent))
<< "No parent for non-whitespace inline textbox: "
<< layout_text_parent
<< "\nParent of parent: " << layout_text_parent->Parent();
return nullptr;
}
}
// Inline textboxes are included if and only if the parent is unignored.
// If the parent is ignored but included in tree, the inline textbox is
// still withheld.
if (parent->IsIgnored()) {
return nullptr;
}
if (AXObject* obj = Get(inline_text_box)) {
#if DCHECK_IS_ON()
DCHECK(!obj->IsDetached())
<< "AXObject for inline text box should not be detached: " << obj;
// AXInlineTextbox objects can't get a new parent, unlike other types of
// accessible objects that can get a new parent because they moved or
// because of aria-owns.
// AXInlineTextbox objects are only added via AddChildren() on static text
// or line break parents. The children are cleared, and detached from their
// parent before AddChildren() executes. There should be no previous parent.
DCHECK(parent->RoleValue() == ax::mojom::blink::Role::kStaticText ||
parent->RoleValue() == ax::mojom::blink::Role::kLineBreak);
DCHECK(!obj->ParentObject() || obj->ParentObject() == parent)
<< "Mismatched old and new parent:" << "\n* Old parent: "
<< obj->ParentObject() << "\n* New parent: " << parent;
DCHECK(ui::CanHaveInlineTextBoxChildren(parent->RoleValue()))
<< "Unexpected parent of inline text box: " << parent->RoleValue();
#endif
DCHECK(obj->ParentObject() == parent);
return obj;
}
// New AXObjects cannot be created when the tree is frozen.
if (IsFrozen()) {
return nullptr;
}
AXObject* new_obj = CreateFromInlineTextBox(inline_text_box);
AXID axid = AssociateAXID(new_obj);
inline_text_box_object_mapping_.Set(inline_text_box, axid);
new_obj->Init(parent);
return new_obj;
}
void AXObjectCacheImpl::Remove(AXObject* object, bool notify_parent) {
DCHECK(object);
if (object->IsAXInlineTextBox()) {
if (::features::IsAccessibilityBlockFlowIteratorEnabled()) {
Remove(object->ParentObject()->GetLayoutObject(),
object->GetFragmentIndex().value(), notify_parent);
} else {
Remove(object->GetInlineTextBox(), notify_parent);
}
} else if (object->GetNode()) {
Remove(object->GetNode(), notify_parent);
} else if (object->GetLayoutObject()) {
Remove(object->GetLayoutObject(), notify_parent);
} else {
Remove(object->AXObjectID(), notify_parent);
}
}
// This is safe to call even if there isn't a current mapping.
// This is called by other Remove() methods, called by Blink for DOM and layout
// changes, iterating over all removed content in the subtree:
// - When a DOM subtree is removed, it is called with the root node first, and
// then descending down into the subtree.
// - When layout for a subtree is detached, it is called on layout objects,
// starting with leaves and moving upward, ending with the subtree root.
void AXObjectCacheImpl::Remove(AXID ax_id, bool notify_parent) {
CHECK(lifecycle_.StateAllowsRemovingAXObjects()) << *this;
if (!ax_id)
return;
// First, fetch object to operate some cleanup functions on it.
auto it = objects_.find(ax_id);
AXObject* obj = it != objects_.end() ? it->value : nullptr;
if (!obj)
return;
#if AX_FAIL_FAST_BUILD()
if (obj->CachedIsIncludedInTree()) {
--included_node_count_;
}
#endif
if (!IsDisposing() && !HasBeenDisposed()) {
if (notify_parent && !obj->IsMissingParent()) {
ChildrenChangedOnAncestorOf(obj);
}
// TODO(aleventhal) This is for web tests only, in order to record MarkDirty
// events. Is there a way to avoid these calls for normal browsing?
// Maybe we should use dependency injection from AccessibilityController.
if (auto* client = GetWebLocalFrameClient()) {
client->HandleAXObjectDetachedForTest(ax_id);
}
}
// Remove references to AXID before detaching, so that nothing will retrieve a
// detached object, which is illegal.
RemoveReferencesToAXID(ax_id);
// RemoveReferencesToAXID can cause the object to detach, in this case,
// fail gracefully rather than attempting to double detach.
DUMP_WILL_BE_CHECK(!obj->IsDetached()) << obj;
if (obj->IsDetached()) {
// TODO(accessibility): Remove early return and change above assertion
// to CHECK() once this no longer occurs.
return;
}
obj->Detach();
// Remove the object.
// TODO(accessibility) We don't use the return value, can we use .erase()
// and it will still make sure that the object is cleaned up?
objects_.Take(ax_id);
// Removing an aria-modal dialog can affect the entire tree.
if (active_aria_modal_dialog_ &&
active_aria_modal_dialog_ == obj->GetElement()) {
Settings* settings = GetSettings();
if (settings && settings->GetAriaModalPrunesAXTree()) {
MarkDocumentDirty();
}
active_aria_modal_dialog_ = nullptr;
}
#if AX_FAIL_FAST_BUILD()
DCHECK(!nodes_requiring_cache_update_.Contains(ax_id));
#endif
}
void AXObjectCacheImpl::Remove(LayoutObject* layout_object,
bool notify_parent) {
CHECK(layout_object);
if (IsA<LayoutView>(layout_object)) {
// A document is being destroyed.
// This code is only reached when it is a popup being destroyed.
// TODO(accessibility) Can we remove this case since Blink calls
// RemovePopup(document) for us?
DCHECK(!popup_document_ ||
popup_document_ == &layout_object->GetDocument());
// Popup has been destroyed.
if (popup_document_) {
RemovePopup(popup_document_);
}
}
// If a DOM node is present, it will have been used to back the AXObject, in
// which case we need to call Remove(node) instead.
if (Node* node = layout_object->GetNode()) {
// Pseudo elements are a special case. The entire subtree needs to be marked
// dirty so that it is recomputed (it is disappearing or changing).
if (node->IsPseudoElement()) {
MarkSubtreeDirty(node);
}
if (IsA<HTMLImageElement>(node)) {
// If an image is removed, ensure its entire subtree is deleted as there
// may have been children supplied via a map.
if (auto* layout_image =
DynamicTo<LayoutImage>(node->GetLayoutObject())) {
if (auto* map = layout_image->ImageMap()) {
if (map->ImageElement() == node) {
RemoveSubtree(map, /*remove_root*/ false);
}
}
}
}
Remove(node, notify_parent);
return;
}
auto iter = layout_object_mapping_.find(layout_object);
if (iter == layout_object_mapping_.end())
return;
AXID ax_id = iter->value;
DCHECK(ax_id);
layout_object_mapping_.erase(iter);
Remove(ax_id, false);
}
// This is safe to call even if there isn't a current mapping.
void AXObjectCacheImpl::Remove(Node* node) {
// Ensure that our plugin serializer, if it exists, is properly
// reset. Paired with AXNodeObject::Detach.
if (IsA<HTMLEmbedElement>(node)) {
ResetPluginTreeSerializer();
}
Remove(node, /* notify_parent */ true);
}
void AXObjectCacheImpl::Remove(Node* node, bool notify_parent) {
DCHECK(node);
LayoutObject* layout_object = node->GetLayoutObject();
DCHECK(!layout_object || layout_object_mapping_.find(layout_object) ==
layout_object_mapping_.end())
<< "AXObject cannot be backed by both a layout object and node.";
AXID axid = node->GetDomNodeId();
if (node == active_aria_modal_dialog_ &&
lifecycle_.StateAllowsAXObjectsToBeDirtied()) {
UpdateActiveAriaModalDialog(FocusedNode());
}
DCHECK_GE(axid, 1);
Remove(axid, notify_parent);
}
void AXObjectCacheImpl::RemovePopup(Document* popup_document) {
// The only 2 documents that partake in the cache are the main document and
// the popup document. This method is only be called for the popup document,
// because if the main document is shutting down, the cache is disposed.
DCHECK(popup_document);
// This can be called even when GetPopupDocumentIfShowing() when the popup
// is from a <select size=1>, and in order to avoid duplicate objects, which
// treat that situations as if there is no popup showing.
if (!GetPopupDocumentIfShowing()) {
return;
}
DCHECK(IsPopup(*popup_document)) << "Use Dispose() to remove main document.";
RemoveSubtree(popup_document);
popup_document_ = nullptr;
pending_events_to_serialize_.clear();
tree_update_callback_queue_popup_.clear();
}
// This is safe to call even if there isn't a current mapping.
void AXObjectCacheImpl::Remove(AbstractInlineTextBox* inline_text_box) {
Remove(inline_text_box, /* notify_parent */ true);
}
void AXObjectCacheImpl::Remove(const LayoutObject* object,
AXBlockFlowIterator::FragmentIndex index,
bool notify_parent) {
if (!object) {
return;
}
auto iter = layout_object_to_inline_text_boxes_.find(object);
if (iter == layout_object_to_inline_text_boxes_.end()) {
return;
}
AXInlineTextBoxFragmentMapping& mapping = iter->value;
const auto fragment_key = index - mapping.starting_index;
AXID ax_id = mapping.ids[fragment_key];
mapping.ids[fragment_key] = 0;
mapping.size--;
if (mapping.size == 0) {
// This layout object has no more fragments it points to.
layout_object_to_inline_text_boxes_.erase(iter);
}
Remove(ax_id, notify_parent);
}
void AXObjectCacheImpl::Remove(AbstractInlineTextBox* inline_text_box,
bool notify_parent) {
if (!inline_text_box)
return;
auto iter = inline_text_box_object_mapping_.find(inline_text_box);
if (iter == inline_text_box_object_mapping_.end())
return;
AXID ax_id = iter->value;
inline_text_box_object_mapping_.erase(iter);
Remove(ax_id, notify_parent);
}
void AXObjectCacheImpl::RemoveIncludedSubtree(AXObject* object,
bool remove_root) {
DCHECK(object);
if (object->IsDetached()) {
return;
}
for (const auto& ax_child : object->CachedChildrenIncludingIgnored()) {
RemoveIncludedSubtree(ax_child, /* remove_root */ true);
}
if (remove_root) {
Remove(object, /* notify_parent */ false);
}
}
void AXObjectCacheImpl::RemoveAXObjectsInLayoutSubtree(
LayoutObject* subtree_root) {
Remove(subtree_root, /*notify_parent*/ true);
LayoutObject* iter = subtree_root;
while ((iter = iter->NextInPreOrder(subtree_root)) != nullptr) {
Remove(iter, /*notify_parent*/ false);
}
}
void AXObjectCacheImpl::RemoveSubtree(const Node* node, bool remove_root) {
if (!node || !node->isConnected()) {
return;
}
RemoveSubtree(node, remove_root, /*notify_parent*/ true);
}
void AXObjectCacheImpl::RemoveSubtree(const Node* node) {
RemoveSubtree(node, /*remove_root*/ true);
}
void AXObjectCacheImpl::RemoveSubtree(const Node* node,
bool remove_root,
bool notify_parent) {
DCHECK(node);
AXObject* object = Get(node);
if (!object && !remove_root) {
// Nothing remaining to do for this subtree. Already removed.
return;
}
if (const HTMLMapElement* map_element = DynamicTo<HTMLMapElement>(node)) {
// If this node is an image map, it is necessary to notify the <img> node
// associated with this map that its children will be deleted. The a11y tree
// will add the children of the image map as children of the image itself
// (see AXNodeObject::AddImageMapChildren for more details). However, the
// dom node traversal below would delete these children without notifying
// their parent that children will change, so this special check here is a
// must. For all other cases, this is not necessary because the parent is
// part of the subtree removal or will be notified via notify_parent defined
// above.
if (AXObject* image_ax_object = GetAXImageForMap(*map_element)) {
// Note here that an image will only be returned if the map has children
// and at least one of them points to an image, so it is guaranteed that
// we are not notifying a parent if children are not being removed.
// **important**: this call must come before the node traversal remove
// below since that could remove a child which would cause it to not point
// to its image parent, making it impossible to notify the parent.
NotifyParentChildrenChanged(image_ax_object);
}
}
// Remove children found through dom traversal.
for (Node* child_node = NodeTraversal::FirstChild(*node); child_node;
child_node = NodeTraversal::NextSibling(*child_node)) {
RemoveSubtree(child_node, /* remove_root */ true,
/* notify_parent */ false);
}
if (!object) {
return;
}
// When removing children, use the cached children to avoid creating a child
// just to destroy it.
for (AXObject* ax_included_child : object->CachedChildrenIncludingIgnored()) {
if (ax_included_child->ParentObjectIfPresent() != object) {
continue;
}
if (ui::CanHaveInlineTextBoxChildren(object->RoleValue())) {
// Just remove child inline textboxes, don't use their node which is the
// same as that static text's parent and would cause an infinite loop.
Remove(ax_included_child, /* notify_parent */ false);
} else if (ax_included_child->GetNode()) {
DCHECK(ax_included_child->GetNode() != node);
RemoveSubtree(ax_included_child->GetNode(),
/* remove_root */ true,
/* notify_parent */ false);
} else {
RemoveIncludedSubtree(ax_included_child, /* remove_root */ true);
}
}
// The code below uses ChildrenChangedWithCleanLayout() instead of
// notify_parent param in Remove(), which would be queued, and it needs to
// happen immediately.
AXObject* parent_to_notify = nullptr;
if (notify_parent) {
// Find the parent to notify:
// If the root is being removed, then it's the root's parent.
// If the root isn't being removed, its child subtrees are being removed,
// and thus the root itself is the parent who's children are changing.
parent_to_notify = remove_root ? object->ParentObjectIfPresent() : object;
}
if (remove_root) {
Remove(object, /* notify_parent */ false);
}
if (parent_to_notify) {
NotifyParentChildrenChanged(parent_to_notify);
}
}
// All generated AXIDs are negative, ranging from kFirstGeneratedRendererNodeID
// to kLastGeneratedRendererNodeID, in order to avoid conflict with the ids
// reused from dom_node_ids, which are positive, and generated IDs on the
// browser side, which are negative, starting at -1.
AXID AXObjectCacheImpl::GenerateAXID() const {
// The first id is close to INT_MIN/2, leaving plenty of room for negative
// generated IDs both here and on the browser side, but starting at an even
// number makes it easier to read when debugging.
static AXID last_used_id = ui::kFirstGeneratedRendererNodeID;
// Generate a new ID.
AXID obj_id = last_used_id;
do {
if (--obj_id == ui::kLastGeneratedRendererNodeID) {
// This is very unlikely to happen, but if we find that it happens, we
// could gracefully turn off a11y instead of crashing the renderer.
CHECK(!has_axid_generator_looped_)
<< "Not enough room more generated accessibility objects.";
has_axid_generator_looped_ = true;
obj_id = ui::kFirstGeneratedRendererNodeID;
}
} while (has_axid_generator_looped_ && objects_.Contains(obj_id));
DCHECK(!WTF::IsHashTraitsEmptyOrDeletedValue<HashTraits<AXID>>(obj_id));
last_used_id = obj_id;
return obj_id;
}
void AXObjectCacheImpl::AddToFixedOrStickyNodeList(const AXObject* object) {
DCHECK(object);
DCHECK(!object->IsDetached());
fixed_or_sticky_node_ids_.insert(object->AXObjectID());
}
AXID AXObjectCacheImpl::AssociateAXID(AXObject* obj, AXID use_axid) {
// Check for already-assigned ID.
DCHECK(!obj->AXObjectID()) << "Object should not already have an AXID";
AXID new_axid = use_axid ? use_axid : GenerateAXID();
bool should_have_node_id = obj->IsAXNodeObject() && obj->GetNode();
DCHECK_EQ(should_have_node_id, IsDOMNodeID(new_axid))
<< "An AXID is also a DOMNodeID (positive integer) if any only if the "
"AXObject is an AXNodeObject with a DOM node.";
obj->SetAXObjectID(new_axid);
objects_.Set(new_axid, obj);
return new_axid;
}
void AXObjectCacheImpl::RemoveReferencesToAXID(AXID obj_id) {
DCHECK(!WTF::IsHashTraitsDeletedValue<HashTraits<AXID>>(obj_id));
// Clear AXIDs from maps. Note: do not need to erase id from
// changed_bounds_ids_, a set which is cleared each time
// SerializeLocationChanges() is finished. Also, do not need to erase id from
// invalidated_ids_main_ or invalidated_ids_popup_, which are cleared each
// time ProcessInvalidatedObjects() finishes, and having extra ids in those
// sets is not harmful.
cached_bounding_boxes_.erase(obj_id);
ax_id_to_explicit_bounds_.erase(obj_id);
if (IsDOMNodeID(obj_id)) {
// Optimization: these maps only contain ids for AXObjects with a DOM node.
fixed_or_sticky_node_ids_.erase(obj_id);
// Only objects with a DOM node can be in the relation cache.
if (relation_cache_) {
relation_cache_->RemoveAXID(obj_id);
}
// Allow the new AXObject for the same node to be serialized correctly.
nodes_with_pending_children_changed_.erase(obj_id);
} else {
// Non-DOM ids should never find their way into these maps.
DCHECK(!fixed_or_sticky_node_ids_.Contains(obj_id));
DCHECK(!nodes_with_pending_children_changed_.Contains(obj_id));
}
if (GetAXMode().HasFilterFlags(ui::AXMode::kOnScreenOnly)) {
extra_off_screen_nodes_to_serialize_.erase(obj_id);
}
}
AXObject* AXObjectCacheImpl::NearestExistingAncestor(Node* node) {
// Find the nearest ancestor that already has an accessibility object, since
// we might be in the middle of a layout.
while (node) {
if (AXObject* obj = Get(node))
return obj;
node = node->parentNode();
}
return nullptr;
}
void AXObjectCacheImpl::UpdateNumTreeUpdatesQueuedBeforeLayoutHistogram() {
UMA_HISTOGRAM_COUNTS_100000(
"Blink.Accessibility.NumTreeUpdatesQueuedBeforeLayout",
tree_update_callback_queue_main_.size() +
tree_update_callback_queue_popup_.size());
}
void AXObjectCacheImpl::InvalidateBoundingBoxForFixedOrStickyPosition() {
for (AXID id : fixed_or_sticky_node_ids_)
InvalidateBoundingBox(id);
}
bool AXObjectCacheImpl::CanDeferTreeUpdate(Document* tree_update_document) {
DCHECK(lifecycle_.StateAllowsDeferTreeUpdates()) << *this;
DCHECK(!IsFrozen());
if (!IsActive(GetDocument()) || tree_updates_paused_)
return false;
// Ensure the tree update document is in a good state.
if (!tree_update_document || !IsActive(*tree_update_document)) {
return false;
}
if (tree_update_document != document_) {
// If the popup_document_ is null, throw this tree update away, because:
// - Updates that occur BEFORE the popup is tracked in a11y don't matter,
// as we will build the entire popup's AXObject subtree once we are
// notified about the popup.
// - Updates that occur AFTER the popup is no longer tracked could occur
// while the popup is currently closing, in which case the updates are no
// longer useful.
if (!popup_document_) {
return false;
}
// If we are queuing an update to a document other than the main document,
// then it must be in an active popup document. The cache would never
// receive notifications from other documents.
DUMP_WILL_BE_CHECK_EQ(tree_update_document, popup_document_)
<< "Update in non-main, non-popup document: "
<< tree_update_document->Url().GetString();
}
return true;
}
bool AXObjectCacheImpl::PauseTreeUpdatesIfQueueFull() {
// Check the main document's queue. If there are too many entries, pause all
// updates and resume later after rebuilding the tree from scratch.
// Popup is excluded because it's controlled by us and will not have too many
// updates. In the case of a web page having too many updates, we need to
// clear all queues, including the popup's.
if (tree_update_callback_queue_main_.size() >= max_pending_updates_) {
UpdateNumTreeUpdatesQueuedBeforeLayoutHistogram();
tree_updates_paused_ = true;
LOG(INFO) << "Accessibility tree update queue is too big, updates have "
"been paused";
// Clear updates from both documents.
tree_update_callback_queue_main_.clear();
tree_update_callback_queue_popup_.clear();
pending_events_to_serialize_.clear();
return true;
}
return false;
}
void AXObjectCacheImpl::DeferTreeUpdate(TreeUpdateReason update_reason,
Node* node,
ax::mojom::blink::Event event) {
CHECK(node);
CHECK(lifecycle_.StateAllowsDeferTreeUpdates()) << *this;
Document& tree_update_document = node->GetDocument();
if (!CanDeferTreeUpdate(&tree_update_document)) {
return;
}
if (PauseTreeUpdatesIfQueueFull()) {
return;
}
TreeUpdateCallbackQueue& queue =
GetTreeUpdateCallbackQueue(tree_update_document);
TreeUpdateParams* tree_update = MakeGarbageCollected<TreeUpdateParams>(
node, 0u, ComputeEventFrom(), active_event_from_action_,
ActiveEventIntents(), update_reason, event);
queue.push_back(tree_update);
if (AXObject* obj = Get(node)) {
obj->InvalidateCachedValues(update_reason);
}
// These events are fired during RunPostLifecycleTasks(),
// ensure there is a document lifecycle update scheduled.
if (IsImmediateProcessingRequired(tree_update)) {
// Ensure that processing of tree updates occurs immediately in cases
// where a user action such as focus or selection occurs, so that the user
// gets immediate feedback.
ScheduleImmediateSerialization();
} else {
// Otherwise, batch updates to improve performance.
ScheduleAXUpdate();
}
}
void AXObjectCacheImpl::DeferTreeUpdate(TreeUpdateReason update_reason,
AXObject* obj,
ax::mojom::blink::Event event,
bool invalidate_cached_values) {
// Called for updates that do not have a DOM node, e.g. a children or text
// changed event that occurs on an anonymous layout block flow.
CHECK(obj);
CHECK(lifecycle_.StateAllowsDeferTreeUpdates()) << *this;
if (obj->IsDetached()) {
return;
}
CHECK(obj->AXObjectID());
Document* tree_update_document = obj->GetDocument();
if (!CanDeferTreeUpdate(tree_update_document)) {
return;
}
if (PauseTreeUpdatesIfQueueFull()) {
return;
}
TreeUpdateCallbackQueue& queue =
GetTreeUpdateCallbackQueue(*tree_update_document);
queue.push_back(MakeGarbageCollected<TreeUpdateParams>(
nullptr, obj->AXObjectID(), ComputeEventFrom(), active_event_from_action_,
ActiveEventIntents(), update_reason, event));
if (invalidate_cached_values) {
obj->InvalidateCachedValues(update_reason);
}
// These events are fired during RunPostLifecycleTasks(),
// ensure there is a document lifecycle update scheduled.
ScheduleAXUpdate();
}
void AXObjectCacheImpl::SelectionChanged(Node* node) {
if (!node)
return;
PostNotification(&GetDocument(),
ax::mojom::blink::Event::kDocumentSelectionChanged);
// If there is a text control, mark it dirty to serialize
// IntAttribute::kTextSelStart/kTextSelEnd changes.
// TODO(accessibility) Remove once we remove kTextSelStart/kTextSelEnd.
if (TextControlElement* text_control = EnclosingTextControl(node))
MarkElementDirty(text_control);
}
void AXObjectCacheImpl::StyleChanged(const LayoutObject* layout_object,
bool visibility_or_inertness_changed) {
DCHECK(layout_object);
SCOPED_DISALLOW_LIFECYCLE_TRANSITION();
AXObject* ax_object = Get(layout_object->GetNode());
if (!ax_object) {
// No object exists to mark dirty yet -- there can sometimes be a layout in
// the initial empty document, or style has changed before the object cache
// becomes aware that the node exists. It's too early for the style change
// to be useful.
return;
}
if (visibility_or_inertness_changed) {
ChildrenChanged(ax_object);
ChildrenChanged(ax_object->ParentObject());
}
MarkAXObjectDirty(ax_object);
}
void AXObjectCacheImpl::ClearBlockFlowCachedData(const LayoutObject* object) {
if (!::features::IsAccessibilityBlockFlowIteratorEnabled()) {
return;
}
if (!object) {
return;
}
const LayoutBlockFlow* block_flow = object->FragmentItemsContainer();
if (block_flow) {
auto it = block_flow_data_cache_.find(block_flow);
if (it != block_flow_data_cache_.end()) {
block_flow_data_cache_.erase(it);
}
}
// Remove each of the AxInlineTextBox associated with this object.
AXObject* ax_object = Get(object);
if (!ax_object) {
return;
}
for (auto& child : ax_object->CachedChildrenIncludingIgnored()) {
if (child->IsAXInlineTextBox() && child->GetFragmentIndex()) {
Remove(object, child->GetFragmentIndex().value(), /*notify_parent=*/true);
}
}
}
void AXObjectCacheImpl::CSSAnchorChanged(const LayoutObject* positioned_obj) {
if (Node* node = positioned_obj->GetNode()) {
DeferTreeUpdate(TreeUpdateReason::kCSSAnchorChanged, node);
}
}
void AXObjectCacheImpl::TextChanged(Node* node) {
if (!node)
return;
// A text changed event is redundant with children changed on the same node.
if (AXID node_id = static_cast<AXID>(node->GetDomNodeId())) {
if (nodes_with_pending_children_changed_.find(node_id) !=
nodes_with_pending_children_changed_.end()) {
return;
}
}
DeferTreeUpdate(TreeUpdateReason::kTextChangedOnNode, node);
}
// Return a node for the current layout object or ancestor layout object.
Node* AXObjectCacheImpl::GetClosestNodeForLayoutObject(
const LayoutObject* layout_object) {
if (!layout_object) {
return nullptr;
}
Node* node = layout_object->GetNode();
return node ? node : GetClosestNodeForLayoutObject(layout_object->Parent());
}
void AXObjectCacheImpl::TextChanged(const LayoutObject* layout_object) {
if (!layout_object)
return;
// The node may be null when the text changes on an anonymous layout object,
// such as a layout block flow that is inserted to parent an inline object
// when it has a block sibling.
Node* node = GetClosestNodeForLayoutObject(layout_object);
if (node) {
// If the text changed in a pseudo element, rebuild the entire subtree.
if (node->IsPseudoElement()) {
RemoveAXObjectsInLayoutSubtree(node->GetLayoutObject());
} else if (AXID node_id = static_cast<AXID>(node->GetDomNodeId())) {
// Text changed is redundant with children changed on the same node.
if (base::Contains(nodes_with_pending_children_changed_, node_id)) {
return;
}
}
DeferTreeUpdate(TreeUpdateReason::kTextChangedOnClosestNodeForLayoutObject,
node);
return;
}
if (Get(layout_object)) {
DeferTreeUpdate(TreeUpdateReason::kTextChangedOnLayoutObject,
Get(layout_object));
}
}
void AXObjectCacheImpl::TextChangedWithCleanLayout(
Node* optional_node_for_relation_update,
AXObject* obj) {
if (obj ? obj->IsDetached() : !optional_node_for_relation_update)
return;
#if DCHECK_IS_ON()
Document* document = obj ? obj->GetDocument()
: &optional_node_for_relation_update->GetDocument();
DCHECK(document->Lifecycle().GetState() >= DocumentLifecycle::kLayoutClean)
<< "Unclean document at lifecycle " << document->Lifecycle().ToString();
#endif // DCHECK_IS_ON()
if (obj) {
if (obj->RoleValue() == ax::mojom::blink::Role::kStaticText &&
obj->IsIncludedInTree()) {
if (obj->ShouldLoadInlineTextBoxes()) {
// Update inline text box children.
ChildrenChangedWithCleanLayout(optional_node_for_relation_update, obj);
return;
}
}
MarkAXObjectDirtyWithCleanLayout(obj);
}
if (optional_node_for_relation_update) {
CHECK(relation_cache_);
relation_cache_->UpdateRelatedTree(optional_node_for_relation_update, obj);
}
}
void AXObjectCacheImpl::TextChangedWithCleanLayout(Node* node) {
if (!node)
return;
DCHECK(!node->GetDocument().NeedsLayoutTreeUpdateForNode(*node));
TextChangedWithCleanLayout(node, Get(node));
}
bool AXObjectCacheImpl::HasBadAriaHidden(const AXObject& obj) const {
return nodes_with_bad_aria_hidden_.Contains(obj.AXObjectID());
}
void AXObjectCacheImpl::DiscardBadAriaHiddenBecauseOfElement(
const AXObject& obj) {
bool is_first_time =
nodes_with_bad_aria_hidden_.insert(obj.AXObjectID()).is_new_entry;
if (!is_first_time) {
return;
}
Element& element = *obj.GetElement();
element.AddConsoleMessage(
mojom::blink::ConsoleMessageSource::kRendering,
mojom::blink::ConsoleMessageLevel::kError,
String::Format(
"Blocked aria-hidden on a <%s> element because it would hide the "
"entire accessibility tree from assistive technology users. For more "
"details, see the aria-hidden section of the WAI-ARIA specification "
"at https://w3c.github.io/aria/#aria-hidden.",
element.TagQName().ToString().Ascii().c_str()));
}
void AXObjectCacheImpl::DiscardBadAriaHiddenBecauseOfFocus(AXObject& obj) {
// aria-hidden markup requires an element.
Element& focused_element = *obj.GetElement();
// Traverse all the way to the root in case there are multiple
// ancestors with aria-hidden. Any aria-hidden="true" on any ancestor will
// be ignored.
AXObject* bad_aria_hidden_ancestor = nullptr;
for (AXObject* ancestor = &obj; ancestor;
ancestor = ancestor->ParentObject()) {
if (ancestor->IsAriaAttributeTrue(html_names::kAriaHiddenAttr)) {
if (nodes_with_bad_aria_hidden_.insert(ancestor->AXObjectID())
.is_new_entry) {
bad_aria_hidden_ancestor = ancestor;
}
}
}
// Invalidate the subtree and rebuild it now that this aria-hidden has
// been marked as bad and will be ignored.
CHECK(bad_aria_hidden_ancestor)
<< "An aria-hidden node did not have an aria-hidden ancestor.";
if (bad_aria_hidden_ancestor->GetElement()) {
bad_aria_hidden_ancestor->GetElement()->AddConsoleMessage(
mojom::blink::ConsoleMessageSource::kRendering,
mojom::blink::ConsoleMessageLevel::kWarning,
String::Format(
"Blocked aria-hidden on an element because its descendant retained "
"focus. The focus must not be hidden from assistive technology "
"users. Avoid using aria-hidden on a focused element or its "
"ancestor. Consider using the inert attribute instead, which will "
"also prevent focus. For more details, see the aria-hidden section "
"of the WAI-ARIA specification at "
"https://w3c.github.io/aria/#aria-hidden.\n"
"Element with focus: %s\nAncestor with aria-hidden: %s",
AXObject::GetNodeString(&focused_element).Ascii().c_str(),
AXObject::GetNodeString(bad_aria_hidden_ancestor->GetElement())
.Ascii()
.c_str()));
#if AX_FAIL_FAST_BUILD()
LOG(ERROR) << "Parent chain for focused node's AXObject:\n"
<< ParentChainToStringHelper(&obj);
#endif
}
Node* bad_aria_hidden_ancestor_node = bad_aria_hidden_ancestor->GetNode();
AXObject* ancestor_to_rebuild = bad_aria_hidden_ancestor->ParentObject();
while (ancestor_to_rebuild) {
ancestor_to_rebuild->SetNeedsToUpdateChildren();
if (ancestor_to_rebuild->IsIncludedInTree()) {
break;
}
ancestor_to_rebuild = ancestor_to_rebuild->ParentObject();
}
// The root is always included, so ancestor_to_rebuild is never null.
DCHECK(ancestor_to_rebuild);
RemoveSubtree(bad_aria_hidden_ancestor_node);
relation_cache_->ProcessUpdatesWithCleanLayout();
CHECK(bad_aria_hidden_ancestor->IsDetached());
ancestor_to_rebuild->UpdateChildrenIfNecessary();
bad_aria_hidden_ancestor = Get(bad_aria_hidden_ancestor_node);
if (bad_aria_hidden_ancestor) {
CHECK(!bad_aria_hidden_ancestor->IsAriaHiddenRoot());
CHECK(!bad_aria_hidden_ancestor->IsAriaHidden());
MarkAXSubtreeDirtyWithCleanLayout(bad_aria_hidden_ancestor);
}
if (AXObject* new_focused_obj = Get(&focused_element)) {
CHECK(!new_focused_obj->IsAriaHidden());
}
}
void AXObjectCacheImpl::DocumentTitleChanged() {
DocumentLifecycle::DisallowTransitionScope disallow(document_->Lifecycle());
AXObject* root = Get(document_);
if (root)
PostNotification(root, ax::mojom::blink::Event::kDocumentTitleChanged);
}
bool AXObjectCacheImpl::IsReadyToProcessTreeUpdatesForNode(const Node* node) {
DCHECK(node);
// The maximum number of nodes after whitespace is parsed before a tree update
// should occur. The value was chosen based on what was needed to eliminate
// flakiness in existing tests and may need adjustment. Example: the
// `AccessibilityCSSPseudoElementsSeparatedByWhitespace` Yielding Parser test
// regularly fails if this value is set to 2, but passes if set to at least 3.
constexpr int kMaxAllowedTreeUpdatePauses = 3;
// If we have a node that must be fully parsed before updates can continue,
// we're ready to process tree updates only if that node has finished parsing
// its children. In this scenario, the maximum number of tree update pauses is
// irrelevant.
if (node_to_parse_before_more_tree_updates_) {
return node_to_parse_before_more_tree_updates_->IsFinishedParsingChildren();
}
// There should be no reason to pause for a script element. Plus if we pause
// for the script element, the slow-document-load.html web test fails.
if (IsA<HTMLScriptElement>(node)) {
return true;
}
if (auto* text = DynamicTo<Text>(node)) {
if (!text->ContainsOnlyWhitespaceOrEmpty()) {
return true;
}
// Whitespace at the end of parsed content is a problem because we won't
// know if that whitespace node is relevant until we have some text or a
// block node. And we won't know the layout of a node at connection time.
// Therefore, if this is a whitespace node, reset the maximum number of
// allowed pauses and wait.
allowed_tree_update_pauses_remaining_ = kMaxAllowedTreeUpdatePauses;
return false;
}
// If the node following a whitespace node is a pseudo element, we won't have
// its contents at the time the node is connected. Those contents can impact
// the relevance of the whitespace node. So remain paused if node is a pseudo
// element, without resetting the maximum number of allowed pauses.
if (node->IsPseudoElement()) {
return false;
}
// No new reason to pause, and there are no prior requested pauses remaining.
if (!allowed_tree_update_pauses_remaining_) {
return true;
}
// No new reason to pause, but we're not ready to unpause yet. So decrement
// the number of pauses requested and wait for the next connected node.
CHECK_GT(allowed_tree_update_pauses_remaining_, 0u);
allowed_tree_update_pauses_remaining_--;
return false;
}
void AXObjectCacheImpl::NodeIsConnected(Node* node) {
if (IsParsingMainDocument()) {
if (IsReadyToProcessTreeUpdatesForNode(node)) {
node_to_parse_before_more_tree_updates_ = nullptr;
allowed_tree_update_pauses_remaining_ = 0;
}
} else {
// Handle case where neither NodeIsAttached() nor SubtreeIsAttached() will
// be called for this node. This occurs for nodes that are added to
// display:none subtrees. Ensure that these nodes partake in the AX tree.
ChildrenChanged(node->parentNode());
}
// Process relations.
if (Element* element = DynamicTo<Element>(node)) {
if (relation_cache_) {
// Register relation ids so that reverse relations can be computed.
relation_cache_->CacheRelations(*element);
ScheduleAXUpdate();
}
if (AXObject::HasARIAOwns(element)) {
DeferTreeUpdate(TreeUpdateReason::kUpdateAriaOwns, element);
}
if (element->HasID()) {
DeferTreeUpdate(TreeUpdateReason::kIdChanged, element);
}
}
}
void AXObjectCacheImpl::UpdateAriaOwnsWithCleanLayout(Node* node) {
// Process any relation attributes that can affect ax objects already created.
// Force computation of aria-owns, so that original parents that already
// computed their children get the aria-owned children removed.
CHECK(relation_cache_);
if (AXObject* obj = Get(node)) {
relation_cache_->UpdateAriaOwnsWithCleanLayout(obj);
}
}
void AXObjectCacheImpl::SubtreeIsAttached(Node* node) {
// If the node is the root of a display locked subtree, or was previously
// display:none, the entire AXObject subtree needs to be destroyed and rebuilt
// using AXNodeObjects with LayoutObjects.
// TODO(accessibility): try to improve performance by keeping the existing
// subtree but setting the LayoutObject and recomputing relevant values,
// including the role and the ignored state.
AXObject* obj = Get(node);
if (!obj) {
if (!node->GetLayoutObject() && !node->IsFinishedParsingChildren() &&
!node_to_parse_before_more_tree_updates_) {
// Unrendered subtrees that are not fully parsed are unsafe to
// process until they are complete, because there are no NodeIsAttached()
// signals for incrementally loaded content.
node_to_parse_before_more_tree_updates_ = node;
}
// No AX subtree to invalidate: just add an AXObject for this node.
// It will automatically add its subtree.
ChildrenChanged(LayoutTreeBuilderTraversal::Parent(*node));
// Ensure that aria-owns is updated on this element once the above
// children changed causes it to have an AXObject.
if (AXObject::HasARIAOwns(DynamicTo<Element>(node))) {
DeferTreeUpdate(TreeUpdateReason::kUpdateAriaOwns, node);
}
return;
}
// Note that technically we do not need to remove the root node for a
// display-locking (content-visibility) change, since it is only the
// descendants that gain or lose their objects, but its easier to be
// consistent here.
RemoveSubtree(node);
}
void AXObjectCacheImpl::NodeIsAttached(Node* node) {
CHECK(node);
CHECK(node->isConnected());
SCOPED_DISALLOW_LIFECYCLE_TRANSITION();
// Ensure that ChildrenChanged() occurs on the correct parent in the case
// where Blink layout code did not have a corresponding LayoutObject parent
// to fire ChildrenChanged() on, such as in a display:contents case.
ChildrenChanged(AXObject::GetParentNodeForComputeParent(*this, node));
// It normally is not necessary to process text nodes here, because we'll
// also get a call for the attachment of the parent element. However in the
// YieldingParser scenario, the `previousOnLineId` can be unexpectedly null
// for whitespace-only nodes whose inclusion had not yet been determined.
// Sample flake: AccessibilityContenteditableDocsLi. Therefore, find the
// highest `LayoutInline` ancestor and mark it dirty.
if (Text* text = DynamicTo<Text>(node)) {
if (text->ContainsOnlyWhitespaceOrEmpty()) {
if (auto* layout_object = node->GetLayoutObject()) {
auto* layout_parent = layout_object->Parent();
while (layout_parent && layout_parent->Parent() &&
layout_parent->Parent()->IsLayoutInline()) {
layout_parent = layout_parent->Parent();
}
MarkSubtreeDirty(layout_parent->GetNode());
}
}
return;
}
Document* document = DynamicTo<Document>(node);
if (document) {
Element* focused_element = GetDocument().FocusedElement();
// A popup is being shown.
if (IsA<HTMLSelectElement>(focused_element)) {
// HTML <select> has a popup that duplicates nodes from the main
// document, and therefore we ignore that popup and any nodes in it.
return;
}
DCHECK(*document != GetDocument());
DCHECK(!popup_document_) << "Last popup was not cleared.";
DCHECK(!popup_document_ || popup_document_ == document)
<< "Last popup was not cleared: " << (void*)popup_document_;
popup_document_ = document;
DCHECK(IsPopup(*document));
// Fire children changed on the focused element that owns this popup.
ChildrenChanged(focused_element);
return;
}
if (node->GetLayoutObject()) {
// Handle subtree that was previously display:none gaining layout.
if (AXObject* obj = Get(node); obj && !obj->GetLayoutObject()) {
// Had a previous AXObject, but wasn't an AXLayoutObject, even though
// there is a layout object available.
RemoveSubtree(node);
return;
}
if ((IsA<HTMLTableElement>(node) || IsA<HTMLSelectElement>(node) ||
node->GetLayoutObject()->IsAtomicInlineLevel()) &&
!node->IsFinishedParsingChildren() &&
!node_to_parse_before_more_tree_updates_) {
// * Tables must be fully parsed before building, because many of the
// computed properties require the entire table.
// * Custom selects must be fully parsed before building because of
// flakes where the entire subtree was not populated. The exact reason
// is unclear, but it could be related to the unique use of the flat
// vs. natural DOM tree.
// TODO(accessibility) Fix root select issue, while still passing
// All/YieldingParserDumpAccessibilityTreeTest.AccessibilityCustomSelect/blink.
// * Inline text boxes must know their children in order to determine
// whether they can be ignored;
node_to_parse_before_more_tree_updates_ = node;
}
// Rare edge case: if an image is added, it could have changed the order of
// images with the same usemap in the document. Only the first image for a
// given <map> should have the <area> children. Therefore, get the current
// primary image before it's updated, and ensure its children are
// recalculated.
if (IsA<HTMLImageElement>(node)) {
if (HTMLMapElement* map = AXObject::GetMapForImage(node)) {
HTMLImageElement* primary_image_element = map->ImageElement();
if (node != primary_image_element) {
// This is a secondary image for its map, and therefore the map does
// not apply to it. Make sure the primary image recomputes its
// children.
ChildrenChanged(primary_image_element);
} else if (AXObject* ax_previous_parent = GetAXImageForMap(*map)) {
// This is the primary image for its map and the map's children
// were previously parented by an AXObject for an <img>
if (ax_previous_parent->GetNode() != node) {
// The previous AXObject parent for the maps children does not
// match!
ChildrenChanged(ax_previous_parent);
ax_previous_parent->ClearChildren();
}
}
}
}
}
DeferTreeUpdate(TreeUpdateReason::kNodeIsAttached, node);
}
void AXObjectCacheImpl::NodeIsAttachedWithCleanLayout(Node* node) {
if (!node || !node->isConnected()) {
return;
}
Element* element = DynamicTo<Element>(node);
#if DCHECK_IS_ON()
DCHECK(node->GetDocument().Lifecycle().GetState() >=
DocumentLifecycle::kLayoutClean)
<< "Unclean document at lifecycle "
<< node->GetDocument().Lifecycle().ToString();
#endif // DCHECK_IS_ON()
if (AXObject::ElementFromAttributeOrInternals(
element, html_names::kAriaActivedescendantAttr)) {
HandleActiveDescendantChangedWithCleanLayout(element);
}
AXObject* obj = Get(node);
CHECK(obj);
CHECK(obj->ParentObject());
if (element) {
MaybeNewRelationTarget(*node, obj);
}
if (IsA<HTMLAreaElement>(node)) {
ChildrenChangedWithCleanLayout(obj);
}
// Check if a row or cell's table changed to or from a data table.
if (IsA<HTMLTableRowElement>(node) || IsA<HTMLTableCellElement>(node)) {
Element* parent = node->parentElement();
while (parent) {
if (DynamicTo<HTMLTableElement>(parent)) {
break;
}
parent = parent->parentElement();
}
if (parent) {
UpdateTableRoleWithCleanLayout(parent);
}
TableCellRoleMaybeChanged(node);
}
}
void AXObjectCacheImpl::NotifyParentChildrenChanged(AXObject* parent) {
if (!parent) {
return;
}
if (lifecycle_.StateAllowsImmediateTreeUpdates()) {
ChildrenChangedWithCleanLayout(parent);
} else {
AXObject* ax_ancestor = ChildrenChanged(parent);
if (!ax_ancestor) {
return;
}
CHECK(!IsFrozen())
<< "Attempting to change children on an ancestor is dangerous during "
"serialization, because the ancestor may have already been "
"visited. Reaching this line indicates that AXObjectCacheImpl did "
"not handle a signal and call ChildrenChanged() earlier."
<< "\nParent: " << parent << "\nAncestor: " << ax_ancestor;
}
}
// Note: do not call this when a child is becoming newly included, because
// it will return early if |obj| was last known to be unincluded.
void AXObjectCacheImpl::ChildrenChangedOnAncestorOf(AXObject* obj) {
DCHECK(obj);
DCHECK(!obj->IsDetached());
// Clear children of ancestors in order to ensure this detached object is not
// cached in an ancestor's list of children:
// Any ancestor up to the first included ancestor can contain the now-detached
// child in it's cached children, and therefore must update children.
NotifyParentChildrenChanged(obj->ParentObjectIfPresent());
}
void AXObjectCacheImpl::ChildrenChangedWithCleanLayout(AXObject* obj) {
if (AXObject* ax_ancestor_for_notification = InvalidateChildren(obj)) {
if (ax_ancestor_for_notification->GetNode() &&
nodes_with_pending_children_changed_.Contains(
ax_ancestor_for_notification->AXObjectID())) {
return;
}
ChildrenChangedWithCleanLayout(ax_ancestor_for_notification->GetNode(),
ax_ancestor_for_notification);
}
}
AXObject* AXObjectCacheImpl::ChildrenChanged(AXObject* obj) {
CHECK(lifecycle_.StateAllowsDeferTreeUpdates())
<< "Call ChildrenChangedWithCleanLayout() directly while processing "
"deferred events."
<< *this;
if (AXObject* ax_ancestor_for_notification = InvalidateChildren(obj)) {
// Don't enqueue a deferred event on the same node more than once.
CHECK(lifecycle_.StateAllowsDeferTreeUpdates());
if (ax_ancestor_for_notification->GetNode() &&
!nodes_with_pending_children_changed_
.insert(ax_ancestor_for_notification->AXObjectID())
.is_new_entry) {
return nullptr;
}
DeferTreeUpdate(TreeUpdateReason::kChildrenChanged,
ax_ancestor_for_notification);
return ax_ancestor_for_notification;
}
return nullptr;
}
AXObject* AXObjectCacheImpl::InvalidateChildren(AXObject* obj) {
if (!obj)
return nullptr;
// Clear children of ancestors in order to ensure this detached object is not
// cached an ancestor's list of children:
AXObject* ancestor = obj;
while (ancestor) {
if (ancestor->NeedsToUpdateChildren() || ancestor->IsDetached())
return nullptr; // Processing has already occurred for this ancestor.
ancestor->SetNeedsToUpdateChildren();
// Any ancestor up to the first included ancestor can contain the
// now-detached child in it's cached children, and therefore must update
// children.
if (ancestor->CachedIsIncludedInTree()) {
break;
}
ancestor = ancestor->ParentObject();
}
// Only process ChildrenChanged() events on the included ancestor. This allows
// deduping of ChildrenChanged() occurrences within the same subtree.
// For example, if a subtree has unincluded children, but included
// grandchildren have changed, only the root children changed needs to be
// processed.
if (!ancestor)
return nullptr;
// Return ancestor to fire children changed notification on.
DCHECK(ancestor->CachedIsIncludedInTree())
<< "ChildrenChanged() must only be called on included nodes: "
<< ancestor;
return ancestor;
}
void AXObjectCacheImpl::SlotAssignmentWillChange(Node* node) {
ChildrenChanged(node);
}
void AXObjectCacheImpl::ChildrenChanged(Node* node) {
ChildrenChanged(Get(node));
}
void AXObjectCacheImpl::ChildrenChanged(const LayoutObject* layout_object) {
if (!layout_object)
return;
// Ensure that this object is touched, so that Get() can Invalidate() it if
// necessary, e.g. to change whether it contains a LayoutObject.
Get(layout_object);
// Update using nearest node (walking ancestors if necessary).
Node* node = GetClosestNodeForLayoutObject(layout_object);
if (!node)
return;
ChildrenChanged(node);
}
void AXObjectCacheImpl::ChildrenChangedWithCleanLayout(Node* node) {
if (AXObject* obj = Get(node)) {
ChildrenChangedWithCleanLayout(node, obj);
}
}
// TODO can node be non-optional?
void AXObjectCacheImpl::ChildrenChangedWithCleanLayout(Node* optional_node,
AXObject* obj) {
CHECK(obj);
CHECK(!obj->IsDetached());
#if DCHECK_IS_ON()
if (optional_node) {
DCHECK_EQ(obj->GetNode(), optional_node);
DCHECK_EQ(obj, Get(optional_node));
}
Document* document = obj->GetDocument();
DCHECK(document);
DCHECK(document->Lifecycle().GetState() >= DocumentLifecycle::kLayoutClean)
<< "Unclean document at lifecycle " << document->Lifecycle().ToString();
#endif // DCHECK_IS_ON()
obj->ChildrenChangedWithCleanLayout();
DUMP_WILL_BE_CHECK(!obj->IsDetached());
if (optional_node) {
CHECK(relation_cache_);
relation_cache_->UpdateRelatedTree(optional_node, obj);
}
TableCellRoleMaybeChanged(optional_node);
}
void AXObjectCacheImpl::FinalizeTree() {
if (Root()->HasDirtyDescendants()) {
HeapDeque<Member<AXObject>> objects_to_process;
objects_to_process.push_back(Root());
while (!objects_to_process.empty()) {
AXObject* obj = objects_to_process.front();
objects_to_process.pop_front();
if (obj->IsDetached()) {
continue;
}
obj->UpdateChildrenIfNecessary();
if (obj->HasDirtyDescendants()) {
obj->SetHasDirtyDescendants(false);
for (auto& child : obj->ChildrenIncludingIgnored()) {
objects_to_process.push_back(child);
}
}
}
}
if (GetAXMode().HasFilterFlags(ui::AXMode::kOnScreenOnly)) {
LocalFrameView* frame_view = GetDocument().View();
PhysicalRect viewport_rect(
frame_view->GetPage()->GetVisualViewport().VisibleContentRect());
// We only care about the y-axis content scrolling to determine what will be
// included. So expand the rectangle to the left and right.
// TODO(accessibility): this seems to not be matching the following example,
// where the expanded rectangle should be matching:
// <style>
// .screen-reader-only {
// position: absolute;
// left: -9999px;
// width: 1px;
// height: 1px;
// overflow: hidden;
// }
// </style>
// <p class="screen-reader-only">
// some text
// </p>
// TODO(accessibility): consider expanding the top of the rectangle to
// capture content that may be put there.
viewport_rect.ExpandEdges(/*top=*/LayoutUnit(0),
/*right=*/LayoutUnit(99999),
/*bottom=*/LayoutUnit(0),
/*left=*/LayoutUnit(99999));
// We include two view ports of content that can be considered on-screen.
viewport_rect.SetHeight(viewport_rect.Height() * 2);
HitTestLocation location(viewport_rect);
HitTestRequest request(HitTestRequest::kReadOnly | HitTestRequest::kActive |
HitTestRequest::kListBased |
HitTestRequest::kPenetratingList);
HitTestResult result(request, location);
GetDocument().GetLayoutView()->HitTestNoLifecycleUpdate(location, result);
const HitTestResult::NodeSet& set = result.ListBasedTestResult();
// From here, there are no more operations to be performed on the tree, so
// we can mark the nodes that will be serialized and the ones that will be
// cut.
MarkOnScreenNodes(Root(), &set);
}
CheckTreeIsFinalized();
}
void AXObjectCacheImpl::CheckStyleIsComplete(Document& document) const {
#if EXPENSIVE_DCHECKS_ARE_ON()
// Style is only guaranteed to be complete for display locked objects when a
// screen reader is active.
if (!IsScreenReaderActive()) {
return;
}
Element* root_element = document.documentElement();
if (!root_element) {
return;
}
{
// Check that all style is up-to-date when layout is clean, when a11y is on.
// This allows content-visibility: auto subtrees to have proper a11y
// semantics, e.g. for the hidden and focusable states.
Node* node = root_element;
do {
CHECK(!node->NeedsStyleRecalc()) << "Need style on: " << node;
auto* element = DynamicTo<Element>(node);
const ComputedStyle* style =
element ? element->GetComputedStyle() : nullptr;
if (!style || style->ContentVisibility() == EContentVisibility::kHidden ||
style->IsEnsuredInDisplayNone()) {
// content-visibility:hidden nodes are an exception and do not
// compute style.
node =
LayoutTreeBuilderTraversal::NextSkippingChildren(*node, &document);
} else {
node = LayoutTreeBuilderTraversal::Next(*node, &document);
}
} while (node);
}
{
// Check results of ChildNeedsStyleRecalc() as well, just to be sure there
// isn't a discrepancy there.
Node* node = root_element;
do {
auto* element = DynamicTo<Element>(node);
const ComputedStyle* style =
element ? element->GetComputedStyle() : nullptr;
if (!style || style->ContentVisibility() == EContentVisibility::kHidden ||
style->IsEnsuredInDisplayNone()) {
// content-visibility:hidden nodes are an exception and do not
// compute style.
node =
LayoutTreeBuilderTraversal::NextSkippingChildren(*node, &document);
continue;
}
CHECK(!node->ChildNeedsStyleRecalc()) << "Need style on child: " << node;
node = LayoutTreeBuilderTraversal::Next(*node, &document);
} while (node);
}
#endif
}
void AXObjectCacheImpl::CheckTreeIsFinalized() {
CHECK(!Root()->NeedsToUpdateCachedValues());
#if AX_FAIL_FAST_BUILD()
// Skip check if document load is not complete.
if (!GetDocument().IsLoadCompleted()) {
return;
}
// After the first 5 checks, only check the tree every 5 seconds.
auto now = base::TimeTicks::Now();
if (tree_check_warmup_counter_ < 5) {
++tree_check_warmup_counter_;
} else if (now - last_tree_check_time_stamp_ < base::Seconds(5)) {
return;
}
last_tree_check_time_stamp_ = now;
// The following checks can make tests flaky if the tree being checked
// is quite large. Therefore cap the number of objects we check.
constexpr int kMaxObjectsToCheckAfterTreeUpdate = 1000;
// First loop checks that tree structure is consistent.
int count = 0;
for (const auto& entry : objects_) {
if (count > kMaxObjectsToCheckAfterTreeUpdate) {
break;
}
const AXObject* object = entry.value;
CHECK(!object->IsDetached());
CHECK(object->GetDocument());
CHECK(object->GetDocument()->GetFrame())
<< "An object in a closed document should have been removed:"
<< "\n* Object: " << object;
CHECK(!object->IsMissingParent())
<< "No object should be missing its parent: " << "\n* Object: "
<< object << "\n* Computed parent: " << object->ComputeParent();
// Check whether cached values need an update before using any getters that
// will update them.
CHECK(!object->NeedsToUpdateCachedValues())
<< "No cached values should require an update: " << "\n* Object: "
<< object;
CHECK(!object->ChildrenNeedToUpdateCachedValues())
<< "Cached values for children should not require an update: "
<< "\n* Object: " << object;
if (object->IsIncludedInTree()) {
// All cached children must be included.
for (const auto& child : object->CachedChildrenIncludingIgnored()) {
CHECK(child->IsIncludedInTree())
<< "Included parent cannot have unincluded child:" << "\n* Parent: "
<< object << "\n* Child: " << child;
}
if (!object->IsRoot()) {
// Parent must have this child in its cached children.
AXObject* included_parent = object->ParentObjectIncludedInTree();
CHECK(included_parent);
const HeapVector<Member<AXObject>>& siblings =
included_parent->CachedChildrenIncludingIgnored();
CHECK(siblings.Contains(object))
<< "Object was not included in its parent: " << "\n* Object: "
<< object << "\n* Included parent: " << included_parent;
}
}
count++;
}
// Second loop checks that all dirty bits to update properties or children
// have been cleared.
count = 0;
for (const auto& entry : objects_) {
if (count > kMaxObjectsToCheckAfterTreeUpdate) {
break;
}
const AXObject* object = entry.value;
if (object->HasDirtyDescendants()) {
// This an error: log the top ancestor that still has dirty descendants.
const AXObject* ancestor = object;
while (ancestor && ancestor->ParentObjectIncludedInTree() &&
ancestor->ParentObjectIncludedInTree()->HasDirtyDescendants()) {
ancestor = ancestor->ParentObjectIncludedInTree();
}
AXObject* included_parent = ancestor->ParentObjectIncludedInTree();
if (!included_parent) {
included_parent = Root();
}
CHECK(!ancestor->HasDirtyDescendants())
<< "No subtrees should be flagged as needing updates at this point:"
<< "\n* Object: " << ancestor
<< "\n* Included parent: " << included_parent->GetAXTreeForThis();
}
AXObject* included_parent = object->ParentObjectIncludedInTree();
if (!included_parent) {
included_parent = Root();
}
CHECK(!object->NeedsToUpdateChildren())
<< "No children in the tree should require an update at this point: "
<< "\n* Object: " << object
<< "\n* Included parent: " << included_parent;
count++;
}
#endif // AX_FAIL_FAST_BUILD()
}
int AXObjectCacheImpl::GetDeferredEventsDelay() const {
// The amount of time, in milliseconds, to wait before sending non-interactive
// events that are deferred before the initial page load.
constexpr int kDelayForDeferredUpdatesBeforePageLoad = 350;
// The amount of time, in milliseconds, to wait before sending non-interactive
// events that are deferred after the initial page load.
// Shync with same constant in CrossPlatformAccessibilityBrowserTest.
constexpr int kDelayForDeferredUpdatesAfterPageLoad = 150;
return GetDocument().IsLoadCompleted()
? kDelayForDeferredUpdatesAfterPageLoad
: kDelayForDeferredUpdatesBeforePageLoad;
}
int AXObjectCacheImpl::GetLocationSerializationDelay() {
// The amount of time, in milliseconds, to wait in between location updates
// when the changed nodes don't include the focused node.
constexpr int kDelayForLocationUpdatesNonFocused = 500;
// The amount of time, in milliseconds, to wait in between location updates
// when the changed nodes includes the focused node.
constexpr int kDelayForLocationUpdatesFocused = 75;
// It's important for the user to have access to any changes to the
// currently focused object, so schedule serializations (almost )immediately
// if that object changes. The root is an exception because it often has focus
// while the page is loading.
DOMNodeId focused_node_id = FocusedNode()->GetDomNodeId();
if (focused_node_id != document_->GetDomNodeId() &&
changed_bounds_ids_.Contains(focused_node_id)) {
return kDelayForLocationUpdatesFocused;
}
return kDelayForLocationUpdatesNonFocused;
}
void AXObjectCacheImpl::CommitAXUpdates(Document& document, bool force) {
if (IsPopup(document)) {
// Only process popup document together with main document.
DCHECK_EQ(&document, GetPopupDocumentIfShowing());
// Since a change occurred in the popup, processing of both documents will
// be needed. A visual update on the main document will force this.
ScheduleAXUpdate();
return;
}
DCHECK_EQ(document, GetDocument());
if (!GetDocument().IsActive()) {
return;
}
CheckStyleIsComplete(document);
// Don't update the tree at an awkward time during page load.
// Example: when the last node is whitespace, there is not yet enough context
// to determine the relevance of the whitespace.
if ((allowed_tree_update_pauses_remaining_ ||
node_to_parse_before_more_tree_updates_) &&
!force) {
if (IsParsingMainDocument()) {
return;
}
allowed_tree_update_pauses_remaining_ = 0;
node_to_parse_before_more_tree_updates_ = nullptr;
}
if (tree_updates_paused_) {
// Unpause tree updates and rebuild the tree from the root.
// TODO(accessibility): Add more testing for this feature.
// TODO(accessibility): Consider waiting until serialization batching timer
// fires, so that the pause is a bit longer.
LOG(INFO) << "Accessibility tree updates will be resumed after rebuilding "
"the tree from root";
mark_all_dirty_ = true;
tree_updates_paused_ = false;
}
// Something occurred which requires an immediate serialization.
if (serialize_immediately_) {
force = true;
serialize_immediately_ = false;
}
if (!force) {
// Process the current tree changes unless not enough time has passed, or
// another serialization is already in flight.
if (IsSerializationInFlight()) {
// Another serialization is in flight. When it's finished, this method
// will be called again.
return;
}
const auto now = base::TimeTicks::Now();
const auto delay_between_serializations =
base::Milliseconds(GetDeferredEventsDelay());
const auto elapsed_since_last_serialization =
now - last_serialization_timestamp_;
const auto delay_until_next_serialization =
delay_between_serializations - elapsed_since_last_serialization;
if (delay_until_next_serialization.is_positive()) {
// No serialization needed yet, will serialize after a delay.
// Set a timer to call this method again, if one isn't already set.
if (!weak_factory_for_serialization_pipeline_.HasWeakCells()) {
document.GetTaskRunner(blink::TaskType::kInternalDefault)
->PostDelayedTask(
FROM_HERE,
WTF::BindOnce(
&AXObjectCacheImpl::ScheduleAXUpdate,
WrapPersistent(weak_factory_for_serialization_pipeline_
.GetWeakCell())),
delay_until_next_serialization);
}
return;
}
}
weak_factory_for_serialization_pipeline_.Invalidate();
if (GetPopupDocumentIfShowing()) {
UpdateLifecycleIfNeeded(*GetPopupDocumentIfShowing());
CheckStyleIsComplete(*GetPopupDocumentIfShowing());
}
lifecycle_.AdvanceTo(AXObjectCacheLifecycle::kProcessDeferredUpdates);
SCOPED_UMA_HISTOGRAM_TIMER_MICROS(
"Accessibility.Performance.TotalAccessibilityCleanLayoutLifecycleStages");
TRACE_EVENT0("accessibility",
load_sent_
? "TotalAccessibilityCleanLayoutLifecycleStages"
: "TotalAccessibilityCleanLayoutLifecycleStagesLoading");
// Upon exiting this function, listen for tree updates again.
absl::Cleanup lifecycle_returns_to_queueing_updates = [this] {
lifecycle_.EnsureStateAtMost(AXObjectCacheLifecycle::kDeferTreeUpdates);
};
SCOPED_DISALLOW_LIFECYCLE_TRANSITION();
// ------------ Process deferred events and update tree --------------------
{
{
SCOPED_UMA_HISTOGRAM_TIMER_MICROS(
"Accessibility.Performance.ProcessDeferredUpdatesLifecycleStage");
TRACE_EVENT0("accessibility",
load_sent_ ? "ProcessDeferredUpdatesLifecycleStage"
: "ProcessDeferredUpdatesLifecycleStageLoading");
// If this is the first update, ensure that both an initial tree exists
// and that the relation cache is initialized. Any existing content with
// aria-owns relation be added to the relation cache's queue for
// processing.
EnsureRelationCacheAndInitialTree();
// Update (create or remove) validation child of root, if it is needed, so
// that the tree can be frozen in the correct state.
ValidationMessageObjectIfInvalid();
// If MarkDocumentDirty() was called, do it now, so that the entire tree
// is invalidated before updating it.
if (mark_all_dirty_) {
MarkDocumentDirtyWithCleanLayout();
}
// Call the queued callback methods that do processing which must occur
// when layout is clean. These callbacks are stored in
// |tree_update_callback_queue_|, and have names like
// FooBarredWithCleanLayout().
if (IsDirty()) {
if (GetPopupDocumentIfShowing()) {
ProcessCleanLayoutCallbacks(*GetPopupDocumentIfShowing());
}
ProcessCleanLayoutCallbacks(document);
}
}
// At this point, the popup queue should be clear, and we must ensure this
// even if nothing is dirty. It seems that there are cases where it
// IsDirty() returns false where there is no popup document, but there are
// entries in the popup queue.
// TODO(https://crbug.com/1507396): It is unclear when this happens, but it
// explains why we still have a full popup queue in CheckTreeIsFinalized().
// DCHECKs have been added elsewhere to help discover the underlying cause.
// For now, keep this line in order to pass CheckTreeIsFinalized().
tree_update_callback_queue_popup_.clear();
{
#if defined(REDUCE_AX_INLINE_TEXTBOXES)
// On Android, the inline textboxes of focused editable subtrees are
// always loaded, but only if inline text boxes are enabled.
if (ax_mode_.has_mode(ui::AXMode::kInlineTextBoxes)) {
AXObject* focus = FocusedObject();
if (focus && focus->IsEditableRoot()) {
focus->LoadInlineTextBoxes();
}
}
#endif
mark_all_dirty_ = false;
// All tree updates have been processed.
DUMP_WILL_BE_CHECK(!IsMainDocumentDirty());
DUMP_WILL_BE_CHECK(!IsPopupDocumentDirty());
// Clean up any remaining unprocessed aria-owns relations, which can
// result from processing deferred tree updates. For example, if an object
// is created without a parent, RepairChildrenOfIncludedParent() may be
// called, which in some cases can queue multiple aria-owns relations that
// point to the same node to be added to the processing queue.
relation_cache_->ProcessUpdatesWithCleanLayout();
EnsureFocusedObject();
if (mark_all_dirty_) {
// In some cases, EnsureFocusedObject() causes bad aria-hidden subtrees
// to be removed, if they contained the focus. This can in turn lead to
// marking the entire document dirty if a modal dialog or focus within
// the modal dialog is removed.
MarkDocumentDirtyWithCleanLayout();
mark_all_dirty_ = false;
}
CHECK(tree_update_callback_queue_main_.empty());
CHECK(tree_update_callback_queue_popup_.empty());
CHECK(nodes_with_pending_children_changed_.empty());
{
lifecycle_.AdvanceTo(AXObjectCacheLifecycle::kFinalizingTree);
SCOPED_UMA_HISTOGRAM_TIMER_MICROS(
"Accessibility.Performance.FinalizingTreeLifecycleStage");
TRACE_EVENT0("accessibility",
load_sent_ ? "FinalizingTreeLifecycleStage"
: "FinalizingTreeLifecycleStageLoading");
// Build out tree, such that each node has computed its children.
FinalizeTree();
CHECK(tree_update_callback_queue_main_.empty());
CHECK(tree_update_callback_queue_popup_.empty());
CHECK(nodes_with_pending_children_changed_.empty());
#if AX_FAIL_FAST_BUILD()
if (!nodes_requiring_cache_update_.empty()) {
std::ostringstream msg;
msg << "We shouldn't have any objects requiring cache update after "
"the tree is finalized. The following objects do not meet "
"this expectation:";
for (auto entry : nodes_requiring_cache_update_) {
msg << "\n*AXObject: " << ObjectFromAXID(entry.key)
<< "\nUpdate Reason: "
<< TreeUpdateReasonAsDebugString(entry.value);
}
DUMP_WILL_BE_CHECK(false) << msg.str();
}
#endif
// Updating the tree did not add dirty objects.
DUMP_WILL_BE_CHECK(!IsDirty())
<< "Cache dirtied at bad time:" << "\nAll: " << mark_all_dirty_
<< "\nRoot children: " << Root()->NeedsToUpdateChildren()
<< "\nRoot descendants: " << Root()->HasDirtyDescendants()
<< "\nRelation cache: " << relation_cache_->IsDirty()
<< "\nUpdates paused: " << tree_updates_paused_;
}
}
}
lifecycle_.AdvanceTo(AXObjectCacheLifecycle::kSerialize);
SCOPED_UMA_HISTOGRAM_TIMER_MICROS(
"Accessibility.Performance.SerializeLifecycleStage");
TRACE_EVENT0("accessibility", load_sent_ ? "SerializeLifecycleStage"
: "SerializeLifecycleStageLoading");
// Check whether serializations are needed, or whether we are just here to
// update as part of a tree snapshot.
if (IsForSnapshot()) {
return;
}
// Serialize the current tree changes unless not enough time has passed, or
// another serialization is already in flight.
if (IsSerializationInFlight()) {
// Another serialization is in flight. When it's finished, this method
// will be called again.
return;
}
// ------------------------ Freeze and serialize ---------------------------
{
// The frozen state begins immediately after processing deferred events.
ScopedFreezeAXCache scoped_freeze_cache(*this);
// ***** Serialize *****
// Check whether there are dirty objects ready to be serialized.
// TODO(accessibility) It's a bit confusing that this can be true when the
// IsDirty() is false, but this is the case for objects marked dirty from
// RenderAccessibilityImpl, e.g. for the kEndOfTest event.
bool did_serialize = false;
if (HasObjectsPendingSerialization()) {
did_serialize = SerializeUpdatesAndEvents();
}
// ***** Serialize Location Changes *****
// Even if there are no dirty objects, we ensure pending location changes
// are sent.
if (reset_token_ && !changed_bounds_ids_.empty()) {
DCHECK(!did_serialize); // Location changes should have been sent with
// full serialization.
SerializeLocationChanges();
}
// ***** Update Inspector Views *****
// Accessibility is now clean for both documents: AXObjects can be safely
// traversed and AXObject's properties can be safely fetched.
// TODO(accessibility) Now that both documents are always processed at the
// same time, consider modifying the InspectorAccessibilityAgent so that
// only the callback for the main document is needed.
for (auto agent : agents_) {
agent->AXReadyCallback(document);
if (GetPopupDocumentIfShowing()) {
agent->AXReadyCallback(*GetPopupDocumentIfShowing());
}
}
Vector<base::OnceClosure> callbacks;
ready_callbacks_.swap(callbacks);
for (auto& callback : callbacks) {
std::move(callback).Run();
}
DUMP_WILL_BE_CHECK(!IsDirty());
// TODO(accessibility): in the future, we may break up serialization into
// pieces to reduce jank, in which case this assertion will not hold.
DUMP_WILL_BE_CHECK(!HasObjectsPendingSerialization() || !did_serialize)
<< "A serialization occurred but dirty objects remained.";
}
}
bool AXObjectCacheImpl::SerializeUpdatesAndEvents() {
CHECK(!for_snapshot_only_);
CHECK(HasObjectsPendingSerialization());
CHECK(!IsSerializationInFlight());
DCHECK(!ax_mode_.is_mode_off());
CHECK(ax_mode_.has_mode(ui::AXMode::kWebContents));
CHECK(lifecycle_.StateAllowsSerialization()) << *this;
if (!GetDocument().GetFrame()) {
return false;
}
// Dirty objects are present, but we cannot serialize until there is an
// embedding token, which may not be present when the cache is first
// initialized.
const std::optional<base::UnguessableToken>& embedding_token =
GetDocument().GetFrame()->GetEmbeddingToken();
if (!embedding_token || embedding_token->is_empty()) {
return false;
}
auto* client = GetWebLocalFrameClient();
CHECK(client);
// TODO(accessibility): Review why this value is inconsistent with
// ax_mode_.has_mode(ui::AXMode::kWebContents)
if (!client->IsAccessibilityEnabled()) {
return false;
}
OnSerializationStartSend();
bool had_end_of_test_event = false;
// Keep track of load complete messages. When a load completes, it's a good
// time to inject a stylesheet for image annotation debugging.
bool had_load_complete_messages = false;
std::vector<ui::AXTreeUpdate> updates;
std::vector<ui::AXEvent> events;
// Serialize all dirty objects in the list at this point in time, stopping
// either when the queue is empty, or the number of remaining objects to
// serialize has been reached.
GetUpdatesAndEventsForSerialization(updates, events, had_end_of_test_event,
had_load_complete_messages);
/* Clear the pending updates and events as they're about to be serialized */
pending_objects_to_serialize_.clear();
pending_events_to_serialize_.clear();
if (had_end_of_test_event) {
ui::AXEvent end_of_test(Root()->AXObjectID(),
ax::mojom::blink::Event::kEndOfTest);
if (!IsDirty() && GetDocument().IsLoadCompleted()) {
// Everything is clean and the document is fully loaded, so kEndOfTest
// signal can be fired.
events.emplace_back(end_of_test);
} else {
DLOG(ERROR) << "Had end of test event, but document is still dirty.";
// Document is still dirty, queue up another end of test and process
// immediately.
AddEventToSerializationQueue(end_of_test, /*serialize_immediately*/ true);
}
}
if (!GetAXMode().HasFilterFlags(ui::AXMode::kOnScreenOnly)) {
// updates.empty() -implies-> events.empty(). However, if
// AXMode::kOnScreenOnly is set, this is not true; It can be the case that
// events were fired on nodes that are not going to be serialized.
DCHECK(!updates.empty() || events.empty())
<< "Every event must have at least one corresponding update because "
"events cause their related nodes to be marked dirty.";
DCHECK(!updates.empty());
} else if (updates.empty() && events.empty()) {
// Updates and events can be empty if the filter kOnScreenOnly filtered them
// all. This means that the changes were only affecting nodes that are not
// known by the client yet, so there is no need to send them.
return false;
}
// There should be no more dirty objects.
CHECK(!HasObjectsPendingSerialization());
/* If there's location updates pending, send them on the way. */
ui::AXLocationAndScrollUpdates location_and_scroll_changes;
if (!changed_bounds_ids_.empty()) {
location_and_scroll_changes = TakeLocationChangsForSerialization();
}
/* Send the actual serialization message.*/
bool success = client->SendAccessibilitySerialization(
std::move(updates), std::move(events),
std::move(location_and_scroll_changes), had_load_complete_messages);
if (!success) {
// In some cases, like in web tests or if a11y is off, serialization doesn't
// really occur and thus the function will return false.
// Cancel serialization to avoid stalling pipeline.
OnSerializationCancelled();
}
if (had_load_complete_messages) {
load_sent_ = true;
}
CHECK(serialization_in_flight_ == success);
return success;
}
const AXBlockFlowData* AXObjectCacheImpl::GetBlockFlowData(
const AXObject* object) {
LayoutBlockFlow* block_flow =
object->GetLayoutObject()->FragmentItemsContainer();
if (!block_flow) {
return nullptr;
}
auto it = block_flow_data_cache_.find(block_flow);
if (it != block_flow_data_cache_.end()) {
return it->value;
}
auto result = block_flow_data_cache_.insert(
block_flow, MakeGarbageCollected<AXBlockFlowData>(block_flow));
CHECK(result.is_new_entry);
return result.stored_value->value;
}
bool AXObjectCacheImpl::IsParsingMainDocument() const {
return GetDocument().Parser() &&
!GetDocument().GetAgent().isolate()->InContext();
}
bool AXObjectCacheImpl::IsMainDocumentDirty() const {
return !tree_update_callback_queue_main_.empty();
}
bool AXObjectCacheImpl::IsPopupDocumentDirty() const {
if (!popup_document_) {
// This should have been cleared in RemovePopup(), but technically the
// popup could be null without calling that, since it's a weak pointer.
DCHECK(tree_update_callback_queue_popup_.empty());
return false;
}
return !tree_update_callback_queue_popup_.empty();
}
bool AXObjectCacheImpl::IsDirty() {
if (!GetDocument().IsActive()) {
return false;
}
if (mark_all_dirty_) {
return true;
}
if (IsMainDocumentDirty() || IsPopupDocumentDirty() || !relation_cache_ ||
relation_cache_->IsDirty()) {
return true;
}
if (Root()->NeedsToUpdateChildren() || Root()->HasDirtyDescendants()) {
return true;
}
// If tree updates are paused, consider the cache dirty. The next time
// CommitAXUpdates() is called, the entire tree will be
// rebuilt from the root.
if (tree_updates_paused_) {
return true;
}
return false;
}
void AXObjectCacheImpl::EmbeddingTokenChanged(HTMLFrameOwnerElement* element) {
if (!element)
return;
MarkElementDirty(element);
}
bool AXObjectCacheImpl::IsPopup(Document& document) const {
// There are 1-2 documents per AXObjectCache: the main document and
// sometimes a popup document.
int is_popup = document != GetDocument();
if (is_popup) {
#if DCHECK_IS_ON()
// Verify that the popup document's owner is the main document.
LocalFrame* frame = document.GetFrame();
DCHECK(frame);
Element* popup_owner = frame->PagePopupOwner();
DCHECK(popup_owner);
DCHECK_EQ(popup_owner->GetDocument(), GetDocument())
<< "The popup document's owner should be in the main document.";
Page* main_page = GetDocument().GetPage();
DCHECK(main_page);
#endif
return &document == GetPopupDocumentIfShowing();
}
return is_popup;
}
AXObjectCacheImpl::TreeUpdateCallbackQueue&
AXObjectCacheImpl::GetTreeUpdateCallbackQueue(Document& document) {
return IsPopup(document) ? tree_update_callback_queue_popup_
: tree_update_callback_queue_main_;
}
void AXObjectCacheImpl::ProcessCleanLayoutCallbacks(Document& document) {
SCOPED_DISALLOW_LIFECYCLE_TRANSITION();
UpdateNumTreeUpdatesQueuedBeforeLayoutHistogram();
CHECK(!IsFrozen());
TreeUpdateCallbackQueue old_tree_update_callback_queue;
GetTreeUpdateCallbackQueue(document).swap(old_tree_update_callback_queue);
nodes_with_pending_children_changed_.clear();
last_value_change_node_ = ui::AXNodeData::kInvalidAXID;
for (TreeUpdateParams* tree_update : old_tree_update_callback_queue) {
if (tree_update->node) {
if (tree_update->node->GetDocument() == document) {
FireTreeUpdatedEventForNode(tree_update);
}
} else {
FireTreeUpdatedEventForAXID(tree_update, document);
}
}
}
void AXObjectCacheImpl::PostNotification(const LayoutObject* layout_object,
ax::mojom::blink::Event notification) {
if (!layout_object)
return;
PostNotification(Get(layout_object), notification);
}
void AXObjectCacheImpl::PostNotification(Node* node,
ax::mojom::blink::Event notification) {
if (!node)
return;
PostNotification(Get(node), notification);
}
void AXObjectCacheImpl::PostNotification(AXObject* object,
ax::mojom::blink::Event event_type) {
if (!object || !object->AXObjectID() || object->IsDetached())
return;
ax::mojom::blink::EventFrom event_from = ComputeEventFrom();
// If PostNotification is called while outside of processing deferred events,
// defer it to to happen later while processing deferred_events.
// TODO(accessibility): Replace calls of PostNotification with direct cleaner
// calls to DeferTreeUpdate.
if (lifecycle_.StateAllowsDeferTreeUpdates()) {
// TODO(accessibility): Investigate why invalidate_cached_values needs to be
// false here and maybe remove it from signature once it's not needed
// anymore.
DeferTreeUpdate(TreeUpdateReason::kDelayEventFromPostNotification, object,
event_type, /*invalidate_cached_values=*/false);
if (IsImmediateProcessingRequiredForEvent(event_from, object, event_type)) {
ScheduleImmediateSerialization();
}
return;
}
ax::mojom::blink::Action event_from_action = active_event_from_action_;
const BlinkAXEventIntentsSet& event_intents = ActiveEventIntents();
#if DCHECK_IS_ON()
// Make sure that we're not in the process of being laid out. Notifications
// should only be sent after the LayoutObject has finished
DCHECK(GetDocument().Lifecycle().GetState() !=
DocumentLifecycle::kInPerformLayout);
SCOPED_DISALLOW_LIFECYCLE_TRANSITION();
#endif // DCHECK_IS_ON()
PostPlatformNotification(object, event_type, event_from, event_from_action,
event_intents);
}
void AXObjectCacheImpl::ScheduleAXUpdate() const {
// A visual update will force accessibility to be updated as well.
// Scheduling visual updates before the document is finished loading can
// interfere with event ordering. In any case, at least one visual update will
// occur between now and when the document load is complete.
if (!GetDocument().IsLoadCompleted())
return;
// If there was a document change that doesn't trigger a lifecycle update on
// its own, (e.g. because it doesn't make layout dirty), make sure we run
// lifecycle phases to update the computed accessibility tree.
LocalFrameView* frame_view = GetDocument().View();
Page* page = GetDocument().GetPage();
if (!frame_view || !page)
return;
if (!frame_view->CanThrottleRendering() &&
!GetDocument().GetPage()->Animator().IsServicingAnimations()) {
page->Animator().ScheduleVisualUpdate(GetDocument().GetFrame());
}
}
void AXObjectCacheImpl::ScheduleAXUpdateWithCallback(
base::OnceClosure callback) {
ready_callbacks_.push_back(std::move(callback));
ScheduleAXUpdate();
}
void AXObjectCacheImpl::FireTreeUpdatedEventForAXID(
TreeUpdateParams* tree_update,
Document& document) {
if (!tree_update->axid) {
// No node and no AXID means that it was a node update, but the
// WeakMember<Node> is no longer available.
return;
}
AXObject* ax_object = ObjectFromAXID(tree_update->axid);
if (!ax_object || ax_object->IsDetached()) {
return;
}
if (ax_object->GetNode() && !ax_object->GetNode()->isConnected()) {
return;
}
if (document != *ax_object->GetDocument()) {
return;
}
CHECK(!ax_object->IsMissingParent(), base::NotFatalUntil::M140)
<< tree_update->ToString() << " on " << ax_object;
// Update cached attributes for all changed nodes before serialization,
// because updating ignored/included can cause tree structure changes, and
// the tree structure needs to be stable before serialization begins.
ax_object->UpdateCachedAttributeValuesIfNeeded(/* notify_parent */ true);
if (ax_object->IsDetached()) {
return;
}
base::AutoReset<ax::mojom::blink::EventFrom> event_from_resetter(
&active_event_from_, tree_update->event_from);
base::AutoReset<ax::mojom::blink::Action> event_from_action_resetter(
&active_event_from_action_, tree_update->event_from_action);
ScopedBlinkAXEventIntent defered_event_intents(
WTF::ToVector(tree_update->event_intents.Values()),
ax_object->GetDocument());
// Kept here for convenient debugging:
// LOG(ERROR) << tree_update->ToString() << " on " << ax_object;
switch (tree_update->update_reason) {
case TreeUpdateReason::kChildrenChanged:
ChildrenChangedWithCleanLayout(ax_object->GetNode(), ax_object);
break;
case TreeUpdateReason::kDelayEventFromPostNotification:
PostNotification(ax_object, tree_update->event);
break;
case TreeUpdateReason::kMarkAXObjectDirty:
MarkAXObjectDirtyWithCleanLayout(ax_object);
break;
case TreeUpdateReason::kMarkAXSubtreeDirty:
MarkAXSubtreeDirtyWithCleanLayout(ax_object);
break;
case TreeUpdateReason::kTextChangedOnLayoutObject:
TextChangedWithCleanLayout(ax_object->GetNode(), ax_object);
break;
default:
NOTREACHED() << "Update reason not handled: "
<< static_cast<int>(tree_update->update_reason);
}
// Ensure that new subtrees are filled out. Any new AXObjects added will
// also add their children.
if (!ax_object->IsDetached()) {
ax_object->UpdateChildrenIfNecessary();
}
}
void AXObjectCacheImpl::FireTreeUpdatedEventForNode(
TreeUpdateParams* tree_update) {
Node* node = tree_update->node;
CHECK(node);
if (!node->isConnected()) {
return;
}
// kRestoreParentOrPrune does not require an up-to-date AXObject.
if (tree_update->update_reason == TreeUpdateReason::kRestoreParentOrPrune) {
RestoreParentOrPruneWithCleanLayout(node);
return;
}
AXObject* ax_object = Get(node);
if (!ax_object) {
return;
}
ax_object->UpdateCachedAttributeValuesIfNeeded(/* notify_parent */ true);
if (ax_object->IsDetached()) {
return;
}
CHECK(!ax_object->IsMissingParent(), base::NotFatalUntil::M140)
<< tree_update->ToString() << " on " << ax_object;
base::AutoReset<ax::mojom::blink::EventFrom> event_from_resetter(
&active_event_from_, tree_update->event_from);
base::AutoReset<ax::mojom::blink::Action> event_from_action_resetter(
&active_event_from_action_, tree_update->event_from_action);
ScopedBlinkAXEventIntent defered_event_intents(
WTF::ToVector(tree_update->event_intents.Values()), &node->GetDocument());
// Kept here for convenient debugging:
// LOG(ERROR) << tree_update->ToString() << " on " << ax_object;
switch (tree_update->update_reason) {
case TreeUpdateReason::kActiveDescendantChanged:
HandleActiveDescendantChangedWithCleanLayout(node);
break;
case TreeUpdateReason::kAriaExpandedChanged:
HandleAriaExpandedChangeWithCleanLayout(node);
break;
case TreeUpdateReason::kAriaPressedChanged:
HandleAriaPressedChangedWithCleanLayout(node);
break;
case TreeUpdateReason::kAriaSelectedChanged:
HandleAriaSelectedChangedWithCleanLayout(node);
break;
case TreeUpdateReason::kCSSAnchorChanged:
CSSAnchorChangedWithCleanLayout(node);
break;
case TreeUpdateReason::kDidShowMenuListPopup:
HandleUpdateMenuListPopupWithCleanLayout(node, /*did_show*/ true);
break;
case TreeUpdateReason::kMaybeDisallowImplicitSelection:
MaybeDisallowImplicitSelectionWithCleanLayout(ax_object);
break;
case TreeUpdateReason::kEditableTextContentChanged:
HandleEditableTextContentChangedWithCleanLayout(node);
break;
case TreeUpdateReason::kIdChanged:
// When the id attribute changes, the relations its in may also change.
MaybeNewRelationTarget(*node, ax_object);
break;
case TreeUpdateReason::kNodeGainedFocus:
HandleNodeGainedFocusWithCleanLayout(node);
break;
case TreeUpdateReason::kNodeLostFocus:
HandleNodeLostFocusWithCleanLayout(node);
break;
case TreeUpdateReason::kPostNotificationFromHandleLoadComplete:
case TreeUpdateReason::kPostNotificationFromHandleLoadStart:
case TreeUpdateReason::kPostNotificationFromHandleScrolledToAnchor:
PostNotification(node, tree_update->event);
break;
case TreeUpdateReason::kReferenceTargetChanged:
// When a shadow root's reference target changes, relations referring
// to the shadow host may change since they will be forwarded to
// the new reference target.
MaybeNewRelationTarget(*node, ax_object);
break;
case TreeUpdateReason::kRemoveValidationMessageObjectFromFocusedUIElement:
RemoveValidationMessageObjectWithCleanLayout(node);
break;
case TreeUpdateReason::kRoleChangeFromAriaHasPopup:
case TreeUpdateReason::kRoleChangeFromImageMapName:
case TreeUpdateReason::kRoleChangeFromRoleOrType:
HandleRoleChangeWithCleanLayout(node);
break;
case TreeUpdateReason::kRoleMaybeChangedFromEventListener:
case TreeUpdateReason::kRoleMaybeChangedFromHref:
case TreeUpdateReason::kRoleMaybeChangedOnSelect:
HandleRoleMaybeChangedWithCleanLayout(node);
break;
case TreeUpdateReason::kSectionOrRegionRoleMaybeChangedFromLabel:
case TreeUpdateReason::kSectionOrRegionRoleMaybeChangedFromLabelledBy:
case TreeUpdateReason::kSectionOrRegionRoleMaybeChangedFromTitle:
SectionOrRegionRoleMaybeChangedWithCleanLayout(node);
break;
case TreeUpdateReason::kTextChangedOnNode:
case TreeUpdateReason::kTextChangedOnClosestNodeForLayoutObject:
TextChangedWithCleanLayout(node);
break;
case TreeUpdateReason::kTextMarkerDataAdded:
HandleTextMarkerDataAddedWithCleanLayout(node);
break;
case TreeUpdateReason::kUpdateActiveMenuOption:
HandleUpdateMenuListPopupWithCleanLayout(node);
break;
case TreeUpdateReason::kNodeIsAttached:
NodeIsAttachedWithCleanLayout(node);
break;
case TreeUpdateReason::kUpdateAriaOwns:
UpdateAriaOwnsWithCleanLayout(node);
break;
case TreeUpdateReason::kUpdateTableRole:
UpdateTableRoleWithCleanLayout(node);
break;
case TreeUpdateReason::kUseMapAttributeChanged:
HandleUseMapAttributeChangedWithCleanLayout(node);
break;
case TreeUpdateReason::kValidationMessageVisibilityChanged:
HandleValidationMessageVisibilityChangedWithCleanLayout(node);
break;
default:
NOTREACHED() << "Update reason not handled: "
<< static_cast<int>(tree_update->update_reason);
}
// Ensure that new subtrees are filled out. Any new AXObjects added will
// also add their children.
if (!ax_object->IsDetached()) {
ax_object->UpdateChildrenIfNecessary();
}
}
bool AXObjectCacheImpl::IsAriaOwned(const AXObject* object, bool checks) const {
return relation_cache_ ? relation_cache_->IsAriaOwned(object, checks) : false;
}
AXObject* AXObjectCacheImpl::ValidatedAriaOwner(const AXObject* object) const {
DCHECK(GetDocument().Lifecycle().GetState() >=
DocumentLifecycle::kLayoutClean);
CHECK(relation_cache_);
return relation_cache_->ValidatedAriaOwner(object);
}
void AXObjectCacheImpl::ValidatedAriaOwnedChildren(
const AXObject* owner,
HeapVector<Member<AXObject>>& owned_children) {
DCHECK(GetDocument().Lifecycle().GetState() >=
DocumentLifecycle::kLayoutClean);
CHECK(relation_cache_);
relation_cache_->ValidatedAriaOwnedChildren(owner, owned_children);
}
bool AXObjectCacheImpl::MayHaveHTMLLabel(const HTMLElement& elem) {
CHECK(elem.GetDocument().Lifecycle().GetState() >=
DocumentLifecycle::kLayoutClean)
<< "Unclean document at lifecycle " << elem.GetDocument().ToString();
CHECK(relation_cache_);
// Return false if this type of element will not accept a <label for> label.
if (!elem.IsLabelable())
return false;
// Return true if a <label for> pointed to this element at some point.
if (relation_cache_->MayHaveHTMLLabelViaForAttribute(elem)) {
return true;
}
// Return true if any ancestor is a label, as in <label><input></label>.
if (Traversal<HTMLLabelElement>::FirstAncestor(elem)) {
return true;
}
// If the element is the reference target of its shadow host, also check if
// the host may have a label.
if (ShadowRoot* shadow_root = elem.ContainingShadowRoot()) {
if (shadow_root->referenceTargetElement() == &elem) {
if (HTMLElement* host = DynamicTo<HTMLElement>(shadow_root->host())) {
return MayHaveHTMLLabel(*host);
}
}
}
return false;
}
bool AXObjectCacheImpl::IsLabelOrDescription(Element& element) {
if (IsA<HTMLLabelElement>(element)) {
return true;
}
CHECK(relation_cache_);
return relation_cache_ && relation_cache_->IsARIALabelOrDescription(element);
}
void AXObjectCacheImpl::CheckedStateChanged(Node* node) {
PostNotification(node, ax::mojom::blink::Event::kCheckedStateChanged);
}
void AXObjectCacheImpl::ListboxOptionStateChanged(HTMLOptionElement* option) {
PostNotification(option, ax::mojom::Event::kCheckedStateChanged);
}
void AXObjectCacheImpl::ListboxSelectedChildrenChanged(
HTMLSelectElement* select) {
PostNotification(select, ax::mojom::Event::kSelectedChildrenChanged);
}
void AXObjectCacheImpl::ListboxActiveIndexChanged(HTMLSelectElement* select) {
SCOPED_DISALLOW_LIFECYCLE_TRANSITION();
if (select->IsFocused()) {
if (HTMLOptionElement* option = select->ActiveSelectionEnd()) {
DOMNodeId option_id = option->GetDomNodeId();
if (option_id != last_selected_list_option_) {
PostNotification(select,
ax::mojom::blink::Event::kActiveDescendantChanged);
last_selected_list_option_ = option_id;
}
}
}
}
void AXObjectCacheImpl::SetMenuListOptionsBounds(
HTMLSelectElement* select,
const WTF::Vector<gfx::Rect>& options_bounds) {
CHECK(select->PopupIsVisible());
CHECK_EQ(select->GetDocument(), GetDocument());
options_bounds_ = options_bounds;
current_menu_list_axid_ = select->GetDomNodeId();
}
const WTF::Vector<gfx::Rect>* AXObjectCacheImpl::GetOptionsBounds(
const AXObject& ax_menu_list) const {
if (RuntimeEnabledFeatures::CustomizableSelectEnabled()) {
// Customizable select does not render in a special popup document and does
// not need to supply bounding boxes via options_bounds_.
HTMLSelectElement* select = To<HTMLSelectElement>(ax_menu_list.GetNode());
if (select->IsAppearanceBasePicker()) {
CHECK(!current_menu_list_axid_);
CHECK(options_bounds_.empty());
return nullptr;
}
}
if (!current_menu_list_axid_ ||
current_menu_list_axid_ != ax_menu_list.AXObjectID()) {
return nullptr;
}
CHECK_EQ(ax_menu_list.IsExpanded(), kExpandedExpanded);
CHECK(options_bounds_.size());
return &options_bounds_;
}
void AXObjectCacheImpl::ImageLoaded(const LayoutObject* layout_object) {
MarkElementDirty(layout_object->GetNode());
}
void AXObjectCacheImpl::HandleClicked(Node* node) {
if (AXObject* obj = Get(node)) {
PostNotification(obj, ax::mojom::Event::kClicked);
}
}
void AXObjectCacheImpl::HandleAriaNotification(
const Node* node,
const String& announcement,
const AriaNotificationOptions* options) {
auto* obj = Get(node);
if (!obj) {
return;
}
// We use `insert` regardless of whether there is an entry for this node in
// `aria_notifications_` since, if there is one, it won't be replaced.
// The return value of `insert` is a pair of an iterator to the entry, called
// `stored_value`, and a boolean; `stored_value` contains a pair with the key
// of the entry and a `value` reference to its mapped `AriaNotifications`.
auto& node_notifications =
aria_notifications_.insert(obj->AXObjectID(), AriaNotifications())
.stored_value->value;
node_notifications.Add(announcement, options);
DeferTreeUpdate(TreeUpdateReason::kMarkAXObjectDirty, obj);
}
AriaNotifications AXObjectCacheImpl::RetrieveAriaNotifications(
const AXObject* obj) {
DCHECK(obj);
// Conveniently, `Take` returns an empty `AriaNotifications` if there's no
// entry in `aria_notifications_` associated to the given object.
return aria_notifications_.Take(obj->AXObjectID());
}
void AXObjectCacheImpl::UpdateTableRoleWithCleanLayout(Node* table) {
if (AXObject* ax_table = Get(table)) {
if (ax_table->RoleValue() == ax::mojom::blink::Role::kLayoutTable &&
ax_table->IsDataTable()) {
HandleRoleChangeWithCleanLayout(table);
}
}
}
void AXObjectCacheImpl::HandleAriaExpandedChangeWithCleanLayout(Node* node) {
if (!node)
return;
SCOPED_DISALLOW_LIFECYCLE_TRANSITION();
DCHECK(!node->GetDocument().NeedsLayoutTreeUpdateForNode(*node));
if (AXObject* obj = Get(node)) {
obj->HandleAriaExpandedChanged();
}
}
void AXObjectCacheImpl::HandleAriaPressedChangedWithCleanLayout(Node* node) {
AXObject* ax_object = Get(node);
if (!ax_object)
return;
ax::mojom::blink::Role previous_role = ax_object->RoleValue();
bool was_toggle_button =
previous_role == ax::mojom::blink::Role::kToggleButton;
bool is_toggle_button =
ax_object->HasAriaAttribute(html_names::kAriaPressedAttr);
if (was_toggle_button != is_toggle_button)
HandleRoleChangeWithCleanLayout(node);
else
PostNotification(node, ax::mojom::blink::Event::kCheckedStateChanged);
}
void AXObjectCacheImpl::MaybeDisallowImplicitSelectionWithCleanLayout(
AXObject* subwidget) {
bool do_notify = false;
switch (subwidget->RoleValue()) {
case ax::mojom::blink::Role::kTab:
if (subwidget->HasAriaAttribute(html_names::kAriaExpandedAttr) ||
subwidget->HasAriaAttribute(html_names::kAriaSelectedAttr)) {
do_notify = true;
}
break;
case ax::mojom::blink::Role::kListBoxOption:
case ax::mojom::blink::Role::kMenuListOption:
case ax::mojom::blink::Role::kTreeItem:
if (subwidget->HasAriaAttribute(html_names::kAriaSelectedAttr) ||
subwidget->HasAriaAttribute(html_names::kAriaCheckedAttr)) {
do_notify = true;
}
break;
default:
return;
}
if (!do_notify) {
return;
}
if (AXObject* container = subwidget->ContainerWidget()) {
if (container->IsMultiSelectable()) {
// Multi-selectable containers do not allow implicit selection, so
// we can skip the remaining checks.
return;
}
if (containers_disallowing_implicit_selection_
.insert(container->AXObjectID())
.is_new_entry) {
if (subwidget->RoleValue() == ax::mojom::blink::Role::kTab) {
// Tabs are a special case, because tab selection can be implicit via
// focus of an element inside the tab panel it controls. For these, mark
// all of the child tabs within the containing tablist dirty.
for (const auto& child : container->CachedChildrenIncludingIgnored()) {
AddDirtyObjectToSerializationQueue(child);
}
return;
}
// The active descendant or focus may lose its implicit selected state.
Node* focus = FocusedNode();
if (focus == container->GetNode()) {
if (const Element* activedescendant =
AXObject::ElementFromAttributeOrInternals(
container->GetElement(),
html_names::kAriaActivedescendantAttr)) {
if (const AXObject* ax_activedescendant = Get(activedescendant)) {
AddDirtyObjectToSerializationQueue(ax_activedescendant);
}
}
}
if (const AXObject* ax_focus = Get(focus)) {
AddDirtyObjectToSerializationQueue(ax_focus);
}
}
}
}
bool AXObjectCacheImpl::IsImplicitSelectionAllowed(const AXObject* container) {
DCHECK(container);
return !containers_disallowing_implicit_selection_.Contains(
container->AXObjectID());
}
// In single selection containers, selection follows focus, so a selection
// changed event must be fired. This ensures the AT is notified that the
// selected state has changed, so that it does not read "unselected" as
// the user navigates through the items. The event generator will handle
// the correct events as long as the old and newly selected objects are marked
// dirty.
void AXObjectCacheImpl::HandleAriaSelectedChangedWithCleanLayout(Node* node) {
DCHECK(node);
SCOPED_DISALLOW_LIFECYCLE_TRANSITION();
DCHECK(!node->GetDocument().NeedsLayoutTreeUpdateForNode(*node));
AXObject* obj = Get(node);
if (!obj)
return;
// Mark the previous selected item dirty if it was selected via "selection
// follows focus".
if (last_selected_from_active_descendant_)
MarkElementDirtyWithCleanLayout(last_selected_from_active_descendant_);
// Mark the newly selected item dirty, and track it for use in the future.
MarkAXObjectDirtyWithCleanLayout(obj);
if (obj->IsSelectedFromFocus())
last_selected_from_active_descendant_ = node;
PostNotification(obj, ax::mojom::Event::kCheckedStateChanged);
// TODO(accessibility): this may no longer be needed as it can be generated
// from the browser side, and could be expensive for many items.
AXObject* listbox = obj->ParentObjectUnignored();
if (listbox && listbox->RoleValue() == ax::mojom::Role::kListBox) {
// Ensure listbox options are in sync as selection status may have changed
MarkAXSubtreeDirtyWithCleanLayout(listbox);
PostNotification(listbox, ax::mojom::Event::kSelectedChildrenChanged);
}
}
void AXObjectCacheImpl::HandleNodeLostFocusWithCleanLayout(Node* node) {
DCHECK(node);
DCHECK(!node->GetDocument().NeedsLayoutTreeUpdateForNode(*node));
AXObject* obj = Get(node);
if (!obj)
return;
PostNotification(obj, ax::mojom::Event::kBlur);
if (AXObject* active_descendant = obj->ActiveDescendant()) {
if (active_descendant->IsSelectedFromFocusSupported())
HandleAriaSelectedChangedWithCleanLayout(active_descendant->GetNode());
}
}
void AXObjectCacheImpl::HandleNodeGainedFocusWithCleanLayout(Node* node) {
AXObject* obj = EnsureFocusedObject();
PostNotification(obj, ax::mojom::Event::kFocus);
if (AXObject* active_descendant = obj->ActiveDescendant()) {
if (active_descendant->IsSelectedFromFocusSupported())
HandleAriaSelectedChangedWithCleanLayout(active_descendant->GetNode());
}
}
// This might be the new target of a relation. Handle all possible cases.
void AXObjectCacheImpl::MaybeNewRelationTarget(Node& node, AXObject* obj) {
// Track reverse relations
CHECK(relation_cache_);
relation_cache_->UpdateRelatedTree(&node, obj);
if (Element* element = DynamicTo<Element>(node)) {
relation_cache_->UpdateRelatedTreeAfterChange(*element);
}
}
void AXObjectCacheImpl::HandleActiveDescendantChangedWithCleanLayout(
Node* node) {
DCHECK(node);
DCHECK(!node->GetDocument().NeedsLayoutTreeUpdateForNode(*node));
if (AXObject* obj = Get(node)) {
obj->HandleActiveDescendantChanged();
}
}
// A <section> or role=region uses the region role if and only if it has a name.
void AXObjectCacheImpl::SectionOrRegionRoleMaybeChangedWithCleanLayout(
Node* node) {
TextChangedWithCleanLayout(node);
Element* element = To<Element>(node);
AXObject* ax_object = Get(element);
if (!ax_object)
return;
// Require <section> or role="region" markup.
if (!element->HasTagName(html_names::kSectionTag) &&
ax_object->DetermineRawAriaRole() != ax::mojom::blink::Role::kRegion) {
return;
}
HandleRoleMaybeChangedWithCleanLayout(element);
}
void AXObjectCacheImpl::TableCellRoleMaybeChanged(Node* node) {
if (!node) {
return;
}
// The role for a table cell depends in complex ways on multiple of its
// siblings (see DecideRoleFromSiblings). Rather than attempt to reproduce
// that logic here for invalidation, just recompute the role of all siblings
// when new table cells are added.
if (auto* cell = DynamicTo<HTMLTableCellElement>(node)) {
for (auto* prev = LayoutTreeBuilderTraversal::PreviousSibling(*cell); prev;
prev = LayoutTreeBuilderTraversal::PreviousSibling(*prev)) {
HandleRoleMaybeChangedWithCleanLayout(prev);
}
HandleRoleMaybeChangedWithCleanLayout(cell);
for (auto* next = LayoutTreeBuilderTraversal::NextSibling(*cell); next;
next = LayoutTreeBuilderTraversal::PreviousSibling(*next)) {
HandleRoleMaybeChangedWithCleanLayout(next);
}
}
}
void AXObjectCacheImpl::HandleRoleMaybeChangedWithCleanLayout(Node* node) {
if (AXObject* obj = Get(node)) {
// If role would stay the same, do nothing.
if (obj->RoleValue() == obj->DetermineRoleValue()) {
return;
}
HandleRoleChangeWithCleanLayout(node);
}
}
// Be as safe as possible about changes that could alter the accessibility role,
// as this may require a different subclass of AXObject.
// Role changes are disallowed by the spec but we must handle it gracefully, see
// https://www.w3.org/TR/wai-aria-1.1/#h-roles for more information.
void AXObjectCacheImpl::HandleRoleChangeWithCleanLayout(Node* node) {
DCHECK(node);
DCHECK(!node->GetDocument().NeedsLayoutTreeUpdateForNode(*node));
// Remove the current object and make the parent reconsider its children.
if (AXObject* obj = Get(node)) {
bool was_owned = IsAriaOwned(obj);
AXObject* parent = obj->ParentObjectIncludedInTree();
ChildrenChangedOnAncestorOf(obj);
// The positioned object may have changed to/from a tooltip so a details
// relationship may need to be added/removed from the anchor.
if (AXObject* anchor = relation_cache_->GetAnchorForPositionedObject(obj)) {
MarkElementDirtyWithCleanLayout(anchor->GetElement());
}
if (!obj->IsDetached()) {
// Remove and rebuild the subtree, because some descendant computations
// rely on the role of ancestors.
// Examples, whether rows return true from SupportsNameFromContents(),
// propagation of role="none", some table descendant roles.
RemoveSubtree(node, /* remove_root */ true, /* notify_parent */ false);
}
if (was_owned) {
relation_cache_->UpdateAriaOwnsWithCleanLayout(parent, /*force*/ true);
}
// A previous call could have detached the parent.
if (parent->IsDetached()) {
return;
}
// Calling GetOrCreate(node) will not only create a new object with the
// correct role, it will also repair all parent-child relationships from the
// included ancestor done. If a new AXObject is not possible it will remove
// the subtree.
parent->UpdateChildrenIfNecessary();
if (AXObject* new_object = Get(node)) {
relation_cache_->UpdateAriaOwnsWithCleanLayout(new_object,
/*force*/ true);
new_object->UpdateChildrenIfNecessary();
// Need to mark dirty because the dom_node_id-based ID remains the same,
// and therefore the serializer may not automatically serialize this node
// from the children changed on the parent.
MarkAXSubtreeDirtyWithCleanLayout(new_object);
}
}
}
void AXObjectCacheImpl::HandleAttributeChanged(const QualifiedName& attr_name,
Element* element) {
DCHECK(element);
if (attr_name.LocalName().StartsWith("aria-")) {
// Perform updates specific to each attribute.
if (attr_name == html_names::kAriaActivedescendantAttr) {
if (relation_cache_) {
relation_cache_->UpdateReverseActiveDescendantRelations(*element);
}
DeferTreeUpdate(TreeUpdateReason::kActiveDescendantChanged, element);
} else if (attr_name == html_names::kAriaValuenowAttr ||
attr_name == html_names::kAriaValuetextAttr) {
HandleValueChanged(element);
} else if (attr_name == html_names::kAriaLabelAttr) {
TextChanged(element);
DeferTreeUpdate(
TreeUpdateReason::kSectionOrRegionRoleMaybeChangedFromLabel, element);
} else if (attr_name == html_names::kAriaLabeledbyAttr ||
attr_name == html_names::kAriaLabelledbyAttr) {
if (relation_cache_) {
relation_cache_->UpdateReverseTextRelations(*element, attr_name);
}
DeferTreeUpdate(
TreeUpdateReason::kSectionOrRegionRoleMaybeChangedFromLabelledBy,
element);
TextChanged(element);
} else if (attr_name == html_names::kAriaDescriptionAttr) {
TextChanged(element);
} else if (attr_name == html_names::kAriaDescribedbyAttr) {
if (relation_cache_) {
relation_cache_->UpdateReverseTextRelations(*element, attr_name);
}
TextChanged(element);
} else if (attr_name == html_names::kAriaCheckedAttr) {
PostNotification(element, ax::mojom::blink::Event::kCheckedStateChanged);
DeferTreeUpdate(TreeUpdateReason::kMaybeDisallowImplicitSelection,
element);
} else if (attr_name == html_names::kAriaPressedAttr) {
DeferTreeUpdate(TreeUpdateReason::kAriaPressedChanged, element);
} else if (attr_name == html_names::kAriaSelectedAttr) {
DeferTreeUpdate(TreeUpdateReason::kAriaSelectedChanged, element);
DeferTreeUpdate(TreeUpdateReason::kMaybeDisallowImplicitSelection,
element);
} else if (attr_name == html_names::kAriaMultiselectableAttr) {
if (element == FocusedNode()) {
// Even though active descendant didn't necessarily change, we want
// to mark it dirty, because it could lose an implicit selected state.
DeferTreeUpdate(TreeUpdateReason::kActiveDescendantChanged, element);
} else {
MarkElementDirty(FocusedNode());
}
MarkElementDirty(element);
} else if (attr_name == html_names::kAriaExpandedAttr) {
DeferTreeUpdate(TreeUpdateReason::kAriaExpandedChanged, element);
DeferTreeUpdate(TreeUpdateReason::kMaybeDisallowImplicitSelection,
element);
} else if (attr_name == html_names::kAriaHiddenAttr) {
// Removing the subtree will also notify its parent that children changed,
// causing the subtree to recursively be rebuilt with correct cached
// values. In addition, changes to aria-hidden can affect with aria-owns
// within the subtree are considered valid. Removing the subtree forces
// any stale assumptions regarding aria-owns to be tossed, and the
// resulting tree structure changes to occur as the subtree is rebuilt,
// including restoring the natural parent of previously owned children
// if the owner becomes aria-hidden.
RemoveSubtree(element);
} else if (attr_name == html_names::kAriaOwnsAttr) {
if (relation_cache_) {
relation_cache_->UpdateReverseOwnsRelations(*element);
}
DeferTreeUpdate(TreeUpdateReason::kUpdateAriaOwns, element);
} else if (attr_name == html_names::kAriaHaspopupAttr) {
if (AXObject* obj = Get(element)) {
if (obj->RoleValue() == ax::mojom::blink::Role::kButton ||
obj->RoleValue() == ax::mojom::blink::Role::kPopUpButton) {
// The aria-haspopup attribute can switch the role between kButton and
// kPopupButton.
DeferTreeUpdate(TreeUpdateReason::kRoleChangeFromAriaHasPopup,
element);
} else {
MarkElementDirty(element);
}
}
} else if (attr_name == html_names::kAriaActionsAttr ||
attr_name == html_names::kAriaControlsAttr ||
attr_name == html_names::kAriaDetailsAttr ||
attr_name == html_names::kAriaErrormessageAttr ||
attr_name == html_names::kAriaFlowtoAttr) {
MarkElementDirty(element);
if (relation_cache_) {
relation_cache_->UpdateReverseOtherRelations(*element);
}
} else {
MarkElementDirty(element);
}
return;
}
if (attr_name == html_names::kRoleAttr ||
attr_name == html_names::kTypeAttr) {
DeferTreeUpdate(TreeUpdateReason::kRoleChangeFromRoleOrType, element);
} else if (attr_name == html_names::kSizeAttr ||
attr_name == html_names::kMultipleAttr) {
if (IsA<HTMLSelectElement>(element)) {
DeferTreeUpdate(TreeUpdateReason::kRoleMaybeChangedOnSelect, element);
}
} else if (attr_name == html_names::kAltAttr) {
TextChanged(element);
} else if (attr_name == html_names::kTitleAttr) {
DeferTreeUpdate(TreeUpdateReason::kSectionOrRegionRoleMaybeChangedFromTitle,
element);
} else if (attr_name == html_names::kForAttr) {
if (relation_cache_) {
if (HTMLLabelElement* label = DynamicTo<HTMLLabelElement>(element)) {
if (Node* label_target = relation_cache_->LabelChanged(*label)) {
// If label_target's subtree was ignored because it was hidden, it
// will no longer be, because labels must be unignored to partake
// in name calculations.
MarkElementDirty(label_target);
}
}
}
} else if (attr_name == html_names::kIdAttr) {
DeferTreeUpdate(TreeUpdateReason::kIdChanged, element);
} else if (attr_name == html_names::kClassAttr) {
MarkElementDirty(element); // Reserialize the class.
} else if (attr_name == html_names::kTabindexAttr) {
MarkElementDirty(element);
} else if (attr_name == html_names::kValueAttr) {
HandleValueChanged(element);
} else if (attr_name == html_names::kDisabledAttr ||
attr_name == html_names::kReadonlyAttr ||
attr_name == html_names::kMinAttr ||
attr_name == html_names::kMaxAttr ||
attr_name == html_names::kStepAttr) {
MarkElementDirty(element);
} else if (attr_name == html_names::kUsemapAttr) {
DeferTreeUpdate(TreeUpdateReason::kUseMapAttributeChanged, element);
} else if (attr_name == html_names::kNameAttr) {
HandleNameAttributeChanged(element);
} else if (attr_name == html_names::kControlsAttr) {
ChildrenChanged(element);
} else if (attr_name == html_names::kHrefAttr) {
DeferTreeUpdate(TreeUpdateReason::kRoleMaybeChangedFromHref, element);
} else if (attr_name == html_names::kLangAttr) {
MarkElementDirty(element);
// ATs may look at the language of the document as a whole on the root web
// area. Since the root's language can come from the <html> element's
// language, if the language changes on <html>, we need to update the root.
if (element == document_->documentElement()) {
MarkElementDirty(document_);
}
}
}
void AXObjectCacheImpl::HandleUseMapAttributeChangedWithCleanLayout(
Node* node) {
if (!IsA<HTMLImageElement>(node)) {
return;
}
// Get an area (aka image link) from the previous usemap.
AXObject* ax_image = Get(node);
AXObject* ax_image_link =
ax_image ? ax_image->FirstChildIncludingIgnored() : nullptr;
HTMLMapElement* previous_map =
ax_image_link && ax_image_link->GetNode()
? Traversal<HTMLMapElement>::FirstAncestor(*ax_image_link->GetNode())
: nullptr;
// Both the old and new image may change image <--> image map.
HandleRoleChangeWithCleanLayout(node);
if (previous_map)
HandleRoleChangeWithCleanLayout(previous_map->ImageElement());
}
void AXObjectCacheImpl::HandleNameAttributeChanged(Node* node) {
HTMLMapElement* map = DynamicTo<HTMLMapElement>(node);
if (!map) {
return;
}
// Changing a map name can alter an image's role and children.
// First update any image that may have used the old map name.
if (AXObject* ax_previous_image = GetAXImageForMap(*map)) {
DeferTreeUpdate(TreeUpdateReason::kRoleChangeFromImageMapName,
ax_previous_image->GetElement());
}
// Then, update any image which may use the new map name.
HTMLImageElement* new_image = map->ImageElement();
if (new_image) {
if (AXObject* obj = Get(new_image)) {
DeferTreeUpdate(TreeUpdateReason::kRoleChangeFromImageMapName,
obj->GetElement());
}
}
}
AXObject* AXObjectCacheImpl::GetOrCreateValidationMessageObject() {
// New AXObjects cannot be created when the tree is frozen.
AXObject* message_ax_object = nullptr;
// Create only if it does not already exist.
if (validation_message_axid_) {
message_ax_object = ObjectFromAXID(validation_message_axid_);
}
if (message_ax_object) {
DCHECK(!message_ax_object->IsDetached());
if (message_ax_object->IsMissingParent()) {
message_ax_object->SetParent(Root()); // Reattach to parent (root).
} else {
DCHECK(message_ax_object->ParentObject() == Root());
}
} else {
if (IsFrozen()) {
return nullptr;
}
message_ax_object = MakeGarbageCollected<AXValidationMessage>(*this);
CHECK(message_ax_object);
CHECK(!message_ax_object->IsDetached());
// Cache the validation message container for reuse.
validation_message_axid_ = AssociateAXID(message_ax_object);
// Validation message alert object is a child of the document, as not all
// form controls can have a child. Also, there are form controls such as
// listbox that technically can have children, but they are probably not
// expected to have alerts within AT client code.
message_ax_object->Init(Root());
}
CHECK(!message_ax_object->IsDetached());
return message_ax_object;
}
AXObject* AXObjectCacheImpl::ValidationMessageObjectIfInvalid() {
Element* focused_element = document_->FocusedElement();
if (focused_element) {
ListedElement* form_control = ListedElement::From(*focused_element);
if (form_control && !form_control->IsNotCandidateOrValid()) {
// These must both be true:
// * Focused control is currently invalid.
// * Validation message was previously created but hidden
// from timeout or currently visible.
bool was_validation_message_already_created = validation_message_axid_;
if (was_validation_message_already_created ||
form_control->IsValidationMessageVisible()) {
// Create the validation message unless the focused form control is
// overriding it with a different message via aria-errormessage.
if (!AXObject::ElementsFromAttributeOrInternals(
focused_element, html_names::kAriaErrormessageAttr)) {
AXObject* message = GetOrCreateValidationMessageObject();
CHECK(message);
CHECK(!message->IsDetached());
CHECK_EQ(message->ParentObject(), Root());
return message;
}
}
}
}
// No focused, invalid form control.
if (validation_message_axid_) {
RemoveValidationMessageObjectWithCleanLayout(document_);
}
return nullptr;
}
void AXObjectCacheImpl::RemoveValidationMessageObjectWithCleanLayout(
Node* document) {
DCHECK_EQ(document, document_);
if (validation_message_axid_) {
// Remove when it becomes hidden, so that a new object is created the next
// time the message becomes visible. It's not possible to reuse the same
// alert, because the event generator will not generate an alert event if
// the same object is hidden and made visible quickly, which occurs if the
// user submits the form when an alert is already visible.
Remove(validation_message_axid_, /* notify_parent */ false);
validation_message_axid_ = 0;
}
ChildrenChangedWithCleanLayout(document_);
}
// Native validation error popup for focused form control in current document.
void AXObjectCacheImpl::HandleValidationMessageVisibilityChanged(
Node* form_control) {
DCHECK(form_control);
SCOPED_DISALLOW_LIFECYCLE_TRANSITION();
DeferTreeUpdate(TreeUpdateReason::kValidationMessageVisibilityChanged,
form_control);
}
void AXObjectCacheImpl::HandleValidationMessageVisibilityChangedWithCleanLayout(
const Node* form_control) {
#if DCHECK_IS_ON()
DCHECK(form_control);
Document* document = &form_control->GetDocument();
DCHECK(document);
DCHECK(document->Lifecycle().GetState() >= DocumentLifecycle::kLayoutClean)
<< "Unclean document at lifecycle " << document->Lifecycle().ToString();
#endif // DCHECK_IS_ON()
if (AXObject* message_ax_object = ValidationMessageObjectIfInvalid()) {
MarkAXObjectDirtyWithCleanLayout(message_ax_object);
}
ChildrenChangedWithCleanLayout(Root());
// If the form control is invalid, it will now have an error message relation
// to the message container.
MarkElementDirtyWithCleanLayout(form_control);
}
void AXObjectCacheImpl::HandleEventListenerAdded(
Node& node,
const AtomicString& event_type) {
// If this is the first |event_type| listener for |node|, handle the
// subscription change.
if (node.NumberOfEventListeners(event_type) == 1)
HandleEventSubscriptionChanged(node, event_type);
}
void AXObjectCacheImpl::HandleEventListenerRemoved(
Node& node,
const AtomicString& event_type) {
// If there are no more |event_type| listeners for |node|, handle the
// subscription change.
if (node.NumberOfEventListeners(event_type) == 0)
HandleEventSubscriptionChanged(node, event_type);
}
void AXObjectCacheImpl::HandleReferenceTargetChanged(Element& element) {
DeferTreeUpdate(TreeUpdateReason::kReferenceTargetChanged, &element);
}
bool AXObjectCacheImpl::DoesEventListenerImpactIgnoredState(
const AtomicString& event_type,
const Node& node) const {
// An SVG graphics element with a focus event listener is focusable, which
// causes it to be unignored.
if (auto* svg_graphics_element = DynamicTo<SVGGraphicsElement>(node)) {
if (svg_graphics_element->HasFocusEventListeners()) {
return true;
}
}
// A mouse event listener causes a node to be unignored.
return event_util::IsMouseButtonEventType(event_type);
}
void AXObjectCacheImpl::HandleEventSubscriptionChanged(
Node& node,
const AtomicString& event_type) {
// Adding or Removing an event listener for certain events may affect whether
// a node or its descendants should be accessibility ignored.
if (!DoesEventListenerImpactIgnoredState(event_type, node)) {
return;
}
MarkElementDirty(&node);
// If the ignored state changes, the parent's children may have changed.
if (AXObject* obj = Get(&node)) {
if (!obj->IsDetached()) {
if (obj->ParentObject()) {
ChildrenChanged(obj->ParentObject());
// ChildrenChanged() can cause the obj to be detached.
if (obj->IsDetached()) {
return;
}
}
DeferTreeUpdate(TreeUpdateReason::kRoleMaybeChangedFromEventListener,
&node);
}
}
}
void AXObjectCacheImpl::CSSAnchorChangedWithCleanLayout(Node* positioned_node) {
relation_cache_->UpdateCSSAnchorFor(positioned_node);
}
void AXObjectCacheImpl::InlineTextBoxesUpdated(LayoutObject* layout_object) {
if (AXObject* obj = Get(layout_object)) {
// Only update if the accessibility object already exists and it's
// not already marked as dirty.
CHECK(!obj->IsDetached());
if (obj->ShouldLoadInlineTextBoxes()) {
obj->SetNeedsToUpdateChildren();
obj->ClearChildren();
MarkAXObjectDirty(obj);
}
}
}
Settings* AXObjectCacheImpl::GetSettings() {
return document_->GetSettings();
}
const Element* AXObjectCacheImpl::RootAXEditableElement(const Node* node) {
const Element* result = RootEditableElement(*node);
const auto* element = DynamicTo<Element>(node);
if (!element)
element = node->parentElement();
for (; element; element = element->parentElement()) {
if (NodeIsTextControl(element))
result = element;
}
return result;
}
bool AXObjectCacheImpl::NodeIsTextControl(const Node* node) {
if (!node)
return false;
const AXObject* ax_object = Get(const_cast<Node*>(node));
return ax_object && ax_object->IsTextField();
}
WebLocalFrameClient* AXObjectCacheImpl::GetWebLocalFrameClient() const {
DCHECK(document_);
WebLocalFrameImpl* web_frame =
WebLocalFrameImpl::FromFrame(document_->AXObjectCacheOwner().GetFrame());
if (!web_frame)
return nullptr;
WebLocalFrameClient* client = web_frame->Client();
DCHECK(client);
return client;
}
bool AXObjectCacheImpl::IsImmediateProcessingRequiredForEvent(
ax::mojom::blink::EventFrom& event_from,
AXObject* target,
ax::mojom::blink::Event& event_type) const {
// Already scheduled for immediate mode.
if (serialize_immediately_) {
return true;
}
// Actions should result in an immediate response.
if (event_from == ax::mojom::blink::EventFrom::kAction) {
return true;
}
// It's important for the user to have access to any changes to the
// currently focused object, so schedule serializations immediately if that
// object changes. The root is an exception because it often has focus while
// the page is loading.
if (target->GetNode() != document_ && target->IsFocused()) {
return true;
}
switch (event_type) {
case ax::mojom::blink::Event::kActiveDescendantChanged:
case ax::mojom::blink::Event::kBlur:
case ax::mojom::blink::Event::kCheckedStateChanged:
case ax::mojom::blink::Event::kClicked:
case ax::mojom::blink::Event::kDocumentSelectionChanged:
case ax::mojom::blink::Event::kExpandedChanged:
case ax::mojom::blink::Event::kFocus:
case ax::mojom::blink::Event::kHover:
case ax::mojom::blink::Event::kLoadComplete:
case ax::mojom::blink::Event::kLoadStart:
case ax::mojom::blink::Event::kRowExpanded:
case ax::mojom::blink::Event::kScrolledToAnchor:
case ax::mojom::blink::Event::kSelectedChildrenChanged:
return true;
case ax::mojom::blink::Event::kDocumentTitleChanged:
case ax::mojom::blink::Event::kLayoutComplete:
case ax::mojom::blink::Event::kLocationChanged:
case ax::mojom::blink::Event::kRowCollapsed:
case ax::mojom::blink::Event::kRowCountChanged:
case ax::mojom::blink::Event::kScrollPositionChanged:
case ax::mojom::blink::Event::kTextChanged:
// Value changes can be fired at a fast rate, so only respond quickly if the
// value is on the focused object itself.
case ax::mojom::blink::Event::kValueChanged:
return false;
// These events are not fired from Blink.
// This list is duplicated in WebFrameTestProxy::PostAccessibilityEvent().
case ax::mojom::blink::Event::kAlert:
case ax::mojom::blink::Event::kAriaAttributeChangedDeprecated:
case ax::mojom::blink::Event::kAutocorrectionOccured:
case ax::mojom::blink::Event::kChildrenChanged:
case ax::mojom::blink::Event::kControlsChanged:
case ax::mojom::blink::Event::kEndOfTest:
case ax::mojom::blink::Event::kFocusAfterMenuClose:
case ax::mojom::blink::Event::kFocusContext:
case ax::mojom::blink::Event::kHide:
case ax::mojom::blink::Event::kHitTestResult:
case ax::mojom::blink::Event::kImageFrameUpdated:
case ax::mojom::blink::Event::kLiveRegionCreated:
case ax::mojom::blink::Event::kLiveRegionChanged:
case ax::mojom::blink::Event::kMediaStartedPlaying:
case ax::mojom::blink::Event::kMediaStoppedPlaying:
case ax::mojom::blink::Event::kMenuEnd:
case ax::mojom::blink::Event::kMenuListValueChangedDeprecated:
case ax::mojom::blink::Event::kMenuPopupEnd:
case ax::mojom::blink::Event::kMenuPopupStart:
case ax::mojom::blink::Event::kMenuStart:
case ax::mojom::blink::Event::kMouseCanceled:
case ax::mojom::blink::Event::kMouseDragged:
case ax::mojom::blink::Event::kMouseMoved:
case ax::mojom::blink::Event::kMousePressed:
case ax::mojom::blink::Event::kMouseReleased:
case ax::mojom::blink::Event::kNone:
case ax::mojom::blink::Event::kSelection:
case ax::mojom::blink::Event::kSelectionAdd:
case ax::mojom::blink::Event::kSelectionRemove:
case ax::mojom::blink::Event::kShow:
case ax::mojom::blink::Event::kStateChanged:
case ax::mojom::blink::Event::kTextSelectionChanged:
case ax::mojom::blink::Event::kTooltipClosed:
case ax::mojom::blink::Event::kTooltipOpened:
case ax::mojom::blink::Event::kTreeChanged:
case ax::mojom::blink::Event::kWindowActivated:
case ax::mojom::blink::Event::kWindowDeactivated:
case ax::mojom::blink::Event::kWindowVisibilityChanged:
// Never fired from Blink.
NOTREACHED() << "Event not expected from Blink: " << event_type;
}
}
bool AXObjectCacheImpl::IsImmediateProcessingRequired(
TreeUpdateParams* tree_update) const {
// For now, immediate processing is never required for deferred AXObject
// updates, and this method doesn't need to be called for that case.
CHECK(!tree_update->axid);
// Already scheduled for immediate mode.
if (serialize_immediately_) {
return true;
}
// Get some initial content as soon as possible.
if (objects_.size() <= 1) {
return true;
}
// Actions should result in an immediate response.
if (tree_update->event_from_action != ax::mojom::blink::Action::kNone) {
return true;
}
// It's important for the user to have access to any changes to the
// currently focused object, so schedule serializations immediately if that
// object changes. The root is an exception because it often has focus while
// the page is loading.
if (tree_update->node != document_ &&
tree_update->node == document_->FocusedElement()) {
return true;
}
switch (tree_update->update_reason) {
// These updates are associated with a Node:
case TreeUpdateReason::kActiveDescendantChanged:
case TreeUpdateReason::kAriaExpandedChanged:
case TreeUpdateReason::kAriaPressedChanged:
case TreeUpdateReason::kAriaSelectedChanged:
case TreeUpdateReason::kDidShowMenuListPopup:
case TreeUpdateReason::kEditableTextContentChanged:
case TreeUpdateReason::kNodeGainedFocus:
case TreeUpdateReason::kNodeLostFocus:
case TreeUpdateReason::kPostNotificationFromHandleLoadComplete:
case TreeUpdateReason::kUpdateActiveMenuOption:
case TreeUpdateReason::kValidationMessageVisibilityChanged:
return true;
case TreeUpdateReason::kChildInserted:
case TreeUpdateReason::kCSSAnchorChanged:
case TreeUpdateReason::kDelayEventFromPostNotification:
case TreeUpdateReason::kFocusableChanged:
case TreeUpdateReason::kIdChanged:
case TreeUpdateReason::kMarkDocumentDirty:
case TreeUpdateReason::kMaybeDisallowImplicitSelection:
case TreeUpdateReason::kNewRelationTargetDirty:
case TreeUpdateReason::kNodeIsAttached:
case TreeUpdateReason::kPostNotificationFromHandleLoadStart:
case TreeUpdateReason::kPostNotificationFromHandleScrolledToAnchor:
case TreeUpdateReason::kReferenceTargetChanged:
case TreeUpdateReason::kRemoveValidationMessageObjectFromFocusedUIElement:
case TreeUpdateReason::
kRemoveValidationMessageObjectFromValidationMessageObject:
case TreeUpdateReason::kRestoreParentOrPrune:
case TreeUpdateReason::kRoleChangeFromAriaHasPopup:
case TreeUpdateReason::kRoleChangeFromImageMapName:
case TreeUpdateReason::kRoleChangeFromRoleOrType:
case TreeUpdateReason::kRoleMaybeChangedFromEventListener:
case TreeUpdateReason::kRoleMaybeChangedFromHref:
case TreeUpdateReason::kRoleMaybeChangedOnSelect:
case TreeUpdateReason::kSectionOrRegionRoleMaybeChangedFromLabel:
case TreeUpdateReason::kSectionOrRegionRoleMaybeChangedFromLabelledBy:
case TreeUpdateReason::kSectionOrRegionRoleMaybeChangedFromTitle:
case TreeUpdateReason::kTextChangedOnNode:
case TreeUpdateReason::kTextChangedOnClosestNodeForLayoutObject:
case TreeUpdateReason::kTextMarkerDataAdded:
case TreeUpdateReason::kUpdateAriaOwns:
case TreeUpdateReason::kUpdateTableRole:
case TreeUpdateReason::kUseMapAttributeChanged:
return false;
// These updates are associated with an AXID:
case TreeUpdateReason::kChildrenChanged:
case TreeUpdateReason::kMarkAXObjectDirty:
case TreeUpdateReason::kMarkAXSubtreeDirty:
case TreeUpdateReason::kTextChangedOnLayoutObject:
return false;
}
}
// The lifecycle serialization works as follows:
// 1) Dirty objects and events are fired through
// AXObjectCacheImpl::PostPlatformNotification which in turn makes a call to
// AXObjectCacheImpl::AddEventToSerializationQueue to queue it.
//
// 2) When the lifecycle is ready to be serialized,
// AXObjectCacheImpl::CommitAXUpdates is called which first
// checks if it's time to make a new serialization, and if not, it will early
// return in order to add a delay between serializations.
//
// 3) AXObjectCacheImpl::CommitAXUpdates then calls
// RenderAccessibilityImpl:AXReadyCallback to start serialization process.
//
// Check the below CL for more information:
// https://chromium-review.googlesource.com/c/chromium/src/+/4994320
void AXObjectCacheImpl::AddEventToSerializationQueue(
const ui::AXEvent& event,
bool immediate_serialization) {
CHECK(lifecycle_.StateAllowsQueueingEventsForSerialization()) << *this;
AXObject* obj = ObjectFromAXID(event.id);
DCHECK(!obj->IsDetached());
pending_events_to_serialize_.push_back(event);
AddDirtyObjectToSerializationQueue(
obj, event.event_from, event.event_from_action, event.event_intents);
if (immediate_serialization) {
ScheduleImmediateSerialization();
}
}
void AXObjectCacheImpl::OnSerializationCancelled() {
serialization_in_flight_ = false;
}
void AXObjectCacheImpl::OnSerializationStartSend() {
serialization_in_flight_ = true;
}
bool AXObjectCacheImpl::IsSerializationInFlight() const {
return serialization_in_flight_;
}
void AXObjectCacheImpl::OnSerializationReceived() {
serialization_in_flight_ = false;
last_serialization_timestamp_ = base::TimeTicks::Now();
// Another serialization may be needed, in the case where the AXObjectCache is
// dirty. In that case, make sure a visual update is scheduled so that
// AXReadyCallback() will be called. ScheduleAXUpdate() will only schedule a
// visual update if the AXObjectCache is dirty.
if (serialize_immediately_after_current_serialization_) {
serialize_immediately_after_current_serialization_ = false;
ScheduleImmediateSerialization();
} else {
ScheduleAXUpdate();
}
}
void AXObjectCacheImpl::ScheduleImmediateSerialization() {
if (IsSerializationInFlight()) {
// Wait until current serialization message has been received.
serialize_immediately_after_current_serialization_ = true;
return;
}
serialize_immediately_ = true;
// Call ScheduleAXUpdate() to ensure lifecycle does not get stalled.
// Will call AXReadyCallback() at the next available opportunity.
ScheduleAXUpdate();
}
Node* AXObjectCacheImpl::GetAccessibilityFocus() const {
if (accessibility_focus_ == ui::AXNodeData::kInvalidAXID) {
return nullptr;
}
AXObject* obj = ObjectFromAXID(accessibility_focus_);
if (!obj) {
return nullptr;
}
return obj->GetNode();
}
void AXObjectCacheImpl::PostPlatformNotification(
AXObject* obj,
ax::mojom::blink::Event event_type,
ax::mojom::blink::EventFrom event_from,
ax::mojom::blink::Action event_from_action,
const BlinkAXEventIntentsSet& event_intents) {
CHECK(lifecycle_.StateAllowsQueueingEventsForSerialization()) << *this;
obj = GetSerializationTarget(obj);
if (!obj)
return;
ui::AXEvent event;
event.id = obj->AXObjectID();
event.event_type = event_type;
event.event_from = event_from;
event.event_from_action = event_from_action;
event.event_intents.resize(event_intents.size());
// We need to filter out the counts from every intent.
std::ranges::transform(
event_intents, event.event_intents.begin(),
[](const auto& intent) { return intent.key.intent(); });
for (auto agent : agents_)
agent->AXEventFired(obj, event_type);
// Since we're in the middle of processing deferred events anyways, we know
// this will be immediately serialized.
AddEventToSerializationQueue(event, /* immediate_serialization */ false);
// TODO(aleventhal) This is for web tests only, in order to record MarkDirty
// events. Is there a way to avoid these calls for normal browsing?
// Maybe we should use dependency injection from AccessibilityController.
if (auto* client = GetWebLocalFrameClient()) {
client->HandleWebAccessibilityEventForTest(event);
}
}
void AXObjectCacheImpl::MarkAXObjectDirtyWithCleanLayoutHelper(
AXObject* obj,
ax::mojom::blink::EventFrom event_from,
ax::mojom::blink::Action event_from_action) {
CHECK(!IsFrozen());
obj = GetSerializationTarget(obj);
if (!obj)
return;
obj->SetAncestorsHaveDirtyDescendants();
// If the content is inside the popup, mark the owning element dirty.
// TODO(aleventhal): not sure why this works, but now that we run a11y in
// PostRunLifecycleTasks(), we need this, otherwise the pending updates in
// the popup aren't processed.
if (IsPopup(*obj->GetDocument())) {
MarkElementDirtyWithCleanLayout(GetDocument().FocusedElement());
}
// TODO(aleventhal) This is for web tests only, in order to record MarkDirty
// events. Is there a way to avoid these calls for normal browsing?
// Maybe we should use dependency injection from AccessibilityController.
if (auto* client = GetWebLocalFrameClient()) {
client->HandleWebAccessibilityEventForTest(
WebAXObject(obj), "MarkDirty", std::vector<ui::AXEventIntent>());
}
std::vector<ui::AXEventIntent> event_intents;
AddDirtyObjectToSerializationQueue(obj, event_from, event_from_action,
event_intents);
obj->UpdateCachedAttributeValuesIfNeeded(true);
}
void AXObjectCacheImpl::MarkAXObjectDirtyWithCleanLayout(AXObject* obj) {
if (!obj) {
return;
}
MarkAXObjectDirtyWithCleanLayoutHelper(obj, active_event_from_,
active_event_from_action_);
if (!obj->IsIncludedInTree()) {
obj = obj->ParentObjectIncludedInTree();
}
for (auto agent : agents_) {
agent->AXObjectModified(obj, /*subtree*/ false);
}
}
void AXObjectCacheImpl::MarkAXObjectDirty(AXObject* obj) {
if (!obj)
return;
// TODO(accessibility) Consider catching all redundant dirty object work,
// perhaps by setting a flag on the AXObject, or by adding the id to a set of
// already-dirtied objects.
DeferTreeUpdate(TreeUpdateReason::kMarkAXObjectDirty, obj);
}
void AXObjectCacheImpl::NotifySubtreeDirty(AXObject* obj) {
DUMP_WILL_BE_CHECK(obj->IsIncludedInTree());
// Note: if there is no serializer yet, then there is nothing to mark dirty
// for serialization purposes yet -- effectively everything starts out dirty
// in a new serializer.
if (ax_tree_serializer_) {
ax_tree_serializer_->MarkSubtreeDirty(obj->AXObjectID());
}
for (auto agent : agents_) {
agent->AXObjectModified(obj, /*subtree*/ true);
}
}
void AXObjectCacheImpl::MarkAXSubtreeDirtyWithCleanLayout(AXObject* obj) {
if (!obj) {
return;
}
if (!obj->IsIncludedInTree()) {
for (const auto& included_child : obj->ChildrenIncludingIgnored()) {
MarkAXSubtreeDirtyWithCleanLayout(included_child);
}
return;
}
MarkAXObjectDirtyWithCleanLayoutHelper(obj, active_event_from_,
active_event_from_action_);
NotifySubtreeDirty(obj);
}
void AXObjectCacheImpl::MarkAXSubtreeDirty(AXObject* obj) {
if (!obj)
return;
DeferTreeUpdate(TreeUpdateReason::kMarkAXSubtreeDirty, obj);
}
void AXObjectCacheImpl::MarkSubtreeDirty(Node* node) {
if (AXObject* obj = Get(node)) {
MarkAXSubtreeDirty(obj);
} else if (node) {
// There is no AXObject, so there is no subtree to mark dirty.
MarkElementDirty(node);
}
}
void AXObjectCacheImpl::MarkDocumentDirty() {
CHECK(!IsFrozen());
mark_all_dirty_ = true;
ScheduleAXUpdate();
}
void AXObjectCacheImpl::MarkDocumentDirtyWithCleanLayout() {
// This function will cause everything to be reserialized from the root down,
// but will not create new AXObjects, which avoids resetting the user's
// position in the content.
DCHECK(mark_all_dirty_);
// Assume all nodes in the tree need to recompute their properties.
// Note that objects can remain in the tree without being re-created.
// However, they will be dropped if they are no longer needed as the tree
// structure is rebuilt from the top down.
for (auto& entry : objects_) {
AXObject* object = entry.value;
DCHECK(!object->IsDetached());
object->InvalidateCachedValues(TreeUpdateReason::kMarkDocumentDirty);
}
// Don't keep previous parent-child relationships.
// This loop operates on a copy of values in the objects_ map, because some
// entries may be removed from objects_ while iterating.
HeapVector<Member<AXObject>> objects(objects_.Values());
for (auto& object : objects) {
if (!object->IsDetached()) {
object->SetNeedsToUpdateChildren();
}
}
// Clear anything about to be serialized, because everything will be
// reserialized anyway.
pending_events_to_serialize_.clear();
pending_objects_to_serialize_.clear();
changed_bounds_ids_.clear();
cached_bounding_boxes_.clear();
// Tell the serializer that everything will need to be serialized.
DCHECK(Root());
Root()->SetHasDirtyDescendants(true);
MarkAXSubtreeDirtyWithCleanLayout(Root());
ChildrenChangedWithCleanLayout(Root());
// Do not trim out load complete messages, they must be fired.
if (!load_sent_ && GetDocument().IsLoadCompleted()) {
PostNotification(&GetDocument(), ax::mojom::blink::Event::kLoadComplete);
}
}
void AXObjectCacheImpl::ResetSerializer() {
if (ax_tree_serializer_) {
ax_tree_serializer_->Reset();
}
if (plugin_serializer_.get()) {
plugin_serializer_->Reset();
}
// Clear anything about to be serialized, because everything will be
// reserialized anyway.
pending_objects_to_serialize_.clear();
pending_events_to_serialize_.clear();
changed_bounds_ids_.clear();
cached_bounding_boxes_.clear();
// Send the serialization at the next available opportunity.
ScheduleAXUpdate();
}
void AXObjectCacheImpl::MarkElementDirty(const Node* element) {
// Warning, if no AXObject exists for element, nothing is marked dirty.
MarkAXObjectDirty(Get(element));
}
WTF::Vector<TextChangedOperation>*
AXObjectCacheImpl::GetFromTextOperationInNodeIdMap(AXID id) {
auto it = text_operation_in_node_ids_.find(id);
if (it != text_operation_in_node_ids_.end()) {
return &it.Get()->value;
}
return nullptr;
}
void AXObjectCacheImpl::ClearTextOperationInNodeIdMap() {
text_operation_in_node_ids_.clear();
}
void AXObjectCacheImpl::MarkElementDirtyWithCleanLayout(const Node* element) {
// Warning, if no AXObject exists for element, nothing is marked dirty.
MarkAXObjectDirtyWithCleanLayout(Get(element));
}
AXObject* AXObjectCacheImpl::GetSerializationTarget(AXObject* obj) {
if (!obj || obj->IsDetached() || !obj->GetDocument() ||
!obj->GetDocument()->View() ||
!obj->GetDocument()->View()->GetFrame().GetPage()) {
return nullptr;
}
// Return included in tree object.
if (obj->IsIncludedInTree())
return obj;
return obj->ParentObjectIncludedInTree();
}
void AXObjectCacheImpl::RestoreParentOrPrune(Node* child_node) {
if (lifecycle_.StateAllowsImmediateTreeUpdates()) {
RestoreParentOrPruneWithCleanLayout(child_node);
} else {
DeferTreeUpdate(TreeUpdateReason::kRestoreParentOrPrune, child_node);
}
}
void AXObjectCacheImpl::RestoreParentOrPruneWithCleanLayout(Node* child_node) {
AXObject* child = Get(child_node);
if (child) {
ChildrenChangedOnAncestorOf(child);
// The previous call can cause child to become detached.
if (child->IsDetached()) {
child = nullptr;
}
}
AXObject* parent = child ? child->ComputeParentOrNull()
: AXObject::ComputeNonARIAParent(*this, child_node);
if (parent && child) {
child->SetParent(parent);
ChildrenChangedOnAncestorOf(child);
} else {
// If no parent is currently available, the child may no longer be part of
// the tree. Remove the child's subtree and ask the parent (if any) to
// rebuild its subtree.
RemoveSubtree(child_node);
ChildrenChangedWithCleanLayout(parent);
}
}
void AXObjectCacheImpl::HandleFocusedUIElementChanged(
Element* old_focused_element,
Element* new_focused_element) {
#if DCHECK_IS_ON()
// The focus can be in a different document when a popup is open.
SCOPED_DISALLOW_LIFECYCLE_TRANSITION();
#endif // DCHECK_IS_ON()
if (validation_message_axid_) {
DeferTreeUpdate(
TreeUpdateReason::kRemoveValidationMessageObjectFromFocusedUIElement,
document_);
}
if (!new_focused_element) {
// When focus is cleared, implicitly focus the document by sending a blur.
if (GetDocument().documentElement()) {
DeferTreeUpdate(TreeUpdateReason::kNodeLostFocus,
GetDocument().documentElement());
}
return;
}
Page* page = new_focused_element->GetDocument().GetPage();
if (!page)
return;
if (old_focused_element) {
DeferTreeUpdate(TreeUpdateReason::kNodeLostFocus, old_focused_element);
}
UpdateActiveAriaModalDialog(new_focused_element);
DeferTreeUpdate(TreeUpdateReason::kNodeGainedFocus, FocusedNode());
}
// Check if the focused node is inside an active aria-modal dialog. If so, we
// should mark the cache as dirty to recompute the ignored status of each node.
void AXObjectCacheImpl::UpdateActiveAriaModalDialog(Node* focused_node) {
Settings* settings = GetSettings();
if (!settings || !settings->GetAriaModalPrunesAXTree()) {
return;
}
Element* new_active_aria_modal = AncestorAriaModalDialog(focused_node);
if (active_aria_modal_dialog_ == new_active_aria_modal)
return;
active_aria_modal_dialog_ = new_active_aria_modal;
MarkDocumentDirty();
}
Element* AXObjectCacheImpl::AncestorAriaModalDialog(Node* node) {
// Find an element with role=dialog|alertdialog and aria-modal="true" that
// either contains the focus, or is focused.
do {
Element* element = DynamicTo<Element>(node);
if (element) {
const AtomicString& role_str =
AXObject::AriaAttribute(*element, html_names::kRoleAttr);
if (!role_str.empty() &&
ui::IsDialog(AXObject::FirstValidRoleInRoleString(role_str))) {
if (AXObject::IsAriaAttributeTrue(*element,
html_names::kAriaModalAttr)) {
return element;
}
}
}
node = FlatTreeTraversal::Parent(*node);
} while (node);
return nullptr;
}
Element* AXObjectCacheImpl::GetActiveAriaModalDialog() const {
return active_aria_modal_dialog_;
}
ui::AXLocationAndScrollUpdates
AXObjectCacheImpl::TakeLocationChangsForSerialization() {
CHECK(!changed_bounds_ids_.empty());
TRACE_EVENT0("accessibility",
load_sent_ ? "TakeLocationChangsForSerialization"
: "TakeLocationChangsForSerializationLoading");
SCOPED_UMA_HISTOGRAM_TIMER_MICROS(
"Accessibility.Performance.TakeLocationChangsForSerialization");
ui::AXLocationAndScrollUpdates changes;
// Reserve is just an optimization. The actual value doesn't have to be
// accurate but just an estimate. Assume the changes will always be half and
// half.
changes.location_changes.reserve(changed_bounds_ids_.size());
changes.scroll_changes.reserve(changed_bounds_ids_.size());
for (AXID changed_bounds_id : changed_bounds_ids_) {
if (AXObject* obj = ObjectFromAXID(changed_bounds_id)) {
DCHECK(!obj->IsDetached());
// Only update locations that are already known.
auto bounds = cached_bounding_boxes_.find(changed_bounds_id);
if (bounds == cached_bounding_boxes_.end()) {
continue;
}
ui::AXRelativeBounds new_location;
bool clips_children;
obj->PopulateAXRelativeBounds(new_location, &clips_children);
gfx::Point scroll_offset = obj->GetScrollOffset();
if (bounds->value.bounds != new_location) {
changes.location_changes.emplace_back(changed_bounds_id, new_location);
}
if (bounds->value.scroll_x != scroll_offset.x() ||
bounds->value.scroll_y != scroll_offset.y()) {
changes.scroll_changes.emplace_back(
changed_bounds_id, scroll_offset.x(), scroll_offset.y());
}
cached_bounding_boxes_.Set(
changed_bounds_id,
CachedLocationChange(std::move(new_location), scroll_offset.x(),
scroll_offset.y()));
}
}
changed_bounds_ids_.clear();
// Since this method is non-recoverable, update the time here and assume this
// serializtion will arrive.
last_location_serialization_time_ = base::TimeTicks::Now();
return changes;
}
void AXObjectCacheImpl::SerializeLocationChanges() {
// We wait until the document load is complete because layout often shifts
// during the load process.
if (!GetDocument().IsLoadCompleted()) {
return;
}
CHECK(GetDocument().IsActive());
TRACE_EVENT0("accessibility", load_sent_ ? "SerializeLocationChanges"
: "SerializeLocationChangesLoading");
SCOPED_UMA_HISTOGRAM_TIMER_MICROS(
"Accessibility.Performance.SerializeLocationChanges");
// Ensure enough time has passed since last locations serialization.
Document& document = GetDocument();
const auto now = base::TimeTicks::Now();
const auto delay_between_serializations =
base::Milliseconds(GetLocationSerializationDelay());
const auto elapsed_since_last_serialization =
now - last_location_serialization_time_;
const auto delay_until_next_serialization =
delay_between_serializations - elapsed_since_last_serialization;
if (delay_until_next_serialization.is_positive()) {
// No serialization needed yet, will serialize after a delay.
// Set a timer to call this method again, if one isn't already set.
if (!weak_factory_for_loc_updates_pipeline_.HasWeakCells()) {
document.GetTaskRunner(blink::TaskType::kInternalDefault)
->PostDelayedTask(
FROM_HERE,
WTF::BindOnce(
&AXObjectCacheImpl::ScheduleAXUpdate,
WrapPersistent(
weak_factory_for_loc_updates_pipeline_.GetWeakCell())),
delay_until_next_serialization);
}
return;
}
weak_factory_for_loc_updates_pipeline_.Invalidate();
ui::AXLocationAndScrollUpdates changes = TakeLocationChangsForSerialization();
// Convert to blink mojom type
ax::mojom::blink::AXLocationAndScrollUpdatesPtr location_and_scroll_changes =
ax::mojom::blink::AXLocationAndScrollUpdates::New();
for (auto& item : changes.location_changes) {
location_and_scroll_changes->location_changes.push_back(
ax::mojom::blink::AXLocationChange::New(item.id,
std::move(item.new_location)));
}
for (auto& item : changes.scroll_changes) {
location_and_scroll_changes->scroll_changes.push_back(
ax::mojom::blink::AXScrollChange::New(item.id, item.scroll_x,
item.scroll_y));
}
if (!location_and_scroll_changes->location_changes.empty() ||
!location_and_scroll_changes->scroll_changes.empty()) {
CHECK(reset_token_);
GetOrCreateRemoteRenderAccessibilityHost()->HandleAXLocationChanges(
std::move(location_and_scroll_changes), *reset_token_);
}
}
void AXObjectCacheImpl::SerializeEntireTreeAndDispose(
size_t max_node_count,
base::TimeDelta timeout,
ui::AXTreeUpdate* response,
std::set<ui::AXSerializationErrorFlag>* out_error) {
CHECK(for_snapshot_only_);
CHECK(GetDocument().IsActive());
// Forces CommitAXUpdates(), which builds the tree.
mark_all_dirty_ = true;
UpdateAXForAllDocuments();
// Ensure that the tree exists.
CHECK(!IsDirty());
CHECK(Root());
CHECK(!Root()->IsDetached());
// Create the serializer.
CHECK(!ax_tree_serializer_) << "Serializer should not exist yet.";
EnsureSerializer();
{
blink::ScopedFreezeAXCache freeze(*this);
// Ensure that an initial tree exists.
if (max_node_count) {
ax_tree_serializer_->set_max_node_count(max_node_count);
}
if (!timeout.is_zero()) {
ax_tree_serializer_->set_timeout(timeout);
}
bool success =
ax_tree_serializer_->SerializeChanges(Root(), response, out_error);
CHECK(success)
<< "Serializer failed. Should have hit CHECK inside of serializer.";
if (RuntimeEnabledFeatures::
AccessibilitySerializationSizeMetricsEnabled()) {
// For a tree snapshot, we don't break down by type.
UMA_HISTOGRAM_CUSTOM_COUNTS(
"Accessibility.Performance.AXObjectCacheImpl.Snapshot",
base::saturated_cast<int>(response->ByteSize()), 1, kSizeGb,
kBucketCount);
}
}
Dispose();
}
void AXObjectCacheImpl::AddDirtyObjectToSerializationQueue(
const AXObject* obj,
ax::mojom::blink::EventFrom event_from,
ax::mojom::blink::Action event_from_action,
const std::vector<ui::AXEventIntent>& event_intents) {
CHECK(!IsFrozen());
CHECK(lifecycle_.StateAllowsQueueingAXObjectsForSerialization()) << *this;
// If not included, cannot be serialized, so there is no need to queue.
if (!obj->IsIncludedInTree()) {
return;
}
// Add to object to a queue that will be sent to the serializer in
// SerializeDirtyObjectsAndEvents().
pending_objects_to_serialize_.push_back(
AXDirtyObject::Create(obj, event_from, event_from_action, event_intents));
// ensure there is a document lifecycle update scheduled for plugin
// containers.
if (obj->GetElement() && DynamicTo<HTMLPlugInElement>(obj->GetElement())) {
ScheduleImmediateSerialization();
}
}
void AXObjectCacheImpl::MaybeSendCanvasHasNonTrivialFallbackUKM(
const AXObject* ax_canvas) {
if (!ax_canvas->ChildCountIncludingIgnored()) {
// Canvas does not have fallback.
return;
}
if (ax_canvas->ChildCountIncludingIgnored() == 1 &&
ui::IsText(ax_canvas->FirstChildIncludingIgnored()->RoleValue())) {
// Ignore a fallback if it's just a single piece of text, as we are
// looking for advanced uses of canvas fallbacks.
return;
}
has_emitted_canvas_fallback_ukm_ = true; // Stop checking.
ukm::UkmRecorder* ukm_recorder = GetDocument().UkmRecorder();
DCHECK(ukm_recorder);
ukm::builders::Accessibility_CanvasHasNonTrivialFallback(
GetDocument().UkmSourceID())
.SetSeen(true)
.Record(ukm_recorder);
}
void AXObjectCacheImpl::GetUpdatesAndEventsForSerialization(
std::vector<ui::AXTreeUpdate>& updates,
std::vector<ui::AXEvent>& events,
bool& had_end_of_test_event,
bool& had_load_complete_messages) {
HashSet<int32_t> already_serialized_ids;
DCHECK_GE(GetDocument().Lifecycle().GetState(),
DocumentLifecycle::kLayoutClean);
DCHECK(!popup_document_ || popup_document_->Lifecycle().GetState() >=
DocumentLifecycle::kLayoutClean);
DUMP_WILL_BE_CHECK(HasObjectsPendingSerialization());
DCHECK_GE(pending_objects_to_serialize_.size(),
pending_events_to_serialize_.size())
<< "There should be at least as many updates as events, because events "
"always mark a node dirty.";
EnsureSerializer();
if (plugin_tree_source_ && IsDirty()) {
// If the document is dirty, ensure the plugin serializer is reset.
CHECK(plugin_serializer_.get());
plugin_serializer_->Reset();
}
ui::AXNodeData::AXNodeDataSize node_data_size;
for (auto& current_dirty_object : pending_objects_to_serialize_) {
const AXObject* obj = current_dirty_object->obj;
// Dirty objects can be added using MarkWebAXObjectDirty(obj) from other
// parts of the code as well, so we need to ensure the object still
// exists.
if (!obj || obj->IsDetached()) {
continue;
}
DCHECK(obj->GetDocument()->GetFrame())
<< "An object in a closed document should have been detached via "
"Remove(): "
<< obj;
// Cannot serialize unincluded object.
// Only included objects are marked dirty, but this can happen if the
// object becomes unincluded after it was originally marked dirty, in which
// case a children changed will also be fired on the included ancestor. The
// children changed event on the ancestor means that attempting to
// serialize this unincluded object is not necessary.
if (!obj->IsIncludedInTree())
continue;
if (GetAXMode().HasFilterFlags(ui::AXMode::kOnScreenOnly)) {
DUMP_WILL_BE_CHECK(obj->IsRoot() || obj->ParentObjectIncludedInTree())
<< "Non-root object has no parent: " << obj->ToString();
if (!obj->IsRoot() && !obj->WasEverOnScreen() &&
!obj->ParentObjectIncludedInTree()->WasEverOnScreen()) {
// Off-screen children with off-screen parents are not serialized.
continue;
}
}
DCHECK(obj->AXObjectID());
if (already_serialized_ids.Contains(obj->AXObjectID()))
continue; // No need to serialize, was already present.
updates.emplace_back();
ui::AXTreeUpdate& update = updates.back();
update.event_from = current_dirty_object->event_from;
update.event_from_action = current_dirty_object->event_from_action;
update.event_intents = std::move(current_dirty_object->event_intents);
bool success = ax_tree_serializer_->SerializeChanges(obj, &update);
DCHECK(success);
DCHECK_GT(update.nodes.size(), 0U);
for (auto& node_data : update.nodes) {
AXID id = node_data.id;
DCHECK(id);
// Kept here for convenient debugging:
// DVLOG(1) << "*** AX Serialize: " << ObjectFromAXID(id)->ToString();
already_serialized_ids.insert(node_data.id);
// Now that the bounding box for this node is serialized, we can clear the
// node from changed_bounds_ids_ to avoid sending it in
// SerializeLocationChanges() later.
changed_bounds_ids_.erase(id);
// Record advanced uses of canvas fallbacks.
if (!has_emitted_canvas_fallback_ukm_ &&
node_data.role == ax::mojom::blink::Role::kCanvas) {
MaybeSendCanvasHasNonTrivialFallbackUKM(ObjectFromAXID(node_data.id));
}
}
DCHECK(already_serialized_ids.Contains(obj->AXObjectID()))
<< "Did not serialize original node, so it was probably not included "
"in its parent's children, and should never have been marked dirty "
"in the first place: "
<< obj->ToString() << "\nParent: " << obj->ParentObjectIncludedInTree()
<< "\nIndex in parent: "
<< obj->ParentObjectIncludedInTree()
->CachedChildrenIncludingIgnored()
.Find(obj);
// If there's a plugin, force the tree data to be generated in every
// message so the plugin can merge its own tree data changes.
AddPluginTreeToUpdate(&update);
if (RuntimeEnabledFeatures::
AccessibilitySerializationSizeMetricsEnabled()) {
update.AccumulateSize(node_data_size);
}
}
if (RuntimeEnabledFeatures::AccessibilitySerializationSizeMetricsEnabled()) {
LogNodeDataSizeDistribution(node_data_size);
UMA_HISTOGRAM_CUSTOM_COUNTS(
"Accessibility.Performance.AXObjectCacheImpl.Incremental",
base::saturated_cast<int>(node_data_size.ByteSize()), 1, kSizeGb,
kBucketCount);
}
// Loop over each event and generate an updated event message.
for (ui::AXEvent& event : pending_events_to_serialize_) {
if (event.event_type == ax::mojom::blink::Event::kEndOfTest) {
had_end_of_test_event = true;
continue;
}
if (!base::Contains(already_serialized_ids, event.id)) {
// Node no longer exists or could not be serialized.
// Kept here for convenient debugging:
// DVLOG(1) << "Dropped AXEvent: " << event.event_type << " on "
// << ObjectFromAXID(event.id);
continue;
}
#if DCHECK_IS_ON()
AXObject* obj = ObjectFromAXID(event.id);
DCHECK(obj && !obj->IsDetached())
<< "Detached object for AXEvent: " << event.event_type << " on #"
<< event.id;
#endif
if (event.event_type == ax::mojom::blink::Event::kLoadComplete) {
if (had_load_complete_messages)
continue; // De-dupe.
had_load_complete_messages = true;
}
events.push_back(event);
// Kept here for convenient debugging:
// DVLOG(1) << "AXEvent: " << event.event_type << " on "
// << ObjectFromAXID(event.id);
}
#if AX_FAIL_FAST_BUILD()
if (!GetAXMode().HasFilterFlags(ui::AXMode::kOnScreenOnly)) {
// Always compute this state.
UpdatePluginIncludedNodeCount();
CheckTreeConsistency(*this, *ax_tree_serializer_, plugin_serializer_.get());
// Provide the expected node count in the last update, so that
// AXTree::Unserialize() can check for tree consistency on the browser side.
if (!updates.back().tree_checks) {
updates.back().tree_checks.emplace();
}
updates.back().tree_checks->node_count =
GetIncludedNodeCount() + GetPluginIncludedNodeCount();
}
#endif // AX_FAIL_FAST_BUILD()
}
#if AX_FAIL_FAST_BUILD()
void AXObjectCacheImpl::UpdateIncludedNodeCount(const AXObject* obj) {
if (obj->IsIncludedInTree()) {
++included_node_count_;
} else {
--included_node_count_;
}
}
void AXObjectCacheImpl::UpdatePluginIncludedNodeCount() {
plugin_included_node_count_ = 0;
// If the serializer is empty, it means we cleared it at some point e.g. when
// detaching the embed. In those cases, it's correct to skip computing the
// count from the plugin tree source which has no idea it was detached.
if (!plugin_serializer_.get() ||
plugin_serializer_->ClientTreeNodeCount() == 0) {
return;
}
if (plugin_tree_source_ && plugin_tree_source_->GetRoot()) {
std::stack<const ui::AXNode*> nodes;
nodes.push(plugin_tree_source_->GetRoot());
while (!nodes.empty()) {
const ui::AXNode* child = nodes.top();
nodes.pop();
plugin_included_node_count_++;
for (size_t i = 0; i < plugin_tree_source_->GetChildCount(child); i++) {
nodes.push(plugin_tree_source_->ChildAt(child, i));
}
}
}
}
bool AXObjectCacheImpl::IsInternalUICheckerOn(const AXObject& obj) const {
if (internal_ui_checker_on_) {
return true;
}
// Also turn on for nodes that are inside of a UA shadow root, which is
// used for complex form controls built into the browser.
return obj.GetNode() && obj.GetNode()->IsInUserAgentShadowRoot();
}
#endif // AX_FAIL_FAST_BUILD()
void AXObjectCacheImpl::GetImagesToAnnotate(
ui::AXTreeUpdate& update,
std::vector<ui::AXNodeData*>& nodes) {
for (auto& node : update.nodes) {
AXObject* src = ObjectFromAXID(node.id);
if (!src || src->IsDetached() || !src->IsIncludedInTree() ||
(src->IsIgnored() &&
!node.HasState(ax::mojom::blink::State::kFocusable))) {
continue;
}
if (src->IsImage()) {
nodes.push_back(&node);
// This else clause matches links/documents because we would like to find
// an image that is in the near-descendant subtree of the link/document,
// since that image may be semantically representative of that
// link/document. See FindExactlyOneInnerImageInMaxDepthThree (not in
// this file), which is used by the caller of this method to find such
// an image.
} else if ((src->IsLink() || ui::IsPlatformDocument(node.role)) &&
node.GetNameFrom() != ax::mojom::blink::NameFrom::kAttribute) {
nodes.push_back(&node);
}
}
}
HeapMojoRemote<blink::mojom::blink::RenderAccessibilityHost>&
AXObjectCacheImpl::GetOrCreateRemoteRenderAccessibilityHost() {
if (!render_accessibility_host_) {
GetDocument().GetFrame()->GetBrowserInterfaceBroker().GetInterface(
render_accessibility_host_.BindNewPipeAndPassReceiver(
document_->GetTaskRunner(TaskType::kUserInteraction)));
}
return render_accessibility_host_;
}
void AXObjectCacheImpl::HandleInitialFocus() {
PostNotification(document_, ax::mojom::Event::kFocus);
}
void AXObjectCacheImpl::HandleEditableTextContentChanged(Node* node) {
if (!node)
return;
SCOPED_DISALLOW_LIFECYCLE_TRANSITION();
DeferTreeUpdate(TreeUpdateReason::kEditableTextContentChanged, node);
}
void AXObjectCacheImpl::HandleDeletionOrInsertionInTextField(
const SelectionInDOMTree& changed_selection,
bool is_deletion) {
Position start_pos = changed_selection.ComputeStartPosition();
Position end_pos = changed_selection.ComputeEndPosition();
#if DCHECK_IS_ON()
Document& selection_document =
start_pos.ComputeContainerNode()->GetDocument();
DCHECK(selection_document.Lifecycle().GetState() >=
DocumentLifecycle::kAfterPerformLayout)
<< "Unclean document at lifecycle "
<< selection_document.Lifecycle().ToString();
#endif
// Currently there are scenarios where the start/end are not offset in
// anchor, if this is the case, we need to compute their offset in the
// container node since we need this information on the browser side.
int start_offset = start_pos.ComputeOffsetInContainerNode();
int end_offset = end_pos.ComputeOffsetInContainerNode();
AXObject* start_obj = Get(start_pos.ComputeContainerNode());
AXObject* end_obj = Get(end_pos.ComputeContainerNode());
if (!start_obj || !end_obj) {
return;
}
AXObject* text_field_obj = start_obj->GetTextFieldAncestor();
if (!text_field_obj) {
return;
}
auto it = text_operation_in_node_ids_.find(text_field_obj->AXObjectID());
ax::mojom::blink::Command op = is_deletion
? ax::mojom::blink::Command::kDelete
: ax::mojom::blink::Command::kInsert;
if (it != text_operation_in_node_ids_.end()) {
it->value.push_back(TextChangedOperation(start_offset, end_offset,
start_obj->AXObjectID(),
end_obj->AXObjectID(), op));
} else {
WTF::Vector<TextChangedOperation> info{
TextChangedOperation(start_offset, end_offset, start_obj->AXObjectID(),
end_obj->AXObjectID(), op)};
text_operation_in_node_ids_.Set(text_field_obj->AXObjectID(), info);
}
}
void AXObjectCacheImpl::HandleEditableTextContentChangedWithCleanLayout(
Node* node) {
AXObject* obj = Get(node);
if (obj) {
obj = obj->GetTextFieldAncestor();
}
PostNotification(obj, ax::mojom::Event::kValueChanged);
}
void AXObjectCacheImpl::HandleTextFormControlChanged(Node* node) {
HandleEditableTextContentChanged(node);
}
void AXObjectCacheImpl::HandleTextMarkerDataAdded(Node* start, Node* end) {
DCHECK(start);
DCHECK(end);
DCHECK(IsA<Text>(start));
DCHECK(IsA<Text>(end));
// Notify the client of new text marker data.
// Ensure there is a delay so that the final marker state can be evaluated.
DeferTreeUpdate(TreeUpdateReason::kTextMarkerDataAdded, start);
if (start != end) {
DeferTreeUpdate(TreeUpdateReason::kTextMarkerDataAdded, end);
}
}
void AXObjectCacheImpl::HandleTextMarkerDataAddedWithCleanLayout(Node* node) {
Text* text_node = To<Text>(node);
// If non-spelling/grammar markers are present, assume that children changed
// should be called.
DocumentMarkerController& marker_controller = GetDocument().Markers();
const DocumentMarker::MarkerTypes non_spelling_or_grammar_markers(
DocumentMarker::kTextMatch | DocumentMarker::kActiveSuggestion |
DocumentMarker::kSuggestion | DocumentMarker::kTextFragment |
DocumentMarker::kCustomHighlight);
if (!marker_controller.MarkersFor(*text_node, non_spelling_or_grammar_markers)
.empty()) {
ChildrenChangedWithCleanLayout(node);
return;
}
// Spelling and grammar markers are removed and then readded in quick
// succession. By checking these here (on a slight delay), we can determine
// whether the presence of one of these markers actually changed, and only
// fire ChildrenChangedWithCleanLayout() if they did.
const DocumentMarker::MarkerTypes spelling_and_grammar_markers(
DocumentMarker::DocumentMarker::kSpelling |
DocumentMarker::DocumentMarker::kGrammar);
bool has_spelling_or_grammar_markers =
!marker_controller.MarkersFor(*text_node, spelling_and_grammar_markers)
.empty();
if (has_spelling_or_grammar_markers) {
if (nodes_with_spelling_or_grammar_markers_.insert(node->GetDomNodeId())
.is_new_entry) {
ChildrenChangedWithCleanLayout(node);
}
} else {
const auto& iter =
nodes_with_spelling_or_grammar_markers_.find(node->GetDomNodeId());
if (iter != nodes_with_spelling_or_grammar_markers_.end()) {
nodes_with_spelling_or_grammar_markers_.erase(iter);
ChildrenChangedWithCleanLayout(node);
}
}
}
void AXObjectCacheImpl::HandleValueChanged(Node* node) {
// Avoid duplicate processing of rapid value changes, e.g. on a slider being
// dragged, or a progress meter.
AXObject* ax_object = Get(node);
if (ax_object) {
if (last_value_change_node_ == ax_object->AXObjectID())
return;
last_value_change_node_ = ax_object->AXObjectID();
}
PostNotification(node, ax::mojom::Event::kValueChanged);
// If it's a slider, invalidate the thumb's bounding box.
if (ax_object && ax_object->RoleValue() == ax::mojom::blink::Role::kSlider &&
!ax_object->NeedsToUpdateChildren() &&
ax_object->ChildCountIncludingIgnored() == 1) {
InvalidateBoundingBox(ax_object->ChildAtIncludingIgnored(0)->AXObjectID());
}
}
void AXObjectCacheImpl::HandleUpdateActiveMenuOption(Node* menu_list) {
DeferTreeUpdate(TreeUpdateReason::kUpdateActiveMenuOption, menu_list);
}
void AXObjectCacheImpl::HandleUpdateMenuListPopupWithCleanLayout(
Node* menu_list,
bool did_show) {
AXObject* ax_menu_list = Get(menu_list);
if (!ax_menu_list) {
return;
}
AXObject* ax_popup = ax_menu_list->FirstChildIncludingIgnored();
if (!ax_popup ||
ax_popup->RoleValue() != ax::mojom::blink::Role::kMenuListPopup) {
last_selected_from_active_descendant_ = nullptr;
return;
}
AXObject* active_descendant = ax_popup->ActiveDescendant();
if (did_show) {
// On first appearance, mark everything dirty, because the hidden state
// will change on most descendants.
MarkAXSubtreeDirtyWithCleanLayout(ax_menu_list);
} else {
// Mark the previously selected item dirty so that its updated selection
// state is reserialized.
if (last_selected_from_active_descendant_) {
MarkElementDirtyWithCleanLayout(last_selected_from_active_descendant_);
}
}
if (active_descendant) {
MarkAXObjectDirtyWithCleanLayout(active_descendant);
PostNotification(ax_popup,
ax::mojom::blink::Event::kActiveDescendantChanged);
last_selected_from_active_descendant_ = active_descendant->GetNode();
}
}
void AXObjectCacheImpl::DidShowMenuListPopup(Node* menu_list) {
SCOPED_DISALLOW_LIFECYCLE_TRANSITION();
CHECK(menu_list);
DeferTreeUpdate(TreeUpdateReason::kDidShowMenuListPopup, menu_list);
}
void AXObjectCacheImpl::DidHideMenuListPopup(Node* menu_list) {
SCOPED_DISALLOW_LIFECYCLE_TRANSITION();
CHECK(menu_list);
current_menu_list_axid_ = 0;
options_bounds_ = {};
MarkAXSubtreeDirty(Get(menu_list));
}
void AXObjectCacheImpl::HandleLoadStart(Document* document) {
SCOPED_DISALLOW_LIFECYCLE_TRANSITION();
// Popups do not need to fire load start or load complete , because ATs do not
// regard popups as documents -- that is an implementation detail of the
// browser. The AT regards popups as part of a widget, and a load start or
// load complete event would only potentially confuse the AT.
if (!IsPopup(*document) && !IsInitialEmptyDocument(*document)) {
DeferTreeUpdate(TreeUpdateReason::kPostNotificationFromHandleLoadStart,
document, ax::mojom::blink::Event::kLoadStart);
}
}
void AXObjectCacheImpl::HandleLoadComplete(Document* document) {
SCOPED_DISALLOW_LIFECYCLE_TRANSITION();
// TODO(accessibility) Change this to a DCHECK, but that would fail right now
// in navigation API tests.
if (!document->IsLoadCompleted())
return;
// Popups do not need to fire load start or load complete , because ATs do not
// regard popups as documents -- that is an implementation detail of the
// browser. The AT regards popups as part of a widget, and a load start or
// load complete event would only potentially confuse the AT.
if (!IsPopup(*document) && !IsInitialEmptyDocument(*document)) {
DeferTreeUpdate(TreeUpdateReason::kPostNotificationFromHandleLoadComplete,
document, ax::mojom::blink::Event::kLoadComplete);
}
}
void AXObjectCacheImpl::HandleScrolledToAnchor(const Node* anchor_node) {
if (!anchor_node)
return;
DeferTreeUpdate(TreeUpdateReason::kPostNotificationFromHandleScrolledToAnchor,
const_cast<Node*>(anchor_node),
ax::mojom::blink::Event::kScrolledToAnchor);
}
void AXObjectCacheImpl::InvalidateBoundingBox(
const LayoutObject* layout_object) {
if (AXObject* obj = Get(const_cast<LayoutObject*>(layout_object))) {
InvalidateBoundingBox(obj->AXObjectID());
}
}
void AXObjectCacheImpl::InvalidateBoundingBox(const AXID& id) {
changed_bounds_ids_.insert(id);
}
void AXObjectCacheImpl::SetCachedBoundingBox(AXID id,
const ui::AXRelativeBounds& bounds,
const int scroll_x,
const int scroll_y) {
// When a bounding box of a node is serialized, we store the last value for it
// in cached_bounding_boxes_, to help with comparing if it really changed
// or not when sending another serialization later.
cached_bounding_boxes_.Set(id,
CachedLocationChange(bounds, scroll_x, scroll_y));
}
void AXObjectCacheImpl::HandleScrollPositionChanged(
LayoutObject* layout_object) {
if (layout_object->GetDocument() != document_) {
return;
}
SCOPED_DISALLOW_LIFECYCLE_TRANSITION();
// When the scroll position position changes, mark the bounding boxes of all
// fixed/sticky positioned objects for reserialization, because they are
// relative to the top left of the document.
InvalidateBoundingBoxForFixedOrStickyPosition();
Node* node = GetClosestNodeForLayoutObject(layout_object);
if (node) {
InvalidateBoundingBox(node->GetDomNodeId());
}
}
const AtomicString& AXObjectCacheImpl::ComputedRoleForNode(Node* node) {
// Accessibility tree must be updated before getting an object.
// Disallow a scope transition on the main document (which needs to already be
// updated to its correct lifecycle state at this point, or else there would
// be an illegal re-entrance to its lifecycle), but not for any popup document
// that is open. That's because popup documents update their lifecycle async
// from the main document, and hence any forced update to the popup document's
// lifecycle here is not re-entrance but rather a "forced" lifecycle update.
DocumentLifecycle::DisallowTransitionScope scoped(document_->Lifecycle());
CommitAXUpdates(GetDocument(), /*force*/ true);
ScopedFreezeAXCache scoped_freeze_cache(*this);
AXObject* obj = Get(node);
return AXObject::AriaRoleName(obj ? obj->ComputeFinalRoleForSerialization()
: ax::mojom::blink::Role::kUnknown);
}
String AXObjectCacheImpl::ComputedNameForNode(Node* node) {
// Accessibility tree must be updated before getting an object. See comment in
// ComputedRoleForNode() for explanation of disallow transition scope usage.
DocumentLifecycle::DisallowTransitionScope scoped(document_->Lifecycle());
CommitAXUpdates(GetDocument(), /*force*/ true);
ScopedFreezeAXCache scoped_freeze_cache(*this);
AXObject* obj = Get(node);
return obj ? obj->ComputedName() : "";
}
void AXObjectCacheImpl::OnTouchAccessibilityHover(const gfx::Point& location) {
DocumentLifecycle::DisallowTransitionScope disallow(document_->Lifecycle());
AXObject* hit = Root()->AccessibilityHitTest(location);
if (hit) {
// Ignore events on a frame or plug-in, because the touch events
// will be re-targeted there and we don't want to fire duplicate
// accessibility events.
if (hit->GetLayoutObject() &&
hit->GetLayoutObject()->IsLayoutEmbeddedContent())
return;
PostNotification(hit, ax::mojom::Event::kHover);
}
}
void AXObjectCacheImpl::SetCanvasObjectBounds(HTMLCanvasElement* canvas,
Element* element,
const PhysicalRect& rect) {
SCOPED_DISALLOW_LIFECYCLE_TRANSITION();
AXObject* obj = Get(element);
if (!obj)
return;
AXObject* ax_canvas = Get(canvas);
if (!ax_canvas)
return;
ax_id_to_explicit_bounds_.Set(obj->AXObjectID(),
std::make_pair(rect, ax_canvas->AXObjectID()));
}
std::optional<std::pair<PhysicalRect, AXID>>
AXObjectCacheImpl::GetCanvasElementBounds(AXID ax_id) {
auto it = ax_id_to_explicit_bounds_.find(ax_id);
if (it == ax_id_to_explicit_bounds_.end()) {
return std::nullopt;
}
return it->value;
}
std::optional<ui::AXTreeID> AXObjectCacheImpl::GetAXObjectChildAXTreeID(
AXID ax_id) {
auto it = ax_id_to_child_tree_id_.find(ax_id);
if (it == ax_id_to_child_tree_id_.end()) {
return std::nullopt;
}
return it->value;
}
void AXObjectCacheImpl::Trace(Visitor* visitor) const {
visitor->Trace(agents_);
visitor->Trace(document_);
visitor->Trace(popup_document_);
visitor->Trace(last_selected_from_active_descendant_);
visitor->Trace(layout_object_mapping_);
visitor->Trace(inline_text_box_object_mapping_);
visitor->Trace(layout_object_to_inline_text_boxes_);
visitor->Trace(active_aria_modal_dialog_);
visitor->Trace(objects_);
visitor->Trace(next_on_line_map_);
visitor->Trace(processed_blocks_);
visitor->Trace(previous_on_line_map_);
visitor->Trace(block_flow_data_cache_);
visitor->Trace(tree_update_callback_queue_main_);
visitor->Trace(tree_update_callback_queue_popup_);
visitor->Trace(render_accessibility_host_);
visitor->Trace(ax_tree_source_);
visitor->Trace(pending_objects_to_serialize_);
visitor->Trace(node_to_parse_before_more_tree_updates_);
visitor->Trace(weak_factory_for_serialization_pipeline_);
visitor->Trace(weak_factory_for_loc_updates_pipeline_);
AXObjectCache::Trace(visitor);
}
ax::mojom::blink::EventFrom AXObjectCacheImpl::ComputeEventFrom() {
if (active_event_from_ != ax::mojom::blink::EventFrom::kNone)
return active_event_from_;
if (document_ && document_->View() &&
LocalFrame::HasTransientUserActivation(
&(document_->View()->GetFrame()))) {
return ax::mojom::blink::EventFrom::kUser;
}
return ax::mojom::blink::EventFrom::kPage;
}
WebAXAutofillSuggestionAvailability
AXObjectCacheImpl::GetAutofillSuggestionAvailability(AXID id) const {
auto iter = autofill_suggestion_availability_map_.find(id);
if (iter == autofill_suggestion_availability_map_.end()) {
return WebAXAutofillSuggestionAvailability::kNoSuggestions;
}
return iter->value;
}
void AXObjectCacheImpl::SetAutofillSuggestionAvailability(
AXID id,
WebAXAutofillSuggestionAvailability suggestion_availability) {
WebAXAutofillSuggestionAvailability previous_suggestion_availability =
GetAutofillSuggestionAvailability(id);
if (suggestion_availability != previous_suggestion_availability) {
autofill_suggestion_availability_map_.Set(id, suggestion_availability);
MarkAXObjectDirty(ObjectFromAXID(id));
}
}
void AXObjectCacheImpl::AddPluginTreeToUpdate(ui::AXTreeUpdate* update) {
if (!plugin_tree_source_) {
return;
}
// Conceptually, a plugin tree "stitches" itself into an existing Blink
// accessibility node. For example, the node could be an <embed>. The plugin
// tree itself contains a root who's parent is the target of the stitching
// (e.g. the <embed> in the Blink accessibility tree). The plugin tree manages
// its own tree of nodes and the below logic handles how that gets integrated
// into Blink accessibility.
CHECK(plugin_serializer_.get());
// Search for the Blink accessibility node onto which we want to stitch the
// plugin tree.
for (ui::AXNodeData& node : update->nodes) {
if (node.role == ax::mojom::Role::kEmbeddedObject) {
// The embed node should already exist in the blink tree source's client
// tree.
CHECK(ax_tree_serializer_->IsInClientTree(
ax_tree_source_->GetFromId(node.id)));
// The plugin tree contains its own tree source, serializer pair. It isn't
// using Blink's source, serializer pair because its backing template tree
// source type is a pure AXNodeData.
const ui::AXNode* root = plugin_tree_source_->GetRoot();
if (!root) {
// The tree may not yet be ready.
continue;
}
node.child_ids.push_back(root->id());
// Serialize changes and integrate them into Blink accessibility's tree
// updates.
ui::AXTreeUpdate plugin_update;
plugin_serializer_->SerializeChanges(root, &plugin_update);
update->nodes.reserve(update->nodes.size() + plugin_update.nodes.size());
std::ranges::move(plugin_update.nodes, std::back_inserter(update->nodes));
if (plugin_tree_source_->GetTreeData(&update->tree_data)) {
update->has_tree_data = true;
}
break;
}
}
}
ui::AXTreeSource<const ui::AXNode*, ui::AXTreeData*, ui::AXNodeData>*
AXObjectCacheImpl::GetPluginTreeSource() {
return plugin_tree_source_.get();
}
void AXObjectCacheImpl::SetPluginTreeSource(
ui::AXTreeSource<const ui::AXNode*, ui::AXTreeData*, ui::AXNodeData>*
source) {
if (plugin_tree_source_.get() == source) {
return;
}
plugin_tree_source_ = source;
plugin_serializer_ =
source ? std::make_unique<PluginAXTreeSerializer>(source) : nullptr;
}
ui::AXTreeSerializer<const ui::AXNode*,
std::vector<const ui::AXNode*>,
ui::AXTreeUpdate*,
ui::AXTreeData*,
ui::AXNodeData>*
AXObjectCacheImpl::GetPluginTreeSerializer() {
return plugin_serializer_.get();
}
void AXObjectCacheImpl::ResetPluginTreeSerializer() {
if (plugin_serializer_.get()) {
plugin_serializer_->Reset();
}
}
void AXObjectCacheImpl::MarkPluginDescendantDirty(ui::AXNodeID node_id) {
if (plugin_serializer_.get()) {
plugin_serializer_->MarkSubtreeDirty(node_id);
}
}
void AXObjectCacheImpl::ComputeNodesOnLine(const LayoutObject* layout_object) {
// The following computation is expensive.
//
// This function works as follows:
// 1. If a layout object associated with an AXNodeObject has its data already
// computed, we finish early;
// 2. If the associated Layout Block that the inline element is contained is
// already processed, we finish early. Note that 2 must come after 1, since
// retrieving the block is not so cheap;
// 3. For each line of this layout block flow, we connect and store the layout
// objects that are part of this line. They are later used in
// Next|PreviousOnLine.
//
// The main advantage of this approach is to be able to, in a single pass,
// compute the next and previous objects in a single line.
if (!layout_object) {
return;
}
if (!layout_object->IsInline() ||
!layout_object->IsInLayoutNGInlineFormattingContext()) {
return;
}
if (CachedNextOnLine(layout_object)) {
return;
}
const LayoutBlockFlow* block_flow = layout_object->FragmentItemsContainer();
if (!block_flow) {
return;
}
if (!processed_blocks_.insert(block_flow).is_new_entry) {
return;
}
InlineCursor cursor(*block_flow);
if (!cursor) {
// Cursor may be null if all objects of this cursor are collapsed.
return;
}
// Important! The next call to MoveToNextInlineLeaf() below fails if we are
// not inside a line.
cursor.MoveToFirstLine();
if (!cursor) {
return;
}
do {
InlineCursor line_cursor = cursor;
// Moves to first LayoutObject that a11y cares about.
line_cursor.MoveToNextInlineLeaf();
// Maximum number of attempts to try to find a next object on the line. Used
// to
// detect unlikely (but theoretically possible), loops.
constexpr int kMaxInlineCursorNextObjectCalls = 250000;
int runs = 0;
while (line_cursor) {
runs++;
if (runs >= kMaxInlineCursorNextObjectCalls) [[unlikely]] {
// TODO(crbug.com/378761505): Move DUMP_WILL_BE_NOTREACHED() to CHECK().
DUMP_WILL_BE_NOTREACHED()
<< "Did not find an end to the processing of next / previous on "
"line candidates for "
<< layout_object << "(" << Get(layout_object) << ") after " << runs
<< " runs.";
break;
}
auto* line_object = line_cursor.Current().GetLayoutObject();
line_cursor.MoveToNextInlineLeafOnLine();
if (!line_object) [[unlikely]] {
break;
}
auto* next_line_object =
line_cursor ? line_cursor.Current().GetLayoutObject() : nullptr;
if (line_object == next_line_object) [[unlikely]] {
// TODO(crbug.com/378761505): Move DUMP_WILL_BE_NOTREACHED() to
// CHECK().
DUMP_WILL_BE_NOTREACHED()
<< "InlineCursor says it moved to the next inline leaf object "
"for a different LayyoutObject, but returned value is the "
"same as previous inline leaf."
<< "same object was: " << line_object << "(" << Get(line_object)
<< ") while processing " << layout_object << " after " << runs
<< " runs.";
break;
}
if (next_line_object) {
next_on_line_map_.insert(line_object, next_line_object);
previous_on_line_map_.insert(next_line_object, line_object);
} else {
// Reached the end of the line. Check if it contains a trailing white
// space that was not visited by the inline cursor because it was
// collapsed.
// The white space at the end of the line is important for a11y because
// if it is not part of the line text, a screen reader may not know
// that it has reached a previous line when going back to the previous
// line.
ConnectToTrailingWhitespaceOnLine(*line_object, *block_flow);
}
}
cursor.MoveToNextLine();
} while (cursor);
}
void AXObjectCacheImpl::ConnectToTrailingWhitespaceOnLine(
const LayoutObject& line_object,
const LayoutBlockFlow& block_flow) {
LayoutObject* trailing_whitespace_object =
PreviousLayoutObjectTextOnLine(line_object, block_flow);
if (!trailing_whitespace_object) {
return;
}
if (!IsAllCollapsedWhiteSpace(*trailing_whitespace_object)) {
return;
}
if (AXObject* obj = Get(trailing_whitespace_object);
obj && obj->IsIncludedInTree()) {
if (auto* previous = PreviousLayoutObjectTextOnLine(
*trailing_whitespace_object, block_flow)) {
// `trailing_whitespace_object` has a LayoutObject that is in
// the same line, connect them here.
// Note: we use `Set()` here to override if a value exists, where in
// `ComputeNodesOnLine()` we use `insert()`, which does not. This is
// necessary in case a object in the line pointed to something else, where
// now it needs to point to the trailing whitespace.
next_on_line_map_.Set(previous, trailing_whitespace_object);
previous_on_line_map_.Set(trailing_whitespace_object, previous);
}
}
}
const LayoutObject* AXObjectCacheImpl::CachedNextOnLine(
const LayoutObject* layout_object) {
auto it = next_on_line_map_.find(layout_object);
if (it != next_on_line_map_.end()) {
return it->value;
}
return nullptr;
}
const LayoutObject* AXObjectCacheImpl::CachedPreviousOnLine(
const LayoutObject* layout_object) {
auto it = previous_on_line_map_.find(layout_object);
if (it != previous_on_line_map_.end()) {
return it->value;
}
return nullptr;
}
void AXObjectCacheImpl::ClearCachedNodesOnLine() {
next_on_line_map_.clear();
previous_on_line_map_.clear();
processed_blocks_.clear();
}
#if AX_FAIL_FAST_BUILD()
void AXObjectCacheImpl::AddNodeRequiringCacheUpdate(AXID ax_id,
TreeUpdateReason reason) {
CHECK(ax_id);
nodes_requiring_cache_update_.Set(ax_id, reason);
}
void AXObjectCacheImpl::RemoveNodeRequiringCacheUpdate(AXID ax_id) {
// `nodes_requiring_cache_update_` may be empty when we try to remove an
// AXID because by default, nodes require cache update, but we don't add them
// to `nodes_requiring_cache_update_` in this case. On initialization, the
// cached attributes will be updated, which will attempt to remove the
// corresponding `ax_id` from `nodes_requiring_cache_update_`. As such, return
// early if the cache is empty.
if (!ax_id || nodes_requiring_cache_update_.empty()) {
return;
}
nodes_requiring_cache_update_.erase(ax_id);
}
#endif
bool AXObjectCacheImpl::MarkOnScreenNodes(
AXObject* obj,
const HitTestResult::NodeSet* on_screen_nodes) {
const bool was_on_screen = obj->WasEverOnScreen();
const bool can_flip = obj->CanFlipFromOffScreenToOnScreen();
// We can skip the check in the set to improve performance a bit here. If a
// node was ever on screen, it will always be.
const bool should_be_considered_on_screen =
was_on_screen || (obj->GetClosestNode() &&
on_screen_nodes->Contains(obj->GetClosestNode()));
if (obj->ChildCountIncludingIgnored() == 0) { // This is a leaf node.
// If this node was ever on-screen, keep serializing it or at least allow
// serializations to happen.
obj->SetIsOnScreen(should_be_considered_on_screen);
if (!obj->WasEverOnScreen()) {
// This node is still offscreen, so check if it can still be included by
// the extra nodes rule.
// Rule: allow a few extra nodes to be serialized with the first tree
// which are likely to be focused by ATs.
if (extra_off_screen_nodes_to_serialize_.size() <
kNumExtraNodesToSerialize &&
obj->IsTextObject()) {
extra_off_screen_nodes_to_serialize_.insert(obj->AXObjectID());
return true;
}
}
} else {
// Discover phase: Check if any children are on-screen.
// If any child is on-screen, this marks the entire parent chain up to the
// root on-screen.
bool any_child_visible = false;
for (AXObject* child : obj->CachedChildrenIncludingIgnored()) {
CHECK(child->IsIncludedInTree());
if (MarkOnScreenNodes(child, on_screen_nodes)) {
any_child_visible = true;
}
}
// Marking phase: Mark the node as on-screen if any child is on-screen OR if
// the node itself is/was on-screen.
obj->SetIsOnScreen(any_child_visible || should_be_considered_on_screen);
}
// Serialization phase: If this node flipped (was off-screen now on-screen,
// force it to be serialized, as clients are not aware of it). Note that this
// guarantees the parent that contain this child will flip too, so no need to
// call it here.
if (can_flip && was_on_screen != obj->WasEverOnScreen()) {
if (extra_off_screen_nodes_to_serialize_.Contains(obj->AXObjectID())) {
// Was added through the extra nodes rule, so remove it so that extra
// nodes can be added.
extra_off_screen_nodes_to_serialize_.erase(obj->AXObjectID());
}
AddDirtyObjectToSerializationQueue(obj);
}
return obj->WasEverOnScreen();
}
std::ostream& operator<<(std::ostream& stream, const AXObjectCacheImpl& cache) {
return stream << "AXObjectCache: " << cache.lifecycle().ToString();
}
} // namespace blink
|