Added docs and C bindings for AccessibleStateSet and AccessibleRelationSet.
[platform/core/uifw/at-spi2-atk.git] / libspi / deviceeventcontroller.c
index f96d7b0..9d2e6e1 100644 (file)
@@ -29,6 +29,7 @@
 #include <stdio.h>
 #endif
 
+#include <stdlib.h> /* for getenv() */
 #include <X11/Xlib.h>
 #include <X11/extensions/XTest.h>
 #include <config.h>
@@ -50,7 +51,7 @@
 /*
  * A pointer to our parent object class
  */
-static GObjectClass *device_event_controller_parent_class;
+static GObjectClass *spi_device_event_controller_parent_class;
 
 static gboolean kbd_registered = FALSE;
 
@@ -59,25 +60,48 @@ static Display *display;
 static Window root_window;
 
 typedef enum {
-  DEVICE_TYPE_KBD,
-  DEVICE_TYPE_MOUSE,
-  DEVICE_TYPE_LAST_DEFINED
-} DeviceTypeCategory;
+  SPI_DEVICE_TYPE_KBD,
+  SPI_DEVICE_TYPE_MOUSE,
+  SPI_DEVICE_TYPE_LAST_DEFINED
+} SpiDeviceTypeCategory;
 
-static gboolean _controller_register_with_devices (DeviceEventController *controller);
-static gboolean _controller_grab_keyboard (DeviceEventController *controller);
+struct _DEControllerListener {
+  CORBA_Object object;
+  SpiDeviceTypeCategory type;
+};
 
-static void _controller_register_device_listener (DeviceEventController *controller,
-                                                 const CORBA_Object l,
-                                                 const Accessibility_ControllerEventMask *mask,
-                                                 DeviceTypeCategory type,
-                                                 CORBA_Environment *ev);
+typedef struct _DEControllerListener DEControllerListener;
+
+struct _DEControllerKeyListener {
+  DEControllerListener listener;
+  Accessibility_KeySet *keys;
+  Accessibility_ControllerEventMask *mask;
+  Accessibility_KeyEventTypeSeq *typeseq;
+  gboolean is_system_global;   
+};
+
+typedef struct _DEControllerKeyListener DEControllerKeyListener;
+
+static gboolean _controller_register_with_devices (SpiDeviceEventController *controller);
+static gboolean _controller_grab_keyboard (SpiDeviceEventController *controller);
+
+static void controller_register_device_listener (SpiDeviceEventController *controller,
+                                                DEControllerListener *l,
+                                                CORBA_Environment *ev);
 
 /*
  * Private methods
  */
 
 static gint
+_compare_listeners (gconstpointer p1, gconstpointer p2)
+{
+  DEControllerListener *l1 = (DEControllerListener *) p1;      
+  DEControllerListener *l2 = (DEControllerListener *) p2;      
+  return _compare_corba_objects (l1->object, l2->object);
+}
+
+static gint
 _compare_corba_objects (gconstpointer p1, gconstpointer p2)
 {
   CORBA_Environment ev;
@@ -104,43 +128,60 @@ _eventmask_compare_value (gconstpointer p1, gconstpointer p2)
     return (gint) d;
 }
 
+static DEControllerKeyListener *
+dec_key_listener_new (CORBA_Object l,
+                     const Accessibility_KeySet *keys,
+                     const Accessibility_ControllerEventMask *mask,
+                     const Accessibility_KeyEventTypeSeq *typeseq,
+                     const CORBA_boolean is_system_global,
+                     CORBA_Environment *ev)
+{
+  DEControllerKeyListener *key_listener = g_new0 (DEControllerKeyListener, 1);
+  key_listener->listener.object = CORBA_Object_duplicate (l, ev);
+  key_listener->listener.type = SPI_DEVICE_TYPE_KBD;
+  key_listener->keys = keys;
+  key_listener->mask = mask;
+  key_listener->is_system_global = is_system_global;
+
+  return key_listener; 
+}
+
 static void
-_controller_register_device_listener (DeviceEventController *controller,
-                                     const CORBA_Object l,
-                                     const Accessibility_ControllerEventMask *mask,
-                                     DeviceTypeCategory type,
-                                     CORBA_Environment *ev)
+controller_register_device_listener (SpiDeviceEventController *controller,
+                                    DEControllerListener *listener,
+                                    CORBA_Environment *ev)
 {
   Accessibility_ControllerEventMask *mask_ptr = NULL;
+  DEControllerKeyListener *key_listener;
   
-  switch (type) {
-  case DEVICE_TYPE_KBD:
-      controller->key_listeners = g_list_append (controller->key_listeners,
-                                                CORBA_Object_duplicate (l, ev));
+  switch (listener->type) {
+  case SPI_DEVICE_TYPE_KBD:
+      key_listener = (DEControllerKeyListener *) listener;       
+      controller->key_listeners = g_list_append (controller->key_listeners, key_listener);
       
       mask_ptr = (Accessibility_ControllerEventMask *)
-             g_list_find_custom (controller->keymask_list, (gpointer) mask,
+             g_list_find_custom (controller->keymask_list, (gpointer) key_listener->mask,
                                  _eventmask_compare_value);
       if (mask_ptr)
              ++(mask_ptr->refcount);
       else
       {
-             if (mask->refcount != (CORBA_unsigned_short) 1)
+             if (key_listener->mask->refcount != (CORBA_unsigned_short) 1)
                      fprintf (stderr, "mask initial refcount is not 1!\n");
-             if (mask->value > (CORBA_unsigned_long) 2048)
+             if (key_listener->mask->value > (CORBA_unsigned_long) 2048)
                      fprintf (stderr, "mask value looks invalid (%lu)\n",
-                              (unsigned long) mask->value);
+                              (unsigned long) key_listener->mask->value);
              else
                      fprintf (stderr, "appending mask with val=%lu\n",
-                              (unsigned long) mask->value);
+                              (unsigned long) key_listener->mask->value);
              mask_ptr = Accessibility_ControllerEventMask__alloc();
-             mask_ptr->value = mask->value;
+             mask_ptr->value = key_listener->mask->value;
              mask_ptr->refcount = (CORBA_unsigned_short) 1;
              controller->keymask_list = g_list_append (controller->keymask_list,
                                                        (gpointer) mask_ptr);
       }
       break;
-  case DEVICE_TYPE_MOUSE:
+  case SPI_DEVICE_TYPE_MOUSE:
 /*    controller->mouse_listeners = g_list_append (controller->mouse_listeners,
                                                    CORBA_Object_duplicate (l, ev));*/
 
@@ -150,21 +191,22 @@ _controller_register_device_listener (DeviceEventController *controller,
 }
 
 static void
-_controller_deregister_device_listener (DeviceEventController *controller,
-                                       const CORBA_Object l,
-                                       const Accessibility_ControllerEventMask *mask,
-                                       DeviceTypeCategory type,
-                                       CORBA_Environment *ev)
+controller_deregister_device_listener (SpiDeviceEventController *controller,
+                                      DEControllerListener *listener,
+                                      CORBA_Environment *ev)
 {
   Accessibility_ControllerEventMask *mask_ptr;
+  DEControllerKeyListener *key_listener;
   GList *list_ptr;
-  switch (type) {
-  case DEVICE_TYPE_KBD:
-      list_ptr = g_list_find_custom (controller->key_listeners, l, _compare_corba_objects);
+  switch (listener->type) {
+  case SPI_DEVICE_TYPE_KBD:
+      key_listener = (DEControllerKeyListener *) listener;
+      list_ptr = g_list_find_custom (controller->key_listeners, listener, _compare_listeners);
+      /* TODO: need a different custom compare func */
       if (list_ptr)
          controller->key_listeners = g_list_remove (controller->key_listeners, list_ptr);
       list_ptr = (GList *)
-                 g_list_find_custom (controller->keymask_list, (gpointer) mask,
+                 g_list_find_custom (controller->keymask_list, (gpointer) key_listener->mask,
                                     _eventmask_compare_value);
       if (list_ptr)
         {
@@ -179,7 +221,7 @@ _controller_deregister_device_listener (DeviceEventController *controller,
            }
        }
       break;
-  case DEVICE_TYPE_MOUSE:
+  case SPI_DEVICE_TYPE_MOUSE:
 /*    controller->mouse_listeners = g_list_append (controller->mouse_listeners,
                                                    CORBA_Object_duplicate (l, ev));*/
 
@@ -189,7 +231,7 @@ _controller_deregister_device_listener (DeviceEventController *controller,
 }
 
 static gboolean
-_controller_register_with_devices (DeviceEventController *controller)
+_controller_register_with_devices (SpiDeviceEventController *controller)
 {
   gboolean retval = FALSE;
 
@@ -211,8 +253,28 @@ _controller_register_with_devices (DeviceEventController *controller)
   return retval;
 }
 
+
+static gboolean
+notify_keylisteners (GList *key_listeners, Accessibility_KeyStroke *key_event, CORBA_Environment *ev)
+{
+  int i, n_listeners = g_list_length (key_listeners);
+  gboolean is_consumed = FALSE;
+  for (i=0; i<n_listeners && !is_consumed; ++i)
+    {
+      Accessibility_KeystrokeListener ls;
+      ls = (Accessibility_KeystrokeListener)
+           g_list_nth_data (key_listeners, i);
+      if (!CORBA_Object_is_nil(ls, ev))
+        {
+           is_consumed = Accessibility_KeystrokeListener_keyEvent (ls, key_event, ev);
+        }              
+    }
+  return is_consumed;
+}
+
+
 static gboolean
-_check_key_event (DeviceEventController *controller)
+_check_key_event (SpiDeviceEventController *controller)
 {
        static gboolean initialized = FALSE;
        static gboolean is_active = FALSE;
@@ -222,7 +284,6 @@ _check_key_event (DeviceEventController *controller)
        gboolean is_consumed = FALSE;
        char key_name[16];
        int i;
-       int n_listeners = g_list_length (controller->key_listeners);
        Accessibility_KeyStroke key_event;
        static CORBA_Environment ev;
 
@@ -235,6 +296,7 @@ _check_key_event (DeviceEventController *controller)
        while (XPending(display))
          {
            XNextEvent (display, x_event);
+           if (XFilterEvent (x_event, None)) continue;   
            if (x_event->type == KeyPress)
              {
                x_key_event = (XKeyEvent *)x_event;
@@ -264,16 +326,8 @@ _check_key_event (DeviceEventController *controller)
 #endif
            }
            /* relay to listeners, and decide whether to consume it or not */
-           for (i=0; i<n_listeners && !is_consumed; ++i)
-           {
-                   Accessibility_KeystrokeListener ls;
-                   ls = (Accessibility_KeystrokeListener)
-                           g_list_nth_data (controller->key_listeners, i);
-                   if (!CORBA_Object_is_nil(ls, &ev))
-                   {
-                           is_consumed = Accessibility_KeystrokeListener_keyEvent (ls, &key_event, &ev);
-                   }           
-           }
+           is_consumed = notify_keylisteners (controller->key_listeners, &key_event, &ev);
+
            if (is_consumed)
            {
              XAllowEvents (display, SyncKeyboard, CurrentTime);
@@ -288,7 +342,7 @@ _check_key_event (DeviceEventController *controller)
 }
 
 static gboolean
-_controller_grab_keyboard (DeviceEventController *controller)
+_controller_grab_keyboard (SpiDeviceEventController *controller)
 {
        GList *maskList = controller->keymask_list;
        int i;
@@ -335,13 +389,13 @@ _controller_grab_keyboard (DeviceEventController *controller)
  * Implemented GObject::finalize
  */
 static void
-device_event_controller_object_finalize (GObject *object)
+spi_device_event_controller_object_finalize (GObject *object)
 {
 
 #ifdef SPI_DEBUG
-        fprintf(stderr, "device_event_controller_object_finalize called\n");
+        fprintf(stderr, "spi_device_event_controller_object_finalize called\n");
 #endif
-        device_event_controller_parent_class->finalize (object);
+        spi_device_event_controller_parent_class->finalize (object);
 }
 
 /*
@@ -354,21 +408,20 @@ impl_register_keystroke_listener (PortableServer_Servant     servant,
                                  const Accessibility_KeySet *keys,
                                  const Accessibility_ControllerEventMask *mask,
                                  const Accessibility_KeyEventTypeSeq *type,
-                                 const CORBA_boolean is_synchronous,
+                                 const CORBA_boolean is_system_global,
                                  CORBA_Environment         *ev)
 {
-       DeviceEventController *controller = DEVICE_EVENT_CONTROLLER (
+       SpiDeviceEventController *controller = SPI_DEVICE_EVENT_CONTROLLER (
                bonobo_object_from_servant (servant));
+       DEControllerKeyListener *dec_listener;
 #ifdef SPI_DEBUG
        fprintf (stderr, "registering keystroke listener %p with maskVal %lu\n",
                 (void *) l, (unsigned long) mask->value);
 #endif
-        /* TODO: change this to an enum, indicating if event can be consumed */
-       if (is_synchronous)
-       _controller_register_device_listener(controller, l, mask, DEVICE_TYPE_KBD, ev);
-       else
-       ; /* register with toolkit instead */   
+       dec_listener = dec_key_listener_new (l, keys, mask, type, is_system_global, ev);
+       controller_register_device_listener (controller, (DEControllerListener *) dec_listener, ev);
 }
+
 /*
  * CORBA Accessibility::DeviceEventController::deregisterKeystrokeListener
  *     method implementation
@@ -379,16 +432,24 @@ impl_deregister_keystroke_listener (PortableServer_Servant     servant,
                                    const Accessibility_KeySet *keys,
                                    const Accessibility_ControllerEventMask *mask,
                                    const Accessibility_KeyEventTypeSeq *type,
-                                   const CORBA_boolean is_synchronous,
+                                   const CORBA_boolean is_system_global,
                                    CORBA_Environment         *ev)
 {
-       DeviceEventController *controller = DEVICE_EVENT_CONTROLLER (
+       SpiDeviceEventController *controller = SPI_DEVICE_EVENT_CONTROLLER (
                bonobo_object_from_servant (servant));
+       DEControllerKeyListener *key_listener = dec_key_listener_new (l,
+                                                                     keys,
+                                                                     mask,
+                                                                     type,
+                                                                     is_system_global,
+                                                                     ev);
 #ifdef SPI_DEBUG
        fprintf (stderr, "deregistering keystroke listener %p with maskVal %lu\n",
                 (void *) l, (unsigned long) mask->value);
 #endif
-       _controller_deregister_device_listener(controller, l, mask, DEVICE_TYPE_KBD, ev);
+       controller_deregister_device_listener(controller,
+                                             (DEControllerListener *) key_listener,
+                                             ev);
 }
 
 /*
@@ -401,30 +462,60 @@ impl_register_mouse_listener (PortableServer_Servant     servant,
                              const Accessibility_MouseListener *l,
                              CORBA_Environment         *ev)
 {
-       DeviceEventController *controller = DEVICE_EVENT_CONTROLLER (
+       SpiDeviceEventController *controller = SPI_DEVICE_EVENT_CONTROLLER (
                bonobo_object_from_servant (servant));
 #ifdef SPI_DEBUG
        fprintf (stderr, "registering mouse listener %p\n", l);
 #endif
-       _controller_register_device_listener(controller, l, mask, DEVICE_TYPE_MOUSE, ev);
+       controller_register_device_listener(controller, DEVICE_TYPE_MOUSE, l, keys, mask, ev);
 }
 */
 
+static KeyCode
+keycode_for_keysym (long keysym)
+{
+  return XKeysymToKeycode (display, (KeySym) keysym);
+}
+
 /*
  * CORBA Accessibility::DeviceEventController::registerKeystrokeListener
  *     method implementation
  */
 static void
 impl_generate_key_event (PortableServer_Servant     servant,
-                        const CORBA_long           keyEventID,
-                        CORBA_Environment         *ev)
+                        const CORBA_long           keycode,
+                        const Accessibility_KeySynthType synth_type,
+                        CORBA_Environment          *ev)
 {
+       long key_synth_code;
 #ifdef SPI_DEBUG
-       fprintf (stderr, "synthesizing keystroke %ld\n", (long) keyEventID);
+       fprintf (stderr, "synthesizing keystroke %ld\n", (long) keycode);
 #endif
        /* TODO: hide/wrap/remove X dependency */
-       XTestFakeKeyEvent (GDK_DISPLAY(), (unsigned int) keyEventID, True, CurrentTime);
-       XTestFakeKeyEvent (GDK_DISPLAY(), (unsigned int) keyEventID, False, CurrentTime);
+
+       /* TODO: be accessX-savvy so that keyrelease occurs after sufficient timeout */
+       
+       /*
+        * TODO: when initializing, query for XTest extension before using,
+        * and fall back to XSendEvent() if XTest is not available.
+        */
+       
+       switch (synth_type)
+       {
+       case Accessibility_KEY_PRESS:
+               XTestFakeKeyEvent (GDK_DISPLAY(), (unsigned int) keycode, True, CurrentTime);
+               break;
+       case Accessibility_KEY_PRESSRELEASE:
+               XTestFakeKeyEvent (GDK_DISPLAY(), (unsigned int) keycode, True, CurrentTime);
+       case Accessibility_KEY_RELEASE:
+               XTestFakeKeyEvent (GDK_DISPLAY(), (unsigned int) keycode, False, CurrentTime);
+               break;
+       case Accessibility_KEY_SYM:
+               key_synth_code = keycode_for_keysym (keycode);
+               XTestFakeKeyEvent (GDK_DISPLAY(), (unsigned int) key_synth_code, True, CurrentTime);
+               XTestFakeKeyEvent (GDK_DISPLAY(), (unsigned int) key_synth_code, False, CurrentTime);
+               break;
+       }
 }
 
 /*
@@ -444,13 +535,13 @@ impl_generate_mouse_event (PortableServer_Servant     servant,
 }
 
 static void
-device_event_controller_class_init (DeviceEventControllerClass *klass)
+spi_device_event_controller_class_init (SpiDeviceEventControllerClass *klass)
 {
         GObjectClass * object_class = (GObjectClass *) klass;
         POA_Accessibility_DeviceEventController__epv *epv = &klass->epv;
-        device_event_controller_parent_class = g_type_class_ref (BONOBO_OBJECT_TYPE);
+        spi_device_event_controller_parent_class = g_type_class_ref (BONOBO_OBJECT_TYPE);
 
-        object_class->finalize = device_event_controller_object_finalize;
+        object_class->finalize = spi_device_event_controller_object_finalize;
 
         epv->registerKeystrokeListener = impl_register_keystroke_listener;
         epv->deregisterKeystrokeListener = impl_deregister_keystroke_listener;
@@ -461,7 +552,7 @@ device_event_controller_class_init (DeviceEventControllerClass *klass)
 }
 
 static void
-device_event_controller_init (DeviceEventController *device_event_controller)
+spi_device_event_controller_init (SpiDeviceEventController *device_event_controller)
 {
   device_event_controller->key_listeners = NULL;
   device_event_controller->mouse_listeners = NULL;
@@ -469,29 +560,40 @@ device_event_controller_init (DeviceEventController *device_event_controller)
   kbd_registered = _controller_register_with_devices (device_event_controller);
 }
 
-gboolean device_event_controller_check_key_event (DeviceEventController *controller)
+gboolean spi_device_event_controller_check_key_event (SpiDeviceEventController *controller)
 {
-       DeviceEventControllerClass *klass = DEVICE_EVENT_CONTROLLER_GET_CLASS (controller);
+       SpiDeviceEventControllerClass *klass = SPI_DEVICE_EVENT_CONTROLLER_GET_CLASS (controller);
        if (klass->check_key_event)
                return (klass->check_key_event) (controller);
 }
 
+SpiDeviceEventController *
+spi_device_event_controller_new (void *registryp)
+{
+  SpiRegistry *registry = SPI_REGISTRY (registryp);    
+  SpiDeviceEventController *retval = 
+         SPI_DEVICE_EVENT_CONTROLLER (g_object_new (SPI_DEVICE_EVENT_CONTROLLER_TYPE, NULL));
+  retval->registry = registry;
+  bonobo_object_ref (registry);
+  return retval;
+}
+
 GType
-device_event_controller_get_type (void)
+spi_device_event_controller_get_type (void)
 {
         static GType type = 0;
 
         if (!type) {
                 static const GTypeInfo tinfo = {
-                        sizeof (DeviceEventControllerClass),
+                        sizeof (SpiDeviceEventControllerClass),
                         (GBaseInitFunc) NULL,
                         (GBaseFinalizeFunc) NULL,
-                        (GClassInitFunc) device_event_controller_class_init,
+                        (GClassInitFunc) spi_device_event_controller_class_init,
                         (GClassFinalizeFunc) NULL,
                         NULL, /* class data */
-                        sizeof (DeviceEventController),
+                        sizeof (SpiDeviceEventController),
                         0, /* n preallocs */
-                        (GInstanceInitFunc) device_event_controller_init,
+                        (GInstanceInitFunc) spi_device_event_controller_init,
                         NULL /* value table */
                 };
                 /*
@@ -504,9 +606,9 @@ device_event_controller_get_type (void)
                         PARENT_TYPE,
                         POA_Accessibility_DeviceEventController__init,
                         NULL,
-                        G_STRUCT_OFFSET (DeviceEventControllerClass, epv),
+                        G_STRUCT_OFFSET (SpiDeviceEventControllerClass, epv),
                         &tinfo,
-                        "DeviceEventController");
+                        "SpiDeviceEventController");
         }
 
         return type;