atspi/atspi-registry.c

   1
   2 /*
   3  * AT-SPI - Assistive Technology Service Provider Interface
   4  * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
   5  *
   6  * Copyright 2001, 2002 Sun Microsystems Inc.,
   7  * Copyright 2001, 2002 Ximian, Inc.
   8  *
   9  * This library is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU Library General Public
  11  * License as published by the Free Software Foundation; either
  12  * version 2 of the License, or (at your option) any later version.
  13  *
  14  * This library is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * Library General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Library General Public
  20  * License along with this library; if not, write to the
  21  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  22  * Boston, MA 02111-1307, USA.
  23  */
  24
  25 /* atspi_registry.c: Global functions wrapping the registry */
  26
  27 #include "atspi-private.h"
  28
  29 /**
  30  * atspi_get_desktop_count:
  31  *
  32  * Gets the number of virtual desktops.
  33  * NOTE: multiple virtual desktops are not implemented yet; as a
  34  * consequence, this function always returns 1.
  35  *
  36  * Returns: a #gint indicating the number of active virtual desktops.
  37  **/
  38 gint
  39 atspi_get_desktop_count ()
  40 {
  41   return 1;
  42 }
  43
  44 /**
  45  * atspi_get_desktop:
  46  * @i: a #gint indicating which of the accessible desktops is to be returned.
  47  *
  48  * Gets the virtual desktop indicated by index @i.
  49  * NOTE: currently multiple virtual desktops are not implemented;
  50  * as a consequence, any @i value different from 0 will not return a
  51  * virtual desktop - instead it will return NULL.
  52  *
  53  * Returns: (transfer full): a pointer to the @i-th virtual desktop's
  54  * #AtspiAccessible representation.
  55  **/
  56 AtspiAccessible*
  57 atspi_get_desktop (gint i)
  58 {
  59   if (i != 0) return NULL;
  60   return _atspi_ref_accessible (atspi_bus_registry, atspi_path_root);
  61 }
  62
  63 /**
  64  * atspi_get_desktop_list:
  65  *
  66  * Gets the list of virtual desktops.  On return, @list will point
  67  *     to a newly-created, NULL terminated array of virtual desktop
  68  *     pointers.
  69  *     It is the responsibility of the caller to free this array when
  70  *     it is no longer needed.
  71  * NOTE: currently multiple virtual desktops are not implemented;
  72  * this implementation always returns a #Garray with a single
  73  * #AtspiAccessible desktop.
  74  *
  75  * Returns: (transfer full): a #GArray of desktops.
  76  **/
  77 GArray *
  78 atspi_get_desktop_list ()
  79 {
  80   GArray *array = g_array_new (TRUE, TRUE, sizeof (AtspiAccessible *));
  81   AtspiAccessible *desktop;
  82
  83   desktop = _atspi_ref_accessible (atspi_bus_registry, atspi_path_root);
  84   if (array)
  85     g_array_index (array, AtspiAccessible *, 0) = desktop;
  86   return array;
  87 }
  88
  89 /**
  90  * atspi_register_keystroke_listener:
  91  * @listener:  a pointer to the #AtspiDeviceListener for which
  92  *             keystroke events are requested.
  93  * @key_set: (element-type AtspiKeyDefinition) (allow-none): a pointer to the
  94  *        #AtspiKeyDefinition array indicating which keystroke events are
  95  *        requested, or NULL
  96  *        to indicate that all keycodes and keyvals for the specified
  97  *        modifier set are to be included.
  98  * @modmask:   an #AtspiKeyMaskType mask indicating which
  99  *             key event modifiers must be set in combination with @keys,
 100  *             events will only be reported for key events for which all
 101  *             modifiers in @modmask are set.  If you wish to listen for
 102  *             events with multiple modifier combinations, you must call
 103  *             #atspi_register_keystroke_listener once for each
 104  *             combination.
 105  * @event_types: an #AtspiKeyMaskType mask indicating which
 106  *             types of key events are requested (ATSPI_KEY_PRESSED etc.).
 107  * @sync_type: an #AtspiKeyListenerSyncType parameter indicating
 108  *             the behavior of the notification/listener transaction.
 109  *
 110  * Registers a listener for keystroke events, either pre-emptively for
 111  *             all windows (ATSPI_KEYLISTENER_ALL_WINDOWS),
 112  *             non-preemptively (ATSPI_KEYLISTENER_NOSYNC), or
 113  *             pre-emptively at the toolkit level (ATSPI_KEYLISTENER_CANCONSUME).
 114  *             If ALL_WINDOWS or CANCONSUME are used, the event is consumed
 115  *             upon receipt if one of @listener's callbacks returns #TRUE
 116  *             (other sync_type values may be available in the future).
 117  *
 118  * Returns: #TRUE if successful, otherwise #FALSE.
 119  **/
 120 gboolean
 121 atspi_register_keystroke_listener (AtspiDeviceListener  *listener,
 122                                          GArray             *key_set,
 123                                          AtspiKeyMaskType         modmask,
 124                                          AtspiKeyEventMask        event_types,
 125                                          gint sync_type, GError **error)
 126 {
 127   GArray *d_key_set;
 128   gchar *path = _atspi_device_listener_get_path (listener);
 129   gint                                i;
 130   dbus_uint32_t d_modmask = modmask;
 131   dbus_uint32_t d_event_types = event_types;
 132   AtspiEventListenerMode     listener_mode;
 133   gboolean                          retval = FALSE;
 134   DBusError d_error;
 135
 136   if (!listener)
 137     {
 138       return retval;
 139     }
 140
 141   /* copy the keyval filter values from the C api into the DBind KeySet */
 142   if (key_set)
 143     {
 144       d_key_set = g_array_sized_new (FALSE, TRUE, sizeof (AtspiKeyDefinition), key_set->len);
 145       d_key_set->len = key_set->len;
 146       for (i = 0; i < key_set->len; ++i)
 147         {
 148           AtspiKeyDefinition *kd =  ((AtspiKeyDefinition *) key_set->data) + i;
 149           AtspiKeyDefinition *d_kd =  ((AtspiKeyDefinition *) d_key_set->data) + i;
 150           d_kd->keycode = kd->keycode;
 151           d_kd->keysym = kd->keysym;
 152           if (kd->keystring)
 153             {
 154               d_kd->keystring = kd->keystring;
 155             }
 156           else
 157             {
 158               d_kd->keystring = "";
 159             }
 160         }
 161     }
 162   else
 163     {
 164       d_key_set = g_array_sized_new (FALSE, TRUE, sizeof (AtspiKeyDefinition), 0);
 165     }
 166
 167   listener_mode.synchronous =
 168           (dbus_bool_t) ((sync_type & ATSPI_KEYLISTENER_SYNCHRONOUS)!=0);
 169   listener_mode.preemptive =
 170           (dbus_bool_t) ((sync_type & ATSPI_KEYLISTENER_CANCONSUME)!=0);
 171   listener_mode.global =
 172           (dbus_bool_t) ((sync_type & ATSPI_KEYLISTENER_ALL_WINDOWS)!=0);
 173
 174     dbus_error_init (&d_error);
 175     dbind_method_call_reentrant (_atspi_bus(), atspi_bus_registry, atspi_path_dec, atspi_interface_dec, "RegisterKeystrokeListener", &d_error, "oa(iisi)uu(bbb)=>b", path, d_key_set, d_modmask, d_event_types, &listener_mode, &retval);
 176
 177   g_array_free (d_key_set, TRUE);
 178   g_free (path);
 179
 180   return retval;
 181 }
 182
 183 /**
 184  * atspi_deregister_keystroke_listener:
 185  * @listener: a pointer to the #AtspiDeviceListener for which
 186  *            keystroke events are requested.
 187  * @key_set: (element-type AtspiKeyDefinition) (allow-none): a pointer to the
 188  *        #AtspiKeyDefinition array indicating which keystroke events are
 189  *        requested, or NULL
 190  *        to indicate that all keycodes and keyvals for the specified
 191  *        modifier set are to be included.
 192  * @modmask:  the key modifier mask for which this listener is to be
 193  *            'deregistered' (of type #AtspiKeyMaskType).
 194  * @event_types: an #AtspiKeyMaskType mask indicating which
 195  *             types of key events were requested (#ATSPI_KEY_PRESSED, etc.).
 196  *
 197  * Removes a keystroke event listener from the registry's listener queue,
 198  *            ceasing notification of events with modifiers matching @modmask.
 199  *
 200  * Returns: #TRUE if successful, otherwise #FALSE.
 201  **/
 202 gboolean
 203 atspi_deregister_keystroke_listener (AtspiDeviceListener *listener,
 204                                      GArray              *key_set,
 205                                      AtspiKeyMaskType     modmask,
 206                                      AtspiKeyEventMask    event_types,
 207                                      GError             **error)
 208 {
 209   GArray *d_key_set;
 210   gchar *path = _atspi_device_listener_get_path (listener);
 211   gint i;
 212   dbus_uint32_t d_modmask = modmask;
 213   dbus_uint32_t d_event_types = event_types;
 214   DBusError d_error;
 215
 216   dbus_error_init (&d_error);
 217   if (!listener)
 218     {
 219       return FALSE;
 220     }
 221
 222   /* copy the keyval filter values from the C api into the DBind KeySet */
 223   if (key_set)
 224     {
 225       d_key_set = g_array_sized_new (FALSE, TRUE, sizeof (AtspiKeyDefinition), key_set->len);
 226       d_key_set->len = key_set->len;
 227       for (i = 0; i < key_set->len; ++i)
 228         {
 229           AtspiKeyDefinition *kd =  ((AtspiKeyDefinition *) key_set->data) + i;
 230           AtspiKeyDefinition *d_kd =  ((AtspiKeyDefinition *) d_key_set->data) + i;
 231           d_kd->keycode = kd->keycode;
 232           d_kd->keysym = kd->keysym;
 233           if (kd->keystring)
 234             {
 235               d_kd->keystring = kd->keystring;
 236             }
 237           else
 238             {
 239               d_kd->keystring = "";
 240             }
 241         }
 242     }
 243   else
 244     {
 245       d_key_set = g_array_sized_new (FALSE, TRUE, sizeof (AtspiKeyDefinition), 0);
 246     }
 247
 248   dbind_method_call_reentrant (_atspi_bus(), atspi_bus_registry,
 249                                atspi_path_dec, atspi_interface_dec,
 250                                "DeregisterKeystrokeListener", &d_error,
 251                                "oa(iisi)uu", path, d_key_set, d_modmask,
 252                                d_event_types);
 253   g_array_free (d_key_set, TRUE);
 254   g_free (path);
 255   return TRUE;
 256 }
 257
 258 /**
 259  * atspi_register_device_event_listener:
 260  * @listener:  a pointer to the #AtspiDeviceListener which requests
 261  *             the events.
 262  * @event_types: an #AtspiDeviceEventMask mask indicating which
 263  *             types of key events are requested (#ATSPI_KEY_PRESSED, etc.).
 264  * @filter: Unused parameter.
 265  *
 266  * Registers a listener for device events, for instance button events.
 267  *
 268  * Returns: #TRUE if successful, otherwise #FALSE.
 269  **/
 270 gboolean
 271 atspi_register_device_event_listener (AtspiDeviceListener  *listener,
 272                                  AtspiDeviceEventMask  event_types,
 273                                  void                      *filter, GError **error)
 274 {
 275   gboolean                          retval = FALSE;
 276   dbus_uint32_t d_event_types = event_types;
 277   gchar *path = _atspi_device_listener_get_path (listener);
 278   DBusError d_error;
 279
 280   dbus_error_init (&d_error);
 281   if (!listener)
 282     {
 283       return retval;
 284     }
 285
 286     dbind_method_call_reentrant (_atspi_bus(), atspi_bus_registry, atspi_path_dec, atspi_interface_dec, "RegisterDeviceEventListener", &d_error, "ou=>b", path, d_event_types, &retval);
 287   g_free (path);
 288   return retval;
 289 }
 290
 291 /**
 292  * atspi_deregister_device_event_listener:
 293  * @listener: a pointer to the #AtspiDeviceListener for which
 294  *            device events are requested.
 295  * @filter: Unused parameter.
 296  *
 297  * Removes a device event listener from the registry's listener queue,
 298  *            ceasing notification of events of the specified type.
 299  *
 300  * Returns: #TRUE if successful, otherwise #FALSE.
 301  **/
 302 gboolean
 303 atspi_deregister_device_event_listener (AtspiDeviceListener *listener,
 304                                    void                     *filter, GError **error)
 305 {
 306   dbus_uint32_t event_types = 0;
 307   gchar *path = _atspi_device_listener_get_path (listener);
 308   DBusError d_error;
 309
 310   dbus_error_init (&d_error);
 311
 312   if (!listener)
 313     {
 314       return FALSE;
 315     }
 316
 317   event_types |= (1 << ATSPI_BUTTON_PRESSED_EVENT);
 318   event_types |= (1 << ATSPI_BUTTON_RELEASED_EVENT);
 319
 320     dbind_method_call_reentrant (_atspi_bus(), atspi_bus_registry, atspi_path_dec, atspi_interface_dec, "DeregisterDeviceEventListener", &d_error, "ou", path, event_types);
 321   g_free (path);
 322   return TRUE;
 323 }
 324
 325 /**
 326  * atspi_generate_keyboard_event:
 327  * @keyval: a #gint indicating the keycode or keysym of the key event
 328  *           being synthesized.
 329  * @keystring: an (optional) UTF-8 string which, if @keyval is NULL,
 330  *           indicates a 'composed' keyboard input string
 331  *           being synthesized; this type of keyboard event synthesis does
 332  *           not emulate hardware keypresses but injects the string
 333  *           as though a composing input method (such as XIM) were used.
 334  * @synth_type: an #AtspiKeySynthType flag indicating whether @keyval
 335  *           is to be interpreted as a keysym rather than a keycode
 336  *           (ATSPI_KEYSYM), or whether to synthesize
 337  *           ATSPI_KEY_PRESS, ATSPI_KEY_RELEASE, or both (ATSPI_KEY_PRESSRELEASE).
 338  *
 339  * Synthesizes a keyboard event (as if a hardware keyboard event occurred in the
 340  * current UI context).
 341  *
 342  * Returns: #TRUE if successful, otherwise #FALSE.
 343  **/
 344 gboolean
 345 atspi_generate_keyboard_event (glong keyval,
 346                            const gchar *keystring,
 347                            AtspiKeySynthType synth_type, GError **error)
 348 {
 349   dbus_uint32_t d_synth_type = synth_type;
 350   dbus_int32_t d_keyval = keyval;
 351   DBusError d_error;
 352
 353   dbus_error_init (&d_error);
 354   if (!keystring) keystring = "";
 355     dbind_method_call_reentrant (_atspi_bus(), atspi_bus_registry, atspi_path_dec, atspi_interface_dec, "GenerateKeyboardEvent", &d_error, "isu", d_keyval, keystring, d_synth_type);
 356
 357   return TRUE;
 358 }
 359
 360 /**
 361  * atspi_generate_mouse_event:
 362  * @x: a #glong indicating the screen x coordinate of the mouse event.
 363  * @y: a #glong indicating the screen y coordinate of the mouse event.
 364  * @name: a string indicating which mouse event to be synthesized
 365  *        (e.g. "b1p", "b1c", "b2r", "rel", "abs").
 366  *
 367  * Synthesizes a mouse event at a specific screen coordinate.
 368  * Most AT clients should use the #AccessibleAction interface when
 369  * tempted to generate mouse events, rather than this method.
 370  * Event names: b1p = button 1 press; b2r = button 2 release;
 371  *              b3c = button 3 click; b2d = button 2 double-click;
 372  *              abs = absolute motion; rel = relative motion.
 373  *
 374  * Returns: #TRUE if successful, otherwise #FALSE.
 375  **/
 376 gboolean
 377 atspi_generate_mouse_event (glong x, glong y, const gchar *name, GError **error)
 378 {
 379   dbus_int32_t d_x = x, d_y = y;
 380   DBusError d_error;
 381
 382   dbus_error_init (&d_error);
 383     dbind_method_call_reentrant (_atspi_bus(), atspi_bus_registry,
 384                                  atspi_path_dec, atspi_interface_dec,
 385                                  "GenerateMouseEvent", &d_error, "iis",
 386                                  d_x, d_y, name);
 387   return TRUE;
 388 }
 389
 390 AtspiKeyDefinition *
 391 atspi_key_definition_copy (AtspiKeyDefinition *src)
 392 {
 393   AtspiKeyDefinition *dst;
 394
 395   dst = g_new0 (AtspiKeyDefinition, 1);
 396   dst->keycode = src->keycode;
 397   dst->keysym = src->keysym;
 398   if (src->keystring)
 399     dst->keystring = g_strdup (src->keystring);
 400   dst->unused = src->unused;
 401   return dst;
 402 }
 403
 404 void
 405 atspi_key_definition_free (AtspiKeyDefinition *kd)
 406 {
 407   if (kd->keystring)
 408     g_free (kd->keystring);
 409   g_free (kd);
 410 }
 411
 412 G_DEFINE_BOXED_TYPE (AtspiKeyDefinition, atspi_key_definition, atspi_key_definition_copy, atspi_key_definition_free)