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