Merge lp:~bregma/geis/lp-921633 into lp:geis

[Stephen M. Webb]

Adds an init flag to geis_new() to enable blocking startup. Using the GEIS_INIT_SYNCHRONOUS_START flag will cause geis_new() to block until either initialization is complete, initialization has failed, or 5 seconds has elapsed, whichever comes first. Without the new init flag, geis_new() completes asynchronously as before.

The GEISv1 interface was modified to use this init flag instead of performing its own internal wait loop. Running the geistest tool exercises the new functionality, running the geisview tool exercises the older functionality.

This change closes lp:921633.

[Daniel d'Andrada (dandrader)]

    #define GEIS_INIT_SYNCHRONOUS_START "org.libgeis.init.synchronous.start"

To keep consistency with the other org.libgeis.init.*, maybe it should be "org.libgeis.init.synchronous-start" instead (s/.start/-start).

[Daniel d'Andrada (dandrader)]

In ibutouch-geis/geis.c
 742 | static void
 743 | _geis_destroy(Geis geis)

Unrelated cosmetic change.

[Daniel d'Andrada (dandrader)]

In libutouch-geis/geis_v1.c:

534 -- instance->geis = geis_new(GEIS_INIT_TRACK_DEVICES,
535 -- GEIS_INIT_TRACK_GESTURE_CLASSES,
536 -- NULL);
491 ++ instance->geis = geis_new(GEIS_INIT_SYNCHRONOUS_START, NULL);

I think GEIS_INIT_TRACK_DEVICES and GEIS_INIT_TRACK_GESTURE_CLASSES should be kept there since their removal doesn't seem related with the objective of this patch. Same for the pygeis change.

[Daniel d'Andrada (dandrader)]

Other than those small details it looks good.

review: Approve

[lp:~bregma/geis/lp-921633]

207. By Stephen M. Webb on 2012-02-23

integrated suggested changes from review

=== modified file 'include/geis/geis.h'
--- include/geis/geis.h	2012-02-22 18:41:32 +0000
+++ include/geis/geis.h	2012-02-23 19:46:19 +0000
@@ -459,11 +459,16 @@
  * @def GEIS_INIT_TRACK_GESTURE_CLASSES
  * Tells GEIS to send gesture class events.
  * This initialization argument takes no parameters.
+ *
+ * @def GEIS_INIT_SYNCHRONOUS_START
+ * Performs all setup synchronously: geis_new() will block until all setup has
+ * completed successfully or unsuccessfully.
  */
 
 #define GEIS_INIT_SERVICE_PROVIDER     "org.libgeis.init.server"
 #define GEIS_INIT_TRACK_DEVICES        "org.libgeis.init.track-devices"
 #define GEIS_INIT_TRACK_GESTURE_CLASSES  "org.libgeis.init.track-gesture-classes"
+#define GEIS_INIT_SYNCHRONOUS_START      "org.libgeis.init.synchronous-start"
 
 /* @} */
 

=== modified file 'libutouch-geis/geis.c'
--- libutouch-geis/geis.c	2012-02-12 04:45:01 +0000
+++ libutouch-geis/geis.c	2012-02-23 19:46:19 +0000
@@ -42,9 +42,30 @@
 #include "geis_logging.h"
 #include <stdarg.h>
 #include <string.h>
+#include <sys/select.h>
 #include <unistd.h>
 
 
+/** Default timeout for synchronous init (in seconds */
+#define GEIS_DEFAULT_INIT_TIMEOUT 5
+
+/**
+ * States the GEIS instance could be in.
+ *
+ * @def GEIS_STATE_INITIALIZING
+ * The instance has not yet completed its initialization sequence: some
+ * functions will not yield valid results.
+ *
+ * @def GEIS_STATE_RUNNING
+ * Initialization has completed, the instance is up and running normally.
+ */
+typedef enum _GeisState
+{
+  GEIS_STATE_INITIALIZING,
+  GEIS_STATE_RUNNING
+} _GeisState;
+
+
 /*
  * An internal structure to track processing callbacks in some order.
  */
@@ -65,6 +86,7 @@
 struct _Geis
 {
   GeisRefCount            refcount;
+  _GeisState              state;
   GeisErrorStack          error_stack;
   GeisSubBag              subscription_bag;
   GeisBackendMultiplexor  backend_multiplexor;
@@ -89,6 +111,7 @@
   FilterableAttributeBag  region_filterable_attributes;
   FilterableAttributeBag  special_filterable_attributes;
   GeisGestureFlick        flick;
+  GeisBoolean             use_synchronous_start;
   GeisBoolean             use_atomic_gestures;
   GeisBoolean             send_tentative_events;
   GeisBoolean             send_synchronous_events;
@@ -234,6 +257,7 @@
 	  break;
 
         case GEIS_EVENT_INIT_COMPLETE:
+          geis->state = GEIS_STATE_RUNNING;
           geis->backend_pending = GEIS_FALSE;
           break;
 
@@ -375,6 +399,8 @@
     goto final_exit;
   }
 
+  geis->state = GEIS_STATE_INITIALIZING;
+
   geis->subscription_bag = geis_subscription_bag_new(1);
   if (!geis->subscription_bag)
   {
@@ -468,6 +494,7 @@
     goto unwind_region_attrs;
   }
 
+  geis->use_synchronous_start = GEIS_FALSE;
   geis->use_atomic_gestures = GEIS_TRUE;
   geis->send_tentative_events = GEIS_FALSE;
   geis->send_synchronous_events = GEIS_FALSE;
@@ -535,6 +562,10 @@
     {
       /* no longer supported */
     }
+    else if (0 == strcmp(init_arg_name, GEIS_INIT_SYNCHRONOUS_START))
+    {
+      geis->use_synchronous_start = GEIS_TRUE;
+    }
     else if (0 == strcmp(init_arg_name, GEIS_INIT_NO_ATOMIC_GESTURES))
     {
       geis->use_atomic_gestures = GEIS_FALSE;
@@ -619,6 +650,51 @@
 
 
 /**
+ * Performs a blocking wait for a GEIS_INIT message.
+ */
+static GeisStatus
+_geis_wait_for_init(Geis geis)
+{
+  geis_debug("waiting for initialization to complete...");
+  GeisStatus status = GEIS_STATUS_UNKNOWN_ERROR;
+  int geis_fd = geis_backend_multiplexor_fd(geis->backend_multiplexor);
+
+  while (1)
+  {
+    fd_set read_fds;
+    FD_ZERO(&read_fds);
+    FD_SET(geis_fd, &read_fds);
+    struct timeval timeout = { GEIS_DEFAULT_INIT_TIMEOUT, 0 };
+
+    int sstat = select(geis_fd + 1, &read_fds, NULL, NULL, &timeout);
+    if (sstat < 0)
+    {
+      geis_error("error %d in select(): %s", errno, strerror(errno));
+      break;
+    }
+    else if (sstat == 0)
+    {
+      geis_error("failed to get init response");
+      break;
+    }
+
+    if (FD_ISSET(geis_fd, &read_fds))
+    {
+      status = geis_dispatch_events(geis);
+      if (geis->state == GEIS_STATE_RUNNING)
+      {
+        status = GEIS_STATUS_SUCCESS;
+        break;
+      }
+    }
+  }
+
+  geis_debug("... initialization complete, status=%d", status);
+  return status;
+}
+
+
+/**
  * Creates an initialized Geis API instance.
  */
 Geis
@@ -644,6 +720,18 @@
     geis = NULL;
     goto final_exit;
   }
+
+  if (geis->use_synchronous_start)
+  {
+    GeisStatus status = _geis_wait_for_init(geis);
+    if (status != GEIS_STATUS_SUCCESS)
+    {
+      geis_delete(geis);
+      geis = NULL;
+      goto final_exit;
+    }
+  }
+
   geis->flick = geis_gesture_flick_new(geis);
 
 final_exit:

=== modified file 'libutouch-geis/geis_v1.c'
--- libutouch-geis/geis_v1.c	2012-02-15 20:31:36 +0000
+++ libutouch-geis/geis_v1.c	2012-02-23 19:46:19 +0000
@@ -42,7 +42,6 @@
   GeisPointer       input_context;
   GeisGestureFuncs  gesture_funcs;
   GeisPointer       gesture_cookie;
-  GeisBoolean       has_init;
   GeisBoolean       init_failed;
 };
 
@@ -336,13 +335,11 @@
   switch (geis_event_type(event))
   {
     case GEIS_EVENT_INIT_COMPLETE:
-      geis_debug("received INIT_COMPLETE");
-      v1_instance->has_init = GEIS_TRUE;
+      geis_debug("received INIT event");
       goto final_exit;
 
     case GEIS_EVENT_ERROR:
       geis_debug("received ERROR event");
-      v1_instance->has_init = GEIS_TRUE;
       v1_instance->init_failed = GEIS_TRUE;
       goto final_exit;
 
@@ -460,46 +457,6 @@
 }
 
 
-static void
-_geis_v1_wait_for_init(GeisInstance geis_instance)
-{
-  int geis_fd = -1;
-  GeisStatus status = geis_get_configuration(geis_instance->geis,
-                                             GEIS_CONFIGURATION_FD,
-                                             &geis_fd);
-  if (status == GEIS_STATUS_SUCCESS)
-  {
-    while (1)
-    {
-      fd_set read_fds;
-      FD_ZERO(&read_fds);
-      FD_SET(geis_fd, &read_fds);
-      struct timeval timeout = { 5, 0 }; /* wait up to 5 seconds */
-
-      int sstat = select(geis_fd + 1, &read_fds, NULL, NULL, &timeout);
-      if (sstat < 0)
-      {
-        geis_error("error %d in select(): %s", errno, strerror(errno));
-        break;
-      }
-      else if (sstat == 0)
-      {
-        geis_error("failed to get init response");
-        geis_instance->init_failed = GEIS_TRUE;
-        break;
-      }
-
-      if (FD_ISSET(geis_fd, &read_fds))
-      {
-        status = geis_dispatch_events(geis_instance->geis);
-        if (geis_instance->has_init)
-          break;
-      }
-    }
-  }
-}
-
-
 GeisStatus
 geis_init(GeisWinInfo* win_info, GeisInstance *geis_instance)
 {
@@ -533,6 +490,7 @@
   {
     instance->geis = geis_new(GEIS_INIT_TRACK_DEVICES,
                               GEIS_INIT_TRACK_GESTURE_CLASSES,
+                              GEIS_INIT_SYNCHRONOUS_START,
                               NULL);
   }
   if (!instance->geis)
@@ -541,11 +499,6 @@
   }
 
   geis_register_event_callback(instance->geis, _v1_event_callback, instance);
-  _geis_v1_wait_for_init(instance);
-  if (instance->init_failed)
-  {
-    goto unwind_instance;
-  }
 
   instance->subscription = geis_subscription_new(instance->geis,
                           _generate_subscription_name(xcb_win_info),
@@ -558,7 +511,6 @@
   status = geis_subscription_add_filter(instance->subscription,
                                         instance->window_filter);
 
-  instance->has_init = GEIS_FALSE;
   instance->init_failed = GEIS_FALSE;
 
   *geis_instance = instance;

=== modified file 'python/_geis_bindings/_geis_bindings.c'
--- python/_geis_bindings/_geis_bindings.c	2011-11-21 21:32:47 +0000
+++ python/_geis_bindings/_geis_bindings.c	2012-02-23 19:46:19 +0000
@@ -53,6 +53,7 @@
   PyModule_AddStringMacro(this_module, GEIS_INIT_SERVICE_PROVIDER);
   PyModule_AddStringMacro(this_module, GEIS_INIT_TRACK_DEVICES);
   PyModule_AddStringMacro(this_module, GEIS_INIT_TRACK_GESTURE_CLASSES);
+  PyModule_AddStringMacro(this_module, GEIS_INIT_SYNCHRONOUS_START);
   PyModule_AddStringMacro(this_module, GEIS_INIT_UTOUCH_MOCK_BACKEND);
   PyModule_AddStringMacro(this_module, GEIS_INIT_UTOUCH_DBUS_BACKEND);
   PyModule_AddStringMacro(this_module, GEIS_INIT_UTOUCH_GRAIL_BACKEND);

=== modified file 'python/geis/__init__.py'
--- python/geis/__init__.py	2011-12-19 22:15:23 +0000
+++ python/geis/__init__.py	2012-02-23 19:46:19 +0000
@@ -34,6 +34,7 @@
         'GEIS_INIT_SERVICE_PROVIDER',
         'GEIS_INIT_TRACK_DEVICES',
         'GEIS_INIT_TRACK_GESTURE_CLASSES',
+        'GEIS_INIT_SYNCHRONOUS_START',
         'GEIS_INIT_UTOUCH_MOCK_BACKEND',
         'GEIS_INIT_UTOUCH_DBUS_BACKEND',
         'GEIS_INIT_UTOUCH_GRAIL_BACKEND',

=== modified file 'python/pygeis'
--- python/pygeis	2011-05-27 12:50:51 +0000
+++ python/pygeis	2012-02-23 19:46:19 +0000
@@ -119,7 +119,8 @@
       sys.exit(1)
 
     g = geis.Geis(geis.GEIS_INIT_TRACK_DEVICES,
-                  geis.GEIS_INIT_TRACK_GESTURE_CLASSES)
+                  geis.GEIS_INIT_TRACK_GESTURE_CLASSES,
+                  geis.GEIS_INIT_SYNCHRONOUS_START)
     geis_fd = g.get_configuration(geis.GEIS_CONFIGURATION_FD)
     sub = geis.Subscription(g)
     g.register_class_callback(_class_callback, sub)