Mercurial > libanimone

annotate src/a11y/win32.cc @ 24:f1b9adaa41b3

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
dep/animone: a11y/win32: fix missing ComInterface definition
author Paper <paper@paper.us.eu.org>
date Wed, 19 Jun 2024 23:21:19 -0400
parents 1cfa7d57c022
children 60ded877339b
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
23
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
1 #include <functional>
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
2 #include <string>
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
3 #include <vector>
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
4
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
5 #include <windows.h>
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
6 #include <uiautomation.h>
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
7
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
8 #include "animone/a11y.h"
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
9 #include "animone/a11y/win32.h"
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
10
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
11 namespace animone::internal::win32 {
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
12
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
13 // Windows Accessibility API reference:
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
14 // https://msdn.microsoft.com/en-us/library/windows/desktop/ff486375.aspx
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
15
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
16 // Commonly used interfaces
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
17 using Element = IUIAutomationElement;
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
18 using TreeWalker = IUIAutomationTreeWalker;
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
19 using ValuePattern = IUIAutomationValuePattern;
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
20
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
21 using element_proc_t = std::function<TreeScope(Element&)>;
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
22 using properties_t = std::vector<std::pair<long, bool>>;
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
23
24
f1b9adaa41b3 dep/animone: a11y/win32: fix missing ComInterface definition
Paper <paper@paper.us.eu.org>
parents: 23
diff changeset
24 /* ------------------------------------------------------------------- */
f1b9adaa41b3 dep/animone: a11y/win32: fix missing ComInterface definition
Paper <paper@paper.us.eu.org>
parents: 23
diff changeset
25
f1b9adaa41b3 dep/animone: a11y/win32: fix missing ComInterface definition
Paper <paper@paper.us.eu.org>
parents: 23
diff changeset
26 template <typename T>
f1b9adaa41b3 dep/animone: a11y/win32: fix missing ComInterface definition
Paper <paper@paper.us.eu.org>
parents: 23
diff changeset
27 struct ComInterfaceDeleter {
f1b9adaa41b3 dep/animone: a11y/win32: fix missing ComInterface definition
Paper <paper@paper.us.eu.org>
parents: 23
diff changeset
28 static_assert(std::is_base_of<IUnknown, T>::value, "Invalid COM interface");
f1b9adaa41b3 dep/animone: a11y/win32: fix missing ComInterface definition
Paper <paper@paper.us.eu.org>
parents: 23
diff changeset
29 using pointer = T*;
f1b9adaa41b3 dep/animone: a11y/win32: fix missing ComInterface definition
Paper <paper@paper.us.eu.org>
parents: 23
diff changeset
30 void operator()(pointer p) const { if (p) p->Release(); }
f1b9adaa41b3 dep/animone: a11y/win32: fix missing ComInterface definition
Paper <paper@paper.us.eu.org>
parents: 23
diff changeset
31 };
f1b9adaa41b3 dep/animone: a11y/win32: fix missing ComInterface definition
Paper <paper@paper.us.eu.org>
parents: 23
diff changeset
32
f1b9adaa41b3 dep/animone: a11y/win32: fix missing ComInterface definition
Paper <paper@paper.us.eu.org>
parents: 23
diff changeset
33 template <typename T>
f1b9adaa41b3 dep/animone: a11y/win32: fix missing ComInterface definition
Paper <paper@paper.us.eu.org>
parents: 23
diff changeset
34 using ComInterface = std::unique_ptr<T, ComInterfaceDeleter<T>>;
f1b9adaa41b3 dep/animone: a11y/win32: fix missing ComInterface definition
Paper <paper@paper.us.eu.org>
parents: 23
diff changeset
35
f1b9adaa41b3 dep/animone: a11y/win32: fix missing ComInterface definition
Paper <paper@paper.us.eu.org>
parents: 23
diff changeset
36 /* ------------------------------------------------------------------- */
f1b9adaa41b3 dep/animone: a11y/win32: fix missing ComInterface definition
Paper <paper@paper.us.eu.org>
parents: 23
diff changeset
37
23
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
38 // The main interface that is used throughout this file. Must be initialized
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
39 // before it can be used for the first time.
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
40 static ComInterface<IUIAutomation> ui_automation;
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
41
24
f1b9adaa41b3 dep/animone: a11y/win32: fix missing ComInterface definition
Paper <paper@paper.us.eu.org>
parents: 23
diff changeset
42 /* ------------------------------------------------------------------- */
23
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
43
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
44 static bool InitializeUIAutomation() {
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
45 if (ui_automation)
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
46 return true;
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
47
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
48 // COM library must be initialized on the current thread before calling
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
49 // CoCreateInstance.
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
50 ::CoInitialize(nullptr);
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
51
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
52 IUIAutomation* ui_automation_interface = nullptr;
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
53 const auto result = ::CoCreateInstance(
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
54 CLSID_CUIAutomation, nullptr, CLSCTX_INPROC_SERVER, IID_IUIAutomation,
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
55 reinterpret_cast<void**>(&ui_automation_interface));
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
56 ui_automation.reset(ui_automation_interface);
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
57
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
58 return SUCCEEDED(result);
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
59 }
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
60
24
f1b9adaa41b3 dep/animone: a11y/win32: fix missing ComInterface definition
Paper <paper@paper.us.eu.org>
parents: 23
diff changeset
61 /* ------------------------------------------------------------------- */
23
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
62
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
63 static Element* GetElementFromHandle(HWND hwnd) {
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
64 Element* element = nullptr;
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
65 ui_automation->ElementFromHandle(static_cast<UIA_HWND>(hwnd), &element);
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
66 return element;
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
67 }
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
68
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
69 static std::wstring GetElementName(Element& element) {
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
70 std::wstring element_name;
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
71
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
72 BSTR bstr = nullptr;
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
73 if (SUCCEEDED(element.get_CurrentName(&bstr)) && bstr) {
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
74 element_name = bstr;
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
75 ::SysFreeString(bstr);
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
76 }
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
77
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
78 return element_name;
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
79 }
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
80
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
81 static std::wstring GetElementValue(Element& element) {
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
82 std::wstring element_value;
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
83
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
84 ValuePattern* value_pattern_interface = nullptr;
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
85 element.GetCurrentPatternAs(
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
86 UIA_ValuePatternId, IID_PPV_ARGS(&value_pattern_interface));
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
87 ComInterface<ValuePattern> value_pattern(value_pattern_interface);
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
88
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
89 if (value_pattern) {
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
90 BSTR bstr = nullptr;
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
91 if (SUCCEEDED(value_pattern->get_CurrentValue(&bstr)) && bstr) {
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
92 element_value = bstr;
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
93 ::SysFreeString(bstr);
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
94 }
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
95 }
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
96
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
97 return element_value;
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
98 }
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
99
24
f1b9adaa41b3 dep/animone: a11y/win32: fix missing ComInterface definition
Paper <paper@paper.us.eu.org>
parents: 23
diff changeset
100 /* ------------------------------------------------------------------- */
23
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
101
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
102 static bool VerifyElementProperties(Element& element, const properties_t& properties) {
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
103 VARIANT v = {};
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
104 for (const auto& pair : properties) {
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
105 if (FAILED(element.GetCurrentPropertyValue(pair.first, &v)))
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
106 return false;
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
107 if (v.boolVal != (pair.second ? VARIANT_TRUE : VARIANT_FALSE))
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
108 return false;
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
109 }
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
110
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
111 return true;
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
112 }
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
113
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
114 static bool IsAddressBarElement(Element& element) {
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
115 static const properties_t properties = {
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
116 {UIA_IsEnabledPropertyId, true},
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
117 {UIA_IsKeyboardFocusablePropertyId, true},
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
118 {UIA_IsValuePatternAvailablePropertyId, true},
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
119 {UIA_ValueIsReadOnlyPropertyId, false},
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
120 };
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
121
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
122 return VerifyElementProperties(element, properties);
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
123 }
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
124
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
125 static bool IsTabsElement(Element& element) {
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
126 static const properties_t properties = {
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
127 {UIA_ValueIsReadOnlyPropertyId, true},
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
128 };
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
129
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
130 return VerifyElementProperties(element, properties);
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
131 }
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
132
24
f1b9adaa41b3 dep/animone: a11y/win32: fix missing ComInterface definition
Paper <paper@paper.us.eu.org>
parents: 23
diff changeset
133 /* ------------------------------------------------------------------- */
23
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
134
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
135 static void WalkElements(TreeWalker& tree_walker, Element& parent, TreeScope scope,
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
136 size_t depth, element_proc_t element_proc) {
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
137 constexpr size_t kMaxTreeDepth = 16; // arbitrary value
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
138 if (depth > kMaxTreeDepth)
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
139 return;
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
140
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
141 if (scope & TreeScope_Element)
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
142 scope = element_proc(parent);
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
143
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
144 auto descend = [](TreeScope scope) {
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
145 return (scope & TreeScope_Children) || (scope & TreeScope_Descendants);
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
146 };
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
147
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
148 if (descend(scope)) {
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
149 Element* first_element = nullptr;
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
150 tree_walker.GetFirstChildElement(&parent, &first_element);
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
151 ComInterface<Element> element(first_element);
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
152
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
153 while (element) {
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
154 scope = element_proc(*element);
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
155
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
156 if (descend(scope))
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
157 WalkElements(tree_walker, *element, scope, depth + 1, element_proc);
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
158
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
159 Element* next_element = nullptr;
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
160 tree_walker.GetNextSiblingElement(element.get(), &next_element);
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
161 element.reset(next_element);
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
162 }
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
163 }
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
164 }
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
165
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
166 static bool FindWebBrowserElements(Element& parent, std::wstring& address,
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
167 std::vector<std::wstring>& tabs) {
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
168 TreeWalker* tree_walker_interface = nullptr;
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
169 ui_automation->get_ControlViewWalker(&tree_walker_interface);
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
170 ComInterface<TreeWalker> tree_walker(tree_walker_interface);
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
171
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
172 if (!tree_walker)
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
173 return false;
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
174
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
175 auto element_proc = [&](Element& element) -> TreeScope {
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
176 CONTROLTYPEID control_type_id = 0;
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
177 element.get_CurrentControlType(&control_type_id);
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
178
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
179 switch (control_type_id) {
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
180 default:
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
181 // Are we done?
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
182 if (!address.empty() && !tabs.empty())
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
183 return TreeScope_Element;
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
184 // Otherwise continue descending the tree.
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
185 return TreeScope_Descendants;
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
186
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
187 case UIA_DocumentControlTypeId:
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
188 case UIA_MenuBarControlTypeId:
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
189 case UIA_TitleBarControlTypeId:
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
190 // We do not need to walk through these nodes. In fact, skipping
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
191 // documents dramatically improves our performance on worst case
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
192 // scenarios. This is the whole reason we are walking the tree rather
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
193 // than using FindFirst and FindAll methods.
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
194 return TreeScope_Element;
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
195
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
196 case UIA_EditControlTypeId:
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
197 // Here we assume that the first edit control that fits our properties
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
198 // is the address bar (e.g. "Omnibox" on Chrome, "Awesome Bar" on
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
199 // Firefox). This element is named differently on each web browser
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
200 // (e.g. "Address and search bar" on Chrome, "Search or enter address"
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
201 // on Firefox). This name can change depending on the browser
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
202 // language. However, we are only interested in the element value,
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
203 // which usually gives us the URL of the current page.
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
204 if (address.empty() && IsAddressBarElement(element)) {
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
205 address = GetElementValue(element);
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
206 return TreeScope_Element;
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
207 } else {
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
208 // Opera has an edit control ("Address field") within another edit
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
209 // control ("Address bar").
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
210 return TreeScope_Descendants;
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
211 }
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
212
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
213 case UIA_TabControlTypeId:
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
214 if (tabs.empty() && IsTabsElement(element))
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
215 return TreeScope_Children;
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
216 return TreeScope_Element;
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
217
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
218 case UIA_TabItemControlTypeId:
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
219 tabs.push_back(GetElementName(element));
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
220 return TreeScope_Element;
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
221 }
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
222 };
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
223
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
224 WalkElements(*tree_walker, parent, TreeScope_Subtree, 0, element_proc);
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
225 return true;
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
226 }
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
227
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
228 /* ------------------------------------------------------------------------------------ */
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
229
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
230 bool GetWebBrowserInformation(const Window& window, web_browser_proc_t web_browser_proc) {
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
231 if (!web_browser_proc)
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
232 return false;
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
233
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
234 if (!InitializeUIAutomation())
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
235 return false;
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
236
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
237 ComInterface<Element> parent(GetElementFromHandle(hwnd));
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
238 if (!parent)
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
239 return false;
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
240
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
241 const std::string title = ToUtf8String(GetElementName(*parent));
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
242 web_browser_proc({WebBrowserInformationType::Title, title});
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
243
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
244 std::wstring address;
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
245 std::vector<std::wstring> tabs;
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
246
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
247 if (!FindWebBrowserElements(*parent, address, tabs))
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
248 return false;
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
249
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
250 web_browser_proc({WebBrowserInformationType::Address, ToUtf8String(address)});
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
251 for (const auto& tab : tabs)
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
252 web_browser_proc({WebBrowserInformationType::Tab, ToUtf8String(tab)});
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
253
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
254 return true;
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
255 }
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
256
1cfa7d57c022 dep/animone: add experimental accessibility strategy
Paper <paper@paper.us.eu.org>
parents:
diff changeset
257 } // namespace animone::internal::win32