Merge lp:~oif-team/geis/geis2-add-subscription-activation into lp:geis

[Stephen M. Webb]

Two smaller enabling changes that set the stage for back end implementations.

(1) Add a call pair for back ends to multiplex/demultiplex their file descriptors through the Geis API instance.

(2) Add the GEIS v2.0 subscription activation functions and associated forwarding function to propagate the calls through to the back ends.

Test cases are included.

[Henrik Rydberg (rydberg)]

Just a couple of typos:

+ * Asks the back end to create a descibed subscription.

+ * Asks a back end to removed a subscription.

Thanks!

[lp:~oif-team/geis/geis2-add-subscription-activation]

95. By Stephen M. Webb on 2010-12-13

Added GEIS v2.0 subscription activation calls.

[Stephen M. Webb (bregma)]

Typos fixed.

[Chase Douglas (chasedouglas)]

No problems here.

review: Approve

=== modified file 'ChangeLog'
--- ChangeLog	2010-12-13 14:13:50 +0000
+++ ChangeLog	2010-12-13 14:13:50 +0000
@@ -1,3 +1,39 @@
[phone]  Stephen M. Webb  <[e-mail]>
+
+  Added GEIS v2.0 subscription activation calls.
+
+  * include/geis/geis.h (geis_subscription_activate): new function
+    (geis_subscription_deactivate): new function
+  * libutouch-geis/geis_subscription.c: implemented above new functions
+  * libutouch-geis/geis_backend.h (geis_backend_subscribe) new function
+    (geis_backend_unsubscribe): new function
+  * libutouch-geis/geis_backend.c: implemented above new functions
+  * libutouch-geis/geis_backend_protected.h (GeisBackendVtable): added new
+    subscribe and unsubscribe function pointers
+  * libutouch-geis/geis_backend_test_fixture.c (_subscribe): new vfunction
+    (_unsubscribe): new vfunction
+  * libutouch-geis/geis_private.h (geis_activate_subscription): new function
+    (geis_deactivate_subscription): new function
+  * libutouch-geis/geis.c: implemented above new functions
+  * libutouch-geis/geis_subscription.h: fixed a typo in a prototype
+  * libutouch-geis/libutouch-geis.ver: added new GEIS v2.0 symbols
+  * testsuite/geis2/check_subscription.c: new test cases
+
[phone]  Stephen M. Webb  <[e-mail]>
+
+  Added forwarding functions so back ends can multiplex file descriptors through
+  the API.
+
+  * libutouch-geis/geis_private.h (geis_multiplex_fd): new function
+    (geis_demultiplex_fd): new function
+  * libutouch-geis/geis.c: implemented above new functions
+  * testsuite/libutouch-geis/check_geis_private.c:
+    renamed from check_backend_event_posting.c
+    (multiplex_fd): new test case
+  * testsuite/libutouch-geis/Makefile.am: renamed above file
+  * testsuite/libutouch-geis/check_backend_multiplexor.c: removed debug message
+    silenced build warnings
+
 2010-12-08  Stephen M. Webb  <[e-mail]>
 
   Refactored event queue style.

=== modified file 'include/geis/geis.h'
--- include/geis/geis.h	2010-12-13 14:13:50 +0000
+++ include/geis/geis.h	2010-12-13 14:13:50 +0000
@@ -677,6 +677,26 @@
 GEIS_API GeisStatus geis_subscription_delete(GeisSubscription subscription);
 
 /**
+ * Activates a subscription.
+ *
+ * @param[in] subscription  The subscription.
+ *
+ * Puts the subscription into the active state.  Gesture events will be
+ * delivered for this subscription.
+ */
+GEIS_API GeisStatus geis_subscription_activate(GeisSubscription subscription);
+
+/**
+ * Deactivates a subscription.
+ *
+ * @param[in] subscription  The subscription.
+ *
+ * Puts the subscription into the inactive state.  Gesture events will not be
+ * delivered for this subscription.
+ */
+GEIS_API GeisStatus geis_subscription_deactivate(GeisSubscription subscription);
+
+/**
  * Gets the name given to a subscription when it was created.
  *
  * @param[in] subscription  The subscription.

=== modified file 'libutouch-geis/geis.c'
--- libutouch-geis/geis.c	2010-12-13 14:13:50 +0000
+++ libutouch-geis/geis.c	2010-12-13 14:13:50 +0000
@@ -362,6 +362,30 @@
 }
 
 
+/*
+ * Adds a back end file descriptor to multiplex.
+ */
+void
+geis_multiplex_fd(Geis                        geis,
+                  int                         fd,
+                  GeisBackendFdEventCallback  callback,
+                  void                       *context)
+{
+  geis_backend_multiplexor_add_fd(geis->backend_multiplexor,
+                                  fd, callback, context);
+}
+
+
+/*
+ * Removes a back end file descriptor from the multiplex.
+ */
+void
+geis_demultiplex_fd(Geis geis, int fd)
+{
+  geis_backend_multiplexor_remove_fd(geis->backend_multiplexor, fd);
+}
+
+
 GeisErrorStack *
 geis_error_stack(Geis geis)
 {
@@ -376,3 +400,23 @@
 }
 
 
+/*
+ * Activates a subscription.
+ */
+GeisStatus
+geis_activate_subscription(Geis geis, GeisSubscription sub)
+{
+  return geis_backend_subscribe(geis->backend, sub);
+}
+
+
+/*
+ * Deactivates a subscription.
+ */
+GeisStatus
+geis_deactivate_subscription(Geis geis, GeisSubscription sub)
+{
+  return geis_backend_unsubscribe(geis->backend, sub);
+}
+
+

=== modified file 'libutouch-geis/geis_backend.c'
--- libutouch-geis/geis_backend.c	2010-12-02 19:09:57 +0000
+++ libutouch-geis/geis_backend.c	2010-12-13 14:13:50 +0000
@@ -63,3 +63,25 @@
   return be->be_name;
 }
 
+
+/**
+ * Forwarding function for subscription activation.
+ */
+GeisStatus
+geis_backend_subscribe(GeisBackend be, GeisSubscription sub)
+{
+  return be->be_vtbl->subscribe(be, sub);
+}
+
+
+/**
+ * Forwarding function for subscription deactivation.
+ */
+GeisStatus
+geis_backend_unsubscribe(GeisBackend be, GeisSubscription sub)
+{
+  return be->be_vtbl->unsubscribe(be, sub);
+}
+
+
+

=== modified file 'libutouch-geis/geis_backend.h'
--- libutouch-geis/geis_backend.h	2010-12-06 12:10:40 +0000
+++ libutouch-geis/geis_backend.h	2010-12-13 14:13:50 +0000
@@ -53,4 +53,14 @@
  */
 GeisString geis_backend_name(GeisBackend be);
 
+/**
+ * Asks the back end to create a described subscription.
+ */
+GeisStatus geis_backend_subscribe(GeisBackend be, GeisSubscription sub);
+
+/**
+ * Asks a back end to remove a subscription.
+ */
+GeisStatus geis_backend_unsubscribe(GeisBackend be, GeisSubscription sub);
+
 #endif /* GEIS_BACKEND_H_ */

=== modified file 'libutouch-geis/geis_backend_protected.h'
--- libutouch-geis/geis_backend_protected.h	2010-12-02 19:09:57 +0000
+++ libutouch-geis/geis_backend_protected.h	2010-12-13 14:13:50 +0000
@@ -35,7 +35,9 @@
  */
 typedef struct _GeisBackendVtable
 {
-  void (* finalize)(GeisBackend);
+  void       (* finalize)(GeisBackend);
+  GeisStatus (* subscribe)(GeisBackend, GeisSubscription);
+  GeisStatus (* unsubscribe)(GeisBackend, GeisSubscription);
 } *GeisBackendVtable;
 
 /**

=== modified file 'libutouch-geis/geis_backend_test_fixture.c'
--- libutouch-geis/geis_backend_test_fixture.c	2010-12-02 19:09:57 +0000
+++ libutouch-geis/geis_backend_test_fixture.c	2010-12-13 14:13:50 +0000
@@ -32,16 +32,40 @@
 
 
 static void 
-geis_backend_finalize(GeisBackend be)
+_finalize(GeisBackend be)
 {
   GeisBackendTestFixture tf __attribute__((unused)) = (GeisBackendTestFixture)be;
 }
 
 
+static GeisStatus 
+_subscribe(GeisBackend      be  __attribute__((unused)),
+           GeisSubscription sub __attribute__((unused)))
+{
+  geis_debug("begins");
+  GeisStatus status = GEIS_STATUS_SUCCESS;
+  geis_debug("ends");
+  return status;
+}
+
+
+static GeisStatus 
+_unsubscribe(GeisBackend      be  __attribute__((unused)),
+             GeisSubscription sub __attribute__((unused)))
+{
+  geis_debug("begins");
+  GeisStatus status = GEIS_STATUS_SUCCESS;
+  geis_debug("ends");
+  return status;
+}
+
 static struct _GeisBackendVtable tf_vtbl = {
-  geis_backend_finalize
+  _finalize,
+  _subscribe,
+  _unsubscribe
 };
 
+
 GeisBackend
 geis_backend_new_test_fixture(Geis geis __attribute__((unused)))
 {

=== modified file 'libutouch-geis/geis_private.h'
--- libutouch-geis/geis_private.h	2010-12-13 14:13:50 +0000
+++ libutouch-geis/geis_private.h	2010-12-13 14:13:50 +0000
@@ -2,6 +2,9 @@
  * @file geis_error.h
  * @brief internal GEIS error facilities
  *
+ * This file is the internal interface to the GEIS API object.  It provides the
+ * implementation hooks for back ends to pass information through the API.
+ *
  * Copyright 2010 Canonical Ltd.
  *
  * This library is free software; you can redistribute it and/or modify it under
@@ -24,6 +27,7 @@
 #include <geis/geis.h>
 
 #include "geis_error.h"
+#include "geis_backend_multiplexor.h"
 #include "geis_subscription.h"
 
 
@@ -41,6 +45,26 @@
  */
 GeisSubBag geis_subscription_bag(Geis geis);
 
+/**
+ * Adds a back end file descriptor to multiplex.
+ *
+ * @param[in] geis     The API instance.
+ * @param[in] fd       The file descriptor to add.
+ * @param[in] callback The file descriptor event callback.
+ * @param[in] context  A contextual datum.
+ */
+void geis_multiplex_fd(Geis                        geis,
+                       int                         fd,
+                       GeisBackendFdEventCallback  callback,
+                       void                       *context);
+
+/**
+ * Removes a back end file descriptor from the multiplex.
+ *
+ * @param[in] geis     The API instance.
+ * @param[in] fd       The file descriptor to remove.
+ */
+void geis_demultiplex_fd(Geis geis, int fd);
 
 /**
  * Posts a new event through the API.
@@ -50,5 +74,20 @@
  */
 void geis_post_event(Geis geis, GeisEvent event);
 
+/**
+ * Activates a subscription in the back end.
+ *
+ * @param[in] geis  The API instance.
+ * @param[in] sub   The subscription.
+ */
+GeisStatus geis_activate_subscription(Geis geis, GeisSubscription sub);
+
+/**
+ * Activates a subscription in the back end.
+ *
+ * @param[in] geis  The API instance.
+ * @param[in] sub   The subscription.
+ */
+GeisStatus geis_deactivate_subscription(Geis geis, GeisSubscription sub);
 
 #endif /* GEIS_PRIVATE_H_ */

=== modified file 'libutouch-geis/geis_subscription.c'
--- libutouch-geis/geis_subscription.c	2010-11-29 02:16:02 +0000
+++ libutouch-geis/geis_subscription.c	2010-12-13 14:13:50 +0000
@@ -176,6 +176,26 @@
 }
 
 
+/*
+ * Activates a subscirption.
+ */
+GeisStatus
+geis_subscription_activate(GeisSubscription sub)
+{
+  return geis_activate_subscription(sub->sub_geis, sub);
+}
+
+
+/*
+ * Deactivates a subscirption.
+ */
+GeisStatus
+geis_subscription_deactivate(GeisSubscription sub)
+{
+  return geis_deactivate_subscription(sub->sub_geis, sub);
+}
+
+
 /**
  * Creates a new subsciption on an API instance.
  */

=== modified file 'libutouch-geis/geis_subscription.h'
--- libutouch-geis/geis_subscription.h	2010-11-29 02:16:02 +0000
+++ libutouch-geis/geis_subscription.h	2010-12-13 14:13:50 +0000
@@ -55,15 +55,22 @@
 /**
  * Creates a new subscription object in a subscription container.
  *
- * @param[in] bag The bag.
+ * @param[in] bag The container.
+ * @param[in] sub The subscription to be added.
  *
  * @returns the index of the newly inserted subscription
  */
 GeisSize geis_subscription_bag_insert(GeisSubBag       bag,
                                       GeisSubscription sub);
 
-void geis_subscription_bag_removed(GeisSubBag       bag,
-                                       GeisSubscription sub);
+/**
+ * Removes a subscription from a subscription container.
+ *
+ * @param[in] bag The subscription container.
+ * @param[in] sub The subscription to be removed.
+ */
+void geis_subscription_bag_remove(GeisSubBag       bag,
+                                  GeisSubscription sub);
 
 /**
  * Looks for an subscription in an subscription container.

=== modified file 'libutouch-geis/libutouch-geis.ver'
--- libutouch-geis/libutouch-geis.ver	2010-12-13 14:13:50 +0000
+++ libutouch-geis/libutouch-geis.ver	2010-12-13 14:13:50 +0000
@@ -29,7 +29,9 @@
     geis_next_event;
     geis_register_event_callback;
     geis_set_configuration;
+    geis_subscription_activate;
     geis_subscription_add_filter;
+    geis_subscription_deactivate;
     geis_subscription_delete;
     geis_subscription_id;
     geis_subscription_name;

=== modified file 'testsuite/geis2/check_subscription.c'
--- testsuite/geis2/check_subscription.c	2010-12-02 19:09:57 +0000
+++ testsuite/geis2/check_subscription.c	2010-12-13 14:13:50 +0000
@@ -37,12 +37,16 @@
 START_TEST(construction)
 {
   GeisSubscription sub = geis_subscription_new(g_geis,
-						"name",
-						GEIS_SUBSCRIPTION_NONE);
+                                               "name",
+                                               GEIS_SUBSCRIPTION_NONE);
   fail_unless(sub != NULL,
               "failed to create subscription");
   fail_unless(0 == strcmp(geis_subscription_name(sub), "name"),
-  	      "unexpected subscription name returned");
+              "unexpected subscription name returned");
+  fail_unless(GEIS_STATUS_SUCCESS == geis_subscription_activate(sub),
+              "unable to activate subscription");
+  fail_unless(GEIS_STATUS_SUCCESS == geis_subscription_deactivate(sub),
+              "unable to deactivate subscription");
   geis_subscription_delete(sub);
 }
 END_TEST

=== modified file 'testsuite/libutouch-geis/Makefile.am'
--- testsuite/libutouch-geis/Makefile.am	2010-12-13 14:13:50 +0000
+++ testsuite/libutouch-geis/Makefile.am	2010-12-13 14:13:50 +0000
@@ -32,7 +32,7 @@
 
 check_geis2_internals_SOURCES = \
 	check_attr.c \
-	check_backend_event_posting.c \
+	check_geis_private.c \
 	check_backend_multiplexor.c \
 	check_error_reporting.c \
 	check_event_queue.c \

=== modified file 'testsuite/libutouch-geis/check_backend_multiplexor.c'
--- testsuite/libutouch-geis/check_backend_multiplexor.c	2010-12-02 16:54:02 +0000
+++ testsuite/libutouch-geis/check_backend_multiplexor.c	2010-12-13 14:13:50 +0000
@@ -3,9 +3,10 @@
  */
 #include <check.h>
 
+#include <errno.h>
 #include "geis/geis.h"
 #include "libutouch-geis/geis_backend_multiplexor.h"
-#include <stdio.h>
+#include <string.h>
 #include <sys/select.h>
 #include <unistd.h>
 
@@ -31,7 +32,7 @@
 testcase_event_callback(int fd, GeisBackendMultiplexorEvent event, void *context)
 {
   char buf[2];
-  (void)read(fd, buf, 1);
+  ssize_t ssize = read(fd, buf, 1);
   *(int *)context += 1; 
 }
 
@@ -57,7 +58,8 @@
   int status = 0;
   int first_time = 1;
 
-  (void)pipe(pfd);
+  fail_unless(pipe(pfd) == 0, "error %d creating self-pipe: %d",
+              errno, strerror(errno));
   geis_backend_multiplexor_add_fd(g_mx, pfd[0], testcase_event_callback, &called);
 
   while (1)
@@ -78,14 +80,14 @@
     }
     else if (0 == status)
     {
-      fprintf(stderr, "select timeout\n");
       fail_unless(first_time, "select timed out before read");
       if (!first_time)
       {
 	break;
       }
       first_time = 0;
-      (void)write(pfd[1], "1", 1);
+      ssize_t ssize = write(pfd[1], "1", 1);
+      fail_unless(ssize == 1, "error writing to self-pipe");
     }
     else
     {

=== renamed file 'testsuite/libutouch-geis/check_backend_event_posting.c' => 'testsuite/libutouch-geis/check_geis_private.c'
--- testsuite/libutouch-geis/check_backend_event_posting.c	2010-12-13 14:13:50 +0000
+++ testsuite/libutouch-geis/check_geis_private.c	2010-12-13 14:13:50 +0000
@@ -3,9 +3,14 @@
  */
 #include <check.h>
 
+#include <errno.h>
 #include "geis/geis.h"
 #include "libutouch-geis/geis_event.h"
 #include "libutouch-geis/geis_private.h"
+#include <string.h>
+#include <sys/select.h>
+#include <unistd.h>
+
 
 /* fixtures */
 Geis g_geis;
@@ -22,6 +27,14 @@
   geis_delete(g_geis);
 }
 
+static void
+testcase_event_callback(int fd, GeisBackendMultiplexorEvent event, void *context)
+{
+  char buf[2];
+  ssize_t ssize = read(fd, buf, 1);
+  *(int *)context += 1; 
+}
+
 START_TEST(backend_post)
 {
   GeisStatus status;
@@ -54,15 +67,71 @@
 }
 END_TEST
 
+START_TEST(multiplex_fd)
+{
+  int pfd[2];
+  int geis_fd;
+  int called = 0;
+  int status = 0;
+  int first_time = 1;
+  GeisStatus gstat = geis_get_configuration(g_geis,
+                                            GEIS_CONFIGURATION_FD,
+                                            &geis_fd);
+  fail_unless(gstat == GEIS_STATUS_SUCCESS, "unable to get GEIS fd");
+
+  fail_unless(pipe(pfd) == 0, "error %d creating self-pipe: %d",
+              errno, strerror(errno));
+  geis_multiplex_fd(g_geis, pfd[0], testcase_event_callback, &called);
+
+  while (1)
+  {
+    fd_set fds;
+    FD_ZERO(&fds);
+    FD_SET(geis_fd, &fds);
+
+    struct timeval tm;
+    tm.tv_sec = 0;
+    tm.tv_usec = 5000;
+
+    status = select(geis_fd+1, &fds, NULL, NULL, &tm);
+    fail_if(status < 0, "error in select");
+    if (status < 0)
+    {
+      break;
+    }
+    else if (0 == status)
+    {
+      fail_unless(first_time, "select timed out before read");
+      if (!first_time)
+      {
+	break;
+      }
+      first_time = 0;
+      ssize_t ssize = write(pfd[1], "1", 1);
+      fail_unless(ssize == 1, "error writing to self-pipe");
+    }
+    else
+    {
+      geis_dispatch_events(g_geis);
+      break;
+    }
+  }
+
+  fail_if(called == 0, "event callback not called");
+  fail_if(called >  1, "event callback called too many times");
+}
+END_TEST
+
 /* boilerplate */
 Suite *
 make_backend_event_posting_suite()
 {
-  Suite *s = suite_create("utouch-geis2-backend-event-posting");
+  Suite *s = suite_create("utouch-geis2-geis-private");
 
-  TCase *usage = tcase_create("backend-event-posting-usage");
+  TCase *usage = tcase_create("backend-event-posting");
   tcase_add_checked_fixture(usage, construct_geis, destroy_geis);
   tcase_add_test(usage, backend_post);
+  tcase_add_test(usage, multiplex_fd);
   suite_add_tcase(s, usage);
 
   return s;