registryd/deviceeventcontroller.c

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