registryd/deviceeventcontroller.c

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