-
Notifications
You must be signed in to change notification settings - Fork 803
/
FBAccessibilityCommands.py
259 lines (219 loc) · 8.9 KB
/
FBAccessibilityCommands.py
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
#!/usr/bin/python
# Copyright (c) Facebook, Inc. and its affiliates. All Rights Reserved
#
# This source code is licensed under the MIT license found in the
# LICENSE file in the root directory of this source tree.
import os
import re
import fbchisellldbbase as fb
import fbchisellldbobjecthelpers as objHelpers
# This is the key corresponding to accessibility label in
# _accessibilityElementsInContainer:
ACCESSIBILITY_LABEL_KEY = 2001
def lldbcommands():
return [
FBPrintAccessibilityLabels(),
FBPrintAccessibilityIdentifiers(),
FBFindViewByAccessibilityLabelCommand(),
]
class FBPrintAccessibilityLabels(fb.FBCommand):
def name(self):
return "pa11y"
def description(self):
return "Print accessibility labels of all views in hierarchy of <aView>"
def args(self):
return [
fb.FBCommandArgument(
arg="aView",
type="UIView*",
help="The view to print the hierarchy of.",
default="(id)[[UIApplication sharedApplication] keyWindow]",
)
]
def run(self, arguments, options):
forceStartAccessibilityServer()
printAccessibilityHierarchy(arguments[0])
class FBPrintAccessibilityIdentifiers(fb.FBCommand):
def name(self):
return "pa11yi"
def description(self):
return "Print accessibility identifiers of all views in hierarchy of <aView>"
def args(self):
return [
fb.FBCommandArgument(
arg="aView",
type="UIView*",
help="The view to print the hierarchy of.",
default="(id)[[UIApplication sharedApplication] keyWindow]",
)
]
def run(self, arguments, option):
forceStartAccessibilityServer()
printAccessibilityIdentifiersHierarchy(arguments[0])
class FBFindViewByAccessibilityLabelCommand(fb.FBCommand):
def name(self):
return "fa11y"
def description(self):
return (
"Find the views whose accessibility labels match labelRegex "
"and puts the address of the first result on the clipboard."
)
def args(self):
return [
fb.FBCommandArgument(
arg="labelRegex",
type="string",
help="The accessibility label regex to search the view hierarchy for.",
)
]
def accessibilityGrepHierarchy(self, view, needle):
a11yLabel = accessibilityLabel(view)
# if we don't have any accessibility string - we should have some children
if int(a11yLabel.GetValue(), 16) == 0:
# We call private method that gives back all visible accessibility children
# for view iOS 10 and higher
if fb.evaluateBooleanExpression(
"[UIView respondsToSelector:@selector(_accessibilityElementsAndContainersDescendingFromViews:options:sorted:)]"
):
accessibilityElements = fb.evaluateObjectExpression(
"[UIView _accessibilityElementsAndContainersDescendingFromViews:@[(id)%s] options:0 sorted:NO]"
% view
)
else:
accessibilityElements = fb.evaluateObjectExpression(
"[[[UIApplication sharedApplication] keyWindow] _accessibilityElementsInContainer:0 topLevel:%s includeKB:0]"
% view
)
accessibilityElementsCount = fb.evaluateIntegerExpression(
"[%s count]" % accessibilityElements
)
for index in range(0, accessibilityElementsCount):
subview = fb.evaluateObjectExpression(
"[%s objectAtIndex:%i]" % (accessibilityElements, index)
)
self.accessibilityGrepHierarchy(subview, needle)
elif re.match(
r".*" + needle + ".*", a11yLabel.GetObjectDescription(), re.IGNORECASE
):
classDesc = objHelpers.className(view)
print(
"({} {}) {}".format(classDesc, view, a11yLabel.GetObjectDescription())
)
# First element that is found is copied to clipboard
if not self.foundElement:
self.foundElement = True
cmd = 'echo %s | tr -d "\n" | pbcopy' % view
os.system(cmd)
def run(self, arguments, options):
forceStartAccessibilityServer()
rootView = fb.evaluateObjectExpression(
"[[UIApplication sharedApplication] keyWindow]"
)
self.foundElement = False
self.accessibilityGrepHierarchy(rootView, arguments[0])
def isRunningInSimulator():
return (
fb.evaluateExpressionValue("(id)[[UIDevice currentDevice] model]")
.GetObjectDescription()
.lower()
.find("simulator")
>= 0
) or (
fb.evaluateExpressionValue("(id)[[UIDevice currentDevice] name]")
.GetObjectDescription()
.lower()
.find("simulator")
>= 0
)
def forceStartAccessibilityServer():
# We try to start accessibility server only if we don't have needed method active
if not fb.evaluateBooleanExpression(
"[UIView instancesRespondToSelector:@selector(_accessibilityElementsInContainer:)]"
):
# Starting accessibility server is different for simulator and device
if isRunningInSimulator():
fb.evaluateEffect(
"[[UIApplication sharedApplication] accessibilityActivate]"
)
else:
fb.evaluateEffect(
"[[[UIApplication sharedApplication] _accessibilityBundlePrincipalClass] _accessibilityStartServer]"
)
def accessibilityLabel(view):
# using Apple private API to get real value of accessibility string for element.
return fb.evaluateExpressionValue(
"(id)[%s accessibilityAttributeValue:%i]" % (view, ACCESSIBILITY_LABEL_KEY),
False,
)
def accessibilityIdentifier(view):
return fb.evaluateExpressionValue(
"(id)[{} accessibilityIdentifier]".format(view), False
)
def accessibilityElements(view):
if fb.evaluateBooleanExpression(
"[UIView instancesRespondToSelector:@selector(accessibilityElements)]"
):
a11yElements = fb.evaluateExpression(
"(id)[%s accessibilityElements]" % view, False
)
if int(a11yElements, 16) != 0:
return a11yElements
if fb.evaluateBooleanExpression(
"[%s respondsToSelector:@selector(_accessibleSubviews)]" % view
):
return fb.evaluateExpression("(id)[%s _accessibleSubviews]" % (view), False)
else:
return fb.evaluateObjectExpression(
"[[[UIApplication sharedApplication] keyWindow] _accessibilityElementsInContainer:0 topLevel:%s includeKB:0]"
% view
)
def printAccessibilityHierarchy(view, indent=0):
a11yLabel = accessibilityLabel(view)
classDesc = objHelpers.className(view)
indentString = " | " * indent
# if we don't have any accessibility string - we should have some children
if int(a11yLabel.GetValue(), 16) == 0:
print(indentString + ("{} {}".format(classDesc, view)))
# We call private method that gives back all visible accessibility children
# for view
a11yElements = accessibilityElements(view)
accessibilityElementsCount = int(
fb.evaluateExpression("(int)[%s count]" % a11yElements)
)
for index in range(0, accessibilityElementsCount):
subview = fb.evaluateObjectExpression(
"[%s objectAtIndex:%i]" % (a11yElements, index)
)
printAccessibilityHierarchy(subview, indent + 1)
else:
print(
indentString
+ ("({} {}) {}".format(classDesc, view, a11yLabel.GetObjectDescription()))
)
def printAccessibilityIdentifiersHierarchy(view, indent=0):
a11yIdentifier = accessibilityIdentifier(view)
classDesc = objHelpers.className(view)
indentString = " | " * indent
# if we don't have any accessibility identifier - we should have some children
if int(a11yIdentifier.GetValue(), 16) == 0:
print(indentString + ("{} {}".format(classDesc, view)))
# We call private method that gives back all visible accessibility children
# for view
a11yElements = accessibilityElements(view)
accessibilityElementsCount = int(
fb.evaluateExpression("(int)[%s count]" % a11yElements)
)
for index in range(0, accessibilityElementsCount):
subview = fb.evaluateObjectExpression(
"[%s objectAtIndex:%i]" % (a11yElements, index)
)
printAccessibilityIdentifiersHierarchy(subview, indent + 1)
else:
print(
indentString
+ (
"({} {}) {}".format(
classDesc, view, a11yIdentifier.GetObjectDescription()
)
)
)