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
|
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=2 et sw=2 tw=80: */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#include "AccessibleWrap.h"
#include "LocalAccessible-inl.h"
#include "AccAttributes.h"
#include "ApplicationAccessibleWrap.h"
#include "InterfaceInitFuncs.h"
#include "nsAccUtils.h"
#include "mozilla/a11y/PDocAccessible.h"
#include "OuterDocAccessible.h"
#include "RemoteAccessible.h"
#include "DocAccessibleParent.h"
#include "RootAccessible.h"
#include "mozilla/a11y/TableAccessibleBase.h"
#include "mozilla/a11y/TableCellAccessibleBase.h"
#include "nsMai.h"
#include "nsMaiHyperlink.h"
#include "nsString.h"
#include "nsStateMap.h"
#include "mozilla/a11y/Platform.h"
#include "Relation.h"
#include "RootAccessible.h"
#include "States.h"
#include "nsISimpleEnumerator.h"
#include "mozilla/ArrayUtils.h"
#include "mozilla/Sprintf.h"
#include "mozilla/StaticPrefs_accessibility.h"
#include "nsComponentManagerUtils.h"
using namespace mozilla;
using namespace mozilla::a11y;
MaiAtkObject::EAvailableAtkSignals MaiAtkObject::gAvailableAtkSignals =
eUnknown;
// defined in ApplicationAccessibleWrap.cpp
extern "C" GType g_atk_hyperlink_impl_type;
/* MaiAtkObject */
enum {
ACTIVATE,
CREATE,
DEACTIVATE,
DESTROY,
MAXIMIZE,
MINIMIZE,
RESIZE,
RESTORE,
LAST_SIGNAL
};
enum MaiInterfaceType {
MAI_INTERFACE_COMPONENT, /* 0 */
MAI_INTERFACE_ACTION,
MAI_INTERFACE_VALUE,
MAI_INTERFACE_EDITABLE_TEXT,
MAI_INTERFACE_HYPERTEXT,
MAI_INTERFACE_HYPERLINK_IMPL,
MAI_INTERFACE_SELECTION,
MAI_INTERFACE_TABLE,
MAI_INTERFACE_TEXT,
MAI_INTERFACE_DOCUMENT,
MAI_INTERFACE_IMAGE, /* 10 */
MAI_INTERFACE_TABLE_CELL
};
static GType GetAtkTypeForMai(MaiInterfaceType type) {
switch (type) {
case MAI_INTERFACE_COMPONENT:
return ATK_TYPE_COMPONENT;
case MAI_INTERFACE_ACTION:
return ATK_TYPE_ACTION;
case MAI_INTERFACE_VALUE:
return ATK_TYPE_VALUE;
case MAI_INTERFACE_EDITABLE_TEXT:
return ATK_TYPE_EDITABLE_TEXT;
case MAI_INTERFACE_HYPERTEXT:
return ATK_TYPE_HYPERTEXT;
case MAI_INTERFACE_HYPERLINK_IMPL:
return g_atk_hyperlink_impl_type;
case MAI_INTERFACE_SELECTION:
return ATK_TYPE_SELECTION;
case MAI_INTERFACE_TABLE:
return ATK_TYPE_TABLE;
case MAI_INTERFACE_TEXT:
return ATK_TYPE_TEXT;
case MAI_INTERFACE_DOCUMENT:
return ATK_TYPE_DOCUMENT;
case MAI_INTERFACE_IMAGE:
return ATK_TYPE_IMAGE;
case MAI_INTERFACE_TABLE_CELL:
MOZ_ASSERT(false);
}
return G_TYPE_INVALID;
}
#define NON_USER_EVENT ":system"
// The atk interfaces we can expose without checking what version of ATK we are
// dealing with. At the moment AtkTableCell is the only interface we can't
// always expose.
static const GInterfaceInfo atk_if_infos[] = {
{(GInterfaceInitFunc)componentInterfaceInitCB,
(GInterfaceFinalizeFunc) nullptr, nullptr},
{(GInterfaceInitFunc)actionInterfaceInitCB,
(GInterfaceFinalizeFunc) nullptr, nullptr},
{(GInterfaceInitFunc)valueInterfaceInitCB, (GInterfaceFinalizeFunc) nullptr,
nullptr},
{(GInterfaceInitFunc)editableTextInterfaceInitCB,
(GInterfaceFinalizeFunc) nullptr, nullptr},
{(GInterfaceInitFunc)hypertextInterfaceInitCB,
(GInterfaceFinalizeFunc) nullptr, nullptr},
{(GInterfaceInitFunc)hyperlinkImplInterfaceInitCB,
(GInterfaceFinalizeFunc) nullptr, nullptr},
{(GInterfaceInitFunc)selectionInterfaceInitCB,
(GInterfaceFinalizeFunc) nullptr, nullptr},
{(GInterfaceInitFunc)tableInterfaceInitCB, (GInterfaceFinalizeFunc) nullptr,
nullptr},
{(GInterfaceInitFunc)textInterfaceInitCB, (GInterfaceFinalizeFunc) nullptr,
nullptr},
{(GInterfaceInitFunc)documentInterfaceInitCB,
(GInterfaceFinalizeFunc) nullptr, nullptr},
{(GInterfaceInitFunc)imageInterfaceInitCB, (GInterfaceFinalizeFunc) nullptr,
nullptr}};
static GQuark quark_mai_hyperlink = 0;
AtkHyperlink* MaiAtkObject::GetAtkHyperlink() {
NS_ASSERTION(quark_mai_hyperlink, "quark_mai_hyperlink not initialized");
MaiHyperlink* maiHyperlink =
(MaiHyperlink*)g_object_get_qdata(G_OBJECT(this), quark_mai_hyperlink);
if (!maiHyperlink) {
maiHyperlink = new MaiHyperlink(acc);
g_object_set_qdata(G_OBJECT(this), quark_mai_hyperlink, maiHyperlink);
}
return maiHyperlink->GetAtkHyperlink();
}
void MaiAtkObject::Shutdown() {
acc = nullptr;
MaiHyperlink* maiHyperlink =
(MaiHyperlink*)g_object_get_qdata(G_OBJECT(this), quark_mai_hyperlink);
if (maiHyperlink) {
delete maiHyperlink;
g_object_set_qdata(G_OBJECT(this), quark_mai_hyperlink, nullptr);
}
}
struct MaiAtkObjectClass {
AtkObjectClass parent_class;
};
static guint mai_atk_object_signals[LAST_SIGNAL] = {
0,
};
static void MaybeFireNameChange(AtkObject* aAtkObj, const nsString& aNewName);
G_BEGIN_DECLS
/* callbacks for MaiAtkObject */
static void classInitCB(AtkObjectClass* aClass);
static void initializeCB(AtkObject* aAtkObj, gpointer aData);
static void finalizeCB(GObject* aObj);
/* callbacks for AtkObject virtual functions */
static const gchar* getNameCB(AtkObject* aAtkObj);
/* getDescriptionCB is also used by image interface */
const gchar* getDescriptionCB(AtkObject* aAtkObj);
static AtkRole getRoleCB(AtkObject* aAtkObj);
static AtkAttributeSet* getAttributesCB(AtkObject* aAtkObj);
static const gchar* GetLocaleCB(AtkObject*);
static AtkObject* getParentCB(AtkObject* aAtkObj);
static gint getChildCountCB(AtkObject* aAtkObj);
static AtkObject* refChildCB(AtkObject* aAtkObj, gint aChildIndex);
static gint getIndexInParentCB(AtkObject* aAtkObj);
static AtkStateSet* refStateSetCB(AtkObject* aAtkObj);
static AtkRelationSet* refRelationSetCB(AtkObject* aAtkObj);
/* the missing atkobject virtual functions */
/*
static AtkLayer getLayerCB(AtkObject *aAtkObj);
static gint getMdiZorderCB(AtkObject *aAtkObj);
static void SetNameCB(AtkObject *aAtkObj,
const gchar *name);
static void SetDescriptionCB(AtkObject *aAtkObj,
const gchar *description);
static void SetParentCB(AtkObject *aAtkObj,
AtkObject *parent);
static void SetRoleCB(AtkObject *aAtkObj,
AtkRole role);
static guint ConnectPropertyChangeHandlerCB(
AtkObject *aObj,
AtkPropertyChangeHandler *handler);
static void RemovePropertyChangeHandlerCB(
AtkObject *aAtkObj,
guint handler_id);
static void InitializeCB(AtkObject *aAtkObj,
gpointer data);
static void ChildrenChangedCB(AtkObject *aAtkObj,
guint change_index,
gpointer changed_child);
static void FocusEventCB(AtkObject *aAtkObj,
gboolean focus_in);
static void PropertyChangeCB(AtkObject *aAtkObj,
AtkPropertyValues *values);
static void StateChangeCB(AtkObject *aAtkObj,
const gchar *name,
gboolean state_set);
static void VisibleDataChangedCB(AtkObject *aAtkObj);
*/
G_END_DECLS
static GType GetMaiAtkType(uint16_t interfacesBits);
static const char* GetUniqueMaiAtkTypeName(uint16_t interfacesBits);
static gpointer parent_class = nullptr;
GType mai_atk_object_get_type(void) {
static GType type = 0;
if (!type) {
static const GTypeInfo tinfo = {
sizeof(MaiAtkObjectClass),
(GBaseInitFunc) nullptr,
(GBaseFinalizeFunc) nullptr,
(GClassInitFunc)classInitCB,
(GClassFinalizeFunc) nullptr,
nullptr, /* class data */
sizeof(MaiAtkObject), /* instance size */
0, /* nb preallocs */
(GInstanceInitFunc) nullptr,
nullptr /* value table */
};
type = g_type_register_static(ATK_TYPE_OBJECT, "MaiAtkObject", &tinfo,
GTypeFlags(0));
quark_mai_hyperlink = g_quark_from_static_string("MaiHyperlink");
}
return type;
}
AccessibleWrap::AccessibleWrap(nsIContent* aContent, DocAccessible* aDoc)
: LocalAccessible(aContent, aDoc), mAtkObject(nullptr) {}
AccessibleWrap::~AccessibleWrap() {
NS_ASSERTION(!mAtkObject, "ShutdownAtkObject() is not called");
}
void AccessibleWrap::ShutdownAtkObject() {
if (!mAtkObject) return;
NS_ASSERTION(IS_MAI_OBJECT(mAtkObject), "wrong type of atk object");
if (IS_MAI_OBJECT(mAtkObject)) MAI_ATK_OBJECT(mAtkObject)->Shutdown();
g_object_unref(mAtkObject);
mAtkObject = nullptr;
}
void AccessibleWrap::Shutdown() {
ShutdownAtkObject();
LocalAccessible::Shutdown();
}
void AccessibleWrap::GetNativeInterface(void** aOutAccessible) {
*aOutAccessible = nullptr;
if (!mAtkObject) {
if (IsDefunct() || IsText()) {
// We don't create ATK objects for node which has been shutdown or
// plain text leaves
return;
}
GType type = GetMaiAtkType(CreateMaiInterfaces());
if (!type) return;
mAtkObject = reinterpret_cast<AtkObject*>(g_object_new(type, nullptr));
if (!mAtkObject) return;
atk_object_initialize(mAtkObject, static_cast<Accessible*>(this));
mAtkObject->role = ATK_ROLE_INVALID;
mAtkObject->layer = ATK_LAYER_INVALID;
}
*aOutAccessible = mAtkObject;
}
AtkObject* AccessibleWrap::GetAtkObject(void) {
void* atkObj = nullptr;
GetNativeInterface(&atkObj);
return static_cast<AtkObject*>(atkObj);
}
// Get AtkObject from LocalAccessible interface
/* static */
AtkObject* AccessibleWrap::GetAtkObject(LocalAccessible* acc) {
void* atkObjPtr = nullptr;
acc->GetNativeInterface(&atkObjPtr);
return atkObjPtr ? ATK_OBJECT(atkObjPtr) : nullptr;
}
/* private */
uint16_t AccessibleWrap::CreateMaiInterfaces(void) {
uint16_t interfacesBits = 0;
// The Component interface is supported by all accessibles.
interfacesBits |= 1 << MAI_INTERFACE_COMPONENT;
// Add Action interface if the action count is more than zero.
if (ActionCount() > 0) interfacesBits |= 1 << MAI_INTERFACE_ACTION;
// Text, Editabletext, and Hypertext interface.
HyperTextAccessible* hyperText = AsHyperText();
if (hyperText && hyperText->IsTextRole()) {
interfacesBits |= 1 << MAI_INTERFACE_TEXT;
interfacesBits |= 1 << MAI_INTERFACE_EDITABLE_TEXT;
if (!nsAccUtils::MustPrune(this)) {
interfacesBits |= 1 << MAI_INTERFACE_HYPERTEXT;
}
}
// Value interface.
if (HasNumericValue()) interfacesBits |= 1 << MAI_INTERFACE_VALUE;
// Document interface.
if (IsDoc()) interfacesBits |= 1 << MAI_INTERFACE_DOCUMENT;
if (IsImage()) interfacesBits |= 1 << MAI_INTERFACE_IMAGE;
// HyperLink interface.
if (IsLink()) interfacesBits |= 1 << MAI_INTERFACE_HYPERLINK_IMPL;
if (!nsAccUtils::MustPrune(this)) { // These interfaces require children
// Table interface.
if (AsTable()) interfacesBits |= 1 << MAI_INTERFACE_TABLE;
if (AsTableCell()) interfacesBits |= 1 << MAI_INTERFACE_TABLE_CELL;
// Selection interface.
if (IsSelect()) {
interfacesBits |= 1 << MAI_INTERFACE_SELECTION;
}
}
return interfacesBits;
}
static GType GetMaiAtkType(uint16_t interfacesBits) {
GType type;
static const GTypeInfo tinfo = {
sizeof(MaiAtkObjectClass),
(GBaseInitFunc) nullptr,
(GBaseFinalizeFunc) nullptr,
(GClassInitFunc) nullptr,
(GClassFinalizeFunc) nullptr,
nullptr, /* class data */
sizeof(MaiAtkObject), /* instance size */
0, /* nb preallocs */
(GInstanceInitFunc) nullptr,
nullptr /* value table */
};
/*
* The members we use to register GTypes are GetAtkTypeForMai
* and atk_if_infos, which are constant values to each MaiInterface
* So we can reuse the registered GType when having
* the same MaiInterface types.
*/
const char* atkTypeName = GetUniqueMaiAtkTypeName(interfacesBits);
type = g_type_from_name(atkTypeName);
if (type) {
return type;
}
/*
* gobject limits the number of types that can directly derive from any
* given object type to 4095.
*/
static uint16_t typeRegCount = 0;
if (typeRegCount++ >= 4095) {
return G_TYPE_INVALID;
}
type = g_type_register_static(MAI_TYPE_ATK_OBJECT, atkTypeName, &tinfo,
GTypeFlags(0));
for (uint32_t index = 0; index < ArrayLength(atk_if_infos); index++) {
if (interfacesBits & (1 << index)) {
g_type_add_interface_static(type,
GetAtkTypeForMai((MaiInterfaceType)index),
&atk_if_infos[index]);
}
}
// Special case AtkTableCell so we can check what version of Atk we are
// dealing with.
if (IsAtkVersionAtLeast(2, 12) &&
(interfacesBits & (1 << MAI_INTERFACE_TABLE_CELL))) {
const GInterfaceInfo cellInfo = {
(GInterfaceInitFunc)tableCellInterfaceInitCB,
(GInterfaceFinalizeFunc) nullptr, nullptr};
g_type_add_interface_static(type, gAtkTableCellGetTypeFunc(), &cellInfo);
}
return type;
}
static const char* GetUniqueMaiAtkTypeName(uint16_t interfacesBits) {
#define MAI_ATK_TYPE_NAME_LEN (30) /* 10+sizeof(uint16_t)*8/4+1 < 30 */
static gchar namePrefix[] = "MaiAtkType"; /* size = 10 */
static gchar name[MAI_ATK_TYPE_NAME_LEN + 1];
SprintfLiteral(name, "%s%x", namePrefix, interfacesBits);
name[MAI_ATK_TYPE_NAME_LEN] = '\0';
return name;
}
bool AccessibleWrap::IsValidObject() {
// to ensure we are not shut down
return !IsDefunct();
}
/* static functions for ATK callbacks */
void classInitCB(AtkObjectClass* aClass) {
GObjectClass* gobject_class = G_OBJECT_CLASS(aClass);
parent_class = g_type_class_peek_parent(aClass);
aClass->get_name = getNameCB;
aClass->get_description = getDescriptionCB;
aClass->get_parent = getParentCB;
aClass->get_n_children = getChildCountCB;
aClass->ref_child = refChildCB;
aClass->get_index_in_parent = getIndexInParentCB;
aClass->get_role = getRoleCB;
aClass->get_attributes = getAttributesCB;
aClass->get_object_locale = GetLocaleCB;
aClass->ref_state_set = refStateSetCB;
aClass->ref_relation_set = refRelationSetCB;
aClass->initialize = initializeCB;
gobject_class->finalize = finalizeCB;
mai_atk_object_signals[ACTIVATE] = g_signal_new(
"activate", MAI_TYPE_ATK_OBJECT, G_SIGNAL_RUN_LAST,
0, /* default signal handler */
nullptr, nullptr, g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
mai_atk_object_signals[CREATE] = g_signal_new(
"create", MAI_TYPE_ATK_OBJECT, G_SIGNAL_RUN_LAST,
0, /* default signal handler */
nullptr, nullptr, g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
mai_atk_object_signals[DEACTIVATE] = g_signal_new(
"deactivate", MAI_TYPE_ATK_OBJECT, G_SIGNAL_RUN_LAST,
0, /* default signal handler */
nullptr, nullptr, g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
mai_atk_object_signals[DESTROY] = g_signal_new(
"destroy", MAI_TYPE_ATK_OBJECT, G_SIGNAL_RUN_LAST,
0, /* default signal handler */
nullptr, nullptr, g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
mai_atk_object_signals[MAXIMIZE] = g_signal_new(
"maximize", MAI_TYPE_ATK_OBJECT, G_SIGNAL_RUN_LAST,
0, /* default signal handler */
nullptr, nullptr, g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
mai_atk_object_signals[MINIMIZE] = g_signal_new(
"minimize", MAI_TYPE_ATK_OBJECT, G_SIGNAL_RUN_LAST,
0, /* default signal handler */
nullptr, nullptr, g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
mai_atk_object_signals[RESIZE] = g_signal_new(
"resize", MAI_TYPE_ATK_OBJECT, G_SIGNAL_RUN_LAST,
0, /* default signal handler */
nullptr, nullptr, g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
mai_atk_object_signals[RESTORE] = g_signal_new(
"restore", MAI_TYPE_ATK_OBJECT, G_SIGNAL_RUN_LAST,
0, /* default signal handler */
nullptr, nullptr, g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
}
void initializeCB(AtkObject* aAtkObj, gpointer aData) {
NS_ASSERTION((IS_MAI_OBJECT(aAtkObj)), "Invalid AtkObject");
NS_ASSERTION(aData, "Invalid Data to init AtkObject");
if (!aAtkObj || !aData) return;
/* call parent init function */
/* AtkObjectClass has not a "initialize" function now,
* maybe it has later
*/
if (ATK_OBJECT_CLASS(parent_class)->initialize) {
ATK_OBJECT_CLASS(parent_class)->initialize(aAtkObj, aData);
}
/* initialize object */
MAI_ATK_OBJECT(aAtkObj)->acc = static_cast<Accessible*>(aData);
}
void finalizeCB(GObject* aObj) {
if (!IS_MAI_OBJECT(aObj)) return;
NS_ASSERTION(!MAI_ATK_OBJECT(aObj)->acc, "acc NOT null");
// call parent finalize function
// finalize of GObjectClass will unref the accessible parent if has
if (G_OBJECT_CLASS(parent_class)->finalize) {
G_OBJECT_CLASS(parent_class)->finalize(aObj);
}
}
const gchar* getNameCB(AtkObject* aAtkObj) {
nsAutoString name;
if (Accessible* acc = GetInternalObj(aAtkObj)) {
acc->Name(name);
} else {
return nullptr;
}
// XXX Firing an event from here does not seem right
MaybeFireNameChange(aAtkObj, name);
return aAtkObj->name;
}
static void MaybeFireNameChange(AtkObject* aAtkObj, const nsString& aNewName) {
NS_ConvertUTF16toUTF8 newNameUTF8(aNewName);
if (aAtkObj->name && !strcmp(aAtkObj->name, newNameUTF8.get())) return;
// Below we duplicate the functionality of atk_object_set_name(),
// but without calling atk_object_get_name(). Instead of
// atk_object_get_name() we directly access aAtkObj->name. This is because
// atk_object_get_name() would call getNameCB() which would call
// MaybeFireNameChange() (or atk_object_set_name() before this problem was
// fixed) and we would get an infinite recursion.
// See http://bugzilla.mozilla.org/733712
// Do not notify for initial name setting.
// See bug http://bugzilla.gnome.org/665870
bool notify = !!aAtkObj->name;
free(aAtkObj->name);
aAtkObj->name = strdup(newNameUTF8.get());
if (notify) g_object_notify(G_OBJECT(aAtkObj), "accessible-name");
}
const gchar* getDescriptionCB(AtkObject* aAtkObj) {
nsAutoString uniDesc;
if (Accessible* acc = GetInternalObj(aAtkObj)) {
acc->Description(uniDesc);
} else {
return nullptr;
}
NS_ConvertUTF8toUTF16 objDesc(aAtkObj->description);
if (!uniDesc.Equals(objDesc)) {
atk_object_set_description(aAtkObj, NS_ConvertUTF16toUTF8(uniDesc).get());
}
return aAtkObj->description;
}
AtkRole getRoleCB(AtkObject* aAtkObj) {
if (aAtkObj->role != ATK_ROLE_INVALID) return aAtkObj->role;
Accessible* acc = GetInternalObj(aAtkObj);
if (!acc) {
return ATK_ROLE_INVALID;
}
#ifdef DEBUG
if (AccessibleWrap* accWrap = GetAccessibleWrap(aAtkObj)) {
NS_ASSERTION(nsAccUtils::IsTextInterfaceSupportCorrect(accWrap),
"Does not support Text interface when it should");
}
#endif
#define ROLE(geckoRole, stringRole, atkRole, macRole, macSubrole, msaaRole, \
ia2Role, androidClass, nameRule) \
case roles::geckoRole: \
aAtkObj->role = atkRole; \
break;
switch (acc->Role()) {
#include "RoleMap.h"
default:
MOZ_CRASH("Unknown role.");
}
#undef ROLE
if (aAtkObj->role == ATK_ROLE_LIST_BOX && !IsAtkVersionAtLeast(2, 1)) {
aAtkObj->role = ATK_ROLE_LIST;
} else if (aAtkObj->role == ATK_ROLE_TABLE_ROW &&
!IsAtkVersionAtLeast(2, 1)) {
aAtkObj->role = ATK_ROLE_LIST_ITEM;
} else if (aAtkObj->role == ATK_ROLE_MATH && !IsAtkVersionAtLeast(2, 12)) {
aAtkObj->role = ATK_ROLE_SECTION;
} else if (aAtkObj->role == ATK_ROLE_COMMENT && !IsAtkVersionAtLeast(2, 12)) {
aAtkObj->role = ATK_ROLE_SECTION;
} else if (aAtkObj->role == ATK_ROLE_LANDMARK &&
!IsAtkVersionAtLeast(2, 12)) {
aAtkObj->role = ATK_ROLE_SECTION;
} else if (aAtkObj->role == ATK_ROLE_FOOTNOTE &&
!IsAtkVersionAtLeast(2, 25, 2)) {
aAtkObj->role = ATK_ROLE_SECTION;
} else if (aAtkObj->role == ATK_ROLE_STATIC && !IsAtkVersionAtLeast(2, 16)) {
aAtkObj->role = ATK_ROLE_TEXT;
} else if ((aAtkObj->role == ATK_ROLE_MATH_FRACTION ||
aAtkObj->role == ATK_ROLE_MATH_ROOT) &&
!IsAtkVersionAtLeast(2, 16)) {
aAtkObj->role = ATK_ROLE_SECTION;
} else if (aAtkObj->role == ATK_ROLE_MARK && !IsAtkVersionAtLeast(2, 36)) {
aAtkObj->role = ATK_ROLE_TEXT;
} else if (aAtkObj->role == ATK_ROLE_SUGGESTION &&
!IsAtkVersionAtLeast(2, 36)) {
aAtkObj->role = ATK_ROLE_SECTION;
} else if (aAtkObj->role == ATK_ROLE_COMMENT && !IsAtkVersionAtLeast(2, 36)) {
aAtkObj->role = ATK_ROLE_SECTION;
} else if ((aAtkObj->role == ATK_ROLE_CONTENT_DELETION ||
aAtkObj->role == ATK_ROLE_CONTENT_INSERTION) &&
!IsAtkVersionAtLeast(2, 34)) {
aAtkObj->role = ATK_ROLE_SECTION;
}
return aAtkObj->role;
}
static AtkAttributeSet* ConvertToAtkAttributeSet(AccAttributes* aAttributes) {
if (!aAttributes) {
return nullptr;
}
AtkAttributeSet* objAttributeSet = nullptr;
for (auto iter : *aAttributes) {
nsAutoString name;
iter.NameAsString(name);
if (name.Equals(u"placeholder")) {
name.AssignLiteral(u"placeholder-text");
}
nsAutoString value;
iter.ValueAsString(value);
AtkAttribute* objAttr = (AtkAttribute*)g_malloc(sizeof(AtkAttribute));
objAttr->name = g_strdup(NS_ConvertUTF16toUTF8(name).get());
objAttr->value = g_strdup(NS_ConvertUTF16toUTF8(value).get());
objAttributeSet = g_slist_prepend(objAttributeSet, objAttr);
}
// libspi will free it
return objAttributeSet;
}
AtkAttributeSet* getAttributesCB(AtkObject* aAtkObj) {
Accessible* acc = GetInternalObj(aAtkObj);
if (!acc) {
return nullptr;
}
RefPtr<AccAttributes> attributes = acc->Attributes();
return ConvertToAtkAttributeSet(attributes);
}
const gchar* GetLocaleCB(AtkObject* aAtkObj) {
AccessibleWrap* accWrap = GetAccessibleWrap(aAtkObj);
if (!accWrap) return nullptr;
nsAutoString locale;
accWrap->Language(locale);
return AccessibleWrap::ReturnString(locale);
}
AtkObject* getParentCB(AtkObject* aAtkObj) {
if (aAtkObj->accessible_parent) return aAtkObj->accessible_parent;
Accessible* acc = GetInternalObj(aAtkObj);
if (!acc) {
return nullptr;
}
Accessible* parent = acc->Parent();
AtkObject* atkParent = parent ? GetWrapperFor(parent) : nullptr;
if (atkParent) atk_object_set_parent(aAtkObj, atkParent);
return aAtkObj->accessible_parent;
}
gint getChildCountCB(AtkObject* aAtkObj) {
Accessible* acc = GetInternalObj(aAtkObj);
if (!acc || nsAccUtils::MustPrune(acc)) {
return 0;
}
return static_cast<gint>(acc->EmbeddedChildCount());
}
AtkObject* refChildCB(AtkObject* aAtkObj, gint aChildIndex) {
// aChildIndex should not be less than zero
if (aChildIndex < 0) {
return nullptr;
}
AtkObject* childAtkObj = nullptr;
AccessibleWrap* accWrap = GetAccessibleWrap(aAtkObj);
if (accWrap) {
if (nsAccUtils::MustPrune(accWrap)) {
return nullptr;
}
LocalAccessible* accChild = accWrap->EmbeddedChildAt(aChildIndex);
if (accChild) {
childAtkObj = AccessibleWrap::GetAtkObject(accChild);
} else {
OuterDocAccessible* docOwner = accWrap->AsOuterDoc();
if (docOwner) {
RemoteAccessible* proxyDoc = docOwner->RemoteChildDoc();
if (proxyDoc) childAtkObj = GetWrapperFor(proxyDoc);
}
}
} else if (RemoteAccessible* proxy = GetProxy(aAtkObj)) {
if (nsAccUtils::MustPrune(proxy)) {
return nullptr;
}
Accessible* child = proxy->EmbeddedChildAt(aChildIndex);
if (child) {
childAtkObj = GetWrapperFor(child->AsRemote());
}
} else {
return nullptr;
}
NS_ASSERTION(childAtkObj, "Fail to get AtkObj");
if (!childAtkObj) return nullptr;
g_object_ref(childAtkObj);
if (aAtkObj != childAtkObj->accessible_parent) {
atk_object_set_parent(childAtkObj, aAtkObj);
}
return childAtkObj;
}
gint getIndexInParentCB(AtkObject* aAtkObj) {
// We don't use LocalAccessible::IndexInParent() because we don't include text
// leaf nodes as children in ATK.
Accessible* acc = GetInternalObj(aAtkObj);
if (!acc) {
return -1;
}
if (acc->IsDoc()) {
return 0;
}
Accessible* parent = acc->Parent();
if (!parent) {
return -1;
}
return parent->IndexOfEmbeddedChild(acc);
}
static void TranslateStates(uint64_t aState, roles::Role aRole,
AtkStateSet* aStateSet) {
// atk doesn't have a read only state so read only things shouldn't be
// editable. However, we don't do this for list items because Gecko always
// exposes those as read only.
if ((aState & states::READONLY) && aRole != roles::LISTITEM) {
aState &= ~states::EDITABLE;
}
// Convert every state to an entry in AtkStateMap
uint64_t bitMask = 1;
for (auto stateIndex = 0U; stateIndex < gAtkStateMapLen; stateIndex++) {
if (gAtkStateMap[stateIndex]
.atkState) { // There's potentially an ATK state for this
bool isStateOn = (aState & bitMask) != 0;
if (gAtkStateMap[stateIndex].stateMapEntryType == kMapOpposite) {
isStateOn = !isStateOn;
}
if (isStateOn) {
atk_state_set_add_state(aStateSet, gAtkStateMap[stateIndex].atkState);
}
}
bitMask <<= 1;
}
}
AtkStateSet* refStateSetCB(AtkObject* aAtkObj) {
AtkStateSet* state_set = nullptr;
state_set = ATK_OBJECT_CLASS(parent_class)->ref_state_set(aAtkObj);
AccessibleWrap* accWrap = GetAccessibleWrap(aAtkObj);
if (accWrap) {
TranslateStates(accWrap->State(), accWrap->Role(), state_set);
} else if (RemoteAccessible* proxy = GetProxy(aAtkObj)) {
TranslateStates(proxy->State(), proxy->Role(), state_set);
} else {
TranslateStates(states::DEFUNCT, roles::NOTHING, state_set);
}
return state_set;
}
static void UpdateAtkRelation(RelationType aType, Accessible* aAcc,
AtkRelationType aAtkType,
AtkRelationSet* aAtkSet) {
if (aAtkType == ATK_RELATION_NULL) return;
AtkRelation* atkRelation =
atk_relation_set_get_relation_by_type(aAtkSet, aAtkType);
if (atkRelation) atk_relation_set_remove(aAtkSet, atkRelation);
Relation rel(aAcc->RelationByType(aType));
nsTArray<AtkObject*> targets;
Accessible* tempAcc = nullptr;
while ((tempAcc = rel.Next())) {
targets.AppendElement(GetWrapperFor(tempAcc));
}
if (targets.Length()) {
atkRelation =
atk_relation_new(targets.Elements(), targets.Length(), aAtkType);
atk_relation_set_add(aAtkSet, atkRelation);
g_object_unref(atkRelation);
}
}
AtkRelationSet* refRelationSetCB(AtkObject* aAtkObj) {
AtkRelationSet* relation_set =
ATK_OBJECT_CLASS(parent_class)->ref_relation_set(aAtkObj);
Accessible* acc = GetInternalObj(aAtkObj);
if (!acc) {
return relation_set;
}
if (!StaticPrefs::accessibility_cache_enabled_AtStartup() &&
acc->IsRemote()) {
RemoteAccessible* proxy = acc->AsRemote();
const AtkRelationType typeMap[] = {
#define RELATIONTYPE(gecko, s, atk, m, i) atk,
#include "RelationTypeMap.h"
#undef RELATIONTYPE
};
nsTArray<RelationType> types;
nsTArray<nsTArray<RemoteAccessible*>> targetSets;
proxy->Relations(&types, &targetSets);
size_t relationCount = types.Length();
for (size_t i = 0; i < relationCount; i++) {
if (typeMap[static_cast<uint32_t>(types[i])] == ATK_RELATION_NULL) {
continue;
}
size_t targetCount = targetSets[i].Length();
AutoTArray<AtkObject*, 5> wrappers;
for (size_t j = 0; j < targetCount; j++) {
wrappers.AppendElement(GetWrapperFor(targetSets[i][j]));
}
AtkRelationType atkType = typeMap[static_cast<uint32_t>(types[i])];
AtkRelation* atkRelation =
atk_relation_set_get_relation_by_type(relation_set, atkType);
if (atkRelation) atk_relation_set_remove(relation_set, atkRelation);
atkRelation =
atk_relation_new(wrappers.Elements(), wrappers.Length(), atkType);
atk_relation_set_add(relation_set, atkRelation);
g_object_unref(atkRelation);
}
return relation_set;
}
#define RELATIONTYPE(geckoType, geckoTypeName, atkType, msaaType, ia2Type) \
UpdateAtkRelation(RelationType::geckoType, acc, atkType, relation_set);
#include "RelationTypeMap.h"
#undef RELATIONTYPE
return relation_set;
}
// Check if aAtkObj is a valid MaiAtkObject, and return the AccessibleWrap
// for it.
AccessibleWrap* GetAccessibleWrap(AtkObject* aAtkObj) {
bool isMAIObject = IS_MAI_OBJECT(aAtkObj);
NS_ENSURE_TRUE(isMAIObject || MAI_IS_ATK_SOCKET(aAtkObj), nullptr);
AccessibleWrap* accWrap = nullptr;
if (isMAIObject) {
// If we're working with an ATK object, we need to convert the Accessible
// back to an AccessibleWrap:
Accessible* storedAcc = MAI_ATK_OBJECT(aAtkObj)->acc;
if (!storedAcc) {
return nullptr;
}
accWrap = static_cast<AccessibleWrap*>(storedAcc->AsLocal());
} else {
// The ATK socket stores an AccessibleWrap directly, so we can get the value
// with no casting.
accWrap = MAI_ATK_SOCKET(aAtkObj)->accWrap;
}
// Check if the accessible was deconstructed.
if (!accWrap) return nullptr;
NS_ENSURE_TRUE(accWrap->GetAtkObject() == aAtkObj, nullptr);
AccessibleWrap* appAccWrap = ApplicationAcc();
if (appAccWrap != accWrap && !accWrap->IsValidObject()) {
return nullptr;
}
return accWrap;
}
RemoteAccessible* GetProxy(AtkObject* aObj) {
Accessible* acc = GetInternalObj(aObj);
if (!acc) {
return nullptr;
}
return acc->AsRemote();
}
Accessible* GetInternalObj(AtkObject* aObj) {
if (!aObj || !IS_MAI_OBJECT(aObj)) return nullptr;
return MAI_ATK_OBJECT(aObj)->acc;
}
AtkObject* GetWrapperFor(Accessible* aAcc) {
if (!aAcc) {
return nullptr;
}
if (aAcc->IsRemote()) {
return reinterpret_cast<AtkObject*>(aAcc->AsRemote()->GetWrapper());
}
return AccessibleWrap::GetAtkObject(aAcc->AsLocal());
}
static uint16_t GetInterfacesForProxy(RemoteAccessible* aProxy) {
uint16_t interfaces = 1 << MAI_INTERFACE_COMPONENT;
if (aProxy->IsHyperText()) {
interfaces |= (1 << MAI_INTERFACE_HYPERTEXT) | (1 << MAI_INTERFACE_TEXT) |
(1 << MAI_INTERFACE_EDITABLE_TEXT);
}
if (aProxy->IsLink()) {
interfaces |= 1 << MAI_INTERFACE_HYPERLINK_IMPL;
}
if (aProxy->HasNumericValue()) {
interfaces |= 1 << MAI_INTERFACE_VALUE;
}
if (aProxy->IsTable()) {
interfaces |= 1 << MAI_INTERFACE_TABLE;
}
if (aProxy->IsTableCell()) {
interfaces |= 1 << MAI_INTERFACE_TABLE_CELL;
}
if (aProxy->IsImage()) {
interfaces |= 1 << MAI_INTERFACE_IMAGE;
}
if (aProxy->IsDoc()) {
interfaces |= 1 << MAI_INTERFACE_DOCUMENT;
}
if (aProxy->IsSelect()) {
interfaces |= 1 << MAI_INTERFACE_SELECTION;
}
if (aProxy->IsActionable()) {
interfaces |= 1 << MAI_INTERFACE_ACTION;
}
return interfaces;
}
void a11y::ProxyCreated(RemoteAccessible* aProxy) {
GType type = GetMaiAtkType(GetInterfacesForProxy(aProxy));
NS_ASSERTION(type, "why don't we have a type!");
AtkObject* obj = reinterpret_cast<AtkObject*>(g_object_new(type, nullptr));
if (!obj) return;
atk_object_initialize(obj, static_cast<Accessible*>(aProxy));
obj->role = ATK_ROLE_INVALID;
obj->layer = ATK_LAYER_INVALID;
aProxy->SetWrapper(reinterpret_cast<uintptr_t>(obj));
}
void a11y::ProxyDestroyed(RemoteAccessible* aProxy) {
auto obj = reinterpret_cast<MaiAtkObject*>(aProxy->GetWrapper());
if (!obj) {
return;
}
obj->Shutdown();
g_object_unref(obj);
aProxy->SetWrapper(0);
}
nsresult AccessibleWrap::HandleAccEvent(AccEvent* aEvent) {
nsresult rv = LocalAccessible::HandleAccEvent(aEvent);
NS_ENSURE_SUCCESS(rv, rv);
if (IPCAccessibilityActive()) {
return NS_OK;
}
LocalAccessible* accessible = aEvent->GetAccessible();
NS_ENSURE_TRUE(accessible, NS_ERROR_FAILURE);
// The accessible can become defunct if we have an xpcom event listener
// which decides it would be fun to change the DOM and flush layout.
if (accessible->IsDefunct()) return NS_OK;
uint32_t type = aEvent->GetEventType();
AtkObject* atkObj = AccessibleWrap::GetAtkObject(accessible);
// We don't create ATK objects for plain text leaves, just return NS_OK in
// such case.
if (!atkObj) {
NS_ASSERTION(type == nsIAccessibleEvent::EVENT_SHOW ||
type == nsIAccessibleEvent::EVENT_HIDE,
"Event other than SHOW and HIDE fired for plain text leaves");
return NS_OK;
}
AccessibleWrap* accWrap = GetAccessibleWrap(atkObj);
if (!accWrap) {
return NS_OK; // Node is shut down
}
switch (type) {
case nsIAccessibleEvent::EVENT_STATE_CHANGE: {
AccStateChangeEvent* event = downcast_accEvent(aEvent);
MAI_ATK_OBJECT(atkObj)->FireStateChangeEvent(event->GetState(),
event->IsStateEnabled());
break;
}
case nsIAccessibleEvent::EVENT_TEXT_REMOVED:
case nsIAccessibleEvent::EVENT_TEXT_INSERTED: {
AccTextChangeEvent* event = downcast_accEvent(aEvent);
NS_ENSURE_TRUE(event, NS_ERROR_FAILURE);
MAI_ATK_OBJECT(atkObj)->FireTextChangeEvent(
event->ModifiedText(), event->GetStartOffset(), event->GetLength(),
event->IsTextInserted(), event->IsFromUserInput());
return NS_OK;
}
case nsIAccessibleEvent::EVENT_FOCUS: {
a11y::RootAccessible* rootAccWrap = accWrap->RootAccessible();
if (rootAccWrap && rootAccWrap->IsActivated()) {
atk_focus_tracker_notify(atkObj);
// Fire state change event for focus
atk_object_notify_state_change(atkObj, ATK_STATE_FOCUSED, true);
return NS_OK;
}
} break;
case nsIAccessibleEvent::EVENT_NAME_CHANGE: {
nsAutoString newName;
accessible->Name(newName);
MaybeFireNameChange(atkObj, newName);
break;
}
case nsIAccessibleEvent::EVENT_VALUE_CHANGE:
case nsIAccessibleEvent::EVENT_TEXT_VALUE_CHANGE:
if (accessible->HasNumericValue()) {
// Make sure this is a numeric value. Don't fire for string value
// changes (e.g. text editing) ATK values are always numeric.
g_object_notify((GObject*)atkObj, "accessible-value");
}
break;
case nsIAccessibleEvent::EVENT_SELECTION:
case nsIAccessibleEvent::EVENT_SELECTION_ADD:
case nsIAccessibleEvent::EVENT_SELECTION_REMOVE: {
// XXX: dupe events may be fired
AccSelChangeEvent* selChangeEvent = downcast_accEvent(aEvent);
g_signal_emit_by_name(
AccessibleWrap::GetAtkObject(selChangeEvent->Widget()),
"selection_changed");
break;
}
case nsIAccessibleEvent::EVENT_SELECTION_WITHIN: {
g_signal_emit_by_name(atkObj, "selection_changed");
break;
}
case nsIAccessibleEvent::EVENT_ALERT:
// A hack using state change showing events as alert events.
atk_object_notify_state_change(atkObj, ATK_STATE_SHOWING, true);
break;
case nsIAccessibleEvent::EVENT_TEXT_SELECTION_CHANGED:
g_signal_emit_by_name(atkObj, "text_selection_changed");
break;
case nsIAccessibleEvent::EVENT_TEXT_CARET_MOVED: {
AccCaretMoveEvent* caretMoveEvent = downcast_accEvent(aEvent);
NS_ASSERTION(caretMoveEvent, "Event needs event data");
if (!caretMoveEvent) break;
int32_t caretOffset = caretMoveEvent->GetCaretOffset();
g_signal_emit_by_name(atkObj, "text_caret_moved", caretOffset);
} break;
case nsIAccessibleEvent::EVENT_TEXT_ATTRIBUTE_CHANGED:
g_signal_emit_by_name(atkObj, "text-attributes-changed");
break;
case nsIAccessibleEvent::EVENT_TABLE_MODEL_CHANGED:
g_signal_emit_by_name(atkObj, "model_changed");
break;
case nsIAccessibleEvent::EVENT_TABLE_ROW_INSERT: {
AccTableChangeEvent* tableEvent = downcast_accEvent(aEvent);
NS_ENSURE_TRUE(tableEvent, NS_ERROR_FAILURE);
int32_t rowIndex = tableEvent->GetIndex();
int32_t numRows = tableEvent->GetCount();
g_signal_emit_by_name(atkObj, "row_inserted", rowIndex, numRows);
} break;
case nsIAccessibleEvent::EVENT_TABLE_ROW_DELETE: {
AccTableChangeEvent* tableEvent = downcast_accEvent(aEvent);
NS_ENSURE_TRUE(tableEvent, NS_ERROR_FAILURE);
int32_t rowIndex = tableEvent->GetIndex();
int32_t numRows = tableEvent->GetCount();
g_signal_emit_by_name(atkObj, "row_deleted", rowIndex, numRows);
} break;
case nsIAccessibleEvent::EVENT_TABLE_ROW_REORDER: {
g_signal_emit_by_name(atkObj, "row_reordered");
break;
}
case nsIAccessibleEvent::EVENT_TABLE_COLUMN_INSERT: {
AccTableChangeEvent* tableEvent = downcast_accEvent(aEvent);
NS_ENSURE_TRUE(tableEvent, NS_ERROR_FAILURE);
int32_t colIndex = tableEvent->GetIndex();
int32_t numCols = tableEvent->GetCount();
g_signal_emit_by_name(atkObj, "column_inserted", colIndex, numCols);
} break;
case nsIAccessibleEvent::EVENT_TABLE_COLUMN_DELETE: {
AccTableChangeEvent* tableEvent = downcast_accEvent(aEvent);
NS_ENSURE_TRUE(tableEvent, NS_ERROR_FAILURE);
int32_t colIndex = tableEvent->GetIndex();
int32_t numCols = tableEvent->GetCount();
g_signal_emit_by_name(atkObj, "column_deleted", colIndex, numCols);
} break;
case nsIAccessibleEvent::EVENT_TABLE_COLUMN_REORDER:
g_signal_emit_by_name(atkObj, "column_reordered");
break;
case nsIAccessibleEvent::EVENT_SECTION_CHANGED:
g_signal_emit_by_name(atkObj, "visible_data_changed");
break;
case nsIAccessibleEvent::EVENT_SHOW: {
AccMutationEvent* event = downcast_accEvent(aEvent);
LocalAccessible* parentAcc =
event ? event->LocalParent() : accessible->LocalParent();
AtkObject* parent = AccessibleWrap::GetAtkObject(parentAcc);
NS_ENSURE_STATE(parent);
auto obj = reinterpret_cast<MaiAtkObject*>(atkObj);
obj->FireAtkShowHideEvent(parent, true, aEvent->IsFromUserInput());
return NS_OK;
}
case nsIAccessibleEvent::EVENT_HIDE: {
// XXX - Handle native dialog accessibles.
if (!accessible->IsRoot() && accessible->HasARIARole() &&
accessible->ARIARole() == roles::DIALOG) {
guint id = g_signal_lookup("deactivate", MAI_TYPE_ATK_OBJECT);
g_signal_emit(atkObj, id, 0);
}
AccMutationEvent* event = downcast_accEvent(aEvent);
LocalAccessible* parentAcc =
event ? event->LocalParent() : accessible->LocalParent();
AtkObject* parent = AccessibleWrap::GetAtkObject(parentAcc);
NS_ENSURE_STATE(parent);
auto obj = reinterpret_cast<MaiAtkObject*>(atkObj);
obj->FireAtkShowHideEvent(parent, false, aEvent->IsFromUserInput());
return NS_OK;
}
/*
* Because dealing with menu is very different between nsIAccessible
* and ATK, and the menu activity is important, specially transfer the
* following two event.
* Need more verification by AT test.
*/
case nsIAccessibleEvent::EVENT_MENU_START:
case nsIAccessibleEvent::EVENT_MENU_END:
break;
case nsIAccessibleEvent::EVENT_WINDOW_ACTIVATE: {
guint id = g_signal_lookup("activate", MAI_TYPE_ATK_OBJECT);
g_signal_emit(atkObj, id, 0);
// Always fire a current focus event after activation.
FocusMgr()->ForceFocusEvent();
} break;
case nsIAccessibleEvent::EVENT_WINDOW_DEACTIVATE: {
guint id = g_signal_lookup("deactivate", MAI_TYPE_ATK_OBJECT);
g_signal_emit(atkObj, id, 0);
} break;
case nsIAccessibleEvent::EVENT_WINDOW_MAXIMIZE: {
guint id = g_signal_lookup("maximize", MAI_TYPE_ATK_OBJECT);
g_signal_emit(atkObj, id, 0);
} break;
case nsIAccessibleEvent::EVENT_WINDOW_MINIMIZE: {
guint id = g_signal_lookup("minimize", MAI_TYPE_ATK_OBJECT);
g_signal_emit(atkObj, id, 0);
} break;
case nsIAccessibleEvent::EVENT_WINDOW_RESTORE: {
guint id = g_signal_lookup("restore", MAI_TYPE_ATK_OBJECT);
g_signal_emit(atkObj, id, 0);
} break;
case nsIAccessibleEvent::EVENT_DOCUMENT_LOAD_COMPLETE:
if (accessible->IsDoc()) {
g_signal_emit_by_name(atkObj, "load_complete");
}
// XXX - Handle native dialog accessibles.
if (!accessible->IsRoot() && accessible->HasARIARole() &&
accessible->ARIARole() == roles::DIALOG) {
guint id = g_signal_lookup("activate", MAI_TYPE_ATK_OBJECT);
g_signal_emit(atkObj, id, 0);
}
break;
case nsIAccessibleEvent::EVENT_DOCUMENT_RELOAD:
if (accessible->IsDoc()) {
g_signal_emit_by_name(atkObj, "reload");
}
break;
case nsIAccessibleEvent::EVENT_DOCUMENT_LOAD_STOPPED:
if (accessible->IsDoc()) {
g_signal_emit_by_name(atkObj, "load_stopped");
}
break;
case nsIAccessibleEvent::EVENT_MENUPOPUP_START:
atk_focus_tracker_notify(atkObj); // fire extra focus event
atk_object_notify_state_change(atkObj, ATK_STATE_VISIBLE, true);
atk_object_notify_state_change(atkObj, ATK_STATE_SHOWING, true);
break;
case nsIAccessibleEvent::EVENT_MENUPOPUP_END:
atk_object_notify_state_change(atkObj, ATK_STATE_VISIBLE, false);
atk_object_notify_state_change(atkObj, ATK_STATE_SHOWING, false);
break;
}
return NS_OK;
}
void a11y::ProxyEvent(RemoteAccessible* aTarget, uint32_t aEventType) {
AtkObject* wrapper = GetWrapperFor(aTarget);
switch (aEventType) {
case nsIAccessibleEvent::EVENT_FOCUS:
atk_focus_tracker_notify(wrapper);
atk_object_notify_state_change(wrapper, ATK_STATE_FOCUSED, true);
break;
case nsIAccessibleEvent::EVENT_DOCUMENT_LOAD_COMPLETE:
if (aTarget->IsDoc()) {
g_signal_emit_by_name(wrapper, "load_complete");
}
break;
case nsIAccessibleEvent::EVENT_DOCUMENT_RELOAD:
if (aTarget->IsDoc()) {
g_signal_emit_by_name(wrapper, "reload");
}
break;
case nsIAccessibleEvent::EVENT_DOCUMENT_LOAD_STOPPED:
if (aTarget->IsDoc()) {
g_signal_emit_by_name(wrapper, "load_stopped");
}
break;
case nsIAccessibleEvent::EVENT_MENUPOPUP_START:
atk_focus_tracker_notify(wrapper); // fire extra focus event
atk_object_notify_state_change(wrapper, ATK_STATE_VISIBLE, true);
atk_object_notify_state_change(wrapper, ATK_STATE_SHOWING, true);
break;
case nsIAccessibleEvent::EVENT_MENUPOPUP_END:
atk_object_notify_state_change(wrapper, ATK_STATE_VISIBLE, false);
atk_object_notify_state_change(wrapper, ATK_STATE_SHOWING, false);
break;
case nsIAccessibleEvent::EVENT_ALERT:
// A hack using state change showing events as alert events.
atk_object_notify_state_change(wrapper, ATK_STATE_SHOWING, true);
break;
case nsIAccessibleEvent::EVENT_VALUE_CHANGE:
g_object_notify((GObject*)wrapper, "accessible-value");
break;
case nsIAccessibleEvent::EVENT_TEXT_SELECTION_CHANGED:
g_signal_emit_by_name(wrapper, "text_selection_changed");
break;
case nsIAccessibleEvent::EVENT_SELECTION_WITHIN:
g_signal_emit_by_name(wrapper, "selection_changed");
break;
case nsIAccessibleEvent::EVENT_TEXT_ATTRIBUTE_CHANGED:
g_signal_emit_by_name(wrapper, "text-attributes-changed");
break;
}
}
void a11y::ProxyStateChangeEvent(RemoteAccessible* aTarget, uint64_t aState,
bool aEnabled) {
MaiAtkObject* atkObj = MAI_ATK_OBJECT(GetWrapperFor(aTarget));
atkObj->FireStateChangeEvent(aState, aEnabled);
}
void a11y::ProxyCaretMoveEvent(RemoteAccessible* aTarget, int32_t aOffset,
bool aIsSelectionCollapsed,
int32_t aGranularity) {
AtkObject* wrapper = GetWrapperFor(aTarget);
g_signal_emit_by_name(wrapper, "text_caret_moved", aOffset);
}
void MaiAtkObject::FireStateChangeEvent(uint64_t aState, bool aEnabled) {
auto state = aState;
int32_t stateIndex = -1;
while (state > 0) {
++stateIndex;
state >>= 1;
}
MOZ_ASSERT(
stateIndex >= 0 && stateIndex < static_cast<int32_t>(gAtkStateMapLen),
"No ATK state for internal state was found");
if (stateIndex < 0 || stateIndex >= static_cast<int32_t>(gAtkStateMapLen)) {
return;
}
if (gAtkStateMap[stateIndex].atkState != kNone) {
MOZ_ASSERT(gAtkStateMap[stateIndex].stateMapEntryType != kNoStateChange,
"State changes should not fired for this state");
if (gAtkStateMap[stateIndex].stateMapEntryType == kMapOpposite) {
aEnabled = !aEnabled;
}
// Fire state change for first state if there is one to map
atk_object_notify_state_change(&parent, gAtkStateMap[stateIndex].atkState,
aEnabled);
}
}
void a11y::ProxyTextChangeEvent(RemoteAccessible* aTarget,
const nsAString& aStr, int32_t aStart,
uint32_t aLen, bool aIsInsert, bool aFromUser) {
MaiAtkObject* atkObj = MAI_ATK_OBJECT(GetWrapperFor(aTarget));
atkObj->FireTextChangeEvent(aStr, aStart, aLen, aIsInsert, aFromUser);
}
#define OLD_TEXT_INSERTED "text_changed::insert"
#define OLD_TEXT_REMOVED "text_changed::delete"
static const char* oldTextChangeStrings[2][2] = {
{OLD_TEXT_REMOVED NON_USER_EVENT, OLD_TEXT_INSERTED NON_USER_EVENT},
{OLD_TEXT_REMOVED, OLD_TEXT_INSERTED}};
#define TEXT_INSERTED "text-insert"
#define TEXT_REMOVED "text-remove"
#define NON_USER_DETAIL "::system"
static const char* textChangedStrings[2][2] = {
{TEXT_REMOVED NON_USER_DETAIL, TEXT_INSERTED NON_USER_DETAIL},
{TEXT_REMOVED, TEXT_INSERTED}};
void MaiAtkObject::FireTextChangeEvent(const nsAString& aStr, int32_t aStart,
uint32_t aLen, bool aIsInsert,
bool aFromUser) {
if (gAvailableAtkSignals == eUnknown) {
gAvailableAtkSignals = g_signal_lookup("text-insert", G_OBJECT_TYPE(this))
? eHaveNewAtkTextSignals
: eNoNewAtkSignals;
}
if (gAvailableAtkSignals == eNoNewAtkSignals) {
// XXX remove this code and the gHaveNewTextSignals check when we can
// stop supporting old atk since it doesn't really work anyway
// see bug 619002
const char* signal_name = oldTextChangeStrings[aFromUser][aIsInsert];
g_signal_emit_by_name(this, signal_name, aStart, aLen);
} else {
const char* signal_name = textChangedStrings[aFromUser][aIsInsert];
g_signal_emit_by_name(this, signal_name, aStart, aLen,
NS_ConvertUTF16toUTF8(aStr).get());
}
}
void a11y::ProxyShowHideEvent(RemoteAccessible* aTarget,
RemoteAccessible* aParent, bool aInsert,
bool aFromUser) {
MaiAtkObject* obj = MAI_ATK_OBJECT(GetWrapperFor(aTarget));
obj->FireAtkShowHideEvent(GetWrapperFor(aParent), aInsert, aFromUser);
}
#define ADD_EVENT "children_changed::add"
#define HIDE_EVENT "children_changed::remove"
static const char* kMutationStrings[2][2] = {
{HIDE_EVENT NON_USER_EVENT, ADD_EVENT NON_USER_EVENT},
{HIDE_EVENT, ADD_EVENT},
};
void MaiAtkObject::FireAtkShowHideEvent(AtkObject* aParent, bool aIsAdded,
bool aFromUser) {
int32_t indexInParent = getIndexInParentCB(&this->parent);
const char* signal_name = kMutationStrings[aFromUser][aIsAdded];
g_signal_emit_by_name(aParent, signal_name, indexInParent, this, nullptr);
}
void a11y::ProxySelectionEvent(RemoteAccessible*, RemoteAccessible* aWidget,
uint32_t) {
MaiAtkObject* obj = MAI_ATK_OBJECT(GetWrapperFor(aWidget));
g_signal_emit_by_name(obj, "selection_changed");
}
// static
void AccessibleWrap::GetKeyBinding(Accessible* aAccessible,
nsAString& aResult) {
// Return all key bindings including access key and keyboard shortcut.
// Get access key.
nsAutoString keyBindingsStr;
KeyBinding keyBinding = aAccessible->AccessKey();
if (!keyBinding.IsEmpty()) {
keyBinding.AppendToString(keyBindingsStr, KeyBinding::eAtkFormat);
Accessible* parent = aAccessible->Parent();
roles::Role role = parent ? parent->Role() : roles::NOTHING;
if (role == roles::PARENT_MENUITEM || role == roles::MENUITEM ||
role == roles::RADIO_MENU_ITEM || role == roles::CHECK_MENU_ITEM) {
// It is submenu, expose keyboard shortcuts from menu hierarchy like
// "s;<Alt>f:s"
nsAutoString keysInHierarchyStr = keyBindingsStr;
do {
KeyBinding parentKeyBinding = parent->AccessKey();
if (!parentKeyBinding.IsEmpty()) {
nsAutoString str;
parentKeyBinding.ToString(str, KeyBinding::eAtkFormat);
str.Append(':');
keysInHierarchyStr.Insert(str, 0);
}
} while ((parent = parent->Parent()) && parent->Role() != roles::MENUBAR);
keyBindingsStr.Append(';');
keyBindingsStr.Append(keysInHierarchyStr);
}
} else {
// No access key, add ';' to point this.
keyBindingsStr.Append(';');
}
// Get keyboard shortcut.
keyBindingsStr.Append(';');
if (LocalAccessible* localAcc = aAccessible->AsLocal()) {
keyBinding = localAcc->KeyboardShortcut();
if (!keyBinding.IsEmpty()) {
keyBinding.AppendToString(keyBindingsStr, KeyBinding::eAtkFormat);
}
}
aResult = keyBindingsStr;
}
// static
Accessible* AccessibleWrap::GetColumnHeader(TableAccessibleBase* aAccessible,
int32_t aColIdx) {
if (!aAccessible) {
return nullptr;
}
Accessible* cell = aAccessible->CellAt(0, aColIdx);
if (!cell) {
return nullptr;
}
// If the cell at the first row is column header then assume it is column
// header for all rows,
if (cell->Role() == roles::COLUMNHEADER) {
return cell;
}
// otherwise get column header for the data cell at the first row.
TableCellAccessibleBase* tableCell = cell->AsTableCellBase();
if (!tableCell) {
return nullptr;
}
AutoTArray<Accessible*, 10> headerCells;
tableCell->ColHeaderCells(&headerCells);
if (headerCells.IsEmpty()) {
return nullptr;
}
return headerCells[0];
}
// static
Accessible* AccessibleWrap::GetRowHeader(TableAccessibleBase* aAccessible,
int32_t aRowIdx) {
if (!aAccessible) {
return nullptr;
}
Accessible* cell = aAccessible->CellAt(aRowIdx, 0);
if (!cell) {
return nullptr;
}
// If the cell at the first column is row header then assume it is row
// header for all columns,
if (cell->Role() == roles::ROWHEADER) {
return cell;
}
// otherwise get row header for the data cell at the first column.
TableCellAccessibleBase* tableCell = cell->AsTableCellBase();
if (!tableCell) {
return nullptr;
}
AutoTArray<Accessible*, 10> headerCells;
tableCell->RowHeaderCells(&headerCells);
if (headerCells.IsEmpty()) {
return nullptr;
}
return headerCells[0];
}
|