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