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
  37 #include <X11/Xlib.h>
  38 #include <X11/Xutil.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 <glib.h>
  52
  53 #include <dbus/dbus.h>
  54
  55 #include "paths.h"
  56 #include "keymasks.h"
  57 #include "de-types.h"
  58 #include "de-marshaller.h"
  59 #include "display.h"
  60 #include "event-source.h"
  61
  62 #include "deviceeventcontroller.h"
  63 #include "reentrant-list.h"
  64
  65 #include "introspection.h"
  66
  67 KeySym ucs2keysym (long ucs);
  68 long keysym2ucs(KeySym keysym);
  69
  70 #define CHECK_RELEASE_DELAY 20
  71 #define BIT(c, x)       (c[x/8]&(1<<(x%8)))
  72 static guint check_release_handler = 0;
  73 static Accessibility_DeviceEvent pressed_event;
  74 static SpiDEController *saved_controller;
  75 static void wait_for_release_event (XEvent *event, SpiDEController *controller);
  76
  77 /* Our parent Gtk object type */
  78 #define PARENT_TYPE G_TYPE_OBJECT
  79
  80 /* A pointer to our parent object class */
  81 static int spi_error_code = 0;
  82 struct _SpiPoint {
  83     gint x;
  84     gint y;
  85 };
  86 typedef struct _SpiPoint SpiPoint;
  87 static SpiPoint last_mouse_pos_static = {0, 0};
  88 static SpiPoint *last_mouse_pos = &last_mouse_pos_static;
  89 static unsigned int mouse_mask_state = 0;
  90 static unsigned int mouse_button_mask =
  91   Button1Mask | Button2Mask | Button3Mask | Button4Mask | Button5Mask;
  92 static unsigned int key_modifier_mask =
  93   Mod1Mask | Mod2Mask | Mod3Mask | Mod4Mask | Mod5Mask | ShiftMask | LockMask | ControlMask | SPI_KEYMASK_NUMLOCK;
  94 static unsigned int _numlock_physical_mask = Mod2Mask; /* a guess, will be reset */
  95
  96 static GQuark spi_dec_private_quark = 0;
  97 static XModifierKeymap* xmkeymap = NULL;
  98
  99 static gboolean have_mouse_listener = FALSE;
 100 static gboolean have_mouse_event_listener = FALSE;
 101
 102 static int (*x_default_error_handler) (Display *display, XErrorEvent *error_event);
 103
 104 typedef enum {
 105   SPI_DEVICE_TYPE_KBD,
 106   SPI_DEVICE_TYPE_MOUSE,
 107   SPI_DEVICE_TYPE_LAST_DEFINED
 108 } SpiDeviceTypeCategory;
 109
 110 typedef struct {
 111   guint                             ref_count : 30;
 112   guint                             pending_add : 1;
 113   guint                             pending_remove : 1;
 114
 115   Accessibility_ControllerEventMask mod_mask;
 116   dbus_uint32_t               key_val;  /* KeyCode */
 117 } DEControllerGrabMask;
 118
 119 typedef struct {
 120   char *bus_name;
 121   char *path;
 122   SpiDeviceTypeCategory type;
 123   gulong types;
 124 } DEControllerListener;
 125
 126 typedef struct {
 127   DEControllerListener listener;
 128
 129  GSList *keys;
 130   Accessibility_ControllerEventMask mask;
 131   Accessibility_EventListenerMode  *mode;
 132 } DEControllerKeyListener;
 133
 134 typedef struct {
 135   unsigned int last_press_keycode;
 136   unsigned int last_release_keycode;
 137   struct timeval last_press_time;
 138   struct timeval last_release_time;
 139   int have_xkb;
 140   int xkb_major_extension_opcode;
 141   int xkb_base_event_code;
 142   int xkb_base_error_code;
 143   unsigned int xkb_latch_mask;
 144   unsigned int pending_xkb_mod_relatch_mask;
 145   XkbDescPtr xkb_desc;
 146   KeyCode reserved_keycode;
 147   KeySym reserved_keysym;
 148   guint  reserved_reset_timeout;
 149 } DEControllerPrivateData;
 150
 151 static void     spi_controller_register_with_devices          (SpiDEController           *controller);
 152 static gboolean spi_controller_update_key_grabs               (SpiDEController           *controller,
 153                                                                Accessibility_DeviceEvent *recv);
 154 static gboolean spi_controller_register_device_listener       (SpiDEController           *controller,
 155                                                                DEControllerListener      *l);
 156 static gboolean spi_device_event_controller_forward_key_event (SpiDEController           *controller,
 157                                                                const XEvent              *event);
 158 static void     spi_controller_deregister_device_listener (SpiDEController            *controller,
 159                                                            DEControllerListener *listener);
 160 static void     spi_deregister_controller_key_listener (SpiDEController         *controller,
 161                                                         DEControllerKeyListener *key_listener);
 162 static gboolean spi_controller_notify_mouselisteners (SpiDEController                 *controller,
 163                                                       const Accessibility_DeviceEvent *event);
 164
 165 static gboolean spi_eventtype_seq_contains_event (dbus_uint32_t types,
 166                                                   const Accessibility_DeviceEvent *event);
 167 static gboolean spi_clear_error_state (void);
 168 static gboolean spi_dec_poll_mouse_moved (gpointer data);
 169 static gboolean spi_dec_poll_mouse_moving (gpointer data);
 170 static gboolean spi_dec_poll_mouse_idle (gpointer data);
 171
 172 G_DEFINE_TYPE(SpiDEController, spi_device_event_controller, G_TYPE_OBJECT)
 173
 174 DBusMessage *
 175 invalid_arguments_error (DBusMessage *message)
 176 {
 177     DBusMessage *reply;
 178     gchar       *errmsg;
 179
 180     errmsg= g_strdup_printf (
 181             "Method \"%s\" with signature \"%s\" on interface \"%s\" was supplied with invalid arguments\n",
 182             dbus_message_get_member (message),
 183             dbus_message_get_signature (message),
 184             dbus_message_get_interface (message));
 185     reply = dbus_message_new_error (message,
 186                                     DBUS_ERROR_INVALID_ARGS,
 187                                     errmsg);
 188     g_free (errmsg);
 189     return reply;
 190 }
 191
 192 /* Private methods */
 193 static dbus_bool_t
 194 spi_dbus_add_disconnect_match (DBusConnection *bus, const char *name)
 195 {
 196   char *match = g_strdup_printf ("interface=%s,member=NameOwnerChanged,arg0=%s", DBUS_INTERFACE_DBUS, name);
 197   if (match)
 198   {
 199     DBusError error;
 200     dbus_error_init (&error);
 201     dbus_bus_add_match (bus, match, &error);
 202     g_free (match);
 203     return !dbus_error_is_set (&error);
 204   }
 205   else return FALSE;
 206 }
 207
 208 static dbus_bool_t
 209 spi_dbus_remove_disconnect_match (DBusConnection *bus, const char *name)
 210 {
 211   char *match = g_strdup_printf ("interface=%s,member=NameOwnerChanged,arg0=%s", DBUS_INTERFACE_DBUS, name);
 212   if (match)
 213   {
 214     DBusError error;
 215     dbus_error_init (&error);
 216     dbus_bus_remove_match (bus, match, &error);
 217     g_free (match);
 218     return !dbus_error_is_set (&error);
 219   }
 220   else return FALSE;
 221 }
 222
 223 static unsigned int
 224 keysym_mod_mask (KeySym keysym, KeyCode keycode)
 225 {
 226         /* we really should use XKB and look directly at the keymap */
 227         /* this is very inelegant */
 228         Display *display = spi_get_display ();
 229         unsigned int mods_rtn = 0;
 230         unsigned int retval = 0;
 231         KeySym sym_rtn;
 232
 233         if (XkbLookupKeySym (display, keycode, 0, &mods_rtn, &sym_rtn) &&
 234             (sym_rtn == keysym)) {
 235                 retval = 0;
 236         }
 237         else if (XkbLookupKeySym (display, keycode, ShiftMask, &mods_rtn, &sym_rtn) &&
 238                  (sym_rtn == keysym)) {
 239                 retval = ShiftMask;
 240         }
 241         else if (XkbLookupKeySym (display, keycode, Mod2Mask, &mods_rtn, &sym_rtn) &&
 242                  (sym_rtn == keysym)) {
 243                 retval = Mod2Mask;
 244         }
 245         else if (XkbLookupKeySym (display, keycode, Mod3Mask, &mods_rtn, &sym_rtn) &&
 246                  (sym_rtn == keysym)) {
 247                 retval = Mod3Mask;
 248         }
 249         else if (XkbLookupKeySym (display, keycode,
 250                                   ShiftMask | Mod2Mask, &mods_rtn, &sym_rtn) &&
 251                  (sym_rtn == keysym)) {
 252                 retval = (Mod2Mask | ShiftMask);
 253         }
 254         else if (XkbLookupKeySym (display, keycode,
 255                                   ShiftMask | Mod3Mask, &mods_rtn, &sym_rtn) &&
 256                  (sym_rtn == keysym)) {
 257                 retval = (Mod3Mask | ShiftMask);
 258         }
 259         else if (XkbLookupKeySym (display, keycode,
 260                                   ShiftMask | Mod4Mask, &mods_rtn, &sym_rtn) &&
 261                  (sym_rtn == keysym)) {
 262                 retval = (Mod4Mask | ShiftMask);
 263         }
 264         else
 265                 retval = 0xFFFF;
 266         return retval;
 267 }
 268
 269 static gboolean
 270 spi_dec_replace_map_keysym (DEControllerPrivateData *priv, KeyCode keycode, KeySym keysym)
 271 {
 272 #ifdef HAVE_XKB
 273   Display *dpy = spi_get_display ();
 274   XkbDescPtr desc;
 275   if (!(desc = XkbGetMap (dpy, XkbAllMapComponentsMask, XkbUseCoreKbd)))
 276     {
 277       fprintf (stderr, "ERROR getting map\n");
 278     }
 279   XFlush (dpy);
 280   XSync (dpy, False);
 281   if (desc && desc->map)
 282     {
 283       gint offset = desc->map->key_sym_map[keycode].offset;
 284       desc->map->syms[offset] = keysym;
 285     }
 286   else
 287     {
 288       fprintf (stderr, "Error changing key map: empty server structure\n");
 289     }
 290   XkbSetMap (dpy, XkbAllMapComponentsMask, desc);
 291   /**
 292    *  FIXME: the use of XkbChangeMap, and the reuse of the priv->xkb_desc structure,
 293    * would be far preferable.
 294    * HOWEVER it does not seem to work using XFree 4.3.
 295    **/
 296   /*        XkbChangeMap (dpy, priv->xkb_desc, priv->changes); */
 297   XFlush (dpy);
 298   XSync (dpy, False);
 299   XkbFreeKeyboard (desc, 0, TRUE);
 300
 301   return TRUE;
 302 #else
 303   return FALSE;
 304 #endif
 305 }
 306
 307 static gboolean
 308 spi_dec_reset_reserved (gpointer data)
 309 {
 310   DEControllerPrivateData *priv = data;
 311   spi_dec_replace_map_keysym (priv, priv->reserved_keycode, priv->reserved_keysym);
 312   priv->reserved_reset_timeout = 0;
 313   return FALSE;
 314 }
 315
 316 static KeyCode
 317 keycode_for_keysym (SpiDEController *controller, long keysym, unsigned int *modmask)
 318 {
 319         KeyCode keycode = 0;
 320         keycode = XKeysymToKeycode (spi_get_display (), (KeySym) keysym);
 321         if (!keycode)
 322         {
 323                 DEControllerPrivateData *priv = (DEControllerPrivateData *)
 324                         g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
 325                 /* if there's no keycode available, fix it */
 326                 if (spi_dec_replace_map_keysym (priv, priv->reserved_keycode, keysym))
 327                 {
 328                         keycode = priv->reserved_keycode;
 329                         /*
 330                          * queue a timer to restore the old keycode.  Ugly, but required
 331                          * due to races / asynchronous X delivery.
 332                          * Long-term fix is to extend the X keymap here instead of replace entries.
 333                          */
 334                         priv->reserved_reset_timeout = g_timeout_add (500, spi_dec_reset_reserved, priv);
 335                 }
 336                 *modmask = 0;
 337                 return keycode;
 338         }
 339         if (modmask)
 340                 *modmask = keysym_mod_mask (keysym, keycode);
 341         return keycode;
 342 }
 343
 344 static DEControllerGrabMask *
 345 spi_grab_mask_clone (DEControllerGrabMask *grab_mask)
 346 {
 347   DEControllerGrabMask *clone = g_new (DEControllerGrabMask, 1);
 348
 349   memcpy (clone, grab_mask, sizeof (DEControllerGrabMask));
 350
 351   clone->ref_count = 1;
 352   clone->pending_add = TRUE;
 353   clone->pending_remove = FALSE;
 354
 355   return clone;
 356 }
 357
 358 static void
 359 spi_grab_mask_free (DEControllerGrabMask *grab_mask)
 360 {
 361   g_free (grab_mask);
 362 }
 363
 364 static gint
 365 spi_grab_mask_compare_values (gconstpointer p1, gconstpointer p2)
 366 {
 367   DEControllerGrabMask *l1 = (DEControllerGrabMask *) p1;
 368   DEControllerGrabMask *l2 = (DEControllerGrabMask *) p2;
 369
 370   if (p1 == p2)
 371     {
 372       return 0;
 373     }
 374   else
 375     {
 376       return ((l1->mod_mask != l2->mod_mask) || (l1->key_val != l2->key_val));
 377     }
 378 }
 379
 380 static void
 381 spi_dec_set_unlatch_pending (SpiDEController *controller, unsigned mask)
 382 {
 383   DEControllerPrivateData *priv =
 384     g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
 385 #ifdef SPI_XKB_DEBUG
 386   if (priv->xkb_latch_mask) fprintf (stderr, "unlatch pending! %x\n",
 387                                      priv->xkb_latch_mask);
 388 #endif
 389   priv->pending_xkb_mod_relatch_mask |= priv->xkb_latch_mask;
 390 }
 391
 392 static void
 393 spi_dec_clear_unlatch_pending (SpiDEController *controller)
 394 {
 395   DEControllerPrivateData *priv =
 396     g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
 397   priv->xkb_latch_mask = 0;
 398 }
 399
 400 static void emit(SpiDEController *controller, const char *interface, const char *name, const char *minor, int a1, int a2)
 401 {
 402   DBusMessage *signal = NULL;
 403   DBusMessageIter iter, iter_struct, iter_variant;
 404   int nil = 0;
 405   const char *path = SPI_DBUS_PATH_ROOT;
 406   const char *bus_name = dbus_bus_get_unique_name (controller->bus);
 407
 408   signal = dbus_message_new_signal (path, interface, name);
 409
 410   dbus_message_iter_init_append (signal, &iter);
 411
 412   dbus_message_iter_append_basic (&iter, DBUS_TYPE_STRING, &minor);
 413   dbus_message_iter_append_basic (&iter, DBUS_TYPE_INT32, &a1);
 414   dbus_message_iter_append_basic (&iter, DBUS_TYPE_INT32, &a2);
 415   dbus_message_iter_open_container (&iter, DBUS_TYPE_VARIANT, "i", &iter_variant);
 416       dbus_message_iter_append_basic (&iter_variant, DBUS_TYPE_INT32, &nil);
 417   dbus_message_iter_close_container (&iter, &iter_variant);
 418
 419   dbus_message_iter_open_container (&iter, DBUS_TYPE_STRUCT, NULL,
 420                                     &iter_struct);
 421   dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_STRING, &bus_name);
 422   dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_OBJECT_PATH, &path);
 423   dbus_message_iter_close_container (&iter, &iter_struct);
 424
 425   dbus_connection_send (controller->bus, signal, NULL);
 426   dbus_message_unref (signal);
 427 }
 428
 429 static gboolean
 430 spi_dec_button_update_and_emit (SpiDEController *controller,
 431                                 guint mask_return)
 432 {
 433   Accessibility_DeviceEvent mouse_e;
 434   gchar event_detail[3];
 435   gboolean is_consumed = FALSE;
 436
 437   if ((mask_return & mouse_button_mask) !=
 438       (mouse_mask_state & mouse_button_mask))
 439     {
 440       int button_number = 0;
 441       gboolean is_down = False;
 442
 443       if (!(mask_return & Button1Mask) &&
 444           (mouse_mask_state & Button1Mask))
 445         {
 446           mouse_mask_state &= ~Button1Mask;
 447           button_number = 1;
 448         }
 449       else if ((mask_return & Button1Mask) &&
 450                !(mouse_mask_state & Button1Mask))
 451         {
 452           mouse_mask_state |= Button1Mask;
 453           button_number = 1;
 454           is_down = True;
 455         }
 456       else if (!(mask_return & Button2Mask) &&
 457                (mouse_mask_state & Button2Mask))
 458         {
 459           mouse_mask_state &= ~Button2Mask;
 460           button_number = 2;
 461         }
 462       else if ((mask_return & Button2Mask) &&
 463                !(mouse_mask_state & Button2Mask))
 464         {
 465           mouse_mask_state |= Button2Mask;
 466           button_number = 2;
 467           is_down = True;
 468         }
 469       else if (!(mask_return & Button3Mask) &&
 470                (mouse_mask_state & Button3Mask))
 471         {
 472           mouse_mask_state &= ~Button3Mask;
 473           button_number = 3;
 474         }
 475       else if ((mask_return & Button3Mask) &&
 476                !(mouse_mask_state & Button3Mask))
 477         {
 478           mouse_mask_state |= Button3Mask;
 479           button_number = 3;
 480           is_down = True;
 481         }
 482       else if (!(mask_return & Button4Mask) &&
 483                (mouse_mask_state & Button4Mask))
 484         {
 485           mouse_mask_state &= ~Button4Mask;
 486           button_number = 4;
 487         }
 488       else if ((mask_return & Button4Mask) &&
 489                !(mouse_mask_state & Button4Mask))
 490         {
 491           mouse_mask_state |= Button4Mask;
 492           button_number = 4;
 493           is_down = True;
 494         }
 495       else if (!(mask_return & Button5Mask) &&
 496                (mouse_mask_state & Button5Mask))
 497         {
 498           mouse_mask_state &= ~Button5Mask;
 499           button_number = 5;
 500         }
 501       else if ((mask_return & Button5Mask) &&
 502                !(mouse_mask_state & Button5Mask))
 503         {
 504           mouse_mask_state |= Button5Mask;
 505           button_number = 5;
 506           is_down = True;
 507         }
 508       if (button_number) {
 509 #ifdef SPI_DEBUG
 510         fprintf (stderr, "Button %d %s\n",
 511                  button_number, (is_down) ? "Pressed" : "Released");
 512 #endif
 513         snprintf (event_detail, 3, "%d%c", button_number,
 514                   (is_down) ? 'p' : 'r');
 515         /* TODO: FIXME distinguish between physical and
 516          * logical buttons
 517          */
 518         mouse_e.type      = (is_down) ?
 519           Accessibility_BUTTON_PRESSED_EVENT :
 520           Accessibility_BUTTON_RELEASED_EVENT;
 521         mouse_e.id        = button_number;
 522         mouse_e.hw_code   = button_number;
 523         mouse_e.modifiers = (dbus_uint16_t) mouse_mask_state;
 524         mouse_e.timestamp = 0;
 525         mouse_e.event_string = "";
 526         mouse_e.is_text   = FALSE;
 527         is_consumed =
 528           spi_controller_notify_mouselisteners (controller,
 529                                                 &mouse_e);
 530         if (!is_consumed)
 531           {
 532             dbus_uint32_t x = last_mouse_pos->x, y = last_mouse_pos->y;
 533             emit(controller, SPI_DBUS_INTERFACE_EVENT_MOUSE, "Button", event_detail, x, y);
 534           }
 535         else
 536           spi_dec_set_unlatch_pending (controller, mask_return);
 537       }
 538       return TRUE;
 539     }
 540   else
 541     {
 542       return FALSE;
 543     }
 544 }
 545
 546
 547 static guint
 548 spi_dec_mouse_check (SpiDEController *controller,
 549                      int *x, int *y, gboolean *moved)
 550 {
 551   int win_x_return,win_y_return;
 552   unsigned int mask_return;
 553   Window root_return, child_return;
 554   Display *display = spi_get_display ();
 555
 556   if (display != NULL)
 557     XQueryPointer(display, DefaultRootWindow (display),
 558                   &root_return, &child_return,
 559                   x, y,
 560                   &win_x_return, &win_y_return, &mask_return);
 561   /*
 562    * Since many clients grab the pointer, and X goes an automatic
 563    * pointer grab on mouse-down, we often must detect mouse button events
 564    * by polling rather than via a button grab.
 565    * The while loop (rather than if) is used since it's possible that
 566    * multiple buttons have changed state since we last checked.
 567    */
 568   if (mask_return != mouse_mask_state)
 569     {
 570       while (spi_dec_button_update_and_emit (controller, mask_return));
 571     }
 572
 573   if (*x != last_mouse_pos->x || *y != last_mouse_pos->y)
 574     {
 575       // TODO: combine these two signals?
 576       dbus_uint32_t ix = *x, iy = *y;
 577       emit(controller, SPI_DBUS_INTERFACE_EVENT_MOUSE, "Abs", "", ix, iy);
 578       ix -= last_mouse_pos->x;
 579       iy -= last_mouse_pos->y;
 580       emit(controller, SPI_DBUS_INTERFACE_EVENT_MOUSE, "Rel", "", ix, iy);
 581       last_mouse_pos->x = *x;
 582       last_mouse_pos->y = *y;
 583       *moved = True;
 584     }
 585   else
 586     {
 587       *moved = False;
 588     }
 589
 590   return mask_return;
 591 }
 592
 593 static void
 594 spi_dec_emit_modifier_event (SpiDEController *controller, guint prev_mask,
 595                              guint current_mask)
 596 {
 597   dbus_uint32_t d1, d2;
 598
 599 #ifdef SPI_XKB_DEBUG
 600   fprintf (stderr, "MODIFIER CHANGE EVENT! %x to %x\n",
 601            prev_mask, current_mask);
 602 #endif
 603
 604   /* set bits for the virtual modifiers like NUMLOCK */
 605   if (prev_mask & _numlock_physical_mask)
 606     prev_mask |= SPI_KEYMASK_NUMLOCK;
 607   if (current_mask & _numlock_physical_mask)
 608     current_mask |= SPI_KEYMASK_NUMLOCK;
 609
 610   d1 = prev_mask & key_modifier_mask;
 611   d2 = current_mask & key_modifier_mask;
 612       emit(controller, SPI_DBUS_INTERFACE_EVENT_KEYBOARD, "Modifiers", "", d1, d2);
 613 }
 614
 615 static gboolean
 616 spi_dec_poll_mouse_moved (gpointer data)
 617 {
 618   SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER(data);
 619   int x, y;
 620   gboolean moved;
 621   guint mask_return;
 622
 623   mask_return = spi_dec_mouse_check (controller, &x, &y, &moved);
 624
 625   if ((mask_return & key_modifier_mask) !=
 626       (mouse_mask_state & key_modifier_mask))
 627     {
 628       spi_dec_emit_modifier_event (controller, mouse_mask_state, mask_return);
 629       mouse_mask_state = mask_return;
 630     }
 631
 632   return moved;
 633 }
 634
 635 static gboolean
 636 spi_dec_poll_mouse_idle (gpointer data)
 637 {
 638   if (!have_mouse_event_listener && !have_mouse_listener)
 639     return FALSE;
 640   else if (!spi_dec_poll_mouse_moved (data))
 641     return TRUE;
 642   else
 643     {
 644       g_timeout_add (20, spi_dec_poll_mouse_moving, data);
 645       return FALSE;
 646     }
 647 }
 648
 649 static gboolean
 650 spi_dec_poll_mouse_moving (gpointer data)
 651 {
 652   if (!have_mouse_event_listener && !have_mouse_listener)
 653     return FALSE;
 654   else if (spi_dec_poll_mouse_moved (data))
 655     return TRUE;
 656   else
 657     {
 658       g_timeout_add (100, spi_dec_poll_mouse_idle, data);
 659       return FALSE;
 660     }
 661 }
 662
 663 #ifdef WE_NEED_UGRAB_MOUSE
 664 static int
 665 spi_dec_ungrab_mouse (gpointer data)
 666 {
 667         Display *display = spi_get_display ();
 668         if (display)
 669           {
 670             XUngrabButton (spi_get_display (), AnyButton, AnyModifier,
 671                            XDefaultRootWindow (spi_get_display ()));
 672           }
 673         return FALSE;
 674 }
 675 #endif
 676
 677 static void
 678 spi_dec_init_mouse_listener (SpiDEController *dec)
 679 {
 680 #ifdef GRAB_BUTTON
 681   Display *display = spi_get_display ();
 682
 683   if (display)
 684     {
 685       if (XGrabButton (display, AnyButton, AnyModifier,
 686                        spi_get_root_window (),
 687                        True, ButtonPressMask | ButtonReleaseMask,
 688                        GrabModeSync, GrabModeAsync, None, None) != Success) {
 689 #ifdef SPI_DEBUG
 690         fprintf (stderr, "WARNING: could not grab mouse buttons!\n");
 691 #endif
 692         ;
 693       }
 694       XSync (display, False);
 695 #ifdef SPI_DEBUG
 696       fprintf (stderr, "mouse buttons grabbed\n");
 697 #endif
 698     }
 699 #endif
 700 }
 701
 702 /**
 703  * Eventually we can use this to make the marshalling of mask types
 704  * more sane, but for now we just use this to detect
 705  * the use of 'virtual' masks such as numlock and convert them to
 706  * system-specific mask values (i.e. ModMask).
 707  *
 708  **/
 709 static Accessibility_ControllerEventMask
 710 spi_dec_translate_mask (Accessibility_ControllerEventMask mask)
 711 {
 712   Accessibility_ControllerEventMask tmp_mask;
 713   gboolean has_numlock;
 714
 715   has_numlock = (mask & SPI_KEYMASK_NUMLOCK);
 716   tmp_mask = mask;
 717   if (has_numlock)
 718     {
 719       tmp_mask = mask ^ SPI_KEYMASK_NUMLOCK;
 720       tmp_mask |= _numlock_physical_mask;
 721     }
 722
 723   return tmp_mask;
 724 }
 725
 726 static DEControllerKeyListener *
 727 spi_dec_key_listener_new (const char *bus_name,
 728                           const char *path,
 729                           GSList *keys,
 730                           const Accessibility_ControllerEventMask mask,
 731                           const dbus_uint32_t types,
 732                           const Accessibility_EventListenerMode  *mode)
 733 {
 734   DEControllerKeyListener *key_listener = g_new0 (DEControllerKeyListener, 1);
 735   key_listener->listener.bus_name = g_strdup(bus_name);
 736   key_listener->listener.path = g_strdup(path);
 737   key_listener->listener.type = SPI_DEVICE_TYPE_KBD;
 738   key_listener->keys = keys;
 739   key_listener->mask = spi_dec_translate_mask (mask);
 740   key_listener->listener.types = types;
 741   if (mode)
 742   {
 743     key_listener->mode = (Accessibility_EventListenerMode *) g_malloc(sizeof(Accessibility_EventListenerMode));
 744     memcpy(key_listener->mode, mode, sizeof(*mode));
 745   }
 746   else
 747     key_listener->mode = NULL;
 748
 749 #ifdef SPI_DEBUG
 750   g_print ("new listener, with mask %x, is_global %d, keys %p (%d)\n",
 751            (unsigned int) key_listener->mask,
 752            (int) (mode ? mode->global : 0),
 753            (void *) key_listener->keys,
 754            (int) (key_listener->keys ? g_slist_length(key_listener->keys) : 0));
 755 #endif
 756
 757   return key_listener;
 758 }
 759
 760 static DEControllerListener *
 761 spi_dec_listener_new (const char *bus_name,
 762                       const char *path,
 763                       dbus_uint32_t types)
 764 {
 765   DEControllerListener *listener = g_new0 (DEControllerListener, 1);
 766   listener->bus_name = g_strdup(bus_name);
 767   listener->path = g_strdup(path);
 768   listener->type = SPI_DEVICE_TYPE_MOUSE;
 769   listener->types = types;
 770   return listener;
 771 }
 772
 773 static DEControllerListener *
 774 spi_listener_clone (DEControllerListener *listener)
 775 {
 776   DEControllerListener *clone = g_new0 (DEControllerListener, 1);
 777   clone->bus_name = g_strdup (listener->bus_name);
 778   clone->path = g_strdup (listener->path);
 779   clone->type = listener->type;
 780   clone->types = listener->types;
 781   return clone;
 782 }
 783
 784 static GSList *keylist_clone (GSList *s)
 785 {
 786   GSList *d = NULL;
 787   GSList *l;
 788
 789   for (l = s; l; l = g_slist_next(l))
 790   {
 791     Accessibility_KeyDefinition *kd = (Accessibility_KeyDefinition *)g_malloc(sizeof(Accessibility_KeyDefinition));
 792     if (kd)
 793     {
 794       Accessibility_KeyDefinition *kds = (Accessibility_KeyDefinition *)l->data;
 795       kd->keycode = kds->keycode;
 796       kd->keysym = kds->keysym;
 797       kd->keystring = g_strdup(kds->keystring);
 798       d = g_slist_append(d, kd);
 799     }
 800   }
 801   return d;
 802 }
 803
 804 static DEControllerKeyListener *
 805 spi_key_listener_clone (DEControllerKeyListener *key_listener)
 806 {
 807   DEControllerKeyListener *clone = g_new0 (DEControllerKeyListener, 1);
 808   clone->listener.bus_name = g_strdup (key_listener->listener.bus_name);
 809   clone->listener.path = g_strdup (key_listener->listener.path);
 810   clone->listener.type = SPI_DEVICE_TYPE_KBD;
 811   clone->keys = keylist_clone (key_listener->keys);
 812   clone->mask = key_listener->mask;
 813   clone->listener.types = key_listener->listener.types;
 814   if (key_listener->mode)
 815   {
 816     clone->mode = (Accessibility_EventListenerMode *)g_malloc(sizeof(Accessibility_EventListenerMode));
 817     if (clone->mode) memcpy(clone->mode, key_listener->mode, sizeof(Accessibility_EventListenerMode));
 818   }
 819   else
 820     clone->mode = NULL;
 821   return clone;
 822 }
 823
 824 static void keylist_free(GSList *keys)
 825 {
 826   GSList *l;
 827
 828   for (l = keys; l; l = g_slist_next(l))
 829   {
 830     Accessibility_KeyDefinition *kd = (Accessibility_KeyDefinition *)l->data;
 831     g_free(kd->keystring);
 832     g_free(kd);
 833   }
 834   g_slist_free (keys);
 835 }
 836
 837 static void
 838 spi_key_listener_data_free (DEControllerKeyListener *key_listener)
 839 {
 840   keylist_free(key_listener->keys);
 841   if (key_listener->mode) g_free(key_listener->mode);
 842   g_free (key_listener->listener.bus_name);
 843   g_free (key_listener->listener.path);
 844   g_free (key_listener);
 845 }
 846
 847 static void
 848 spi_key_listener_clone_free (DEControllerKeyListener *clone)
 849 {
 850   spi_key_listener_data_free (clone);
 851 }
 852
 853 static void
 854 spi_listener_clone_free (DEControllerListener *clone)
 855 {
 856   g_free (clone->path);
 857   g_free (clone->bus_name);
 858   g_free (clone);
 859 }
 860
 861 static void
 862 spi_dec_listener_free (DEControllerListener    *listener)
 863 {
 864   if (listener->type == SPI_DEVICE_TYPE_KBD)
 865     spi_key_listener_data_free ((DEControllerKeyListener *) listener);
 866   else
 867   {
 868     g_free (listener->bus_name);
 869     g_free (listener->path);
 870   }
 871 }
 872
 873 static void
 874 _register_keygrab (SpiDEController      *controller,
 875                    DEControllerGrabMask *grab_mask)
 876 {
 877   GList *l;
 878
 879   l = g_list_find_custom (controller->keygrabs_list, grab_mask,
 880                           spi_grab_mask_compare_values);
 881   if (l)
 882     {
 883       DEControllerGrabMask *cur_mask = l->data;
 884
 885       cur_mask->ref_count++;
 886       if (cur_mask->pending_remove)
 887         {
 888           cur_mask->pending_remove = FALSE;
 889         }
 890     }
 891   else
 892     {
 893       controller->keygrabs_list =
 894         g_list_prepend (controller->keygrabs_list,
 895                         spi_grab_mask_clone (grab_mask));
 896     }
 897 }
 898
 899 static void
 900 _deregister_keygrab (SpiDEController      *controller,
 901                      DEControllerGrabMask *grab_mask)
 902 {
 903   GList *l;
 904
 905   l = g_list_find_custom (controller->keygrabs_list, grab_mask,
 906                           spi_grab_mask_compare_values);
 907
 908   if (l)
 909     {
 910       DEControllerGrabMask *cur_mask = l->data;
 911
 912       cur_mask->ref_count--;
 913       if (cur_mask->ref_count <= 0)
 914         {
 915           cur_mask->pending_remove = TRUE;
 916         }
 917     }
 918 }
 919
 920 static void
 921 handle_keygrab (SpiDEController         *controller,
 922                 DEControllerKeyListener *key_listener,
 923                 void                   (*process_cb) (SpiDEController *controller,
 924                                                       DEControllerGrabMask *grab_mask))
 925 {
 926   DEControllerGrabMask grab_mask = { 0 };
 927
 928   grab_mask.mod_mask = key_listener->mask;
 929   if (g_slist_length (key_listener->keys) == 0) /* special case means AnyKey/AllKeys */
 930     {
 931       grab_mask.key_val = AnyKey;
 932 #ifdef SPI_DEBUG
 933       fprintf (stderr, "AnyKey grab!");
 934 #endif
 935       process_cb (controller, &grab_mask);
 936     }
 937   else
 938     {
 939       GSList *l;
 940
 941       for (l = key_listener->keys; l; l = g_slist_next(l))
 942         {
 943           Accessibility_KeyDefinition *keydef = l->data;
 944           long int key_val = keydef->keysym;
 945           /* X Grabs require keycodes, not keysyms */
 946           if (keydef->keystring && keydef->keystring[0])
 947             {
 948               key_val = XStringToKeysym(keydef->keystring);
 949             }
 950           if (key_val > 0)
 951             {
 952               key_val = XKeysymToKeycode (spi_get_display (), (KeySym) key_val);
 953             }
 954           else
 955             {
 956               key_val = keydef->keycode;
 957             }
 958           grab_mask.key_val = key_val;
 959           process_cb (controller, &grab_mask);
 960         }
 961     }
 962 }
 963
 964 static gboolean
 965 spi_controller_register_global_keygrabs (SpiDEController         *controller,
 966                                          DEControllerKeyListener *key_listener)
 967 {
 968   handle_keygrab (controller, key_listener, _register_keygrab);
 969   if (controller->xevie_display == NULL)
 970     return spi_controller_update_key_grabs (controller, NULL);
 971   else
 972     return TRUE;
 973 }
 974
 975 static void
 976 spi_controller_deregister_global_keygrabs (SpiDEController         *controller,
 977                                            DEControllerKeyListener *key_listener)
 978 {
 979   handle_keygrab (controller, key_listener, _deregister_keygrab);
 980   if (controller->xevie_display == NULL)
 981     spi_controller_update_key_grabs (controller, NULL);
 982 }
 983
 984 static void
 985 append_keystroke_listener (DBusMessageIter *iter, DEControllerKeyListener *listener)
 986 {
 987   dbus_uint32_t d_uint;
 988   DBusMessageIter iter_struct, iter_subarray, iter_substruct;
 989   GList *l;
 990   GSList *kl;
 991
 992   if (!dbus_message_iter_open_container (iter, DBUS_TYPE_STRUCT, NULL,
 993                                          &iter_struct))
 994     return;
 995
 996   dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_STRING,
 997                                   &listener->listener.bus_name);
 998   dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_OBJECT_PATH,
 999                                   &listener->listener.path);
1000   d_uint = listener->listener.type;
1001   dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_UINT32, &d_uint);
1002   d_uint = listener->listener.types;
1003   dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_UINT32, &d_uint);
1004   if (!dbus_message_iter_open_container (&iter_struct, DBUS_TYPE_ARRAY,
1005                                          "(iisi)", &iter_subarray))
1006   {
1007     dbus_message_iter_close_container (iter, &iter_struct);
1008     return;
1009   }
1010   for (kl = listener->keys; kl; kl = kl->next)
1011   {
1012     Accessibility_KeyDefinition *kd = kl->data;
1013     if (!dbus_message_iter_open_container (&iter_subarray, DBUS_TYPE_STRUCT,
1014                                          NULL, &iter_substruct))
1015       break;
1016     dbus_message_iter_append_basic (&iter_substruct, DBUS_TYPE_INT32, &kd->keycode);
1017     dbus_message_iter_append_basic (&iter_substruct, DBUS_TYPE_INT32, &kd->keysym);
1018     dbus_message_iter_append_basic (&iter_substruct, DBUS_TYPE_STRING, &kd->keystring);
1019     dbus_message_iter_append_basic (&iter_substruct, DBUS_TYPE_INT32, &kd->unused);
1020     dbus_message_iter_close_container (&iter_subarray, &iter_substruct);
1021   }
1022   dbus_message_iter_close_container (&iter_struct, &iter_subarray);
1023   d_uint = listener->mask;
1024   dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_UINT32, &d_uint);
1025   if (dbus_message_iter_open_container (&iter_struct, DBUS_TYPE_STRUCT,
1026                                          NULL, &iter_substruct))
1027   {
1028     dbus_message_iter_append_basic (&iter_substruct, DBUS_TYPE_BOOLEAN,
1029                                     &listener->mode->synchronous);
1030     dbus_message_iter_append_basic (&iter_substruct, DBUS_TYPE_BOOLEAN,
1031                                     &listener->mode->preemptive);
1032     dbus_message_iter_append_basic (&iter_substruct, DBUS_TYPE_BOOLEAN,
1033                                     &listener->mode->global);
1034     dbus_message_iter_close_container (&iter_struct, &iter_substruct);
1035   }
1036   dbus_message_iter_close_container (iter, &iter_struct);
1037 }
1038
1039 static void
1040 notify_keystroke_listener (SpiDEController *controller,
1041                            DEControllerKeyListener *listener,
1042                            gboolean enable)
1043 {
1044   const char *path = SPI_DBUS_PATH_DEC;
1045   const char *interface = SPI_DBUS_INTERFACE_DEVICE_EVENT_LISTENER;
1046   const char *name = (enable
1047                       ? "KeystrokeListenerRegistered"
1048                       : "KeystrokeListenerDeregistered");
1049   DBusMessage *signal;
1050   DBusMessageIter iter;
1051
1052   signal = dbus_message_new_signal (path, interface, name);
1053   if (!signal)
1054     return;
1055   dbus_message_iter_init_append (signal, &iter);
1056   append_keystroke_listener (&iter, listener);
1057   dbus_connection_send (controller->bus, signal, NULL);
1058   dbus_message_unref (signal);
1059 }
1060
1061 static void
1062 append_mouse_listener (DBusMessageIter *iter, DEControllerListener *listener)
1063 {
1064   DBusMessageIter iter_struct;
1065   dbus_uint32_t d_uint;
1066
1067   if (!dbus_message_iter_open_container (iter, DBUS_TYPE_STRUCT, NULL,
1068                                          &iter_struct))
1069     return;
1070   dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_STRING,
1071                                   &listener->bus_name);
1072   dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_OBJECT_PATH,
1073                                   &listener->path);
1074   d_uint = listener->types;
1075   dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_UINT32, &d_uint);
1076   dbus_message_iter_close_container (iter, &iter_struct);
1077 }
1078
1079 static void
1080 notify_mouse_listener (SpiDEController *controller,
1081                        DEControllerListener *listener,
1082                        gboolean enable)
1083 {
1084   const char *path = SPI_DBUS_PATH_DEC;
1085   const char *interface = SPI_DBUS_INTERFACE_DEVICE_EVENT_LISTENER;
1086   const char *name = (enable
1087                       ? "DeviceListenerRegistered"
1088                       : "DeviceListenerDeregistered");
1089   DBusMessage *signal;
1090   DBusMessageIter iter;
1091
1092   signal = dbus_message_new_signal (path, interface, name);
1093   if (!signal)
1094     return;
1095   dbus_message_iter_init_append (signal, &iter);
1096   append_mouse_listener (&iter, listener);
1097   dbus_connection_send (controller->bus, signal, NULL);
1098   dbus_message_unref (signal);
1099 }
1100
1101 static gboolean
1102 spi_controller_register_device_listener (SpiDEController      *controller,
1103                                          DEControllerListener *listener)
1104 {
1105   DEControllerKeyListener *key_listener;
1106   gboolean retval;
1107
1108   switch (listener->type) {
1109   case SPI_DEVICE_TYPE_KBD:
1110       key_listener = (DEControllerKeyListener *) listener;
1111
1112       controller->key_listeners = g_list_prepend (controller->key_listeners,
1113                                                   key_listener);
1114       spi_dbus_add_disconnect_match (controller->bus, key_listener->listener.bus_name);
1115       if (key_listener->mode->global)
1116         {
1117           retval = spi_controller_register_global_keygrabs (controller, key_listener);
1118         }
1119       else
1120           retval = TRUE;
1121       if (retval)
1122         notify_keystroke_listener (controller, key_listener, TRUE);
1123       break;
1124   case SPI_DEVICE_TYPE_MOUSE:
1125       controller->mouse_listeners = g_list_prepend (controller->mouse_listeners, listener);
1126       if (!have_mouse_listener)
1127         {
1128           have_mouse_listener = TRUE;
1129           if (!have_mouse_event_listener)
1130             g_timeout_add (100, spi_dec_poll_mouse_idle, controller);
1131         }
1132       spi_dbus_add_disconnect_match (controller->bus, listener->bus_name);
1133       notify_mouse_listener (controller, listener, TRUE);
1134       break;
1135   default:
1136       break;
1137   }
1138   return FALSE;
1139 }
1140
1141 static void
1142 set_reply (DBusPendingCall *pending, void *user_data)
1143 {
1144     void **replyptr = (void **)user_data;
1145
1146     *replyptr = dbus_pending_call_steal_reply (pending);
1147 }
1148
1149 static DBusMessage *
1150 send_and_allow_reentry (DBusConnection *bus, DBusMessage *message, int timeout, DBusError *error)
1151 {
1152     DBusPendingCall *pending;
1153     DBusMessage *reply = NULL;
1154
1155     if (!dbus_connection_send_with_reply (bus, message, &pending, -1))
1156     {
1157         return NULL;
1158     }
1159     dbus_pending_call_set_notify (pending, set_reply, (void *)&reply, NULL);
1160     while (!reply)
1161     {
1162       if (!dbus_connection_read_write_dispatch (bus, timeout))
1163         return NULL;
1164     }
1165     dbus_pending_call_unref (pending);
1166     return reply;
1167 }
1168 static gboolean
1169 Accessibility_DeviceEventListener_NotifyEvent(SpiDEController *controller,
1170                                               SpiRegistry *registry,
1171                                               DEControllerListener *listener,
1172                                               const Accessibility_DeviceEvent *key_event)
1173 {
1174   DBusMessage *message = dbus_message_new_method_call(listener->bus_name,
1175                                                       listener->path,
1176                                                       SPI_DBUS_INTERFACE_DEVICE_EVENT_LISTENER,
1177                                                       "NotifyEvent");
1178   DBusError error;
1179   dbus_bool_t consumed = FALSE;
1180
1181   dbus_error_init(&error);
1182   if (spi_dbus_marshal_deviceEvent(message, key_event))
1183   {
1184     DBusMessage *reply = send_and_allow_reentry (controller->bus, message, 1000, &error);
1185     if (reply)
1186     {
1187       DBusError error;
1188       dbus_error_init(&error);
1189       dbus_message_get_args(reply, &error, DBUS_TYPE_BOOLEAN, &consumed, DBUS_TYPE_INVALID);
1190       dbus_message_unref(reply);
1191     }
1192   }
1193   dbus_message_unref(message);
1194   return consumed;
1195 }
1196
1197 static gboolean
1198 spi_controller_notify_mouselisteners (SpiDEController                 *controller,
1199                                       const Accessibility_DeviceEvent *event)
1200 {
1201   GList   *l;
1202   GSList  *notify = NULL, *l2;
1203   GList  **listeners = &controller->mouse_listeners;
1204   gboolean is_consumed;
1205 #ifdef SPI_KEYEVENT_DEBUG
1206   gboolean found = FALSE;
1207 #endif
1208   if (!listeners)
1209     {
1210       return FALSE;
1211     }
1212
1213   for (l = *listeners; l; l = l->next)
1214     {
1215        DEControllerListener *listener = l->data;
1216
1217        if (spi_eventtype_seq_contains_event (listener->types, event))
1218          {
1219            /* we clone (don't dup) the listener, to avoid refcount inc. */
1220            notify = g_slist_prepend (notify,
1221                                      spi_listener_clone (listener));
1222 #ifdef SPI_KEYEVENT_DEBUG
1223            found = TRUE;
1224 #endif
1225          }
1226     }
1227
1228 #ifdef SPI_KEYEVENT_DEBUG
1229   if (!found)
1230     {
1231       g_print ("no match for event\n");
1232     }
1233 #endif
1234
1235   is_consumed = FALSE;
1236   for (l2 = notify; l2 && !is_consumed; l2 = l2->next)
1237     {
1238       DEControllerListener *listener = l2->data;
1239
1240       is_consumed = Accessibility_DeviceEventListener_NotifyEvent (controller, controller->registry, listener, event);
1241
1242       spi_listener_clone_free ((DEControllerListener *) l2->data);
1243     }
1244
1245   for (; l2; l2 = l2->next)
1246     {
1247       DEControllerListener *listener = l2->data;
1248       spi_listener_clone_free (listener);
1249       /* clone doesn't have its own ref, so don't use spi_device_listener_free */
1250     }
1251
1252   g_slist_free (notify);
1253
1254 #ifdef SPI_DEBUG
1255   if (is_consumed) g_message ("consumed\n");
1256 #endif
1257   return is_consumed;
1258 }
1259
1260 static void
1261 spi_device_event_controller_forward_mouse_event (SpiDEController *controller,
1262                                                  XEvent *xevent)
1263 {
1264   Accessibility_DeviceEvent mouse_e;
1265   gchar event_detail[3];
1266   gboolean is_consumed = FALSE;
1267   gboolean xkb_mod_unlatch_occurred;
1268   XButtonEvent *xbutton_event = (XButtonEvent *) xevent;
1269   dbus_uint32_t ix, iy;
1270
1271   int button = xbutton_event->button;
1272
1273   unsigned int mouse_button_state = xbutton_event->state;
1274
1275   switch (button)
1276     {
1277     case 1:
1278             mouse_button_state |= Button1Mask;
1279             break;
1280     case 2:
1281             mouse_button_state |= Button2Mask;
1282             break;
1283     case 3:
1284             mouse_button_state |= Button3Mask;
1285             break;
1286     case 4:
1287             mouse_button_state |= Button4Mask;
1288             break;
1289     case 5:
1290             mouse_button_state |= Button5Mask;
1291             break;
1292     }
1293
1294   last_mouse_pos->x = ((XButtonEvent *) xevent)->x_root;
1295   last_mouse_pos->y = ((XButtonEvent *) xevent)->y_root;
1296
1297 #ifdef SPI_DEBUG
1298   fprintf (stderr, "mouse button %d %s (%x)\n",
1299            xbutton_event->button,
1300            (xevent->type == ButtonPress) ? "Press" : "Release",
1301            mouse_button_state);
1302 #endif
1303   snprintf (event_detail, 3, "%d%c", button,
1304             (xevent->type == ButtonPress) ? 'p' : 'r');
1305
1306   /* TODO: FIXME distinguish between physical and logical buttons */
1307   mouse_e.type      = (xevent->type == ButtonPress) ?
1308                       Accessibility_BUTTON_PRESSED_EVENT :
1309                       Accessibility_BUTTON_RELEASED_EVENT;
1310   mouse_e.id        = button;
1311   mouse_e.hw_code   = button;
1312   mouse_e.modifiers = (dbus_uint16_t) xbutton_event->state;
1313   mouse_e.timestamp = (dbus_uint32_t) xbutton_event->time;
1314   mouse_e.event_string = "";
1315   mouse_e.is_text   = FALSE;
1316   if ((mouse_button_state & mouse_button_mask) !=
1317        (mouse_mask_state & mouse_button_mask))
1318     {
1319       if ((mouse_mask_state & key_modifier_mask) !=
1320           (mouse_button_state & key_modifier_mask))
1321         spi_dec_emit_modifier_event (controller,
1322                                      mouse_mask_state, mouse_button_state);
1323       mouse_mask_state = mouse_button_state;
1324       is_consumed =
1325         spi_controller_notify_mouselisteners (controller, &mouse_e);
1326       ix = last_mouse_pos->x;
1327       iy = last_mouse_pos->y;
1328       emit(controller, SPI_DBUS_INTERFACE_EVENT_MOUSE, "Button", event_detail, ix, iy);
1329     }
1330
1331   xkb_mod_unlatch_occurred = (xevent->type == ButtonPress ||
1332                               xevent->type == ButtonRelease);
1333
1334   /* if client wants to consume this event, and XKB latch state was
1335    *   unset by this button event, we reset it
1336    */
1337   if (is_consumed && xkb_mod_unlatch_occurred)
1338     spi_dec_set_unlatch_pending (controller, mouse_mask_state);
1339
1340   XAllowEvents (spi_get_display (),
1341                 (is_consumed) ? SyncPointer : ReplayPointer,
1342                 CurrentTime);
1343 }
1344
1345 static void
1346 global_filter_fn (XEvent *xevent, void *data)
1347 {
1348   SpiDEController *controller;
1349   DEControllerPrivateData *priv;
1350   Display *display = spi_get_display ();
1351   controller = SPI_DEVICE_EVENT_CONTROLLER (data);
1352   priv = (DEControllerPrivateData *)
1353           g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
1354
1355   if (xevent->type == MappingNotify)
1356     xmkeymap = NULL;
1357
1358   if (xevent->type == KeyPress || xevent->type == KeyRelease)
1359     {
1360       if (controller->xevie_display == NULL)
1361         {
1362           gboolean is_consumed;
1363
1364           is_consumed =
1365             spi_device_event_controller_forward_key_event (controller, xevent);
1366
1367           if (is_consumed)
1368             {
1369               int n_events;
1370               int i;
1371               XEvent next_event;
1372               n_events = XPending (display);
1373
1374 #ifdef SPI_KEYEVENT_DEBUG
1375               g_print ("Number of events pending: %d\n", n_events);
1376 #endif
1377               for (i = 0; i < n_events; i++)
1378                 {
1379                   XNextEvent (display, &next_event);
1380                   if (next_event.type != KeyPress &&
1381                       next_event.type != KeyRelease)
1382                         g_warning ("Unexpected event type %d in queue", next_event.type);
1383                  }
1384
1385               XAllowEvents (display, AsyncKeyboard, CurrentTime);
1386               if (n_events)
1387                 XUngrabKeyboard (display, CurrentTime);
1388             }
1389           else
1390             {
1391               if (xevent->type == KeyPress)
1392                 wait_for_release_event (xevent, controller);
1393               XAllowEvents (display, ReplayKeyboard, CurrentTime);
1394             }
1395         }
1396
1397       return;
1398     }
1399   if (xevent->type == ButtonPress || xevent->type == ButtonRelease)
1400     {
1401       spi_device_event_controller_forward_mouse_event (controller, xevent);
1402     }
1403   if (xevent->type == priv->xkb_base_event_code)
1404     {
1405       XkbAnyEvent * xkb_ev = (XkbAnyEvent *) xevent;
1406       /* ugly but probably necessary...*/
1407       XSynchronize (display, TRUE);
1408
1409       if (xkb_ev->xkb_type == XkbStateNotify)
1410         {
1411           XkbStateNotifyEvent *xkb_snev =
1412                   (XkbStateNotifyEvent *) xkb_ev;
1413           /* check the mouse, to catch mouse events grabbed by
1414            * another client; in case we should revert this XKB delatch
1415            */
1416           if (!priv->pending_xkb_mod_relatch_mask)
1417             {
1418               int x, y;
1419               gboolean moved;
1420               spi_dec_mouse_check (controller, &x, &y, &moved);
1421             }
1422           /* we check again, since the previous call may have
1423              changed this flag */
1424           if (priv->pending_xkb_mod_relatch_mask)
1425             {
1426               unsigned int feedback_mask;
1427 #ifdef SPI_XKB_DEBUG
1428               fprintf (stderr, "relatching %x\n",
1429                        priv->pending_xkb_mod_relatch_mask);
1430 #endif
1431               /* temporarily turn off the latch bell, if it's on */
1432               XkbGetControls (display,
1433                               XkbAccessXFeedbackMask,
1434                               priv->xkb_desc);
1435               feedback_mask = priv->xkb_desc->ctrls->ax_options;
1436               if (feedback_mask & XkbAX_StickyKeysFBMask)
1437               {
1438                 XkbControlsChangesRec changes = {XkbAccessXFeedbackMask,
1439                                                  0, False};
1440                 priv->xkb_desc->ctrls->ax_options
1441                               &= ~(XkbAX_StickyKeysFBMask);
1442                 XkbChangeControls (display, priv->xkb_desc, &changes);
1443               }
1444               /* TODO: account for lock as well as latch */
1445               XkbLatchModifiers (display,
1446                                  XkbUseCoreKbd,
1447                                  priv->pending_xkb_mod_relatch_mask,
1448                                  priv->pending_xkb_mod_relatch_mask);
1449               if (feedback_mask & XkbAX_StickyKeysFBMask)
1450               {
1451                 XkbControlsChangesRec changes = {XkbAccessXFeedbackMask,
1452                                                  0, False};
1453                 priv->xkb_desc->ctrls->ax_options = feedback_mask;
1454                 XkbChangeControls (display, priv->xkb_desc, &changes);
1455               }
1456 #ifdef SPI_XKB_DEBUG
1457               fprintf (stderr, "relatched %x\n",
1458                        priv->pending_xkb_mod_relatch_mask);
1459 #endif
1460               priv->pending_xkb_mod_relatch_mask = 0;
1461             }
1462           else
1463             {
1464               priv->xkb_latch_mask = xkb_snev->latched_mods;
1465             }
1466         }
1467       XSynchronize (display, FALSE);
1468     }
1469
1470   return;
1471 }
1472
1473 static int
1474 _spi_controller_device_error_handler (Display *display, XErrorEvent *error)
1475 {
1476   if (error->error_code == BadAccess)
1477     {
1478       g_message ("Could not complete key grab: grab already in use.\n");
1479       spi_error_code = BadAccess;
1480       return 0;
1481     }
1482   else
1483     {
1484       return (*x_default_error_handler) (display, error);
1485     }
1486 }
1487
1488 static void
1489 spi_controller_register_with_devices (SpiDEController *controller)
1490 {
1491   DEControllerPrivateData *priv;
1492   int event_base, error_base, major_version, minor_version;
1493
1494   priv = (DEControllerPrivateData *) g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
1495   if (XTestQueryExtension (spi_get_display(), &event_base, &error_base, &major_version, &minor_version))
1496     {
1497       XTestGrabControl (spi_get_display (), True);
1498     }
1499
1500   /* calls to device-specific implementations and routines go here */
1501   /* register with: keyboard hardware code handler */
1502   /* register with: (translated) keystroke handler */
1503
1504   priv->have_xkb = XkbQueryExtension (spi_get_display (),
1505                                       &priv->xkb_major_extension_opcode,
1506                                       &priv->xkb_base_event_code,
1507                                       &priv->xkb_base_error_code, NULL, NULL);
1508   if (priv->have_xkb)
1509     {
1510       gint i;
1511       guint64 reserved = 0;
1512       priv->xkb_desc = XkbGetMap (spi_get_display (), XkbKeySymsMask, XkbUseCoreKbd);
1513       XkbSelectEvents (spi_get_display (),
1514                        XkbUseCoreKbd,
1515                        XkbStateNotifyMask, XkbStateNotifyMask);
1516       _numlock_physical_mask = XkbKeysymToModifiers (spi_get_display (),
1517                                                      XK_Num_Lock);
1518       for (i = priv->xkb_desc->max_key_code; i >= priv->xkb_desc->min_key_code; --i)
1519       {
1520           if (priv->xkb_desc->map->key_sym_map[i].kt_index[0] == XkbOneLevelIndex)
1521           {
1522               if (XKeycodeToKeysym (spi_get_display (), i, 0) != 0)
1523               {
1524                   /* don't use this one if there's a grab client! */
1525
1526                   /* Runtime errors are generated from these functions,
1527                    * that are then quashed. Equivalent to:
1528                    * try
1529                    *   {Blah}
1530                    * except
1531                    *   {;}
1532                    */
1533
1534                   spi_x_error_trap ();
1535                   XGrabKey (spi_get_display (), i, 0,
1536                             spi_get_root_window (),
1537                             TRUE,
1538                             GrabModeSync, GrabModeSync);
1539                   XSync (spi_get_display (), TRUE);
1540                   XUngrabKey (spi_get_display (), i, 0,
1541                               spi_get_root_window ());
1542                   if (!spi_x_error_release ())
1543                   {
1544                       reserved = i;
1545                       break;
1546                   }
1547               }
1548           }
1549       }
1550       if (reserved)
1551       {
1552           priv->reserved_keycode = reserved;
1553           priv->reserved_keysym = XKeycodeToKeysym (spi_get_display (), reserved, 0);
1554       }
1555       else
1556       {
1557           priv->reserved_keycode = XKeysymToKeycode (spi_get_display (), XK_numbersign);
1558           priv->reserved_keysym = XK_numbersign;
1559       }
1560 #ifdef SPI_RESERVED_DEBUG
1561       unsigned sym = 0;
1562       sym = XKeycodeToKeysym (spi_get_display (), reserved, 0);
1563       fprintf (stderr, "%x\n", sym);
1564       fprintf (stderr, "setting the reserved keycode to %d (%s)\n",
1565                reserved,
1566                XKeysymToString (XKeycodeToKeysym (spi_get_display (),
1567                                                             reserved, 0)));
1568 #endif
1569     }
1570
1571   spi_set_filter (global_filter_fn, controller);
1572   spi_set_events (KeyPressMask | KeyReleaseMask);
1573
1574   x_default_error_handler = XSetErrorHandler (_spi_controller_device_error_handler);
1575 }
1576
1577 static gboolean
1578 spi_key_set_contains_key (GSList                          *key_set,
1579                           const Accessibility_DeviceEvent *key_event)
1580 {
1581   gint i;
1582   gint len;
1583   GSList *l;
1584
1585   if (!key_set)
1586     {
1587 #ifdef SPI_DEBUG
1588       g_print ("null key set!\n");
1589 #endif
1590       return TRUE;
1591     }
1592
1593   len = g_slist_length (key_set);
1594
1595   if (len == 0) /* special case, means "all keys/any key" */
1596     {
1597 #ifdef SPI_DEBUG
1598       g_print ("anykey\n");
1599 #endif
1600       return TRUE;
1601     }
1602
1603   for (l = key_set,i = 0; l; l = g_slist_next(l),i++)
1604     {
1605       Accessibility_KeyDefinition *kd = l->data;
1606 #ifdef SPI_KEYEVENT_DEBUG
1607       g_print ("key_set[%d] event = %d, code = %d; key_event %d, code %d, string %s\n",
1608                 i,
1609                 (int) kd->keysym,
1610                 (int) kd->keycode,
1611                 (int) key_event->id,
1612                 (int) key_event->hw_code,
1613                 key_event->event_string);
1614 #endif
1615       if (kd->keysym == (dbus_uint32_t) key_event->id)
1616         {
1617           return TRUE;
1618         }
1619       if (kd->keycode == (dbus_uint32_t) key_event->hw_code)
1620         {
1621           return TRUE;
1622         }
1623       if (key_event->event_string && key_event->event_string[0] &&
1624           !strcmp (kd->keystring, key_event->event_string))
1625         {
1626           return TRUE;
1627         }
1628     }
1629
1630   return FALSE;
1631 }
1632
1633 static gboolean
1634 spi_eventtype_seq_contains_event (dbus_uint32_t types,
1635                                   const Accessibility_DeviceEvent *event)
1636 {
1637   if (types == 0) /* special case, means "all events/any event" */
1638     {
1639       return TRUE;
1640     }
1641
1642   return (types & (1 << event->type));
1643 }
1644
1645 static gboolean
1646 spi_key_event_matches_listener (const Accessibility_DeviceEvent *key_event,
1647                                 DEControllerKeyListener         *listener,
1648                                 dbus_bool_t                    is_system_global)
1649 {
1650   if (((key_event->modifiers & 0xFF) == (dbus_uint16_t) (listener->mask & 0xFF)) &&
1651        spi_key_set_contains_key (listener->keys, key_event) &&
1652        spi_eventtype_seq_contains_event (listener->listener.types, key_event) &&
1653       (is_system_global == listener->mode->global))
1654     {
1655       return TRUE;
1656     }
1657   else
1658     {
1659       return FALSE;
1660     }
1661 }
1662
1663 static gboolean
1664 spi_controller_notify_keylisteners (SpiDEController                 *controller,
1665                                     Accessibility_DeviceEvent       *key_event,
1666                                     dbus_bool_t                    is_system_global)
1667 {
1668   GList   *l;
1669   GSList  *notify = NULL, *l2;
1670   GList  **key_listeners = &controller->key_listeners;
1671   gboolean is_consumed;
1672
1673   if (!key_listeners)
1674     {
1675       return FALSE;
1676     }
1677
1678   /* set the NUMLOCK event mask bit if appropriate: see bug #143702 */
1679   if (key_event->modifiers & _numlock_physical_mask)
1680       key_event->modifiers |= SPI_KEYMASK_NUMLOCK;
1681
1682   for (l = *key_listeners; l; l = l->next)
1683     {
1684        DEControllerKeyListener *key_listener = l->data;
1685
1686        if (spi_key_event_matches_listener (key_event, key_listener, is_system_global))
1687          {
1688            /* we clone (don't dup) the listener, to avoid refcount inc. */
1689            notify = g_slist_prepend (notify,
1690                                      spi_key_listener_clone (key_listener));
1691          }
1692     }
1693
1694 #ifdef SPI_KEYEVENT_DEBUG
1695   if (!notify)
1696     {
1697       g_print ("no match for event\n");
1698     }
1699 #endif
1700
1701   is_consumed = FALSE;
1702   for (l2 = notify; l2 && !is_consumed; l2 = l2->next)
1703     {
1704       DEControllerKeyListener *key_listener = l2->data;
1705
1706       is_consumed = Accessibility_DeviceEventListener_NotifyEvent (controller, controller->registry, &key_listener->listener, key_event) &&
1707                     key_listener->mode->preemptive;
1708
1709       spi_key_listener_clone_free (key_listener);
1710     }
1711
1712   for (; l2; l2 = l2->next)
1713     {
1714       DEControllerKeyListener *key_listener = l2->data;
1715       spi_key_listener_clone_free (key_listener);
1716       /* clone doesn't have its own ref, so don't use spi_dec_listener_free */
1717     }
1718
1719   g_slist_free (notify);
1720
1721 #ifdef SPI_DEBUG
1722   if (is_consumed) g_message ("consumed\n");
1723 #endif
1724   return is_consumed;
1725 }
1726
1727 static gboolean
1728 spi_clear_error_state (void)
1729 {
1730         gboolean retval = spi_error_code != 0;
1731         spi_error_code = 0;
1732         return retval;
1733 }
1734
1735 static Accessibility_DeviceEvent
1736 spi_keystroke_from_x_key_event (XKeyEvent *x_key_event)
1737 {
1738   Accessibility_DeviceEvent key_event;
1739   KeySym keysym;
1740   const int cbuf_bytes = 20;
1741   char cbuf [21];
1742   int nbytes;
1743
1744   nbytes = XLookupString (x_key_event, cbuf, cbuf_bytes, &keysym, NULL);
1745   key_event.id = (dbus_int32_t)(keysym);
1746   key_event.hw_code = (dbus_int16_t) x_key_event->keycode;
1747   if (((XEvent *) x_key_event)->type == KeyPress)
1748     {
1749       key_event.type = Accessibility_KEY_PRESSED_EVENT;
1750     }
1751   else
1752     {
1753       key_event.type = Accessibility_KEY_RELEASED_EVENT;
1754     }
1755   key_event.modifiers = (dbus_uint16_t)(x_key_event->state);
1756   key_event.is_text = FALSE;
1757   switch (keysym)
1758     {
1759       case ' ':
1760         key_event.event_string = g_strdup ("space");
1761         break;
1762       case XK_Tab:
1763         key_event.event_string = g_strdup ("Tab");
1764         break;
1765       case XK_BackSpace:
1766         key_event.event_string = g_strdup ("Backspace");
1767         break;
1768       case XK_Return:
1769         key_event.event_string = g_strdup ("Return");
1770         break;
1771       case XK_Home:
1772         key_event.event_string = g_strdup ("Home");
1773         break;
1774       case XK_Page_Down:
1775         key_event.event_string = g_strdup ("Page_Down");
1776         break;
1777       case XK_Page_Up:
1778         key_event.event_string = g_strdup ("Page_Up");
1779         break;
1780       case XK_F1:
1781         key_event.event_string = g_strdup ("F1");
1782         break;
1783       case XK_F2:
1784         key_event.event_string = g_strdup ("F2");
1785         break;
1786       case XK_F3:
1787         key_event.event_string = g_strdup ("F3");
1788         break;
1789       case XK_F4:
1790         key_event.event_string = g_strdup ("F4");
1791         break;
1792       case XK_F5:
1793         key_event.event_string = g_strdup ("F5");
1794         break;
1795       case XK_F6:
1796         key_event.event_string = g_strdup ("F6");
1797         break;
1798       case XK_F7:
1799         key_event.event_string = g_strdup ("F7");
1800         break;
1801       case XK_F8:
1802         key_event.event_string = g_strdup ("F8");
1803         break;
1804       case XK_F9:
1805         key_event.event_string = g_strdup ("F9");
1806         break;
1807       case XK_F10:
1808         key_event.event_string = g_strdup ("F10");
1809         break;
1810       case XK_F11:
1811         key_event.event_string = g_strdup ("F11");
1812         break;
1813       case XK_F12:
1814         key_event.event_string = g_strdup ("F12");
1815         break;
1816       case XK_End:
1817         key_event.event_string = g_strdup ("End");
1818         break;
1819       case XK_Escape:
1820         key_event.event_string = g_strdup ("Escape");
1821         break;
1822       case XK_Up:
1823         key_event.event_string = g_strdup ("Up");
1824         break;
1825       case XK_Down:
1826         key_event.event_string = g_strdup ("Down");
1827         break;
1828       case XK_Left:
1829         key_event.event_string = g_strdup ("Left");
1830         break;
1831       case XK_Right:
1832         key_event.event_string = g_strdup ("Right");
1833         break;
1834       default:
1835         if (nbytes > 0)
1836           {
1837             gunichar c;
1838             cbuf[nbytes] = '\0'; /* OK since length is cbuf_bytes+1 */
1839             key_event.event_string = g_strdup (cbuf);
1840             c = keysym2ucs (keysym);
1841             if (c > 0 && !g_unichar_iscntrl (c))
1842               {
1843                 key_event.is_text = TRUE;
1844                 /* incorrect for some composed chars? */
1845               }
1846           }
1847         else
1848           {
1849             key_event.event_string = g_strdup ("");
1850           }
1851     }
1852
1853   key_event.timestamp = (dbus_uint32_t) x_key_event->time;
1854 #ifdef SPI_KEYEVENT_DEBUG
1855   {
1856     char *pressed_str  = "pressed";
1857     char *released_str = "released";
1858     char *state_ptr;
1859
1860     if (key_event.type == Accessibility_KEY_PRESSED_EVENT)
1861       state_ptr = pressed_str;
1862     else
1863       state_ptr = released_str;
1864
1865     fprintf (stderr,
1866              "Key %lu %s (%c), modifiers %d; string=%s [%x] %s\n",
1867              (unsigned long) keysym,
1868              state_ptr,
1869              keysym ? (int) keysym : '*',
1870              (int) x_key_event->state,
1871              key_event.event_string,
1872              key_event.event_string[0],
1873              (key_event.is_text == TRUE) ? "(text)" : "(not text)");
1874   }
1875 #endif
1876 #ifdef SPI_DEBUG
1877   fprintf (stderr, "%s%c\n",
1878      (x_key_event->state & Mod1Mask)?"Alt-":"",
1879      ((x_key_event->state & ShiftMask)^(x_key_event->state & LockMask))?
1880      g_ascii_toupper (keysym) : g_ascii_tolower (keysym));
1881   fprintf (stderr, "serial: %x Time: %x\n", x_key_event->serial, x_key_event->time);
1882 #endif /* SPI_DEBUG */
1883   return key_event;
1884 }
1885
1886 static gboolean
1887 spi_controller_update_key_grabs (SpiDEController           *controller,
1888                                  Accessibility_DeviceEvent *recv)
1889 {
1890   GList *l, *next;
1891   gboolean   update_failed = FALSE;
1892   KeyCode keycode = 0;
1893
1894   g_return_val_if_fail (controller != NULL, FALSE);
1895
1896   /*
1897    * masks known to work with default RH 7.1+:
1898    * 0 (no mods), LockMask, Mod1Mask, Mod2Mask, ShiftMask,
1899    * ShiftMask|LockMask, Mod1Mask|LockMask, Mod2Mask|LockMask,
1900    * ShiftMask|Mod1Mask, ShiftMask|Mod2Mask, Mod1Mask|Mod2Mask,
1901    * ShiftMask|LockMask|Mod1Mask, ShiftMask|LockMask|Mod2Mask,
1902    *
1903    * ControlMask grabs are broken, must be in use already
1904    */
1905   if (recv)
1906     keycode = keycode_for_keysym (controller, recv->id, NULL);
1907   for (l = controller->keygrabs_list; l; l = next)
1908     {
1909       gboolean do_remove;
1910       gboolean re_issue_grab;
1911       DEControllerGrabMask *grab_mask = l->data;
1912
1913       next = l->next;
1914
1915       re_issue_grab = recv &&
1916               (recv->modifiers & grab_mask->mod_mask) &&
1917               (grab_mask->key_val == keycode);
1918
1919 #ifdef SPI_DEBUG
1920       fprintf (stderr, "mask=%lx %lx (%c%c) %s\n",
1921                (long int) grab_mask->key_val,
1922                (long int) grab_mask->mod_mask,
1923                grab_mask->pending_add ? '+' : '.',
1924                grab_mask->pending_remove ? '-' : '.',
1925                re_issue_grab ? "re-issue": "");
1926 #endif
1927
1928       do_remove = FALSE;
1929
1930       if (grab_mask->pending_add && grab_mask->pending_remove)
1931         {
1932           do_remove = TRUE;
1933         }
1934       else if (grab_mask->pending_remove)
1935         {
1936 #ifdef SPI_DEBUG
1937       fprintf (stderr, "ungrabbing, mask=%x\n", grab_mask->mod_mask);
1938 #endif
1939           XUngrabKey (spi_get_display (),
1940                       grab_mask->key_val,
1941                       grab_mask->mod_mask,
1942                       spi_get_root_window ());
1943
1944           do_remove = TRUE;
1945         }
1946       else if (grab_mask->pending_add || re_issue_grab)
1947         {
1948
1949 #ifdef SPI_DEBUG
1950           fprintf (stderr, "grab %d with mask %x\n", grab_mask->key_val, grab_mask->mod_mask);
1951 #endif
1952           XGrabKey (spi_get_display (),
1953                     grab_mask->key_val,
1954                     grab_mask->mod_mask,
1955                     spi_get_root_window (),
1956                     True,
1957                     GrabModeSync,
1958                     GrabModeSync);
1959           XSync (spi_get_display (), False);
1960           update_failed = spi_clear_error_state ();
1961           if (update_failed) {
1962                   while (grab_mask->ref_count > 0) --grab_mask->ref_count;
1963                   do_remove = TRUE;
1964           }
1965         }
1966
1967       grab_mask->pending_add = FALSE;
1968       grab_mask->pending_remove = FALSE;
1969
1970       if (do_remove)
1971         {
1972           g_assert (grab_mask->ref_count <= 0);
1973
1974           controller->keygrabs_list = g_list_delete_link (
1975             controller->keygrabs_list, l);
1976
1977           spi_grab_mask_free (grab_mask);
1978         }
1979
1980     }
1981
1982   return ! update_failed;
1983 }
1984
1985 /*
1986  * Implemented GObject::finalize
1987  */
1988 static void
1989 spi_device_event_controller_object_finalize (GObject *object)
1990 {
1991   SpiDEController *controller;
1992   DEControllerPrivateData *private;
1993   controller = SPI_DEVICE_EVENT_CONTROLLER (object);
1994   GObjectClass *parent_class = G_OBJECT_CLASS(spi_device_event_controller_parent_class);
1995 #ifdef SPI_DEBUG
1996   fprintf(stderr, "spi_device_event_controller_object_finalize called\n");
1997 #endif
1998   /* disconnect any special listeners, get rid of outstanding keygrabs */
1999   XUngrabKey (spi_get_display (), AnyKey, AnyModifier, DefaultRootWindow (spi_get_display ()));
2000
2001 #ifdef HAVE_XEVIE
2002   if (controller->xevie_display != NULL)
2003     {
2004       XevieEnd(controller->xevie_display);
2005 #ifdef SPI_KEYEVENT_DEBUG
2006       printf("XevieEnd(dpy) finished \n");
2007 #endif
2008     }
2009 #endif
2010
2011   private = g_object_get_data (G_OBJECT (controller), "spi-dec-private");
2012   if (private->xkb_desc)
2013           XkbFreeKeyboard (private->xkb_desc, 0, True);
2014   g_free (private);
2015   parent_class->finalize (object);
2016 }
2017
2018 /*
2019  * DBus Accessibility::DEController::RegisterKeystrokeListener
2020  *     method implementation
2021  */
2022 static DBusMessage *
2023 impl_register_keystroke_listener (DBusConnection *bus,
2024                                   DBusMessage *message,
2025                                   void *user_data)
2026 {
2027   SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER(user_data);
2028   DEControllerKeyListener *dec_listener;
2029   DBusMessageIter iter, iter_array;
2030   const char *path;
2031   GSList *keys = NULL;
2032   dbus_int32_t mask, type;
2033   Accessibility_EventListenerMode *mode;
2034  dbus_bool_t ret;
2035   DBusMessage *reply = NULL;
2036   char *keystring;
2037
2038   if (strcmp (dbus_message_get_signature (message), "oa(iisi)uu(bbb)") != 0)
2039     return invalid_arguments_error (message);
2040
2041   dbus_message_iter_init(message, &iter);
2042   dbus_message_iter_get_basic(&iter, &path);
2043   dbus_message_iter_next(&iter);
2044   dbus_message_iter_recurse(&iter, &iter_array);
2045   while (dbus_message_iter_get_arg_type(&iter_array) != DBUS_TYPE_INVALID)
2046   {
2047     Accessibility_KeyDefinition *kd = (Accessibility_KeyDefinition *)g_malloc(sizeof(Accessibility_KeyDefinition));
2048     if (!spi_dbus_message_iter_get_struct(&iter_array, DBUS_TYPE_INT32, &kd->keycode, DBUS_TYPE_INT32, &kd->keysym, DBUS_TYPE_STRING, &keystring, DBUS_TYPE_INVALID))
2049     {
2050       break;
2051     }
2052     kd->keystring = g_strdup (keystring);
2053     keys = g_slist_append(keys, kd);
2054   }
2055   dbus_message_iter_next(&iter);
2056   dbus_message_iter_get_basic(&iter, &mask);
2057   dbus_message_iter_next(&iter);
2058   dbus_message_iter_get_basic(&iter, &type);
2059   dbus_message_iter_next(&iter);
2060   mode = (Accessibility_EventListenerMode *)g_malloc(sizeof(Accessibility_EventListenerMode));
2061   if (mode)
2062   {
2063     spi_dbus_message_iter_get_struct(&iter, DBUS_TYPE_BOOLEAN, &mode->synchronous, DBUS_TYPE_BOOLEAN, &mode->preemptive, DBUS_TYPE_BOOLEAN, &mode->global, DBUS_TYPE_INVALID);
2064   }
2065 #ifdef SPI_DEBUG
2066   fprintf (stderr, "registering keystroke listener %s:%s with maskVal %lu\n",
2067            dbus_message_get_sender(message), path, (unsigned long) mask);
2068 #endif
2069   dec_listener = spi_dec_key_listener_new (dbus_message_get_sender(message), path, keys, mask, type, mode);
2070   g_free (mode);
2071   ret = spi_controller_register_device_listener (
2072           controller, (DEControllerListener *) dec_listener);
2073   reply = dbus_message_new_method_return (message);
2074   if (reply)
2075   {
2076     dbus_message_append_args (reply, DBUS_TYPE_BOOLEAN, &ret, DBUS_TYPE_INVALID);
2077   }
2078   return reply;
2079 }
2080
2081 /*
2082  * DBus Accessibility::DEController::RegisterDeviceEventListener
2083  *     method implementation
2084  */
2085 static DBusMessage *
2086 impl_register_device_event_listener (DBusConnection *bus,
2087                                   DBusMessage *message,
2088                                   void *user_data)
2089 {
2090   SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER(user_data);
2091   DEControllerListener *dec_listener;
2092   DBusError error;
2093   const char *path;
2094   dbus_int32_t event_types;
2095   dbus_bool_t ret;
2096   DBusMessage *reply = NULL;
2097
2098   dbus_error_init(&error);
2099   if (!dbus_message_get_args(message, &error, DBUS_TYPE_OBJECT_PATH, &path, DBUS_TYPE_UINT32, &event_types, DBUS_TYPE_INVALID))
2100   {
2101     return invalid_arguments_error (message);
2102   }
2103   dec_listener = spi_dec_listener_new (dbus_message_get_sender(message), path, event_types);
2104   ret =  spi_controller_register_device_listener (
2105           controller, (DEControllerListener *) dec_listener);
2106   reply = dbus_message_new_method_return (message);
2107   if (reply)
2108   {
2109     dbus_message_append_args (reply, DBUS_TYPE_BOOLEAN, &ret, DBUS_TYPE_INVALID);
2110   }
2111   return reply;
2112 }
2113
2114 typedef struct {
2115         DBusConnection *bus;
2116         DEControllerListener    *listener;
2117 } RemoveListenerClosure;
2118
2119 static SpiReEntrantContinue
2120 remove_listener_cb (GList * const *list,
2121                     gpointer       user_data)
2122 {
2123   DEControllerListener  *listener = (*list)->data;
2124   RemoveListenerClosure *ctx = user_data;
2125
2126   if (!strcmp(ctx->listener->bus_name, listener->bus_name) &&
2127       !strcmp(ctx->listener->path, listener->path))
2128     {
2129       spi_re_entrant_list_delete_link (list);
2130       spi_dbus_remove_disconnect_match (ctx->bus, listener->bus_name);
2131       spi_dec_listener_free (listener);
2132     }
2133
2134   return SPI_RE_ENTRANT_CONTINUE;
2135 }
2136
2137 static SpiReEntrantContinue
2138 copy_key_listener_cb (GList * const *list,
2139                       gpointer       user_data)
2140 {
2141   DEControllerKeyListener  *key_listener = (*list)->data;
2142   RemoveListenerClosure    *ctx = user_data;
2143
2144   if (!strcmp(ctx->listener->bus_name, key_listener->listener.bus_name) &&
2145       !strcmp(ctx->listener->path, key_listener->listener.path))
2146     {
2147       /* TODO: FIXME aggregate keys in case the listener is registered twice */
2148       DEControllerKeyListener *ctx_key_listener =
2149         (DEControllerKeyListener *) ctx->listener;
2150       keylist_free (ctx_key_listener->keys);
2151       ctx_key_listener->keys = keylist_clone(key_listener->keys);
2152     }
2153
2154   return SPI_RE_ENTRANT_CONTINUE;
2155 }
2156
2157 static void
2158 spi_controller_deregister_device_listener (SpiDEController            *controller,
2159                                            DEControllerListener *listener)
2160 {
2161   RemoveListenerClosure  ctx;
2162
2163   ctx.bus = controller->bus;
2164   ctx.listener = listener;
2165
2166   notify_mouse_listener (controller, listener, FALSE);
2167
2168   spi_re_entrant_list_foreach (&controller->mouse_listeners,
2169                                remove_listener_cb, &ctx);
2170   if (!controller->mouse_listeners)
2171     have_mouse_listener = FALSE;
2172 }
2173
2174 static void
2175 spi_deregister_controller_key_listener (SpiDEController            *controller,
2176                                         DEControllerKeyListener    *key_listener)
2177 {
2178   RemoveListenerClosure  ctx;
2179
2180   ctx.bus = controller->bus;
2181   ctx.listener = (DEControllerListener *) spi_key_listener_clone (key_listener);
2182
2183   notify_keystroke_listener (controller, key_listener, FALSE);
2184
2185   /* special case, copy keyset from existing controller list entry */
2186   if (g_slist_length(key_listener->keys) == 0)
2187     {
2188       spi_re_entrant_list_foreach (&controller->key_listeners,
2189                                   copy_key_listener_cb, &ctx);
2190     }
2191
2192   spi_controller_deregister_global_keygrabs (controller, key_listener);
2193
2194   spi_re_entrant_list_foreach (&controller->key_listeners,
2195                                 remove_listener_cb, &ctx);
2196
2197   spi_key_listener_clone_free ((DEControllerKeyListener *) ctx.listener);
2198 }
2199
2200 void
2201 spi_remove_device_listeners (SpiDEController *controller, const char *bus_name)
2202 {
2203   GList *l, *tmp;
2204
2205   for (l = controller->mouse_listeners; l; l = tmp)
2206   {
2207     DEControllerListener *listener = l->data;
2208     tmp = l->next;
2209     if (!strcmp (listener->bus_name, bus_name))
2210     {
2211       spi_controller_deregister_device_listener (controller, listener);
2212       tmp = controller->mouse_listeners;
2213     }
2214   }
2215   for (l = controller->key_listeners; l; l = tmp)
2216   {
2217     DEControllerKeyListener *key_listener = l->data;
2218     tmp = l->next;
2219     if (!strcmp (key_listener->listener.bus_name, bus_name))
2220     {
2221       /* TODO: untangle the below line(s) */
2222       spi_deregister_controller_key_listener (controller, key_listener);
2223       tmp = controller->key_listeners;
2224     }
2225   }
2226 }
2227
2228 /*
2229  * DBus Accessibility::DEController::DeregisterKeystrokeListener
2230  *     method implementation
2231  */
2232 static DBusMessage *
2233 impl_deregister_keystroke_listener (DBusConnection *bus,
2234                                   DBusMessage *message,
2235                                   void *user_data)
2236 {
2237   SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER(user_data);
2238   DEControllerKeyListener *key_listener;
2239   DBusMessageIter iter, iter_array;
2240   const char *path;
2241   GSList *keys = NULL;
2242   dbus_int32_t mask, type;
2243   DBusMessage *reply = NULL;
2244
2245   dbus_message_iter_init(message, &iter);
2246   if (strcmp (dbus_message_get_signature (message), "oa(iisi)uu") != 0)
2247   dbus_message_iter_get_basic(&iter, &path);
2248   dbus_message_iter_next(&iter);
2249   dbus_message_iter_recurse(&iter, &iter_array);
2250   while (dbus_message_iter_get_arg_type(&iter_array) != DBUS_TYPE_INVALID)
2251   {
2252     Accessibility_KeyDefinition *kd = (Accessibility_KeyDefinition *)g_malloc(sizeof(Accessibility_KeyDefinition));
2253   char *keystring;
2254
2255     if (!spi_dbus_message_iter_get_struct(&iter_array, DBUS_TYPE_INT32, &kd->keycode, DBUS_TYPE_INT32, &kd->keysym, DBUS_TYPE_STRING, &keystring, DBUS_TYPE_INVALID))
2256     {
2257       break;
2258     }
2259     kd->keystring = g_strdup (keystring);
2260     keys = g_slist_append(keys, kd);
2261   }
2262   dbus_message_iter_next(&iter);
2263   dbus_message_iter_get_basic(&iter, &mask);
2264   dbus_message_iter_next(&iter);
2265   dbus_message_iter_get_basic(&iter, &type);
2266   dbus_message_iter_next(&iter);
2267   key_listener = spi_dec_key_listener_new (dbus_message_get_sender(message), path, keys, mask, type, NULL);
2268 #ifdef SPI_DEREGISTER_DEBUG
2269   fprintf (stderr, "deregistering keystroke listener %p with maskVal %lu\n",
2270            (void *) l, (unsigned long) mask->value);
2271 #endif
2272
2273   spi_deregister_controller_key_listener (controller, key_listener);
2274
2275   spi_dec_listener_free ((DEControllerListener *) key_listener);
2276   reply = dbus_message_new_method_return (message);
2277   return reply;
2278 }
2279
2280 /*
2281  * DBus Accessibility::DEController::DeregisterDeviceEventListener
2282  *     method implementation
2283  */
2284 static DBusMessage *
2285 impl_deregister_device_event_listener (DBusConnection *bus,
2286                                   DBusMessage *message,
2287                                   void *user_data)
2288 {
2289   SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER(user_data);
2290   DEControllerListener *listener;
2291   DBusError error;
2292   const char *path;
2293   dbus_int32_t event_types;
2294   DBusMessage *reply = NULL;
2295
2296   dbus_error_init(&error);
2297   if (!dbus_message_get_args(message, &error, DBUS_TYPE_OBJECT_PATH, &path, DBUS_TYPE_UINT32, &event_types, DBUS_TYPE_INVALID))
2298   {
2299     return invalid_arguments_error (message);
2300   }
2301   listener = spi_dec_listener_new (dbus_message_get_sender(message), path, event_types);
2302   spi_controller_deregister_device_listener (
2303           controller, listener);
2304   reply = dbus_message_new_method_return (message);
2305   return reply;
2306 }
2307
2308 static DBusMessage *
2309 impl_get_keystroke_listeners (DBusConnection *bus,
2310                                   DBusMessage *message,
2311                                   void *user_data)
2312 {
2313   SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER(user_data);
2314   DEControllerKeyListener *dec_listener;
2315   DBusMessageIter iter, iter_array;
2316   DBusMessage *reply = dbus_message_new_method_return (message);
2317   GList *l;
2318
2319   if (!reply)
2320     return NULL;
2321
2322   dbus_message_iter_init_append (reply, &iter);
2323   dbus_message_iter_open_container (&iter, DBUS_TYPE_ARRAY,
2324                                     "(souua(iisi)u(bbb))", &iter_array);
2325   for (l = controller->key_listeners; l; l = l->next)
2326   {
2327     append_keystroke_listener (&iter_array, l->data);
2328   }
2329   dbus_message_iter_close_container (&iter, &iter_array);
2330   return reply;
2331 }
2332
2333 static DBusMessage *
2334 impl_get_device_event_listeners (DBusConnection *bus,
2335                                   DBusMessage *message,
2336                                   void *user_data)
2337 {
2338   SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER(user_data);
2339   DEControllerKeyListener *dec_listener;
2340   DBusMessageIter iter, iter_array;
2341   GList *l;
2342   DBusMessage *reply = dbus_message_new_method_return (message);
2343
2344   if (!reply)
2345     return NULL;
2346
2347   dbus_message_iter_init_append (reply, &iter);
2348   dbus_message_iter_open_container (&iter, DBUS_TYPE_ARRAY,
2349                                     "(sou)", &iter_array);
2350   for (l = controller->key_listeners; l; l = l->next)
2351   {
2352     append_mouse_listener (&iter_array, l->data);
2353   }
2354   dbus_message_iter_close_container (&iter, &iter_array);
2355   return reply;
2356 }
2357
2358 static unsigned int dec_xkb_get_slowkeys_delay (SpiDEController *controller)
2359 {
2360   unsigned int retval = 0;
2361   DEControllerPrivateData *priv = (DEControllerPrivateData *)
2362           g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
2363 #ifdef HAVE_XKB
2364 #ifdef XKB_HAS_GET_SLOW_KEYS_DELAY
2365   retval = XkbGetSlowKeysDelay (spi_get_display (),
2366                                 XkbUseCoreKbd, &bounce_delay);
2367 #else
2368   if (!(priv->xkb_desc == (XkbDescPtr) BadAlloc || priv->xkb_desc == NULL))
2369     {
2370       Status s = XkbGetControls (spi_get_display (),
2371                                  XkbAllControlsMask, priv->xkb_desc);
2372       if (s == Success)
2373         {
2374          if (priv->xkb_desc->ctrls->enabled_ctrls & XkbSlowKeysMask)
2375                  retval = priv->xkb_desc->ctrls->slow_keys_delay;
2376         }
2377     }
2378 #endif
2379 #endif
2380 #ifdef SPI_XKB_DEBUG
2381         fprintf (stderr, "SlowKeys delay: %d\n", (int) retval);
2382 #endif
2383         return retval;
2384 }
2385
2386 static unsigned int dec_xkb_get_bouncekeys_delay (SpiDEController *controller)
2387 {
2388   unsigned int retval = 0;
2389   DEControllerPrivateData *priv = (DEControllerPrivateData *)
2390           g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
2391 #ifdef HAVE_XKB
2392 #ifdef XKB_HAS_GET_BOUNCE_KEYS_DELAY
2393   retval = XkbGetBounceKeysDelay (spi_get_display (),
2394                                   XkbUseCoreKbd, &bounce_delay);
2395 #else
2396   if (!(priv->xkb_desc == (XkbDescPtr) BadAlloc || priv->xkb_desc == NULL))
2397     {
2398       Status s = XkbGetControls (spi_get_display (),
2399                                  XkbAllControlsMask, priv->xkb_desc);
2400       if (s == Success)
2401         {
2402           if (priv->xkb_desc->ctrls->enabled_ctrls & XkbBounceKeysMask)
2403                   retval = priv->xkb_desc->ctrls->debounce_delay;
2404         }
2405     }
2406 #endif
2407 #endif
2408 #ifdef SPI_XKB_DEBUG
2409   fprintf (stderr, "BounceKeys delay: %d\n", (int) retval);
2410 #endif
2411   return retval;
2412 }
2413
2414 static gboolean
2415 dec_synth_keycode_press (SpiDEController *controller,
2416                          unsigned int keycode)
2417 {
2418         unsigned int time = CurrentTime;
2419         unsigned int bounce_delay;
2420         unsigned int elapsed_msec;
2421         struct timeval tv;
2422         DEControllerPrivateData *priv =
2423                 (DEControllerPrivateData *) g_object_get_qdata (G_OBJECT (controller),
2424                                                                 spi_dec_private_quark);
2425         if (keycode == priv->last_release_keycode)
2426         {
2427                 bounce_delay = dec_xkb_get_bouncekeys_delay (controller);
2428                 if (bounce_delay)
2429                 {
2430                         gettimeofday (&tv, NULL);
2431                         elapsed_msec =
2432                                 (tv.tv_sec - priv->last_release_time.tv_sec) * 1000
2433                                 + (tv.tv_usec - priv->last_release_time.tv_usec) / 1000;
2434 #ifdef SPI_XKB_DEBUG
2435                         fprintf (stderr, "%d ms elapsed (%ld usec)\n", elapsed_msec,
2436                                  (long) (tv.tv_usec - priv->last_release_time.tv_usec));
2437 #endif
2438 #ifdef THIS_IS_BROKEN
2439                         if (elapsed_msec < bounce_delay)
2440                                 time = bounce_delay - elapsed_msec + 1;
2441 #else
2442                         time = bounce_delay + 10;
2443                         /* fudge for broken XTest */
2444 #endif
2445 #ifdef SPI_XKB_DEBUG
2446                         fprintf (stderr, "waiting %d ms\n", time);
2447 #endif
2448                 }
2449         }
2450         XTestFakeKeyEvent (spi_get_display (), keycode, True, time);
2451         priv->last_press_keycode = keycode;
2452         XFlush (spi_get_display ());
2453         XSync (spi_get_display (), False);
2454         gettimeofday (&priv->last_press_time, NULL);
2455         return TRUE;
2456 }
2457
2458 static gboolean
2459 dec_synth_keycode_release (SpiDEController *controller,
2460                            unsigned int keycode)
2461 {
2462         unsigned int time = CurrentTime;
2463         unsigned int slow_delay;
2464         unsigned int elapsed_msec;
2465         struct timeval tv;
2466         DEControllerPrivateData *priv =
2467                 (DEControllerPrivateData *) g_object_get_qdata (G_OBJECT (controller),
2468                                                                 spi_dec_private_quark);
2469         if (keycode == priv->last_press_keycode)
2470         {
2471                 slow_delay = dec_xkb_get_slowkeys_delay (controller);
2472                 if (slow_delay)
2473                 {
2474                         gettimeofday (&tv, NULL);
2475                         elapsed_msec =
2476                                 (tv.tv_sec - priv->last_press_time.tv_sec) * 1000
2477                                 + (tv.tv_usec - priv->last_press_time.tv_usec) / 1000;
2478 #ifdef SPI_XKB_DEBUG
2479                         fprintf (stderr, "%d ms elapsed (%ld usec)\n", elapsed_msec,
2480                                  (long) (tv.tv_usec - priv->last_press_time.tv_usec));
2481 #endif
2482 #ifdef THIS_IS_BROKEN_DUNNO_WHY
2483                         if (elapsed_msec < slow_delay)
2484                                 time = slow_delay - elapsed_msec + 1;
2485 #else
2486                         time = slow_delay + 10;
2487                         /* our XTest seems broken, we have to add slop as above */
2488 #endif
2489 #ifdef SPI_XKB_DEBUG
2490                         fprintf (stderr, "waiting %d ms\n", time);
2491 #endif
2492                 }
2493         }
2494         XTestFakeKeyEvent (spi_get_display (), keycode, False, time);
2495         priv->last_release_keycode = keycode;
2496         XSync (spi_get_display (), False);
2497         gettimeofday (&priv->last_release_time, NULL);
2498         return TRUE;
2499 }
2500
2501 static unsigned
2502 dec_get_modifier_state (SpiDEController *controller)
2503 {
2504         return mouse_mask_state;
2505 }
2506
2507 static gboolean
2508 dec_lock_modifiers (SpiDEController *controller, unsigned modifiers)
2509 {
2510     DEControllerPrivateData *priv = (DEControllerPrivateData *)
2511     g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
2512
2513     if (priv->have_xkb) {
2514         return XkbLockModifiers (spi_get_display (), XkbUseCoreKbd,
2515                                   modifiers, modifiers);
2516     } else {
2517         int mod_index;
2518         for (mod_index=0;mod_index<8;mod_index++)
2519             if (modifiers & (1<<mod_index))
2520                 dec_synth_keycode_press(controller, xmkeymap->modifiermap[mod_index]);
2521         return TRUE;
2522     }
2523 }
2524
2525 static gboolean
2526 dec_unlock_modifiers (SpiDEController *controller, unsigned modifiers)
2527 {
2528     DEControllerPrivateData *priv = (DEControllerPrivateData *)
2529     g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
2530
2531     if (priv->have_xkb) {
2532         return XkbLockModifiers (spi_get_display (), XkbUseCoreKbd,
2533                                   modifiers, 0);
2534     } else {
2535         int mod_index;
2536         for (mod_index=0;mod_index<8;mod_index++)
2537             if (modifiers & (1<<mod_index))
2538                 dec_synth_keycode_release(controller, xmkeymap->modifiermap[mod_index]);
2539         return TRUE;
2540     }
2541 }
2542
2543 static KeySym
2544 dec_keysym_for_unichar (SpiDEController *controller, gunichar unichar)
2545 {
2546         return ucs2keysym ((long) unichar);
2547 }
2548
2549 static gboolean
2550 dec_synth_keysym (SpiDEController *controller, KeySym keysym)
2551 {
2552         KeyCode key_synth_code;
2553         unsigned int modifiers, synth_mods, lock_mods;
2554
2555         key_synth_code = keycode_for_keysym (controller, keysym, &synth_mods);
2556
2557         if ((key_synth_code == 0) || (synth_mods == 0xFF)) return FALSE;
2558
2559         /* TODO: set the modifiers accordingly! */
2560         modifiers = dec_get_modifier_state (controller);
2561         /* side-effect; we may unset mousebutton modifiers here! */
2562
2563         lock_mods = 0;
2564         if (synth_mods != modifiers) {
2565                 lock_mods = synth_mods & ~modifiers;
2566                 dec_lock_modifiers (controller, lock_mods);
2567         }
2568         dec_synth_keycode_press (controller, key_synth_code);
2569         dec_synth_keycode_release (controller, key_synth_code);
2570
2571         if (synth_mods != modifiers)
2572                 dec_unlock_modifiers (controller, lock_mods);
2573         return TRUE;
2574 }
2575
2576
2577 static gboolean
2578 dec_synth_keystring (SpiDEController *controller, const char *keystring)
2579 {
2580         /* probably we need to create and inject an XIM handler eventually. */
2581         /* for now, try to match the string to existing
2582          * keycode+modifier states.
2583          */
2584         KeySym *keysyms;
2585         gint maxlen = 0;
2586         gunichar unichar = 0;
2587         gint i = 0;
2588         gboolean retval = TRUE;
2589         const gchar *c;
2590
2591         maxlen = strlen (keystring) + 1;
2592         keysyms = g_new0 (KeySym, maxlen);
2593         if (!(keystring && *keystring && g_utf8_validate (keystring, -1, &c))) {
2594                 retval = FALSE;
2595         }
2596         else {
2597 #ifdef SPI_DEBUG
2598                 fprintf (stderr, "[keystring synthesis attempted on %s]\n", keystring);
2599 #endif
2600                 while (keystring && (unichar = g_utf8_get_char (keystring))) {
2601                         KeySym keysym;
2602                         char bytes[6];
2603                         gint mbytes;
2604
2605                         mbytes = g_unichar_to_utf8 (unichar, bytes);
2606                         bytes[mbytes] = '\0';
2607 #ifdef SPI_DEBUG
2608                         fprintf (stderr, "[unichar %s]", bytes);
2609 #endif
2610                         keysym = dec_keysym_for_unichar (controller, unichar);
2611                         if (keysym == NoSymbol) {
2612 #ifdef SPI_DEBUG
2613                                 fprintf (stderr, "no keysym for %s", bytes);
2614 #endif
2615                                 retval = FALSE;
2616                                 break;
2617                         }
2618                         keysyms[i++] = keysym;
2619                         keystring = g_utf8_next_char (keystring);
2620                 }
2621                 keysyms[i++] = 0;
2622                 XSynchronize (spi_get_display (), TRUE);
2623                 for (i = 0; keysyms[i]; ++i) {
2624                         if (!dec_synth_keysym (controller, keysyms[i])) {
2625 #ifdef SPI_DEBUG
2626                                 fprintf (stderr, "could not synthesize %c\n",
2627                                          (int) keysyms[i]);
2628 #endif
2629                                 retval = FALSE;
2630                                 break;
2631                         }
2632                 }
2633                 XSynchronize (spi_get_display (), FALSE);
2634         }
2635         g_free (keysyms);
2636
2637         return retval;
2638 }
2639
2640
2641 /*
2642  * DBus Accessibility::DEController::RegisterKeystrokeListener
2643  *     method implementation
2644  */
2645 static DBusMessage * impl_generate_keyboard_event (DBusConnection *bus, DBusMessage *message, void *user_data)
2646 {
2647   SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER(user_data);
2648   DBusError error;
2649   dbus_int32_t keycode;
2650   char *keystring;
2651   dbus_uint32_t synth_type;
2652   gint err;
2653   KeySym keysym;
2654   DEControllerPrivateData *priv;
2655   DBusMessage *reply = NULL;
2656
2657   dbus_error_init(&error);
2658   if (!dbus_message_get_args(message, &error, DBUS_TYPE_INT32, &keycode, DBUS_TYPE_STRING, &keystring, DBUS_TYPE_UINT32, &synth_type, DBUS_TYPE_INVALID))
2659   {
2660     return invalid_arguments_error (message);
2661   }
2662
2663 #ifdef SPI_DEBUG
2664         fprintf (stderr, "synthesizing keystroke %ld, type %d\n",
2665                  (long) keycode, (int) synth_type);
2666 #endif
2667   /* TODO: hide/wrap/remove X dependency */
2668
2669   /*
2670    * TODO: when initializing, query for XTest extension before using,
2671    * and fall back to XSendEvent() if XTest is not available.
2672    */
2673
2674   spi_x_error_trap ();
2675
2676   priv = (DEControllerPrivateData *)
2677       g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
2678
2679   if (!priv->have_xkb && xmkeymap==NULL) {
2680     xmkeymap = XGetModifierMapping(spi_get_display ());
2681   }
2682
2683   switch (synth_type)
2684     {
2685       case Accessibility_KEY_PRESS:
2686               dec_synth_keycode_press (controller, keycode);
2687               break;
2688       case Accessibility_KEY_PRESSRELEASE:
2689               dec_synth_keycode_press (controller, keycode);
2690       case Accessibility_KEY_RELEASE:
2691               dec_synth_keycode_release (controller, keycode);
2692               break;
2693       case Accessibility_KEY_SYM:
2694 #ifdef SPI_XKB_DEBUG
2695               fprintf (stderr, "KeySym synthesis\n");
2696 #endif
2697               /*
2698                * note: we are using long for 'keycode'
2699                * in our arg list; it can contain either
2700                * a keycode or a keysym.
2701                */
2702               dec_synth_keysym (controller, (KeySym) keycode);
2703               break;
2704       case Accessibility_KEY_STRING:
2705               if (!dec_synth_keystring (controller, keystring))
2706                       fprintf (stderr, "Keystring synthesis failure, string=%s\n",
2707                                keystring);
2708               break;
2709     }
2710   if (synth_type == Accessibility_KEY_SYM) {
2711     keysym = keycode;
2712   }
2713   else {
2714     keysym = XkbKeycodeToKeysym (spi_get_display (), keycode, 0, 0);
2715   }
2716   if (XkbKeysymToModifiers (spi_get_display (), keysym) == 0)
2717     {
2718       spi_dec_clear_unlatch_pending (controller);
2719     }
2720   reply = dbus_message_new_method_return (message);
2721   return reply;
2722 }
2723
2724 /* Accessibility::DEController::GenerateMouseEvent */
2725 static DBusMessage * impl_generate_mouse_event (DBusConnection *bus, DBusMessage *message, void *user_data)
2726 {
2727   DBusError error;
2728   dbus_int32_t       x;
2729   dbus_int32_t       y;
2730   char *eventName;
2731   DBusMessage *reply = NULL;
2732   int button = 0;
2733   gboolean err = FALSE;
2734   Display *display = spi_get_display ();
2735
2736   dbus_error_init (&error);
2737   if (!dbus_message_get_args(message, &error, DBUS_TYPE_INT32, &x, DBUS_TYPE_INT32, &y, DBUS_TYPE_STRING, &eventName, DBUS_TYPE_INVALID))
2738   {
2739     return invalid_arguments_error (message);
2740   }
2741
2742 #ifdef SPI_DEBUG
2743   fprintf (stderr, "generating mouse %s event at %ld, %ld\n",
2744            eventName, (long int) x, (long int) y);
2745 #endif
2746   switch (eventName[0])
2747     {
2748       case 'b':
2749         switch (eventName[1])
2750           {
2751           /* TODO: check number of buttons before parsing */
2752           case '1':
2753                     button = 1;
2754                     break;
2755           case '2':
2756                   button = 2;
2757                   break;
2758           case '3':
2759                   button = 3;
2760                   break;
2761           case '4':
2762                   button = 4;
2763                   break;
2764           case '5':
2765                   button = 5;
2766                   break;
2767           default:
2768                   err = TRUE;
2769           }
2770         if (!err)
2771           {
2772             if (x != -1 && y != -1)
2773               {
2774                 XTestFakeMotionEvent (display, DefaultScreen (display),
2775                                       x, y, 0);
2776               }
2777             XTestFakeButtonEvent (display, button, !(eventName[2] == 'r'), 0);
2778             if (eventName[2] == 'c')
2779               XTestFakeButtonEvent (display, button, FALSE, 1);
2780             else if (eventName[2] == 'd')
2781               {
2782               XTestFakeButtonEvent (display, button, FALSE, 1);
2783               XTestFakeButtonEvent (display, button, TRUE, 2);
2784               XTestFakeButtonEvent (display, button, FALSE, 3);
2785               }
2786           }
2787         break;
2788       case 'r': /* relative motion */
2789         XTestFakeRelativeMotionEvent (display, x, y, 0);
2790         break;
2791       case 'a': /* absolute motion */
2792         XTestFakeMotionEvent (display, DefaultScreen (display),
2793                               x, y, 0);
2794         break;
2795     }
2796   reply = dbus_message_new_method_return (message);
2797   return reply;
2798 }
2799
2800 /* Accessibility::DEController::NotifyListenersSync */
2801 static DBusMessage *
2802 impl_notify_listeners_sync (DBusConnection *bus, DBusMessage *message, void *user_data)
2803 {
2804   SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER(user_data);
2805   Accessibility_DeviceEvent event;
2806   dbus_bool_t ret;
2807   DBusMessage *reply = NULL;
2808
2809   if (!spi_dbus_demarshal_deviceEvent(message, &event))
2810   {
2811     return invalid_arguments_error (message);
2812   }
2813 #ifdef SPI_DEBUG
2814   g_print ("notifylistening listeners synchronously: controller %p, event id %d\n",
2815            controller, (int) event.id);
2816 #endif
2817   ret = spi_controller_notify_keylisteners (controller,
2818                                              (Accessibility_DeviceEvent *)
2819                                              &event, FALSE) ?
2820           TRUE : FALSE;
2821   reply = dbus_message_new_method_return (message);
2822   if (reply)
2823   {
2824     dbus_message_append_args (reply, DBUS_TYPE_BOOLEAN, &ret, DBUS_TYPE_INVALID);
2825   }
2826   return reply;
2827 }
2828
2829 static DBusMessage *
2830 impl_notify_listeners_async (DBusConnection *bus, DBusMessage *message, void *user_data)
2831 {
2832   SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER(user_data);
2833   Accessibility_DeviceEvent event;
2834   DBusMessage *reply = NULL;
2835
2836   if (!spi_dbus_demarshal_deviceEvent(message, &event))
2837   {
2838     return invalid_arguments_error (message);
2839   }
2840 #ifdef SPI_DEBUG
2841   g_print ("notifylistening listeners asynchronously: controller %p, event id %d\n",
2842            controller, (int) event.id);
2843 #endif
2844   spi_controller_notify_keylisteners (controller, (Accessibility_DeviceEvent *)
2845                                       &event, FALSE);
2846   reply = dbus_message_new_method_return (message);
2847   return reply;
2848 }
2849
2850 static void
2851 spi_device_event_controller_class_init (SpiDEControllerClass *klass)
2852 {
2853   GObjectClass * object_class = (GObjectClass *) klass;
2854
2855   spi_device_event_controller_parent_class = g_type_class_peek_parent (klass);
2856
2857   object_class->finalize = spi_device_event_controller_object_finalize;
2858
2859   if (!spi_dec_private_quark)
2860           spi_dec_private_quark = g_quark_from_static_string ("spi-dec-private");
2861 }
2862
2863 #ifdef HAVE_XEVIE
2864 static Bool isEvent(Display *dpy, XEvent *event, char *arg)
2865 {
2866    return TRUE;
2867 }
2868
2869 static gboolean
2870 handle_io (GIOChannel *source,
2871            GIOCondition condition,
2872            gpointer data)
2873 {
2874   SpiDEController *controller = (SpiDEController *) data;
2875   gboolean is_consumed = FALSE;
2876   XEvent ev;
2877
2878   while (XCheckIfEvent(controller->xevie_display, &ev, isEvent, NULL))
2879     {
2880       if (ev.type == KeyPress || ev.type == KeyRelease)
2881         is_consumed = spi_device_event_controller_forward_key_event (controller, &ev);
2882
2883       if (! is_consumed)
2884         XevieSendEvent(controller->xevie_display, &ev, XEVIE_UNMODIFIED);
2885     }
2886
2887   return TRUE;
2888 }
2889 #endif /* HAVE_XEVIE */
2890
2891 static void
2892 spi_device_event_controller_init (SpiDEController *device_event_controller)
2893 {
2894   spi_events_init (spi_get_display());
2895 #ifdef HAVE_XEVIE
2896   GIOChannel *ioc;
2897   int fd;
2898 #endif /* HAVE_XEVIE */
2899
2900   DEControllerPrivateData *private;
2901   device_event_controller->key_listeners   = NULL;
2902   device_event_controller->mouse_listeners = NULL;
2903   device_event_controller->keygrabs_list   = NULL;
2904   device_event_controller->xevie_display   = NULL;
2905
2906 #ifdef HAVE_XEVIE
2907   device_event_controller->xevie_display = XOpenDisplay(NULL);
2908
2909   if (XevieStart(device_event_controller->xevie_display) == TRUE)
2910     {
2911 #ifdef SPI_KEYEVENT_DEBUG
2912       fprintf (stderr, "XevieStart() success \n");
2913 #endif
2914       XevieSelectInput(device_event_controller->xevie_display, KeyPressMask | KeyReleaseMask);
2915
2916       fd = ConnectionNumber(device_event_controller->xevie_display);
2917       ioc = g_io_channel_unix_new (fd);
2918       g_io_add_watch (ioc, G_IO_IN | G_IO_HUP, handle_io, device_event_controller);
2919       g_io_channel_unref (ioc);
2920     }
2921   else
2922     {
2923       device_event_controller->xevie_display = NULL;
2924 #ifdef SPI_KEYEVENT_DEBUG
2925       fprintf (stderr, "XevieStart() failed, only one client is allowed to do event int exception\n");
2926 #endif
2927     }
2928 #endif /* HAVE_XEVIE */
2929
2930   private = g_new0 (DEControllerPrivateData, 1);
2931   gettimeofday (&private->last_press_time, NULL);
2932   gettimeofday (&private->last_release_time, NULL);
2933   g_object_set_qdata (G_OBJECT (device_event_controller),
2934                       spi_dec_private_quark,
2935                       private);
2936   spi_controller_register_with_devices (device_event_controller);
2937   device_event_controller->message_queue = g_queue_new ();
2938   saved_controller = device_event_controller;
2939 }
2940
2941 static gboolean
2942 spi_device_event_controller_forward_key_event (SpiDEController *controller,
2943                                                const XEvent    *event)
2944 {
2945   Accessibility_DeviceEvent key_event;
2946   gboolean ret;
2947
2948   g_assert (event->type == KeyPress || event->type == KeyRelease);
2949
2950   key_event = spi_keystroke_from_x_key_event ((XKeyEvent *) event);
2951
2952   if (controller->xevie_display == NULL)
2953     spi_controller_update_key_grabs (controller, &key_event);
2954
2955   /* relay to listeners, and decide whether to consume it or not */
2956   ret = spi_controller_notify_keylisteners (controller, &key_event, TRUE);
2957   g_free(key_event.event_string);
2958   return ret;
2959 }
2960
2961
2962 static gboolean
2963 is_key_released (KeyCode code)
2964 {
2965   char keys[32];
2966   int down;
2967
2968   XQueryKeymap (spi_get_display (), keys);
2969   down = BIT (keys, code);
2970   return (down == 0);
2971 }
2972
2973 static gboolean
2974 check_release (gpointer data)
2975 {
2976   gboolean released;
2977   Accessibility_DeviceEvent *event = (Accessibility_DeviceEvent *)data;
2978   KeyCode code = event->hw_code;
2979
2980   released = is_key_released (code);
2981
2982   if (released)
2983     {
2984       check_release_handler = 0;
2985       event->type = Accessibility_KEY_RELEASED_EVENT;
2986       spi_controller_notify_keylisteners (saved_controller, event, TRUE);
2987     }
2988   return (released == 0);
2989 }
2990
2991 static void wait_for_release_event (XEvent          *event,
2992                                     SpiDEController *controller)
2993 {
2994   pressed_event = spi_keystroke_from_x_key_event ((XKeyEvent *) event);
2995   check_release_handler = g_timeout_add (CHECK_RELEASE_DELAY, check_release, &pressed_event);
2996 }
2997
2998 /*---------------------------------------------------------------------------*/
2999
3000 static const char *introspection_header =
3001 "<?xml version=\"1.0\"?>\n";
3002
3003 static const char *introspection_node_element =
3004 "<node name=\"%s\">\n";
3005
3006 static const char *introspection_footer =
3007 "</node>";
3008
3009 static DBusMessage *
3010 impl_Introspect (DBusConnection * bus,
3011                  DBusMessage * message, void *user_data)
3012 {
3013   GString *output;
3014   gchar *final;
3015   gint i;
3016
3017   const gchar *pathstr = SPI_DBUS_PATH_DEC;
3018
3019   DBusMessage *reply;
3020
3021   output = g_string_new(introspection_header);
3022
3023   g_string_append_printf(output, introspection_node_element, pathstr);
3024
3025   g_string_append (output, spi_org_a11y_atspi_DeviceEventController);
3026
3027   g_string_append(output, introspection_footer);
3028   final = g_string_free(output, FALSE);
3029
3030   reply = dbus_message_new_method_return (message);
3031   dbus_message_append_args(reply, DBUS_TYPE_STRING, &final, DBUS_TYPE_INVALID);
3032
3033   g_free(final);
3034   return reply;
3035 }
3036
3037 /*---------------------------------------------------------------------------*/
3038
3039 static void
3040 handle_dec_method_from_idle (DBusConnection *bus, DBusMessage *message, void *user_data)
3041 {
3042   const gchar *iface   = dbus_message_get_interface (message);
3043   const gchar *member  = dbus_message_get_member (message);
3044   const gint   type    = dbus_message_get_type (message);
3045   DBusHandlerResult result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
3046   DBusMessage *reply = NULL;
3047
3048   if (!strcmp (iface, SPI_DBUS_INTERFACE_DEC))
3049     {
3050       result = DBUS_HANDLER_RESULT_HANDLED;
3051       if      (!strcmp (member, "RegisterKeystrokeListener"))
3052           reply = impl_register_keystroke_listener (bus, message, user_data);
3053       else if (!strcmp (member, "RegisterDeviceEventListener"))
3054           reply = impl_register_device_event_listener (bus, message, user_data);
3055       else if (!strcmp (member, "DeregisterKeystrokeListener"))
3056           reply = impl_deregister_keystroke_listener (bus, message, user_data);
3057       else if (!strcmp (member, "DeregisterDeviceEventListener"))
3058           reply = impl_deregister_device_event_listener (bus, message, user_data);
3059       else if (!strcmp (member, "GetKeystrokeListeners"))
3060           reply = impl_get_keystroke_listeners (bus, message, user_data);
3061       else if (!strcmp (member, "GetDeviceEventListeners"))
3062           reply = impl_get_device_event_listeners (bus, message, user_data);
3063       else if (!strcmp (member, "GenerateKeyboardEvent"))
3064           reply = impl_generate_keyboard_event (bus, message, user_data);
3065       else if (!strcmp (member, "GenerateMouseEvent"))
3066           reply = impl_generate_mouse_event (bus, message, user_data);
3067       else if (!strcmp (member, "NotifyListenersSync"))
3068           reply = impl_notify_listeners_sync (bus, message, user_data);
3069       else if (!strcmp (member, "NotifyListenersAsync"))
3070           reply = impl_notify_listeners_async (bus, message, user_data);
3071       else
3072           result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
3073     }
3074
3075   if (!strcmp (iface, "org.freedesktop.DBus.Introspectable"))
3076     {
3077       result = DBUS_HANDLER_RESULT_HANDLED;
3078       if      (!strcmp (member, "Introspect"))
3079           reply = impl_Introspect (bus, message, user_data);
3080       else
3081           result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
3082     }
3083
3084   if (result == DBUS_HANDLER_RESULT_HANDLED)
3085     {
3086       if (!reply)
3087         {
3088           reply = dbus_message_new_method_return (message);
3089         }
3090
3091       dbus_connection_send (bus, reply, NULL);
3092       dbus_message_unref (reply);
3093     }
3094 }
3095
3096 static gboolean
3097 message_queue_dispatch (gpointer data)
3098 {
3099   saved_controller->message_queue_idle = 0;
3100   while (!g_queue_is_empty (saved_controller->message_queue))
3101     {
3102       DBusMessage *message = g_queue_pop_head (saved_controller->message_queue);
3103       data = g_queue_pop_head (saved_controller->message_queue);
3104       handle_dec_method_from_idle (saved_controller->bus, message, data);
3105       dbus_message_unref (message);
3106     }
3107   return FALSE;
3108 }
3109
3110 static DBusHandlerResult
3111 handle_dec_method (DBusConnection *bus, DBusMessage *message, void *user_data)
3112 {
3113   const gchar *iface   = dbus_message_get_interface (message);
3114   const gchar *member  = dbus_message_get_member (message);
3115   const gint   type    = dbus_message_get_type (message);
3116
3117   /* Check for basic reasons not to handle */
3118   if (type   != DBUS_MESSAGE_TYPE_METHOD_CALL ||
3119       member == NULL ||
3120       iface  == NULL)
3121       return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
3122
3123   dbus_message_ref (message);
3124   g_queue_push_tail (saved_controller->message_queue, message);
3125   g_queue_push_tail (saved_controller->message_queue, user_data);
3126   if (!saved_controller->message_queue_idle)
3127     saved_controller->message_queue_idle = g_idle_add (message_queue_dispatch, NULL);
3128   return DBUS_HANDLER_RESULT_HANDLED;
3129 }
3130
3131 static DBusObjectPathVTable dec_vtable =
3132 {
3133   NULL,
3134   &handle_dec_method,
3135   NULL, NULL, NULL, NULL
3136 };
3137
3138 SpiDEController *
3139 spi_registry_dec_new (SpiRegistry *reg, DBusConnection *bus)
3140 {
3141   SpiDEController *dec = g_object_new (SPI_DEVICE_EVENT_CONTROLLER_TYPE, NULL);
3142
3143   dec->registry = g_object_ref (reg);
3144   reg->dec = g_object_ref (dec);
3145   dec->bus = bus;
3146
3147   dbus_connection_register_object_path (bus, SPI_DBUS_PATH_DEC, &dec_vtable, dec);
3148
3149   spi_dec_init_mouse_listener (dec);
3150
3151   return dec;
3152 }
3153
3154 void
3155 spi_device_event_controller_start_poll_mouse (SpiRegistry *registry)
3156 {
3157   if (!have_mouse_event_listener)
3158     {
3159       have_mouse_event_listener = TRUE;
3160       if (!have_mouse_listener)
3161       g_timeout_add (100, spi_dec_poll_mouse_idle, registry->dec);
3162     }
3163 }
3164
3165 void
3166 spi_device_event_controller_stop_poll_mouse (void)
3167 {
3168   have_mouse_event_listener = FALSE;
3169 }