registryd/deviceeventcontroller.c

   1 /* AT-SPI - Assistive Technology Service Provider Interface
   2  *
   3  * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
   4  *
   5  * Copyright 2001, 2003 Sun Microsystems Inc.,
   6  * Copyright 2001, 2002 Ximian, Inc.
   7  *
   8  * This library is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Library General Public
  10  * License as published by the Free Software Foundation; either
  11  * version 2 of the License, or (at your option) any later version.
  12  *
  13  * This library is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * Library General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Library General Public
  19  * License along with this library; if not, write to the
  20  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  21  * Boston, MA 02111-1307, USA.
  22  */
  23
  24 /* deviceeventcontroller.c: implement the DeviceEventController interface */
  25
  26 #include <config.h>
  27
  28 #undef  SPI_XKB_DEBUG
  29 #undef  SPI_DEBUG
  30 #undef  SPI_KEYEVENT_DEBUG
  31
  32 #include <string.h>
  33 #include <ctype.h>
  34 #include <stdio.h>
  35 #include <sys/time.h>
  36 #include <bonobo/bonobo-exception.h>
  37
  38 #include <X11/Xlib.h>
  39 #include <X11/extensions/XTest.h>
  40 #include <X11/XKBlib.h>
  41 #define XK_MISCELLANY
  42 #define XK_LATIN1
  43 #include <X11/keysymdef.h>
  44
  45 #ifdef HAVE_XEVIE
  46 #include <X11/Xproto.h>
  47 #include <X11/X.h>
  48 #include <X11/extensions/Xevie.h>
  49 #endif /* HAVE_XEVIE */
  50
  51 #include <gdk/gdk.h>
  52 #include <gdk/gdkx.h> /* TODO: hide dependency (wrap in single porting file) */
  53 #include <gdk/gdkkeysyms.h>
  54 #include <gdk/gdkwindow.h>
  55
  56 #include "../libspi/spi-private.h"
  57 #include "deviceeventcontroller.h"
  58
  59 KeySym ucs2keysym (long ucs);
  60 long keysym2ucs(KeySym keysym);
  61
  62 #define CHECK_RELEASE_DELAY 20
  63 #define BIT(c, x)       (c[x/8]&(1<<(x%8)))
  64 static guint check_release_handler = 0;
  65 static Accessibility_DeviceEvent pressed_event;
  66 static SpiDEController *saved_controller;
  67 static void wait_for_release_event (XEvent *event, SpiDEController *controller);
  68
  69 /* Our parent Gtk object type */
  70 #define PARENT_TYPE BONOBO_TYPE_OBJECT
  71
  72 /* A pointer to our parent object class */
  73 static GObjectClass *spi_device_event_controller_parent_class;
  74 static int spi_error_code = 0;
  75 static GdkPoint last_mouse_pos_static = {0, 0};
  76 static GdkPoint *last_mouse_pos = &last_mouse_pos_static;
  77 static unsigned int mouse_mask_state = 0;
  78 static unsigned int mouse_button_mask =
  79   Button1Mask | Button2Mask | Button3Mask | Button4Mask | Button5Mask;
  80 static unsigned int key_modifier_mask =
  81   Mod1Mask | Mod2Mask | Mod3Mask | Mod4Mask | Mod5Mask | ShiftMask | LockMask | ControlMask | SPI_KEYMASK_NUMLOCK;
  82 static unsigned int _numlock_physical_mask = Mod2Mask; /* a guess, will be reset */
  83
  84 static GQuark spi_dec_private_quark = 0;
  85
  86 int (*x_default_error_handler) (Display *display, XErrorEvent *error_event);
  87
  88 typedef enum {
  89   SPI_DEVICE_TYPE_KBD,
  90   SPI_DEVICE_TYPE_MOUSE,
  91   SPI_DEVICE_TYPE_LAST_DEFINED
  92 } SpiDeviceTypeCategory;
  93
  94 typedef struct {
  95   guint                             ref_count : 30;
  96   guint                             pending_add : 1;
  97   guint                             pending_remove : 1;
  98
  99   Accessibility_ControllerEventMask mod_mask;
 100   CORBA_unsigned_long               key_val;  /* KeyCode */
 101 } DEControllerGrabMask;
 102
 103 typedef struct {
 104   CORBA_Object          object;
 105   SpiDeviceTypeCategory type;
 106   Accessibility_EventTypeSeq    *typeseq;
 107 } DEControllerListener;
 108
 109 typedef struct {
 110   DEControllerListener listener;
 111
 112   Accessibility_KeySet             *keys;
 113   Accessibility_ControllerEventMask mask;
 114   Accessibility_EventListenerMode  *mode;
 115 } DEControllerKeyListener;
 116
 117 typedef struct {
 118   unsigned int last_press_keycode;
 119   unsigned int last_release_keycode;
 120   struct timeval last_press_time;
 121   struct timeval last_release_time;
 122   int have_xkb;
 123   int xkb_major_extension_opcode;
 124   int xkb_base_event_code;
 125   int xkb_base_error_code;
 126   unsigned int xkb_latch_mask;
 127   unsigned int pending_xkb_mod_relatch_mask;
 128   XkbDescPtr xkb_desc;
 129   KeyCode reserved_keycode;
 130   KeySym reserved_keysym;
 131   guint  reserved_reset_timeout;
 132 } DEControllerPrivateData;
 133
 134 static void     spi_controller_register_with_devices          (SpiDEController           *controller);
 135 static gboolean spi_controller_update_key_grabs               (SpiDEController           *controller,
 136                                                                Accessibility_DeviceEvent *recv);
 137 static gboolean spi_controller_register_device_listener       (SpiDEController           *controller,
 138                                                                DEControllerListener      *l,
 139                                                                CORBA_Environment         *ev);
 140 static gboolean spi_device_event_controller_forward_key_event (SpiDEController           *controller,
 141                                                                const XEvent              *event);
 142 static void     spi_deregister_controller_device_listener (SpiDEController            *controller,
 143                                                            DEControllerListener *listener,
 144                                                            CORBA_Environment          *ev);
 145 static void     spi_deregister_controller_key_listener (SpiDEController         *controller,
 146                                                         DEControllerKeyListener *key_listener,
 147                                                         CORBA_Environment       *ev);
 148 static gboolean spi_controller_notify_mouselisteners (SpiDEController                 *controller,
 149                                                       const Accessibility_DeviceEvent *event,
 150                                                       CORBA_Environment               *ev);
 151
 152 static gboolean spi_eventtype_seq_contains_event (Accessibility_EventTypeSeq      *type_seq,
 153                                                   const Accessibility_DeviceEvent *event);
 154 static gboolean spi_clear_error_state (void);
 155 static gboolean spi_dec_poll_mouse_moved (gpointer data);
 156 static gboolean spi_dec_poll_mouse_moving (gpointer data);
 157 static gboolean spi_dec_poll_mouse_idle (gpointer data);
 158
 159 #define spi_get_display() GDK_DISPLAY()
 160
 161 /* Private methods */
 162
 163 static unsigned int
 164 keysym_mod_mask (KeySym keysym, KeyCode keycode)
 165 {
 166         /* we really should use XKB and look directly at the keymap */
 167         /* this is very inelegant */
 168         Display *display = spi_get_display ();
 169         unsigned int mods_rtn = 0;
 170         unsigned int retval = 0;
 171         KeySym sym_rtn;
 172
 173         if (XkbLookupKeySym (display, keycode, 0, &mods_rtn, &sym_rtn) &&
 174             (sym_rtn == keysym)) {
 175                 retval = 0;
 176         }
 177         else if (XkbLookupKeySym (display, keycode, ShiftMask, &mods_rtn, &sym_rtn) &&
 178                  (sym_rtn == keysym)) {
 179                 retval = ShiftMask;
 180         }
 181         else if (XkbLookupKeySym (display, keycode, Mod2Mask, &mods_rtn, &sym_rtn) &&
 182                  (sym_rtn == keysym)) {
 183                 retval = Mod2Mask;
 184         }
 185         else if (XkbLookupKeySym (display, keycode, Mod3Mask, &mods_rtn, &sym_rtn) &&
 186                  (sym_rtn == keysym)) {
 187                 retval = Mod3Mask;
 188         }
 189         else if (XkbLookupKeySym (display, keycode,
 190                                   ShiftMask | Mod2Mask, &mods_rtn, &sym_rtn) &&
 191                  (sym_rtn == keysym)) {
 192                 retval = (Mod2Mask | ShiftMask);
 193         }
 194         else if (XkbLookupKeySym (display, keycode,
 195                                   ShiftMask | Mod3Mask, &mods_rtn, &sym_rtn) &&
 196                  (sym_rtn == keysym)) {
 197                 retval = (Mod3Mask | ShiftMask);
 198         }
 199         else if (XkbLookupKeySym (display, keycode,
 200                                   ShiftMask | Mod4Mask, &mods_rtn, &sym_rtn) &&
 201                  (sym_rtn == keysym)) {
 202                 retval = (Mod4Mask | ShiftMask);
 203         }
 204         else
 205                 retval = 0xFFFF;
 206         return retval;
 207 }
 208
 209 static gboolean
 210 spi_dec_replace_map_keysym (DEControllerPrivateData *priv, KeyCode keycode, KeySym keysym)
 211 {
 212 #ifdef HAVE_XKB
 213   Display *dpy = spi_get_display ();
 214   XkbDescPtr desc;
 215   if (!(desc = XkbGetMap (dpy, XkbAllMapComponentsMask, XkbUseCoreKbd)))
 216     {
 217       fprintf (stderr, "ERROR getting map\n");
 218     }
 219   XFlush (dpy);
 220   XSync (dpy, False);
 221   if (desc && desc->map)
 222     {
 223       gint offset = desc->map->key_sym_map[keycode].offset;
 224       desc->map->syms[offset] = keysym;
 225     }
 226   else
 227     {
 228       fprintf (stderr, "Error changing key map: empty server structure\n");
 229     }
 230   XkbSetMap (dpy, XkbAllMapComponentsMask, desc);
 231   /**
 232    *  FIXME: the use of XkbChangeMap, and the reuse of the priv->xkb_desc structure,
 233    * would be far preferable.
 234    * HOWEVER it does not seem to work using XFree 4.3.
 235    **/
 236   /*        XkbChangeMap (dpy, priv->xkb_desc, priv->changes); */
 237   XFlush (dpy);
 238   XSync (dpy, False);
 239   XkbFreeKeyboard (desc, 0, TRUE);
 240
 241   return TRUE;
 242 #else
 243   return FALSE;
 244 #endif
 245 }
 246
 247 static gboolean
 248 spi_dec_reset_reserved (gpointer data)
 249 {
 250   DEControllerPrivateData *priv = data;
 251   spi_dec_replace_map_keysym (priv, priv->reserved_keycode, priv->reserved_keysym);
 252   priv->reserved_reset_timeout = 0;
 253   return FALSE;
 254 }
 255
 256 static KeyCode
 257 keycode_for_keysym (SpiDEController *controller, long keysym, unsigned int *modmask)
 258 {
 259         KeyCode keycode = 0;
 260         keycode = XKeysymToKeycode (spi_get_display (), (KeySym) keysym);
 261         if (!keycode)
 262         {
 263                 DEControllerPrivateData *priv = (DEControllerPrivateData *)
 264                         g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
 265                 /* if there's no keycode available, fix it */
 266                 if (spi_dec_replace_map_keysym (priv, priv->reserved_keycode, keysym))
 267                 {
 268                         keycode = priv->reserved_keycode;
 269                         /*
 270                          * queue a timer to restore the old keycode.  Ugly, but required
 271                          * due to races / asynchronous X delivery.
 272                          * Long-term fix is to extend the X keymap here instead of replace entries.
 273                          */
 274                         priv->reserved_reset_timeout = g_timeout_add (500, spi_dec_reset_reserved, priv);
 275                 }
 276                 *modmask = 0;
 277                 return keycode;
 278         }
 279         if (modmask)
 280                 *modmask = keysym_mod_mask (keysym, keycode);
 281         return keycode;
 282 }
 283
 284 static DEControllerGrabMask *
 285 spi_grab_mask_clone (DEControllerGrabMask *grab_mask)
 286 {
 287   DEControllerGrabMask *clone = g_new (DEControllerGrabMask, 1);
 288
 289   memcpy (clone, grab_mask, sizeof (DEControllerGrabMask));
 290
 291   clone->ref_count = 1;
 292   clone->pending_add = TRUE;
 293   clone->pending_remove = FALSE;
 294
 295   return clone;
 296 }
 297
 298 static void
 299 spi_grab_mask_free (DEControllerGrabMask *grab_mask)
 300 {
 301   g_free (grab_mask);
 302 }
 303
 304 static gint
 305 spi_grab_mask_compare_values (gconstpointer p1, gconstpointer p2)
 306 {
 307   DEControllerGrabMask *l1 = (DEControllerGrabMask *) p1;
 308   DEControllerGrabMask *l2 = (DEControllerGrabMask *) p2;
 309
 310   if (p1 == p2)
 311     {
 312       return 0;
 313     }
 314   else
 315     {
 316       return ((l1->mod_mask != l2->mod_mask) || (l1->key_val != l2->key_val));
 317     }
 318 }
 319
 320 static void
 321 spi_dec_set_unlatch_pending (SpiDEController *controller, unsigned mask)
 322 {
 323   DEControllerPrivateData *priv =
 324     g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
 325 #ifdef SPI_XKB_DEBUG
 326   if (priv->xkb_latch_mask) fprintf (stderr, "unlatch pending! %x\n",
 327                                      priv->xkb_latch_mask);
 328 #endif
 329   priv->pending_xkb_mod_relatch_mask |= priv->xkb_latch_mask;
 330 }
 331
 332 static void
 333 spi_dec_clear_unlatch_pending (SpiDEController *controller)
 334 {
 335   DEControllerPrivateData *priv =
 336     g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
 337   priv->xkb_latch_mask = 0;
 338 }
 339
 340 static gboolean
 341 spi_dec_button_update_and_emit (SpiDEController *controller,
 342                                 guint mask_return)
 343 {
 344   CORBA_Environment ev;
 345   Accessibility_Event e;
 346   Accessibility_DeviceEvent mouse_e;
 347   gchar event_name[24];
 348   gboolean is_consumed = FALSE;
 349
 350   if ((mask_return & mouse_button_mask) !=
 351       (mouse_mask_state & mouse_button_mask))
 352     {
 353       int button_number = 0;
 354       gboolean is_down = False;
 355
 356       if (!(mask_return & Button1Mask) &&
 357           (mouse_mask_state & Button1Mask))
 358         {
 359           mouse_mask_state &= ~Button1Mask;
 360           button_number = 1;
 361         }
 362       else if ((mask_return & Button1Mask) &&
 363                !(mouse_mask_state & Button1Mask))
 364         {
 365           mouse_mask_state |= Button1Mask;
 366           button_number = 1;
 367           is_down = True;
 368         }
 369       else if (!(mask_return & Button2Mask) &&
 370                (mouse_mask_state & Button2Mask))
 371         {
 372           mouse_mask_state &= ~Button2Mask;
 373           button_number = 2;
 374         }
 375       else if ((mask_return & Button2Mask) &&
 376                !(mouse_mask_state & Button2Mask))
 377         {
 378           mouse_mask_state |= Button2Mask;
 379           button_number = 2;
 380           is_down = True;
 381         }
 382       else if (!(mask_return & Button3Mask) &&
 383                (mouse_mask_state & Button3Mask))
 384         {
 385           mouse_mask_state &= ~Button3Mask;
 386           button_number = 3;
 387         }
 388       else if ((mask_return & Button3Mask) &&
 389                !(mouse_mask_state & Button3Mask))
 390         {
 391           mouse_mask_state |= Button3Mask;
 392           button_number = 3;
 393           is_down = True;
 394         }
 395       else if (!(mask_return & Button4Mask) &&
 396                (mouse_mask_state & Button4Mask))
 397         {
 398           mouse_mask_state &= ~Button4Mask;
 399           button_number = 4;
 400         }
 401       else if ((mask_return & Button4Mask) &&
 402                !(mouse_mask_state & Button4Mask))
 403         {
 404           mouse_mask_state |= Button4Mask;
 405           button_number = 4;
 406           is_down = True;
 407         }
 408       else if (!(mask_return & Button5Mask) &&
 409                (mouse_mask_state & Button5Mask))
 410         {
 411           mouse_mask_state &= ~Button5Mask;
 412           button_number = 5;
 413         }
 414       else if ((mask_return & Button5Mask) &&
 415                !(mouse_mask_state & Button5Mask))
 416         {
 417           mouse_mask_state |= Button5Mask;
 418           button_number = 5;
 419           is_down = True;
 420         }
 421       if (button_number) {
 422 #ifdef SPI_DEBUG
 423         fprintf (stderr, "Button %d %s\n",
 424                  button_number, (is_down) ? "Pressed" : "Released");
 425 #endif
 426         snprintf (event_name, 22, "mouse:button:%d%c", button_number,
 427                   (is_down) ? 'p' : 'r');
 428         /* TODO: FIXME distinguish between physical and
 429          * logical buttons
 430          */
 431         mouse_e.type      = (is_down) ?
 432           Accessibility_BUTTON_PRESSED_EVENT :
 433           Accessibility_BUTTON_RELEASED_EVENT;
 434         mouse_e.id        = button_number;
 435         mouse_e.hw_code   = button_number;
 436         mouse_e.modifiers = (CORBA_unsigned_short) mouse_mask_state;
 437         mouse_e.timestamp = 0;
 438         mouse_e.event_string = "";
 439         mouse_e.is_text   = CORBA_FALSE;
 440         is_consumed =
 441           spi_controller_notify_mouselisteners (controller,
 442                                                 &mouse_e,
 443                                                 &ev);
 444         e.type = event_name;
 445         e.source = BONOBO_OBJREF (controller->registry->desktop);
 446         e.detail1 = last_mouse_pos->x;
 447         e.detail2 = last_mouse_pos->y;
 448         spi_init_any_nil (&e.any_data,
 449                     spi_accessible_new_return (atk_get_root (), FALSE, NULL),
 450                     Accessibility_ROLE_UNKNOWN,
 451                     CORBA_string_dup (""));
 452         CORBA_exception_init (&ev);
 453         if (!is_consumed)
 454           {
 455             Accessibility_Registry_notifyEvent (BONOBO_OBJREF (controller->registry),
 456                                                 &e,
 457                                                 &ev);
 458           }
 459         else
 460           spi_dec_set_unlatch_pending (controller, mask_return);
 461       }
 462       return TRUE;
 463     }
 464   else
 465     {
 466       return FALSE;
 467     }
 468 }
 469
 470
 471 static guint
 472 spi_dec_mouse_check (SpiDEController *controller,
 473                      int *x, int *y, gboolean *moved)
 474 {
 475   Accessibility_Event e;
 476   CORBA_Environment ev;
 477   int win_x_return,win_y_return;
 478   unsigned int mask_return;
 479   Window root_return, child_return;
 480   Display *display = spi_get_display ();
 481
 482   if (display != NULL)
 483     XQueryPointer(display, DefaultRootWindow (display),
 484                   &root_return, &child_return,
 485                   x, y,
 486                   &win_x_return, &win_y_return, &mask_return);
 487   /*
 488    * Since many clients grab the pointer, and X goes an automatic
 489    * pointer grab on mouse-down, we often must detect mouse button events
 490    * by polling rather than via a button grab.
 491    * The while loop (rather than if) is used since it's possible that
 492    * multiple buttons have changed state since we last checked.
 493    */
 494   if (mask_return != mouse_mask_state)
 495     {
 496       while (spi_dec_button_update_and_emit (controller, mask_return));
 497     }
 498
 499   if (*x != last_mouse_pos->x || *y != last_mouse_pos->y)
 500     {
 501       e.type = "mouse:abs";
 502       e.source = BONOBO_OBJREF (controller->registry->desktop);
 503       e.detail1 = *x;
 504       e.detail2 = *y;
 505       spi_init_any_nil (&e.any_data,
 506                     spi_accessible_new_return (atk_get_root (), FALSE, NULL),
 507                     Accessibility_ROLE_UNKNOWN,
 508                     CORBA_string_dup (""));
 509       CORBA_exception_init (&ev);
 510       Accessibility_Registry_notifyEvent (BONOBO_OBJREF (controller->registry),
 511                                           &e,
 512                                           &ev);
 513       e.type = "mouse:rel";
 514       e.source = BONOBO_OBJREF (controller->registry->desktop);
 515       e.detail1 = *x - last_mouse_pos->x;
 516       e.detail2 = *y - last_mouse_pos->y;
 517       spi_init_any_nil (&e.any_data,
 518                     spi_accessible_new_return (atk_get_root (), FALSE, NULL),
 519                     Accessibility_ROLE_UNKNOWN,
 520                     CORBA_string_dup (""));
 521       CORBA_exception_init (&ev);
 522       last_mouse_pos->x = *x;
 523       last_mouse_pos->y = *y;
 524       Accessibility_Registry_notifyEvent (BONOBO_OBJREF (controller->registry),
 525                                           &e,
 526                                           &ev);
 527       *moved = True;
 528     }
 529   else
 530     {
 531       *moved = False;
 532     }
 533
 534   return mask_return;
 535 }
 536
 537 static void
 538 spi_dec_emit_modifier_event (SpiDEController *controller, guint prev_mask,
 539                              guint current_mask)
 540 {
 541   Accessibility_Event e;
 542   CORBA_Environment ev;
 543
 544 #ifdef SPI_XKB_DEBUG
 545   fprintf (stderr, "MODIFIER CHANGE EVENT! %x to %x\n",
 546            prev_mask, current_mask);
 547 #endif
 548
 549   /* set bits for the virtual modifiers like NUMLOCK */
 550   if (prev_mask & _numlock_physical_mask)
 551     prev_mask |= SPI_KEYMASK_NUMLOCK;
 552   if (current_mask & _numlock_physical_mask)
 553     current_mask |= SPI_KEYMASK_NUMLOCK;
 554
 555   e.type = "keyboard:modifiers";
 556   e.source = BONOBO_OBJREF (controller->registry->desktop);
 557   e.detail1 = prev_mask & key_modifier_mask;
 558   e.detail2 = current_mask & key_modifier_mask;
 559   spi_init_any_nil (&e.any_data,
 560                     spi_accessible_new_return (atk_get_root (), FALSE, NULL),
 561                     Accessibility_ROLE_UNKNOWN,
 562                     CORBA_string_dup (""));
 563   CORBA_exception_init (&ev);
 564   Accessibility_Registry_notifyEvent (BONOBO_OBJREF (controller->registry),
 565                                       &e,
 566                                       &ev);
 567 }
 568
 569 static gboolean
 570 spi_dec_poll_mouse_moved (gpointer data)
 571 {
 572   SpiRegistry *registry = SPI_REGISTRY (data);
 573   SpiDEController *controller = registry->de_controller;
 574   int x, y;
 575   gboolean moved;
 576   guint mask_return;
 577
 578   mask_return = spi_dec_mouse_check (controller, &x, &y, &moved);
 579
 580   if ((mask_return & key_modifier_mask) !=
 581       (mouse_mask_state & key_modifier_mask))
 582     {
 583       spi_dec_emit_modifier_event (controller, mouse_mask_state, mask_return);
 584       mouse_mask_state = mask_return;
 585     }
 586
 587   return moved;
 588 }
 589
 590 static gboolean
 591 spi_dec_poll_mouse_idle (gpointer data)
 592 {
 593   if (! spi_dec_poll_mouse_moved (data))
 594     return TRUE;
 595   else
 596     {
 597       g_timeout_add (20, spi_dec_poll_mouse_moving, data);
 598       return FALSE;
 599     }
 600 }
 601
 602 static gboolean
 603 spi_dec_poll_mouse_moving (gpointer data)
 604 {
 605   if (spi_dec_poll_mouse_moved (data))
 606     return TRUE;
 607   else
 608     {
 609       g_timeout_add (100, spi_dec_poll_mouse_idle, data);
 610       return FALSE;
 611     }
 612 }
 613
 614 #ifdef WE_NEED_UGRAB_MOUSE
 615 static int
 616 spi_dec_ungrab_mouse (gpointer data)
 617 {
 618         Display *display = spi_get_display ();
 619         if (display)
 620           {
 621             XUngrabButton (spi_get_display (), AnyButton, AnyModifier,
 622                            XDefaultRootWindow (spi_get_display ()));
 623           }
 624         return FALSE;
 625 }
 626 #endif
 627
 628 static void
 629 spi_dec_init_mouse_listener (SpiRegistry *registry)
 630 {
 631 #ifdef GRAB_BUTTON
 632   Display *display = spi_get_display ();
 633 #endif
 634   g_timeout_add (100, spi_dec_poll_mouse_idle, registry);
 635
 636 #ifdef GRAB_BUTTON
 637   if (display)
 638     {
 639       if (XGrabButton (display, AnyButton, AnyModifier,
 640                        gdk_x11_get_default_root_xwindow (),
 641                        True, ButtonPressMask | ButtonReleaseMask,
 642                        GrabModeSync, GrabModeAsync, None, None) != Success) {
 643 #ifdef SPI_DEBUG
 644         fprintf (stderr, "WARNING: could not grab mouse buttons!\n");
 645 #endif
 646         ;
 647       }
 648       XSync (display, False);
 649 #ifdef SPI_DEBUG
 650       fprintf (stderr, "mouse buttons grabbed\n");
 651 #endif
 652     }
 653 #endif
 654 }
 655
 656 /**
 657  * Eventually we can use this to make the marshalling of mask types
 658  * more sane, but for now we just use this to detect
 659  * the use of 'virtual' masks such as numlock and convert them to
 660  * system-specific mask values (i.e. ModMask).
 661  *
 662  **/
 663 static Accessibility_ControllerEventMask
 664 spi_dec_translate_mask (Accessibility_ControllerEventMask mask)
 665 {
 666   Accessibility_ControllerEventMask tmp_mask;
 667   gboolean has_numlock;
 668
 669   has_numlock = (mask & SPI_KEYMASK_NUMLOCK);
 670   tmp_mask = mask;
 671   if (has_numlock)
 672     {
 673       tmp_mask = mask ^ SPI_KEYMASK_NUMLOCK;
 674       tmp_mask |= _numlock_physical_mask;
 675     }
 676
 677   return tmp_mask;
 678 }
 679
 680 static DEControllerKeyListener *
 681 spi_dec_key_listener_new (CORBA_Object                            l,
 682                           const Accessibility_KeySet             *keys,
 683                           const Accessibility_ControllerEventMask mask,
 684                           const Accessibility_EventTypeSeq    *typeseq,
 685                           const Accessibility_EventListenerMode  *mode,
 686                           CORBA_Environment                      *ev)
 687 {
 688   DEControllerKeyListener *key_listener = g_new0 (DEControllerKeyListener, 1);
 689   key_listener->listener.object = bonobo_object_dup_ref (l, ev);
 690   key_listener->listener.type = SPI_DEVICE_TYPE_KBD;
 691   key_listener->keys = ORBit_copy_value (keys, TC_Accessibility_KeySet);
 692   key_listener->mask = spi_dec_translate_mask (mask);
 693   key_listener->listener.typeseq = ORBit_copy_value (typeseq, TC_Accessibility_EventTypeSeq);
 694   if (mode)
 695     key_listener->mode = ORBit_copy_value (mode, TC_Accessibility_EventListenerMode);
 696   else
 697     key_listener->mode = NULL;
 698
 699 #ifdef SPI_DEBUG
 700   g_print ("new listener, with mask %x, is_global %d, keys %p (%d)\n",
 701            (unsigned int) key_listener->mask,
 702            (int) (mode ? mode->global : 0),
 703            (void *) key_listener->keys,
 704            (int) (key_listener->keys ? key_listener->keys->_length : 0));
 705 #endif
 706
 707   return key_listener;
 708 }
 709
 710 static DEControllerListener *
 711 spi_dec_listener_new (CORBA_Object                            l,
 712                       const Accessibility_EventTypeSeq    *typeseq,
 713                       CORBA_Environment                      *ev)
 714 {
 715   DEControllerListener *listener = g_new0 (DEControllerListener, 1);
 716   listener->object = bonobo_object_dup_ref (l, ev);
 717   listener->type = SPI_DEVICE_TYPE_MOUSE;
 718   listener->typeseq = ORBit_copy_value (typeseq, TC_Accessibility_EventTypeSeq);
 719   return listener;
 720 }
 721
 722 static DEControllerListener *
 723 spi_listener_clone (DEControllerListener *listener, CORBA_Environment *ev)
 724 {
 725   DEControllerListener *clone = g_new0 (DEControllerListener, 1);
 726   clone->object =
 727           CORBA_Object_duplicate (listener->object, ev);
 728   clone->type = listener->type;
 729   clone->typeseq = ORBit_copy_value (listener->typeseq, TC_Accessibility_EventTypeSeq);
 730   return clone;
 731 }
 732
 733 static DEControllerKeyListener *
 734 spi_key_listener_clone (DEControllerKeyListener *key_listener, CORBA_Environment *ev)
 735 {
 736   DEControllerKeyListener *clone = g_new0 (DEControllerKeyListener, 1);
 737   clone->listener.object =
 738           CORBA_Object_duplicate (key_listener->listener.object, ev);
 739   clone->listener.type = SPI_DEVICE_TYPE_KBD;
 740   clone->keys = ORBit_copy_value (key_listener->keys, TC_Accessibility_KeySet);
 741   clone->mask = key_listener->mask;
 742   clone->listener.typeseq = ORBit_copy_value (key_listener->listener.typeseq, TC_Accessibility_EventTypeSeq);
 743   if (key_listener->mode)
 744     clone->mode = ORBit_copy_value (key_listener->mode, TC_Accessibility_EventListenerMode);
 745   else
 746     clone->mode = NULL;
 747   return clone;
 748 }
 749
 750 static void
 751 spi_key_listener_data_free (DEControllerKeyListener *key_listener, CORBA_Environment *ev)
 752 {
 753   CORBA_free (key_listener->listener.typeseq);
 754   CORBA_free (key_listener->keys);
 755   g_free (key_listener);
 756 }
 757
 758 static void
 759 spi_key_listener_clone_free (DEControllerKeyListener *clone, CORBA_Environment *ev)
 760 {
 761   CORBA_Object_release (clone->listener.object, ev);
 762   spi_key_listener_data_free (clone, ev);
 763 }
 764
 765 static void
 766 spi_listener_clone_free (DEControllerListener *clone, CORBA_Environment *ev)
 767 {
 768   CORBA_Object_release (clone->object, ev);
 769   CORBA_free (clone->typeseq);
 770   g_free (clone);
 771 }
 772
 773 static void
 774 spi_dec_listener_free (DEControllerListener    *listener,
 775                        CORBA_Environment       *ev)
 776 {
 777   bonobo_object_release_unref (listener->object, ev);
 778   if (listener->type == SPI_DEVICE_TYPE_KBD)
 779     spi_key_listener_data_free ((DEControllerKeyListener *) listener, ev);
 780 }
 781
 782 static void
 783 _register_keygrab (SpiDEController      *controller,
 784                    DEControllerGrabMask *grab_mask)
 785 {
 786   GList *l;
 787
 788   l = g_list_find_custom (controller->keygrabs_list, grab_mask,
 789                           spi_grab_mask_compare_values);
 790   if (l)
 791     {
 792       DEControllerGrabMask *cur_mask = l->data;
 793
 794       cur_mask->ref_count++;
 795       if (cur_mask->pending_remove)
 796         {
 797           cur_mask->pending_remove = FALSE;
 798         }
 799     }
 800   else
 801     {
 802       controller->keygrabs_list =
 803         g_list_prepend (controller->keygrabs_list,
 804                         spi_grab_mask_clone (grab_mask));
 805     }
 806 }
 807
 808 static void
 809 _deregister_keygrab (SpiDEController      *controller,
 810                      DEControllerGrabMask *grab_mask)
 811 {
 812   GList *l;
 813
 814   l = g_list_find_custom (controller->keygrabs_list, grab_mask,
 815                           spi_grab_mask_compare_values);
 816
 817   if (l)
 818     {
 819       DEControllerGrabMask *cur_mask = l->data;
 820
 821       cur_mask->ref_count--;
 822       if (cur_mask->ref_count <= 0)
 823         {
 824           cur_mask->pending_remove = TRUE;
 825         }
 826     }
 827   else
 828     {
 829       DBG (1, g_warning ("De-registering non-existant grab"));
 830     }
 831 }
 832
 833 static void
 834 handle_keygrab (SpiDEController         *controller,
 835                 DEControllerKeyListener *key_listener,
 836                 void                   (*process_cb) (SpiDEController *controller,
 837                                                       DEControllerGrabMask *grab_mask))
 838 {
 839   DEControllerGrabMask grab_mask = { 0 };
 840
 841   grab_mask.mod_mask = key_listener->mask;
 842   if (key_listener->keys->_length == 0) /* special case means AnyKey/AllKeys */
 843     {
 844       grab_mask.key_val = AnyKey;
 845 #ifdef SPI_DEBUG
 846       fprintf (stderr, "AnyKey grab!");
 847 #endif
 848       process_cb (controller, &grab_mask);
 849     }
 850   else
 851     {
 852       int i;
 853
 854       for (i = 0; i < key_listener->keys->_length; ++i)
 855         {
 856           Accessibility_KeyDefinition keydef = key_listener->keys->_buffer[i];
 857           long int key_val = keydef.keysym;
 858           /* X Grabs require keycodes, not keysyms */
 859           if (keydef.keystring && keydef.keystring[0])
 860             {
 861               key_val = XStringToKeysym(keydef.keystring);
 862             }
 863           if (key_val > 0)
 864             {
 865               key_val = XKeysymToKeycode (spi_get_display (), (KeySym) key_val);
 866             }
 867           else
 868             {
 869               key_val = keydef.keycode;
 870             }
 871           grab_mask.key_val = key_val;
 872           process_cb (controller, &grab_mask);
 873         }
 874     }
 875 }
 876
 877 static gboolean
 878 spi_controller_register_global_keygrabs (SpiDEController         *controller,
 879                                          DEControllerKeyListener *key_listener)
 880 {
 881   handle_keygrab (controller, key_listener, _register_keygrab);
 882   if (controller->xevie_display == NULL)
 883     return spi_controller_update_key_grabs (controller, NULL);
 884   else
 885     return TRUE;
 886 }
 887
 888 static void
 889 spi_controller_deregister_global_keygrabs (SpiDEController         *controller,
 890                                            DEControllerKeyListener *key_listener)
 891 {
 892   handle_keygrab (controller, key_listener, _deregister_keygrab);
 893   if (controller->xevie_display == NULL)
 894     spi_controller_update_key_grabs (controller, NULL);
 895 }
 896
 897 static gboolean
 898 spi_controller_register_device_listener (SpiDEController      *controller,
 899                                          DEControllerListener *listener,
 900                                          CORBA_Environment    *ev)
 901 {
 902   DEControllerKeyListener *key_listener;
 903
 904   switch (listener->type) {
 905   case SPI_DEVICE_TYPE_KBD:
 906       key_listener = (DEControllerKeyListener *) listener;
 907
 908       controller->key_listeners = g_list_prepend (controller->key_listeners,
 909                                                   key_listener);
 910       if (key_listener->mode->global)
 911         {
 912           return spi_controller_register_global_keygrabs (controller, key_listener);
 913         }
 914       else
 915               return TRUE;
 916       break;
 917   case SPI_DEVICE_TYPE_MOUSE:
 918       controller->mouse_listeners = g_list_prepend (controller->mouse_listeners, listener);
 919       break;
 920   default:
 921       DBG (1, g_warning ("listener registration for unknown device type.\n"));
 922       break;
 923   }
 924   return FALSE;
 925 }
 926
 927 static gboolean
 928 spi_controller_notify_mouselisteners (SpiDEController                 *controller,
 929                                       const Accessibility_DeviceEvent *event,
 930                                       CORBA_Environment               *ev)
 931 {
 932   GList   *l;
 933   GSList  *notify = NULL, *l2;
 934   GList  **listeners = &controller->mouse_listeners;
 935   gboolean is_consumed;
 936 #ifdef SPI_KEYEVENT_DEBUG
 937   gboolean found = FALSE;
 938 #endif
 939   if (!listeners)
 940     {
 941       return FALSE;
 942     }
 943
 944   for (l = *listeners; l; l = l->next)
 945     {
 946        DEControllerListener *listener = l->data;
 947
 948        if (spi_eventtype_seq_contains_event (listener->typeseq, event))
 949          {
 950            Accessibility_DeviceEventListener ls = listener->object;
 951
 952            if (ls != CORBA_OBJECT_NIL)
 953              {
 954                /* we clone (don't dup) the listener, to avoid refcount inc. */
 955                notify = g_slist_prepend (notify,
 956                                          spi_listener_clone (listener, ev));
 957 #ifdef SPI_KEYEVENT_DEBUG
 958                found = TRUE;
 959 #endif
 960              }
 961          }
 962     }
 963
 964 #ifdef SPI_KEYEVENT_DEBUG
 965   if (!found)
 966     {
 967       g_print ("no match for event\n");
 968     }
 969 #endif
 970
 971   is_consumed = FALSE;
 972   for (l2 = notify; l2 && !is_consumed; l2 = l2->next)
 973     {
 974       DEControllerListener *listener = l2->data;
 975       Accessibility_DeviceEventListener ls = listener->object;
 976
 977       CORBA_exception_init (ev);
 978       is_consumed = Accessibility_DeviceEventListener_notifyEvent (ls, event, ev);
 979       if (BONOBO_EX (ev))
 980         {
 981           is_consumed = FALSE;
 982           DBG (2, g_warning ("error notifying listener, removing it\n"));
 983           spi_deregister_controller_device_listener (controller, listener,
 984                                                      ev);
 985           CORBA_exception_free (ev);
 986         }
 987
 988       spi_listener_clone_free ((DEControllerListener *) l2->data, ev);
 989     }
 990
 991   for (; l2; l2 = l2->next)
 992     {
 993       DEControllerListener *listener = l2->data;
 994       spi_listener_clone_free (listener, ev);
 995       /* clone doesn't have its own ref, so don't use spi_device_listener_free */
 996     }
 997
 998   g_slist_free (notify);
 999
1000 #ifdef SPI_DEBUG
1001   if (is_consumed) g_message ("consumed\n");
1002 #endif
1003   return is_consumed;
1004 }
1005
1006 static void
1007 spi_device_event_controller_forward_mouse_event (SpiDEController *controller,
1008                                                  XEvent *xevent)
1009 {
1010   Accessibility_Event e;
1011   Accessibility_DeviceEvent mouse_e;
1012   CORBA_Environment ev;
1013   gchar event_name[24];
1014   gboolean is_consumed = FALSE;
1015   gboolean xkb_mod_unlatch_occurred;
1016   XButtonEvent *xbutton_event = (XButtonEvent *) xevent;
1017
1018   int button = xbutton_event->button;
1019
1020   unsigned int mouse_button_state = xbutton_event->state;
1021
1022   switch (button)
1023     {
1024     case 1:
1025             mouse_button_state |= Button1Mask;
1026             break;
1027     case 2:
1028             mouse_button_state |= Button2Mask;
1029             break;
1030     case 3:
1031             mouse_button_state |= Button3Mask;
1032             break;
1033     case 4:
1034             mouse_button_state |= Button4Mask;
1035             break;
1036     case 5:
1037             mouse_button_state |= Button5Mask;
1038             break;
1039     }
1040
1041   last_mouse_pos->x = ((XButtonEvent *) xevent)->x_root;
1042   last_mouse_pos->y = ((XButtonEvent *) xevent)->y_root;
1043
1044 #ifdef SPI_DEBUG
1045   fprintf (stderr, "mouse button %d %s (%x)\n",
1046            xbutton_event->button,
1047            (xevent->type == ButtonPress) ? "Press" : "Release",
1048            mouse_button_state);
1049 #endif
1050   snprintf (event_name, 22, "mouse:button:%d%c", button,
1051             (xevent->type == ButtonPress) ? 'p' : 'r');
1052
1053   /* TODO: FIXME distinguish between physical and logical buttons */
1054   mouse_e.type      = (xevent->type == ButtonPress) ?
1055                       Accessibility_BUTTON_PRESSED_EVENT :
1056                       Accessibility_BUTTON_RELEASED_EVENT;
1057   mouse_e.id        = button;
1058   mouse_e.hw_code   = button;
1059   mouse_e.modifiers = (CORBA_unsigned_short) xbutton_event->state;
1060   mouse_e.timestamp = (CORBA_unsigned_long) xbutton_event->time;
1061   mouse_e.event_string = "";
1062   mouse_e.is_text   = CORBA_FALSE;
1063   if ((mouse_button_state & mouse_button_mask) !=
1064        (mouse_mask_state & mouse_button_mask))
1065     {
1066       if ((mouse_mask_state & key_modifier_mask) !=
1067           (mouse_button_state & key_modifier_mask))
1068         spi_dec_emit_modifier_event (controller,
1069                                      mouse_mask_state, mouse_button_state);
1070       mouse_mask_state = mouse_button_state;
1071       is_consumed =
1072         spi_controller_notify_mouselisteners (controller, &mouse_e, &ev);
1073       e.type = CORBA_string_dup (event_name);
1074       e.source = BONOBO_OBJREF (controller->registry->desktop);
1075       e.detail1 = last_mouse_pos->x;
1076       e.detail2 = last_mouse_pos->y;
1077       spi_init_any_nil (&e.any_data,
1078                     spi_accessible_new_return (atk_get_root (), FALSE, NULL),
1079                     Accessibility_ROLE_UNKNOWN,
1080                     CORBA_string_dup (""));
1081       CORBA_exception_init (&ev);
1082
1083       Accessibility_Registry_notifyEvent (BONOBO_OBJREF (controller->registry),
1084                                           &e,
1085                                           &ev);
1086     }
1087
1088   xkb_mod_unlatch_occurred = (xevent->type == ButtonPress ||
1089                               xevent->type == ButtonRelease);
1090
1091   /* if client wants to consume this event, and XKB latch state was
1092    *   unset by this button event, we reset it
1093    */
1094   if (is_consumed && xkb_mod_unlatch_occurred)
1095     spi_dec_set_unlatch_pending (controller, mouse_mask_state);
1096
1097   XAllowEvents (spi_get_display (),
1098                 (is_consumed) ? SyncPointer : ReplayPointer,
1099                 CurrentTime);
1100 }
1101
1102 static GdkFilterReturn
1103 global_filter_fn (GdkXEvent *gdk_xevent, GdkEvent *event, gpointer data)
1104 {
1105   XEvent *xevent = gdk_xevent;
1106   SpiDEController *controller;
1107   DEControllerPrivateData *priv;
1108   Display *display = spi_get_display ();
1109   controller = SPI_DEVICE_EVENT_CONTROLLER (data);
1110   priv = (DEControllerPrivateData *)
1111           g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
1112
1113   if (xevent->type == KeyPress || xevent->type == KeyRelease)
1114     {
1115       if (controller->xevie_display == NULL)
1116         {
1117           gboolean is_consumed;
1118
1119           is_consumed =
1120             spi_device_event_controller_forward_key_event (controller, xevent);
1121
1122           if (is_consumed)
1123             {
1124               int n_events;
1125               int i;
1126               XEvent next_event;
1127               n_events = XPending (display);
1128
1129 #ifdef SPI_KEYEVENT_DEBUG
1130               g_print ("Number of events pending: %d\n", n_events);
1131 #endif
1132               for (i = 0; i < n_events; i++)
1133                 {
1134                   XNextEvent (display, &next_event);
1135                   if (next_event.type != KeyPress &&
1136                       next_event.type != KeyRelease)
1137                         g_warning ("Unexpected event type %d in queue", next_event.type);
1138                  }
1139
1140               XAllowEvents (display, AsyncKeyboard, CurrentTime);
1141               if (n_events)
1142                 XUngrabKeyboard (display, CurrentTime);
1143             }
1144           else
1145             {
1146               if (xevent->type == KeyPress)
1147                 wait_for_release_event (xevent, controller);
1148               XAllowEvents (display, ReplayKeyboard, CurrentTime);
1149             }
1150         }
1151
1152       return GDK_FILTER_CONTINUE;
1153     }
1154   if (xevent->type == ButtonPress || xevent->type == ButtonRelease)
1155     {
1156       spi_device_event_controller_forward_mouse_event (controller, xevent);
1157     }
1158   if (xevent->type == priv->xkb_base_event_code)
1159     {
1160       XkbAnyEvent * xkb_ev = (XkbAnyEvent *) xevent;
1161       /* ugly but probably necessary...*/
1162       XSynchronize (display, TRUE);
1163
1164       if (xkb_ev->xkb_type == XkbStateNotify)
1165         {
1166           XkbStateNotifyEvent *xkb_snev =
1167                   (XkbStateNotifyEvent *) xkb_ev;
1168           /* check the mouse, to catch mouse events grabbed by
1169            * another client; in case we should revert this XKB delatch
1170            */
1171           if (!priv->pending_xkb_mod_relatch_mask)
1172             {
1173               int x, y;
1174               gboolean moved;
1175               spi_dec_mouse_check (controller, &x, &y, &moved);
1176             }
1177           /* we check again, since the previous call may have
1178              changed this flag */
1179           if (priv->pending_xkb_mod_relatch_mask)
1180             {
1181               unsigned int feedback_mask;
1182 #ifdef SPI_XKB_DEBUG
1183               fprintf (stderr, "relatching %x\n",
1184                        priv->pending_xkb_mod_relatch_mask);
1185 #endif
1186               /* temporarily turn off the latch bell, if it's on */
1187               XkbGetControls (display,
1188                               XkbAccessXFeedbackMask,
1189                               priv->xkb_desc);
1190               feedback_mask = priv->xkb_desc->ctrls->ax_options;
1191               if (feedback_mask & XkbAX_StickyKeysFBMask)
1192               {
1193                 XkbControlsChangesRec changes = {XkbAccessXFeedbackMask,
1194                                                  0, False};
1195                 priv->xkb_desc->ctrls->ax_options
1196                               &= ~(XkbAX_StickyKeysFBMask);
1197                 XkbChangeControls (display, priv->xkb_desc, &changes);
1198               }
1199               /* TODO: account for lock as well as latch */
1200               XkbLatchModifiers (display,
1201                                  XkbUseCoreKbd,
1202                                  priv->pending_xkb_mod_relatch_mask,
1203                                  priv->pending_xkb_mod_relatch_mask);
1204               if (feedback_mask & XkbAX_StickyKeysFBMask)
1205               {
1206                 XkbControlsChangesRec changes = {XkbAccessXFeedbackMask,
1207                                                  0, False};
1208                 priv->xkb_desc->ctrls->ax_options = feedback_mask;
1209                 XkbChangeControls (display, priv->xkb_desc, &changes);
1210               }
1211 #ifdef SPI_XKB_DEBUG
1212               fprintf (stderr, "relatched %x\n",
1213                        priv->pending_xkb_mod_relatch_mask);
1214 #endif
1215               priv->pending_xkb_mod_relatch_mask = 0;
1216             }
1217           else
1218             {
1219               priv->xkb_latch_mask = xkb_snev->latched_mods;
1220             }
1221         }
1222         else
1223                DBG (2, g_warning ("XKB event %d\n", xkb_ev->xkb_type));
1224       XSynchronize (display, FALSE);
1225     }
1226
1227   return GDK_FILTER_CONTINUE;
1228 }
1229
1230 int
1231 _spi_controller_device_error_handler (Display *display, XErrorEvent *error)
1232 {
1233   if (error->error_code == BadAccess)
1234     {
1235       g_message ("Could not complete key grab: grab already in use.\n");
1236       spi_error_code = BadAccess;
1237       return 0;
1238     }
1239   else
1240     {
1241       return (*x_default_error_handler) (display, error);
1242     }
1243 }
1244
1245 static void
1246 spi_controller_register_with_devices (SpiDEController *controller)
1247 {
1248   DEControllerPrivateData *priv = (DEControllerPrivateData *)
1249           g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
1250   /* FIXME: should check for extension first! */
1251   XTestGrabControl (spi_get_display (), True);
1252
1253   /* calls to device-specific implementations and routines go here */
1254   /* register with: keyboard hardware code handler */
1255   /* register with: (translated) keystroke handler */
1256
1257   priv->have_xkb = XkbQueryExtension (spi_get_display (),
1258                                       &priv->xkb_major_extension_opcode,
1259                                       &priv->xkb_base_event_code,
1260                                       &priv->xkb_base_error_code, NULL, NULL);
1261   if (priv->have_xkb)
1262     {
1263       gint i;
1264       guint64 reserved = 0;
1265       priv->xkb_desc = XkbGetMap (spi_get_display (), XkbKeySymsMask, XkbUseCoreKbd);
1266       XkbSelectEvents (spi_get_display (),
1267                        XkbUseCoreKbd,
1268                        XkbStateNotifyMask, XkbStateNotifyMask);
1269       _numlock_physical_mask = XkbKeysymToModifiers (spi_get_display (),
1270                                                      XK_Num_Lock);
1271       for (i = priv->xkb_desc->max_key_code; i >= priv->xkb_desc->min_key_code; --i)
1272       {
1273           if (priv->xkb_desc->map->key_sym_map[i].kt_index[0] == XkbOneLevelIndex)
1274           {
1275               if (XKeycodeToKeysym (spi_get_display (), i, 0) != 0)
1276               {
1277                   /* don't use this one if there's a grab client! */
1278                   gdk_error_trap_push ();
1279                   XGrabKey (spi_get_display (), i, 0,
1280                             gdk_x11_get_default_root_xwindow (),
1281                             TRUE,
1282                             GrabModeSync, GrabModeSync);
1283                   XSync (spi_get_display (), TRUE);
1284                   XUngrabKey (spi_get_display (), i, 0,
1285                               gdk_x11_get_default_root_xwindow ());
1286                   if (!gdk_error_trap_pop ())
1287                   {
1288                       reserved = i;
1289                       break;
1290                   }
1291               }
1292           }
1293       }
1294       if (reserved)
1295       {
1296           priv->reserved_keycode = reserved;
1297           priv->reserved_keysym = XKeycodeToKeysym (spi_get_display (), reserved, 0);
1298       }
1299       else
1300       {
1301           priv->reserved_keycode = XKeysymToKeycode (spi_get_display (), XK_numbersign);
1302           priv->reserved_keysym = XK_numbersign;
1303       }
1304 #ifdef SPI_RESERVED_DEBUG
1305       unsigned sym = 0;
1306       sym = XKeycodeToKeysym (spi_get_display (), reserved, 0);
1307       fprintf (stderr, "%x\n", sym);
1308       fprintf (stderr, "setting the reserved keycode to %d (%s)\n",
1309                reserved,
1310                XKeysymToString (XKeycodeToKeysym (spi_get_display (),
1311                                                             reserved, 0)));
1312 #endif
1313     }
1314
1315   gdk_window_add_filter (NULL, global_filter_fn, controller);
1316
1317   gdk_window_set_events (gdk_get_default_root_window (),
1318                          GDK_KEY_PRESS_MASK | GDK_KEY_RELEASE_MASK);
1319
1320   x_default_error_handler = XSetErrorHandler (_spi_controller_device_error_handler);
1321 }
1322
1323 static gboolean
1324 spi_key_set_contains_key (Accessibility_KeySet            *key_set,
1325                           const Accessibility_DeviceEvent *key_event)
1326 {
1327   gint i;
1328   gint len;
1329
1330   if (!key_set)
1331     {
1332       g_print ("null key set!");
1333       return TRUE;
1334     }
1335
1336   len = key_set->_length;
1337
1338   if (len == 0) /* special case, means "all keys/any key" */
1339     {
1340       g_print ("anykey\n");
1341       return TRUE;
1342     }
1343
1344   for (i = 0; i < len; ++i)
1345     {
1346 #ifdef SPI_KEYEVENT_DEBUG
1347       g_print ("key_set[%d] event = %d, code = %d; key_event %d, code %d, string %s\n",
1348                 i,
1349                 (int)key_set->_buffer[i].keysym,
1350                 (int) key_set->_buffer[i].keycode,
1351                 (int) key_event->id,
1352                 (int) key_event->hw_code,
1353                 key_event->event_string);
1354 #endif
1355       if (key_set->_buffer[i].keysym == (CORBA_long) key_event->id)
1356         {
1357           return TRUE;
1358         }
1359       if (key_set->_buffer[i].keycode == (CORBA_long) key_event->hw_code)
1360         {
1361           return TRUE;
1362         }
1363       if (key_event->event_string && key_event->event_string[0] &&
1364           !strcmp (key_set->_buffer[i].keystring, key_event->event_string))
1365         {
1366           return TRUE;
1367         }
1368     }
1369
1370   return FALSE;
1371 }
1372
1373 static gboolean
1374 spi_eventtype_seq_contains_event (Accessibility_EventTypeSeq      *type_seq,
1375                                   const Accessibility_DeviceEvent *event)
1376 {
1377   gint i;
1378   gint len;
1379
1380
1381   if (!type_seq)
1382     {
1383       g_print ("null type seq!");
1384       return TRUE;
1385     }
1386
1387   len = type_seq->_length;
1388
1389   if (len == 0) /* special case, means "all events/any event" */
1390     {
1391       return TRUE;
1392     }
1393
1394   for (i = 0; i < len; ++i)
1395     {
1396 #ifdef SPI_DEBUG
1397       g_print ("type_seq[%d] = %d; event type = %d\n", i,
1398                (int) type_seq->_buffer[i], (int) event->type);
1399 #endif
1400       if (type_seq->_buffer[i] == (CORBA_long) event->type)
1401         {
1402           return TRUE;
1403         }
1404     }
1405
1406   return FALSE;
1407 }
1408
1409 static gboolean
1410 spi_key_event_matches_listener (const Accessibility_DeviceEvent *key_event,
1411                                 DEControllerKeyListener         *listener,
1412                                 CORBA_boolean                    is_system_global)
1413 {
1414   if ((key_event->modifiers == (CORBA_unsigned_short) (listener->mask & 0xFF)) &&
1415        spi_key_set_contains_key (listener->keys, key_event) &&
1416        spi_eventtype_seq_contains_event (listener->listener.typeseq, key_event) &&
1417       (is_system_global == listener->mode->global))
1418     {
1419       return TRUE;
1420     }
1421   else
1422     {
1423       return FALSE;
1424     }
1425 }
1426
1427 static gboolean
1428 spi_controller_notify_keylisteners (SpiDEController                 *controller,
1429                                     const Accessibility_DeviceEvent *key_event,
1430                                     CORBA_boolean                    is_system_global,
1431                                     CORBA_Environment               *ev)
1432 {
1433   GList   *l;
1434   GSList  *notify = NULL, *l2;
1435   GList  **key_listeners = &controller->key_listeners;
1436   gboolean is_consumed;
1437
1438   if (!key_listeners)
1439     {
1440       return FALSE;
1441     }
1442
1443   for (l = *key_listeners; l; l = l->next)
1444     {
1445        DEControllerKeyListener *key_listener = l->data;
1446
1447        if (spi_key_event_matches_listener (key_event, key_listener, is_system_global))
1448          {
1449            Accessibility_DeviceEventListener ls = key_listener->listener.object;
1450
1451            if (ls != CORBA_OBJECT_NIL)
1452              {
1453                /* we clone (don't dup) the listener, to avoid refcount inc. */
1454                notify = g_slist_prepend (notify,
1455                                          spi_key_listener_clone (key_listener, ev));
1456              }
1457          }
1458     }
1459
1460 #ifdef SPI_KEYEVENT_DEBUG
1461   if (!notify)
1462     {
1463       g_print ("no match for event\n");
1464     }
1465 #endif
1466
1467   is_consumed = FALSE;
1468   for (l2 = notify; l2 && !is_consumed; l2 = l2->next)
1469     {
1470       DEControllerKeyListener *key_listener = l2->data;
1471       Accessibility_DeviceEventListener ls = key_listener->listener.object;
1472
1473       is_consumed = Accessibility_DeviceEventListener_notifyEvent (ls, key_event, ev) &&
1474                     key_listener->mode->preemptive;
1475
1476       if (BONOBO_EX (ev))
1477         {
1478           is_consumed = FALSE;
1479           spi_deregister_controller_key_listener (controller, key_listener,
1480                                                   ev);
1481           CORBA_exception_free (ev);
1482         }
1483
1484       spi_key_listener_clone_free (key_listener, ev);
1485     }
1486
1487   for (; l2; l2 = l2->next)
1488     {
1489       DEControllerKeyListener *key_listener = l2->data;
1490       spi_key_listener_clone_free (key_listener, ev);
1491       /* clone doesn't have its own ref, so don't use spi_dec_listener_free */
1492     }
1493
1494   g_slist_free (notify);
1495
1496 #ifdef SPI_DEBUG
1497   if (is_consumed) g_message ("consumed\n");
1498 #endif
1499   return is_consumed;
1500 }
1501
1502 static gboolean
1503 spi_clear_error_state (void)
1504 {
1505         gboolean retval = spi_error_code != 0;
1506         spi_error_code = 0;
1507         return retval;
1508 }
1509
1510 static Accessibility_DeviceEvent
1511 spi_keystroke_from_x_key_event (XKeyEvent *x_key_event)
1512 {
1513   Accessibility_DeviceEvent key_event;
1514   KeySym keysym;
1515   const int cbuf_bytes = 20;
1516   char cbuf [21];
1517   int nbytes;
1518
1519   nbytes = XLookupString (x_key_event, cbuf, cbuf_bytes, &keysym, NULL);
1520   key_event.id = (CORBA_long)(keysym);
1521   key_event.hw_code = (CORBA_short) x_key_event->keycode;
1522   if (((XEvent *) x_key_event)->type == KeyPress)
1523     {
1524       key_event.type = Accessibility_KEY_PRESSED_EVENT;
1525     }
1526   else
1527     {
1528       key_event.type = Accessibility_KEY_RELEASED_EVENT;
1529     }
1530   key_event.modifiers = (CORBA_unsigned_short)(x_key_event->state);
1531   key_event.is_text = CORBA_FALSE;
1532   switch (keysym)
1533     {
1534       case ' ':
1535         key_event.event_string = CORBA_string_dup ("space");
1536         break;
1537       case XK_Tab:
1538         key_event.event_string = CORBA_string_dup ("Tab");
1539         break;
1540       case XK_BackSpace:
1541         key_event.event_string = CORBA_string_dup ("Backspace");
1542         break;
1543       case XK_Return:
1544         key_event.event_string = CORBA_string_dup ("Return");
1545         break;
1546       case XK_Home:
1547         key_event.event_string = CORBA_string_dup ("Home");
1548         break;
1549       case XK_Page_Down:
1550         key_event.event_string = CORBA_string_dup ("Page_Down");
1551         break;
1552       case XK_Page_Up:
1553         key_event.event_string = CORBA_string_dup ("Page_Up");
1554         break;
1555       case XK_F1:
1556         key_event.event_string = CORBA_string_dup ("F1");
1557         break;
1558       case XK_F2:
1559         key_event.event_string = CORBA_string_dup ("F2");
1560         break;
1561       case XK_F3:
1562         key_event.event_string = CORBA_string_dup ("F3");
1563         break;
1564       case XK_F4:
1565         key_event.event_string = CORBA_string_dup ("F4");
1566         break;
1567       case XK_F5:
1568         key_event.event_string = CORBA_string_dup ("F5");
1569         break;
1570       case XK_F6:
1571         key_event.event_string = CORBA_string_dup ("F6");
1572         break;
1573       case XK_F7:
1574         key_event.event_string = CORBA_string_dup ("F7");
1575         break;
1576       case XK_F8:
1577         key_event.event_string = CORBA_string_dup ("F8");
1578         break;
1579       case XK_F9:
1580         key_event.event_string = CORBA_string_dup ("F9");
1581         break;
1582       case XK_F10:
1583         key_event.event_string = CORBA_string_dup ("F10");
1584         break;
1585       case XK_F11:
1586         key_event.event_string = CORBA_string_dup ("F11");
1587         break;
1588       case XK_F12:
1589         key_event.event_string = CORBA_string_dup ("F12");
1590         break;
1591       case XK_End:
1592         key_event.event_string = CORBA_string_dup ("End");
1593         break;
1594       case XK_Escape:
1595         key_event.event_string = CORBA_string_dup ("Escape");
1596         break;
1597       case XK_Up:
1598         key_event.event_string = CORBA_string_dup ("Up");
1599         break;
1600       case XK_Down:
1601         key_event.event_string = CORBA_string_dup ("Down");
1602         break;
1603       case XK_Left:
1604         key_event.event_string = CORBA_string_dup ("Left");
1605         break;
1606       case XK_Right:
1607         key_event.event_string = CORBA_string_dup ("Right");
1608         break;
1609       default:
1610         if (nbytes > 0)
1611           {
1612             gunichar c;
1613             cbuf[nbytes] = '\0'; /* OK since length is cbuf_bytes+1 */
1614             key_event.event_string = CORBA_string_dup (cbuf);
1615             c = keysym2ucs (keysym);
1616             if (c > 0 && !g_unichar_iscntrl (c))
1617               {
1618                 key_event.is_text = CORBA_TRUE;
1619                 /* incorrect for some composed chars? */
1620               }
1621           }
1622         else
1623           {
1624             key_event.event_string = CORBA_string_dup ("");
1625           }
1626     }
1627
1628   key_event.timestamp = (CORBA_unsigned_long) x_key_event->time;
1629 #ifdef SPI_KEYEVENT_DEBUG
1630   {
1631     char *pressed_str  = "pressed";
1632     char *released_str = "released";
1633     char *state_ptr;
1634
1635     if (key_event.type == Accessibility_KEY_PRESSED_EVENT)
1636       state_ptr = pressed_str;
1637     else
1638       state_ptr = released_str;
1639
1640     fprintf (stderr,
1641              "Key %lu %s (%c), modifiers %d; string=%s [%x] %s\n",
1642              (unsigned long) keysym,
1643              state_ptr,
1644              keysym ? (int) keysym : '*',
1645              (int) x_key_event->state,
1646              key_event.event_string,
1647              key_event.event_string[0],
1648              (key_event.is_text == CORBA_TRUE) ? "(text)" : "(not text)");
1649   }
1650 #endif
1651 #ifdef SPI_DEBUG
1652   fprintf (stderr, "%s%c\n",
1653      (x_key_event->state & Mod1Mask)?"Alt-":"",
1654      ((x_key_event->state & ShiftMask)^(x_key_event->state & LockMask))?
1655      g_ascii_toupper (keysym) : g_ascii_tolower (keysym));
1656   fprintf (stderr, "serial: %x Time: %x\n", x_key_event->serial, x_key_event->time);
1657 #endif /* SPI_DEBUG */
1658   return key_event;
1659 }
1660
1661 static gboolean
1662 spi_controller_update_key_grabs (SpiDEController           *controller,
1663                                  Accessibility_DeviceEvent *recv)
1664 {
1665   GList *l, *next;
1666   gboolean   update_failed = FALSE;
1667   KeyCode keycode;
1668
1669   g_return_val_if_fail (controller != NULL, FALSE);
1670
1671   /*
1672    * masks known to work with default RH 7.1+:
1673    * 0 (no mods), LockMask, Mod1Mask, Mod2Mask, ShiftMask,
1674    * ShiftMask|LockMask, Mod1Mask|LockMask, Mod2Mask|LockMask,
1675    * ShiftMask|Mod1Mask, ShiftMask|Mod2Mask, Mod1Mask|Mod2Mask,
1676    * ShiftMask|LockMask|Mod1Mask, ShiftMask|LockMask|Mod2Mask,
1677    *
1678    * ControlMask grabs are broken, must be in use already
1679    */
1680   if (recv)
1681     keycode = keycode_for_keysym (controller, recv->id, NULL);
1682   for (l = controller->keygrabs_list; l; l = next)
1683     {
1684       gboolean do_remove;
1685       gboolean re_issue_grab;
1686       DEControllerGrabMask *grab_mask = l->data;
1687
1688       next = l->next;
1689
1690       re_issue_grab = recv &&
1691               (recv->modifiers & grab_mask->mod_mask) &&
1692               (grab_mask->key_val == keycode);
1693
1694 #ifdef SPI_DEBUG
1695       fprintf (stderr, "mask=%lx %lx (%c%c) %s\n",
1696                (long int) grab_mask->key_val,
1697                (long int) grab_mask->mod_mask,
1698                grab_mask->pending_add ? '+' : '.',
1699                grab_mask->pending_remove ? '-' : '.',
1700                re_issue_grab ? "re-issue": "");
1701 #endif
1702
1703       do_remove = FALSE;
1704
1705       if (grab_mask->pending_add && grab_mask->pending_remove)
1706         {
1707           do_remove = TRUE;
1708         }
1709       else if (grab_mask->pending_remove)
1710         {
1711 #ifdef SPI_DEBUG
1712       fprintf (stderr, "ungrabbing, mask=%x\n", grab_mask->mod_mask);
1713 #endif
1714           XUngrabKey (spi_get_display (),
1715                       grab_mask->key_val,
1716                       grab_mask->mod_mask,
1717                       gdk_x11_get_default_root_xwindow ());
1718
1719           do_remove = TRUE;
1720         }
1721       else if (grab_mask->pending_add || re_issue_grab)
1722         {
1723
1724 #ifdef SPI_DEBUG
1725           fprintf (stderr, "grab %d with mask %x\n", grab_mask->key_val, grab_mask->mod_mask);
1726 #endif
1727           XGrabKey (spi_get_display (),
1728                     grab_mask->key_val,
1729                     grab_mask->mod_mask,
1730                     gdk_x11_get_default_root_xwindow (),
1731                     True,
1732                     GrabModeSync,
1733                     GrabModeSync);
1734           XSync (spi_get_display (), False);
1735           update_failed = spi_clear_error_state ();
1736           if (update_failed) {
1737                   while (grab_mask->ref_count > 0) --grab_mask->ref_count;
1738                   do_remove = TRUE;
1739           }
1740         }
1741
1742       grab_mask->pending_add = FALSE;
1743       grab_mask->pending_remove = FALSE;
1744
1745       if (do_remove)
1746         {
1747           g_assert (grab_mask->ref_count <= 0);
1748
1749           controller->keygrabs_list = g_list_delete_link (
1750             controller->keygrabs_list, l);
1751
1752           spi_grab_mask_free (grab_mask);
1753         }
1754
1755     }
1756
1757   return ! update_failed;
1758 }
1759
1760 /*
1761  * Implemented GObject::finalize
1762  */
1763 static void
1764 spi_device_event_controller_object_finalize (GObject *object)
1765 {
1766   SpiDEController *controller;
1767   DEControllerPrivateData *private;
1768   controller = SPI_DEVICE_EVENT_CONTROLLER (object);
1769
1770 #ifdef SPI_DEBUG
1771   fprintf(stderr, "spi_device_event_controller_object_finalize called\n");
1772 #endif
1773   /* disconnect any special listeners, get rid of outstanding keygrabs */
1774   XUngrabKey (spi_get_display (), AnyKey, AnyModifier, DefaultRootWindow (spi_get_display ()));
1775
1776 #ifdef HAVE_XEVIE
1777   if (controller->xevie_display != NULL)
1778     {
1779       XevieEnd(controller->xevie_display);
1780 #ifdef SPI_KEYEVENT_DEBUG
1781       printf("XevieEnd(dpy) finished \n");
1782 #endif
1783     }
1784 #endif
1785
1786   private = g_object_get_data (G_OBJECT (controller), "spi-dec-private");
1787   if (private->xkb_desc)
1788           XkbFreeKeyboard (private->xkb_desc, 0, True);
1789   g_free (private);
1790   spi_device_event_controller_parent_class->finalize (object);
1791 }
1792
1793 /*
1794  * CORBA Accessibility::DEController::registerKeystrokeListener
1795  *     method implementation
1796  */
1797 static CORBA_boolean
1798 impl_register_keystroke_listener (PortableServer_Servant                  servant,
1799                                   const Accessibility_DeviceEventListener l,
1800                                   const Accessibility_KeySet             *keys,
1801                                   const Accessibility_ControllerEventMask mask,
1802                                   const Accessibility_EventTypeSeq       *type,
1803                                   const Accessibility_EventListenerMode  *mode,
1804                                   CORBA_Environment                      *ev)
1805 {
1806   SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER (
1807           bonobo_object_from_servant (servant));
1808   DEControllerKeyListener *dec_listener;
1809 #ifdef SPI_DEBUG
1810   fprintf (stderr, "registering keystroke listener %p with maskVal %lu\n",
1811            (void *) l, (unsigned long) mask);
1812 #endif
1813   dec_listener = spi_dec_key_listener_new (l, keys, mask, type, mode, ev);
1814   return spi_controller_register_device_listener (
1815           controller, (DEControllerListener *) dec_listener, ev);
1816 }
1817
1818
1819 /*
1820  * CORBA Accessibility::DEController::registerDeviceEventListener
1821  *     method implementation
1822  */
1823 static CORBA_boolean
1824 impl_register_device_listener (PortableServer_Servant                  servant,
1825                                const Accessibility_DeviceEventListener l,
1826                                const Accessibility_EventTypeSeq       *event_types,
1827                                CORBA_Environment                      *ev)
1828 {
1829   SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER (
1830           bonobo_object_from_servant (servant));
1831   DEControllerListener *dec_listener;
1832
1833   dec_listener = spi_dec_listener_new (l, event_types, ev);
1834   return spi_controller_register_device_listener (
1835           controller, (DEControllerListener *) dec_listener, ev);
1836 }
1837
1838 typedef struct {
1839         CORBA_Environment       *ev;
1840         DEControllerListener    *listener;
1841 } RemoveListenerClosure;
1842
1843 static SpiReEntrantContinue
1844 remove_listener_cb (GList * const *list,
1845                     gpointer       user_data)
1846 {
1847   DEControllerListener  *listener = (*list)->data;
1848   RemoveListenerClosure *ctx = user_data;
1849
1850   if (CORBA_Object_is_equivalent (ctx->listener->object,
1851                                   listener->object, ctx->ev))
1852     {
1853       spi_re_entrant_list_delete_link (list);
1854       spi_dec_listener_free (listener, ctx->ev);
1855     }
1856
1857   return SPI_RE_ENTRANT_CONTINUE;
1858 }
1859
1860 static SpiReEntrantContinue
1861 copy_key_listener_cb (GList * const *list,
1862                       gpointer       user_data)
1863 {
1864   DEControllerKeyListener  *key_listener = (*list)->data;
1865   RemoveListenerClosure    *ctx = user_data;
1866
1867   if (CORBA_Object_is_equivalent (ctx->listener->object,
1868                                   key_listener->listener.object, ctx->ev))
1869     {
1870       /* TODO: FIXME aggregate keys in case the listener is registered twice */
1871       DEControllerKeyListener *ctx_key_listener =
1872         (DEControllerKeyListener *) ctx->listener;
1873       CORBA_free (ctx_key_listener->keys);
1874       ctx_key_listener->keys = ORBit_copy_value (key_listener->keys, TC_Accessibility_KeySet);
1875     }
1876
1877   return SPI_RE_ENTRANT_CONTINUE;
1878 }
1879
1880 static void
1881 spi_deregister_controller_device_listener (SpiDEController            *controller,
1882                                            DEControllerListener *listener,
1883                                            CORBA_Environment          *ev)
1884 {
1885   RemoveListenerClosure  ctx;
1886
1887   ctx.ev = ev;
1888   ctx.listener = listener;
1889
1890   spi_re_entrant_list_foreach (&controller->mouse_listeners,
1891                                remove_listener_cb, &ctx);
1892 }
1893
1894 static void
1895 spi_deregister_controller_key_listener (SpiDEController            *controller,
1896                                         DEControllerKeyListener    *key_listener,
1897                                         CORBA_Environment          *ev)
1898 {
1899   RemoveListenerClosure  ctx;
1900
1901   ctx.ev = ev;
1902   ctx.listener = (DEControllerListener *) key_listener;
1903
1904   /* special case, copy keyset from existing controller list entry */
1905   if (key_listener->keys->_length == 0)
1906     {
1907       spi_re_entrant_list_foreach (&controller->key_listeners,
1908                                   copy_key_listener_cb, &ctx);
1909     }
1910
1911   spi_controller_deregister_global_keygrabs (controller, key_listener);
1912
1913   spi_re_entrant_list_foreach (&controller->key_listeners,
1914                                 remove_listener_cb, &ctx);
1915
1916 }
1917
1918 /*
1919  * CORBA Accessibility::DEController::deregisterKeystrokeListener
1920  *     method implementation
1921  */
1922 static void
1923 impl_deregister_keystroke_listener (PortableServer_Servant                  servant,
1924                                     const Accessibility_DeviceEventListener l,
1925                                     const Accessibility_KeySet             *keys,
1926                                     const Accessibility_ControllerEventMask mask,
1927                                     const Accessibility_EventTypeSeq       *type,
1928                                     CORBA_Environment                      *ev)
1929 {
1930   DEControllerKeyListener  *key_listener;
1931   SpiDEController *controller;
1932
1933   controller = SPI_DEVICE_EVENT_CONTROLLER (bonobo_object (servant));
1934
1935   key_listener = spi_dec_key_listener_new (l, keys, mask, type, NULL, ev);
1936
1937 #ifdef SPI_DEREGISTER_DEBUG
1938   fprintf (stderr, "deregistering keystroke listener %p with maskVal %lu\n",
1939            (void *) l, (unsigned long) mask->value);
1940 #endif
1941
1942   spi_deregister_controller_key_listener (controller, key_listener, ev);
1943
1944   spi_dec_listener_free ((DEControllerListener *) key_listener, ev);
1945 }
1946
1947 /*
1948  * CORBA Accessibility::DEController::deregisterDeviceEventListener
1949  *     method implementation
1950  */
1951 static void
1952 impl_deregister_device_listener (PortableServer_Servant                  servant,
1953                                  const Accessibility_DeviceEventListener l,
1954                                  const Accessibility_EventTypeSeq       *event_types,
1955                                  CORBA_Environment                      *ev)
1956 {
1957   SpiDEController *controller;
1958   DEControllerListener *listener =
1959           spi_dec_listener_new (l, event_types, ev);
1960
1961   controller = SPI_DEVICE_EVENT_CONTROLLER (bonobo_object (servant));
1962
1963   spi_deregister_controller_device_listener (controller, listener, ev);
1964
1965   spi_dec_listener_free (listener, ev);
1966 }
1967
1968 static unsigned int dec_xkb_get_slowkeys_delay (SpiDEController *controller)
1969 {
1970   unsigned int retval = 0;
1971   DEControllerPrivateData *priv = (DEControllerPrivateData *)
1972           g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
1973 #ifdef HAVE_XKB
1974 #ifdef XKB_HAS_GET_SLOW_KEYS_DELAY
1975   retval = XkbGetSlowKeysDelay (spi_get_display (),
1976                                 XkbUseCoreKbd, &bounce_delay);
1977 #else
1978   if (!(priv->xkb_desc == (XkbDescPtr) BadAlloc || priv->xkb_desc == NULL))
1979     {
1980       Status s = XkbGetControls (spi_get_display (),
1981                                  XkbAllControlsMask, priv->xkb_desc);
1982       if (s == Success)
1983         {
1984          if (priv->xkb_desc->ctrls->enabled_ctrls & XkbSlowKeysMask)
1985                  retval = priv->xkb_desc->ctrls->slow_keys_delay;
1986         }
1987     }
1988 #endif
1989 #endif
1990 #ifdef SPI_XKB_DEBUG
1991         fprintf (stderr, "SlowKeys delay: %d\n", (int) retval);
1992 #endif
1993         return retval;
1994 }
1995
1996 static unsigned int dec_xkb_get_bouncekeys_delay (SpiDEController *controller)
1997 {
1998   unsigned int retval = 0;
1999   DEControllerPrivateData *priv = (DEControllerPrivateData *)
2000           g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
2001 #ifdef HAVE_XKB
2002 #ifdef XKB_HAS_GET_BOUNCE_KEYS_DELAY
2003   retval = XkbGetBounceKeysDelay (spi_get_display (),
2004                                   XkbUseCoreKbd, &bounce_delay);
2005 #else
2006   if (!(priv->xkb_desc == (XkbDescPtr) BadAlloc || priv->xkb_desc == NULL))
2007     {
2008       Status s = XkbGetControls (spi_get_display (),
2009                                  XkbAllControlsMask, priv->xkb_desc);
2010       if (s == Success)
2011         {
2012           if (priv->xkb_desc->ctrls->enabled_ctrls & XkbBounceKeysMask)
2013                   retval = priv->xkb_desc->ctrls->debounce_delay;
2014         }
2015     }
2016 #endif
2017 #endif
2018 #ifdef SPI_XKB_DEBUG
2019   fprintf (stderr, "BounceKeys delay: %d\n", (int) retval);
2020 #endif
2021   return retval;
2022 }
2023
2024 static gboolean
2025 dec_synth_keycode_press (SpiDEController *controller,
2026                          unsigned int keycode)
2027 {
2028         unsigned int time = CurrentTime;
2029         unsigned int bounce_delay;
2030         unsigned int elapsed_msec;
2031         struct timeval tv;
2032         DEControllerPrivateData *priv =
2033                 (DEControllerPrivateData *) g_object_get_qdata (G_OBJECT (controller),
2034                                                                 spi_dec_private_quark);
2035         if (keycode == priv->last_release_keycode)
2036         {
2037                 bounce_delay = dec_xkb_get_bouncekeys_delay (controller);
2038                 if (bounce_delay)
2039                 {
2040                         gettimeofday (&tv, NULL);
2041                         elapsed_msec =
2042                                 (tv.tv_sec - priv->last_release_time.tv_sec) * 1000
2043                                 + (tv.tv_usec - priv->last_release_time.tv_usec) / 1000;
2044 #ifdef SPI_XKB_DEBUG
2045                         fprintf (stderr, "%d ms elapsed (%ld usec)\n", elapsed_msec,
2046                                  (long) (tv.tv_usec - priv->last_release_time.tv_usec));
2047 #endif
2048 #ifdef THIS_IS_BROKEN
2049                         if (elapsed_msec < bounce_delay)
2050                                 time = bounce_delay - elapsed_msec + 1;
2051 #else
2052                         time = bounce_delay + 10;
2053                         /* fudge for broken XTest */
2054 #endif
2055 #ifdef SPI_XKB_DEBUG
2056                         fprintf (stderr, "waiting %d ms\n", time);
2057 #endif
2058                 }
2059         }
2060         XTestFakeKeyEvent (spi_get_display (), keycode, True, time);
2061         priv->last_press_keycode = keycode;
2062         XFlush (spi_get_display ());
2063         XSync (spi_get_display (), False);
2064         gettimeofday (&priv->last_press_time, NULL);
2065         return TRUE;
2066 }
2067
2068 static gboolean
2069 dec_synth_keycode_release (SpiDEController *controller,
2070                            unsigned int keycode)
2071 {
2072         unsigned int time = CurrentTime;
2073         unsigned int slow_delay;
2074         unsigned int elapsed_msec;
2075         struct timeval tv;
2076         DEControllerPrivateData *priv =
2077                 (DEControllerPrivateData *) g_object_get_qdata (G_OBJECT (controller),
2078                                                                 spi_dec_private_quark);
2079         if (keycode == priv->last_press_keycode)
2080         {
2081                 slow_delay = dec_xkb_get_slowkeys_delay (controller);
2082                 if (slow_delay)
2083                 {
2084                         gettimeofday (&tv, NULL);
2085                         elapsed_msec =
2086                                 (tv.tv_sec - priv->last_press_time.tv_sec) * 1000
2087                                 + (tv.tv_usec - priv->last_press_time.tv_usec) / 1000;
2088 #ifdef SPI_XKB_DEBUG
2089                         fprintf (stderr, "%d ms elapsed (%ld usec)\n", elapsed_msec,
2090                                  (long) (tv.tv_usec - priv->last_press_time.tv_usec));
2091 #endif
2092 #ifdef THIS_IS_BROKEN_DUNNO_WHY
2093                         if (elapsed_msec < slow_delay)
2094                                 time = slow_delay - elapsed_msec + 1;
2095 #else
2096                         time = slow_delay + 10;
2097                         /* our XTest seems broken, we have to add slop as above */
2098 #endif
2099 #ifdef SPI_XKB_DEBUG
2100                         fprintf (stderr, "waiting %d ms\n", time);
2101 #endif
2102                 }
2103         }
2104         XTestFakeKeyEvent (spi_get_display (), keycode, False, time);
2105         priv->last_release_keycode = keycode;
2106         XSync (spi_get_display (), False);
2107         gettimeofday (&priv->last_release_time, NULL);
2108         return TRUE;
2109 }
2110
2111 static unsigned
2112 dec_get_modifier_state (SpiDEController *controller)
2113 {
2114         return mouse_mask_state;
2115 }
2116
2117 static gboolean
2118 dec_lock_modifiers (SpiDEController *controller, unsigned modifiers)
2119 {
2120         return XkbLockModifiers (spi_get_display (), XkbUseCoreKbd,
2121                           modifiers, modifiers);
2122 }
2123
2124 static gboolean
2125 dec_unlock_modifiers (SpiDEController *controller, unsigned modifiers)
2126 {
2127         return XkbLockModifiers (spi_get_display (), XkbUseCoreKbd,
2128                           modifiers, 0);
2129 }
2130
2131 static KeySym
2132 dec_keysym_for_unichar (SpiDEController *controller, gunichar unichar)
2133 {
2134         return ucs2keysym ((long) unichar);
2135 }
2136
2137 static gboolean
2138 dec_synth_keysym (SpiDEController *controller, KeySym keysym)
2139 {
2140         KeyCode key_synth_code;
2141         unsigned int modifiers, synth_mods, lock_mods;
2142
2143         key_synth_code = keycode_for_keysym (controller, keysym, &synth_mods);
2144
2145         if ((key_synth_code == 0) || (synth_mods == 0xFF)) return FALSE;
2146
2147         /* TODO: set the modifiers accordingly! */
2148         modifiers = dec_get_modifier_state (controller);
2149         /* side-effect; we may unset mousebutton modifiers here! */
2150
2151         lock_mods = 0;
2152         if (synth_mods != modifiers) {
2153                 lock_mods = synth_mods & ~modifiers;
2154                 dec_lock_modifiers (controller, lock_mods);
2155         }
2156         dec_synth_keycode_press (controller, key_synth_code);
2157         dec_synth_keycode_release (controller, key_synth_code);
2158
2159         if (synth_mods != modifiers)
2160                 dec_unlock_modifiers (controller, lock_mods);
2161         return TRUE;
2162 }
2163
2164
2165 static gboolean
2166 dec_synth_keystring (SpiDEController *controller, const CORBA_char *keystring)
2167 {
2168         /* probably we need to create and inject an XIM handler eventually. */
2169         /* for now, try to match the string to existing
2170          * keycode+modifier states.
2171          */
2172         KeySym *keysyms;
2173         gint maxlen = 0;
2174         gunichar unichar = 0;
2175         gint i = 0;
2176         gboolean retval = TRUE;
2177         const gchar *c;
2178
2179         maxlen = strlen (keystring);
2180         keysyms = g_new0 (KeySym, maxlen);
2181         if (!(keystring && *keystring && g_utf8_validate (keystring, -1, &c))) {
2182                 retval = FALSE;
2183         }
2184         else {
2185 #ifdef SPI_DEBUG
2186                 fprintf (stderr, "[keystring synthesis attempted on %s]\n", keystring);
2187 #endif
2188                 while (keystring && (unichar = g_utf8_get_char (keystring))) {
2189                         KeySym keysym;
2190                         char bytes[6];
2191                         gint mbytes;
2192
2193                         mbytes = g_unichar_to_utf8 (unichar, bytes);
2194                         bytes[mbytes] = '\0';
2195 #ifdef SPI_DEBUG
2196                         fprintf (stderr, "[unichar %s]", bytes);
2197 #endif
2198                         keysym = dec_keysym_for_unichar (controller, unichar);
2199                         if (keysym == NoSymbol) {
2200 #ifdef SPI_DEBUG
2201                                 fprintf (stderr, "no keysym for %s", bytes);
2202 #endif
2203                                 retval = FALSE;
2204                                 break;
2205                         }
2206                         keysyms[i++] = keysym;
2207                         keystring = g_utf8_next_char (keystring);
2208                 }
2209                 keysyms[i++] = 0;
2210                 XSynchronize (spi_get_display (), TRUE);
2211                 for (i = 0; keysyms[i]; ++i) {
2212                         if (!dec_synth_keysym (controller, keysyms[i])) {
2213 #ifdef SPI_DEBUG
2214                                 fprintf (stderr, "could not synthesize %c\n",
2215                                          (int) keysyms[i]);
2216 #endif
2217                                 retval = FALSE;
2218                                 break;
2219                         }
2220                 }
2221                 XSynchronize (spi_get_display (), FALSE);
2222         }
2223         g_free (keysyms);
2224
2225         return retval;
2226 }
2227
2228
2229 /*
2230  * CORBA Accessibility::DEController::registerKeystrokeListener
2231  *     method implementation
2232  */
2233 static void
2234 impl_generate_keyboard_event (PortableServer_Servant           servant,
2235                               const CORBA_long                 keycode,
2236                               const CORBA_char                *keystring,
2237                               const Accessibility_KeySynthType synth_type,
2238                               CORBA_Environment               *ev)
2239 {
2240   SpiDEController *controller =
2241         SPI_DEVICE_EVENT_CONTROLLER (bonobo_object (servant));
2242   gint err;
2243   KeySym keysym;
2244
2245 #ifdef SPI_DEBUG
2246         fprintf (stderr, "synthesizing keystroke %ld, type %d\n",
2247                  (long) keycode, (int) synth_type);
2248 #endif
2249   /* TODO: hide/wrap/remove X dependency */
2250
2251   /*
2252    * TODO: when initializing, query for XTest extension before using,
2253    * and fall back to XSendEvent() if XTest is not available.
2254    */
2255
2256   gdk_error_trap_push ();
2257
2258   switch (synth_type)
2259     {
2260       case Accessibility_KEY_PRESS:
2261               dec_synth_keycode_press (controller, keycode);
2262               break;
2263       case Accessibility_KEY_PRESSRELEASE:
2264               dec_synth_keycode_press (controller, keycode);
2265       case Accessibility_KEY_RELEASE:
2266               dec_synth_keycode_release (controller, keycode);
2267               break;
2268       case Accessibility_KEY_SYM:
2269 #ifdef SPI_XKB_DEBUG
2270               fprintf (stderr, "KeySym synthesis\n");
2271 #endif
2272               /*
2273                * note: we are using long for 'keycode'
2274                * in our arg list; it can contain either
2275                * a keycode or a keysym.
2276                */
2277               dec_synth_keysym (controller, (KeySym) keycode);
2278               break;
2279       case Accessibility_KEY_STRING:
2280               if (!dec_synth_keystring (controller, keystring))
2281                       fprintf (stderr, "Keystring synthesis failure, string=%s\n",
2282                                keystring);
2283               break;
2284     }
2285   if ((err = gdk_error_trap_pop ()))
2286     {
2287       DBG (-1, g_warning ("Error [%d] emitting keystroke", err));
2288     }
2289   if (synth_type == Accessibility_KEY_SYM) {
2290     keysym = keycode;
2291   }
2292   else {
2293     keysym = XkbKeycodeToKeysym (spi_get_display (), keycode, 0, 0);
2294   }
2295   if (XkbKeysymToModifiers (spi_get_display (), keysym) == 0)
2296     {
2297       spi_dec_clear_unlatch_pending (controller);
2298     }
2299 }
2300
2301 /* Accessibility::DEController::generateMouseEvent */
2302 static void
2303 impl_generate_mouse_event (PortableServer_Servant servant,
2304                            const CORBA_long       x,
2305                            const CORBA_long       y,
2306                            const CORBA_char      *eventName,
2307                            CORBA_Environment     *ev)
2308 {
2309   int button = 0;
2310   gboolean error = FALSE;
2311   Display *display = spi_get_display ();
2312 #ifdef SPI_DEBUG
2313   fprintf (stderr, "generating mouse %s event at %ld, %ld\n",
2314            eventName, (long int) x, (long int) y);
2315 #endif
2316   switch (eventName[0])
2317     {
2318       case 'b':
2319         switch (eventName[1])
2320           {
2321           /* TODO: check number of buttons before parsing */
2322           case '1':
2323                     button = 1;
2324                     break;
2325           case '2':
2326                   button = 2;
2327                   break;
2328           case '3':
2329                   button = 3;
2330                   break;
2331           case '4':
2332                   button = 4;
2333                   break;
2334           case '5':
2335                   button = 5;
2336                   break;
2337           default:
2338                   error = TRUE;
2339           }
2340         if (!error)
2341           {
2342             if (x != -1 && y != -1)
2343               {
2344                 XTestFakeMotionEvent (display, DefaultScreen (display),
2345                                       x, y, 0);
2346               }
2347             XTestFakeButtonEvent (display, button, !(eventName[2] == 'r'), 0);
2348             if (eventName[2] == 'c')
2349               XTestFakeButtonEvent (display, button, FALSE, 1);
2350             else if (eventName[2] == 'd')
2351               {
2352               XTestFakeButtonEvent (display, button, FALSE, 1);
2353               XTestFakeButtonEvent (display, button, TRUE, 2);
2354               XTestFakeButtonEvent (display, button, FALSE, 3);
2355               }
2356           }
2357         break;
2358       case 'r': /* relative motion */
2359         XTestFakeRelativeMotionEvent (display, x, y, 0);
2360         break;
2361       case 'a': /* absolute motion */
2362         XTestFakeMotionEvent (display, DefaultScreen (display),
2363                               x, y, 0);
2364         break;
2365     }
2366 }
2367
2368 /* Accessibility::DEController::notifyListenersSync */
2369 static CORBA_boolean
2370 impl_notify_listeners_sync (PortableServer_Servant           servant,
2371                             const Accessibility_DeviceEvent *event,
2372                             CORBA_Environment               *ev)
2373 {
2374   SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER (
2375     bonobo_object_from_servant (servant));
2376 #ifdef SPI_DEBUG
2377   g_print ("notifylistening listeners synchronously: controller %p, event id %d\n",
2378            controller, (int) event->id);
2379 #endif
2380   return spi_controller_notify_keylisteners (controller, event, CORBA_FALSE, ev) ?
2381           CORBA_TRUE : CORBA_FALSE;
2382 }
2383
2384 /* Accessibility::DEController::notifyListenersAsync */
2385 static void
2386 impl_notify_listeners_async (PortableServer_Servant           servant,
2387                              const Accessibility_DeviceEvent *event,
2388                              CORBA_Environment               *ev)
2389 {
2390   SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER (
2391     bonobo_object_from_servant (servant));
2392 #ifdef SPI_DEBUG
2393   fprintf (stderr, "notifying listeners asynchronously\n");
2394 #endif
2395   spi_controller_notify_keylisteners (controller, event, CORBA_FALSE, ev);
2396 }
2397
2398 static void
2399 spi_device_event_controller_class_init (SpiDEControllerClass *klass)
2400 {
2401   GObjectClass * object_class = (GObjectClass *) klass;
2402   POA_Accessibility_DeviceEventController__epv *epv = &klass->epv;
2403
2404   spi_device_event_controller_parent_class = g_type_class_peek_parent (klass);
2405
2406   object_class->finalize = spi_device_event_controller_object_finalize;
2407
2408   epv->registerKeystrokeListener   = impl_register_keystroke_listener;
2409   epv->deregisterKeystrokeListener = impl_deregister_keystroke_listener;
2410   epv->registerDeviceEventListener = impl_register_device_listener;
2411   epv->deregisterDeviceEventListener = impl_deregister_device_listener;
2412   epv->generateKeyboardEvent       = impl_generate_keyboard_event;
2413   epv->generateMouseEvent          = impl_generate_mouse_event;
2414   epv->notifyListenersSync         = impl_notify_listeners_sync;
2415   epv->notifyListenersAsync        = impl_notify_listeners_async;
2416
2417   if (!spi_dec_private_quark)
2418           spi_dec_private_quark = g_quark_from_static_string ("spi-dec-private");
2419 }
2420
2421 #ifdef HAVE_XEVIE
2422 Bool isEvent(dpy,event,arg)
2423      Display *dpy;
2424      XEvent *event;
2425      char *arg;
2426 {
2427    return TRUE;
2428 }
2429
2430 gboolean
2431 handle_io (GIOChannel *source,
2432            GIOCondition condition,
2433            gpointer data)
2434 {
2435   SpiDEController *controller = (SpiDEController *) data;
2436   gboolean is_consumed = FALSE;
2437   XEvent ev;
2438
2439   while (XCheckIfEvent(controller->xevie_display, &ev, isEvent, NULL))
2440     {
2441       if (ev.type == KeyPress || ev.type == KeyRelease)
2442         is_consumed = spi_device_event_controller_forward_key_event (controller, &ev);
2443
2444       if (! is_consumed)
2445         XevieSendEvent(controller->xevie_display, &ev, XEVIE_UNMODIFIED);
2446     }
2447
2448   return TRUE;
2449 }
2450 #endif /* HAVE_XEVIE */
2451
2452 static void
2453 spi_device_event_controller_init (SpiDEController *device_event_controller)
2454 {
2455 #ifdef HAVE_XEVIE
2456   GIOChannel *ioc;
2457   int fd;
2458 #endif /* HAVE_XEVIE */
2459
2460   DEControllerPrivateData *private;
2461   device_event_controller->key_listeners   = NULL;
2462   device_event_controller->mouse_listeners = NULL;
2463   device_event_controller->keygrabs_list   = NULL;
2464   device_event_controller->xevie_display   = NULL;
2465
2466 #ifdef HAVE_XEVIE
2467   device_event_controller->xevie_display = XOpenDisplay(NULL);
2468
2469   if (XevieStart(device_event_controller->xevie_display) == TRUE)
2470     {
2471 #ifdef SPI_KEYEVENT_DEBUG
2472       fprintf (stderr, "XevieStart() success \n");
2473 #endif
2474       XevieSelectInput(device_event_controller->xevie_display, KeyPressMask | KeyReleaseMask);
2475
2476       fd = ConnectionNumber(device_event_controller->xevie_display);
2477       ioc = g_io_channel_unix_new (fd);
2478       g_io_add_watch (ioc, G_IO_IN | G_IO_HUP, handle_io, device_event_controller);
2479       g_io_channel_unref (ioc);
2480     }
2481   else
2482     {
2483       device_event_controller->xevie_display = NULL;
2484 #ifdef SPI_KEYEVENT_DEBUG
2485       fprintf (stderr, "XevieStart() failed, only one client is allowed to do event int exception\n");
2486 #endif
2487     }
2488 #endif /* HAVE_XEVIE */
2489
2490   private = g_new0 (DEControllerPrivateData, 1);
2491   gettimeofday (&private->last_press_time, NULL);
2492   gettimeofday (&private->last_release_time, NULL);
2493   g_object_set_qdata (G_OBJECT (device_event_controller),
2494                       spi_dec_private_quark,
2495                       private);
2496   spi_controller_register_with_devices (device_event_controller);
2497 }
2498
2499 static gboolean
2500 spi_device_event_controller_forward_key_event (SpiDEController *controller,
2501                                                const XEvent    *event)
2502 {
2503   CORBA_Environment ev;
2504   Accessibility_DeviceEvent key_event;
2505
2506   g_assert (event->type == KeyPress || event->type == KeyRelease);
2507
2508   CORBA_exception_init (&ev);
2509
2510   key_event = spi_keystroke_from_x_key_event ((XKeyEvent *) event);
2511
2512   if (controller->xevie_display == NULL)
2513     spi_controller_update_key_grabs (controller, &key_event);
2514
2515   /* relay to listeners, and decide whether to consume it or not */
2516   return spi_controller_notify_keylisteners (controller, &key_event, CORBA_TRUE, &ev);
2517 }
2518
2519 SpiDEController *
2520 spi_device_event_controller_new (SpiRegistry *registry)
2521 {
2522   SpiDEController *retval = g_object_new (
2523     SPI_DEVICE_EVENT_CONTROLLER_TYPE, NULL);
2524
2525   retval->registry = SPI_REGISTRY (bonobo_object_ref (
2526           BONOBO_OBJECT (registry)));
2527
2528   spi_dec_init_mouse_listener (registry);
2529   /* TODO: kill mouse listener on finalize */
2530   return retval;
2531 }
2532
2533 static gboolean
2534 is_key_released (KeyCode code)
2535 {
2536   char keys[32];
2537   int down;
2538
2539   XQueryKeymap (spi_get_display (), keys);
2540   down = BIT (keys, code);
2541   return (down == 0);
2542 }
2543
2544 static gboolean
2545 check_release (gpointer data)
2546 {
2547   gboolean released;
2548   Accessibility_DeviceEvent *event = (Accessibility_DeviceEvent *)data;
2549   KeyCode code = event->hw_code;
2550   CORBA_Environment ev;
2551
2552   released = is_key_released (code);
2553
2554   if (released)
2555     {
2556       check_release_handler = 0;
2557       event->type = Accessibility_KEY_RELEASED_EVENT;
2558       ev._major = CORBA_NO_EXCEPTION;
2559       spi_controller_notify_keylisteners (saved_controller, event, CORBA_TRUE, &ev);
2560     }
2561   return (released == 0);
2562 }
2563
2564 static void wait_for_release_event (XEvent          *event,
2565                                     SpiDEController *controller)
2566 {
2567   pressed_event = spi_keystroke_from_x_key_event ((XKeyEvent *) event);
2568   saved_controller = controller;
2569   check_release_handler = g_timeout_add (CHECK_RELEASE_DELAY, check_release, &pressed_event);
2570 }
2571
2572 BONOBO_TYPE_FUNC_FULL (SpiDEController,
2573                        Accessibility_DeviceEventController,
2574                        PARENT_TYPE,
2575                        spi_device_event_controller)