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->listener.bus_name);
 841   g_free (key_listener->listener.path);
 842   g_free (key_listener);
 843 }
 844
 845 static void
 846 spi_key_listener_clone_free (DEControllerKeyListener *clone)
 847 {
 848   spi_key_listener_data_free (clone);
 849 }
 850
 851 static void
 852 spi_listener_clone_free (DEControllerListener *clone)
 853 {
 854   g_free (clone->path);
 855   g_free (clone->bus_name);
 856   g_free (clone);
 857 }
 858
 859 static void
 860 spi_dec_listener_free (DEControllerListener    *listener)
 861 {
 862   if (listener->type == SPI_DEVICE_TYPE_KBD)
 863     spi_key_listener_data_free ((DEControllerKeyListener *) listener);
 864   else
 865   {
 866     g_free (listener->bus_name);
 867     g_free (listener->path);
 868   }
 869 }
 870
 871 static void
 872 _register_keygrab (SpiDEController      *controller,
 873                    DEControllerGrabMask *grab_mask)
 874 {
 875   GList *l;
 876
 877   l = g_list_find_custom (controller->keygrabs_list, grab_mask,
 878                           spi_grab_mask_compare_values);
 879   if (l)
 880     {
 881       DEControllerGrabMask *cur_mask = l->data;
 882
 883       cur_mask->ref_count++;
 884       if (cur_mask->pending_remove)
 885         {
 886           cur_mask->pending_remove = FALSE;
 887         }
 888     }
 889   else
 890     {
 891       controller->keygrabs_list =
 892         g_list_prepend (controller->keygrabs_list,
 893                         spi_grab_mask_clone (grab_mask));
 894     }
 895 }
 896
 897 static void
 898 _deregister_keygrab (SpiDEController      *controller,
 899                      DEControllerGrabMask *grab_mask)
 900 {
 901   GList *l;
 902
 903   l = g_list_find_custom (controller->keygrabs_list, grab_mask,
 904                           spi_grab_mask_compare_values);
 905
 906   if (l)
 907     {
 908       DEControllerGrabMask *cur_mask = l->data;
 909
 910       cur_mask->ref_count--;
 911       if (cur_mask->ref_count <= 0)
 912         {
 913           cur_mask->pending_remove = TRUE;
 914         }
 915     }
 916 }
 917
 918 static void
 919 handle_keygrab (SpiDEController         *controller,
 920                 DEControllerKeyListener *key_listener,
 921                 void                   (*process_cb) (SpiDEController *controller,
 922                                                       DEControllerGrabMask *grab_mask))
 923 {
 924   DEControllerGrabMask grab_mask = { 0 };
 925
 926   grab_mask.mod_mask = key_listener->mask;
 927   if (g_slist_length (key_listener->keys) == 0) /* special case means AnyKey/AllKeys */
 928     {
 929       grab_mask.key_val = AnyKey;
 930 #ifdef SPI_DEBUG
 931       fprintf (stderr, "AnyKey grab!");
 932 #endif
 933       process_cb (controller, &grab_mask);
 934     }
 935   else
 936     {
 937       GSList *l;
 938
 939       for (l = key_listener->keys; l; l = g_slist_next(l))
 940         {
 941           Accessibility_KeyDefinition *keydef = l->data;
 942           long int key_val = keydef->keysym;
 943           /* X Grabs require keycodes, not keysyms */
 944           if (keydef->keystring && keydef->keystring[0])
 945             {
 946               key_val = XStringToKeysym(keydef->keystring);
 947             }
 948           if (key_val > 0)
 949             {
 950               key_val = XKeysymToKeycode (spi_get_display (), (KeySym) key_val);
 951             }
 952           else
 953             {
 954               key_val = keydef->keycode;
 955             }
 956           grab_mask.key_val = key_val;
 957           process_cb (controller, &grab_mask);
 958         }
 959     }
 960 }
 961
 962 static gboolean
 963 spi_controller_register_global_keygrabs (SpiDEController         *controller,
 964                                          DEControllerKeyListener *key_listener)
 965 {
 966   handle_keygrab (controller, key_listener, _register_keygrab);
 967   if (controller->xevie_display == NULL)
 968     return spi_controller_update_key_grabs (controller, NULL);
 969   else
 970     return TRUE;
 971 }
 972
 973 static void
 974 spi_controller_deregister_global_keygrabs (SpiDEController         *controller,
 975                                            DEControllerKeyListener *key_listener)
 976 {
 977   handle_keygrab (controller, key_listener, _deregister_keygrab);
 978   if (controller->xevie_display == NULL)
 979     spi_controller_update_key_grabs (controller, NULL);
 980 }
 981
 982 static gboolean
 983 spi_controller_register_device_listener (SpiDEController      *controller,
 984                                          DEControllerListener *listener)
 985 {
 986   DEControllerKeyListener *key_listener;
 987
 988   switch (listener->type) {
 989   case SPI_DEVICE_TYPE_KBD:
 990       key_listener = (DEControllerKeyListener *) listener;
 991
 992       controller->key_listeners = g_list_prepend (controller->key_listeners,
 993                                                   key_listener);
 994       spi_dbus_add_disconnect_match (controller->bus, key_listener->listener.bus_name);
 995       if (key_listener->mode->global)
 996         {
 997           return spi_controller_register_global_keygrabs (controller, key_listener);
 998         }
 999       else
1000               return TRUE;
1001       break;
1002   case SPI_DEVICE_TYPE_MOUSE:
1003       controller->mouse_listeners = g_list_prepend (controller->mouse_listeners, listener);
1004       if (!have_mouse_listener)
1005         {
1006           have_mouse_listener = TRUE;
1007           if (!have_mouse_event_listener)
1008             g_timeout_add (100, spi_dec_poll_mouse_idle, controller);
1009         }
1010       spi_dbus_add_disconnect_match (controller->bus, listener->bus_name);
1011       break;
1012   default:
1013       break;
1014   }
1015   return FALSE;
1016 }
1017
1018 static void
1019 set_reply (DBusPendingCall *pending, void *user_data)
1020 {
1021     void **replyptr = (void **)user_data;
1022
1023     *replyptr = dbus_pending_call_steal_reply (pending);
1024 }
1025
1026 static DBusMessage *
1027 send_and_allow_reentry (DBusConnection *bus, DBusMessage *message, int timeout, DBusError *error)
1028 {
1029     DBusPendingCall *pending;
1030     DBusMessage *reply = NULL;
1031
1032     if (!dbus_connection_send_with_reply (bus, message, &pending, -1))
1033     {
1034         return NULL;
1035     }
1036     dbus_pending_call_set_notify (pending, set_reply, (void *)&reply, NULL);
1037     while (!reply)
1038     {
1039       if (!dbus_connection_read_write_dispatch (bus, timeout))
1040         return NULL;
1041     }
1042     dbus_pending_call_unref (pending);
1043     return reply;
1044 }
1045 static gboolean
1046 Accessibility_DeviceEventListener_NotifyEvent(SpiDEController *controller,
1047                                               SpiRegistry *registry,
1048                                               DEControllerListener *listener,
1049                                               const Accessibility_DeviceEvent *key_event)
1050 {
1051   DBusMessage *message = dbus_message_new_method_call(listener->bus_name,
1052                                                       listener->path,
1053                                                       SPI_DBUS_INTERFACE_DEVICE_EVENT_LISTENER,
1054                                                       "NotifyEvent");
1055   DBusError error;
1056   dbus_bool_t consumed = FALSE;
1057
1058   dbus_error_init(&error);
1059   if (spi_dbus_marshal_deviceEvent(message, key_event))
1060   {
1061     DBusMessage *reply = send_and_allow_reentry (controller->bus, message, 1000, &error);
1062     if (reply)
1063     {
1064       DBusError error;
1065       dbus_error_init(&error);
1066       dbus_message_get_args(reply, &error, DBUS_TYPE_BOOLEAN, &consumed, DBUS_TYPE_INVALID);
1067       dbus_message_unref(reply);
1068     }
1069   }
1070   dbus_message_unref(message);
1071   return consumed;
1072 }
1073
1074 static gboolean
1075 spi_controller_notify_mouselisteners (SpiDEController                 *controller,
1076                                       const Accessibility_DeviceEvent *event)
1077 {
1078   GList   *l;
1079   GSList  *notify = NULL, *l2;
1080   GList  **listeners = &controller->mouse_listeners;
1081   gboolean is_consumed;
1082 #ifdef SPI_KEYEVENT_DEBUG
1083   gboolean found = FALSE;
1084 #endif
1085   if (!listeners)
1086     {
1087       return FALSE;
1088     }
1089
1090   for (l = *listeners; l; l = l->next)
1091     {
1092        DEControllerListener *listener = l->data;
1093
1094        if (spi_eventtype_seq_contains_event (listener->types, event))
1095          {
1096            /* we clone (don't dup) the listener, to avoid refcount inc. */
1097            notify = g_slist_prepend (notify,
1098                                      spi_listener_clone (listener));
1099 #ifdef SPI_KEYEVENT_DEBUG
1100            found = TRUE;
1101 #endif
1102          }
1103     }
1104
1105 #ifdef SPI_KEYEVENT_DEBUG
1106   if (!found)
1107     {
1108       g_print ("no match for event\n");
1109     }
1110 #endif
1111
1112   is_consumed = FALSE;
1113   for (l2 = notify; l2 && !is_consumed; l2 = l2->next)
1114     {
1115       DEControllerListener *listener = l2->data;
1116
1117       is_consumed = Accessibility_DeviceEventListener_NotifyEvent (controller, controller->registry, listener, event);
1118
1119       spi_listener_clone_free ((DEControllerListener *) l2->data);
1120     }
1121
1122   for (; l2; l2 = l2->next)
1123     {
1124       DEControllerListener *listener = l2->data;
1125       spi_listener_clone_free (listener);
1126       /* clone doesn't have its own ref, so don't use spi_device_listener_free */
1127     }
1128
1129   g_slist_free (notify);
1130
1131 #ifdef SPI_DEBUG
1132   if (is_consumed) g_message ("consumed\n");
1133 #endif
1134   return is_consumed;
1135 }
1136
1137 static void
1138 spi_device_event_controller_forward_mouse_event (SpiDEController *controller,
1139                                                  XEvent *xevent)
1140 {
1141   Accessibility_DeviceEvent mouse_e;
1142   gchar event_detail[3];
1143   gboolean is_consumed = FALSE;
1144   gboolean xkb_mod_unlatch_occurred;
1145   XButtonEvent *xbutton_event = (XButtonEvent *) xevent;
1146   dbus_uint32_t ix, iy;
1147
1148   int button = xbutton_event->button;
1149
1150   unsigned int mouse_button_state = xbutton_event->state;
1151
1152   switch (button)
1153     {
1154     case 1:
1155             mouse_button_state |= Button1Mask;
1156             break;
1157     case 2:
1158             mouse_button_state |= Button2Mask;
1159             break;
1160     case 3:
1161             mouse_button_state |= Button3Mask;
1162             break;
1163     case 4:
1164             mouse_button_state |= Button4Mask;
1165             break;
1166     case 5:
1167             mouse_button_state |= Button5Mask;
1168             break;
1169     }
1170
1171   last_mouse_pos->x = ((XButtonEvent *) xevent)->x_root;
1172   last_mouse_pos->y = ((XButtonEvent *) xevent)->y_root;
1173
1174 #ifdef SPI_DEBUG
1175   fprintf (stderr, "mouse button %d %s (%x)\n",
1176            xbutton_event->button,
1177            (xevent->type == ButtonPress) ? "Press" : "Release",
1178            mouse_button_state);
1179 #endif
1180   snprintf (event_detail, 3, "%d%c", button,
1181             (xevent->type == ButtonPress) ? 'p' : 'r');
1182
1183   /* TODO: FIXME distinguish between physical and logical buttons */
1184   mouse_e.type      = (xevent->type == ButtonPress) ?
1185                       Accessibility_BUTTON_PRESSED_EVENT :
1186                       Accessibility_BUTTON_RELEASED_EVENT;
1187   mouse_e.id        = button;
1188   mouse_e.hw_code   = button;
1189   mouse_e.modifiers = (dbus_uint16_t) xbutton_event->state;
1190   mouse_e.timestamp = (dbus_uint32_t) xbutton_event->time;
1191   mouse_e.event_string = "";
1192   mouse_e.is_text   = FALSE;
1193   if ((mouse_button_state & mouse_button_mask) !=
1194        (mouse_mask_state & mouse_button_mask))
1195     {
1196       if ((mouse_mask_state & key_modifier_mask) !=
1197           (mouse_button_state & key_modifier_mask))
1198         spi_dec_emit_modifier_event (controller,
1199                                      mouse_mask_state, mouse_button_state);
1200       mouse_mask_state = mouse_button_state;
1201       is_consumed =
1202         spi_controller_notify_mouselisteners (controller, &mouse_e);
1203       ix = last_mouse_pos->x;
1204       iy = last_mouse_pos->y;
1205       emit(controller, SPI_DBUS_INTERFACE_EVENT_MOUSE, "Button", event_detail, ix, iy);
1206     }
1207
1208   xkb_mod_unlatch_occurred = (xevent->type == ButtonPress ||
1209                               xevent->type == ButtonRelease);
1210
1211   /* if client wants to consume this event, and XKB latch state was
1212    *   unset by this button event, we reset it
1213    */
1214   if (is_consumed && xkb_mod_unlatch_occurred)
1215     spi_dec_set_unlatch_pending (controller, mouse_mask_state);
1216
1217   XAllowEvents (spi_get_display (),
1218                 (is_consumed) ? SyncPointer : ReplayPointer,
1219                 CurrentTime);
1220 }
1221
1222 static void
1223 global_filter_fn (XEvent *xevent, void *data)
1224 {
1225   SpiDEController *controller;
1226   DEControllerPrivateData *priv;
1227   Display *display = spi_get_display ();
1228   controller = SPI_DEVICE_EVENT_CONTROLLER (data);
1229   priv = (DEControllerPrivateData *)
1230           g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
1231
1232   if (xevent->type == MappingNotify)
1233     xmkeymap = NULL;
1234
1235   if (xevent->type == KeyPress || xevent->type == KeyRelease)
1236     {
1237       if (controller->xevie_display == NULL)
1238         {
1239           gboolean is_consumed;
1240
1241           is_consumed =
1242             spi_device_event_controller_forward_key_event (controller, xevent);
1243
1244           if (is_consumed)
1245             {
1246               int n_events;
1247               int i;
1248               XEvent next_event;
1249               n_events = XPending (display);
1250
1251 #ifdef SPI_KEYEVENT_DEBUG
1252               g_print ("Number of events pending: %d\n", n_events);
1253 #endif
1254               for (i = 0; i < n_events; i++)
1255                 {
1256                   XNextEvent (display, &next_event);
1257                   if (next_event.type != KeyPress &&
1258                       next_event.type != KeyRelease)
1259                         g_warning ("Unexpected event type %d in queue", next_event.type);
1260                  }
1261
1262               XAllowEvents (display, AsyncKeyboard, CurrentTime);
1263               if (n_events)
1264                 XUngrabKeyboard (display, CurrentTime);
1265             }
1266           else
1267             {
1268               if (xevent->type == KeyPress)
1269                 wait_for_release_event (xevent, controller);
1270               XAllowEvents (display, ReplayKeyboard, CurrentTime);
1271             }
1272         }
1273
1274       return;
1275     }
1276   if (xevent->type == ButtonPress || xevent->type == ButtonRelease)
1277     {
1278       spi_device_event_controller_forward_mouse_event (controller, xevent);
1279     }
1280   if (xevent->type == priv->xkb_base_event_code)
1281     {
1282       XkbAnyEvent * xkb_ev = (XkbAnyEvent *) xevent;
1283       /* ugly but probably necessary...*/
1284       XSynchronize (display, TRUE);
1285
1286       if (xkb_ev->xkb_type == XkbStateNotify)
1287         {
1288           XkbStateNotifyEvent *xkb_snev =
1289                   (XkbStateNotifyEvent *) xkb_ev;
1290           /* check the mouse, to catch mouse events grabbed by
1291            * another client; in case we should revert this XKB delatch
1292            */
1293           if (!priv->pending_xkb_mod_relatch_mask)
1294             {
1295               int x, y;
1296               gboolean moved;
1297               spi_dec_mouse_check (controller, &x, &y, &moved);
1298             }
1299           /* we check again, since the previous call may have
1300              changed this flag */
1301           if (priv->pending_xkb_mod_relatch_mask)
1302             {
1303               unsigned int feedback_mask;
1304 #ifdef SPI_XKB_DEBUG
1305               fprintf (stderr, "relatching %x\n",
1306                        priv->pending_xkb_mod_relatch_mask);
1307 #endif
1308               /* temporarily turn off the latch bell, if it's on */
1309               XkbGetControls (display,
1310                               XkbAccessXFeedbackMask,
1311                               priv->xkb_desc);
1312               feedback_mask = priv->xkb_desc->ctrls->ax_options;
1313               if (feedback_mask & XkbAX_StickyKeysFBMask)
1314               {
1315                 XkbControlsChangesRec changes = {XkbAccessXFeedbackMask,
1316                                                  0, False};
1317                 priv->xkb_desc->ctrls->ax_options
1318                               &= ~(XkbAX_StickyKeysFBMask);
1319                 XkbChangeControls (display, priv->xkb_desc, &changes);
1320               }
1321               /* TODO: account for lock as well as latch */
1322               XkbLatchModifiers (display,
1323                                  XkbUseCoreKbd,
1324                                  priv->pending_xkb_mod_relatch_mask,
1325                                  priv->pending_xkb_mod_relatch_mask);
1326               if (feedback_mask & XkbAX_StickyKeysFBMask)
1327               {
1328                 XkbControlsChangesRec changes = {XkbAccessXFeedbackMask,
1329                                                  0, False};
1330                 priv->xkb_desc->ctrls->ax_options = feedback_mask;
1331                 XkbChangeControls (display, priv->xkb_desc, &changes);
1332               }
1333 #ifdef SPI_XKB_DEBUG
1334               fprintf (stderr, "relatched %x\n",
1335                        priv->pending_xkb_mod_relatch_mask);
1336 #endif
1337               priv->pending_xkb_mod_relatch_mask = 0;
1338             }
1339           else
1340             {
1341               priv->xkb_latch_mask = xkb_snev->latched_mods;
1342             }
1343         }
1344       XSynchronize (display, FALSE);
1345     }
1346
1347   return;
1348 }
1349
1350 static int
1351 _spi_controller_device_error_handler (Display *display, XErrorEvent *error)
1352 {
1353   if (error->error_code == BadAccess)
1354     {
1355       g_message ("Could not complete key grab: grab already in use.\n");
1356       spi_error_code = BadAccess;
1357       return 0;
1358     }
1359   else
1360     {
1361       return (*x_default_error_handler) (display, error);
1362     }
1363 }
1364
1365 static void
1366 spi_controller_register_with_devices (SpiDEController *controller)
1367 {
1368   DEControllerPrivateData *priv;
1369   int event_base, error_base, major_version, minor_version;
1370
1371   priv = (DEControllerPrivateData *) g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
1372   if (XTestQueryExtension (spi_get_display(), &event_base, &error_base, &major_version, &minor_version))
1373     {
1374       XTestGrabControl (spi_get_display (), True);
1375     }
1376
1377   /* calls to device-specific implementations and routines go here */
1378   /* register with: keyboard hardware code handler */
1379   /* register with: (translated) keystroke handler */
1380
1381   priv->have_xkb = XkbQueryExtension (spi_get_display (),
1382                                       &priv->xkb_major_extension_opcode,
1383                                       &priv->xkb_base_event_code,
1384                                       &priv->xkb_base_error_code, NULL, NULL);
1385   if (priv->have_xkb)
1386     {
1387       gint i;
1388       guint64 reserved = 0;
1389       priv->xkb_desc = XkbGetMap (spi_get_display (), XkbKeySymsMask, XkbUseCoreKbd);
1390       XkbSelectEvents (spi_get_display (),
1391                        XkbUseCoreKbd,
1392                        XkbStateNotifyMask, XkbStateNotifyMask);
1393       _numlock_physical_mask = XkbKeysymToModifiers (spi_get_display (),
1394                                                      XK_Num_Lock);
1395       for (i = priv->xkb_desc->max_key_code; i >= priv->xkb_desc->min_key_code; --i)
1396       {
1397           if (priv->xkb_desc->map->key_sym_map[i].kt_index[0] == XkbOneLevelIndex)
1398           {
1399               if (XKeycodeToKeysym (spi_get_display (), i, 0) != 0)
1400               {
1401                   /* don't use this one if there's a grab client! */
1402
1403                   /* Runtime errors are generated from these functions,
1404                    * that are then quashed. Equivalent to:
1405                    * try
1406                    *   {Blah}
1407                    * except
1408                    *   {;}
1409                    */
1410
1411                   spi_x_error_trap ();
1412                   XGrabKey (spi_get_display (), i, 0,
1413                             spi_get_root_window (),
1414                             TRUE,
1415                             GrabModeSync, GrabModeSync);
1416                   XSync (spi_get_display (), TRUE);
1417                   XUngrabKey (spi_get_display (), i, 0,
1418                               spi_get_root_window ());
1419                   if (!spi_x_error_release ())
1420                   {
1421                       reserved = i;
1422                       break;
1423                   }
1424               }
1425           }
1426       }
1427       if (reserved)
1428       {
1429           priv->reserved_keycode = reserved;
1430           priv->reserved_keysym = XKeycodeToKeysym (spi_get_display (), reserved, 0);
1431       }
1432       else
1433       {
1434           priv->reserved_keycode = XKeysymToKeycode (spi_get_display (), XK_numbersign);
1435           priv->reserved_keysym = XK_numbersign;
1436       }
1437 #ifdef SPI_RESERVED_DEBUG
1438       unsigned sym = 0;
1439       sym = XKeycodeToKeysym (spi_get_display (), reserved, 0);
1440       fprintf (stderr, "%x\n", sym);
1441       fprintf (stderr, "setting the reserved keycode to %d (%s)\n",
1442                reserved,
1443                XKeysymToString (XKeycodeToKeysym (spi_get_display (),
1444                                                             reserved, 0)));
1445 #endif
1446     }
1447
1448   spi_set_filter (global_filter_fn, controller);
1449   spi_set_events (KeyPressMask | KeyReleaseMask);
1450
1451   x_default_error_handler = XSetErrorHandler (_spi_controller_device_error_handler);
1452 }
1453
1454 static gboolean
1455 spi_key_set_contains_key (GSList                          *key_set,
1456                           const Accessibility_DeviceEvent *key_event)
1457 {
1458   gint i;
1459   gint len;
1460   GSList *l;
1461
1462   if (!key_set)
1463     {
1464 #ifdef SPI_DEBUG
1465       g_print ("null key set!\n");
1466 #endif
1467       return TRUE;
1468     }
1469
1470   len = g_slist_length (key_set);
1471
1472   if (len == 0) /* special case, means "all keys/any key" */
1473     {
1474 #ifdef SPI_DEBUG
1475       g_print ("anykey\n");
1476 #endif
1477       return TRUE;
1478     }
1479
1480   for (l = key_set,i = 0; l; l = g_slist_next(l),i++)
1481     {
1482       Accessibility_KeyDefinition *kd = l->data;
1483 #ifdef SPI_KEYEVENT_DEBUG
1484       g_print ("key_set[%d] event = %d, code = %d; key_event %d, code %d, string %s\n",
1485                 i,
1486                 (int) kd->keysym,
1487                 (int) kd->keycode,
1488                 (int) key_event->id,
1489                 (int) key_event->hw_code,
1490                 key_event->event_string);
1491 #endif
1492       if (kd->keysym == (dbus_uint32_t) key_event->id)
1493         {
1494           return TRUE;
1495         }
1496       if (kd->keycode == (dbus_uint32_t) key_event->hw_code)
1497         {
1498           return TRUE;
1499         }
1500       if (key_event->event_string && key_event->event_string[0] &&
1501           !strcmp (kd->keystring, key_event->event_string))
1502         {
1503           return TRUE;
1504         }
1505     }
1506
1507   return FALSE;
1508 }
1509
1510 static gboolean
1511 spi_eventtype_seq_contains_event (dbus_uint32_t types,
1512                                   const Accessibility_DeviceEvent *event)
1513 {
1514   if (types == 0) /* special case, means "all events/any event" */
1515     {
1516       return TRUE;
1517     }
1518
1519   return (types & (1 << event->type));
1520 }
1521
1522 static gboolean
1523 spi_key_event_matches_listener (const Accessibility_DeviceEvent *key_event,
1524                                 DEControllerKeyListener         *listener,
1525                                 dbus_bool_t                    is_system_global)
1526 {
1527   if (((key_event->modifiers & 0xFF) == (dbus_uint16_t) (listener->mask & 0xFF)) &&
1528        spi_key_set_contains_key (listener->keys, key_event) &&
1529        spi_eventtype_seq_contains_event (listener->listener.types, key_event) &&
1530       (is_system_global == listener->mode->global))
1531     {
1532       return TRUE;
1533     }
1534   else
1535     {
1536       return FALSE;
1537     }
1538 }
1539
1540 static gboolean
1541 spi_controller_notify_keylisteners (SpiDEController                 *controller,
1542                                     Accessibility_DeviceEvent       *key_event,
1543                                     dbus_bool_t                    is_system_global)
1544 {
1545   GList   *l;
1546   GSList  *notify = NULL, *l2;
1547   GList  **key_listeners = &controller->key_listeners;
1548   gboolean is_consumed;
1549
1550   if (!key_listeners)
1551     {
1552       return FALSE;
1553     }
1554
1555   /* set the NUMLOCK event mask bit if appropriate: see bug #143702 */
1556   if (key_event->modifiers & _numlock_physical_mask)
1557       key_event->modifiers |= SPI_KEYMASK_NUMLOCK;
1558
1559   for (l = *key_listeners; l; l = l->next)
1560     {
1561        DEControllerKeyListener *key_listener = l->data;
1562
1563        if (spi_key_event_matches_listener (key_event, key_listener, is_system_global))
1564          {
1565            /* we clone (don't dup) the listener, to avoid refcount inc. */
1566            notify = g_slist_prepend (notify,
1567                                      spi_key_listener_clone (key_listener));
1568          }
1569     }
1570
1571 #ifdef SPI_KEYEVENT_DEBUG
1572   if (!notify)
1573     {
1574       g_print ("no match for event\n");
1575     }
1576 #endif
1577
1578   is_consumed = FALSE;
1579   for (l2 = notify; l2 && !is_consumed; l2 = l2->next)
1580     {
1581       DEControllerKeyListener *key_listener = l2->data;
1582
1583       is_consumed = Accessibility_DeviceEventListener_NotifyEvent (controller, controller->registry, &key_listener->listener, key_event) &&
1584                     key_listener->mode->preemptive;
1585
1586       spi_key_listener_clone_free (key_listener);
1587     }
1588
1589   for (; l2; l2 = l2->next)
1590     {
1591       DEControllerKeyListener *key_listener = l2->data;
1592       spi_key_listener_clone_free (key_listener);
1593       /* clone doesn't have its own ref, so don't use spi_dec_listener_free */
1594     }
1595
1596   g_slist_free (notify);
1597
1598 #ifdef SPI_DEBUG
1599   if (is_consumed) g_message ("consumed\n");
1600 #endif
1601   return is_consumed;
1602 }
1603
1604 static gboolean
1605 spi_clear_error_state (void)
1606 {
1607         gboolean retval = spi_error_code != 0;
1608         spi_error_code = 0;
1609         return retval;
1610 }
1611
1612 static Accessibility_DeviceEvent
1613 spi_keystroke_from_x_key_event (XKeyEvent *x_key_event)
1614 {
1615   Accessibility_DeviceEvent key_event;
1616   KeySym keysym;
1617   const int cbuf_bytes = 20;
1618   char cbuf [21];
1619   int nbytes;
1620
1621   nbytes = XLookupString (x_key_event, cbuf, cbuf_bytes, &keysym, NULL);
1622   key_event.id = (dbus_int32_t)(keysym);
1623   key_event.hw_code = (dbus_int16_t) x_key_event->keycode;
1624   if (((XEvent *) x_key_event)->type == KeyPress)
1625     {
1626       key_event.type = Accessibility_KEY_PRESSED_EVENT;
1627     }
1628   else
1629     {
1630       key_event.type = Accessibility_KEY_RELEASED_EVENT;
1631     }
1632   key_event.modifiers = (dbus_uint16_t)(x_key_event->state);
1633   key_event.is_text = FALSE;
1634   switch (keysym)
1635     {
1636       case ' ':
1637         key_event.event_string = g_strdup ("space");
1638         break;
1639       case XK_Tab:
1640         key_event.event_string = g_strdup ("Tab");
1641         break;
1642       case XK_BackSpace:
1643         key_event.event_string = g_strdup ("Backspace");
1644         break;
1645       case XK_Return:
1646         key_event.event_string = g_strdup ("Return");
1647         break;
1648       case XK_Home:
1649         key_event.event_string = g_strdup ("Home");
1650         break;
1651       case XK_Page_Down:
1652         key_event.event_string = g_strdup ("Page_Down");
1653         break;
1654       case XK_Page_Up:
1655         key_event.event_string = g_strdup ("Page_Up");
1656         break;
1657       case XK_F1:
1658         key_event.event_string = g_strdup ("F1");
1659         break;
1660       case XK_F2:
1661         key_event.event_string = g_strdup ("F2");
1662         break;
1663       case XK_F3:
1664         key_event.event_string = g_strdup ("F3");
1665         break;
1666       case XK_F4:
1667         key_event.event_string = g_strdup ("F4");
1668         break;
1669       case XK_F5:
1670         key_event.event_string = g_strdup ("F5");
1671         break;
1672       case XK_F6:
1673         key_event.event_string = g_strdup ("F6");
1674         break;
1675       case XK_F7:
1676         key_event.event_string = g_strdup ("F7");
1677         break;
1678       case XK_F8:
1679         key_event.event_string = g_strdup ("F8");
1680         break;
1681       case XK_F9:
1682         key_event.event_string = g_strdup ("F9");
1683         break;
1684       case XK_F10:
1685         key_event.event_string = g_strdup ("F10");
1686         break;
1687       case XK_F11:
1688         key_event.event_string = g_strdup ("F11");
1689         break;
1690       case XK_F12:
1691         key_event.event_string = g_strdup ("F12");
1692         break;
1693       case XK_End:
1694         key_event.event_string = g_strdup ("End");
1695         break;
1696       case XK_Escape:
1697         key_event.event_string = g_strdup ("Escape");
1698         break;
1699       case XK_Up:
1700         key_event.event_string = g_strdup ("Up");
1701         break;
1702       case XK_Down:
1703         key_event.event_string = g_strdup ("Down");
1704         break;
1705       case XK_Left:
1706         key_event.event_string = g_strdup ("Left");
1707         break;
1708       case XK_Right:
1709         key_event.event_string = g_strdup ("Right");
1710         break;
1711       default:
1712         if (nbytes > 0)
1713           {
1714             gunichar c;
1715             cbuf[nbytes] = '\0'; /* OK since length is cbuf_bytes+1 */
1716             key_event.event_string = g_strdup (cbuf);
1717             c = keysym2ucs (keysym);
1718             if (c > 0 && !g_unichar_iscntrl (c))
1719               {
1720                 key_event.is_text = TRUE;
1721                 /* incorrect for some composed chars? */
1722               }
1723           }
1724         else
1725           {
1726             key_event.event_string = g_strdup ("");
1727           }
1728     }
1729
1730   key_event.timestamp = (dbus_uint32_t) x_key_event->time;
1731 #ifdef SPI_KEYEVENT_DEBUG
1732   {
1733     char *pressed_str  = "pressed";
1734     char *released_str = "released";
1735     char *state_ptr;
1736
1737     if (key_event.type == Accessibility_KEY_PRESSED_EVENT)
1738       state_ptr = pressed_str;
1739     else
1740       state_ptr = released_str;
1741
1742     fprintf (stderr,
1743              "Key %lu %s (%c), modifiers %d; string=%s [%x] %s\n",
1744              (unsigned long) keysym,
1745              state_ptr,
1746              keysym ? (int) keysym : '*',
1747              (int) x_key_event->state,
1748              key_event.event_string,
1749              key_event.event_string[0],
1750              (key_event.is_text == TRUE) ? "(text)" : "(not text)");
1751   }
1752 #endif
1753 #ifdef SPI_DEBUG
1754   fprintf (stderr, "%s%c\n",
1755      (x_key_event->state & Mod1Mask)?"Alt-":"",
1756      ((x_key_event->state & ShiftMask)^(x_key_event->state & LockMask))?
1757      g_ascii_toupper (keysym) : g_ascii_tolower (keysym));
1758   fprintf (stderr, "serial: %x Time: %x\n", x_key_event->serial, x_key_event->time);
1759 #endif /* SPI_DEBUG */
1760   return key_event;
1761 }
1762
1763 static gboolean
1764 spi_controller_update_key_grabs (SpiDEController           *controller,
1765                                  Accessibility_DeviceEvent *recv)
1766 {
1767   GList *l, *next;
1768   gboolean   update_failed = FALSE;
1769   KeyCode keycode = 0;
1770
1771   g_return_val_if_fail (controller != NULL, FALSE);
1772
1773   /*
1774    * masks known to work with default RH 7.1+:
1775    * 0 (no mods), LockMask, Mod1Mask, Mod2Mask, ShiftMask,
1776    * ShiftMask|LockMask, Mod1Mask|LockMask, Mod2Mask|LockMask,
1777    * ShiftMask|Mod1Mask, ShiftMask|Mod2Mask, Mod1Mask|Mod2Mask,
1778    * ShiftMask|LockMask|Mod1Mask, ShiftMask|LockMask|Mod2Mask,
1779    *
1780    * ControlMask grabs are broken, must be in use already
1781    */
1782   if (recv)
1783     keycode = keycode_for_keysym (controller, recv->id, NULL);
1784   for (l = controller->keygrabs_list; l; l = next)
1785     {
1786       gboolean do_remove;
1787       gboolean re_issue_grab;
1788       DEControllerGrabMask *grab_mask = l->data;
1789
1790       next = l->next;
1791
1792       re_issue_grab = recv &&
1793               (recv->modifiers & grab_mask->mod_mask) &&
1794               (grab_mask->key_val == keycode);
1795
1796 #ifdef SPI_DEBUG
1797       fprintf (stderr, "mask=%lx %lx (%c%c) %s\n",
1798                (long int) grab_mask->key_val,
1799                (long int) grab_mask->mod_mask,
1800                grab_mask->pending_add ? '+' : '.',
1801                grab_mask->pending_remove ? '-' : '.',
1802                re_issue_grab ? "re-issue": "");
1803 #endif
1804
1805       do_remove = FALSE;
1806
1807       if (grab_mask->pending_add && grab_mask->pending_remove)
1808         {
1809           do_remove = TRUE;
1810         }
1811       else if (grab_mask->pending_remove)
1812         {
1813 #ifdef SPI_DEBUG
1814       fprintf (stderr, "ungrabbing, mask=%x\n", grab_mask->mod_mask);
1815 #endif
1816           XUngrabKey (spi_get_display (),
1817                       grab_mask->key_val,
1818                       grab_mask->mod_mask,
1819                       spi_get_root_window ());
1820
1821           do_remove = TRUE;
1822         }
1823       else if (grab_mask->pending_add || re_issue_grab)
1824         {
1825
1826 #ifdef SPI_DEBUG
1827           fprintf (stderr, "grab %d with mask %x\n", grab_mask->key_val, grab_mask->mod_mask);
1828 #endif
1829           XGrabKey (spi_get_display (),
1830                     grab_mask->key_val,
1831                     grab_mask->mod_mask,
1832                     spi_get_root_window (),
1833                     True,
1834                     GrabModeSync,
1835                     GrabModeSync);
1836           XSync (spi_get_display (), False);
1837           update_failed = spi_clear_error_state ();
1838           if (update_failed) {
1839                   while (grab_mask->ref_count > 0) --grab_mask->ref_count;
1840                   do_remove = TRUE;
1841           }
1842         }
1843
1844       grab_mask->pending_add = FALSE;
1845       grab_mask->pending_remove = FALSE;
1846
1847       if (do_remove)
1848         {
1849           g_assert (grab_mask->ref_count <= 0);
1850
1851           controller->keygrabs_list = g_list_delete_link (
1852             controller->keygrabs_list, l);
1853
1854           spi_grab_mask_free (grab_mask);
1855         }
1856
1857     }
1858
1859   return ! update_failed;
1860 }
1861
1862 /*
1863  * Implemented GObject::finalize
1864  */
1865 static void
1866 spi_device_event_controller_object_finalize (GObject *object)
1867 {
1868   SpiDEController *controller;
1869   DEControllerPrivateData *private;
1870   controller = SPI_DEVICE_EVENT_CONTROLLER (object);
1871   GObjectClass *parent_class = G_OBJECT_CLASS(spi_device_event_controller_parent_class);
1872 #ifdef SPI_DEBUG
1873   fprintf(stderr, "spi_device_event_controller_object_finalize called\n");
1874 #endif
1875   /* disconnect any special listeners, get rid of outstanding keygrabs */
1876   XUngrabKey (spi_get_display (), AnyKey, AnyModifier, DefaultRootWindow (spi_get_display ()));
1877
1878 #ifdef HAVE_XEVIE
1879   if (controller->xevie_display != NULL)
1880     {
1881       XevieEnd(controller->xevie_display);
1882 #ifdef SPI_KEYEVENT_DEBUG
1883       printf("XevieEnd(dpy) finished \n");
1884 #endif
1885     }
1886 #endif
1887
1888   private = g_object_get_data (G_OBJECT (controller), "spi-dec-private");
1889   if (private->xkb_desc)
1890           XkbFreeKeyboard (private->xkb_desc, 0, True);
1891   g_free (private);
1892   parent_class->finalize (object);
1893 }
1894
1895 /*
1896  * DBus Accessibility::DEController::RegisterKeystrokeListener
1897  *     method implementation
1898  */
1899 static DBusMessage *
1900 impl_register_keystroke_listener (DBusConnection *bus,
1901                                   DBusMessage *message,
1902                                   void *user_data)
1903 {
1904   SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER(user_data);
1905   DEControllerKeyListener *dec_listener;
1906   DBusMessageIter iter, iter_array;
1907   const char *path;
1908   GSList *keys = NULL;
1909   dbus_int32_t mask, type;
1910   Accessibility_EventListenerMode *mode;
1911   dbus_bool_t ret;
1912   DBusMessage *reply = NULL;
1913   char *keystring;
1914   char *sig;
1915
1916   dbus_message_iter_init(message, &iter);
1917   // TODO: verify type signature
1918   dbus_message_iter_get_basic(&iter, &path);
1919   dbus_message_iter_next(&iter);
1920   dbus_message_iter_recurse(&iter, &iter_array);
1921   while (dbus_message_iter_get_arg_type(&iter_array) != DBUS_TYPE_INVALID)
1922   {
1923     Accessibility_KeyDefinition *kd = (Accessibility_KeyDefinition *)g_malloc(sizeof(Accessibility_KeyDefinition));
1924     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))
1925     {
1926       break;
1927     }
1928     kd->keystring = g_strdup (keystring);
1929     keys = g_slist_append(keys, kd);
1930   }
1931   dbus_message_iter_next(&iter);
1932   dbus_message_iter_get_basic(&iter, &mask);
1933   dbus_message_iter_next(&iter);
1934   sig = dbus_message_iter_get_signature (&iter);
1935   if (sig && !strcmp (sig, "u"))
1936     dbus_message_iter_get_basic(&iter, &type);
1937   else
1938   {
1939     dbus_message_iter_recurse(&iter, &iter_array);
1940     while (dbus_message_iter_get_arg_type(&iter_array) != DBUS_TYPE_INVALID)
1941     {
1942       dbus_uint32_t t;
1943       dbus_message_iter_get_basic (&iter_array, &t);
1944       type |= (1 << t);
1945       dbus_message_iter_next (&iter_array);
1946     }
1947     dbus_message_iter_next (&iter_array);
1948   }
1949   dbus_free (sig);
1950   dbus_message_iter_next(&iter);
1951   mode = (Accessibility_EventListenerMode *)g_malloc(sizeof(Accessibility_EventListenerMode));
1952   if (mode)
1953   {
1954     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);
1955   }
1956 #ifdef SPI_DEBUG
1957   fprintf (stderr, "registering keystroke listener %s:%s with maskVal %lu\n",
1958            dbus_message_get_sender(message), path, (unsigned long) mask);
1959 #endif
1960   dec_listener = spi_dec_key_listener_new (dbus_message_get_sender(message), path, keys, mask, type, mode);
1961   g_free (mode);
1962   ret = spi_controller_register_device_listener (
1963           controller, (DEControllerListener *) dec_listener);
1964   reply = dbus_message_new_method_return (message);
1965   if (reply)
1966   {
1967     dbus_message_append_args (reply, DBUS_TYPE_BOOLEAN, &ret, DBUS_TYPE_INVALID);
1968   }
1969   return reply;
1970 }
1971
1972 /*
1973  * DBus Accessibility::DEController::RegisterDeviceEventListener
1974  *     method implementation
1975  */
1976 static DBusMessage *
1977 impl_register_device_event_listener (DBusConnection *bus,
1978                                   DBusMessage *message,
1979                                   void *user_data)
1980 {
1981   SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER(user_data);
1982   DEControllerListener *dec_listener;
1983   DBusError error;
1984   const char *path;
1985   dbus_int32_t event_types;
1986   dbus_bool_t ret;
1987   DBusMessage *reply = NULL;
1988
1989   dbus_error_init(&error);
1990   if (!dbus_message_get_args(message, &error, DBUS_TYPE_OBJECT_PATH, &path, DBUS_TYPE_UINT32, &event_types, DBUS_TYPE_INVALID))
1991   {
1992     return invalid_arguments_error (message);
1993   }
1994   dec_listener = spi_dec_listener_new (dbus_message_get_sender(message), path, event_types);
1995   ret =  spi_controller_register_device_listener (
1996           controller, (DEControllerListener *) dec_listener);
1997   reply = dbus_message_new_method_return (message);
1998   if (reply)
1999   {
2000     dbus_message_append_args (reply, DBUS_TYPE_BOOLEAN, &ret, DBUS_TYPE_INVALID);
2001   }
2002   return reply;
2003 }
2004
2005 typedef struct {
2006         DBusConnection *bus;
2007         DEControllerListener    *listener;
2008 } RemoveListenerClosure;
2009
2010 static SpiReEntrantContinue
2011 remove_listener_cb (GList * const *list,
2012                     gpointer       user_data)
2013 {
2014   DEControllerListener  *listener = (*list)->data;
2015   RemoveListenerClosure *ctx = user_data;
2016
2017   if (!strcmp(ctx->listener->bus_name, listener->bus_name) &&
2018       !strcmp(ctx->listener->path, listener->path))
2019     {
2020       spi_re_entrant_list_delete_link (list);
2021       spi_dbus_remove_disconnect_match (ctx->bus, listener->bus_name);
2022       spi_dec_listener_free (listener);
2023     }
2024
2025   return SPI_RE_ENTRANT_CONTINUE;
2026 }
2027
2028 static SpiReEntrantContinue
2029 copy_key_listener_cb (GList * const *list,
2030                       gpointer       user_data)
2031 {
2032   DEControllerKeyListener  *key_listener = (*list)->data;
2033   RemoveListenerClosure    *ctx = user_data;
2034
2035   if (!strcmp(ctx->listener->bus_name, key_listener->listener.bus_name) &&
2036       !strcmp(ctx->listener->path, key_listener->listener.path))
2037     {
2038       /* TODO: FIXME aggregate keys in case the listener is registered twice */
2039       DEControllerKeyListener *ctx_key_listener =
2040         (DEControllerKeyListener *) ctx->listener;
2041       keylist_free (ctx_key_listener->keys);
2042       ctx_key_listener->keys = keylist_clone(key_listener->keys);
2043     }
2044
2045   return SPI_RE_ENTRANT_CONTINUE;
2046 }
2047
2048 static void
2049 spi_controller_deregister_device_listener (SpiDEController            *controller,
2050                                            DEControllerListener *listener)
2051 {
2052   RemoveListenerClosure  ctx;
2053
2054   ctx.bus = controller->bus;
2055   ctx.listener = listener;
2056
2057   spi_re_entrant_list_foreach (&controller->mouse_listeners,
2058                                remove_listener_cb, &ctx);
2059   if (!controller->mouse_listeners)
2060     have_mouse_listener = FALSE;
2061 }
2062
2063 static void
2064 spi_deregister_controller_key_listener (SpiDEController            *controller,
2065                                         DEControllerKeyListener    *key_listener)
2066 {
2067   RemoveListenerClosure  ctx;
2068
2069   ctx.bus = controller->bus;
2070   ctx.listener = (DEControllerListener *) key_listener;
2071
2072   /* special case, copy keyset from existing controller list entry */
2073   if (g_slist_length(key_listener->keys) == 0)
2074     {
2075       spi_re_entrant_list_foreach (&controller->key_listeners,
2076                                   copy_key_listener_cb, &ctx);
2077     }
2078
2079   spi_controller_deregister_global_keygrabs (controller, key_listener);
2080
2081   spi_re_entrant_list_foreach (&controller->key_listeners,
2082                                 remove_listener_cb, &ctx);
2083
2084 }
2085
2086 void
2087 spi_remove_device_listeners (SpiDEController *controller, const char *bus_name)
2088 {
2089   GList *l, *tmp;
2090
2091   for (l = controller->mouse_listeners; l; l = tmp)
2092   {
2093     DEControllerListener *listener = l->data;
2094     tmp = l->next;
2095     if (!strcmp (listener->bus_name, bus_name))
2096     {
2097       spi_controller_deregister_device_listener (controller, listener);
2098     }
2099   }
2100   for (l = controller->key_listeners; l; l = tmp)
2101   {
2102     DEControllerKeyListener *key_listener = l->data;
2103     tmp = l->next;
2104     if (!strcmp (key_listener->listener.bus_name, bus_name))
2105     {
2106       spi_deregister_controller_key_listener (controller, key_listener);
2107     }
2108   }
2109 }
2110
2111 /*
2112  * DBus Accessibility::DEController::DeregisterKeystrokeListener
2113  *     method implementation
2114  */
2115 static DBusMessage *
2116 impl_deregister_keystroke_listener (DBusConnection *bus,
2117                                   DBusMessage *message,
2118                                   void *user_data)
2119 {
2120   SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER(user_data);
2121   DEControllerKeyListener *key_listener;
2122   DBusMessageIter iter, iter_array;
2123   const char *path;
2124   GSList *keys = NULL;
2125   dbus_int32_t mask, type;
2126   DBusMessage *reply = NULL;
2127
2128   dbus_message_iter_init(message, &iter);
2129   // TODO: verify type signature
2130   dbus_message_iter_get_basic(&iter, &path);
2131   dbus_message_iter_next(&iter);
2132   dbus_message_iter_recurse(&iter, &iter_array);
2133   while (dbus_message_iter_get_arg_type(&iter_array) != DBUS_TYPE_INVALID)
2134   {
2135     Accessibility_KeyDefinition *kd = (Accessibility_KeyDefinition *)g_malloc(sizeof(Accessibility_KeyDefinition));
2136   char *keystring;
2137
2138     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))
2139     {
2140       break;
2141     }
2142     kd->keystring = g_strdup (keystring);
2143     keys = g_slist_append(keys, kd);
2144   }
2145   dbus_message_iter_next(&iter);
2146   dbus_message_iter_get_basic(&iter, &mask);
2147   dbus_message_iter_next(&iter);
2148   dbus_message_iter_get_basic(&iter, &type);
2149   dbus_message_iter_next(&iter);
2150   key_listener = spi_dec_key_listener_new (dbus_message_get_sender(message), path, keys, mask, type, NULL);
2151 #ifdef SPI_DEREGISTER_DEBUG
2152   fprintf (stderr, "deregistering keystroke listener %p with maskVal %lu\n",
2153            (void *) l, (unsigned long) mask->value);
2154 #endif
2155
2156   spi_deregister_controller_key_listener (controller, key_listener);
2157
2158   spi_dec_listener_free ((DEControllerListener *) key_listener);
2159   reply = dbus_message_new_method_return (message);
2160   return reply;
2161 }
2162
2163 /*
2164  * DBus Accessibility::DEController::DeregisterDeviceEventListener
2165  *     method implementation
2166  */
2167 static DBusMessage *
2168 impl_deregister_device_event_listener (DBusConnection *bus,
2169                                   DBusMessage *message,
2170                                   void *user_data)
2171 {
2172   SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER(user_data);
2173   DEControllerListener *listener;
2174   DBusError error;
2175   const char *path;
2176   dbus_int32_t event_types;
2177   DBusMessage *reply = NULL;
2178
2179   dbus_error_init(&error);
2180   if (!dbus_message_get_args(message, &error, DBUS_TYPE_OBJECT_PATH, &path, DBUS_TYPE_UINT32, &event_types, DBUS_TYPE_INVALID))
2181   {
2182     return invalid_arguments_error (message);
2183   }
2184   listener = spi_dec_listener_new (dbus_message_get_sender(message), path, event_types);
2185   spi_controller_deregister_device_listener (
2186           controller, listener);
2187   reply = dbus_message_new_method_return (message);
2188   return reply;
2189 }
2190
2191 static unsigned int dec_xkb_get_slowkeys_delay (SpiDEController *controller)
2192 {
2193   unsigned int retval = 0;
2194   DEControllerPrivateData *priv = (DEControllerPrivateData *)
2195           g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
2196 #ifdef HAVE_XKB
2197 #ifdef XKB_HAS_GET_SLOW_KEYS_DELAY
2198   retval = XkbGetSlowKeysDelay (spi_get_display (),
2199                                 XkbUseCoreKbd, &bounce_delay);
2200 #else
2201   if (!(priv->xkb_desc == (XkbDescPtr) BadAlloc || priv->xkb_desc == NULL))
2202     {
2203       Status s = XkbGetControls (spi_get_display (),
2204                                  XkbAllControlsMask, priv->xkb_desc);
2205       if (s == Success)
2206         {
2207          if (priv->xkb_desc->ctrls->enabled_ctrls & XkbSlowKeysMask)
2208                  retval = priv->xkb_desc->ctrls->slow_keys_delay;
2209         }
2210     }
2211 #endif
2212 #endif
2213 #ifdef SPI_XKB_DEBUG
2214         fprintf (stderr, "SlowKeys delay: %d\n", (int) retval);
2215 #endif
2216         return retval;
2217 }
2218
2219 static unsigned int dec_xkb_get_bouncekeys_delay (SpiDEController *controller)
2220 {
2221   unsigned int retval = 0;
2222   DEControllerPrivateData *priv = (DEControllerPrivateData *)
2223           g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
2224 #ifdef HAVE_XKB
2225 #ifdef XKB_HAS_GET_BOUNCE_KEYS_DELAY
2226   retval = XkbGetBounceKeysDelay (spi_get_display (),
2227                                   XkbUseCoreKbd, &bounce_delay);
2228 #else
2229   if (!(priv->xkb_desc == (XkbDescPtr) BadAlloc || priv->xkb_desc == NULL))
2230     {
2231       Status s = XkbGetControls (spi_get_display (),
2232                                  XkbAllControlsMask, priv->xkb_desc);
2233       if (s == Success)
2234         {
2235           if (priv->xkb_desc->ctrls->enabled_ctrls & XkbBounceKeysMask)
2236                   retval = priv->xkb_desc->ctrls->debounce_delay;
2237         }
2238     }
2239 #endif
2240 #endif
2241 #ifdef SPI_XKB_DEBUG
2242   fprintf (stderr, "BounceKeys delay: %d\n", (int) retval);
2243 #endif
2244   return retval;
2245 }
2246
2247 static gboolean
2248 dec_synth_keycode_press (SpiDEController *controller,
2249                          unsigned int keycode)
2250 {
2251         unsigned int time = CurrentTime;
2252         unsigned int bounce_delay;
2253         unsigned int elapsed_msec;
2254         struct timeval tv;
2255         DEControllerPrivateData *priv =
2256                 (DEControllerPrivateData *) g_object_get_qdata (G_OBJECT (controller),
2257                                                                 spi_dec_private_quark);
2258         if (keycode == priv->last_release_keycode)
2259         {
2260                 bounce_delay = dec_xkb_get_bouncekeys_delay (controller);
2261                 if (bounce_delay)
2262                 {
2263                         gettimeofday (&tv, NULL);
2264                         elapsed_msec =
2265                                 (tv.tv_sec - priv->last_release_time.tv_sec) * 1000
2266                                 + (tv.tv_usec - priv->last_release_time.tv_usec) / 1000;
2267 #ifdef SPI_XKB_DEBUG
2268                         fprintf (stderr, "%d ms elapsed (%ld usec)\n", elapsed_msec,
2269                                  (long) (tv.tv_usec - priv->last_release_time.tv_usec));
2270 #endif
2271 #ifdef THIS_IS_BROKEN
2272                         if (elapsed_msec < bounce_delay)
2273                                 time = bounce_delay - elapsed_msec + 1;
2274 #else
2275                         time = bounce_delay + 10;
2276                         /* fudge for broken XTest */
2277 #endif
2278 #ifdef SPI_XKB_DEBUG
2279                         fprintf (stderr, "waiting %d ms\n", time);
2280 #endif
2281                 }
2282         }
2283         XTestFakeKeyEvent (spi_get_display (), keycode, True, time);
2284         priv->last_press_keycode = keycode;
2285         XFlush (spi_get_display ());
2286         XSync (spi_get_display (), False);
2287         gettimeofday (&priv->last_press_time, NULL);
2288         return TRUE;
2289 }
2290
2291 static gboolean
2292 dec_synth_keycode_release (SpiDEController *controller,
2293                            unsigned int keycode)
2294 {
2295         unsigned int time = CurrentTime;
2296         unsigned int slow_delay;
2297         unsigned int elapsed_msec;
2298         struct timeval tv;
2299         DEControllerPrivateData *priv =
2300                 (DEControllerPrivateData *) g_object_get_qdata (G_OBJECT (controller),
2301                                                                 spi_dec_private_quark);
2302         if (keycode == priv->last_press_keycode)
2303         {
2304                 slow_delay = dec_xkb_get_slowkeys_delay (controller);
2305                 if (slow_delay)
2306                 {
2307                         gettimeofday (&tv, NULL);
2308                         elapsed_msec =
2309                                 (tv.tv_sec - priv->last_press_time.tv_sec) * 1000
2310                                 + (tv.tv_usec - priv->last_press_time.tv_usec) / 1000;
2311 #ifdef SPI_XKB_DEBUG
2312                         fprintf (stderr, "%d ms elapsed (%ld usec)\n", elapsed_msec,
2313                                  (long) (tv.tv_usec - priv->last_press_time.tv_usec));
2314 #endif
2315 #ifdef THIS_IS_BROKEN_DUNNO_WHY
2316                         if (elapsed_msec < slow_delay)
2317                                 time = slow_delay - elapsed_msec + 1;
2318 #else
2319                         time = slow_delay + 10;
2320                         /* our XTest seems broken, we have to add slop as above */
2321 #endif
2322 #ifdef SPI_XKB_DEBUG
2323                         fprintf (stderr, "waiting %d ms\n", time);
2324 #endif
2325                 }
2326         }
2327         XTestFakeKeyEvent (spi_get_display (), keycode, False, time);
2328         priv->last_release_keycode = keycode;
2329         XSync (spi_get_display (), False);
2330         gettimeofday (&priv->last_release_time, NULL);
2331         return TRUE;
2332 }
2333
2334 static unsigned
2335 dec_get_modifier_state (SpiDEController *controller)
2336 {
2337         return mouse_mask_state;
2338 }
2339
2340 static gboolean
2341 dec_lock_modifiers (SpiDEController *controller, unsigned modifiers)
2342 {
2343     DEControllerPrivateData *priv = (DEControllerPrivateData *)
2344     g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
2345
2346     if (priv->have_xkb) {
2347         return XkbLockModifiers (spi_get_display (), XkbUseCoreKbd,
2348                                   modifiers, modifiers);
2349     } else {
2350         int mod_index;
2351         for (mod_index=0;mod_index<8;mod_index++)
2352             if (modifiers & (1<<mod_index))
2353                 dec_synth_keycode_press(controller, xmkeymap->modifiermap[mod_index]);
2354         return TRUE;
2355     }
2356 }
2357
2358 static gboolean
2359 dec_unlock_modifiers (SpiDEController *controller, unsigned modifiers)
2360 {
2361     DEControllerPrivateData *priv = (DEControllerPrivateData *)
2362     g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
2363
2364     if (priv->have_xkb) {
2365         return XkbLockModifiers (spi_get_display (), XkbUseCoreKbd,
2366                                   modifiers, 0);
2367     } else {
2368         int mod_index;
2369         for (mod_index=0;mod_index<8;mod_index++)
2370             if (modifiers & (1<<mod_index))
2371                 dec_synth_keycode_release(controller, xmkeymap->modifiermap[mod_index]);
2372         return TRUE;
2373     }
2374 }
2375
2376 static KeySym
2377 dec_keysym_for_unichar (SpiDEController *controller, gunichar unichar)
2378 {
2379         return ucs2keysym ((long) unichar);
2380 }
2381
2382 static gboolean
2383 dec_synth_keysym (SpiDEController *controller, KeySym keysym)
2384 {
2385         KeyCode key_synth_code;
2386         unsigned int modifiers, synth_mods, lock_mods;
2387
2388         key_synth_code = keycode_for_keysym (controller, keysym, &synth_mods);
2389
2390         if ((key_synth_code == 0) || (synth_mods == 0xFF)) return FALSE;
2391
2392         /* TODO: set the modifiers accordingly! */
2393         modifiers = dec_get_modifier_state (controller);
2394         /* side-effect; we may unset mousebutton modifiers here! */
2395
2396         lock_mods = 0;
2397         if (synth_mods != modifiers) {
2398                 lock_mods = synth_mods & ~modifiers;
2399                 dec_lock_modifiers (controller, lock_mods);
2400         }
2401         dec_synth_keycode_press (controller, key_synth_code);
2402         dec_synth_keycode_release (controller, key_synth_code);
2403
2404         if (synth_mods != modifiers)
2405                 dec_unlock_modifiers (controller, lock_mods);
2406         return TRUE;
2407 }
2408
2409
2410 static gboolean
2411 dec_synth_keystring (SpiDEController *controller, const char *keystring)
2412 {
2413         /* probably we need to create and inject an XIM handler eventually. */
2414         /* for now, try to match the string to existing
2415          * keycode+modifier states.
2416          */
2417         KeySym *keysyms;
2418         gint maxlen = 0;
2419         gunichar unichar = 0;
2420         gint i = 0;
2421         gboolean retval = TRUE;
2422         const gchar *c;
2423
2424         maxlen = strlen (keystring) + 1;
2425         keysyms = g_new0 (KeySym, maxlen);
2426         if (!(keystring && *keystring && g_utf8_validate (keystring, -1, &c))) {
2427                 retval = FALSE;
2428         }
2429         else {
2430 #ifdef SPI_DEBUG
2431                 fprintf (stderr, "[keystring synthesis attempted on %s]\n", keystring);
2432 #endif
2433                 while (keystring && (unichar = g_utf8_get_char (keystring))) {
2434                         KeySym keysym;
2435                         char bytes[6];
2436                         gint mbytes;
2437
2438                         mbytes = g_unichar_to_utf8 (unichar, bytes);
2439                         bytes[mbytes] = '\0';
2440 #ifdef SPI_DEBUG
2441                         fprintf (stderr, "[unichar %s]", bytes);
2442 #endif
2443                         keysym = dec_keysym_for_unichar (controller, unichar);
2444                         if (keysym == NoSymbol) {
2445 #ifdef SPI_DEBUG
2446                                 fprintf (stderr, "no keysym for %s", bytes);
2447 #endif
2448                                 retval = FALSE;
2449                                 break;
2450                         }
2451                         keysyms[i++] = keysym;
2452                         keystring = g_utf8_next_char (keystring);
2453                 }
2454                 keysyms[i++] = 0;
2455                 XSynchronize (spi_get_display (), TRUE);
2456                 for (i = 0; keysyms[i]; ++i) {
2457                         if (!dec_synth_keysym (controller, keysyms[i])) {
2458 #ifdef SPI_DEBUG
2459                                 fprintf (stderr, "could not synthesize %c\n",
2460                                          (int) keysyms[i]);
2461 #endif
2462                                 retval = FALSE;
2463                                 break;
2464                         }
2465                 }
2466                 XSynchronize (spi_get_display (), FALSE);
2467         }
2468         g_free (keysyms);
2469
2470         return retval;
2471 }
2472
2473
2474 /*
2475  * DBus Accessibility::DEController::RegisterKeystrokeListener
2476  *     method implementation
2477  */
2478 static DBusMessage * impl_generate_keyboard_event (DBusConnection *bus, DBusMessage *message, void *user_data)
2479 {
2480   SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER(user_data);
2481   DBusError error;
2482   dbus_int32_t keycode;
2483   char *keystring;
2484   dbus_uint32_t synth_type;
2485   gint err;
2486   KeySym keysym;
2487   DEControllerPrivateData *priv;
2488   DBusMessage *reply = NULL;
2489
2490   dbus_error_init(&error);
2491   if (!dbus_message_get_args(message, &error, DBUS_TYPE_INT32, &keycode, DBUS_TYPE_STRING, &keystring, DBUS_TYPE_UINT32, &synth_type, DBUS_TYPE_INVALID))
2492   {
2493     return invalid_arguments_error (message);
2494   }
2495
2496 #ifdef SPI_DEBUG
2497         fprintf (stderr, "synthesizing keystroke %ld, type %d\n",
2498                  (long) keycode, (int) synth_type);
2499 #endif
2500   /* TODO: hide/wrap/remove X dependency */
2501
2502   /*
2503    * TODO: when initializing, query for XTest extension before using,
2504    * and fall back to XSendEvent() if XTest is not available.
2505    */
2506
2507   spi_x_error_trap ();
2508
2509   priv = (DEControllerPrivateData *)
2510       g_object_get_qdata (G_OBJECT (controller), spi_dec_private_quark);
2511
2512   if (!priv->have_xkb && xmkeymap==NULL) {
2513     xmkeymap = XGetModifierMapping(spi_get_display ());
2514   }
2515
2516   switch (synth_type)
2517     {
2518       case Accessibility_KEY_PRESS:
2519               dec_synth_keycode_press (controller, keycode);
2520               break;
2521       case Accessibility_KEY_PRESSRELEASE:
2522               dec_synth_keycode_press (controller, keycode);
2523       case Accessibility_KEY_RELEASE:
2524               dec_synth_keycode_release (controller, keycode);
2525               break;
2526       case Accessibility_KEY_SYM:
2527 #ifdef SPI_XKB_DEBUG
2528               fprintf (stderr, "KeySym synthesis\n");
2529 #endif
2530               /*
2531                * note: we are using long for 'keycode'
2532                * in our arg list; it can contain either
2533                * a keycode or a keysym.
2534                */
2535               dec_synth_keysym (controller, (KeySym) keycode);
2536               break;
2537       case Accessibility_KEY_STRING:
2538               if (!dec_synth_keystring (controller, keystring))
2539                       fprintf (stderr, "Keystring synthesis failure, string=%s\n",
2540                                keystring);
2541               break;
2542     }
2543   if (synth_type == Accessibility_KEY_SYM) {
2544     keysym = keycode;
2545   }
2546   else {
2547     keysym = XkbKeycodeToKeysym (spi_get_display (), keycode, 0, 0);
2548   }
2549   if (XkbKeysymToModifiers (spi_get_display (), keysym) == 0)
2550     {
2551       spi_dec_clear_unlatch_pending (controller);
2552     }
2553   reply = dbus_message_new_method_return (message);
2554   return reply;
2555 }
2556
2557 /* Accessibility::DEController::GenerateMouseEvent */
2558 static DBusMessage * impl_generate_mouse_event (DBusConnection *bus, DBusMessage *message, void *user_data)
2559 {
2560   DBusError error;
2561   dbus_int32_t       x;
2562   dbus_int32_t       y;
2563   char *eventName;
2564   DBusMessage *reply = NULL;
2565   int button = 0;
2566   gboolean err = FALSE;
2567   Display *display = spi_get_display ();
2568
2569   dbus_error_init (&error);
2570   if (!dbus_message_get_args(message, &error, DBUS_TYPE_INT32, &x, DBUS_TYPE_INT32, &y, DBUS_TYPE_STRING, &eventName, DBUS_TYPE_INVALID))
2571   {
2572     return invalid_arguments_error (message);
2573   }
2574
2575 #ifdef SPI_DEBUG
2576   fprintf (stderr, "generating mouse %s event at %ld, %ld\n",
2577            eventName, (long int) x, (long int) y);
2578 #endif
2579   switch (eventName[0])
2580     {
2581       case 'b':
2582         switch (eventName[1])
2583           {
2584           /* TODO: check number of buttons before parsing */
2585           case '1':
2586                     button = 1;
2587                     break;
2588           case '2':
2589                   button = 2;
2590                   break;
2591           case '3':
2592                   button = 3;
2593                   break;
2594           case '4':
2595                   button = 4;
2596                   break;
2597           case '5':
2598                   button = 5;
2599                   break;
2600           default:
2601                   err = TRUE;
2602           }
2603         if (!err)
2604           {
2605             if (x != -1 && y != -1)
2606               {
2607                 XTestFakeMotionEvent (display, DefaultScreen (display),
2608                                       x, y, 0);
2609               }
2610             XTestFakeButtonEvent (display, button, !(eventName[2] == 'r'), 0);
2611             if (eventName[2] == 'c')
2612               XTestFakeButtonEvent (display, button, FALSE, 1);
2613             else if (eventName[2] == 'd')
2614               {
2615               XTestFakeButtonEvent (display, button, FALSE, 1);
2616               XTestFakeButtonEvent (display, button, TRUE, 2);
2617               XTestFakeButtonEvent (display, button, FALSE, 3);
2618               }
2619           }
2620         break;
2621       case 'r': /* relative motion */
2622         XTestFakeRelativeMotionEvent (display, x, y, 0);
2623         break;
2624       case 'a': /* absolute motion */
2625         XTestFakeMotionEvent (display, DefaultScreen (display),
2626                               x, y, 0);
2627         break;
2628     }
2629   reply = dbus_message_new_method_return (message);
2630   return reply;
2631 }
2632
2633 /* Accessibility::DEController::NotifyListenersSync */
2634 static DBusMessage *
2635 impl_notify_listeners_sync (DBusConnection *bus, DBusMessage *message, void *user_data)
2636 {
2637   SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER(user_data);
2638   Accessibility_DeviceEvent event;
2639   dbus_bool_t ret;
2640   DBusMessage *reply = NULL;
2641
2642   if (!spi_dbus_demarshal_deviceEvent(message, &event))
2643   {
2644     return invalid_arguments_error (message);
2645   }
2646 #ifdef SPI_DEBUG
2647   g_print ("notifylistening listeners synchronously: controller %p, event id %d\n",
2648            controller, (int) event.id);
2649 #endif
2650   ret = spi_controller_notify_keylisteners (controller,
2651                                              (Accessibility_DeviceEvent *)
2652                                              &event, FALSE) ?
2653           TRUE : FALSE;
2654   reply = dbus_message_new_method_return (message);
2655   if (reply)
2656   {
2657     dbus_message_append_args (reply, DBUS_TYPE_BOOLEAN, &ret, DBUS_TYPE_INVALID);
2658   }
2659   return reply;
2660 }
2661
2662 static DBusMessage *
2663 impl_notify_listeners_async (DBusConnection *bus, DBusMessage *message, void *user_data)
2664 {
2665   SpiDEController *controller = SPI_DEVICE_EVENT_CONTROLLER(user_data);
2666   Accessibility_DeviceEvent event;
2667   DBusMessage *reply = NULL;
2668
2669   if (!spi_dbus_demarshal_deviceEvent(message, &event))
2670   {
2671     return invalid_arguments_error (message);
2672   }
2673 #ifdef SPI_DEBUG
2674   g_print ("notifylistening listeners asynchronously: controller %p, event id %d\n",
2675            controller, (int) event.id);
2676 #endif
2677   spi_controller_notify_keylisteners (controller, (Accessibility_DeviceEvent *)
2678                                       &event, FALSE);
2679   reply = dbus_message_new_method_return (message);
2680   return reply;
2681 }
2682
2683 static void
2684 spi_device_event_controller_class_init (SpiDEControllerClass *klass)
2685 {
2686   GObjectClass * object_class = (GObjectClass *) klass;
2687
2688   spi_device_event_controller_parent_class = g_type_class_peek_parent (klass);
2689
2690   object_class->finalize = spi_device_event_controller_object_finalize;
2691
2692   if (!spi_dec_private_quark)
2693           spi_dec_private_quark = g_quark_from_static_string ("spi-dec-private");
2694 }
2695
2696 #ifdef HAVE_XEVIE
2697 static Bool isEvent(Display *dpy, XEvent *event, char *arg)
2698 {
2699    return TRUE;
2700 }
2701
2702 static gboolean
2703 handle_io (GIOChannel *source,
2704            GIOCondition condition,
2705            gpointer data)
2706 {
2707   SpiDEController *controller = (SpiDEController *) data;
2708   gboolean is_consumed = FALSE;
2709   XEvent ev;
2710
2711   while (XCheckIfEvent(controller->xevie_display, &ev, isEvent, NULL))
2712     {
2713       if (ev.type == KeyPress || ev.type == KeyRelease)
2714         is_consumed = spi_device_event_controller_forward_key_event (controller, &ev);
2715
2716       if (! is_consumed)
2717         XevieSendEvent(controller->xevie_display, &ev, XEVIE_UNMODIFIED);
2718     }
2719
2720   return TRUE;
2721 }
2722 #endif /* HAVE_XEVIE */
2723
2724 static void
2725 spi_device_event_controller_init (SpiDEController *device_event_controller)
2726 {
2727   spi_events_init (spi_get_display());
2728 #ifdef HAVE_XEVIE
2729   GIOChannel *ioc;
2730   int fd;
2731 #endif /* HAVE_XEVIE */
2732
2733   DEControllerPrivateData *private;
2734   device_event_controller->key_listeners   = NULL;
2735   device_event_controller->mouse_listeners = NULL;
2736   device_event_controller->keygrabs_list   = NULL;
2737   device_event_controller->xevie_display   = NULL;
2738
2739 #ifdef HAVE_XEVIE
2740   device_event_controller->xevie_display = XOpenDisplay(NULL);
2741
2742   if (XevieStart(device_event_controller->xevie_display) == TRUE)
2743     {
2744 #ifdef SPI_KEYEVENT_DEBUG
2745       fprintf (stderr, "XevieStart() success \n");
2746 #endif
2747       XevieSelectInput(device_event_controller->xevie_display, KeyPressMask | KeyReleaseMask);
2748
2749       fd = ConnectionNumber(device_event_controller->xevie_display);
2750       ioc = g_io_channel_unix_new (fd);
2751       g_io_add_watch (ioc, G_IO_IN | G_IO_HUP, handle_io, device_event_controller);
2752       g_io_channel_unref (ioc);
2753     }
2754   else
2755     {
2756       device_event_controller->xevie_display = NULL;
2757 #ifdef SPI_KEYEVENT_DEBUG
2758       fprintf (stderr, "XevieStart() failed, only one client is allowed to do event int exception\n");
2759 #endif
2760     }
2761 #endif /* HAVE_XEVIE */
2762
2763   private = g_new0 (DEControllerPrivateData, 1);
2764   gettimeofday (&private->last_press_time, NULL);
2765   gettimeofday (&private->last_release_time, NULL);
2766   g_object_set_qdata (G_OBJECT (device_event_controller),
2767                       spi_dec_private_quark,
2768                       private);
2769   spi_controller_register_with_devices (device_event_controller);
2770   device_event_controller->message_queue = g_queue_new ();
2771   saved_controller = device_event_controller;
2772 }
2773
2774 static gboolean
2775 spi_device_event_controller_forward_key_event (SpiDEController *controller,
2776                                                const XEvent    *event)
2777 {
2778   Accessibility_DeviceEvent key_event;
2779   gboolean ret;
2780
2781   g_assert (event->type == KeyPress || event->type == KeyRelease);
2782
2783   key_event = spi_keystroke_from_x_key_event ((XKeyEvent *) event);
2784
2785   if (controller->xevie_display == NULL)
2786     spi_controller_update_key_grabs (controller, &key_event);
2787
2788   /* relay to listeners, and decide whether to consume it or not */
2789   ret = spi_controller_notify_keylisteners (controller, &key_event, TRUE);
2790   g_free(key_event.event_string);
2791   return ret;
2792 }
2793
2794
2795 static gboolean
2796 is_key_released (KeyCode code)
2797 {
2798   char keys[32];
2799   int down;
2800
2801   XQueryKeymap (spi_get_display (), keys);
2802   down = BIT (keys, code);
2803   return (down == 0);
2804 }
2805
2806 static gboolean
2807 check_release (gpointer data)
2808 {
2809   gboolean released;
2810   Accessibility_DeviceEvent *event = (Accessibility_DeviceEvent *)data;
2811   KeyCode code = event->hw_code;
2812
2813   released = is_key_released (code);
2814
2815   if (released)
2816     {
2817       check_release_handler = 0;
2818       event->type = Accessibility_KEY_RELEASED_EVENT;
2819       spi_controller_notify_keylisteners (saved_controller, event, TRUE);
2820     }
2821   return (released == 0);
2822 }
2823
2824 static void wait_for_release_event (XEvent          *event,
2825                                     SpiDEController *controller)
2826 {
2827   pressed_event = spi_keystroke_from_x_key_event ((XKeyEvent *) event);
2828   check_release_handler = g_timeout_add (CHECK_RELEASE_DELAY, check_release, &pressed_event);
2829 }
2830
2831 /*---------------------------------------------------------------------------*/
2832
2833 static const char *introspection_header =
2834 "<?xml version=\"1.0\"?>\n";
2835
2836 static const char *introspection_node_element =
2837 "<node name=\"%s\">\n";
2838
2839 static const char *introspection_footer =
2840 "</node>";
2841
2842 static DBusMessage *
2843 impl_Introspect (DBusConnection * bus,
2844                  DBusMessage * message, void *user_data)
2845 {
2846   GString *output;
2847   gchar *final;
2848   gint i;
2849
2850   const gchar *pathstr = SPI_DBUS_PATH_DEC;
2851
2852   DBusMessage *reply;
2853
2854   output = g_string_new(introspection_header);
2855
2856   g_string_append_printf(output, introspection_node_element, pathstr);
2857
2858   g_string_append (output, spi_org_a11y_atspi_DeviceEventController);
2859
2860   g_string_append(output, introspection_footer);
2861   final = g_string_free(output, FALSE);
2862
2863   reply = dbus_message_new_method_return (message);
2864   dbus_message_append_args(reply, DBUS_TYPE_STRING, &final, DBUS_TYPE_INVALID);
2865
2866   g_free(final);
2867   return reply;
2868 }
2869
2870 /*---------------------------------------------------------------------------*/
2871
2872 static void
2873 handle_dec_method_from_idle (DBusConnection *bus, DBusMessage *message, void *user_data)
2874 {
2875   const gchar *iface   = dbus_message_get_interface (message);
2876   const gchar *member  = dbus_message_get_member (message);
2877   const gint   type    = dbus_message_get_type (message);
2878   DBusHandlerResult result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
2879   DBusMessage *reply = NULL;
2880
2881   if (!strcmp (iface, SPI_DBUS_INTERFACE_DEC))
2882     {
2883       result = DBUS_HANDLER_RESULT_HANDLED;
2884       if      (!strcmp (member, "RegisterKeystrokeListener"))
2885           reply = impl_register_keystroke_listener (bus, message, user_data);
2886       else if (!strcmp (member, "RegisterDeviceEventListener"))
2887           reply = impl_register_device_event_listener (bus, message, user_data);
2888       else if (!strcmp (member, "DeregisterKeystrokeListener"))
2889           reply = impl_deregister_keystroke_listener (bus, message, user_data);
2890       else if (!strcmp (member, "DeregisterDeviceEventListener"))
2891           reply = impl_deregister_device_event_listener (bus, message, user_data);
2892       else if (!strcmp (member, "GenerateKeyboardEvent"))
2893           reply = impl_generate_keyboard_event (bus, message, user_data);
2894       else if (!strcmp (member, "GenerateMouseEvent"))
2895           reply = impl_generate_mouse_event (bus, message, user_data);
2896       else if (!strcmp (member, "NotifyListenersSync"))
2897           reply = impl_notify_listeners_sync (bus, message, user_data);
2898       else if (!strcmp (member, "NotifyListenersAsync"))
2899           reply = impl_notify_listeners_async (bus, message, user_data);
2900       else
2901           result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
2902     }
2903
2904   if (!strcmp (iface, "org.freedesktop.DBus.Introspectable"))
2905     {
2906       result = DBUS_HANDLER_RESULT_HANDLED;
2907       if      (!strcmp (member, "Introspect"))
2908           reply = impl_Introspect (bus, message, user_data);
2909       else
2910           result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
2911     }
2912
2913   if (result == DBUS_HANDLER_RESULT_HANDLED)
2914     {
2915       if (!reply)
2916         {
2917           reply = dbus_message_new_method_return (message);
2918         }
2919
2920       dbus_connection_send (bus, reply, NULL);
2921       dbus_message_unref (reply);
2922     }
2923 }
2924
2925 static gboolean
2926 message_queue_dispatch (gpointer data)
2927 {
2928   saved_controller->message_queue_idle = 0;
2929   while (!g_queue_is_empty (saved_controller->message_queue))
2930     {
2931       DBusMessage *message = g_queue_pop_head (saved_controller->message_queue);
2932       data = g_queue_pop_head (saved_controller->message_queue);
2933       handle_dec_method_from_idle (saved_controller->bus, message, data);
2934       dbus_message_unref (message);
2935     }
2936   return FALSE;
2937 }
2938
2939 static DBusHandlerResult
2940 handle_dec_method (DBusConnection *bus, DBusMessage *message, void *user_data)
2941 {
2942   const gchar *iface   = dbus_message_get_interface (message);
2943   const gchar *member  = dbus_message_get_member (message);
2944   const gint   type    = dbus_message_get_type (message);
2945
2946   /* Check for basic reasons not to handle */
2947   if (type   != DBUS_MESSAGE_TYPE_METHOD_CALL ||
2948       member == NULL ||
2949       iface  == NULL)
2950       return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
2951
2952   dbus_message_ref (message);
2953   g_queue_push_tail (saved_controller->message_queue, message);
2954   g_queue_push_tail (saved_controller->message_queue, user_data);
2955   if (!saved_controller->message_queue_idle)
2956     saved_controller->message_queue_idle = g_idle_add (message_queue_dispatch, NULL);
2957   return DBUS_HANDLER_RESULT_HANDLED;
2958 }
2959
2960 static DBusObjectPathVTable dec_vtable =
2961 {
2962   NULL,
2963   &handle_dec_method,
2964   NULL, NULL, NULL, NULL
2965 };
2966
2967 SpiDEController *
2968 spi_registry_dec_new (SpiRegistry *reg, DBusConnection *bus)
2969 {
2970   SpiDEController *dec = g_object_new (SPI_DEVICE_EVENT_CONTROLLER_TYPE, NULL);
2971
2972   dec->registry = g_object_ref (reg);
2973   reg->dec = g_object_ref (dec);
2974   dec->bus = bus;
2975
2976   dbus_connection_register_object_path (bus, SPI_DBUS_PATH_DEC, &dec_vtable, dec);
2977
2978   spi_dec_init_mouse_listener (dec);
2979
2980   return dec;
2981 }
2982
2983 void
2984 spi_device_event_controller_start_poll_mouse (SpiRegistry *registry)
2985 {
2986   if (!have_mouse_event_listener)
2987     {
2988       have_mouse_event_listener = TRUE;
2989       if (!have_mouse_listener)
2990       g_timeout_add (100, spi_dec_poll_mouse_idle, registry->dec);
2991     }
2992 }
2993
2994 void
2995 spi_device_event_controller_stop_poll_mouse (void)
2996 {
2997   have_mouse_event_listener = FALSE;
2998 }