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