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