/
gecko_ia2.cpp
executable file
·1041 lines (961 loc) · 36.9 KB
/
gecko_ia2.cpp
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
/*
This file is a part of the NVDA project.
URL: http://www.nvda-project.org/
Copyright 2007-2016 NV Access Limited
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License version 2.0, as published by
the Free Software Foundation.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
This license can be found at:
http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
*/
#include <windows.h>
#include <set>
#include <string>
#include <sstream>
#include <ia2.h>
#include <common/ia2utils.h>
#include <remote/nvdaHelperRemote.h>
#include <vbufBase/backend.h>
#include <common/log.h>
#include <vbufBase/utils.h>
#include "gecko_ia2.h"
using namespace std;
#define NAVRELATION_LABELLED_BY 0x1003
#define NAVRELATION_NODE_CHILD_OF 0x1005
HWND findRealMozillaWindow(HWND hwnd) {
if(hwnd==0||!IsWindow(hwnd))
return (HWND)0;
wchar_t className[256];
bool foundWindow=false;
HWND tempWindow=hwnd;
do {
if(GetClassName(tempWindow,className,256)==0)
return hwnd;
if(wcscmp(L"MozillaWindowClass",className)!=0)
foundWindow=true;
else
tempWindow=GetAncestor(tempWindow,GA_PARENT);
} while(tempWindow&&!foundWindow);
if(GetClassName(tempWindow,className,256)!=0&&wcsstr(className,L"Mozilla")==className)
hwnd=tempWindow;
return hwnd;
}
IAccessible2* IAccessible2FromIdentifier(int docHandle, int ID) {
IAccessible* pacc=NULL;
IServiceProvider* pserv=NULL;
IAccessible2* pacc2=NULL;
VARIANT varChild;
if(AccessibleObjectFromEvent((HWND)UlongToHandle(docHandle),OBJID_CLIENT,ID,&pacc,&varChild)!=S_OK) {
LOG_DEBUG(L"AccessibleObjectFromEvent failed");
return NULL;
}
if (varChild.lVal!=CHILDID_SELF) {
// IAccessible2 can't be implemented on a simple child,
// so this object is invalid.
pacc->Release();
return NULL;
}
VariantClear(&varChild);
if(pacc->QueryInterface(IID_IServiceProvider,(void**)&pserv)!=S_OK) {
pacc->Release();
return NULL;
}
pacc->Release();
pserv->QueryService(IID_IAccessible,IID_IAccessible2,(void**)&pacc2);
pserv->Release();
return pacc2;
}
template<typename TableType> inline void fillTableCounts(VBufStorage_controlFieldNode_t* node, IAccessible2* pacc, TableType* paccTable) {
wostringstream s;
long count = 0;
if (paccTable->get_nRows(&count) == S_OK) {
s << count;
node->addAttribute(L"table-physicalrowcount", s.str());
node->addAttribute(L"table-rowcount", s.str());
s.str(L"");
}
if (paccTable->get_nColumns(&count) == S_OK) {
s << count;
node->addAttribute(L"table-physicalcolumncount", s.str());
node->addAttribute(L"table-columncount", s.str());
}
}
inline int updateTableCounts(IAccessibleTableCell* tableCell, VBufStorage_buffer_t* tableBuffer) {
IUnknown* unk = NULL;
if (tableCell->get_table(&unk) != S_OK || !unk)
return 0;
IAccessible2* acc = NULL;
HRESULT res;
res = unk->QueryInterface(IID_IAccessible2, (void**)&acc);
unk->Release();
if (res != S_OK || !acc)
return 0;
HWND docHwnd;
int id;
if (acc->get_windowHandle(&docHwnd) != S_OK
|| acc->get_uniqueID((long*)&id) != S_OK) {
acc->Release();
return 0;
}
const int docHandle = HandleToUlong(docHwnd);
VBufStorage_controlFieldNode_t* node = tableBuffer->getControlFieldNodeWithIdentifier(docHandle, id);
if (!node) {
acc->Release();
return 0;
}
IAccessibleTable2* table = NULL;
if (acc->QueryInterface(IID_IAccessibleTable2, (void**)&table) != S_OK || !table) {
acc->Release();
return 0;
}
fillTableCounts<IAccessibleTable2>(node, acc, table);
table->Release();
acc->Release();
return id;
}
inline void fillTableCellInfo_IATable(VBufStorage_controlFieldNode_t* node, IAccessibleTable* paccTable, const wstring& cellIndexStr) {
wostringstream s;
long cellIndex = _wtoi(cellIndexStr.c_str());
long row, column, rowExtents, columnExtents;
boolean isSelected;
if (paccTable->get_rowColumnExtentsAtIndex(cellIndex, &row, &column, &rowExtents, &columnExtents, &isSelected) == S_OK) {
s << row + 1;
node->addAttribute(L"table-physicalrownumber", s.str());
node->addAttribute(L"table-rownumber", s.str());
s.str(L"");
s << column + 1;
node->addAttribute(L"table-physicalcolumnnumber", s.str());
node->addAttribute(L"table-columnnumber", s.str());
if (columnExtents > 1) {
s.str(L"");
s << columnExtents;
node->addAttribute(L"table-columnsspanned", s.str());
}
if (rowExtents > 1) {
s.str(L"");
s << rowExtents;
node->addAttribute(L"table-rowsspanned", s.str());
}
}
}
typedef HRESULT(STDMETHODCALLTYPE IAccessibleTableCell::*IATableCellGetHeaderCellsFunc)(IUnknown***, long*);
inline void fillTableHeaders(VBufStorage_controlFieldNode_t* node, IAccessibleTableCell* paccTableCell, const IATableCellGetHeaderCellsFunc getHeaderCells, const wstring& attribName) {
wostringstream s;
IUnknown** headerCells;
long nHeaderCells;
if ((paccTableCell->*getHeaderCells)(&headerCells, &nHeaderCells) == S_OK && headerCells) {
for (int hci = 0; hci < nHeaderCells; hci++) {
IAccessible2* headerCellPacc = NULL;
if (headerCells[hci]->QueryInterface(IID_IAccessible2, (void**)&headerCellPacc) != S_OK) {
headerCells[hci]->Release();
continue;
}
headerCells[hci]->Release();
HWND hwnd;
if (headerCellPacc->get_windowHandle(&hwnd) != S_OK) {
headerCellPacc->Release();
continue;
}
const int headerCellDocHandle = HandleToUlong(findRealMozillaWindow(hwnd));
int headerCellID;
if (headerCellPacc->get_uniqueID((long*)&headerCellID) != S_OK) {
headerCellPacc->Release();
continue;
}
s << headerCellDocHandle << L"," << headerCellID << L";";
headerCellPacc->Release();
}
if (!s.str().empty())
node->addAttribute(attribName, s.str());
CoTaskMemFree(headerCells);
}
}
inline void GeckoVBufBackend_t::fillTableCellInfo_IATable2(VBufStorage_controlFieldNode_t* node, IAccessibleTableCell* paccTableCell) {
wostringstream s;
long row, column, rowExtents, columnExtents;
boolean isSelected;
if (paccTableCell->get_rowColumnExtents(&row, &column, &rowExtents, &columnExtents, &isSelected) == S_OK) {
s << row + 1;
node->addAttribute(L"table-physicalrownumber", s.str());
node->addAttribute(L"table-rownumber", s.str());
s.str(L"");
s << column + 1;
node->addAttribute(L"table-physicalcolumnnumber", s.str());
node->addAttribute(L"table-columnnumber", s.str());
if (columnExtents > 1) {
s.str(L"");
s << columnExtents;
node->addAttribute(L"table-columnsspanned", s.str());
}
if (rowExtents > 1) {
s.str(L"");
s << rowExtents;
node->addAttribute(L"table-rowsspanned", s.str());
}
}
if (this->shouldDisableTableHeaders)
return;
fillTableHeaders(node, paccTableCell, &IAccessibleTableCell::get_columnHeaderCells, L"table-columnheadercells");
fillTableHeaders(node, paccTableCell, &IAccessibleTableCell::get_rowHeaderCells, L"table-rowheadercells");
}
void GeckoVBufBackend_t::versionSpecificInit(IAccessible2* pacc) {
// Defaults.
this->shouldDisableTableHeaders = false;
this->hasEncodedAccDescription = false;
IServiceProvider* serv = NULL;
if (pacc->QueryInterface(IID_IServiceProvider, (void**)&serv) != S_OK)
return;
IAccessibleApplication* iaApp = NULL;
if (serv->QueryService(IID_IAccessibleApplication, IID_IAccessibleApplication, (void**)&iaApp) != S_OK) {
serv->Release();
return;
}
serv->Release();
BSTR toolkitName = NULL;
if (iaApp->get_toolkitName(&toolkitName) != S_OK) {
iaApp->Release();
return;
}
BSTR toolkitVersion = NULL;
if (iaApp->get_toolkitVersion(&toolkitVersion) != S_OK) {
iaApp->Release();
SysFreeString(toolkitName);
return;
}
iaApp->Release();
iaApp = NULL;
if (wcscmp(toolkitName, L"Gecko") == 0) {
if (wcsncmp(toolkitVersion, L"1.", 2) == 0) {
if (wcsncmp(toolkitVersion, L"1.9.2.", 6) == 0) {
// Gecko 1.9.2.x.
// Retrieve the digits for the final part of the main version number.
wstring verPart;
for (wchar_t* c = &toolkitVersion[6]; iswdigit(*c); c++)
verPart += *c;
if (_wtoi(verPart.c_str()) <= 10) {
// Gecko <= 1.9.2.10 will crash if we try to retrieve headers on some table cells, so disable them.
this->shouldDisableTableHeaders = true;
}
}
// Gecko 1.x uses accDescription to encode position info as well as the description.
this->hasEncodedAccDescription = true;
}
}
SysFreeString(toolkitName);
SysFreeString(toolkitVersion);
}
bool isLabelVisible(IAccessible2* acc) {
VARIANT child, target;
child.vt = VT_I4;
child.lVal = 0;
if (acc->accNavigate(NAVRELATION_LABELLED_BY, child, &target) != S_OK)
return false;
IAccessible2* targetAcc;
HRESULT res;
res = target.pdispVal->QueryInterface(IID_IAccessible2, (void**)&targetAcc);
VariantClear(&target);
if (res != S_OK)
return false;
VARIANT state;
res = targetAcc->get_accState(child, &state);
targetAcc->Release();
if (res != S_OK)
return false;
if (state.lVal & STATE_SYSTEM_INVISIBLE)
return false;
return true;
}
long getChildCount(const bool isAriaHidden, IAccessible2 * const pacc){
long rawChildCount = 0;
if(!isAriaHidden){
auto res = pacc->get_accChildCount(&rawChildCount);
if(res != S_OK){
rawChildCount = 0;
}
}
return rawChildCount;
}
bool hasAriaHiddenAttribute(const map<wstring,wstring>& IA2AttribsMap){
const auto IA2AttribsMapIt = IA2AttribsMap.find(L"hidden");
return (IA2AttribsMapIt != IA2AttribsMap.end() && IA2AttribsMapIt->second == L"true");
}
const vector<wstring>ATTRLIST_ROLES(1, L"IAccessible2::attribute_xml-roles");
const wregex REGEX_PRESENTATION_ROLE(L"IAccessible2\\\\:\\\\:attribute_xml-roles:.*\\bpresentation\\b.*;");
VBufStorage_fieldNode_t* GeckoVBufBackend_t::fillVBuf(IAccessible2* pacc,
VBufStorage_buffer_t* buffer, VBufStorage_controlFieldNode_t* parentNode, VBufStorage_fieldNode_t* previousNode,
IAccessibleTable* paccTable, IAccessibleTable2* paccTable2, long tableID, const wchar_t* parentPresentationalRowNumber,
bool ignoreInteractiveUnlabelledGraphics
) {
nhAssert(buffer); //buffer can't be NULL
nhAssert(!parentNode||buffer->isNodeInBuffer(parentNode)); //parent node must be in buffer
nhAssert(!previousNode||buffer->isNodeInBuffer(previousNode)); //Previous node must be in buffer
VBufStorage_fieldNode_t* tempNode;
//all IAccessible methods take a variant for childID, get one ready
VARIANT varChild;
varChild.vt=VT_I4;
varChild.lVal=0;
wostringstream s;
//get docHandle -- IAccessible2 windowHandle
HWND docHwnd;
if(pacc->get_windowHandle(&docHwnd)!=S_OK) {
LOG_DEBUG(L"pacc->get_windowHandle failed");
return NULL;
}
const int docHandle=HandleToUlong(findRealMozillaWindow(docHwnd));
if(!docHandle) {
LOG_DEBUG(L"bad docHandle");
return NULL;
}
//Get ID -- IAccessible2 uniqueID
int ID;
if(pacc->get_uniqueID((long*)&ID)!=S_OK) {
LOG_DEBUG(L"pacc->get_uniqueID failed");
return NULL;
}
//Make sure that we don't already know about this object -- protect from loops
if(buffer->getControlFieldNodeWithIdentifier(docHandle,ID)) {
LOG_DEBUG(L"a node with this docHandle and ID already exists, returning NULL");
return NULL;
}
// Save off the old parent for later propagation of some attributes
VBufStorage_fieldNode_t* origParentNode=parentNode;
//Add this node to the buffer
parentNode=buffer->addControlFieldNode(parentNode,previousNode,docHandle,ID,TRUE);
nhAssert(parentNode); //new node must have been created
previousNode=NULL;
//Get role -- IAccessible2 role
long role=0;
BSTR roleString=NULL;
if(pacc->role(&role)!=S_OK)
role=IA2_ROLE_UNKNOWN;
VARIANT varRole;
VariantInit(&varRole);
if(role==0) {
if(pacc->get_accRole(varChild,&varRole)!=S_OK) {
LOG_DEBUG(L"accRole failed");
}
if(varRole.vt==VT_I4)
role=varRole.lVal;
else if(varRole.vt==VT_BSTR)
roleString=varRole.bstrVal;
}
//Add role as an attrib
if(roleString)
s<<roleString;
else
s<<role;
parentNode->addAttribute(L"IAccessible::role",s.str());
s.str(L"");
VariantClear(&varRole);
//get states -- IAccessible accState
VARIANT varState;
VariantInit(&varState);
if(pacc->get_accState(varChild,&varState)!=S_OK) {
LOG_DEBUG(L"pacc->get_accState failed");
varState.vt=VT_I4;
varState.lVal=0;
}
int states=varState.lVal;
VariantClear(&varState);
//Add each state that is on, as an attrib
for(int i=0;i<32;++i) {
int state=1<<i;
if(state&states) {
s<<L"IAccessible::state_"<<state;
parentNode->addAttribute(s.str(),L"1");
s.str(L"");
}
}
//get IA2States -- IAccessible2 states
AccessibleStates IA2States;
if(pacc->get_states(&IA2States)!=S_OK) {
LOG_DEBUG(L"pacc->get_states failed");
IA2States=0;
}
//Add each state that is on, as an attrib
for(int i=0;i<32;++i) {
int state=1<<i;
if(state&IA2States) {
s<<L"IAccessible2::state_"<<state;
parentNode->addAttribute(s.str(),L"1");
s.str(L"");
}
}
//get keyboardShortcut -- IAccessible accKeyboardShortcut;
BSTR keyboardShortcut;
if(pacc->get_accKeyboardShortcut(varChild,&keyboardShortcut)==S_OK) {
parentNode->addAttribute(L"keyboardShortcut",keyboardShortcut);
//Free keyboardShortcut string memory
SysFreeString(keyboardShortcut);
} else
parentNode->addAttribute(L"keyboardShortcut",L"");
//get IA2Attributes -- IAccessible2 attributes;
BSTR IA2Attributes;
map<wstring,wstring> IA2AttribsMap;
if(pacc->get_attributes(&IA2Attributes)==S_OK) {
IA2AttribsToMap(IA2Attributes,IA2AttribsMap);
SysFreeString(IA2Attributes);
// Add each IA2 attribute as an attrib.
for(map<wstring,wstring>::const_iterator it=IA2AttribsMap.begin();it!=IA2AttribsMap.end();++it) {
s<<L"IAccessible2::attribute_"<<it->first;
parentNode->addAttribute(s.str(),it->second);
s.str(L"");
}
} else
LOG_DEBUG(L"pacc->get_attributes failed");
map<wstring,wstring>::const_iterator IA2AttribsMapIt;
//Check IA2Attributes, and or the role etc to work out if this object is a block element
bool isBlockElement=TRUE;
if(IA2States&IA2_STATE_MULTI_LINE) {
// Multiline nodes should always be block.
isBlockElement=TRUE;
} else if((IA2AttribsMapIt=IA2AttribsMap.find(L"display"))!=IA2AttribsMap.end()) {
// If there is a display attribute, we can rely solely on this to determine whether this is a block element or not.
isBlockElement=(IA2AttribsMapIt->second!=L"inline"&&IA2AttribsMapIt->second!=L"inline-block");
} else if((IA2AttribsMapIt=IA2AttribsMap.find(L"formatting"))!=IA2AttribsMap.end()&&IA2AttribsMapIt->second==L"block") {
isBlockElement=TRUE;
} else if(role==ROLE_SYSTEM_TABLE||role==ROLE_SYSTEM_CELL||role==IA2_ROLE_SECTION||role==ROLE_SYSTEM_DOCUMENT||role==IA2_ROLE_INTERNAL_FRAME||role==IA2_ROLE_UNKNOWN||role==ROLE_SYSTEM_SEPARATOR) {
isBlockElement=TRUE;
} else {
isBlockElement=FALSE;
}
parentNode->isBlock=isBlockElement;
// force isHidden to True if this has an ARIA role of presentation but its focusble -- Gecko does not hide this itself.
if((states&STATE_SYSTEM_FOCUSABLE)&&parentNode->matchAttributes(ATTRLIST_ROLES, REGEX_PRESENTATION_ROLE)) {
parentNode->isHidden=true;
}
BSTR name=NULL;
if(pacc->get_accName(varChild,&name)!=S_OK)
name=NULL;
wstring description;
BSTR rawDesc=NULL;
if(pacc->get_accDescription(varChild,&rawDesc)==S_OK) {
if(this->hasEncodedAccDescription) {
if(wcsncmp(rawDesc,L"Description: ",13)==0)
description=&rawDesc[13];
} else
description=rawDesc;
parentNode->addAttribute(L"description",description);
SysFreeString(rawDesc);
}
wstring locale;
IA2Locale ia2Locale={0};
if(pacc->get_locale(&ia2Locale)==S_OK) {
if(ia2Locale.language) {
locale.append(ia2Locale.language);
SysFreeString(ia2Locale.language);
}
if(ia2Locale.country) {
if(!locale.empty()) {
locale.append(L"-");
locale.append(ia2Locale.country);
}
SysFreeString(ia2Locale.country);
}
if(ia2Locale.variant) {
SysFreeString(ia2Locale.variant);
}
}
long left=0, top=0, width=0, height=0;
if(pacc->accLocation(&left,&top,&width,&height,varChild)!=S_OK) {
LOG_DEBUG(L"Error getting accLocation");
}
// Whether this node is editable text.
bool isEditable = (role == ROLE_SYSTEM_TEXT && (states & STATE_SYSTEM_FOCUSABLE || states & STATE_SYSTEM_UNAVAILABLE)) || IA2States & IA2_STATE_EDITABLE;
// Whether this node is a link or inside a link.
int inLink = states & STATE_SYSTEM_LINKED;
// Whether this is the root node.
bool isRoot = ID == this->rootID;
// Whether this is an embedded application.
bool isEmbeddedApp = role == IA2_ROLE_EMBEDDED_OBJECT
|| (!isRoot && (role == ROLE_SYSTEM_APPLICATION || role == ROLE_SYSTEM_DIALOG));
// Whether this node is interactive.
// Certain objects are never interactive, even if other checks are true.
bool isNeverInteractive = parentNode->isHidden||(!isEditable && (isRoot || role == ROLE_SYSTEM_DOCUMENT || role == IA2_ROLE_INTERNAL_FRAME));
bool isInteractive = !isNeverInteractive && (isEditable || inLink || states & STATE_SYSTEM_FOCUSABLE || states & STATE_SYSTEM_UNAVAILABLE || isEmbeddedApp || role == ROLE_SYSTEM_EQUATION);
// We aren't finished calculating isInteractive yet; actions are handled below.
const bool isAriaHidden = hasAriaHiddenAttribute(IA2AttribsMap);
const long childCount = getChildCount(isAriaHidden, pacc);
const bool isImgMap = role == ROLE_SYSTEM_GRAPHIC && childCount > 0;
// Whether the name is the content of this node.
const bool nameIsContent = isEmbeddedApp
|| role == ROLE_SYSTEM_LINK || role == ROLE_SYSTEM_PUSHBUTTON || role == IA2_ROLE_TOGGLE_BUTTON || role == ROLE_SYSTEM_MENUITEM || (role == ROLE_SYSTEM_GRAPHIC && !isImgMap) || (role == ROLE_SYSTEM_TEXT && !isEditable) || role == IA2_ROLE_HEADING || role == ROLE_SYSTEM_PAGETAB || role == ROLE_SYSTEM_BUTTONMENU
|| ((role == ROLE_SYSTEM_CHECKBUTTON || role == ROLE_SYSTEM_RADIOBUTTON) && !isLabelVisible(pacc));
IAccessibleText* paccText=NULL;
IAccessibleHypertext* paccHypertext=NULL;
//get IAccessibleText interface
pacc->QueryInterface(IID_IAccessibleText,(void**)&paccText);
//Get IAccessibleHypertext interface
pacc->QueryInterface(IID_IAccessibleHypertext,(void**)&paccHypertext);
//Get the text from the IAccessibleText interface
BSTR IA2Text=NULL;
int IA2TextLength=0;
if (paccText && paccText->get_text(0, IA2_TEXT_OFFSET_LENGTH, &IA2Text) == S_OK && IA2Text)
IA2TextLength=SysStringLen(IA2Text);
// Determine whether the text is extraneous whitespace.
bool IA2TextIsUnneededSpace=true;
// Whitespace isn't extraneous in editable controls.
if (IA2TextLength > 0 && !isEditable) {
for(int i=0;i<IA2TextLength;++i) {
if(IA2Text[i]==L'\n'||IA2Text[i]==L'\xfffc'||!iswspace(IA2Text[i])) {
IA2TextIsUnneededSpace=false;
break;
}
}
} else
IA2TextIsUnneededSpace=false;
// Whether a node is visible.
// An invisible node should not be rendered, but will have a presence in the buffer.
bool isVisible = true;
// Whether to render children, including text content.
// Note that we may still render the name, value, etc. even if we don't render children.
bool renderChildren = true;
if (isAriaHidden) {
// aria-hidden
isVisible = false;
} else {
// If a node has children, it's visible.
isVisible = width > 0 && height > 0 || childCount > 0;
if (IA2TextIsUnneededSpace
|| role == ROLE_SYSTEM_COMBOBOX
|| (role == ROLE_SYSTEM_LIST && !(states & STATE_SYSTEM_READONLY))
|| isEmbeddedApp
|| role == ROLE_SYSTEM_OUTLINE
|| role == ROLE_SYSTEM_EQUATION
|| (nameIsContent && (IA2AttribsMapIt = IA2AttribsMap.find(L"explicit-name")) != IA2AttribsMap.end() && IA2AttribsMapIt->second == L"true")
) {
renderChildren = false;
}
}
//Expose all available actions
IAccessibleAction* paccAction=NULL;
pacc->QueryInterface(IID_IAccessibleAction,(void**)&paccAction);
if(paccAction) {
long nActions=0;
paccAction->nActions(&nActions);
for(int i=0;i<nActions;++i) {
BSTR actionName=NULL;
paccAction->get_name(i,&actionName);
if(actionName) {
wstring attribName=L"IAccessibleAction_";
attribName+=actionName;
s<<i;
parentNode->addAttribute(attribName,s.str());
s.str(L"");
if(!isNeverInteractive&&(wcscmp(actionName, L"click")==0||wcscmp(actionName, L"showlongdesc")==0)) {
isInteractive=true;
}
SysFreeString(actionName);
}
}
paccAction->Release();
}
// Handle table cell information.
IAccessibleTableCell* paccTableCell = NULL;
// For IAccessibleTable, we must always be passed the table interface by the caller.
// For IAccessibleTable2, we can always obtain the cell interface,
// which allows us to handle updates to table cells.
if (
pacc->QueryInterface(IID_IAccessibleTableCell, (void**)&paccTableCell) == S_OK || // IAccessibleTable2
(paccTable && (IA2AttribsMapIt = IA2AttribsMap.find(L"table-cell-index")) != IA2AttribsMap.end()) // IAccessibleTable
) {
if (paccTableCell) {
// IAccessibleTable2
this->fillTableCellInfo_IATable2(parentNode, paccTableCell);
if (!paccTable2) {
// This is an update; we're not rendering the entire table.
tableID = updateTableCounts(paccTableCell, this);
}
paccTableCell->Release();
paccTableCell = NULL;
} else // IAccessibleTable
fillTableCellInfo_IATable(parentNode, paccTable, IA2AttribsMapIt->second);
// tableID is the IAccessible2::uniqueID for paccTable.
s << tableID;
parentNode->addAttribute(L"table-id", s.str());
s.str(L"");
// We're now within a cell, so descendant nodes shouldn't refer to this table anymore.
paccTable = NULL;
paccTable2 = NULL;
tableID = 0;
}
// Handle table information.
// Don't release the table unless it was created in this call.
bool releaseTable = false;
// If paccTable is not NULL, we're within a table but not yet within a cell, so don't bother to query for table info.
if (!paccTable2 && !paccTable) {
// Try to get table information.
pacc->QueryInterface(IID_IAccessibleTable2,(void**)&paccTable2);
if(!paccTable2)
pacc->QueryInterface(IID_IAccessibleTable,(void**)&paccTable);
if (paccTable2||paccTable) {
// We did the QueryInterface for paccTable, so we must release it after all calls that use it are done.
releaseTable = true;
// This is a table, so add its information as attributes.
if((IA2AttribsMapIt = IA2AttribsMap.find(L"layout-guess")) != IA2AttribsMap.end())
parentNode->addAttribute(L"table-layout",L"1");
tableID = ID;
s << ID;
parentNode->addAttribute(L"table-id", s.str());
s.str(L"");
if(paccTable2)
fillTableCounts<IAccessibleTable2>(parentNode, pacc, paccTable2);
else
fillTableCounts<IAccessibleTable>(parentNode, pacc, paccTable);
// Add the table summary if one is present and the table is visible.
if (isVisible &&
(!description.empty() && (tempNode = buffer->addTextFieldNode(parentNode, previousNode, description))) ||
// If there is no caption, the summary (if any) is the name.
// There is no caption if the label isn't visible.
(name && !isLabelVisible(pacc) && (tempNode = buffer->addTextFieldNode(parentNode, previousNode, name)))
) {
if(!locale.empty()) tempNode->addAttribute(L"language",locale);
previousNode = tempNode;
}
}
}
// Add some presentational table attributes
// Note these are only for reporting, the physical table attributes (table-physicalrownumber etc) for aiding in navigation etc are added later on.
// propagate table-rownumber down to the cell as Gecko only includes it on the row itself
if(parentPresentationalRowNumber)
parentNode->addAttribute(L"table-rownumber",parentPresentationalRowNumber);
const wchar_t* presentationalRowNumber=NULL;
if((IA2AttribsMapIt = IA2AttribsMap.find(L"rowindex")) != IA2AttribsMap.end()) {
parentNode->addAttribute(L"table-rownumber",IA2AttribsMapIt->second);
presentationalRowNumber=IA2AttribsMapIt->second.c_str();
}
if((IA2AttribsMapIt = IA2AttribsMap.find(L"colindex")) != IA2AttribsMap.end())
parentNode->addAttribute(L"table-columnnumber",IA2AttribsMapIt->second);
if((IA2AttribsMapIt = IA2AttribsMap.find(L"rowcount")) != IA2AttribsMap.end())
parentNode->addAttribute(L"table-rowcount",IA2AttribsMapIt->second);
if((IA2AttribsMapIt = IA2AttribsMap.find(L"colcount")) != IA2AttribsMap.end())
parentNode->addAttribute(L"table-columncount",IA2AttribsMapIt->second);
BSTR value=NULL;
if(pacc->get_accValue(varChild,&value)==S_OK) {
if(value&&SysStringLen(value)==0) {
SysFreeString(value);
value=NULL;
}
}
//If the name isn't being rendered as the content, then add the name as a field attribute.
if (!nameIsContent && name)
parentNode->addAttribute(L"name", name);
if (isVisible) {
if ( isImgMap && name ) {
// This is an image map with a name. Render the name first.
previousNode=buffer->addTextFieldNode(parentNode,previousNode,name);
if(previousNode&&!locale.empty()) previousNode->addAttribute(L"language",locale);
}
if (isInteractive && !ignoreInteractiveUnlabelledGraphics) {
// Don't render interactive unlabelled graphic descendants if this node has a name,
// as author supplied names are preferred.
ignoreInteractiveUnlabelledGraphics = name != NULL;
}
if (renderChildren && IA2TextLength > 0) {
// Process IAccessibleText.
int chunkStart=0;
long attribsStart = 0;
long attribsEnd = 0;
map<wstring,wstring> textAttribs;
for(int i=0;;++i) {
if(i!=chunkStart&&(i==IA2TextLength||i==attribsEnd||IA2Text[i]==0xfffc)) {
// We've reached the end of the current chunk of text.
// (A chunk ends at the end of the text, at the end of an attributes run
// or at an embedded object char.)
// Add the chunk to the buffer.
if(tempNode=buffer->addTextFieldNode(parentNode,previousNode,wstring(IA2Text+chunkStart,i-chunkStart))) {
previousNode=tempNode;
// Add text attributes.
for(map<wstring,wstring>::const_iterator it=textAttribs.begin();it!=textAttribs.end();++it)
previousNode->addAttribute(it->first,it->second);
#define copyObjectAttribute(attr) if ((IA2AttribsMapIt = IA2AttribsMap.find(attr)) != IA2AttribsMap.end()) \
previousNode->addAttribute(attr, IA2AttribsMapIt->second);
copyObjectAttribute(L"text-align");
#undef copyObjectAttribute
}
}
if(i==IA2TextLength)
break;
if(i==attribsEnd) {
// We've hit the end of the last attributes run and thus the start of the next.
textAttribs.clear();
chunkStart=i;
BSTR attribsStr;
if(paccText->get_attributes(attribsEnd,&attribsStart,&attribsEnd,&attribsStr)==S_OK) {
if(attribsStr) {
IA2AttribsToMap(attribsStr,textAttribs);
SysFreeString(attribsStr);
}
} else {
// If attributes fails, assume it'll fail for the entire text.
attribsEnd=IA2TextLength;
}
}
if(paccHypertext&&IA2Text[i]==0xfffc) {
// Embedded object char.
// The next chunk of text shouldn't include this char.
chunkStart=i+1;
long hyperlinkIndex;
if(paccHypertext->get_hyperlinkIndex(i,&hyperlinkIndex)!=S_OK)
continue;
IAccessibleHyperlink* paccHyperlink=NULL;
if(paccHypertext->get_hyperlink(hyperlinkIndex,&paccHyperlink)!=S_OK)
continue;
IAccessible2* childPacc=NULL;
if(paccHyperlink->QueryInterface(IID_IAccessible2,(void**)&childPacc)!=S_OK) {
paccHyperlink->Release();
continue;
}
paccHyperlink->Release();
if (tempNode = this->fillVBuf(childPacc, buffer, parentNode, previousNode, paccTable, paccTable2, tableID, presentationalRowNumber, ignoreInteractiveUnlabelledGraphics)) {
previousNode=tempNode;
} else {
LOG_DEBUG(L"Error in fillVBuf");
}
childPacc->Release();
}
}
} else if (renderChildren && childCount > 0) {
// The object has no text, but we do want to render its children.
VARIANT* varChildren;
if(!(varChildren=(VARIANT*)malloc(sizeof(VARIANT)*childCount))) {
LOG_DEBUG(L"Error allocating varChildren memory");
return NULL;
}
long accessibleChildrenCount = 0;
if(AccessibleChildren(pacc,0,childCount,varChildren,&accessibleChildrenCount)!=S_OK) {
LOG_DEBUG(L"AccessibleChildren failed");
accessibleChildrenCount=0;
}
for(long i=0;i<accessibleChildrenCount;++i) {
if (varChildren[i].vt != VT_DISPATCH) {
VariantClear(&(varChildren[i]));
continue;
}
IAccessible2* childPacc=NULL;
if(varChildren[i].pdispVal) varChildren[i].pdispVal->QueryInterface(IID_IAccessible2,(void**)&childPacc);
if (!childPacc) {
VariantClear(&(varChildren[i]));
continue;
}
if (tempNode = this->fillVBuf(childPacc, buffer, parentNode, previousNode, paccTable, paccTable2, tableID, presentationalRowNumber, ignoreInteractiveUnlabelledGraphics))
previousNode=tempNode;
else
LOG_DEBUG(L"Error in calling fillVBuf");
childPacc->Release();
VariantClear(&(varChildren[i]));
}
free(varChildren);
} else {
// There were no children to render.
if(role==ROLE_SYSTEM_GRAPHIC) {
if (name && name[0]) {
// The graphic has a label, so use it.
previousNode=buffer->addTextFieldNode(parentNode,previousNode,name);
if(previousNode&&!locale.empty()) previousNode->addAttribute(L"language",locale);
} else if ((name && !name[0]) || ignoreInteractiveUnlabelledGraphics) {
// alt="" or we've determined that all unlabelled graphics should be ignored,
// so don't render the graphic at all.
isInteractive = false;
} else if (isInteractive) {
// The graphic is unlabelled, but we should try to derive a name for it.
if (inLink && value) {
// derive the label from the link URL.
previousNode = buffer->addTextFieldNode(parentNode, previousNode, getNameForURL(value));
} else if ((IA2AttribsMapIt = IA2AttribsMap.find(L"src")) != IA2AttribsMap.end()) {
// Derive the label from the graphic URL.
previousNode = buffer->addTextFieldNode(parentNode, previousNode, getNameForURL(IA2AttribsMap[L"src"]));
}
}
} else if (!nameIsContent && value) {
previousNode=buffer->addTextFieldNode(parentNode,previousNode,value);
if(previousNode&&!locale.empty()) previousNode->addAttribute(L"language",locale);
}
}
if (!isEditable && (nameIsContent || role == IA2_ROLE_SECTION || role == IA2_ROLE_TEXT_FRAME) && !nodeHasUsefulContent(parentNode)) {
// If there is no useful content and the name can be the content,
// render the name if there is one.
if(name) {
tempNode = buffer->addTextFieldNode(parentNode, NULL, name);
if(tempNode && !locale.empty()) tempNode->addAttribute(L"language", locale);
} else if(role==ROLE_SYSTEM_LINK&&value) {
// If a link has no name, derive it from the URL.
buffer->addTextFieldNode(parentNode, NULL, getNameForURL(value));
}
}
if ((role == ROLE_SYSTEM_CELL || role == ROLE_SYSTEM_ROWHEADER || role == ROLE_SYSTEM_COLUMNHEADER||role==IA2_ROLE_UNKNOWN) && parentNode->getLength() == 0) {
// Always render a space for empty table cells and unknowns.
previousNode=buffer->addTextFieldNode(parentNode,previousNode,L" ");
if(previousNode&&!locale.empty()) previousNode->addAttribute(L"language",locale);
parentNode->isBlock=false;
}
if ((isInteractive || role == ROLE_SYSTEM_SEPARATOR) && parentNode->getLength() == 0) {
// If the node is interactive or otherwise relevant even when empty
// and it still has no content, render a space so the user can access the node.
previousNode=buffer->addTextFieldNode(parentNode,previousNode,L" ");
if(previousNode&&!locale.empty()) previousNode->addAttribute(L"language",locale);
}
}
// Clean up.
if(name)
SysFreeString(name);
if(value)
SysFreeString(value);
if (IA2Text)
SysFreeString(IA2Text);
if(paccText)
paccText->Release();
if(paccHypertext)
paccHypertext->Release();
if (releaseTable) {
if(paccTable2)
paccTable2->Release();
else
paccTable->Release();
}
return parentNode;
}
bool getDocumentFrame(HWND* hwnd, long* childID) {
IAccessible2* pacc=IAccessible2FromIdentifier(HandleToUlong(*hwnd),*childID);
if (!pacc)
return false;
IAccessible2* parentPacc=NULL;
VARIANT varChild;
varChild.vt=VT_I4;
varChild.lVal=*childID;
VARIANT varDisp;
if(pacc->accNavigate(NAVRELATION_NODE_CHILD_OF,varChild,&varDisp)!=S_OK) {
pacc->Release();
return false;
}
pacc->Release();
if(varDisp.vt!=VT_DISPATCH) {
VariantClear(&varDisp);
return false;
}
if(varDisp.pdispVal->QueryInterface(IID_IAccessible2,(void**)&parentPacc)!=S_OK) {
VariantClear(&varDisp);
return false;
}
VariantClear(&varDisp);
if(parentPacc==pacc) {
parentPacc->Release();
return false;
}
long role;
if(parentPacc->role(&role)!=S_OK||role!=IA2_ROLE_INTERNAL_FRAME) {
parentPacc->Release();
return false;
}
if(parentPacc->get_uniqueID(childID)!=S_OK||*childID>=0) {
parentPacc->Release();
return false;
}
if(parentPacc->get_windowHandle(hwnd)!=S_OK) {
parentPacc->Release();
return false;
}
parentPacc->Release();
return true;
}
void CALLBACK GeckoVBufBackend_t::renderThread_winEventProcHook(HWINEVENTHOOK hookID, DWORD eventID, HWND hwnd, long objectID, long childID, DWORD threadID, DWORD time) {
switch(eventID) {
case EVENT_OBJECT_FOCUS:
case EVENT_SYSTEM_ALERT:
case IA2_EVENT_TEXT_UPDATED:
case IA2_EVENT_TEXT_INSERTED:
case IA2_EVENT_TEXT_REMOVED:
case EVENT_OBJECT_REORDER:
case EVENT_OBJECT_NAMECHANGE:
case EVENT_OBJECT_VALUECHANGE:
case EVENT_OBJECT_DESCRIPTIONCHANGE:
case EVENT_OBJECT_STATECHANGE:
case IA2_EVENT_OBJECT_ATTRIBUTE_CHANGED:
break;
default:
return;
}
if(childID>=0||objectID!=OBJID_CLIENT)
return;
LOG_DEBUG(L"winEvent for window "<<hwnd);
hwnd=findRealMozillaWindow(hwnd);
if(!hwnd) {
LOG_DEBUG(L"Invalid window");
return;
}
int docHandle=HandleToUlong(hwnd);
int ID=childID;
VBufBackend_t* backend=NULL;
for(VBufBackendSet_t::iterator i=runningBackends.begin();i!=runningBackends.end();++i) {
HWND rootWindow=(HWND)UlongToHandle(((*i)->rootDocHandle));
if(rootWindow==hwnd||IsChild(rootWindow,hwnd))
backend=(*i);
else
continue;
LOG_DEBUG(L"found active backend for this window at "<<backend);
//For focus and alert events, force any invalid nodes to be updated right now
if(eventID==EVENT_OBJECT_FOCUS||eventID==EVENT_SYSTEM_ALERT) {
backend->forceUpdate();
continue;
}
//Ignore state change events on the root node (document) as it can cause rerendering when the document goes busy
if(eventID==EVENT_OBJECT_STATECHANGE&&hwnd==(HWND)UlongToHandle(backend->rootDocHandle)&&childID==backend->rootID)
return;
VBufStorage_controlFieldNode_t* node=backend->getControlFieldNodeWithIdentifier(docHandle,ID);
if(!node&&eventID==EVENT_OBJECT_STATECHANGE) {
// This event is possibly due to a new document loading in a subframe.
// Gecko doesn't fire a reorder on the iframe (Mozilla bug 420845), so we need to use NODE_CHILD_OF in this case so that frames will reload.
LOG_DEBUG(L"State change on an unknown node in a subframe, try NODE_CHILD_OF");
if (getDocumentFrame(&hwnd, &childID)) {
#ifdef DEBUG
Beep(2000,50);
#endif
LOG_DEBUG(L"Got NODE_CHILD_OF, recursing");
renderThread_winEventProcHook(hookID,eventID,hwnd,OBJID_CLIENT,childID,threadID,time);
} else
LOG_DEBUG(L"NODE_CHILD_OF failed, returning");
continue;
}
if(!node)
continue;
backend->invalidateSubtree(node);
}
}