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
|
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#include "AccEvent.h"
#include "LocalAccessible-inl.h"
#include "EmbeddedObjCollector.h"
#include "AccAttributes.h"
#include "AccGroupInfo.h"
#include "AccIterator.h"
#include "CacheConstants.h"
#include "CachedTableAccessible.h"
#include "DocAccessible-inl.h"
#include "mozilla/a11y/AccAttributes.h"
#include "nsAccUtils.h"
#include "nsAccessibilityService.h"
#include "ApplicationAccessible.h"
#include "nsAccessiblePivot.h"
#include "nsGenericHTMLElement.h"
#include "NotificationController.h"
#include "nsEventShell.h"
#include "nsTextEquivUtils.h"
#include "DocAccessibleChild.h"
#include "EventTree.h"
#include "OuterDocAccessible.h"
#include "Pivot.h"
#include "Relation.h"
#include "Role.h"
#include "RootAccessible.h"
#include "States.h"
#include "StyleInfo.h"
#include "TextLeafRange.h"
#include "TextRange.h"
#include "TableAccessible.h"
#include "TableCellAccessible.h"
#include "TreeWalker.h"
#include "HTMLElementAccessibles.h"
#include "HTMLSelectAccessible.h"
#include "ImageAccessible.h"
#include "nsIDOMXULButtonElement.h"
#include "nsIDOMXULSelectCntrlEl.h"
#include "nsIDOMXULSelectCntrlItemEl.h"
#include "nsINodeList.h"
#include "nsPIDOMWindow.h"
#include "mozilla/dom/Document.h"
#include "mozilla/dom/HTMLFormElement.h"
#include "mozilla/dom/HTMLAnchorElement.h"
#include "mozilla/gfx/Matrix.h"
#include "nsIContent.h"
#include "nsIFormControl.h"
#include "nsLayoutUtils.h"
#include "nsPresContext.h"
#include "nsIFrame.h"
#include "nsTextFrame.h"
#include "nsView.h"
#include "nsIDocShellTreeItem.h"
#include "nsIScrollableFrame.h"
#include "nsStyleStructInlines.h"
#include "nsFocusManager.h"
#include "nsString.h"
#include "nsUnicharUtils.h"
#include "nsReadableUtils.h"
#include "prdtoa.h"
#include "nsAtom.h"
#include "nsIURI.h"
#include "nsArrayUtils.h"
#include "nsWhitespaceTokenizer.h"
#include "nsAttrName.h"
#include "nsContainerFrame.h"
#include "mozilla/Assertions.h"
#include "mozilla/BasicEvents.h"
#include "mozilla/Components.h"
#include "mozilla/ErrorResult.h"
#include "mozilla/FloatingPoint.h"
#include "mozilla/MouseEvents.h"
#include "mozilla/PresShell.h"
#include "mozilla/Unused.h"
#include "mozilla/Preferences.h"
#include "mozilla/ProfilerMarkers.h"
#include "mozilla/StaticPrefs_accessibility.h"
#include "mozilla/StaticPrefs_ui.h"
#include "mozilla/dom/CanvasRenderingContext2D.h"
#include "mozilla/dom/Element.h"
#include "mozilla/dom/HTMLCanvasElement.h"
#include "mozilla/dom/HTMLBodyElement.h"
#include "mozilla/dom/HTMLLabelElement.h"
#include "mozilla/dom/KeyboardEventBinding.h"
#include "mozilla/dom/TreeWalker.h"
#include "mozilla/dom/UserActivation.h"
#include "mozilla/dom/MutationEventBinding.h"
using namespace mozilla;
using namespace mozilla::a11y;
////////////////////////////////////////////////////////////////////////////////
// LocalAccessible: nsISupports and cycle collection
NS_IMPL_CYCLE_COLLECTION_CLASS(LocalAccessible)
NS_IMPL_CYCLE_COLLECTION_UNLINK_BEGIN(LocalAccessible)
tmp->Shutdown();
NS_IMPL_CYCLE_COLLECTION_UNLINK_END
NS_IMPL_CYCLE_COLLECTION_TRAVERSE_BEGIN(LocalAccessible)
NS_IMPL_CYCLE_COLLECTION_TRAVERSE(mContent, mDoc)
NS_IMPL_CYCLE_COLLECTION_TRAVERSE_END
NS_INTERFACE_MAP_BEGIN_CYCLE_COLLECTION(LocalAccessible)
NS_INTERFACE_MAP_ENTRY_CONCRETE(LocalAccessible)
NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, LocalAccessible)
NS_INTERFACE_MAP_END
NS_IMPL_CYCLE_COLLECTING_ADDREF(LocalAccessible)
NS_IMPL_CYCLE_COLLECTING_RELEASE_WITH_DESTROY(LocalAccessible, LastRelease())
LocalAccessible::LocalAccessible(nsIContent* aContent, DocAccessible* aDoc)
: Accessible(),
mContent(aContent),
mDoc(aDoc),
mParent(nullptr),
mIndexInParent(-1),
mBounds(),
mFirstLineStart(-1),
mStateFlags(0),
mContextFlags(0),
mReorderEventTarget(false),
mShowEventTarget(false),
mHideEventTarget(false),
mIndexOfEmbeddedChild(-1),
mGroupInfo(nullptr) {}
LocalAccessible::~LocalAccessible() {
NS_ASSERTION(!mDoc, "LastRelease was never called!?!");
}
ENameValueFlag LocalAccessible::Name(nsString& aName) const {
aName.Truncate();
if (!HasOwnContent()) return eNameOK;
ARIAName(aName);
if (!aName.IsEmpty()) return eNameOK;
ENameValueFlag nameFlag = NativeName(aName);
if (!aName.IsEmpty()) return nameFlag;
// In the end get the name from tooltip.
if (mContent->IsHTMLElement()) {
if (mContent->AsElement()->GetAttr(kNameSpaceID_None, nsGkAtoms::title,
aName)) {
aName.CompressWhitespace();
return eNameFromTooltip;
}
} else if (mContent->IsXULElement()) {
if (mContent->AsElement()->GetAttr(kNameSpaceID_None,
nsGkAtoms::tooltiptext, aName)) {
aName.CompressWhitespace();
return eNameFromTooltip;
}
} else if (mContent->IsSVGElement()) {
// If user agents need to choose among multiple 'desc' or 'title'
// elements for processing, the user agent shall choose the first one.
for (nsIContent* childElm = mContent->GetFirstChild(); childElm;
childElm = childElm->GetNextSibling()) {
if (childElm->IsSVGElement(nsGkAtoms::desc)) {
nsTextEquivUtils::AppendTextEquivFromContent(this, childElm, &aName);
return eNameFromTooltip;
}
}
}
aName.SetIsVoid(true);
return nameFlag;
}
void LocalAccessible::Description(nsString& aDescription) const {
// There are 4 conditions that make an accessible have no accDescription:
// 1. it's a text node; or
// 2. It has no ARIA describedby or description property
// 3. it doesn't have an accName; or
// 4. its title attribute already equals to its accName nsAutoString name;
if (!HasOwnContent() || mContent->IsText()) return;
ARIADescription(aDescription);
if (aDescription.IsEmpty()) {
NativeDescription(aDescription);
if (aDescription.IsEmpty()) {
// Keep the Name() method logic.
if (mContent->IsHTMLElement()) {
mContent->AsElement()->GetAttr(kNameSpaceID_None, nsGkAtoms::title,
aDescription);
} else if (mContent->IsXULElement()) {
mContent->AsElement()->GetAttr(kNameSpaceID_None,
nsGkAtoms::tooltiptext, aDescription);
} else if (mContent->IsSVGElement()) {
for (nsIContent* childElm = mContent->GetFirstChild(); childElm;
childElm = childElm->GetNextSibling()) {
if (childElm->IsSVGElement(nsGkAtoms::desc)) {
nsTextEquivUtils::AppendTextEquivFromContent(this, childElm,
&aDescription);
break;
}
}
}
}
}
if (!aDescription.IsEmpty()) {
aDescription.CompressWhitespace();
nsAutoString name;
Name(name);
// Don't expose a description if it is the same as the name.
if (aDescription.Equals(name)) aDescription.Truncate();
}
}
KeyBinding LocalAccessible::AccessKey() const {
if (!HasOwnContent()) return KeyBinding();
uint32_t key = nsCoreUtils::GetAccessKeyFor(mContent);
if (!key && mContent->IsElement()) {
LocalAccessible* label = nullptr;
// Copy access key from label node.
if (mContent->IsHTMLElement()) {
// Unless it is labeled via an ancestor <label>, in which case that would
// be redundant.
HTMLLabelIterator iter(Document(), this,
HTMLLabelIterator::eSkipAncestorLabel);
label = iter.Next();
}
if (!label) {
XULLabelIterator iter(Document(), mContent);
label = iter.Next();
}
if (label) key = nsCoreUtils::GetAccessKeyFor(label->GetContent());
}
if (!key) return KeyBinding();
// Get modifier mask. Use ui.key.generalAccessKey (unless it is -1).
switch (StaticPrefs::ui_key_generalAccessKey()) {
case -1:
break;
case dom::KeyboardEvent_Binding::DOM_VK_SHIFT:
return KeyBinding(key, KeyBinding::kShift);
case dom::KeyboardEvent_Binding::DOM_VK_CONTROL:
return KeyBinding(key, KeyBinding::kControl);
case dom::KeyboardEvent_Binding::DOM_VK_ALT:
return KeyBinding(key, KeyBinding::kAlt);
case dom::KeyboardEvent_Binding::DOM_VK_META:
return KeyBinding(key, KeyBinding::kMeta);
default:
return KeyBinding();
}
// Determine the access modifier used in this context.
dom::Document* document = mContent->GetComposedDoc();
if (!document) return KeyBinding();
nsCOMPtr<nsIDocShellTreeItem> treeItem(document->GetDocShell());
if (!treeItem) return KeyBinding();
nsresult rv = NS_ERROR_FAILURE;
int32_t modifierMask = 0;
switch (treeItem->ItemType()) {
case nsIDocShellTreeItem::typeChrome:
modifierMask = StaticPrefs::ui_key_chromeAccess();
rv = NS_OK;
break;
case nsIDocShellTreeItem::typeContent:
modifierMask = StaticPrefs::ui_key_contentAccess();
rv = NS_OK;
break;
}
return NS_SUCCEEDED(rv) ? KeyBinding(key, modifierMask) : KeyBinding();
}
KeyBinding LocalAccessible::KeyboardShortcut() const { return KeyBinding(); }
uint64_t LocalAccessible::VisibilityState() const {
if (IPCAccessibilityActive() &&
StaticPrefs::accessibility_cache_enabled_AtStartup()) {
// Visibility states must be calculated by RemoteAccessible, so there's no
// point calculating them here.
return 0;
}
nsIFrame* frame = GetFrame();
if (!frame) {
// Element having display:contents is considered visible semantically,
// despite it doesn't have a visually visible box.
if (nsCoreUtils::IsDisplayContents(mContent)) {
return states::OFFSCREEN;
}
return states::INVISIBLE;
}
if (!frame->StyleVisibility()->IsVisible()) return states::INVISIBLE;
// It's invisible if the presshell is hidden by a visibility:hidden element in
// an ancestor document.
if (frame->PresShell()->IsUnderHiddenEmbedderElement()) {
return states::INVISIBLE;
}
// Offscreen state if the document's visibility state is not visible.
if (Document()->IsHidden()) return states::OFFSCREEN;
// Walk the parent frame chain to see if the frame is in background tab or
// scrolled out.
nsIFrame* curFrame = frame;
do {
nsView* view = curFrame->GetView();
if (view && view->GetVisibility() == nsViewVisibility_kHide) {
return states::INVISIBLE;
}
if (nsLayoutUtils::IsPopup(curFrame)) {
return 0;
}
if (curFrame->StyleUIReset()->mMozSubtreeHiddenOnlyVisually) {
// Offscreen state for background tab content.
return states::OFFSCREEN;
}
nsIFrame* parentFrame = curFrame->GetParent();
// If contained by scrollable frame then check that at least 12 pixels
// around the object is visible, otherwise the object is offscreen.
nsIScrollableFrame* scrollableFrame = do_QueryFrame(parentFrame);
const nscoord kMinPixels = nsPresContext::CSSPixelsToAppUnits(12);
if (scrollableFrame) {
nsRect scrollPortRect = scrollableFrame->GetScrollPortRect();
nsRect frameRect = nsLayoutUtils::TransformFrameRectToAncestor(
frame, frame->GetRectRelativeToSelf(), parentFrame);
if (!scrollPortRect.Contains(frameRect)) {
scrollPortRect.Deflate(kMinPixels, kMinPixels);
if (!scrollPortRect.Intersects(frameRect)) return states::OFFSCREEN;
}
}
if (!parentFrame) {
parentFrame = nsLayoutUtils::GetCrossDocParentFrameInProcess(curFrame);
// Even if we couldn't find the parent frame, it might mean we are in an
// out-of-process iframe, try to see if |frame| is scrolled out in an
// scrollable frame in a cross-process ancestor document.
if (!parentFrame &&
nsLayoutUtils::FrameIsMostlyScrolledOutOfViewInCrossProcess(
frame, kMinPixels)) {
return states::OFFSCREEN;
}
}
curFrame = parentFrame;
} while (curFrame);
// Zero area rects can occur in the first frame of a multi-frame text flow,
// in which case the rendered text is not empty and the frame should not be
// marked invisible.
// XXX Can we just remove this check? Why do we need to mark empty
// text invisible?
if (frame->IsTextFrame() && !(frame->GetStateBits() & NS_FRAME_OUT_OF_FLOW) &&
frame->GetRect().IsEmpty()) {
nsIFrame::RenderedText text = frame->GetRenderedText(
0, UINT32_MAX, nsIFrame::TextOffsetType::OffsetsInContentText,
nsIFrame::TrailingWhitespace::DontTrim);
if (text.mString.IsEmpty()) {
return states::INVISIBLE;
}
}
return 0;
}
uint64_t LocalAccessible::NativeState() const {
uint64_t state = 0;
if (!IsInDocument()) state |= states::STALE;
if (HasOwnContent() && mContent->IsElement()) {
dom::ElementState elementState = mContent->AsElement()->State();
if (elementState.HasState(dom::ElementState::INVALID)) {
state |= states::INVALID;
}
if (elementState.HasState(dom::ElementState::REQUIRED)) {
state |= states::REQUIRED;
}
state |= NativeInteractiveState();
}
// Gather states::INVISIBLE and states::OFFSCREEN flags for this object.
state |= VisibilityState();
nsIFrame* frame = GetFrame();
if (frame) {
if (frame->GetStateBits() & NS_FRAME_OUT_OF_FLOW) state |= states::FLOATING;
// XXX we should look at layout for non XUL box frames, but need to decide
// how that interacts with ARIA.
if (HasOwnContent() && mContent->IsXULElement() && frame->IsXULBoxFrame()) {
const nsStyleXUL* xulStyle = frame->StyleXUL();
if (xulStyle && frame->IsXULBoxFrame()) {
// In XUL all boxes are either vertical or horizontal
if (xulStyle->mBoxOrient == StyleBoxOrient::Vertical) {
state |= states::VERTICAL;
} else {
state |= states::HORIZONTAL;
}
}
}
}
// Check if a XUL element has the popup attribute (an attached popup menu).
if (HasOwnContent() && mContent->IsXULElement() &&
mContent->AsElement()->HasAttr(kNameSpaceID_None, nsGkAtoms::popup)) {
state |= states::HASPOPUP;
}
// Bypass the link states specialization for non links.
const nsRoleMapEntry* roleMapEntry = ARIARoleMap();
if (!roleMapEntry || roleMapEntry->roleRule == kUseNativeRole ||
roleMapEntry->role == roles::LINK) {
state |= NativeLinkState();
}
return state;
}
uint64_t LocalAccessible::NativeInteractiveState() const {
if (!mContent->IsElement()) return 0;
if (NativelyUnavailable()) return states::UNAVAILABLE;
nsIFrame* frame = GetFrame();
if (frame && frame->IsFocusable()) return states::FOCUSABLE;
return 0;
}
uint64_t LocalAccessible::NativeLinkState() const { return 0; }
bool LocalAccessible::NativelyUnavailable() const {
if (mContent->IsHTMLElement()) return mContent->AsElement()->IsDisabled();
return mContent->IsElement() && mContent->AsElement()->AttrValueIs(
kNameSpaceID_None, nsGkAtoms::disabled,
nsGkAtoms::_true, eCaseMatters);
}
Accessible* LocalAccessible::ChildAtPoint(int32_t aX, int32_t aY,
EWhichChildAtPoint aWhichChild) {
Accessible* child = LocalChildAtPoint(aX, aY, aWhichChild);
if (aWhichChild != EWhichChildAtPoint::DirectChild && child &&
child->IsOuterDoc()) {
child = child->ChildAtPoint(aX, aY, aWhichChild);
}
return child;
}
LocalAccessible* LocalAccessible::LocalChildAtPoint(
int32_t aX, int32_t aY, EWhichChildAtPoint aWhichChild) {
// If we can't find the point in a child, we will return the fallback answer:
// we return |this| if the point is within it, otherwise nullptr.
LocalAccessible* fallbackAnswer = nullptr;
LayoutDeviceIntRect rect = Bounds();
if (rect.Contains(aX, aY)) fallbackAnswer = this;
if (nsAccUtils::MustPrune(this)) { // Do not dig any further
return fallbackAnswer;
}
// Search an accessible at the given point starting from accessible document
// because containing block (see CSS2) for out of flow element (for example,
// absolutely positioned element) may be different from its DOM parent and
// therefore accessible for containing block may be different from accessible
// for DOM parent but GetFrameForPoint() should be called for containing block
// to get an out of flow element.
DocAccessible* accDocument = Document();
NS_ENSURE_TRUE(accDocument, nullptr);
nsIFrame* rootFrame = accDocument->GetFrame();
NS_ENSURE_TRUE(rootFrame, nullptr);
nsIFrame* startFrame = rootFrame;
// Check whether the point is at popup content.
nsIWidget* rootWidget = rootFrame->GetView()->GetNearestWidget(nullptr);
NS_ENSURE_TRUE(rootWidget, nullptr);
LayoutDeviceIntRect rootRect = rootWidget->GetScreenBounds();
auto point = LayoutDeviceIntPoint(aX - rootRect.X(), aY - rootRect.Y());
nsIFrame* popupFrame = nsLayoutUtils::GetPopupFrameForPoint(
accDocument->PresContext()->GetRootPresContext(), rootWidget, point);
if (popupFrame) {
// If 'this' accessible is not inside the popup then ignore the popup when
// searching an accessible at point.
DocAccessible* popupDoc =
GetAccService()->GetDocAccessible(popupFrame->GetContent()->OwnerDoc());
LocalAccessible* popupAcc =
popupDoc->GetAccessibleOrContainer(popupFrame->GetContent());
LocalAccessible* popupChild = this;
while (popupChild && !popupChild->IsDoc() && popupChild != popupAcc) {
popupChild = popupChild->LocalParent();
}
if (popupChild == popupAcc) startFrame = popupFrame;
}
nsPresContext* presContext = startFrame->PresContext();
nsRect screenRect = startFrame->GetScreenRectInAppUnits();
nsPoint offset(presContext->DevPixelsToAppUnits(aX) - screenRect.X(),
presContext->DevPixelsToAppUnits(aY) - screenRect.Y());
nsIFrame* foundFrame = nsLayoutUtils::GetFrameForPoint(
RelativeTo{startFrame, ViewportType::Visual}, offset);
nsIContent* content = nullptr;
if (!foundFrame || !(content = foundFrame->GetContent())) {
return fallbackAnswer;
}
// Get accessible for the node with the point or the first accessible in
// the DOM parent chain.
DocAccessible* contentDocAcc =
GetAccService()->GetDocAccessible(content->OwnerDoc());
// contentDocAcc in some circumstances can be nullptr. See bug 729861
NS_ASSERTION(contentDocAcc, "could not get the document accessible");
if (!contentDocAcc) return fallbackAnswer;
LocalAccessible* accessible =
contentDocAcc->GetAccessibleOrContainer(content);
if (!accessible) return fallbackAnswer;
// Hurray! We have an accessible for the frame that layout gave us.
// Since DOM node of obtained accessible may be out of flow then we should
// ensure obtained accessible is a child of this accessible.
LocalAccessible* child = accessible;
while (child != this) {
LocalAccessible* parent = child->LocalParent();
if (!parent) {
// Reached the top of the hierarchy. These bounds were inside an
// accessible that is not a descendant of this one.
return fallbackAnswer;
}
// If we landed on a legitimate child of |this|, and we want the direct
// child, return it here.
if (parent == this && aWhichChild == EWhichChildAtPoint::DirectChild) {
return child;
}
child = parent;
}
// Manually walk through accessible children and see if the are within this
// point. Skip offscreen or invisible accessibles. This takes care of cases
// where layout won't walk into things for us, such as image map areas and
// sub documents (XXX: subdocuments should be handled by methods of
// OuterDocAccessibles).
uint32_t childCount = accessible->ChildCount();
if (childCount == 1 && accessible->IsOuterDoc() &&
accessible->FirstChild()->IsRemote()) {
// No local children.
return accessible;
}
for (uint32_t childIdx = 0; childIdx < childCount; childIdx++) {
LocalAccessible* child = accessible->LocalChildAt(childIdx);
LayoutDeviceIntRect childRect = child->Bounds();
if (childRect.Contains(aX, aY) &&
(child->State() & states::INVISIBLE) == 0) {
if (aWhichChild == EWhichChildAtPoint::DeepestChild) {
return child->LocalChildAtPoint(aX, aY,
EWhichChildAtPoint::DeepestChild);
}
return child;
}
}
return accessible;
}
nsIFrame* LocalAccessible::FindNearestAccessibleAncestorFrame() {
nsIFrame* frame = GetFrame();
if (IsDoc()) {
// We bound documents by their own frame, which is their PresShell's root
// frame. We cache the document offset elsewhere in BundleFieldsForCache
// using the nsGkAtoms::crossorigin attribute.
MOZ_ASSERT(frame, "DocAccessibles should always have a frame");
return frame;
}
// Iterate through accessible's ancestors to find one with a frame.
LocalAccessible* ancestor = mParent;
while (ancestor) {
if (nsIFrame* boundingFrame = ancestor->GetFrame()) {
return boundingFrame;
}
ancestor = ancestor->LocalParent();
}
MOZ_ASSERT_UNREACHABLE("No ancestor with frame?");
return nsLayoutUtils::GetContainingBlockForClientRect(frame);
}
nsRect LocalAccessible::ParentRelativeBounds() {
nsIFrame* frame = GetFrame();
if (frame && mContent) {
nsIFrame* boundingFrame = FindNearestAccessibleAncestorFrame();
nsRect result = nsLayoutUtils::GetAllInFlowRectsUnion(frame, boundingFrame);
if (result.IsEmpty()) {
// If we end up with a 0x0 rect from above (or one with negative
// height/width) we should try using the ink overflow rect instead. If we
// use this rect, our relative bounds will match the bounds of what
// appears visually. We do this because some web authors (icloud.com for
// example) employ things like 0x0 buttons with visual overflow. Without
// this, such frames aren't navigable by screen readers.
result = frame->InkOverflowRectRelativeToSelf();
nsLayoutUtils::TransformRect(frame, boundingFrame, result);
}
if (nsIScrollableFrame* sf =
mParent == mDoc
? mDoc->PresShellPtr()->GetRootScrollFrameAsScrollable()
: boundingFrame->GetScrollTargetFrame()) {
// If boundingFrame has a scroll position, result is currently relative
// to that. Instead, we want result to remain the same regardless of
// scrolling. We then subtract the scroll position later when calculating
// absolute bounds. We do this because we don't want to push cache
// updates for the bounds of all descendants every time we scroll.
nsPoint scrollPos = sf->GetScrollPosition().ApplyResolution(
mDoc->PresShellPtr()->GetResolution());
result.MoveBy(scrollPos.x, scrollPos.y);
}
return result;
}
return nsRect();
}
nsRect LocalAccessible::RelativeBounds(nsIFrame** aBoundingFrame) const {
nsIFrame* frame = GetFrame();
if (frame && mContent) {
*aBoundingFrame = nsLayoutUtils::GetContainingBlockForClientRect(frame);
nsRect unionRect = nsLayoutUtils::GetAllInFlowRectsUnion(
frame, *aBoundingFrame, nsLayoutUtils::RECTS_ACCOUNT_FOR_TRANSFORMS);
if (unionRect.IsEmpty()) {
// If we end up with a 0x0 rect from above (or one with negative
// height/width) we should try using the ink overflow rect instead. If we
// use this rect, our relative bounds will match the bounds of what
// appears visually. We do this because some web authors (icloud.com for
// example) employ things like 0x0 buttons with visual overflow. Without
// this, such frames aren't navigable by screen readers.
nsRect overflow = frame->InkOverflowRectRelativeToSelf();
nsLayoutUtils::TransformRect(frame, *aBoundingFrame, overflow);
return overflow;
}
return unionRect;
}
return nsRect();
}
nsRect LocalAccessible::BoundsInAppUnits() const {
nsIFrame* boundingFrame = nullptr;
nsRect unionRectTwips = RelativeBounds(&boundingFrame);
if (!boundingFrame) {
return nsRect();
}
PresShell* presShell = mDoc->PresContext()->PresShell();
// We need to inverse translate with the offset of the edge of the visual
// viewport from top edge of the layout viewport.
nsPoint viewportOffset = presShell->GetVisualViewportOffset() -
presShell->GetLayoutViewportOffset();
unionRectTwips.MoveBy(-viewportOffset);
// We need to take into account a non-1 resolution set on the presshell.
// This happens with async pinch zooming. Here we scale the bounds before
// adding the screen-relative offset.
unionRectTwips.ScaleRoundOut(presShell->GetResolution());
// We have the union of the rectangle, now we need to put it in absolute
// screen coords.
nsRect orgRectPixels = boundingFrame->GetScreenRectInAppUnits();
unionRectTwips.MoveBy(orgRectPixels.X(), orgRectPixels.Y());
return unionRectTwips;
}
LayoutDeviceIntRect LocalAccessible::Bounds() const {
return LayoutDeviceIntRect::FromAppUnitsToNearest(
BoundsInAppUnits(), mDoc->PresContext()->AppUnitsPerDevPixel());
}
void LocalAccessible::SetSelected(bool aSelect) {
if (!HasOwnContent()) return;
LocalAccessible* select = nsAccUtils::GetSelectableContainer(this, State());
if (select) {
if (select->State() & states::MULTISELECTABLE) {
if (mContent->IsElement() && ARIARoleMap()) {
if (aSelect) {
mContent->AsElement()->SetAttr(
kNameSpaceID_None, nsGkAtoms::aria_selected, u"true"_ns, true);
} else {
mContent->AsElement()->UnsetAttr(kNameSpaceID_None,
nsGkAtoms::aria_selected, true);
}
}
return;
}
if (aSelect) TakeFocus();
}
}
void LocalAccessible::TakeSelection() {
LocalAccessible* select = nsAccUtils::GetSelectableContainer(this, State());
if (select) {
if (select->State() & states::MULTISELECTABLE) select->UnselectAll();
SetSelected(true);
}
}
void LocalAccessible::TakeFocus() const {
nsIFrame* frame = GetFrame();
if (!frame) return;
nsIContent* focusContent = mContent;
// If the accessible focus is managed by container widget then focus the
// widget and set the accessible as its current item.
if (!frame->IsFocusable()) {
LocalAccessible* widget = ContainerWidget();
if (widget && widget->AreItemsOperable()) {
nsIContent* widgetElm = widget->GetContent();
nsIFrame* widgetFrame = widgetElm->GetPrimaryFrame();
if (widgetFrame && widgetFrame->IsFocusable()) {
focusContent = widgetElm;
widget->SetCurrentItem(this);
}
}
}
if (RefPtr<nsFocusManager> fm = nsFocusManager::GetFocusManager()) {
dom::AutoHandlingUserInputStatePusher inputStatePusher(true);
// XXXbz: Can we actually have a non-element content here?
RefPtr<dom::Element> element = dom::Element::FromNodeOrNull(focusContent);
fm->SetFocus(element, 0);
}
}
void LocalAccessible::NameFromAssociatedXULLabel(DocAccessible* aDocument,
nsIContent* aElm,
nsString& aName) {
LocalAccessible* label = nullptr;
XULLabelIterator iter(aDocument, aElm);
while ((label = iter.Next())) {
// Check if label's value attribute is used
label->Elm()->GetAttr(kNameSpaceID_None, nsGkAtoms::value, aName);
if (aName.IsEmpty()) {
// If no value attribute, a non-empty label must contain
// children that define its text -- possibly using HTML
nsTextEquivUtils::AppendTextEquivFromContent(label, label->Elm(), &aName);
}
}
aName.CompressWhitespace();
}
void LocalAccessible::XULElmName(DocAccessible* aDocument, nsIContent* aElm,
nsString& aName) {
/**
* 3 main cases for XUL Controls to be labeled
* 1 - control contains label="foo"
* 2 - non-child label contains control="controlID"
* - label has either value="foo" or children
* 3 - name from subtree; e.g. a child label element
* Cases 1 and 2 are handled here.
* Case 3 is handled by GetNameFromSubtree called in NativeName.
* Once a label is found, the search is discontinued, so a control
* that has a label attribute as well as having a label external to
* the control that uses the control="controlID" syntax will use
* the label attribute for its Name.
*/
// CASE #1 (via label attribute) -- great majority of the cases
// Only do this if this is not a select control element, which uses label
// attribute to indicate, which option is selected.
nsCOMPtr<nsIDOMXULSelectControlElement> select =
aElm->AsElement()->AsXULSelectControl();
if (!select) {
aElm->AsElement()->GetAttr(kNameSpaceID_None, nsGkAtoms::label, aName);
}
// CASE #2 -- label as <label control="id" ... ></label>
if (aName.IsEmpty()) {
NameFromAssociatedXULLabel(aDocument, aElm, aName);
}
aName.CompressWhitespace();
}
nsresult LocalAccessible::HandleAccEvent(AccEvent* aEvent) {
NS_ENSURE_ARG_POINTER(aEvent);
if (profiler_thread_is_being_profiled_for_markers()) {
nsAutoCString strEventType;
GetAccService()->GetStringEventType(aEvent->GetEventType(), strEventType);
nsAutoCString strMarker;
strMarker.AppendLiteral("A11y Event - ");
strMarker.Append(strEventType);
PROFILER_MARKER_UNTYPED(strMarker, A11Y);
}
if (IPCAccessibilityActive() && Document()) {
DocAccessibleChild* ipcDoc = mDoc->IPCDoc();
// If ipcDoc is null, we can't fire the event to the client. We shouldn't
// have fired the event in the first place, since this makes events
// inconsistent for local and remote documents. To avoid this, don't call
// nsEventShell::FireEvent on a DocAccessible for which
// HasLoadState(eTreeConstructed) is false.
MOZ_ASSERT(ipcDoc);
if (ipcDoc) {
uint64_t id = aEvent->GetAccessible()->ID();
switch (aEvent->GetEventType()) {
case nsIAccessibleEvent::EVENT_SHOW:
ipcDoc->ShowEvent(downcast_accEvent(aEvent));
break;
case nsIAccessibleEvent::EVENT_HIDE:
ipcDoc->SendHideEvent(id, aEvent->IsFromUserInput());
break;
case nsIAccessibleEvent::EVENT_INNER_REORDER:
case nsIAccessibleEvent::EVENT_REORDER:
if (IsTable()) {
SendCache(CacheDomain::Table, CacheUpdateType::Update);
}
#if defined(XP_WIN)
if (StaticPrefs::accessibility_cache_enabled_AtStartup() &&
HasOwnContent() && mContent->IsMathMLElement()) {
// For any change in a MathML subtree, update the innerHTML cache on
// the root math element.
for (LocalAccessible* acc = this; acc; acc = acc->LocalParent()) {
if (acc->HasOwnContent() &&
acc->mContent->IsMathMLElement(nsGkAtoms::math)) {
mDoc->QueueCacheUpdate(acc, CacheDomain::InnerHTML);
}
}
}
#endif // defined(XP_WIN)
// reorder events on the application acc aren't necessary to tell the
// parent about new top level documents.
if (!aEvent->GetAccessible()->IsApplication()) {
ipcDoc->SendEvent(id, aEvent->GetEventType());
}
break;
case nsIAccessibleEvent::EVENT_STATE_CHANGE: {
AccStateChangeEvent* event = downcast_accEvent(aEvent);
ipcDoc->SendStateChangeEvent(id, event->GetState(),
event->IsStateEnabled());
break;
}
case nsIAccessibleEvent::EVENT_TEXT_CARET_MOVED: {
AccCaretMoveEvent* event = downcast_accEvent(aEvent);
ipcDoc->SendCaretMoveEvent(
id, event->GetCaretOffset(), event->IsSelectionCollapsed(),
event->IsAtEndOfLine(), event->GetGranularity());
break;
}
case nsIAccessibleEvent::EVENT_TEXT_INSERTED:
case nsIAccessibleEvent::EVENT_TEXT_REMOVED: {
AccTextChangeEvent* event = downcast_accEvent(aEvent);
const nsString& text = event->ModifiedText();
#if defined(XP_WIN)
// On Windows with the cache disabled, events for live region updates
// containing embedded objects require us to dispatch synchronous
// events.
bool sync = !StaticPrefs::accessibility_cache_enabled_AtStartup() &&
text.Contains(L'\xfffc') &&
nsAccUtils::IsARIALive(aEvent->GetAccessible());
#endif
ipcDoc->SendTextChangeEvent(id, text, event->GetStartOffset(),
event->GetLength(),
event->IsTextInserted(),
event->IsFromUserInput()
#if defined(XP_WIN)
// This parameter only exists on Windows.
,
sync
#endif
);
break;
}
case nsIAccessibleEvent::EVENT_SELECTION:
case nsIAccessibleEvent::EVENT_SELECTION_ADD:
case nsIAccessibleEvent::EVENT_SELECTION_REMOVE: {
AccSelChangeEvent* selEvent = downcast_accEvent(aEvent);
ipcDoc->SendSelectionEvent(id, selEvent->Widget()->ID(),
aEvent->GetEventType());
break;
}
case nsIAccessibleEvent::EVENT_VIRTUALCURSOR_CHANGED: {
AccVCChangeEvent* vcEvent = downcast_accEvent(aEvent);
LocalAccessible* position = vcEvent->NewAccessible();
LocalAccessible* oldPosition = vcEvent->OldAccessible();
ipcDoc->SendVirtualCursorChangeEvent(
id, oldPosition ? oldPosition->ID() : 0,
vcEvent->OldStartOffset(), vcEvent->OldEndOffset(),
position ? position->ID() : 0, vcEvent->NewStartOffset(),
vcEvent->NewEndOffset(), vcEvent->Reason(),
vcEvent->BoundaryType(), vcEvent->IsFromUserInput());
break;
}
#if defined(XP_WIN)
case nsIAccessibleEvent::EVENT_FOCUS: {
ipcDoc->SendFocusEvent(id);
break;
}
#endif
case nsIAccessibleEvent::EVENT_SCROLLING_END:
case nsIAccessibleEvent::EVENT_SCROLLING: {
AccScrollingEvent* scrollingEvent = downcast_accEvent(aEvent);
ipcDoc->SendScrollingEvent(
id, aEvent->GetEventType(), scrollingEvent->ScrollX(),
scrollingEvent->ScrollY(), scrollingEvent->MaxScrollX(),
scrollingEvent->MaxScrollY());
break;
}
#if !defined(XP_WIN)
case nsIAccessibleEvent::EVENT_ANNOUNCEMENT: {
AccAnnouncementEvent* announcementEvent = downcast_accEvent(aEvent);
ipcDoc->SendAnnouncementEvent(id, announcementEvent->Announcement(),
announcementEvent->Priority());
break;
}
#endif // !defined(XP_WIN)
case nsIAccessibleEvent::EVENT_TEXT_SELECTION_CHANGED: {
#if defined(XP_WIN)
if (!StaticPrefs::accessibility_cache_enabled_AtStartup()) {
// On Windows, when the cache is disabled, we have to defer events
// until we are notified that the DocAccessibleParent has been
// constructed, which needs specific code for each event payload.
// Since we don't need a special event payload for text selection in
// this case anyway, just send it as a generic event.
ipcDoc->SendEvent(id, aEvent->GetEventType());
break;
}
#endif // defined(XP_WIN)
AccTextSelChangeEvent* textSelChangeEvent = downcast_accEvent(aEvent);
AutoTArray<TextRange, 1> ranges;
textSelChangeEvent->SelectionRanges(&ranges);
nsTArray<TextRangeData> textRangeData(ranges.Length());
for (size_t i = 0; i < ranges.Length(); i++) {
const TextRange& range = ranges.ElementAt(i);
LocalAccessible* start = range.StartContainer()->AsLocal();
LocalAccessible* end = range.EndContainer()->AsLocal();
textRangeData.AppendElement(TextRangeData(start->ID(), end->ID(),
range.StartOffset(),
range.EndOffset()));
}
ipcDoc->SendTextSelectionChangeEvent(id, textRangeData);
break;
}
case nsIAccessibleEvent::EVENT_DESCRIPTION_CHANGE:
case nsIAccessibleEvent::EVENT_NAME_CHANGE: {
SendCache(CacheDomain::NameAndDescription, CacheUpdateType::Update);
ipcDoc->SendEvent(id, aEvent->GetEventType());
break;
}
case nsIAccessibleEvent::EVENT_TEXT_VALUE_CHANGE:
case nsIAccessibleEvent::EVENT_VALUE_CHANGE: {
SendCache(CacheDomain::Value, CacheUpdateType::Update);
ipcDoc->SendEvent(id, aEvent->GetEventType());
break;
}
default:
ipcDoc->SendEvent(id, aEvent->GetEventType());
}
}
}
if (nsCoreUtils::AccEventObserversExist()) {
nsCoreUtils::DispatchAccEvent(MakeXPCEvent(aEvent));
}
return NS_OK;
}
already_AddRefed<AccAttributes> LocalAccessible::Attributes() {
RefPtr<AccAttributes> attributes = NativeAttributes();
if (!HasOwnContent() || !mContent->IsElement()) return attributes.forget();
// 'xml-roles' attribute coming from ARIA.
nsString xmlRoles;
if (nsAccUtils::GetARIAAttr(mContent->AsElement(), nsGkAtoms::role,
xmlRoles) &&
!xmlRoles.IsEmpty()) {
attributes->SetAttribute(nsGkAtoms::xmlroles, std::move(xmlRoles));
} else if (nsAtom* landmark = LandmarkRole()) {
// 'xml-roles' attribute for landmark.
attributes->SetAttribute(nsGkAtoms::xmlroles, landmark);
}
// Expose object attributes from ARIA attributes.
aria::AttrIterator attribIter(mContent);
while (attribIter.Next()) {
attribIter.ExposeAttr(attributes);
}
// If there is no aria-live attribute then expose default value of 'live'
// object attribute used for ARIA role of this accessible.
const nsRoleMapEntry* roleMapEntry = ARIARoleMap();
if (roleMapEntry) {
if (roleMapEntry->Is(nsGkAtoms::searchbox)) {
attributes->SetAttribute(nsGkAtoms::textInputType, nsGkAtoms::search);
}
if (!attributes->HasAttribute(nsGkAtoms::aria_live)) {
nsString live;
if (nsAccUtils::GetLiveAttrValue(roleMapEntry->liveAttRule, live)) {
attributes->SetAttribute(nsGkAtoms::aria_live, std::move(live));
}
}
}
return attributes.forget();
}
already_AddRefed<AccAttributes> LocalAccessible::NativeAttributes() {
RefPtr<AccAttributes> attributes = new AccAttributes();
// We support values, so expose the string value as well, via the valuetext
// object attribute. We test for the value interface because we don't want
// to expose traditional Value() information such as URL's on links and
// documents, or text in an input.
if (HasNumericValue()) {
nsString valuetext;
Value(valuetext);
attributes->SetAttribute(nsGkAtoms::aria_valuetext, std::move(valuetext));
}
// Expose checkable object attribute if the accessible has checkable state
if (State() & states::CHECKABLE) {
attributes->SetAttribute(nsGkAtoms::checkable, true);
}
// Expose 'explicit-name' attribute.
nsAutoString name;
if (Name(name) != eNameFromSubtree && !name.IsVoid()) {
attributes->SetAttribute(nsGkAtoms::explicit_name, true);
}
// Group attributes (level/setsize/posinset)
GroupPos groupPos = GroupPosition();
nsAccUtils::SetAccGroupAttrs(attributes, groupPos.level, groupPos.setSize,
groupPos.posInSet);
bool hierarchical = false;
uint32_t itemCount = AccGroupInfo::TotalItemCount(this, &hierarchical);
if (itemCount) {
attributes->SetAttribute(nsGkAtoms::child_item_count,
static_cast<int32_t>(itemCount));
}
if (hierarchical) {
attributes->SetAttribute(nsGkAtoms::tree, true);
}
// If the accessible doesn't have own content (such as list item bullet or
// xul tree item) then don't calculate content based attributes.
if (!HasOwnContent()) return attributes.forget();
nsEventShell::GetEventAttributes(GetNode(), attributes);
// Get container-foo computed live region properties based on the closest
// container with the live region attribute. Inner nodes override outer nodes
// within the same document. The inner nodes can be used to override live
// region behavior on more general outer nodes.
nsAccUtils::SetLiveContainerAttributes(attributes, this);
if (!mContent->IsElement()) return attributes.forget();
nsString id;
if (nsCoreUtils::GetID(mContent, id)) {
attributes->SetAttribute(nsGkAtoms::id, std::move(id));
}
// Expose class because it may have useful microformat information.
nsString _class;
if (mContent->AsElement()->GetAttr(kNameSpaceID_None, nsGkAtoms::_class,
_class)) {
attributes->SetAttribute(nsGkAtoms::_class, std::move(_class));
}
// Expose tag.
attributes->SetAttribute(nsGkAtoms::tag, mContent->NodeInfo()->NameAtom());
// Expose draggable object attribute.
if (auto htmlElement = nsGenericHTMLElement::FromNode(mContent)) {
if (htmlElement->Draggable()) {
attributes->SetAttribute(nsGkAtoms::draggable, true);
}
}
// Don't calculate CSS-based object attributes when:
// 1. There is no frame (e.g. the accessible is unattached from the tree).
// 2. This is an image map area. CSS is irrelevant here. Furthermore, we won't
// be able to get the computed style if the map is unslotted in a shadow host.
if (!mContent->GetPrimaryFrame() ||
mContent->IsHTMLElement(nsGkAtoms::area)) {
return attributes.forget();
}
// CSS style based object attributes.
nsAutoString value;
StyleInfo styleInfo(mContent->AsElement());
// Expose 'display' attribute.
RefPtr<nsAtom> displayValue = styleInfo.Display();
attributes->SetAttribute(nsGkAtoms::display, displayValue);
// Expose 'text-align' attribute.
RefPtr<nsAtom> textAlignValue = styleInfo.TextAlign();
attributes->SetAttribute(nsGkAtoms::textAlign, textAlignValue);
// Expose 'text-indent' attribute.
mozilla::LengthPercentage textIndent = styleInfo.TextIndent();
if (textIndent.ConvertsToLength()) {
attributes->SetAttribute(nsGkAtoms::textIndent,
textIndent.ToLengthInCSSPixels());
} else if (textIndent.ConvertsToPercentage()) {
attributes->SetAttribute(nsGkAtoms::textIndent, textIndent.ToPercentage());
}
// Expose 'margin-left' attribute.
attributes->SetAttribute(nsGkAtoms::marginLeft, styleInfo.MarginLeft());
// Expose 'margin-right' attribute.
attributes->SetAttribute(nsGkAtoms::marginRight, styleInfo.MarginRight());
// Expose 'margin-top' attribute.
attributes->SetAttribute(nsGkAtoms::marginTop, styleInfo.MarginTop());
// Expose 'margin-bottom' attribute.
attributes->SetAttribute(nsGkAtoms::marginBottom, styleInfo.MarginBottom());
// Expose data-at-shortcutkeys attribute for web applications and virtual
// cursors. Currently mostly used by JAWS.
nsString atShortcutKeys;
if (mContent->AsElement()->GetAttr(
kNameSpaceID_None, nsGkAtoms::dataAtShortcutkeys, atShortcutKeys)) {
attributes->SetAttribute(nsGkAtoms::dataAtShortcutkeys,
std::move(atShortcutKeys));
}
return attributes.forget();
}
bool LocalAccessible::AttributeChangesState(nsAtom* aAttribute) {
return aAttribute == nsGkAtoms::aria_disabled ||
aAttribute == nsGkAtoms::disabled ||
aAttribute == nsGkAtoms::tabindex ||
aAttribute == nsGkAtoms::aria_required ||
aAttribute == nsGkAtoms::aria_invalid ||
aAttribute == nsGkAtoms::aria_expanded ||
aAttribute == nsGkAtoms::aria_checked ||
(aAttribute == nsGkAtoms::aria_pressed && IsButton()) ||
aAttribute == nsGkAtoms::aria_readonly ||
aAttribute == nsGkAtoms::aria_current ||
aAttribute == nsGkAtoms::aria_haspopup ||
aAttribute == nsGkAtoms::aria_busy ||
aAttribute == nsGkAtoms::aria_multiline ||
aAttribute == nsGkAtoms::aria_multiselectable ||
aAttribute == nsGkAtoms::contenteditable;
}
void LocalAccessible::DOMAttributeChanged(int32_t aNameSpaceID,
nsAtom* aAttribute, int32_t aModType,
const nsAttrValue* aOldValue,
uint64_t aOldState) {
// Fire accessible event after short timer, because we need to wait for
// DOM attribute & resulting layout to actually change. Otherwise,
// assistive technology will retrieve the wrong state/value/selection info.
// XXX todo
// We still need to handle special HTML cases here
// For example, if an <img>'s usemap attribute is modified
// Otherwise it may just be a state change, for example an object changing
// its visibility
//
// XXX todo: report aria state changes for "undefined" literal value changes
// filed as bug 472142
//
// XXX todo: invalidate accessible when aria state changes affect exposed
// role filed as bug 472143
if (AttributeChangesState(aAttribute)) {
uint64_t currState = State();
uint64_t diffState = currState ^ aOldState;
if (diffState) {
for (uint64_t state = 1; state <= states::LAST_ENTRY; state <<= 1) {
if (diffState & state) {
RefPtr<AccEvent> stateChangeEvent =
new AccStateChangeEvent(this, state, (currState & state));
mDoc->FireDelayedEvent(stateChangeEvent);
}
}
}
}
// When a details object has its open attribute changed
// we should fire a state-change event on the accessible of
// its main summary
if (aAttribute == nsGkAtoms::open) {
// FromDetails checks if the given accessible belongs to
// a details frame and also locates the accessible of its
// main summary.
if (HTMLSummaryAccessible* summaryAccessible =
HTMLSummaryAccessible::FromDetails(this)) {
RefPtr<AccEvent> expandedChangeEvent =
new AccStateChangeEvent(summaryAccessible, states::EXPANDED);
mDoc->FireDelayedEvent(expandedChangeEvent);
return;
}
}
// Check for namespaced ARIA attribute
if (aNameSpaceID == kNameSpaceID_None) {
// Check for hyphenated aria-foo property?
if (StringBeginsWith(nsDependentAtomString(aAttribute), u"aria-"_ns)) {
uint8_t attrFlags = aria::AttrCharacteristicsFor(aAttribute);
if (!(attrFlags & ATTR_BYPASSOBJ)) {
mDoc->QueueCacheUpdate(this, CacheDomain::ARIA);
// For aria attributes like drag and drop changes we fire a generic
// attribute change event; at least until native API comes up with a
// more meaningful event.
RefPtr<AccEvent> event =
new AccObjectAttrChangedEvent(this, aAttribute);
mDoc->FireDelayedEvent(event);
}
}
}
dom::Element* elm = Elm();
if (HasNumericValue() &&
(aAttribute == nsGkAtoms::aria_valuemax ||
aAttribute == nsGkAtoms::aria_valuemin || aAttribute == nsGkAtoms::min ||
aAttribute == nsGkAtoms::max || aAttribute == nsGkAtoms::step)) {
SendCache(CacheDomain::Value, CacheUpdateType::Update);
return;
}
// Fire text value change event whenever aria-valuetext is changed.
if (aAttribute == nsGkAtoms::aria_valuetext) {
mDoc->FireDelayedEvent(nsIAccessibleEvent::EVENT_TEXT_VALUE_CHANGE, this);
return;
}
if (aAttribute == nsGkAtoms::aria_valuenow) {
if (!nsAccUtils::HasARIAAttr(elm, nsGkAtoms::aria_valuetext) ||
nsAccUtils::ARIAAttrValueIs(elm, nsGkAtoms::aria_valuetext,
nsGkAtoms::_empty, eCaseMatters)) {
// Fire numeric value change event when aria-valuenow is changed and
// aria-valuetext is empty
mDoc->FireDelayedEvent(nsIAccessibleEvent::EVENT_VALUE_CHANGE, this);
} else {
// We need to update the cache here since we won't get an event if
// aria-valuenow is shadowed by aria-valuetext.
SendCache(CacheDomain::Value, CacheUpdateType::Update);
}
return;
}
if (aAttribute == nsGkAtoms::aria_owns) {
mDoc->Controller()->ScheduleRelocation(this);
}
// Fire name change and description change events.
if (aAttribute == nsGkAtoms::aria_label) {
// A valid aria-labelledby would take precedence so an aria-label change
// won't change the name.
IDRefsIterator iter(mDoc, elm, nsGkAtoms::aria_labelledby);
if (!iter.NextElem()) {
mDoc->FireDelayedEvent(nsIAccessibleEvent::EVENT_NAME_CHANGE, this);
}
return;
}
if (aAttribute == nsGkAtoms::aria_describedby) {
mDoc->QueueCacheUpdate(this, CacheDomain::Relations);
mDoc->FireDelayedEvent(nsIAccessibleEvent::EVENT_DESCRIPTION_CHANGE, this);
if (aModType == dom::MutationEvent_Binding::MODIFICATION ||
aModType == dom::MutationEvent_Binding::ADDITION) {
// The subtrees of the new aria-describedby targets might be used to
// compute the description for this. Therefore, we need to set
// the eHasDescriptionDependent flag on all Accessibles in these subtrees.
IDRefsIterator iter(mDoc, elm, nsGkAtoms::aria_describedby);
while (LocalAccessible* target = iter.Next()) {
target->ModifySubtreeContextFlags(eHasDescriptionDependent, true);
}
}
return;
}
if (aAttribute == nsGkAtoms::aria_labelledby) {
// We only queue cache updates for explicit relations. Implicit, reverse
// relations are handled in ApplyCache and stored in a map on the remote
// document itself.
mDoc->QueueCacheUpdate(this, CacheDomain::Relations);
mDoc->FireDelayedEvent(nsIAccessibleEvent::EVENT_NAME_CHANGE, this);
if (aModType == dom::MutationEvent_Binding::MODIFICATION ||
aModType == dom::MutationEvent_Binding::ADDITION) {
// The subtrees of the new aria-labelledby targets might be used to
// compute the name for this. Therefore, we need to set
// the eHasNameDependent flag on all Accessibles in these subtrees.
IDRefsIterator iter(mDoc, elm, nsGkAtoms::aria_labelledby);
while (LocalAccessible* target = iter.Next()) {
target->ModifySubtreeContextFlags(eHasNameDependent, true);
}
}
return;
}
if ((aAttribute == nsGkAtoms::aria_expanded ||
aAttribute == nsGkAtoms::href) &&
(aModType == dom::MutationEvent_Binding::ADDITION ||
aModType == dom::MutationEvent_Binding::REMOVAL)) {
// The presence of aria-expanded adds an expand/collapse action.
SendCache(CacheDomain::Actions, CacheUpdateType::Update);
}
if (aAttribute == nsGkAtoms::href) {
mDoc->QueueCacheUpdate(this, CacheDomain::Value);
}
if (aAttribute == nsGkAtoms::aria_controls ||
aAttribute == nsGkAtoms::aria_flowto) {
mDoc->QueueCacheUpdate(this, CacheDomain::Relations);
}
if (aAttribute == nsGkAtoms::alt &&
!nsAccUtils::HasARIAAttr(elm, nsGkAtoms::aria_label) &&
!elm->HasAttr(nsGkAtoms::aria_labelledby)) {
mDoc->FireDelayedEvent(nsIAccessibleEvent::EVENT_NAME_CHANGE, this);
return;
}
if (aAttribute == nsGkAtoms::title) {
nsAutoString name;
ARIAName(name);
if (name.IsEmpty()) {
NativeName(name);
if (name.IsEmpty()) {
mDoc->FireDelayedEvent(nsIAccessibleEvent::EVENT_NAME_CHANGE, this);
return;
}
}
if (!elm->HasAttr(nsGkAtoms::aria_describedby)) {
mDoc->FireDelayedEvent(nsIAccessibleEvent::EVENT_DESCRIPTION_CHANGE,
this);
}
return;
}
// ARIA or XUL selection
if ((mContent->IsXULElement() && aAttribute == nsGkAtoms::selected) ||
aAttribute == nsGkAtoms::aria_selected) {
LocalAccessible* widget = nsAccUtils::GetSelectableContainer(this, State());
if (widget) {
AccSelChangeEvent::SelChangeType selChangeType;
if (aNameSpaceID != kNameSpaceID_None) {
selChangeType = elm->AttrValueIs(aNameSpaceID, aAttribute,
nsGkAtoms::_true, eCaseMatters)
? AccSelChangeEvent::eSelectionAdd
: AccSelChangeEvent::eSelectionRemove;
} else {
selChangeType = nsAccUtils::ARIAAttrValueIs(
elm, aAttribute, nsGkAtoms::_true, eCaseMatters)
? AccSelChangeEvent::eSelectionAdd
: AccSelChangeEvent::eSelectionRemove;
}
RefPtr<AccEvent> event =
new AccSelChangeEvent(widget, this, selChangeType);
mDoc->FireDelayedEvent(event);
if (aAttribute == nsGkAtoms::aria_selected) {
mDoc->QueueCacheUpdate(this, CacheDomain::State);
}
}
return;
}
if (aAttribute == nsGkAtoms::aria_level ||
aAttribute == nsGkAtoms::aria_setsize ||
aAttribute == nsGkAtoms::aria_posinset) {
SendCache(CacheDomain::GroupInfo, CacheUpdateType::Update);
return;
}
if (aAttribute == nsGkAtoms::accesskey) {
mDoc->QueueCacheUpdate(this, CacheDomain::Actions);
}
if (aAttribute == nsGkAtoms::name &&
(mContent && mContent->IsHTMLElement(nsGkAtoms::a))) {
// If an anchor's name changed, it's possible a LINKS_TO relation
// also changed. Push a cache update for Relations.
mDoc->QueueCacheUpdate(this, CacheDomain::Relations);
}
if (aAttribute == nsGkAtoms::slot &&
!mContent->GetFlattenedTreeParentNode() && this != mDoc) {
// This is inside a shadow host but is no longer slotted.
mDoc->ContentRemoved(this);
}
}
void LocalAccessible::ARIAGroupPosition(int32_t* aLevel, int32_t* aSetSize,
int32_t* aPosInSet) const {
if (!mContent) {
return;
}
if (aLevel) {
nsCoreUtils::GetUIntAttr(mContent, nsGkAtoms::aria_level, aLevel);
}
if (aSetSize) {
nsCoreUtils::GetUIntAttr(mContent, nsGkAtoms::aria_setsize, aSetSize);
}
if (aPosInSet) {
nsCoreUtils::GetUIntAttr(mContent, nsGkAtoms::aria_posinset, aPosInSet);
}
}
uint64_t LocalAccessible::State() {
if (IsDefunct()) return states::DEFUNCT;
uint64_t state = NativeState();
// Apply ARIA states to be sure accessible states will be overridden.
ApplyARIAState(&state);
const uint32_t kExpandCollapseStates = states::COLLAPSED | states::EXPANDED;
if ((state & kExpandCollapseStates) == kExpandCollapseStates) {
// Cannot be both expanded and collapsed -- this happens in ARIA expanded
// combobox because of limitation of ARIAMap.
// XXX: Perhaps we will be able to make this less hacky if we support
// extended states in ARIAMap, e.g. derive COLLAPSED from
// EXPANDABLE && !EXPANDED.
state &= ~states::COLLAPSED;
}
if (!(state & states::UNAVAILABLE)) {
state |= states::ENABLED | states::SENSITIVE;
// If the object is a current item of container widget then mark it as
// ACTIVE. This allows screen reader virtual buffer modes to know which
// descendant is the current one that would get focus if the user navigates
// to the container widget.
LocalAccessible* widget = ContainerWidget();
if (widget && widget->CurrentItem() == this) state |= states::ACTIVE;
}
if ((state & states::COLLAPSED) || (state & states::EXPANDED)) {
state |= states::EXPANDABLE;
}
ApplyImplicitState(state);
return state;
}
void LocalAccessible::ApplyARIAState(uint64_t* aState) const {
if (!mContent->IsElement()) return;
dom::Element* element = mContent->AsElement();
// Test for universal states first
*aState |= aria::UniversalStatesFor(element);
const nsRoleMapEntry* roleMapEntry = ARIARoleMap();
if (roleMapEntry) {
// We only force the readonly bit off if we have a real mapping for the aria
// role. This preserves the ability for screen readers to use readonly
// (primarily on the document) as the hint for creating a virtual buffer.
if (roleMapEntry->role != roles::NOTHING) *aState &= ~states::READONLY;
if (mContent->HasID()) {
// If has a role & ID and aria-activedescendant on the container, assume
// focusable.
const LocalAccessible* ancestor = this;
while ((ancestor = ancestor->LocalParent()) && !ancestor->IsDoc()) {
dom::Element* el = ancestor->Elm();
if (el && el->HasAttr(nsGkAtoms::aria_activedescendant)) {
*aState |= states::FOCUSABLE;
break;
}
}
}
}
if (*aState & states::FOCUSABLE) {
// Propogate aria-disabled from ancestors down to any focusable descendant.
const LocalAccessible* ancestor = this;
while ((ancestor = ancestor->LocalParent()) && !ancestor->IsDoc()) {
dom::Element* el = ancestor->Elm();
if (el && nsAccUtils::ARIAAttrValueIs(el, nsGkAtoms::aria_disabled,
nsGkAtoms::_true, eCaseMatters)) {
*aState |= states::UNAVAILABLE;
break;
}
}
} else {
// Sometimes, we use aria-activedescendant targeting something which isn't
// actually a descendant. This is technically a spec violation, but it's a
// useful hack which makes certain things much easier. For example, we use
// this for "fake focus" for multi select browser tabs and Quantumbar
// autocomplete suggestions.
// In these cases, the aria-activedescendant code above won't make the
// active item focusable. It doesn't make sense for something to have
// focus when it isn't focusable, so fix that here.
if (FocusMgr()->IsActiveItem(this)) {
*aState |= states::FOCUSABLE;
}
}
// special case: A native button element whose role got transformed by ARIA to
// a toggle button Also applies to togglable button menus, like in the Dev
// Tools Web Console.
if (IsButton() || IsMenuButton()) {
aria::MapToState(aria::eARIAPressed, element, aState);
}
if (!roleMapEntry) return;
*aState |= roleMapEntry->state;
if (aria::MapToState(roleMapEntry->attributeMap1, element, aState) &&
aria::MapToState(roleMapEntry->attributeMap2, element, aState) &&
aria::MapToState(roleMapEntry->attributeMap3, element, aState)) {
aria::MapToState(roleMapEntry->attributeMap4, element, aState);
}
// ARIA gridcell inherits readonly state from the grid until it's overridden.
if ((roleMapEntry->Is(nsGkAtoms::gridcell) ||
roleMapEntry->Is(nsGkAtoms::columnheader) ||
roleMapEntry->Is(nsGkAtoms::rowheader)) &&
!nsAccUtils::HasDefinedARIAToken(mContent, nsGkAtoms::aria_readonly)) {
const TableCellAccessible* cell = AsTableCell();
if (cell) {
TableAccessible* table = cell->Table();
if (table) {
LocalAccessible* grid = table->AsAccessible();
uint64_t gridState = 0;
grid->ApplyARIAState(&gridState);
*aState |= gridState & states::READONLY;
}
}
}
}
void LocalAccessible::Value(nsString& aValue) const {
if (HasNumericValue()) {
// aria-valuenow is a number, and aria-valuetext is the optional text
// equivalent. For the string value, we will try the optional text
// equivalent first.
if (!mContent->IsElement()) {
return;
}
if (!nsAccUtils::GetARIAAttr(mContent->AsElement(),
nsGkAtoms::aria_valuetext, aValue)) {
if (!NativeHasNumericValue()) {
double checkValue = CurValue();
if (!IsNaN(checkValue)) {
aValue.AppendFloat(checkValue);
}
}
}
return;
}
const nsRoleMapEntry* roleMapEntry = ARIARoleMap();
if (!roleMapEntry) {
return;
}
// Value of textbox is a textified subtree.
if (roleMapEntry->Is(nsGkAtoms::textbox)) {
nsTextEquivUtils::GetTextEquivFromSubtree(this, aValue);
return;
}
// Value of combobox is a text of current or selected item.
if (roleMapEntry->Is(nsGkAtoms::combobox)) {
LocalAccessible* option = CurrentItem();
if (!option) {
uint32_t childCount = ChildCount();
for (uint32_t idx = 0; idx < childCount; idx++) {
LocalAccessible* child = mChildren.ElementAt(idx);
if (child->IsListControl()) {
Accessible* acc = child->GetSelectedItem(0);
option = acc ? acc->AsLocal() : nullptr;
break;
}
}
}
// If there's a selected item, get the value from it. Otherwise, determine
// the value from descendant elements.
nsTextEquivUtils::GetTextEquivFromSubtree(option ? option : this, aValue);
}
}
double LocalAccessible::MaxValue() const {
double checkValue = AttrNumericValue(nsGkAtoms::aria_valuemax);
if (IsNaN(checkValue) && !NativeHasNumericValue()) {
// aria-valuemax isn't present and this element doesn't natively provide a
// maximum value. Use the ARIA default.
const nsRoleMapEntry* roleMap = ARIARoleMap();
if (roleMap && roleMap->role == roles::SPINBUTTON) {
return UnspecifiedNaN<double>();
}
return 100;
}
return checkValue;
}
double LocalAccessible::MinValue() const {
double checkValue = AttrNumericValue(nsGkAtoms::aria_valuemin);
if (IsNaN(checkValue) && !NativeHasNumericValue()) {
// aria-valuemin isn't present and this element doesn't natively provide a
// minimum value. Use the ARIA default.
const nsRoleMapEntry* roleMap = ARIARoleMap();
if (roleMap && roleMap->role == roles::SPINBUTTON) {
return UnspecifiedNaN<double>();
}
return 0;
}
return checkValue;
}
double LocalAccessible::Step() const {
return UnspecifiedNaN<double>(); // no mimimum increment (step) in ARIA.
}
double LocalAccessible::CurValue() const {
double checkValue = AttrNumericValue(nsGkAtoms::aria_valuenow);
if (IsNaN(checkValue) && !NativeHasNumericValue()) {
// aria-valuenow isn't present and this element doesn't natively provide a
// current value. Use the ARIA default.
const nsRoleMapEntry* roleMap = ARIARoleMap();
if (roleMap && roleMap->role == roles::SPINBUTTON) {
return UnspecifiedNaN<double>();
}
double minValue = MinValue();
return minValue + ((MaxValue() - minValue) / 2);
}
return checkValue;
}
bool LocalAccessible::SetCurValue(double aValue) {
const nsRoleMapEntry* roleMapEntry = ARIARoleMap();
if (!roleMapEntry || roleMapEntry->valueRule == eNoValue) return false;
const uint32_t kValueCannotChange = states::READONLY | states::UNAVAILABLE;
if (State() & kValueCannotChange) return false;
double checkValue = MinValue();
if (!IsNaN(checkValue) && aValue < checkValue) return false;
checkValue = MaxValue();
if (!IsNaN(checkValue) && aValue > checkValue) return false;
nsAutoString strValue;
strValue.AppendFloat(aValue);
if (!mContent->IsElement()) return true;
return NS_SUCCEEDED(mContent->AsElement()->SetAttr(
kNameSpaceID_None, nsGkAtoms::aria_valuenow, strValue, true));
}
role LocalAccessible::ARIATransformRole(role aRole) const {
// Beginning with ARIA 1.1, user agents are expected to use the native host
// language role of the element when the region role is used without a name.
// https://rawgit.com/w3c/aria/master/core-aam/core-aam.html#role-map-region
//
// XXX: While the name computation algorithm can be non-trivial in the general
// case, it should not be especially bad here: If the author hasn't used the
// region role, this calculation won't occur. And the region role's name
// calculation rule excludes name from content. That said, this use case is
// another example of why we should consider caching the accessible name. See:
// https://bugzilla.mozilla.org/show_bug.cgi?id=1378235.
if (aRole == roles::REGION) {
nsAutoString name;
Name(name);
return name.IsEmpty() ? NativeRole() : aRole;
}
// XXX: these unfortunate exceptions don't fit into the ARIA table. This is
// where the accessible role depends on both the role and ARIA state.
if (aRole == roles::PUSHBUTTON) {
if (nsAccUtils::HasDefinedARIAToken(mContent, nsGkAtoms::aria_pressed)) {
// For simplicity, any existing pressed attribute except "" or "undefined"
// indicates a toggle.
return roles::TOGGLE_BUTTON;
}
if (mContent->IsElement() &&
nsAccUtils::ARIAAttrValueIs(mContent->AsElement(),
nsGkAtoms::aria_haspopup, nsGkAtoms::_true,
eCaseMatters)) {
// For button with aria-haspopup="true".
return roles::BUTTONMENU;
}
} else if (aRole == roles::LISTBOX) {
// A listbox inside of a combobox needs a special role because of ATK
// mapping to menu.
if (mParent && mParent->IsCombobox()) {
return roles::COMBOBOX_LIST;
}
} else if (aRole == roles::OPTION) {
if (mParent && mParent->Role() == roles::COMBOBOX_LIST) {
return roles::COMBOBOX_OPTION;
}
} else if (aRole == roles::MENUITEM) {
// Menuitem has a submenu.
if (mContent->IsElement() &&
nsAccUtils::ARIAAttrValueIs(mContent->AsElement(),
nsGkAtoms::aria_haspopup, nsGkAtoms::_true,
eCaseMatters)) {
return roles::PARENT_MENUITEM;
}
} else if (aRole == roles::CELL) {
// A cell inside an ancestor table element that has a grid role needs a
// gridcell role
// (https://www.w3.org/TR/html-aam-1.0/#html-element-role-mappings).
const TableCellAccessible* cell = AsTableCell();
if (cell) {
TableAccessible* table = cell->Table();
if (table && table->AsAccessible()->IsARIARole(nsGkAtoms::grid)) {
return roles::GRID_CELL;
}
}
}
return aRole;
}
role LocalAccessible::NativeRole() const { return roles::NOTHING; }
uint8_t LocalAccessible::ActionCount() const {
return HasPrimaryAction() || ActionAncestor() ? 1 : 0;
}
void LocalAccessible::ActionNameAt(uint8_t aIndex, nsAString& aName) {
aName.Truncate();
if (aIndex != 0) return;
uint32_t actionRule = GetActionRule();
switch (actionRule) {
case eActivateAction:
aName.AssignLiteral("activate");
return;
case eClickAction:
aName.AssignLiteral("click");
return;
case ePressAction:
aName.AssignLiteral("press");
return;
case eCheckUncheckAction: {
uint64_t state = State();
if (state & states::CHECKED) {
aName.AssignLiteral("uncheck");
} else if (state & states::MIXED) {
aName.AssignLiteral("cycle");
} else {
aName.AssignLiteral("check");
}
return;
}
case eJumpAction:
aName.AssignLiteral("jump");
return;
case eOpenCloseAction:
if (State() & states::COLLAPSED) {
aName.AssignLiteral("open");
} else {
aName.AssignLiteral("close");
}
return;
case eSelectAction:
aName.AssignLiteral("select");
return;
case eSwitchAction:
aName.AssignLiteral("switch");
return;
case eSortAction:
aName.AssignLiteral("sort");
return;
case eExpandAction:
if (State() & states::COLLAPSED) {
aName.AssignLiteral("expand");
} else {
aName.AssignLiteral("collapse");
}
return;
}
if (ActionAncestor()) {
aName.AssignLiteral("click ancestor");
return;
}
}
bool LocalAccessible::DoAction(uint8_t aIndex) const {
if (aIndex != 0) return false;
if (HasPrimaryAction() || ActionAncestor()) {
DoCommand();
return true;
}
return false;
}
bool LocalAccessible::HasPrimaryAction() const {
return GetActionRule() != eNoAction;
}
nsIContent* LocalAccessible::GetAtomicRegion() const {
nsIContent* loopContent = mContent;
nsAutoString atomic;
while (loopContent &&
(!loopContent->IsElement() ||
!nsAccUtils::GetARIAAttr(loopContent->AsElement(),
nsGkAtoms::aria_atomic, atomic))) {
loopContent = loopContent->GetParent();
}
return atomic.EqualsLiteral("true") ? loopContent : nullptr;
}
Relation LocalAccessible::RelationByType(RelationType aType) const {
if (!HasOwnContent()) return Relation();
const nsRoleMapEntry* roleMapEntry = ARIARoleMap();
// Relationships are defined on the same content node that the role would be
// defined on.
switch (aType) {
case RelationType::LABELLED_BY: {
Relation rel(
new IDRefsIterator(mDoc, mContent, nsGkAtoms::aria_labelledby));
if (mContent->IsHTMLElement()) {
rel.AppendIter(new HTMLLabelIterator(Document(), this));
}
rel.AppendIter(new XULLabelIterator(Document(), mContent));
return rel;
}
case RelationType::LABEL_FOR: {
Relation rel(new RelatedAccIterator(Document(), mContent,
nsGkAtoms::aria_labelledby));
if (mContent->IsXULElement(nsGkAtoms::label)) {
rel.AppendIter(new IDRefsIterator(mDoc, mContent, nsGkAtoms::control));
}
return rel;
}
case RelationType::DESCRIBED_BY: {
Relation rel(
new IDRefsIterator(mDoc, mContent, nsGkAtoms::aria_describedby));
if (mContent->IsXULElement()) {
rel.AppendIter(new XULDescriptionIterator(Document(), mContent));
}
return rel;
}
case RelationType::DESCRIPTION_FOR: {
Relation rel(new RelatedAccIterator(Document(), mContent,
nsGkAtoms::aria_describedby));
// This affectively adds an optional control attribute to xul:description,
// which only affects accessibility, by allowing the description to be
// tied to a control.
if (mContent->IsXULElement(nsGkAtoms::description)) {
rel.AppendIter(new IDRefsIterator(mDoc, mContent, nsGkAtoms::control));
}
return rel;
}
case RelationType::NODE_CHILD_OF: {
Relation rel;
// This is an ARIA tree or treegrid that doesn't use owns, so we need to
// get the parent the hard way.
if (roleMapEntry && (roleMapEntry->role == roles::OUTLINEITEM ||
roleMapEntry->role == roles::LISTITEM ||
roleMapEntry->role == roles::ROW)) {
Accessible* parent = const_cast<LocalAccessible*>(this)
->GetOrCreateGroupInfo()
->ConceptualParent();
if (parent) {
MOZ_ASSERT(parent->IsLocal());
rel.AppendTarget(parent->AsLocal());
}
}
// If this is an OOP iframe document, we can't support NODE_CHILD_OF
// here, since the iframe resides in a different process. This is fine
// because the client will then request the parent instead, which will be
// correctly handled by platform code.
if (XRE_IsContentProcess() && IsRoot()) {
dom::Document* doc =
const_cast<LocalAccessible*>(this)->AsDoc()->DocumentNode();
dom::BrowsingContext* bc = doc->GetBrowsingContext();
MOZ_ASSERT(bc);
if (!bc->Top()->IsInProcess()) {
return rel;
}
}
// If accessible is in its own Window, or is the root of a document,
// then we should provide NODE_CHILD_OF relation so that MSAA clients
// can easily get to true parent instead of getting to oleacc's
// ROLE_WINDOW accessible which will prevent us from going up further
// (because it is system generated and has no idea about the hierarchy
// above it).
nsIFrame* frame = GetFrame();
if (frame) {
nsView* view = frame->GetView();
if (view) {
nsIScrollableFrame* scrollFrame = do_QueryFrame(frame);
if (scrollFrame || view->GetWidget() || !frame->GetParent()) {
rel.AppendTarget(LocalParent());
}
}
}
return rel;
}
case RelationType::NODE_PARENT_OF: {
// ARIA tree or treegrid can do the hierarchy by @aria-level, ARIA trees
// also can be organized by groups.
if (roleMapEntry && (roleMapEntry->role == roles::OUTLINEITEM ||
roleMapEntry->role == roles::LISTITEM ||
roleMapEntry->role == roles::ROW ||
roleMapEntry->role == roles::OUTLINE ||
roleMapEntry->role == roles::LIST ||
roleMapEntry->role == roles::TREE_TABLE)) {
return Relation(new ItemIterator(this));
}
return Relation();
}
case RelationType::CONTROLLED_BY:
return Relation(new RelatedAccIterator(Document(), mContent,
nsGkAtoms::aria_controls));
case RelationType::CONTROLLER_FOR: {
Relation rel(
new IDRefsIterator(mDoc, mContent, nsGkAtoms::aria_controls));
rel.AppendIter(new HTMLOutputIterator(Document(), mContent));
return rel;
}
case RelationType::FLOWS_TO:
return Relation(
new IDRefsIterator(mDoc, mContent, nsGkAtoms::aria_flowto));
case RelationType::FLOWS_FROM:
return Relation(
new RelatedAccIterator(Document(), mContent, nsGkAtoms::aria_flowto));
case RelationType::MEMBER_OF: {
if (Role() == roles::RADIOBUTTON) {
/* If we see a radio button role here, we're dealing with an aria
* radio button (because input=radio buttons are
* HTMLRadioButtonAccessibles) */
Relation rel = Relation();
LocalAccessible* currParent = LocalParent();
while (currParent && currParent->Role() != roles::RADIO_GROUP) {
currParent = currParent->LocalParent();
}
if (currParent && currParent->Role() == roles::RADIO_GROUP) {
/* If we found a radiogroup parent, search for all
* roles::RADIOBUTTON children and add them to our relation.
* This search will include the radio button this method
* was called from, which is expected. */
Pivot p = Pivot(currParent);
PivotRoleRule rule(roles::RADIOBUTTON);
Accessible* match = p.Next(currParent, rule);
while (match) {
MOZ_ASSERT(match->IsLocal(),
"We shouldn't find any remote accs while building our "
"relation!");
rel.AppendTarget(match->AsLocal());
match = p.Next(match, rule);
}
}
/* By webkit's standard, aria radio buttons do not get grouped
* if they lack a group parent, so we return an empty
* relation here if the above check fails. */
return rel;
}
return Relation(mDoc, GetAtomicRegion());
}
case RelationType::LINKS_TO: {
Relation rel = Relation();
if (Role() == roles::LINK) {
dom::HTMLAnchorElement* anchor =
dom::HTMLAnchorElement::FromNode(mContent);
if (!anchor) {
return rel;
}
// If this node is an anchor element, query its hash to find the
// target.
nsAutoString hash;
anchor->GetHash(hash);
if (hash.IsEmpty()) {
return rel;
}
// GetHash returns an ID or name with a leading '#', trim it so we can
// search the doc by ID or name alone.
hash.Trim("#");
if (dom::Element* elm = mContent->OwnerDoc()->GetElementById(hash)) {
rel.AppendTarget(mDoc->GetAccessibleOrContainer(elm));
} else if (nsCOMPtr<nsINodeList> list =
mContent->OwnerDoc()->GetElementsByName(hash)) {
// Loop through the named nodes looking for the first anchor
uint32_t length = list->Length();
for (uint32_t i = 0; i < length; i++) {
nsIContent* node = list->Item(i);
if (node->IsHTMLElement(nsGkAtoms::a)) {
rel.AppendTarget(mDoc->GetAccessibleOrContainer(node));
break;
}
}
}
}
return rel;
}
case RelationType::SUBWINDOW_OF:
case RelationType::EMBEDS:
case RelationType::EMBEDDED_BY:
case RelationType::POPUP_FOR:
case RelationType::PARENT_WINDOW_OF:
return Relation();
case RelationType::DEFAULT_BUTTON: {
if (mContent->IsHTMLElement()) {
// HTML form controls implements nsIFormControl interface.
nsCOMPtr<nsIFormControl> control(do_QueryInterface(mContent));
if (control) {
if (dom::HTMLFormElement* form = control->GetForm()) {
return Relation(mDoc, form->GetDefaultSubmitElement());
}
}
} else {
// In XUL, use first <button default="true" .../> in the document
dom::Document* doc = mContent->OwnerDoc();
nsIContent* buttonEl = nullptr;
if (doc->AllowXULXBL()) {
nsCOMPtr<nsIHTMLCollection> possibleDefaultButtons =
doc->GetElementsByAttribute(u"default"_ns, u"true"_ns);
if (possibleDefaultButtons) {
uint32_t length = possibleDefaultButtons->Length();
// Check for button in list of default="true" elements
for (uint32_t count = 0; count < length && !buttonEl; count++) {
nsIContent* item = possibleDefaultButtons->Item(count);
RefPtr<nsIDOMXULButtonElement> button =
item->IsElement() ? item->AsElement()->AsXULButton()
: nullptr;
if (button) {
buttonEl = item;
}
}
}
return Relation(mDoc, buttonEl);
}
}
return Relation();
}
case RelationType::CONTAINING_DOCUMENT:
return Relation(mDoc);
case RelationType::CONTAINING_TAB_PANE: {
nsCOMPtr<nsIDocShell> docShell = nsCoreUtils::GetDocShellFor(GetNode());
if (docShell) {
// Walk up the parent chain without crossing the boundary at which item
// types change, preventing us from walking up out of tab content.
nsCOMPtr<nsIDocShellTreeItem> root;
docShell->GetInProcessSameTypeRootTreeItem(getter_AddRefs(root));
if (root) {
// If the item type is typeContent, we assume we are in browser tab
// content. Note, this includes content such as about:addons,
// for consistency.
if (root->ItemType() == nsIDocShellTreeItem::typeContent) {
return Relation(nsAccUtils::GetDocAccessibleFor(root));
}
}
}
return Relation();
}
case RelationType::CONTAINING_APPLICATION:
return Relation(ApplicationAcc());
case RelationType::DETAILS:
return Relation(
new IDRefsIterator(mDoc, mContent, nsGkAtoms::aria_details));
case RelationType::DETAILS_FOR:
return Relation(
new RelatedAccIterator(mDoc, mContent, nsGkAtoms::aria_details));
case RelationType::ERRORMSG:
return Relation(
new IDRefsIterator(mDoc, mContent, nsGkAtoms::aria_errormessage));
case RelationType::ERRORMSG_FOR:
return Relation(
new RelatedAccIterator(mDoc, mContent, nsGkAtoms::aria_errormessage));
default:
return Relation();
}
}
void LocalAccessible::GetNativeInterface(void** aNativeAccessible) {}
void LocalAccessible::DoCommand(nsIContent* aContent,
uint32_t aActionIndex) const {
class Runnable final : public mozilla::Runnable {
public:
Runnable(const LocalAccessible* aAcc, nsIContent* aContent, uint32_t aIdx)
: mozilla::Runnable("Runnable"),
mAcc(aAcc),
mContent(aContent),
mIdx(aIdx) {}
// XXX Cannot mark as MOZ_CAN_RUN_SCRIPT because the base class change
// requires too big changes across a lot of modules.
MOZ_CAN_RUN_SCRIPT_BOUNDARY NS_IMETHOD Run() override {
if (mAcc) {
MOZ_KnownLive(mAcc)->DispatchClickEvent(MOZ_KnownLive(mContent), mIdx);
}
return NS_OK;
}
void Revoke() {
mAcc = nullptr;
mContent = nullptr;
}
private:
RefPtr<const LocalAccessible> mAcc;
nsCOMPtr<nsIContent> mContent;
uint32_t mIdx;
};
nsIContent* content = aContent ? aContent : mContent.get();
nsCOMPtr<nsIRunnable> runnable = new Runnable(this, content, aActionIndex);
NS_DispatchToMainThread(runnable);
}
void LocalAccessible::DispatchClickEvent(nsIContent* aContent,
uint32_t aActionIndex) const {
if (IsDefunct()) return;
RefPtr<PresShell> presShell = mDoc->PresShellPtr();
// Scroll into view.
presShell->ScrollContentIntoView(aContent, ScrollAxis(), ScrollAxis(),
ScrollFlags::ScrollOverflowHidden);
AutoWeakFrame frame = aContent->GetPrimaryFrame();
if (!frame) return;
// Compute x and y coordinates.
nsPoint point;
nsCOMPtr<nsIWidget> widget = frame->GetNearestWidget(point);
if (!widget) return;
nsSize size = frame->GetSize();
RefPtr<nsPresContext> presContext = presShell->GetPresContext();
int32_t x = presContext->AppUnitsToDevPixels(point.x + size.width / 2);
int32_t y = presContext->AppUnitsToDevPixels(point.y + size.height / 2);
// Simulate a touch interaction by dispatching touch events with mouse events.
nsCoreUtils::DispatchTouchEvent(eTouchStart, x, y, aContent, frame, presShell,
widget);
nsCoreUtils::DispatchMouseEvent(eMouseDown, x, y, aContent, frame, presShell,
widget);
nsCoreUtils::DispatchTouchEvent(eTouchEnd, x, y, aContent, frame, presShell,
widget);
nsCoreUtils::DispatchMouseEvent(eMouseUp, x, y, aContent, frame, presShell,
widget);
}
void LocalAccessible::ScrollToPoint(uint32_t aCoordinateType, int32_t aX,
int32_t aY) {
nsIFrame* frame = GetFrame();
if (!frame) return;
LayoutDeviceIntPoint coords =
nsAccUtils::ConvertToScreenCoords(aX, aY, aCoordinateType, this);
nsIFrame* parentFrame = frame;
while ((parentFrame = parentFrame->GetParent())) {
nsCoreUtils::ScrollFrameToPoint(parentFrame, frame, coords);
}
}
void LocalAccessible::AppendTextTo(nsAString& aText, uint32_t aStartOffset,
uint32_t aLength) {
// Return text representation of non-text accessible within hypertext
// accessible. Text accessible overrides this method to return enclosed text.
if (aStartOffset != 0 || aLength == 0) return;
MOZ_ASSERT(mParent,
"Called on accessible unbound from tree. Result can be wrong.");
nsIFrame* frame = GetFrame();
// We handle something becoming display: none async, which means we won't have
// a frame when we're queuing text removed events. Thus, it's important that
// we produce text here even if there's no frame. Otherwise, we won't fire a
// text removed event at all, which might leave client caches (e.g. NVDA
// virtual buffers) with dead nodes.
if (IsHTMLBr() || (frame && frame->IsBrFrame())) {
aText += kForcedNewLineChar;
} else if (mParent && nsAccUtils::MustPrune(mParent)) {
// Expose the embedded object accessible as imaginary embedded object
// character if its parent hypertext accessible doesn't expose children to
// AT.
aText += kImaginaryEmbeddedObjectChar;
} else {
aText += kEmbeddedObjectChar;
}
}
void LocalAccessible::Shutdown() {
// Mark the accessible as defunct, invalidate the child count and pointers to
// other accessibles, also make sure none of its children point to this
// parent
mStateFlags |= eIsDefunct;
int32_t childCount = mChildren.Length();
for (int32_t childIdx = 0; childIdx < childCount; childIdx++) {
mChildren.ElementAt(childIdx)->UnbindFromParent();
}
mChildren.Clear();
mEmbeddedObjCollector = nullptr;
if (mParent) mParent->RemoveChild(this);
mContent = nullptr;
mDoc = nullptr;
if (SelectionMgr() && SelectionMgr()->AccessibleWithCaret(nullptr) == this) {
SelectionMgr()->ResetCaretOffset();
}
}
// LocalAccessible protected
void LocalAccessible::ARIAName(nsString& aName) const {
// aria-labelledby now takes precedence over aria-label
nsresult rv = nsTextEquivUtils::GetTextEquivFromIDRefs(
this, nsGkAtoms::aria_labelledby, aName);
if (NS_SUCCEEDED(rv)) {
aName.CompressWhitespace();
}
if (aName.IsEmpty() && mContent->IsElement() &&
nsAccUtils::GetARIAAttr(mContent->AsElement(), nsGkAtoms::aria_label,
aName)) {
aName.CompressWhitespace();
}
}
// LocalAccessible protected
void LocalAccessible::ARIADescription(nsString& aDescription) const {
// aria-describedby takes precedence over aria-description
nsresult rv = nsTextEquivUtils::GetTextEquivFromIDRefs(
this, nsGkAtoms::aria_describedby, aDescription);
if (NS_SUCCEEDED(rv)) {
aDescription.CompressWhitespace();
}
if (aDescription.IsEmpty() && mContent->IsElement() &&
nsAccUtils::GetARIAAttr(mContent->AsElement(),
nsGkAtoms::aria_description, aDescription)) {
aDescription.CompressWhitespace();
}
}
// LocalAccessible protected
ENameValueFlag LocalAccessible::NativeName(nsString& aName) const {
if (mContent->IsHTMLElement()) {
LocalAccessible* label = nullptr;
HTMLLabelIterator iter(Document(), this);
while ((label = iter.Next())) {
nsTextEquivUtils::AppendTextEquivFromContent(this, label->GetContent(),
&aName);
aName.CompressWhitespace();
}
if (!aName.IsEmpty()) return eNameOK;
NameFromAssociatedXULLabel(mDoc, mContent, aName);
if (!aName.IsEmpty()) {
return eNameOK;
}
nsTextEquivUtils::GetNameFromSubtree(this, aName);
return aName.IsEmpty() ? eNameOK : eNameFromSubtree;
}
if (mContent->IsXULElement()) {
XULElmName(mDoc, mContent, aName);
if (!aName.IsEmpty()) return eNameOK;
nsTextEquivUtils::GetNameFromSubtree(this, aName);
return aName.IsEmpty() ? eNameOK : eNameFromSubtree;
}
if (mContent->IsSVGElement()) {
// If user agents need to choose among multiple 'desc' or 'title'
// elements for processing, the user agent shall choose the first one.
for (nsIContent* childElm = mContent->GetFirstChild(); childElm;
childElm = childElm->GetNextSibling()) {
if (childElm->IsSVGElement(nsGkAtoms::title)) {
nsTextEquivUtils::AppendTextEquivFromContent(this, childElm, &aName);
return eNameOK;
}
}
}
return eNameOK;
}
// LocalAccessible protected
void LocalAccessible::NativeDescription(nsString& aDescription) const {
bool isXUL = mContent->IsXULElement();
if (isXUL) {
// Try XUL <description control="[id]">description text</description>
XULDescriptionIterator iter(Document(), mContent);
LocalAccessible* descr = nullptr;
while ((descr = iter.Next())) {
nsTextEquivUtils::AppendTextEquivFromContent(this, descr->GetContent(),
&aDescription);
}
}
}
// LocalAccessible protected
void LocalAccessible::BindToParent(LocalAccessible* aParent,
uint32_t aIndexInParent) {
MOZ_ASSERT(aParent, "This method isn't used to set null parent");
MOZ_ASSERT(!mParent, "The child was expected to be moved");
#ifdef A11Y_LOG
if (mParent) {
logging::TreeInfo("BindToParent: stealing accessible", 0, "old parent",
mParent, "new parent", aParent, "child", this, nullptr);
}
#endif
mParent = aParent;
mIndexInParent = aIndexInParent;
if (mParent->HasNameDependent() || mParent->IsXULListItem() ||
RelationByType(RelationType::LABEL_FOR).Next() ||
nsTextEquivUtils::HasNameRule(mParent, eNameFromSubtreeRule)) {
mContextFlags |= eHasNameDependent;
} else {
mContextFlags &= ~eHasNameDependent;
}
if (mParent->HasDescriptionDependent() ||
RelationByType(RelationType::DESCRIPTION_FOR).Next()) {
mContextFlags |= eHasDescriptionDependent;
} else {
mContextFlags &= ~eHasDescriptionDependent;
}
// Add name/description dependent flags for dependent content once
// a name/description provider is added to doc.
Relation rel = RelationByType(RelationType::LABELLED_BY);
LocalAccessible* relTarget = nullptr;
while ((relTarget = rel.LocalNext())) {
if (!relTarget->HasNameDependent()) {
relTarget->ModifySubtreeContextFlags(eHasNameDependent, true);
}
}
rel = RelationByType(RelationType::DESCRIBED_BY);
while ((relTarget = rel.LocalNext())) {
if (!relTarget->HasDescriptionDependent()) {
relTarget->ModifySubtreeContextFlags(eHasDescriptionDependent, true);
}
}
mContextFlags |=
static_cast<uint32_t>((mParent->IsAlert() || mParent->IsInsideAlert())) &
eInsideAlert;
if (TableCellAccessible* cell = AsTableCell()) {
if (StaticPrefs::accessibility_cache_enabled_AtStartup()) {
CachedTableAccessible::Invalidate(this);
} else if (Role() == roles::COLUMNHEADER) {
// A new column header is being added. Invalidate the table's header
// cache.
TableAccessible* table = cell->Table();
if (table) {
table->GetHeaderCache().Clear();
}
}
}
}
// LocalAccessible protected
void LocalAccessible::UnbindFromParent() {
// We do this here to handle document shutdown and an Accessible being moved.
// We do this for subtree removal in DocAccessible::UncacheChildrenInSubtree.
if (StaticPrefs::accessibility_cache_enabled_AtStartup() &&
(IsTable() || IsTableCell())) {
CachedTableAccessible::Invalidate(this);
}
mParent = nullptr;
mIndexInParent = -1;
mIndexOfEmbeddedChild = -1;
delete mGroupInfo;
mGroupInfo = nullptr;
mContextFlags &= ~eHasNameDependent & ~eInsideAlert;
}
////////////////////////////////////////////////////////////////////////////////
// LocalAccessible public methods
RootAccessible* LocalAccessible::RootAccessible() const {
nsCOMPtr<nsIDocShell> docShell = nsCoreUtils::GetDocShellFor(GetNode());
NS_ASSERTION(docShell, "No docshell for mContent");
if (!docShell) {
return nullptr;
}
nsCOMPtr<nsIDocShellTreeItem> root;
docShell->GetInProcessRootTreeItem(getter_AddRefs(root));
NS_ASSERTION(root, "No root content tree item");
if (!root) {
return nullptr;
}
DocAccessible* docAcc = nsAccUtils::GetDocAccessibleFor(root);
return docAcc ? docAcc->AsRoot() : nullptr;
}
nsIFrame* LocalAccessible::GetFrame() const {
return mContent ? mContent->GetPrimaryFrame() : nullptr;
}
nsINode* LocalAccessible::GetNode() const { return mContent; }
dom::Element* LocalAccessible::Elm() const {
return dom::Element::FromNodeOrNull(mContent);
}
void LocalAccessible::Language(nsAString& aLanguage) {
aLanguage.Truncate();
if (!mDoc) return;
nsCoreUtils::GetLanguageFor(mContent, nullptr, aLanguage);
if (aLanguage.IsEmpty()) { // Nothing found, so use document's language
mDoc->DocumentNode()->GetHeaderData(nsGkAtoms::headerContentLanguage,
aLanguage);
}
}
bool LocalAccessible::InsertChildAt(uint32_t aIndex, LocalAccessible* aChild) {
if (!aChild) return false;
if (aIndex == mChildren.Length()) {
// XXX(Bug 1631371) Check if this should use a fallible operation as it
// pretended earlier.
mChildren.AppendElement(aChild);
} else {
// XXX(Bug 1631371) Check if this should use a fallible operation as it
// pretended earlier.
mChildren.InsertElementAt(aIndex, aChild);
MOZ_ASSERT(mStateFlags & eKidsMutating, "Illicit children change");
for (uint32_t idx = aIndex + 1; idx < mChildren.Length(); idx++) {
mChildren[idx]->mIndexInParent = idx;
}
}
if (aChild->IsText()) {
mStateFlags |= eHasTextKids;
}
aChild->BindToParent(this, aIndex);
return true;
}
bool LocalAccessible::RemoveChild(LocalAccessible* aChild) {
MOZ_DIAGNOSTIC_ASSERT(aChild, "No child was given");
MOZ_DIAGNOSTIC_ASSERT(aChild->mParent, "No parent");
MOZ_DIAGNOSTIC_ASSERT(aChild->mParent == this, "Wrong parent");
MOZ_DIAGNOSTIC_ASSERT(aChild->mIndexInParent != -1,
"Unbound child was given");
MOZ_DIAGNOSTIC_ASSERT((mStateFlags & eKidsMutating) || aChild->IsDefunct() ||
aChild->IsDoc() || IsApplication(),
"Illicit children change");
int32_t index = static_cast<uint32_t>(aChild->mIndexInParent);
if (mChildren.SafeElementAt(index) != aChild) {
MOZ_ASSERT_UNREACHABLE("A wrong child index");
index = mChildren.IndexOf(aChild);
if (index == -1) {
MOZ_ASSERT_UNREACHABLE("No child was found");
return false;
}
}
aChild->UnbindFromParent();
mChildren.RemoveElementAt(index);
for (uint32_t idx = index; idx < mChildren.Length(); idx++) {
mChildren[idx]->mIndexInParent = idx;
}
return true;
}
void LocalAccessible::RelocateChild(uint32_t aNewIndex,
LocalAccessible* aChild) {
MOZ_DIAGNOSTIC_ASSERT(aChild, "No child was given");
MOZ_DIAGNOSTIC_ASSERT(aChild->mParent == this,
"A child from different subtree was given");
MOZ_DIAGNOSTIC_ASSERT(aChild->mIndexInParent != -1,
"Unbound child was given");
MOZ_DIAGNOSTIC_ASSERT(
aChild->mParent->LocalChildAt(aChild->mIndexInParent) == aChild,
"Wrong index in parent");
MOZ_DIAGNOSTIC_ASSERT(
static_cast<uint32_t>(aChild->mIndexInParent) != aNewIndex,
"No move, same index");
MOZ_DIAGNOSTIC_ASSERT(aNewIndex <= mChildren.Length(),
"Wrong new index was given");
RefPtr<AccHideEvent> hideEvent = new AccHideEvent(aChild, false);
if (mDoc->Controller()->QueueMutationEvent(hideEvent)) {
aChild->SetHideEventTarget(true);
}
mEmbeddedObjCollector = nullptr;
mChildren.RemoveElementAt(aChild->mIndexInParent);
uint32_t startIdx = aNewIndex, endIdx = aChild->mIndexInParent;
// If the child is moved after its current position.
if (static_cast<uint32_t>(aChild->mIndexInParent) < aNewIndex) {
startIdx = aChild->mIndexInParent;
if (aNewIndex == mChildren.Length() + 1) {
// The child is moved to the end.
mChildren.AppendElement(aChild);
endIdx = mChildren.Length() - 1;
} else {
mChildren.InsertElementAt(aNewIndex - 1, aChild);
endIdx = aNewIndex;
}
} else {
// The child is moved prior its current position.
mChildren.InsertElementAt(aNewIndex, aChild);
}
for (uint32_t idx = startIdx; idx <= endIdx; idx++) {
mChildren[idx]->mIndexInParent = idx;
mChildren[idx]->mIndexOfEmbeddedChild = -1;
}
for (uint32_t idx = 0; idx < mChildren.Length(); idx++) {
mChildren[idx]->mStateFlags |= eGroupInfoDirty;
}
RefPtr<AccShowEvent> showEvent = new AccShowEvent(aChild);
DebugOnly<bool> added = mDoc->Controller()->QueueMutationEvent(showEvent);
MOZ_ASSERT(added);
aChild->SetShowEventTarget(true);
}
LocalAccessible* LocalAccessible::LocalChildAt(uint32_t aIndex) const {
LocalAccessible* child = mChildren.SafeElementAt(aIndex, nullptr);
if (!child) return nullptr;
#ifdef DEBUG
LocalAccessible* realParent = child->mParent;
NS_ASSERTION(!realParent || realParent == this,
"Two accessibles have the same first child accessible!");
#endif
return child;
}
uint32_t LocalAccessible::ChildCount() const { return mChildren.Length(); }
int32_t LocalAccessible::IndexInParent() const { return mIndexInParent; }
uint32_t LocalAccessible::EmbeddedChildCount() {
if (mStateFlags & eHasTextKids) {
if (!mEmbeddedObjCollector) {
mEmbeddedObjCollector.reset(new EmbeddedObjCollector(this));
}
return mEmbeddedObjCollector->Count();
}
return ChildCount();
}
LocalAccessible* LocalAccessible::EmbeddedChildAt(uint32_t aIndex) {
if (mStateFlags & eHasTextKids) {
if (!mEmbeddedObjCollector) {
mEmbeddedObjCollector.reset(new EmbeddedObjCollector(this));
}
return mEmbeddedObjCollector.get()
? mEmbeddedObjCollector->GetAccessibleAt(aIndex)
: nullptr;
}
return LocalChildAt(aIndex);
}
int32_t LocalAccessible::IndexOfEmbeddedChild(Accessible* aChild) {
MOZ_ASSERT(aChild->IsLocal());
if (mStateFlags & eHasTextKids) {
if (!mEmbeddedObjCollector) {
mEmbeddedObjCollector.reset(new EmbeddedObjCollector(this));
}
return mEmbeddedObjCollector.get()
? mEmbeddedObjCollector->GetIndexAt(aChild->AsLocal())
: -1;
}
return GetIndexOf(aChild->AsLocal());
}
////////////////////////////////////////////////////////////////////////////////
// HyperLinkAccessible methods
bool LocalAccessible::IsLink() const {
// Every embedded accessible within hypertext accessible implements
// hyperlink interface.
return mParent && mParent->IsHyperText() && !IsText();
}
uint32_t LocalAccessible::AnchorCount() {
MOZ_ASSERT(IsLink(), "AnchorCount is called on not hyper link!");
return 1;
}
LocalAccessible* LocalAccessible::AnchorAt(uint32_t aAnchorIndex) {
MOZ_ASSERT(IsLink(), "GetAnchor is called on not hyper link!");
return aAnchorIndex == 0 ? this : nullptr;
}
already_AddRefed<nsIURI> LocalAccessible::AnchorURIAt(
uint32_t aAnchorIndex) const {
MOZ_ASSERT(IsLink(), "AnchorURIAt is called on not hyper link!");
return nullptr;
}
////////////////////////////////////////////////////////////////////////////////
// SelectAccessible
void LocalAccessible::SelectedItems(nsTArray<Accessible*>* aItems) {
AccIterator iter(this, filters::GetSelected);
LocalAccessible* selected = nullptr;
while ((selected = iter.Next())) aItems->AppendElement(selected);
}
uint32_t LocalAccessible::SelectedItemCount() {
uint32_t count = 0;
AccIterator iter(this, filters::GetSelected);
LocalAccessible* selected = nullptr;
while ((selected = iter.Next())) ++count;
return count;
}
Accessible* LocalAccessible::GetSelectedItem(uint32_t aIndex) {
AccIterator iter(this, filters::GetSelected);
LocalAccessible* selected = nullptr;
uint32_t index = 0;
while ((selected = iter.Next()) && index < aIndex) index++;
return selected;
}
bool LocalAccessible::IsItemSelected(uint32_t aIndex) {
uint32_t index = 0;
AccIterator iter(this, filters::GetSelectable);
LocalAccessible* selected = nullptr;
while ((selected = iter.Next()) && index < aIndex) index++;
return selected && selected->State() & states::SELECTED;
}
bool LocalAccessible::AddItemToSelection(uint32_t aIndex) {
uint32_t index = 0;
AccIterator iter(this, filters::GetSelectable);
LocalAccessible* selected = nullptr;
while ((selected = iter.Next()) && index < aIndex) index++;
if (selected) selected->SetSelected(true);
return static_cast<bool>(selected);
}
bool LocalAccessible::RemoveItemFromSelection(uint32_t aIndex) {
uint32_t index = 0;
AccIterator iter(this, filters::GetSelectable);
LocalAccessible* selected = nullptr;
while ((selected = iter.Next()) && index < aIndex) index++;
if (selected) selected->SetSelected(false);
return static_cast<bool>(selected);
}
bool LocalAccessible::SelectAll() {
bool success = false;
LocalAccessible* selectable = nullptr;
AccIterator iter(this, filters::GetSelectable);
while ((selectable = iter.Next())) {
success = true;
selectable->SetSelected(true);
}
return success;
}
bool LocalAccessible::UnselectAll() {
bool success = false;
LocalAccessible* selected = nullptr;
AccIterator iter(this, filters::GetSelected);
while ((selected = iter.Next())) {
success = true;
selected->SetSelected(false);
}
return success;
}
////////////////////////////////////////////////////////////////////////////////
// Widgets
bool LocalAccessible::IsWidget() const { return false; }
bool LocalAccessible::IsActiveWidget() const {
if (FocusMgr()->HasDOMFocus(mContent)) return true;
// If text entry of combobox widget has a focus then the combobox widget is
// active.
const nsRoleMapEntry* roleMapEntry = ARIARoleMap();
if (roleMapEntry && roleMapEntry->Is(nsGkAtoms::combobox)) {
uint32_t childCount = ChildCount();
for (uint32_t idx = 0; idx < childCount; idx++) {
LocalAccessible* child = mChildren.ElementAt(idx);
if (child->Role() == roles::ENTRY) {
return FocusMgr()->HasDOMFocus(child->GetContent());
}
}
}
return false;
}
bool LocalAccessible::AreItemsOperable() const {
return HasOwnContent() && mContent->IsElement() &&
mContent->AsElement()->HasAttr(nsGkAtoms::aria_activedescendant);
}
LocalAccessible* LocalAccessible::CurrentItem() const {
// Check for aria-activedescendant, which changes which element has focus.
// For activedescendant, the ARIA spec does not require that the user agent
// checks whether pointed node is actually a DOM descendant of the element
// with the aria-activedescendant attribute.
nsAutoString id;
if (HasOwnContent() && mContent->IsElement() &&
mContent->AsElement()->GetAttr(nsGkAtoms::aria_activedescendant, id)) {
dom::Element* activeDescendantElm = IDRefsIterator::GetElem(mContent, id);
if (activeDescendantElm) {
if (mContent->IsInclusiveDescendantOf(activeDescendantElm)) {
// Don't want a cyclical descendant relationship. That would be bad.
return nullptr;
}
DocAccessible* document = Document();
if (document) return document->GetAccessible(activeDescendantElm);
}
}
return nullptr;
}
void LocalAccessible::SetCurrentItem(const LocalAccessible* aItem) {
nsAtom* id = aItem->GetContent()->GetID();
if (id) {
nsAutoString idStr;
id->ToString(idStr);
mContent->AsElement()->SetAttr(
kNameSpaceID_None, nsGkAtoms::aria_activedescendant, idStr, true);
}
}
LocalAccessible* LocalAccessible::ContainerWidget() const {
if (HasARIARole() && mContent->HasID()) {
for (LocalAccessible* parent = LocalParent(); parent;
parent = parent->LocalParent()) {
nsIContent* parentContent = parent->GetContent();
if (parentContent && parentContent->IsElement() &&
parentContent->AsElement()->HasAttr(
nsGkAtoms::aria_activedescendant)) {
return parent;
}
// Don't cross DOM document boundaries.
if (parent->IsDoc()) break;
}
}
return nullptr;
}
bool LocalAccessible::IsActiveDescendant(LocalAccessible** aWidget) const {
if (!HasOwnContent() || !mContent->HasID()) {
return false;
}
dom::DocumentOrShadowRoot* docOrShadowRoot =
mContent->GetUncomposedDocOrConnectedShadowRoot();
if (!docOrShadowRoot) {
return false;
}
nsAutoCString selector;
selector.AppendPrintf(
"[aria-activedescendant=\"%s\"]",
NS_ConvertUTF16toUTF8(mContent->GetID()->GetUTF16String()).get());
IgnoredErrorResult er;
dom::Element* widgetElm =
docOrShadowRoot->AsNode().QuerySelector(selector, er);
if (!widgetElm || er.Failed()) {
return false;
}
if (widgetElm->IsInclusiveDescendantOf(mContent)) {
// Don't want a cyclical descendant relationship. That would be bad.
return false;
}
LocalAccessible* widget = mDoc->GetAccessible(widgetElm);
if (aWidget) {
*aWidget = widget;
}
return !!widget;
}
void LocalAccessible::Announce(const nsAString& aAnnouncement,
uint16_t aPriority) {
RefPtr<AccAnnouncementEvent> event =
new AccAnnouncementEvent(this, aAnnouncement, aPriority);
nsEventShell::FireEvent(event);
}
////////////////////////////////////////////////////////////////////////////////
// LocalAccessible protected methods
void LocalAccessible::LastRelease() {
// First cleanup if needed...
if (mDoc) {
Shutdown();
NS_ASSERTION(!mDoc,
"A Shutdown() impl forgot to call its parent's Shutdown?");
}
// ... then die.
delete this;
}
LocalAccessible* LocalAccessible::GetSiblingAtOffset(int32_t aOffset,
nsresult* aError) const {
if (!mParent || mIndexInParent == -1) {
if (aError) *aError = NS_ERROR_UNEXPECTED;
return nullptr;
}
if (aError &&
mIndexInParent + aOffset >= static_cast<int32_t>(mParent->ChildCount())) {
*aError = NS_OK; // fail peacefully
return nullptr;
}
LocalAccessible* child = mParent->LocalChildAt(mIndexInParent + aOffset);
if (aError && !child) *aError = NS_ERROR_UNEXPECTED;
return child;
}
void LocalAccessible::ModifySubtreeContextFlags(uint32_t aContextFlags,
bool aAdd) {
Pivot pivot(this);
LocalAccInSameDocRule rule;
for (Accessible* anchor = this; anchor; anchor = pivot.Next(anchor, rule)) {
MOZ_ASSERT(anchor->IsLocal());
LocalAccessible* acc = anchor->AsLocal();
if (aAdd) {
acc->mContextFlags |= aContextFlags;
} else {
acc->mContextFlags &= ~aContextFlags;
}
}
}
double LocalAccessible::AttrNumericValue(nsAtom* aAttr) const {
const nsRoleMapEntry* roleMapEntry = ARIARoleMap();
if (!roleMapEntry || roleMapEntry->valueRule == eNoValue) {
return UnspecifiedNaN<double>();
}
nsAutoString attrValue;
if (!mContent->IsElement() ||
!nsAccUtils::GetARIAAttr(mContent->AsElement(), aAttr, attrValue)) {
return UnspecifiedNaN<double>();
}
nsresult error = NS_OK;
double value = attrValue.ToDouble(&error);
return NS_FAILED(error) ? UnspecifiedNaN<double>() : value;
}
uint32_t LocalAccessible::GetActionRule() const {
if (!HasOwnContent() || (InteractiveState() & states::UNAVAILABLE)) {
return eNoAction;
}
// Return "click" action on elements that have an attached popup menu.
if (mContent->IsXULElement()) {
if (mContent->AsElement()->HasAttr(kNameSpaceID_None, nsGkAtoms::popup)) {
return eClickAction;
}
}
// Has registered 'click' event handler.
bool isOnclick = nsCoreUtils::HasClickListener(mContent);
if (isOnclick) return eClickAction;
// Get an action based on ARIA role.
const nsRoleMapEntry* roleMapEntry = ARIARoleMap();
if (roleMapEntry && roleMapEntry->actionRule != eNoAction) {
return roleMapEntry->actionRule;
}
// Get an action based on ARIA attribute.
if (nsAccUtils::HasDefinedARIAToken(mContent, nsGkAtoms::aria_expanded)) {
return eExpandAction;
}
return eNoAction;
}
AccGroupInfo* LocalAccessible::GetGroupInfo() const {
if (mGroupInfo && !(mStateFlags & eGroupInfoDirty)) {
return mGroupInfo;
}
return nullptr;
}
AccGroupInfo* LocalAccessible::GetOrCreateGroupInfo() {
if (mGroupInfo) {
if (mStateFlags & eGroupInfoDirty) {
mGroupInfo->Update();
mStateFlags &= ~eGroupInfoDirty;
}
return mGroupInfo;
}
mGroupInfo = AccGroupInfo::CreateGroupInfo(this);
mStateFlags &= ~eGroupInfoDirty;
return mGroupInfo;
}
void LocalAccessible::SendCache(uint64_t aCacheDomain,
CacheUpdateType aUpdateType) {
if (!StaticPrefs::accessibility_cache_enabled_AtStartup()) {
return;
}
if (!IPCAccessibilityActive() || !Document()) {
return;
}
DocAccessibleChild* ipcDoc = mDoc->IPCDoc();
if (!ipcDoc) {
// This means DocAccessible::DoInitialUpdate hasn't been called yet, which
// means the a11y tree hasn't been built yet. Therefore, this should only
// be possible if this is a DocAccessible.
MOZ_ASSERT(IsDoc(), "Called on a non-DocAccessible but IPCDoc is null");
return;
}
RefPtr<AccAttributes> fields =
BundleFieldsForCache(aCacheDomain, aUpdateType);
if (!fields->Count()) {
return;
}
nsTArray<CacheData> data;
data.AppendElement(CacheData(ID(), fields));
ipcDoc->SendCache(aUpdateType, data, false);
if (profiler_thread_is_being_profiled_for_markers()) {
nsAutoCString updateTypeStr;
if (aUpdateType == CacheUpdateType::Initial) {
updateTypeStr = "Initial";
} else if (aUpdateType == CacheUpdateType::Update) {
updateTypeStr = "Update";
} else {
updateTypeStr = "Other";
}
PROFILER_MARKER_TEXT("LocalAccessible::SendCache", A11Y, {}, updateTypeStr);
}
}
already_AddRefed<AccAttributes> LocalAccessible::BundleFieldsForCache(
uint64_t aCacheDomain, CacheUpdateType aUpdateType) {
RefPtr<AccAttributes> fields = new AccAttributes();
// Caching name for text leaf Accessibles is redundant, since their name is
// always their text. Text gets handled below.
if (aCacheDomain & CacheDomain::NameAndDescription && !IsText()) {
nsString name;
int32_t nameFlag = Name(name);
if (nameFlag != eNameOK) {
fields->SetAttribute(nsGkAtoms::explicit_name, nameFlag);
} else if (aUpdateType == CacheUpdateType::Update) {
fields->SetAttribute(nsGkAtoms::explicit_name, DeleteEntry());
}
if (!name.IsEmpty()) {
fields->SetAttribute(nsGkAtoms::name, std::move(name));
} else if (aUpdateType == CacheUpdateType::Update) {
fields->SetAttribute(nsGkAtoms::name, DeleteEntry());
}
nsString description;
Description(description);
if (!description.IsEmpty()) {
fields->SetAttribute(nsGkAtoms::description, std::move(description));
} else if (aUpdateType == CacheUpdateType::Update) {
fields->SetAttribute(nsGkAtoms::description, DeleteEntry());
}
}
if (aCacheDomain & CacheDomain::Value) {
// We cache the text value in 3 cases:
// 1. Accessible is an HTML input type that holds a number.
// 2. Accessible has a numeric value and an aria-valuetext.
// 3. Accessible is an HTML input type that holds text.
// 4. Accessible is a link, in which case value is the target URL.
// ... for all other cases we divine the value remotely.
bool cacheValueText = false;
if (HasNumericValue()) {
fields->SetAttribute(nsGkAtoms::value, CurValue());
fields->SetAttribute(nsGkAtoms::max, MaxValue());
fields->SetAttribute(nsGkAtoms::min, MinValue());
fields->SetAttribute(nsGkAtoms::step, Step());
cacheValueText = NativeHasNumericValue() ||
(mContent->IsElement() &&
nsAccUtils::HasARIAAttr(mContent->AsElement(),
nsGkAtoms::aria_valuetext));
} else {
cacheValueText = IsTextField() || IsHTMLLink();
}
if (cacheValueText) {
nsString value;
Value(value);
if (!value.IsEmpty()) {
fields->SetAttribute(nsGkAtoms::aria_valuetext, std::move(value));
} else if (aUpdateType == CacheUpdateType::Update) {
fields->SetAttribute(nsGkAtoms::aria_valuetext, DeleteEntry());
}
}
}
if (aCacheDomain & CacheDomain::Viewport && IsDoc()) {
// Construct the viewport cache for this document. This cache domain will
// only be requested after we finish painting.
DocAccessible* doc = AsDoc();
PresShell* presShell = doc->PresShellPtr();
if (nsIFrame* rootFrame = presShell->GetRootFrame()) {
nsTArray<nsIFrame*> frames;
nsIScrollableFrame* sf = presShell->GetRootScrollFrameAsScrollable();
nsRect scrollPort = sf ? sf->GetScrollPortRect() : rootFrame->GetRect();
nsLayoutUtils::GetFramesForArea(
RelativeTo{rootFrame}, scrollPort, frames,
{{// We only care about visible content for hittesting.
nsLayoutUtils::FrameForPointOption::OnlyVisible,
// This flag ensures the display lists are built, even if
// the page hasn't finished loading.
nsLayoutUtils::FrameForPointOption::IgnorePaintSuppression,
// Each doc should have its own viewport cache, so we can
// ignore cross-doc content as an optimization.
nsLayoutUtils::FrameForPointOption::IgnoreCrossDoc}});
nsTHashSet<LocalAccessible*> inViewAccs;
nsTArray<uint64_t> viewportCache;
// Layout considers table rows fully occluded by their containing cells.
// This means they don't have their own display list items, and they won't
// show up in the list returned from GetFramesForArea. To prevent table
// rows from appearing offscreen, we manually add any rows for which we
// have on-screen cells.
LocalAccessible* prevParentRow = nullptr;
for (nsIFrame* frame : frames) {
nsIContent* content = frame->GetContent();
if (!content) {
continue;
}
LocalAccessible* acc = doc->GetAccessible(content);
// The document should always be present at the end of the list, so
// including it is unnecessary and wasteful. We skip the document here
// and handle it as a fallback when hit testing.
if (!acc || acc == mDoc) {
continue;
}
if (acc->IsTextLeaf() && nsAccUtils::MustPrune(acc->LocalParent())) {
acc = acc->LocalParent();
}
if (acc->IsTableCell()) {
LocalAccessible* parent = acc->LocalParent();
if (parent && parent->IsTableRow() && parent != prevParentRow) {
// If we've entered a new row since the last cell we saw, add the
// previous parent row to our viewport cache here to maintain
// hittesting order. Keep track of the current parent row.
if (prevParentRow && inViewAccs.EnsureInserted(prevParentRow)) {
viewportCache.AppendElement(prevParentRow->ID());
}
prevParentRow = parent;
}
} else if (acc->IsTable()) {
// If we've encountered a table, we know we've already
// handled all of this table's content (because we're traversing
// in hittesting order). Add our table's final row to the viewport
// cache before adding the table itself. Reset our marker for the next
// table.
if (prevParentRow && inViewAccs.EnsureInserted(prevParentRow)) {
viewportCache.AppendElement(prevParentRow->ID());
}
prevParentRow = nullptr;
} else if (acc->IsImageMap()) {
// Layout doesn't walk image maps, so we do that
// manually here. We do this before adding the map itself
// so the children come earlier in the hittesting order.
for (uint32_t i = 0; i < acc->ChildCount(); i++) {
LocalAccessible* child = acc->LocalChildAt(i);
MOZ_ASSERT(child);
if (inViewAccs.EnsureInserted(child)) {
MOZ_ASSERT(!child->IsDoc());
viewportCache.AppendElement(child->ID());
}
}
} else if (acc->IsHTMLCombobox()) {
// Layout doesn't consider combobox lists (or their
// currently selected items) to be onscreen, but we do.
// Add those things manually here.
HTMLComboboxAccessible* combobox =
static_cast<HTMLComboboxAccessible*>(acc);
HTMLComboboxListAccessible* list = combobox->List();
LocalAccessible* currItem = combobox->SelectedOption();
// Preserve hittesting order by adding the item, then
// the list, and finally the combobox itself.
if (currItem && inViewAccs.EnsureInserted(currItem)) {
viewportCache.AppendElement(currItem->ID());
}
if (list && inViewAccs.EnsureInserted(list)) {
viewportCache.AppendElement(list->ID());
}
}
if (inViewAccs.EnsureInserted(acc)) {
MOZ_ASSERT(!acc->IsDoc());
viewportCache.AppendElement(acc->ID());
}
}
if (viewportCache.Length()) {
fields->SetAttribute(nsGkAtoms::viewport, std::move(viewportCache));
}
}
}
bool boundsChanged = false;
if (aCacheDomain & CacheDomain::Bounds) {
nsRect newBoundsRect = ParentRelativeBounds();
// 1. Layout might notify us of a possible bounds change when the bounds
// haven't really changed. Therefore, we cache the last bounds we sent
// and don't send an update if they haven't changed.
// 2. For an initial cache push, we ignore 1) and always send the bounds.
// This handles the case where this LocalAccessible was moved (but not
// re-created). In that case, we will have cached bounds, but we currently
// do an initial cache push.
MOZ_ASSERT(aUpdateType == CacheUpdateType::Initial || mBounds.isSome(),
"Incremental cache push but mBounds is not set!");
if (OuterDocAccessible* doc = AsOuterDoc()) {
if (nsIFrame* docFrame = doc->GetFrame()) {
const nsMargin& newOffset = docFrame->GetUsedBorderAndPadding();
Maybe<nsMargin> currOffset = doc->GetCrossDocOffset();
if (!currOffset || *currOffset != newOffset) {
// OOP iframe docs can't compute their position within their
// cross-proc parent, so we have to manually cache that offset
// on the parent (outer doc) itself. For simplicity and consistency,
// we do this here for both OOP and in-process iframes. For in-process
// iframes, this also avoids the need to push a cache update for the
// embedded document when the iframe changes its padding, gets
// re-created, etc. Similar to bounds, we maintain a local cache and a
// remote cache to avoid sending redundant updates.
doc->SetCrossDocOffset(newOffset);
nsTArray<int32_t> offsetArray(2);
offsetArray.AppendElement(newOffset.Side(eSideLeft)); // X offset
offsetArray.AppendElement(newOffset.Side(eSideTop)); // Y offset
fields->SetAttribute(nsGkAtoms::crossorigin, std::move(offsetArray));
}
}
}
boundsChanged = aUpdateType == CacheUpdateType::Initial ||
!newBoundsRect.IsEqualEdges(mBounds.value());
if (boundsChanged) {
mBounds = Some(newBoundsRect);
nsTArray<int32_t> boundsArray(4);
boundsArray.AppendElement(newBoundsRect.x);
boundsArray.AppendElement(newBoundsRect.y);
boundsArray.AppendElement(newBoundsRect.width);
boundsArray.AppendElement(newBoundsRect.height);
fields->SetAttribute(nsGkAtoms::relativeBounds, std::move(boundsArray));
}
}
if (aCacheDomain & CacheDomain::Text) {
if (!HasChildren()) {
// We only cache text and line offsets on leaf Accessibles.
// Only text Accessibles can have actual text.
if (IsText()) {
nsString text;
AppendTextTo(text);
fields->SetAttribute(nsGkAtoms::text, std::move(text));
TextLeafPoint point(this, 0);
RefPtr<AccAttributes> attrs = point.GetTextAttributesLocalAcc(
/* aIncludeDefaults */ false);
fields->SetAttribute(nsGkAtoms::style, std::move(attrs));
}
}
if (HyperTextAccessible* ht = AsHyperText()) {
RefPtr<AccAttributes> attrs = ht->DefaultTextAttributes();
fields->SetAttribute(nsGkAtoms::style, std::move(attrs));
}
}
// If text changes, we must also update spelling errors.
if (aCacheDomain & (CacheDomain::Spelling | CacheDomain::Text) &&
IsTextLeaf()) {
auto spellingErrors = TextLeafPoint::GetSpellingErrorOffsets(this);
if (!spellingErrors.IsEmpty()) {
fields->SetAttribute(nsGkAtoms::spelling, std::move(spellingErrors));
} else if (aUpdateType == CacheUpdateType::Update) {
fields->SetAttribute(nsGkAtoms::spelling, DeleteEntry());
}
}
nsIFrame* frame = GetFrame();
if (aCacheDomain & (CacheDomain::Text | CacheDomain::Bounds) &&
!HasChildren()) {
// We cache line start offsets for both text and non-text leaf Accessibles
// because non-text leaf Accessibles can still start a line.
TextLeafPoint lineStart =
TextLeafPoint(this, 0).FindNextLineStartSameLocalAcc(
/* aIncludeOrigin */ true);
int32_t lineStartOffset = lineStart ? lineStart.mOffset : -1;
// We push line starts and text bounds in two cases:
// 1. Text or bounds changed, which means it's very likely that line starts
// and text bounds changed too.
// 2. CacheDomain::Bounds was requested (indicating that the frame was
// reflowed) but the bounds didn't actually change. This can happen when
// the spanned text is non-rectangular. For example, an Accessible might
// cover two characters on one line and a single character on another line.
// An insertion in a previous text node might cause it to shift such that it
// now covers a single character on the first line and two characters on the
// second line. Its bounding rect will be the same both before and after the
// insertion. In this case, we use the first line start to determine whether
// there was a change. This should be safe because the text didn't change in
// this Accessible, so if the first line start doesn't shift, none of them
// should shift.
if (aCacheDomain & CacheDomain::Text || boundsChanged ||
mFirstLineStart != lineStartOffset) {
mFirstLineStart = lineStartOffset;
nsTArray<int32_t> lineStarts;
for (; lineStart;
lineStart = lineStart.FindNextLineStartSameLocalAcc(false)) {
lineStarts.AppendElement(lineStart.mOffset);
}
if (!lineStarts.IsEmpty()) {
fields->SetAttribute(nsGkAtoms::line, std::move(lineStarts));
} else if (aUpdateType == CacheUpdateType::Update) {
fields->SetAttribute(nsGkAtoms::line, DeleteEntry());
}
if (frame && frame->IsTextFrame()) {
nsTArray<int32_t> charData;
if (nsTextFrame* currTextFrame = do_QueryFrame(frame)) {
nsTextFrame* prevTextFrame = currTextFrame;
nsRect frameRect = currTextFrame->GetRect();
nsIFrame* nearestAccAncestorFrame =
LocalParent() ? LocalParent()->GetFrame() : nullptr;
while (currTextFrame) {
nsRect contRect = currTextFrame->GetRect();
if (prevTextFrame->GetParent() != currTextFrame->GetParent() &&
nearestAccAncestorFrame) {
// Continuations can span multiple frame tree subtrees,
// particularly when multiline text is nested within both block
// and inline elements. In addition to using the position of this
// continuation to offset our char rects, we'll need to offset
// this continuation from the continuations that occurred before
// it. We don't know how many there are or what subtrees they're
// in, so we use a transform here. This also ensures our offset is
// accurate even if the intervening inline elements are not
// present in the a11y tree.
contRect = frameRect;
nsLayoutUtils::TransformRect(currTextFrame,
nearestAccAncestorFrame, contRect);
}
nsTArray<nsRect> charBounds;
currTextFrame->GetCharacterRectsInRange(
currTextFrame->GetContentOffset(),
currTextFrame->GetContentEnd(), charBounds);
for (const nsRect& charRect : charBounds) {
// We expect each char rect to be relative to the text leaf
// acc this text lives in. Unfortunately, GetCharacterRectsInRange
// returns rects relative to their continuation. Add the
// continuation's relative position here to make our final
// rect relative to the text leaf acc. Continuation rects include
// the padding of their parent text frame, so we compute the
// relative offset here instead of using `contRect`'s coordinates
// outright.
int computedX = charRect.x + (contRect.x - frameRect.x);
int computedY = charRect.y + (contRect.y - frameRect.y);
charData.AppendElement(computedX);
charData.AppendElement(computedY);
charData.AppendElement(charRect.width);
charData.AppendElement(charRect.height);
}
prevTextFrame = currTextFrame;
currTextFrame = currTextFrame->GetNextContinuation();
}
}
if (charData.Length()) {
fields->SetAttribute(nsGkAtoms::characterData, std::move(charData));
}
}
}
}
if (aCacheDomain & CacheDomain::TransformMatrix) {
bool transformed = false;
if (frame && frame->IsTransformed()) {
// We need to find a frame to make our transform relative to.
// It's important this frame have a corresponding accessible,
// because this transform is applied while walking the accessibility
// tree (in the parent process), not the frame tree.
nsIFrame* boundingFrame = FindNearestAccessibleAncestorFrame();
// This matrix is only valid when applied to CSSPixel points/rects
// in the coordinate space of `frame`. It also includes the translation
// to the parent space.
gfx::Matrix4x4Flagged mtx = nsLayoutUtils::GetTransformToAncestor(
RelativeTo{frame}, RelativeTo{boundingFrame}, nsIFrame::IN_CSS_UNITS);
// We might get back the identity matrix. This can happen if there is no
// actual transform. For example, if an element has
// will-change: transform, nsIFrame::IsTransformed will return true, but
// this doesn't necessarily mean there is a transform right now.
// Applying the identity matrix is effectively a no-op, so there's no
// point caching it.
transformed = !mtx.IsIdentity();
if (transformed) {
UniquePtr<gfx::Matrix4x4> ptr =
MakeUnique<gfx::Matrix4x4>(mtx.GetMatrix());
fields->SetAttribute(nsGkAtoms::transform, std::move(ptr));
}
}
if (!transformed && aUpdateType == CacheUpdateType::Update) {
// Otherwise, if we're bundling a transform update but this
// frame isn't transformed (or doesn't exist), we need
// to send a DeleteEntry() to remove any
// transform that was previously cached for this frame.
fields->SetAttribute(nsGkAtoms::transform, DeleteEntry());
}
}
if (aCacheDomain & CacheDomain::ScrollPosition) {
nsPoint scrollPosition;
std::tie(scrollPosition, std::ignore) = mDoc->ComputeScrollData(this);
if (scrollPosition.x || scrollPosition.y) {
nsTArray<int32_t> positionArr(2);
positionArr.AppendElement(scrollPosition.x);
positionArr.AppendElement(scrollPosition.y);
fields->SetAttribute(nsGkAtoms::scrollPosition, std::move(positionArr));
} else if (aUpdateType == CacheUpdateType::Update) {
fields->SetAttribute(nsGkAtoms::scrollPosition, DeleteEntry());
}
}
if (aCacheDomain & CacheDomain::DOMNodeID && mContent) {
nsAtom* id = mContent->GetID();
if (id) {
fields->SetAttribute(nsGkAtoms::id, id);
} else if (aUpdateType == CacheUpdateType::Update) {
fields->SetAttribute(nsGkAtoms::id, DeleteEntry());
}
}
// State is only included in the initial push. Thereafter, cached state is
// updated via events.
if (aCacheDomain & CacheDomain::State) {
if (aUpdateType == CacheUpdateType::Initial) {
// Most states are updated using state change events, so we only send
// these for the initial cache push.
uint64_t state = State();
// Exclude states which must be calculated by RemoteAccessible.
state &= ~kRemoteCalculatedStates;
fields->SetAttribute(nsGkAtoms::state, state);
}
// If aria-selected isn't specified, there may be no SELECTED state.
// However, aria-selected can be implicit in some cases when an item is
// focused. We don't want to do this if aria-selected is explicitly
// set to "false", so we need to differentiate between false and unset.
if (auto ariaSelected = ARIASelected()) {
fields->SetAttribute(nsGkAtoms::aria_selected, *ariaSelected);
} else if (aUpdateType == CacheUpdateType::Update) {
fields->SetAttribute(nsGkAtoms::aria_selected, DeleteEntry()); // Unset.
}
}
if (aCacheDomain & CacheDomain::GroupInfo && mContent) {
for (nsAtom* attr : {nsGkAtoms::aria_level, nsGkAtoms::aria_setsize,
nsGkAtoms::aria_posinset}) {
int32_t value = 0;
if (nsCoreUtils::GetUIntAttr(mContent, attr, &value)) {
fields->SetAttribute(attr, value);
} else if (aUpdateType == CacheUpdateType::Update) {
fields->SetAttribute(attr, DeleteEntry());
}
}
}
if (aCacheDomain & CacheDomain::Actions) {
if (HasPrimaryAction()) {
// Here we cache the primary action.
nsAutoString actionName;
ActionNameAt(0, actionName);
RefPtr<nsAtom> actionAtom = NS_Atomize(actionName);
fields->SetAttribute(nsGkAtoms::action, actionAtom);
} else if (aUpdateType == CacheUpdateType::Update) {
fields->SetAttribute(nsGkAtoms::action, DeleteEntry());
}
if (ImageAccessible* imgAcc = AsImage()) {
// Here we cache the showlongdesc action.
if (imgAcc->HasLongDesc()) {
fields->SetAttribute(nsGkAtoms::longdesc, true);
} else if (aUpdateType == CacheUpdateType::Update) {
fields->SetAttribute(nsGkAtoms::longdesc, DeleteEntry());
}
}
KeyBinding accessKey = AccessKey();
if (!accessKey.IsEmpty()) {
fields->SetAttribute(nsGkAtoms::accesskey, accessKey.Serialize());
} else if (aUpdateType == CacheUpdateType::Update) {
fields->SetAttribute(nsGkAtoms::accesskey, DeleteEntry());
}
}
if (aCacheDomain & CacheDomain::Style) {
if (RefPtr<nsAtom> display = DisplayStyle()) {
fields->SetAttribute(nsGkAtoms::display, display);
}
float opacity = Opacity();
if (opacity != 1.0f) {
fields->SetAttribute(nsGkAtoms::opacity, opacity);
} else if (aUpdateType == CacheUpdateType::Update) {
fields->SetAttribute(nsGkAtoms::opacity, DeleteEntry());
}
}
if (aCacheDomain & CacheDomain::Table) {
if (TableAccessible* table = AsTable()) {
if (table->IsProbablyLayoutTable()) {
fields->SetAttribute(nsGkAtoms::layout_guess, true);
} else if (aUpdateType == CacheUpdateType::Update) {
fields->SetAttribute(nsGkAtoms::layout_guess, DeleteEntry());
}
} else if (TableCellAccessible* cell = AsTableCell()) {
// For HTML table cells, we must use the HTMLTableCellAccessible
// GetRow/ColExtent methods rather than using the DOM attributes directly.
// This is because of things like rowspan="0" which depend on knowing
// about thead, tbody, etc., which is info we don't have in the a11y tree.
int32_t value = static_cast<int32_t>(cell->RowExtent());
MOZ_ASSERT(value > 0);
if (value > 1) {
fields->SetAttribute(nsGkAtoms::rowspan, value);
} else if (aUpdateType == CacheUpdateType::Update) {
fields->SetAttribute(nsGkAtoms::rowspan, DeleteEntry());
}
value = static_cast<int32_t>(cell->ColExtent());
MOZ_ASSERT(value > 0);
if (value > 1) {
fields->SetAttribute(nsGkAtoms::colspan, value);
} else if (aUpdateType == CacheUpdateType::Update) {
fields->SetAttribute(nsGkAtoms::colspan, DeleteEntry());
}
if (mContent->AsElement()->HasAttr(kNameSpaceID_None,
nsGkAtoms::headers)) {
nsTArray<uint64_t> headers;
IDRefsIterator iter(mDoc, mContent, nsGkAtoms::headers);
while (LocalAccessible* cell = iter.Next()) {
if (cell->IsTableCell()) {
headers.AppendElement(cell->ID());
}
}
fields->SetAttribute(nsGkAtoms::headers, std::move(headers));
} else if (aUpdateType == CacheUpdateType::Update) {
fields->SetAttribute(nsGkAtoms::headers, DeleteEntry());
}
}
}
if (aCacheDomain & CacheDomain::ARIA && mContent && mContent->IsElement()) {
// We use a nested AccAttributes to make cache updates simpler. Rather than
// managing individual removals, we just replace or remove the entire set of
// ARIA attributes.
RefPtr<AccAttributes> ariaAttrs;
aria::AttrIterator attrIt(mContent);
while (attrIt.Next()) {
if (!ariaAttrs) {
ariaAttrs = new AccAttributes();
}
attrIt.ExposeAttr(ariaAttrs);
}
if (ariaAttrs) {
fields->SetAttribute(nsGkAtoms::aria, std::move(ariaAttrs));
} else if (aUpdateType == CacheUpdateType::Update) {
fields->SetAttribute(nsGkAtoms::aria, DeleteEntry());
}
}
if (aCacheDomain & CacheDomain::Relations && mContent) {
if (IsHTMLRadioButton() ||
(mContent->IsElement() &&
mContent->AsElement()->IsHTMLElement(nsGkAtoms::a))) {
// HTML radio buttons with the same name should be grouped
// and returned together when their MEMBER_OF relation is
// requested. Computing LINKS_TO also requires we cache `name` on
// anchor elements.
nsString name;
mContent->AsElement()->GetAttr(kNameSpaceID_None, nsGkAtoms::name, name);
if (!name.IsEmpty()) {
fields->SetAttribute(nsGkAtoms::attributeName, std::move(name));
} else if (aUpdateType != CacheUpdateType::Initial) {
// It's possible we used to have a name and it's since been
// removed. Send a delete entry.
fields->SetAttribute(nsGkAtoms::attributeName, DeleteEntry());
}
}
for (auto const& data : kRelationTypeAtoms) {
nsTArray<uint64_t> ids;
nsStaticAtom* const relAtom = data.mAtom;
Relation rel;
if (data.mType == RelationType::LABEL_FOR) {
// Labels are a special case -- we need to validate that the target of
// their `for` attribute is in fact labelable. DOM checks this when we
// call GetControl(). If a label contains an element we will return it
// here.
if (dom::HTMLLabelElement* labelEl =
dom::HTMLLabelElement::FromNode(mContent)) {
rel.AppendTarget(mDoc, labelEl->GetControl());
}
} else {
// We use an IDRefsIterator here instead of calling RelationByType
// directly because we only want to cache explicit relations. Implicit
// relations will be computed and stored separately in the parent
// process.
rel.AppendIter(new IDRefsIterator(mDoc, mContent, relAtom));
}
while (LocalAccessible* acc = rel.LocalNext()) {
ids.AppendElement(acc->ID());
}
if (ids.Length()) {
fields->SetAttribute(relAtom, std::move(ids));
} else if (aUpdateType == CacheUpdateType::Update) {
fields->SetAttribute(relAtom, DeleteEntry());
}
}
}
#if defined(XP_WIN)
if (aCacheDomain & CacheDomain::InnerHTML && HasOwnContent() &&
mContent->IsMathMLElement(nsGkAtoms::math)) {
nsString innerHTML;
mContent->AsElement()->GetInnerHTML(innerHTML, IgnoreErrors());
fields->SetAttribute(nsGkAtoms::html, std::move(innerHTML));
}
#endif // defined(XP_WIN)
if (aUpdateType == CacheUpdateType::Initial) {
// Add fields which never change and thus only need to be included in the
// initial cache push.
if (mContent && mContent->IsElement()) {
fields->SetAttribute(nsGkAtoms::tag, mContent->NodeInfo()->NameAtom());
dom::Element* el = mContent->AsElement();
if (IsTextField() || IsDateTimeField()) {
// Cache text input types. Accessible is recreated if this changes,
// so it is considered immutable.
if (const nsAttrValue* attr = el->GetParsedAttr(nsGkAtoms::type)) {
RefPtr<nsAtom> inputType = attr->GetAsAtom();
if (inputType) {
fields->SetAttribute(nsGkAtoms::textInputType, inputType);
}
}
}
// Changing the role attribute currently re-creates the Accessible, so
// it's immutable in the cache.
if (const nsRoleMapEntry* roleMap = ARIARoleMap()) {
// Most of the time, the role attribute is a single, known role. We
// already send the map index, so we don't need to double up.
if (!nsAccUtils::ARIAAttrValueIs(el, nsGkAtoms::role, roleMap->roleAtom,
eIgnoreCase)) {
// Multiple roles or unknown roles are rare, so just send them as a
// string.
nsAutoString role;
nsAccUtils::GetARIAAttr(el, nsGkAtoms::role, role);
fields->SetAttribute(nsGkAtoms::role, std::move(role));
}
}
}
if (frame) {
// Note our frame's current computed style so we can track style changes
// later on.
mOldComputedStyle = frame->Style();
if (frame->IsTransformed()) {
mStateFlags |= eOldFrameHasValidTransformStyle;
} else {
mStateFlags &= ~eOldFrameHasValidTransformStyle;
}
}
if (IsDoc()) {
if (PresShell* presShell = AsDoc()->PresShellPtr()) {
// Send the initial resolution of the document. When this changes, we
// will ne notified via nsAS::NotifyOfResolutionChange
float resolution = presShell->GetResolution();
fields->SetAttribute(nsGkAtoms::resolution, resolution);
int32_t appUnitsPerDevPixel =
presShell->GetPresContext()->AppUnitsPerDevPixel();
fields->SetAttribute(nsGkAtoms::_moz_device_pixel_ratio,
appUnitsPerDevPixel);
}
}
}
if ((aCacheDomain & (CacheDomain::Text | CacheDomain::ScrollPosition) ||
boundsChanged) &&
mDoc) {
mDoc->SetViewportCacheDirty(true);
}
return fields.forget();
}
void LocalAccessible::MaybeQueueCacheUpdateForStyleChanges() {
// mOldComputedStyle might be null if the initial cache hasn't been sent yet.
// In that case, there is nothing to do here.
if (!IPCAccessibilityActive() ||
!StaticPrefs::accessibility_cache_enabled_AtStartup() ||
!mOldComputedStyle) {
return;
}
if (nsIFrame* frame = GetFrame()) {
const ComputedStyle* newStyle = frame->Style();
nsAutoCString oldDisplay, newDisplay;
mOldComputedStyle->GetComputedPropertyValue(eCSSProperty_display,
oldDisplay);
newStyle->GetComputedPropertyValue(eCSSProperty_display, newDisplay);
nsAutoCString oldOpacity, newOpacity;
mOldComputedStyle->GetComputedPropertyValue(eCSSProperty_opacity,
oldOpacity);
newStyle->GetComputedPropertyValue(eCSSProperty_opacity, newOpacity);
if (oldDisplay != newDisplay || oldOpacity != newOpacity) {
// CacheDomain::Style covers both display and opacity, so if
// either property has changed, send an update for the entire domain.
mDoc->QueueCacheUpdate(this, CacheDomain::Style);
}
bool newHasValidTransformStyle =
newStyle->StyleDisplay()->HasTransform(frame);
bool oldHasValidTransformStyle =
(mStateFlags & eOldFrameHasValidTransformStyle) != 0;
// We should send a transform update if we're adding or
// removing transform styling altogether.
bool sendTransformUpdate =
newHasValidTransformStyle || oldHasValidTransformStyle;
if (newHasValidTransformStyle && oldHasValidTransformStyle) {
// If we continue to have transform styling, verify
// our transform has actually changed.
nsChangeHint transformHint =
newStyle->StyleDisplay()->CalcTransformPropertyDifference(
*mOldComputedStyle->StyleDisplay());
// If this hint exists, it implies we found a property difference
sendTransformUpdate = !!transformHint;
}
if (sendTransformUpdate) {
// If our transform matrix has changed, it's possible our
// viewport cache has also changed.
mDoc->SetViewportCacheDirty(true);
// Queuing a cache update for the TransformMatrix domain doesn't
// necessarily mean we'll send the matrix itself, we may
// send a DeleteEntry() instead. See BundleFieldsForCache for
// more information.
mDoc->QueueCacheUpdate(this, CacheDomain::TransformMatrix);
}
if (newStyle->StyleDisplay()->IsPositionedStyle()) {
// We normally rely on reflow to know when bounds might have changed.
// However, changing the CSS left, top, etc. properties doesn't always
// cause reflow.
for (auto prop : {eCSSProperty_left, eCSSProperty_right, eCSSProperty_top,
eCSSProperty_bottom}) {
nsAutoCString oldVal, newVal;
mOldComputedStyle->GetComputedPropertyValue(prop, oldVal);
newStyle->GetComputedPropertyValue(prop, newVal);
if (oldVal != newVal) {
mDoc->QueueCacheUpdate(this, CacheDomain::Bounds);
break;
}
}
}
mOldComputedStyle = newStyle;
if (newHasValidTransformStyle) {
mStateFlags |= eOldFrameHasValidTransformStyle;
} else {
mStateFlags &= ~eOldFrameHasValidTransformStyle;
}
}
}
nsAtom* LocalAccessible::TagName() const {
return mContent && mContent->IsElement() ? mContent->NodeInfo()->NameAtom()
: nullptr;
}
already_AddRefed<nsAtom> LocalAccessible::DisplayStyle() const {
if (dom::Element* elm = Elm()) {
if (elm->IsHTMLElement(nsGkAtoms::area)) {
// This is an image map area. CSS is irrelevant here. Furthermore, we
// won't be able to get the computed style if the map is unslotted in a
// shadow host.
return nullptr;
}
StyleInfo info(elm);
return info.Display();
}
return nullptr;
}
float LocalAccessible::Opacity() const {
if (nsIFrame* frame = GetFrame()) {
return frame->StyleEffects()->mOpacity;
}
return 1.0f;
}
void LocalAccessible::DOMNodeID(nsString& aID) const {
aID.Truncate();
if (mContent) {
if (nsAtom* id = mContent->GetID()) {
id->ToString(aID);
}
}
}
void LocalAccessible::LiveRegionAttributes(nsAString* aLive,
nsAString* aRelevant,
Maybe<bool>* aAtomic,
nsAString* aBusy) const {
dom::Element* el = Elm();
if (!el) {
return;
}
if (aLive) {
nsAccUtils::GetARIAAttr(el, nsGkAtoms::aria_live, *aLive);
}
if (aRelevant) {
nsAccUtils::GetARIAAttr(el, nsGkAtoms::aria_relevant, *aRelevant);
}
if (aAtomic) {
// XXX We ignore aria-atomic="false", but this probably doesn't conform to
// the spec.
if (nsAccUtils::ARIAAttrValueIs(el, nsGkAtoms::aria_atomic,
nsGkAtoms::_true, eCaseMatters)) {
*aAtomic = Some(true);
}
}
if (aBusy) {
nsAccUtils::GetARIAAttr(el, nsGkAtoms::aria_busy, *aBusy);
}
}
Maybe<bool> LocalAccessible::ARIASelected() const {
if (dom::Element* el = Elm()) {
nsStaticAtom* atom =
nsAccUtils::NormalizeARIAToken(el, nsGkAtoms::aria_selected);
if (atom == nsGkAtoms::_true) {
return Some(true);
}
if (atom == nsGkAtoms::_false) {
return Some(false);
}
}
return Nothing();
}
void LocalAccessible::StaticAsserts() const {
static_assert(
eLastStateFlag <= (1 << kStateFlagsBits) - 1,
"LocalAccessible::mStateFlags was oversized by eLastStateFlag!");
static_assert(
eLastContextFlag <= (1 << kContextFlagsBits) - 1,
"LocalAccessible::mContextFlags was oversized by eLastContextFlag!");
}
TableAccessibleBase* LocalAccessible::AsTableBase() {
if (StaticPrefs::accessibility_cache_enabled_AtStartup() && IsTable() &&
!mContent->IsXULElement()) {
// This isn't strictly related to caching, but this new table implementation
// is being developed to make caching feasible. We put it behind this pref
// to make it easy to test while it's still under development.
return CachedTableAccessible::GetFrom(this);
}
return AsTable();
}
TableCellAccessibleBase* LocalAccessible::AsTableCellBase() {
if (StaticPrefs::accessibility_cache_enabled_AtStartup() && IsTableCell() &&
!mContent->IsXULElement()) {
// This isn't strictly related to caching, but this new table implementation
// is being developed to make caching feasible. We put it behind this pref
// to make it easy to test while it's still under development.
return CachedTableCellAccessible::GetFrom(this);
}
return AsTableCell();
}
Maybe<int32_t> LocalAccessible::GetIntARIAAttr(nsAtom* aAttrName) const {
if (mContent) {
int32_t val;
if (nsCoreUtils::GetUIntAttr(mContent, aAttrName, &val)) {
return Some(val);
}
// XXX Handle attributes that allow -1; e.g. aria-row/colcount.
}
return Nothing();
}
|