API revisions: tweaks to key event API, added some reserved slots for
[platform/core/uifw/at-spi2-atk.git] / registryd / deviceeventcontroller.c
index 964fb90..a9ffd9d 100644 (file)
 
 #include <config.h>
 
+#undef SPI_DEBUG
+
 #ifdef SPI_DEBUG
 #  include <stdio.h>
 #endif
 
 #include <X11/Xlib.h>
 #include <X11/extensions/XTest.h>
+#define XK_MISCELLANY
+#include <X11/keysymdef.h>
 #include <gdk/gdkx.h> /* TODO: hide dependency (wrap in single porting file) */
 #include <gdk/gdkwindow.h>
 
@@ -43,46 +47,77 @@ static GObjectClass *spi_device_event_controller_parent_class;
 
 static gboolean kbd_registered = FALSE;
 
-static Display *display;
-
 static Window root_window;
 
 typedef enum {
-       SPI_DEVICE_TYPE_KBD,
-       SPI_DEVICE_TYPE_MOUSE,
-       SPI_DEVICE_TYPE_LAST_DEFINED
+  SPI_DEVICE_TYPE_KBD,
+  SPI_DEVICE_TYPE_MOUSE,
+  SPI_DEVICE_TYPE_LAST_DEFINED
 } SpiDeviceTypeCategory;
 
+struct _DEControllerGrabMask {
+  Accessibility_ControllerEventMask modmask;
+  CORBA_unsigned_long               keyval;
+  unsigned int                      refcount;
+};
+
+typedef struct _DEControllerGrabMask DEControllerGrabMask;
+
 struct _DEControllerListener {
-       CORBA_Object          object;
-       SpiDeviceTypeCategory type;
+  CORBA_Object          object;
+  SpiDeviceTypeCategory type;
 };
 
 typedef struct _DEControllerListener DEControllerListener;
 
 struct _DEControllerKeyListener {
-       DEControllerListener listener;
-       Accessibility_KeySet *keys;
-       Accessibility_ControllerEventMask *mask;
-       Accessibility_KeyEventTypeSeq *typeseq;
-       gboolean is_system_global;      
+  DEControllerListener listener;
+  Accessibility_KeySet *keys;
+  Accessibility_ControllerEventMask mask;
+  Accessibility_KeyEventTypeSeq *typeseq;
+  Accessibility_EventListenerMode *mode;       
 };
 
 typedef struct _DEControllerKeyListener DEControllerKeyListener;
 
-static gboolean _controller_register_with_devices (SpiDeviceEventController *controller);
-static gboolean _controller_grab_keyboard (SpiDeviceEventController *controller);
+static gboolean spi_controller_register_with_devices (SpiDeviceEventController *controller);
+static gboolean spi_controller_grab_keyboard (SpiDeviceEventController *controller);
 
-static void controller_register_device_listener (SpiDeviceEventController *controller,
-                                                DEControllerListener *l,
-                                                CORBA_Environment *ev);
+static void spi_controller_register_device_listener (SpiDeviceEventController *controller,
+                                                    DEControllerListener *l,
+                                                    CORBA_Environment *ev);
 
 /*
  * Private methods
  */
 
+static Display *
+spi_get_display (void )
+{
+ static Display *display = NULL;
+ /* We must open a new connection to the server to avoid clashing with the GDK event loop */
+ /*
+  * TODO: fixme, this makes the foolish assumption that registryd uses
+  * the same display as the apps, and the the DISPLAY environment variable is set.
+  */
+ if (!display)
+   {
+     display = XOpenDisplay (g_getenv ("DISPLAY"));
+   }
+ return display;
+}
+
+static DEControllerGrabMask *
+spi_grabmask_clone (DEControllerGrabMask *grabmask)
+{
+  DEControllerGrabMask *clone = g_new0 (DEControllerGrabMask, 1);
+  memcpy (clone, grabmask, sizeof (DEControllerGrabMask));
+  return clone;
+}
+
 static gint
-_compare_corba_objects (gconstpointer p1, gconstpointer p2)
+spi_compare_corba_objects (gconstpointer p1, gconstpointer p2)
 {
   CORBA_Environment ev;
   gint retval;
@@ -97,172 +132,203 @@ _compare_corba_objects (gconstpointer p1, gconstpointer p2)
 }
 
 static gint
-_compare_listeners (gconstpointer p1, gconstpointer p2)
+spi_compare_listeners (gconstpointer p1, gconstpointer p2)
 {
   DEControllerListener *l1 = (DEControllerListener *) p1;      
   DEControllerListener *l2 = (DEControllerListener *) p2;      
-  return _compare_corba_objects (l1->object, l2->object);
+  return spi_compare_corba_objects (l1->object, l2->object);
 }
 
 static gint
-_eventmask_compare_value (gconstpointer p1, gconstpointer p2)
+spi_grabmask_compare_values (gconstpointer p1, gconstpointer p2)
 {
-    long d;
-    if (!p1 || !p2)
-       return (gint) (p1?1:(p2?-1:0));
-    else
-       d = ((long)((Accessibility_ControllerEventMask*)p2)->value) -
-               ((long)((Accessibility_ControllerEventMask*)p1)->value);
-    return (gint) d;
+  DEControllerGrabMask *l1;
+  DEControllerGrabMask *l2;
+  if (p1 == p2)
+    {
+      return 0;
+    }
+  else
+    { 
+      l1 = (DEControllerGrabMask *) p1;        
+      l2 = (DEControllerGrabMask *) p2;
+      return ((l1->modmask != l2->modmask) || (l1->keyval != l2->keyval));
+    }
 }
 
 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)
+spi_dec_key_listener_new (CORBA_Object l,
+                         const Accessibility_KeySet *keys,
+                         const Accessibility_ControllerEventMask mask,
+                         const Accessibility_KeyEventTypeSeq *typeseq,
+                         const Accessibility_EventListenerMode *mode,
+                         CORBA_Environment *ev)
 {
   DEControllerKeyListener *key_listener = g_new0 (DEControllerKeyListener, 1);
   key_listener->listener.object = bonobo_object_dup_ref (l, ev);
   key_listener->listener.type = SPI_DEVICE_TYPE_KBD;
   key_listener->keys = ORBit_copy_value (keys, TC_Accessibility_KeySet);
-  key_listener->mask = ORBit_copy_value (mask, TC_Accessibility_ControllerEventMask);
+  key_listener->mask = mask;
   key_listener->typeseq = ORBit_copy_value (typeseq, TC_Accessibility_KeyEventTypeSeq);
-  key_listener->is_system_global = is_system_global;
+  if (mode)
+    key_listener->mode = ORBit_copy_value (mode, TC_Accessibility_EventListenerMode);
+  else
+    key_listener->mode = NULL;
 
 #ifdef SPI_DEBUG
   g_print ("new listener, with mask %x, is_global %d, keys %p\n",
-          (unsigned int) key_listener->mask->value,
-           (int) key_listener->is_system_global,
+          (unsigned int) key_listener->mask,
+           (int) mode->global,
           (void *) key_listener->keys);
 #endif
   return key_listener; 
 }
 
 static void
-dec_key_listener_free (DEControllerKeyListener *key_listener, CORBA_Environment *ev)
+spi_dec_key_listener_free (DEControllerKeyListener *key_listener, CORBA_Environment *ev)
 {
   bonobo_object_release_unref (key_listener->listener.object, ev);
   CORBA_free (key_listener->typeseq);
-  CORBA_free (key_listener->mask);
   CORBA_free (key_listener->keys);
   g_free (key_listener);
 }
 
 static void
-controller_register_device_listener (SpiDeviceEventController *controller,
-                                    DEControllerListener *listener,
-                                    CORBA_Environment *ev)
+spi_controller_deregister_global_keygrabs (SpiDeviceEventController *controller,
+                                          DEControllerKeyListener *key_listener)
+{
+  GList *list_ptr;
+  DEControllerGrabMask *mask_ptr;
+  /* TODO: implement this! Also remember to release any keygrabs still held */
+  ;
+}
+
+static void
+spi_controller_register_global_keygrabs (SpiDeviceEventController *controller,
+                                        DEControllerKeyListener *key_listener)
+{
+  DEControllerGrabMask grabmask, *grabmask_ptr;
+  GList *list_ptr;
+  gint i;
+  /* TODO: deregistration version of this function */
+  
+  grabmask.modmask = key_listener->mask;
+  if (key_listener->keys->_length == 0) /* special case means AnyKey/AllKeys */
+    {
+      grabmask.keyval = AnyKey;
+      list_ptr = g_list_find_custom (controller->keygrabs_list, &grabmask,
+                                    spi_grabmask_compare_values);
+      if (list_ptr)
+        {
+          grabmask_ptr = (DEControllerGrabMask *) list_ptr->data;
+         grabmask_ptr->refcount++;
+        }
+      else
+        {
+         controller->keygrabs_list =
+                 g_list_prepend (controller->keygrabs_list,
+                                 spi_grabmask_clone (&grabmask));
+        }
+    }
+  else
+    {
+      for (i = 0; i < key_listener->keys->_length; ++i)
+        {
+         long int keyval = key_listener->keys->_buffer[i];
+         /* X Grabs require keycodes, not keysyms */
+         if (keyval >= 0)
+           {
+             keyval = XKeysymToKeycode(spi_get_display (), (KeySym) keyval);               
+           }
+         grabmask.keyval = keyval;
+          list_ptr = g_list_find_custom (controller->keygrabs_list, &grabmask,
+                                            spi_grabmask_compare_values);
+          if (list_ptr)
+            {
+             grabmask_ptr = (DEControllerGrabMask *) list_ptr->data;
+              grabmask_ptr->refcount++;
+            }
+          else
+            {
+             controller->keygrabs_list =
+                 g_list_prepend (controller->keygrabs_list,
+                                 spi_grabmask_clone (&grabmask));
+             fprintf (stderr, "appending mask with val=%lu\n",
+                      (unsigned long) grabmask.modmask);
+            }
+        }
+    }
+}
+
+static void
+spi_controller_register_device_listener (SpiDeviceEventController *controller,
+                                        DEControllerListener *listener,
+                                        CORBA_Environment *ev)
 {
-  Accessibility_ControllerEventMask *mask_ptr = NULL;
   DEControllerKeyListener *key_listener;
   
   switch (listener->type) {
   case SPI_DEVICE_TYPE_KBD:
       key_listener = (DEControllerKeyListener *) listener;       
       controller->key_listeners = g_list_prepend (controller->key_listeners, key_listener);
-      if (key_listener->is_system_global)
+      if (key_listener->mode->global)
         {
-          mask_ptr = (Accessibility_ControllerEventMask *)
-             g_list_find_custom (controller->keymask_list, (gpointer) key_listener->mask,
-                                 _eventmask_compare_value);
-          if (mask_ptr)
-             ++(mask_ptr->refcount);
-          else
-           {
-             if (key_listener->mask->refcount != (CORBA_unsigned_short) 1)
-                     fprintf (stderr, "mask initial refcount is not 1!\n");
-             if (key_listener->mask->value > (CORBA_unsigned_long) 2048)
-                     fprintf (stderr, "mask value looks invalid (%lu)\n",
-                              (unsigned long) key_listener->mask->value);
-             else
-                     fprintf (stderr, "appending mask with val=%lu\n",
-                              (unsigned long) key_listener->mask->value);
-             mask_ptr = Accessibility_ControllerEventMask__alloc();
-             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);
-          }
+         spi_controller_register_global_keygrabs (controller, key_listener);   
        }
       break;
   case SPI_DEVICE_TYPE_MOUSE:
 /*    controller->mouse_listeners = g_list_append (controller->mouse_listeners,
                                                    CORBA_Object_duplicate (l, ev));*/
 
-/* possibly this interface should NOT be used for mouse events ? */
+/* this interface should only be used for mouse motion events, not mouse clicks events */
       break;
   }
 }
 
 static void
-controller_deregister_device_listener (SpiDeviceEventController *controller,
-                                      DEControllerListener *listener,
-                                      CORBA_Environment *ev)
+spi_controller_deregister_device_listener (SpiDeviceEventController *controller,
+                                          DEControllerListener *listener,
+                                          CORBA_Environment *ev)
 {
   Accessibility_ControllerEventMask *mask_ptr;
-  DEControllerKeyListener *key_listener;
   DEControllerListener *dec_listener;
   GList *list_ptr;
-  switch (listener->type) {
-  case SPI_DEVICE_TYPE_KBD:
-      key_listener = (DEControllerKeyListener *) listener;
-      /* first, deref matching event mask, if any */
-      list_ptr = (GList *)
-                 g_list_find_custom (controller->keymask_list, (gpointer) key_listener->mask,
-                                    _eventmask_compare_value);
-      if (list_ptr)
-        {
-         mask_ptr = (Accessibility_ControllerEventMask *) list_ptr->data;
-          if (mask_ptr)
-             --mask_ptr->refcount;
-          if (!mask_ptr->refcount)
-            {
-             controller->keymask_list =
-                     g_list_remove_link (controller->keymask_list, list_ptr);
-             ;  /* TODO: release any key grabs that are in place for this key mask */
-           }
-       }
-      /* now, remove this listener from the keylistener list */
-      list_ptr = g_list_find_custom (controller->key_listeners, listener, _compare_listeners);
-      if (list_ptr)
-        {
-         dec_listener = (DEControllerListener *) list_ptr->data;
+  switch (listener->type)
+    {
+      case SPI_DEVICE_TYPE_KBD:
+        spi_controller_deregister_global_keygrabs (controller,
+                                                  (DEControllerKeyListener *) listener);
+
+        /* now, remove this listener from the keylistener list */
+        list_ptr = g_list_find_custom (controller->key_listeners, listener, spi_compare_listeners);
+        if (list_ptr)
+          {
+           dec_listener = (DEControllerListener *) list_ptr->data;
 #ifdef SPI_DEBUG         
-         g_print ("removing keylistener %p\n", dec_listener->object);
+           g_print ("removing keylistener %p\n", dec_listener->object);
 #endif
-         controller->key_listeners = g_list_remove_link (controller->key_listeners,
+           controller->key_listeners = g_list_remove_link (controller->key_listeners,
                                                          list_ptr);
-         dec_key_listener_free ((DEControllerKeyListener *) dec_listener, ev);
-       }
-      break;
-  case SPI_DEVICE_TYPE_MOUSE:
-/*    controller->mouse_listeners = g_list_append (controller->mouse_listeners,
-                                                   CORBA_Object_duplicate (l, ev));*/
-
-/* possibly this interface should NOT be used for mouse events ? */
-      break;
-  }
+           spi_dec_key_listener_free ((DEControllerKeyListener *) dec_listener, ev);
+         }
+        break;
+      case SPI_DEVICE_TYPE_MOUSE: /* TODO: implement */
+        break;
+    }
 }
 
 static gboolean
-_controller_register_with_devices (SpiDeviceEventController *controller)
+spi_controller_register_with_devices (SpiDeviceEventController *controller)
 {
   gboolean retval = FALSE;
 
   /* calls to device-specific implementations and routines go here */
   /* register with: keyboard hardware code handler */
   /* register with: (translated) keystroke handler */
-#ifdef SPI_DEBUG
-  fprintf (stderr, "About to request events on window %ld of display %p\n",
-          (unsigned long) GDK_ROOT_WINDOW(), GDK_DISPLAY());
-#endif
+
   /* We must open a new connection to the server to avoid clashing with the GDK event loop */
-  display = XOpenDisplay (g_getenv ("DISPLAY"));
-  root_window = DefaultRootWindow (display);           
-  XSelectInput (display,
+  root_window = DefaultRootWindow (spi_get_display ());                
+  XSelectInput (spi_get_display (),
                root_window,
                KeyPressMask | KeyReleaseMask);
   /* register with: mouse hardware device handler? */
@@ -271,7 +337,7 @@ _controller_register_with_devices (SpiDeviceEventController *controller)
 }
 
 static gboolean
-key_set_contains_key (Accessibility_KeySet *key_set, Accessibility_KeyStroke *key_event)
+spi_key_set_contains_key (Accessibility_KeySet *key_set, const Accessibility_DeviceEvent *key_event)
 {
   gint i;
   gint len;
@@ -283,6 +349,7 @@ key_set_contains_key (Accessibility_KeySet *key_set, Accessibility_KeyStroke *ke
   
   if (len == 0) /* special case, means "all keys/any key" */
     {
+      g_print ("anykey\n");        
       return TRUE;
     }
 
@@ -292,19 +359,19 @@ key_set_contains_key (Accessibility_KeySet *key_set, Accessibility_KeyStroke *ke
       g_print ("key_set[%d] = %d; key_event %d, code %d\n",
                i,
               (int) key_set->_buffer[i],
-              (int) key_event->keyID,
-              (int) key_event->keycode); 
+              (int) key_event->id,
+              (int) key_event->hw_code); 
 #endif
-      if (key_set->_buffer[i] == (CORBA_long) key_event->keyID) return TRUE;
-      if (key_set->_buffer[i] == (CORBA_long) -key_event->keycode) return TRUE;
+      if (key_set->_buffer[i] == (CORBA_long) key_event->id) return TRUE;
+      if (key_set->_buffer[i] == (CORBA_long) -key_event->hw_code) return TRUE;
     }
   
   return FALSE;
 }
 
 static gboolean
-key_eventtype_seq_contains_event (Accessibility_KeyEventTypeSeq *type_seq,
-                                 Accessibility_KeyStroke *key_event)
+spi_key_eventtype_seq_contains_event (Accessibility_KeyEventTypeSeq *type_seq,
+                                 const Accessibility_DeviceEvent *key_event)
 {
   gint i;
   gint len;
@@ -321,22 +388,26 @@ key_eventtype_seq_contains_event (Accessibility_KeyEventTypeSeq *type_seq,
 
   for (i=0; i<len; ++i)
     {
-/*      g_print ("type_seq[%d] = %d\n", i, (int) type_seq->_buffer[i]); */
+#ifdef SPI_DEBUG           
+      g_print ("type_seq[%d] = %d; key event type = %d\n", i, (int) type_seq->_buffer[i],
+              (int) key_event->type);
+#endif      
       if (type_seq->_buffer[i] == (CORBA_long) key_event->type) return TRUE;       
     }
   
-  return TRUE;
+  return FALSE;
 }
 
 static gboolean
-key_event_matches_listener (Accessibility_KeyStroke *key_event,
+spi_key_event_matches_listener (const Accessibility_DeviceEvent *key_event,
                            DEControllerKeyListener *listener,
                            CORBA_boolean is_system_global)
 {
-  if ((key_event->modifiers == (CORBA_unsigned_short) (listener->mask->value & 0xFFFF)) &&
-       key_set_contains_key (listener->keys, key_event) &&
-       key_eventtype_seq_contains_event (listener->typeseq, key_event) && 
-      (is_system_global == listener->is_system_global))
+  g_print ("checking keycode %d\n", (int) key_event->hw_code);
+  if ((key_event->modifiers == (CORBA_unsigned_short) (listener->mask & 0xFFFF)) &&
+       spi_key_set_contains_key (listener->keys, key_event) &&
+       spi_key_eventtype_seq_contains_event (listener->typeseq, key_event) && 
+      (is_system_global == listener->mode->global))
     {
       return TRUE;
     }
@@ -345,25 +416,25 @@ key_event_matches_listener (Accessibility_KeyStroke *key_event,
 }
 
 static gboolean
-notify_keylisteners (GList *key_listeners,
-                    Accessibility_KeyStroke *key_event,
-                    CORBA_boolean is_system_global,
-                    CORBA_Environment *ev)
+spi_notify_keylisteners (GList *key_listeners,
+                        const Accessibility_DeviceEvent *key_event,
+                        CORBA_boolean is_system_global,
+                        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;
+      Accessibility_DeviceEventListener ls;
       DEControllerKeyListener *key_listener = (DEControllerKeyListener *)
            g_list_nth_data (key_listeners, i);
-      ls = (Accessibility_KeystrokeListener) key_listener->listener.object;
-      if (key_event_matches_listener (key_event, key_listener, is_system_global))
+      ls = (Accessibility_DeviceEventListener) key_listener->listener.object;
+      if (spi_key_event_matches_listener (key_event, key_listener, is_system_global))
         {
           if (!CORBA_Object_is_nil(ls, ev))
             {
-             is_consumed = Accessibility_KeystrokeListener_keyEvent (ls, key_event, ev);
+             is_consumed = Accessibility_DeviceEventListener_notifyEvent (ls, key_event, ev);
             }          
         }
       else
@@ -377,15 +448,82 @@ notify_keylisteners (GList *key_listeners,
   return is_consumed;
 }
 
+static Accessibility_DeviceEvent
+spi_keystroke_from_x_key_event (XKeyEvent *x_key_event)
+{
+  Accessibility_DeviceEvent key_event;
+  KeySym keysym;
+  const int cbuf_bytes = 20;
+  char cbuf [cbuf_bytes];
+  
+  keysym = XLookupKeysym (x_key_event, 0);
+  key_event.id = (CORBA_long)(keysym);
+  key_event.hw_code = (CORBA_short) x_key_event->keycode;
+  if (((XEvent *) x_key_event)->type == KeyPress)
+    {
+      key_event.type = Accessibility_KEY_PRESSED;
+    }
+  else
+    {
+      key_event.type = Accessibility_KEY_RELEASED;
+    } 
+  key_event.modifiers = (CORBA_unsigned_short)(x_key_event->state);
+  key_event.is_text = CORBA_FALSE;
+  switch (keysym)
+    {
+      case ' ':
+        key_event.event_string = CORBA_string_dup ("space");
+        break;
+      case XK_Tab:
+        key_event.event_string = CORBA_string_dup ("Tab");
+       break;
+      case XK_BackSpace:
+        key_event.event_string = CORBA_string_dup ("Backspace");
+       break;
+      case XK_Return:
+        key_event.event_string = CORBA_string_dup ("Return");
+       break;
+      default:
+        if (XLookupString (x_key_event, cbuf, cbuf_bytes, &keysym, NULL) > 0)
+          {
+            key_event.event_string = CORBA_string_dup (cbuf);
+           if (isgraph (keysym))
+             {
+               key_event.is_text = CORBA_TRUE; /* FIXME: incorrect for some composed chars? */
+             }
+          }
+        else
+          {
+            key_event.event_string = CORBA_string_dup ("");
+          }
+    }
+
+  key_event.timestamp = (CORBA_unsigned_long) x_key_event->time;
+#ifdef SPI_KEYEVENT_DEBUG
+  fprintf (stderr,
+     "Key %lu pressed (%c), modifiers %d\n",
+     (unsigned long) keysym,
+     keysym ? (int) keysym : '*',
+     (int) x_key_event->state);
+#endif
+#ifdef SPI_DEBUG
+  fprintf (stderr, "%s%c",
+     (x_key_event->state & Mod1Mask)?"Alt-":"",
+     ((x_key_event->state & ShiftMask)^(x_key_event->state & LockMask))?
+     g_ascii_toupper (keysym) : g_ascii_tolower (keysym));
+#endif /* SPI_DEBUG */
+  return key_event;    
+}
+
+
 static gboolean
-_check_key_event (SpiDeviceEventController *controller)
+spi_check_key_event (SpiDeviceEventController *controller)
 {
        static gboolean initialized = FALSE;
        XEvent *x_event = g_new0 (XEvent, 1);
        XKeyEvent *x_key_event;
-       KeySym keysym;
        gboolean is_consumed = FALSE;
-       Accessibility_KeyStroke key_event;
+       Accessibility_DeviceEvent key_event;
        static CORBA_Environment ev;
 
        if (!initialized)
@@ -394,61 +532,44 @@ _check_key_event (SpiDeviceEventController *controller)
          CORBA_exception_init (&ev);
        }
 
-       while (XPending(display))
+       while (XPending(spi_get_display ()))
          {
-           XNextEvent (display, x_event);
+           XNextEvent (spi_get_display (), x_event);
            if (XFilterEvent (x_event, None)) continue;   
-           if (x_event->type == KeyPress)
+           if (x_event->type == KeyPress || x_event->type == KeyRelease)
              {
-               x_key_event = (XKeyEvent *)x_event;
-               keysym = XLookupKeysym (x_key_event, 0);
-               key_event.keyID = (CORBA_long)(keysym);
-               key_event.keycode = (CORBA_short) x_key_event->keycode;
-               key_event.type = Accessibility_KEY_PRESSED;
-               key_event.modifiers = (CORBA_unsigned_short)(x_key_event->state);
-#ifdef SPI_KEYEVENT_DEBUG
-           fprintf (stderr,
-                    "Key %lu pressed (%c), modifiers %d\n",
-                    (unsigned long) keysym,
-                    keysym ? (int) keysym : '*',
-                    (int) x_key_event->state);
-#endif
-#ifdef SPI_DEBUG
-           fprintf (stderr, "%s%c",
-                    (x_key_event->state & Mod1Mask)?"Alt-":"",
-                    ((x_key_event->state & ShiftMask)^(x_key_event->state & LockMask))?
-                    g_ascii_toupper (keysym) : g_ascii_tolower (keysym));
-#endif /* SPI_DEBUG */
+               key_event = spi_keystroke_from_x_key_event ((XKeyEvent *) x_event);
+               /* relay to listeners, and decide whether to consume it or not */
+               is_consumed = spi_notify_keylisteners (controller->key_listeners, &key_event, CORBA_TRUE, &ev);
              }
            else
-           {
+             {
 #ifdef SPI_KEYEVENT_DEBUG
-                   fprintf (stderr, "other event, type %d\n", (int) x_event->type);
+               fprintf (stderr, "other event, type %d\n", (int) x_event->type);
 #endif
-           }
-           /* relay to listeners, and decide whether to consume it or not */
-           is_consumed = notify_keylisteners (controller->key_listeners, &key_event, CORBA_TRUE, &ev);
+             }
 
            if (is_consumed)
-           {
-             XAllowEvents (display, AsyncKeyboard, CurrentTime);
-           }
+             {
+               XAllowEvents (spi_get_display (), AsyncKeyboard, CurrentTime);
+             }
            else
-           {
-             XAllowEvents (display, ReplayKeyboard, CurrentTime);
-           }
+             {
+               XAllowEvents (spi_get_display (), ReplayKeyboard, CurrentTime);
+             }
          }
-       XUngrabKey (display, AnyKey, AnyModifier, root_window);
-       return _controller_grab_keyboard (controller);
+       XUngrabKey (spi_get_display (), AnyKey, AnyModifier, root_window);
+
+       return spi_controller_grab_keyboard (controller);
 }
 
 static gboolean
-_controller_grab_keyboard (SpiDeviceEventController *controller)
+spi_controller_grab_keyboard (SpiDeviceEventController *controller)
 {
-       GList *maskList = controller->keymask_list;
-       int i;
-       int last_mask;
-       last_mask = g_list_length (maskList);
+  GList *maskList = controller->keygrabs_list;
+  int i;
+  int last_mask;
+  last_mask = g_list_length (maskList);
 
 /*
  * masks known to work with default RH 7.1: 
@@ -460,30 +581,37 @@ _controller_grab_keyboard (SpiDeviceEventController *controller)
  * ControlMask grabs are broken, must be in use already
  */
        
-       for (i=0; i < last_mask; ++i)
-       {
-               Accessibility_ControllerEventMask *mask
-                       = (Accessibility_ControllerEventMask *)g_list_nth_data (maskList, i);
-               unsigned long maskVal = 0xFFFFFFFF;
-               if (mask) maskVal = (unsigned long) mask->value;
-#ifdef SPI_KEYEVENT_DEBUG
-               fprintf (stderr, "mask=%lx\n", maskVal);
+  for (i=0; i < last_mask; ++i)
+    {
+      DEControllerGrabMask * grab_mask
+               = (DEControllerGrabMask *) g_list_nth_data (maskList, i);
+      unsigned long maskVal = 0xFFFFFFFF;
+      int           keyVal = AnyKey;
+      if (grab_mask)
+        {
+         maskVal = (unsigned long) grab_mask->modmask;
+         keyVal =  grab_mask->keyval;
+        }
+#ifdef SPI_DEBUG
+      fprintf (stderr, "mask=%lx\n", maskVal);
 #endif
-               if (!(maskVal & ControlMask))
-               {
-                       XGrabKey (display,
-                                 AnyKey,
-                                 maskVal,
-                                 root_window,
-                                 True,
-                                 GrabModeAsync,
-                                 GrabModeAsync);
-                       /* TODO: check call for errors and return FALSE if error occurs */
-               } else {
-                       return FALSE; /* can't do control key yet */
-               }
+      if (!(maskVal & ControlMask))
+       {
+         XGrabKey (spi_get_display (),
+                   keyVal, 
+                   maskVal,
+                   root_window,
+                   True,
+                   GrabModeAsync,
+                   GrabModeAsync);
+         /* TODO: check call for errors and return FALSE if error occurs */
        }
-       return TRUE;
+      else
+        {
+         return FALSE; /* can't do control key yet */
+        }
+    }
+  return TRUE;
 }
 
 /*
@@ -494,11 +622,11 @@ spi_device_event_controller_object_finalize (GObject *object)
 {
 
 #ifdef SPI_DEBUG
-        fprintf(stderr, "spi_device_event_controller_object_finalize called\n");
+  fprintf(stderr, "spi_device_event_controller_object_finalize called\n");
 #endif
-       /* disconnect any special listeners, get rid of outstanding keygrabs */
+  /* disconnect any special listeners, get rid of outstanding keygrabs */
        
-        spi_device_event_controller_parent_class->finalize (object);
+  spi_device_event_controller_parent_class->finalize (object);
 }
 
 /*
@@ -507,22 +635,22 @@ spi_device_event_controller_object_finalize (GObject *object)
  */
 static void
 impl_register_keystroke_listener (PortableServer_Servant     servant,
-                                 const Accessibility_KeystrokeListener l,
+                                 const Accessibility_DeviceEventListener l,
                                  const Accessibility_KeySet *keys,
-                                 const Accessibility_ControllerEventMask *mask,
+                                 const Accessibility_ControllerEventMask mask,
                                  const Accessibility_KeyEventTypeSeq *type,
-                                 const CORBA_boolean is_system_global,
+                                 const Accessibility_EventListenerMode *mode,
                                  CORBA_Environment         *ev)
 {
-       SpiDeviceEventController *controller = SPI_DEVICE_EVENT_CONTROLLER (
-               bonobo_object_from_servant (servant));
-       DEControllerKeyListener *dec_listener;
+  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);
+  fprintf (stderr, "registering keystroke listener %p with maskVal %lu\n",
+          (void *) l, (unsigned long) mask);
 #endif
-       dec_listener = dec_key_listener_new (l, keys, mask, type, is_system_global, ev);
-       controller_register_device_listener (controller, (DEControllerListener *) dec_listener, ev);
+  dec_listener = spi_dec_key_listener_new (l, keys, mask, type, mode, ev);
+  spi_controller_register_device_listener (controller, (DEControllerListener *) dec_listener, ev);
 }
 
 /*
@@ -531,29 +659,28 @@ impl_register_keystroke_listener (PortableServer_Servant     servant,
  */
 static void
 impl_deregister_keystroke_listener (PortableServer_Servant     servant,
-                                   const Accessibility_KeystrokeListener l,
+                                   const Accessibility_DeviceEventListener l,
                                    const Accessibility_KeySet *keys,
-                                   const Accessibility_ControllerEventMask *mask,
+                                   const Accessibility_ControllerEventMask mask,
                                    const Accessibility_KeyEventTypeSeq *type,
-                                   const CORBA_boolean is_system_global,
                                    CORBA_Environment         *ev)
 {
        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);
+       DEControllerKeyListener *key_listener = spi_dec_key_listener_new (l,
+                                                                         keys,
+                                                                         mask,
+                                                                         type,
+                                                                         NULL,
+                                                                         ev);
 #ifdef SPI_DEREGISTER_DEBUG
        fprintf (stderr, "deregistering keystroke listener %p with maskVal %lu\n",
                 (void *) l, (unsigned long) mask->value);
 #endif
-       controller_deregister_device_listener(controller,
+       spi_controller_deregister_device_listener(controller,
                                              (DEControllerListener *) key_listener,
                                              ev);
-       dec_key_listener_free (key_listener, ev);
+       spi_dec_key_listener_free (key_listener, ev);
 }
 
 /*
@@ -571,55 +698,60 @@ impl_register_mouse_listener (PortableServer_Servant     servant,
 #ifdef SPI_DEBUG
        fprintf (stderr, "registering mouse listener %p\n", l);
 #endif
-       controller_register_device_listener(controller, DEVICE_TYPE_MOUSE, l, keys, mask, ev);
+       spi_controller_register_device_listener(controller, DEVICE_TYPE_MOUSE, l, keys, mask, ev);
 }
 */
 
 static KeyCode
 keycode_for_keysym (long keysym)
 {
-  return XKeysymToKeycode (display, (KeySym) keysym);
+  return XKeysymToKeycode (spi_get_display (), (KeySym) keysym);
 }
 
+#define SPI_DEBUG
+
 /*
  * CORBA Accessibility::DeviceEventController::registerKeystrokeListener
  *     method implementation
  */
 static void
-impl_generate_key_event (PortableServer_Servant     servant,
-                        const CORBA_long           keycode,
-                        const Accessibility_KeySynthType synth_type,
-                        CORBA_Environment          *ev)
+impl_generate_keyboard_event (PortableServer_Servant     servant,
+                             const CORBA_long           keycode,
+                             const CORBA_char          *keystring,
+                             const Accessibility_KeySynthType synth_type,
+                             CORBA_Environment          *ev)
 {
-       long key_synth_code;
+  long key_synth_code;
 #ifdef SPI_DEBUG
-       fprintf (stderr, "synthesizing keystroke %ld\n", (long) keycode);
+  fprintf (stderr, "synthesizing keystroke %ld, type %d\n", (long) keycode, (int) synth_type);
 #endif
-       /* TODO: hide/wrap/remove X dependency */
+  /* TODO: hide/wrap/remove X dependency */
 
-       /* TODO: be accessX-savvy so that keyrelease occurs after sufficient timeout */
+  /* 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.
-        */
+  /*
+   * TODO: when initializing, query for XTest extension before using,
+   * and fall back to XSendEvent() if XTest is not available.
+   */
+  
+  /* TODO: implement keystring mode also */
        
-       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;
-       }
+  switch (synth_type)
+    {
+      case Accessibility_KEY_PRESS:
+         XTestFakeKeyEvent (spi_get_display (), (unsigned int) keycode, True, CurrentTime);
+         break;
+      case Accessibility_KEY_PRESSRELEASE:
+         XTestFakeKeyEvent (spi_get_display (), (unsigned int) keycode, True, CurrentTime);
+      case Accessibility_KEY_RELEASE:
+         XTestFakeKeyEvent (spi_get_display (), (unsigned int) keycode, False, CurrentTime);
+         break;
+      case Accessibility_KEY_SYM:
+         key_synth_code = keycode_for_keysym (keycode);
+         XTestFakeKeyEvent (spi_get_display (), (unsigned int) key_synth_code, True, CurrentTime);
+         XTestFakeKeyEvent (spi_get_display (), (unsigned int) key_synth_code, False, CurrentTime);
+         break;
+   }
 }
 
 /* Accessibility::DeviceEventController::generateMouseEvent */
@@ -643,12 +775,11 @@ impl_notify_listeners_sync(PortableServer_Servant     servant,
 {
   SpiDeviceEventController *controller = SPI_DEVICE_EVENT_CONTROLLER (
                                          bonobo_object_from_servant (servant));
-  Accessibility_KeyStroke *key_event = (Accessibility_KeyStroke *) event;      
 #ifdef SPI_DEBUG
-  g_print ("notifying listeners synchronously: controller %x, event id %d\n",
-          (void *) controller, (int) event->eventID);
+  g_print ("notifylistening listeners synchronously: controller %x, event id %d\n",
+          (void *) controller, (int) event->id);
 #endif
-  return (notify_keylisteners (controller->key_listeners, key_event, CORBA_FALSE, ev) ?
+  return (spi_notify_keylisteners (controller->key_listeners, event, CORBA_FALSE, ev) ?
          CORBA_TRUE : CORBA_FALSE); 
 }
 
@@ -660,11 +791,10 @@ impl_notify_listeners_async (PortableServer_Servant     servant,
 {
   SpiDeviceEventController *controller = SPI_DEVICE_EVENT_CONTROLLER(
                                         bonobo_object_from_servant (servant));
-  Accessibility_KeyStroke *key_event = (Accessibility_KeyStroke *) event;      
 #ifdef SPI_DEBUG
   fprintf (stderr, "notifying listeners asynchronously\n");
 #endif
-  notify_keylisteners (controller->key_listeners, key_event, CORBA_FALSE, ev); 
+  spi_notify_keylisteners (controller->key_listeners, event, CORBA_FALSE, ev); 
 }
 
 static void
@@ -679,11 +809,11 @@ spi_device_event_controller_class_init (SpiDeviceEventControllerClass *klass)
         epv->registerKeystrokeListener = impl_register_keystroke_listener;
         epv->deregisterKeystrokeListener = impl_deregister_keystroke_listener;
 /*        epv->registerMouseListener = impl_register_mouse_listener; */
-        epv->generateKeyEvent = impl_generate_key_event;
+        epv->generateKeyboardEvent = impl_generate_keyboard_event;
         epv->generateMouseEvent = impl_generate_mouse_event;
        epv->notifyListenersSync = impl_notify_listeners_sync;
        epv->notifyListenersAsync = impl_notify_listeners_async;
-       klass->check_key_event = _check_key_event;
+       klass->check_key_event = spi_check_key_event;
 }
 
 static void
@@ -691,17 +821,17 @@ spi_device_event_controller_init (SpiDeviceEventController *device_event_control
 {
   device_event_controller->key_listeners = NULL;
   device_event_controller->mouse_listeners = NULL;
-  device_event_controller->keymask_list = NULL;
-  kbd_registered = _controller_register_with_devices (device_event_controller);
+  device_event_controller->keygrabs_list = NULL;
+  kbd_registered = spi_controller_register_with_devices (device_event_controller);
 }
 
 gboolean
 spi_device_event_controller_check_key_event (SpiDeviceEventController *controller)
 {
-       SpiDeviceEventControllerClass *klass = SPI_DEVICE_EVENT_CONTROLLER_GET_CLASS (controller);
-       if (klass->check_key_event)
-               return (klass->check_key_event) (controller);
-       return FALSE;
+  SpiDeviceEventControllerClass *klass = SPI_DEVICE_EVENT_CONTROLLER_GET_CLASS (controller);
+  if (klass->check_key_event)
+       return (klass->check_key_event) (controller);
+  return FALSE;
 }
 
 SpiDeviceEventController *