Feature: Accessibility Tree printing

commands/FBPrintCommands.py

@@ -15,6 +15,7 @@
 import fblldbviewcontrollerhelpers as vcHelpers
 import fblldbviewhelpers as viewHelpers
 import fblldbobjcruntimehelpers as runtimeHelpers
+import fblldbobjecthelpers as objectHelpers
 
 def lldbcommands():
   return [
@@ -28,6 +29,8 @@ def lldbcommands():
     FBPrintOnscreenTableViewCells(),
     FBPrintInternals(),
     FBPrintInstanceVariable(),
+    FBPrintKeyPath(),
+    FBPrintAccessibilityTree(),
   ]
 
 class FBPrintViewHierarchyCommand(fb.FBCommand):
@@ -272,3 +275,40 @@ def run(self, arguments, options):
 
     printCommand = 'po' if ('@' in ivarTypeEncodingFirstChar) else 'p'
     lldb.debugger.HandleCommand('{} (({} *)({}))->{}'.format(printCommand, objectClass, object, ivarName))
+
+class FBPrintKeyPath(fb.FBCommand):
+  def name(self):
+    return 'pkp'
+
+  def description(self):
+    return "Print out the value of the key path expression using -valueForKeyPath:"
+
+  def args(self):
+    return [
+      fb.FBCommandArgument(arg='keypath', type='NSString *', help='The keypath to print'),
+    ]
+
+  def run(self, arguments, options):
+    if len(arguments[0].split('.')) == 1:
+      print '"' + arguments[0] + '" is not a keypath =('
+      return
+
+    object, keypath = arguments[0].split('.', 1)
+    printCommand = 'po [{} valueForKeyPath:@"{}"]'.format(object, keypath)
+    lldb.debugger.HandleCommand(printCommand)
+
+class FBPrintAccessibilityTree(fb.FBCommand):
+  def name(self):
+    return 'pae'
+
+  def description(self):
+    return "Print out the accessibility heirarchy.   Traverses the accessibilityElements if present, otherwise the subviews."
+
+  def args(self):
+    return [
+      fb.FBCommandArgument(arg='object', type='id', help='The object to print accessibility information for'),
+    ]
+
+  def run(self, arguments, options):
+    object = fb.evaluateObjectExpression(arguments[0])
+    return viewHelpers.accessibilityRecursiveDescription(object, "")

fblldbobjecthelpers.py

@@ -15,4 +15,30 @@ def isKindOfClass(obj, className):
   return fb.evaluateBooleanExpression(isKindOfClassStr.format(className))
 
 def className(obj):
-  return fb.evaluateExpressionValue('(id)[(' + obj + ') class]').GetObjectDescription()
+  return fb.evaluateExpressionValue('(id)[(%s) class]' % (obj)).GetObjectDescription()
+
+def valueForKey(obj, key):
+  return fb.evaluateExpressionValue('(id)[%s valueForKey:@"%s"]' % (obj, key)).GetObjectDescription()
+
+def isNil(obj):
+  return obj == "<nil>" or obj == "<object returned empty description>"
+
+def displayValueForKey(obj, key):
+  value = valueForKey(obj, key)
+  return "{}='{}'".format(key, value) if not isNil(value) else ""
+
+def displayValueForKeys(obj, keys):
+  def displayValueForThisObjectKey(key):
+    return displayValueForKey(obj, key)
+  return " ".join(map(displayValueForThisObjectKey, keys))
+
+def displayObjectWithString(obj, string):
+  return "<{}:{} {}>".format(
+    className(obj),
+    obj,
+    string)
+
+def displayObjectWithKeys(obj, keys):
+  return displayObjectWithString(obj, displayValueForKeys(obj, keys))
+
+

fblldbviewhelpers.py

@@ -8,8 +8,9 @@
 # of patent rights can be found in the PATENTS file in the same directory.
 
 import lldb
-
+import re
 import fblldbbase as fb
+import fblldbobjecthelpers as objectHelpers
 
 def flushCoreAnimationTransaction():
   lldb.debugger.HandleCommand('expr (void)[CATransaction flush]')
@@ -84,6 +85,69 @@ def upwardsRecursiveDescription(view, maxDepth=0):
   builder = ""
   for viewDescription in recursiveDescription:
     builder += currentPrefix + viewDescription + "\n"
-    currentPrefix += "   | "
-  
+  currentPrefix += "   | "
+
   return builder
+
+# GetObjectDescription will try to return the pointer.
+# However on UIAccessibilityElements, the result will look like this:
+#  [UITableViewSectionElement]{0x79eb2280} section: 0 (isHeader: 1)
+#  [UITableViewCellAccessibilityElement - 0x79eac160] <.....
+# So, just get the first hex address
+def firstHexInDescription(object):
+  return re.findall(r'0x[0-9A-F]+', "{}".format(object), re.I)[0]
+
+def evaluateIntegerExpression(expression):
+  output = fb.evaluateExpression('(int)(' + expression + ')', True).replace('\'', '')
+  return int (output, 10)
+
+def accessibilityDescription(object):
+  if isAccessibilityElement(object):
+    return objectHelpers.displayObjectWithKeys(object, ["accessibilityLabel", "accessibilityValue", "accessibilityHint"])
+  else:
+    return objectHelpers.displayObjectWithString(object, "isAccessibilityElement=NO")
+
+def accessibilityElementCount(object):
+  cmd = "(int)[%s accessibilityElementCount]" % (object)
+  return evaluateIntegerExpression(cmd)
+
+def isAccessibilityElement(object):
+  return fb.evaluateBooleanExpression('[(id)%s isAccessibilityElement]' % object)
+
+def accessibilityElementAtIndex(object, index):
+  cmd = '(id)[%s accessibilityElementAtIndex:%s]' % (object, index)
+  obj = firstHexInDescription(fb.evaluateExpressionValue(cmd))
+  return obj
+
+def accessibilityChildren(object):
+  accessibilityCount = accessibilityElementCount(object)
+  aeChildren = []
+  if accessibilityCount != 0x7fffffff:
+    for i in range(0, accessibilityCount):
+      aeChildren.append(accessibilityElementAtIndex(object, i))
+  return aeChildren
+
+def subviews(view):
+  subviewResult = []
+  responds = fb.evaluateBooleanExpression('[(id)%s respondsToSelector:(SEL)@selector(subviews)]' % view)
+  if responds:
+    subviews = fb.evaluateExpression('(id)[%s subviews]' % view)
+    subviewsCount = evaluateIntegerExpression('[(id)%s count]' % subviews)
+    if subviewsCount > 0:
+      for i in range(0, subviewsCount):
+        subview = fb.evaluateExpression('(id)[%s objectAtIndex:%i]' % (subviews, i))
+        subviewResult.append(subview)
+  return subviewResult
+
+
+def accessibilityRecursiveDescription(object, prefix="", childType=""):
+  print '%s%s%s' % (prefix, childType, accessibilityDescription(object))
+  nextPrefix = prefix + '    |'
+  aeChildren = accessibilityChildren(object)
+  for ae in aeChildren:
+      accessibilityRecursiveDescription(ae, nextPrefix, 'A ')
+
+  if len(aeChildren) == 0:
+    for subview in subviews(object):
+      accessibilityRecursiveDescription(subview, nextPrefix, 'S ')
+