Merge lp:~mardy/autopilot-gtk/atk into lp:autopilot-gtk

[Alberto Mardegan]

Export the ATK objects hierarchy as well

AtkObject interfaces are meant for accessibility, and expose more information
which can be useful for automated testing. For instance, it is possible to
enumerate and introspect all the cells in a GtkTreeView.

This patch exposes the ATK objects hierarchies as children of the root node;
the existing GtkWidget hierarchy is left untouched, and can still be used.

Export the ATK objects hierarchy as well

AtkObject interfaces are meant for accessibility, and expose more information
which can be useful for automated testing. For instance, it is possible to
enumerate and introspect all the cells in a GtkTreeView.

This patch exposes the ATK objects hierarchies as children of the root node;
the existing GtkWidget hierarchy is left untouched, and can still be used.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:33
http://jenkins.qa.ubuntu.com/job/autopilot-gtk-ci/1/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-gtk-raring-amd64-ci/1
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-gtk-raring-armhf-ci/1

Click here to trigger a rebuild:
http://s-jenkins:8080/job/autopilot-gtk-ci/1/rebuild

review: Approve (continuous-integration)

[lp:~mardy/autopilot-gtk/atk]

34. By Alberto Mardegan on 2013-04-03

Skip accessible-table-* properties

These properties are not implemented (ATK bug?).

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:34
http://jenkins.qa.ubuntu.com/job/autopilot-gtk-ci/27/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-gtk-raring-amd64-ci/2
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-gtk-raring-armhf-ci/2

Click here to trigger a rebuild:
http://s-jenkins:8080/job/autopilot-gtk-ci/27/rebuild

review: Approve (continuous-integration)

[Allan LeSage (allanlesage)]

Alberto, would you offer a sample script or two for my testing convenience?

To this point I'm attempting just to 'autopilot launch gedit' and to inspect the properties using autopilot vis; I'm finding that the globalRects are giving absurd numbers--is this not true for you?

Lastly I wonder if you'd object to just making a function out of the EXPORT_STATE macro--I'm trying to hang on to a C++-like standard for the project, at least for the moment :) .

[lp:~mardy/autopilot-gtk/atk]

35. By Alberto Mardegan on 2013-04-16

Remove usage of preprocessor macro

[Alberto Mardegan (mardy)]

> Alberto, would you offer a sample script or two for my testing convenience?
>
> To this point I'm attempting just to 'autopilot launch gedit' and to inspect
> the properties using autopilot vis; I'm finding that the globalRects are
> giving absurd numbers--is this not true for you?

Yes. Unfortunately unless the items are visible on screen, those values are bogus.
But they are correct, when the item is actually on screen.

> Lastly I wonder if you'd object to just making a function out of the
> EXPORT_STATE macro--I'm trying to hang on to a C++-like standard for the
> project, at least for the moment :) .

I removed the macro now. It's not worth to make it a function, as it would take 4 parameters so in practice not make the code any easier to read. :-)

[Alberto Mardegan (mardy)]

And I forgot, an example is here:
http://bazaar.launchpad.net/~online-accounts/uoa-integration-tests/trunk/view/head:/online-accounts/tests/test_control_center_signon.py

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:35
http://jenkins.qa.ubuntu.com/job/autopilot-gtk-ci/28/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-gtk-raring-amd64-ci/3
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-gtk-raring-armhf-ci/3

Click here to trigger a rebuild:
http://s-jenkins:8080/job/autopilot-gtk-ci/28/rebuild

review: Approve (continuous-integration)

[Allan LeSage (allanlesage)]

I was able to write a small test to experiment with ATK-bindings; thanks Alberto for your changes.

review: Approve

=== modified file 'lib/GtkNode.cpp'
--- lib/GtkNode.cpp	2013-01-31 21:10:24 +0000
+++ lib/GtkNode.cpp	2013-04-16 05:36:24 +0000
@@ -22,12 +22,17 @@
 
 #include <string>
 #include "GtkNode.h"
-#include "Variant.h"
 
 const std::string GtkNode::AP_ID_NAME = "id";
 
 GtkNode::GtkNode(GObject* obj)
   : object_(obj) {
+  if (object_ != NULL) g_object_ref(object_);
+}
+
+GtkNode::~GtkNode()
+{
+  g_clear_object(&object_);
 }
 
 GVariant* GtkNode::Introspect() const
@@ -41,6 +46,10 @@
   variant::BuilderWrapper builder_wrapper(&builder);
   for (uint i = 0; i < length; ++i) {
     GParamSpec* param_spec = properties[i];
+    // ATK's accessible-table-* properties generate "invalid property id" warnings
+    std::string prefix("accessible-table-");
+    if (std::string(g_param_spec_get_name(param_spec)).compare(0, prefix.length(), prefix) == 0)
+      continue;
     // see Launchpad bug #1108155: GtkTreePath mis-casts while copying, actuates here in "root" property
     if (std::string(g_type_name(param_spec->value_type)) != "GtkTreePath") {
       // some properties are only writeable; some toxic nodes change their names (?)
@@ -75,6 +84,8 @@
       GVariant *rect_gvariant = ComposeRectVariant(rect.x, rect.y, rect.width, rect.height);
       builder_wrapper.add("globalRect", rect_gvariant);
     }
+  } else if (ATK_IS_COMPONENT(object_)) {
+    AddAtkComponentProperties(builder_wrapper, ATK_COMPONENT(object_));
   }
   return g_variant_builder_end(&builder);
 }
@@ -91,6 +102,43 @@
   return g_variant_builder_end(&builder);
 }
 
+void GtkNode::AddAtkComponentProperties(variant::BuilderWrapper &builder_wrapper,
+                                        AtkComponent *atk_component) const
+{
+  AtkStateSet *states = atk_object_ref_state_set(ATK_OBJECT(atk_component));
+
+  /* Expose a few states which might be especially interesting for autopilot */
+  bool visible = atk_state_set_contains_state(states, ATK_STATE_VISIBLE);
+  builder_wrapper.add("visible", visible);
+  if (visible) {
+    gint x, y, width, height;
+    atk_component_get_extents(atk_component, &x, &y, &width, &height,
+                              ATK_XY_SCREEN);
+    GVariant *rect_gvariant = ComposeRectVariant(x, y, width, height);
+    builder_wrapper.add("globalRect", rect_gvariant);
+  }
+
+  builder_wrapper.add("active",
+                      bool(atk_state_set_contains_state(states, ATK_STATE_ACTIVE)));
+  builder_wrapper.add("checked",
+                      bool(atk_state_set_contains_state(states, ATK_STATE_CHECKED)));
+  builder_wrapper.add("editable",
+                      bool(atk_state_set_contains_state(states, ATK_STATE_EDITABLE)));
+  builder_wrapper.add("enabled",
+                      bool(atk_state_set_contains_state(states, ATK_STATE_ENABLED)));
+  builder_wrapper.add("focused",
+                      bool(atk_state_set_contains_state(states, ATK_STATE_FOCUSED)));
+  builder_wrapper.add("pressed",
+                      bool(atk_state_set_contains_state(states, ATK_STATE_PRESSED)));
+  builder_wrapper.add("selected",
+                      bool(atk_state_set_contains_state(states, ATK_STATE_SELECTED)));
+  builder_wrapper.add("sensitive",
+                      bool(atk_state_set_contains_state(states, ATK_STATE_SENSITIVE)));
+  builder_wrapper.add("showing",
+                      bool(atk_state_set_contains_state(states, ATK_STATE_SHOWING)));
+  g_object_unref(G_OBJECT(states));
+}
+
 intptr_t GtkNode::GetObjectId() const {
   return reinterpret_cast<intptr_t>(object_);
 }
@@ -154,6 +202,13 @@
       children.push_back(std::make_shared<GtkNode>(G_OBJECT(elem->data)));
     }
     g_list_free(gtk_children);
+  } else if (ATK_IS_OBJECT(object_)) {
+    AtkObject *atk_object = ATK_OBJECT(object_);
+    int n_children = atk_object_get_n_accessible_children(atk_object);
+    for (int i = 0; i < n_children; i++) {
+      AtkObject *child = atk_object_ref_accessible_child(atk_object, i);
+      children.push_back(std::make_shared<GtkNode>(G_OBJECT(child)));
+    }
   }
 
   return children;

=== modified file 'lib/GtkNode.h'
--- lib/GtkNode.h	2013-01-30 20:09:43 +0000
+++ lib/GtkNode.h	2013-04-16 05:36:24 +0000
@@ -25,12 +25,14 @@
 #include <xpathselect/node.h>
 #include <xpathselect/xpathselect.h>
 #include <string>
+#include "Variant.h"
 
 class GtkNode: public xpathselect::Node {
 public:
   typedef std::shared_ptr<GtkNode> Ptr;
 
   GtkNode(GObject* object);
+  virtual ~GtkNode();
 
   virtual GVariant* Introspect() const;
 
@@ -48,6 +50,8 @@
   virtual intptr_t GetObjectId() const;
   virtual void GetGlobalRect(GdkRectangle* rect) const;
   virtual GVariant* ComposeRectVariant(gint x, gint y, gint height, gint width) const;
+  void AddAtkComponentProperties(variant::BuilderWrapper &builder_wrapper,
+                                 AtkComponent *atk_component) const;
 };
 
 #endif // GTKNODE_H

=== modified file 'lib/GtkRootNode.cpp'
--- lib/GtkRootNode.cpp	2013-01-31 21:10:24 +0000
+++ lib/GtkRootNode.cpp	2013-04-16 05:36:24 +0000
@@ -69,6 +69,11 @@
   for (elem = toplevels_list; elem; elem = elem->next) {
     GObject *node = reinterpret_cast<GObject*>(elem->data);
     children.push_back(std::make_shared<GtkNode>(node));
+
+    // if the AtkObjects are available, expose the Atk hierarchy as well
+    AtkObject *atk_object = gtk_widget_get_accessible(GTK_WIDGET(node));
+    if (atk_object != NULL)
+        children.push_back(std::make_shared<GtkNode>(G_OBJECT(atk_object)));
   }
   g_list_free(toplevels_list);
   return children;