-
/*
+ * AT-SPI - Assistive Technology Service Provider Interface
+ * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
+ *
+ * Copyright 2001 Sun Microsystems Inc.
*
- * Global functions serviced by the registry
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Library General Public
+ * License as published by the Free Software Foundation; either
+ * version 2 of the License, or (at your option) any later version.
*
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Library General Public License for more details.
+ *
+ * You should have received a copy of the GNU Library General Public
+ * License along with this library; if not, write to the
+ * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
+ * Boston, MA 02111-1307, USA.
*/
-/* static stuff used only by registry C bindings */
-static GList *key_listeners = NULL;
-static Display *display = NULL;
+/* spi_registry.c: Global functions wrapping the registry */
+
+#include <cspi/spi-private.h>
/**
- * registerGlobalEventListener:
- * @listener: the #AccessibleEventListener to be registered against an event type.
- * @callback: a character string indicating the type of events for which
+ * SPI_registerGlobalEventListener:
+ * @listener: the #AccessibleEventListener to be registered against an
+ * event type.
+ * @eventType: a character string indicating the type of events for which
* notification is requested. Format is
* EventClass:major_type:minor_type:detail
* where all subfields other than EventClass are optional.
- * EventClasses include "Focus", "Window", "Mouse",
+ * EventClasses include "object", "window", "mouse",
* and toolkit events (e.g. "Gtk", "AWT").
* Examples: "focus:", "Gtk:GtkWidget:button_press_event".
*
- * NOTE: this string may be UTF-8, but should not contain byte value 56 (ascii ':'),
- * except as a delimiter, since non-UTF-8 string delimiting
- * functions are used internally. In general, listening to
+ * Legal object event types:
+ *
+ * (property change events)
+ *
+ * object:property-change
+ * object:property-change:accessible-name
+ * object:property-change:accessible-state
+ * object:property-change:accessible-description
+ * object:property-change:accessible-parent
+ * object:property-change:accessible-value
+ * object:property-change:accessible-role
+ * object:property-change:accessible-table-caption
+ * object:property-change:accessible-table-column-description
+ * object:property-change:accessible-table-column-header
+ * object:property-change:accessible-table-row-description
+ * object:property-change:accessible-table-row-header
+ * object:property-change:accessible-table-summary
+ *
+ * (other object events)
+ *
+ * object:children-changed
+ * object:visible-data-changed
+ * object:selection-changed
+ * object:text-selection-changed
+ * object:text-changed
+ * object:text-caret-moved
+ * object:row-inserted
+ * object:row-reordered
+ * object:row-deleted
+ * object:column-inserted
+ * object:column-reordered
+ * object:column-deleted
+ * object:model-changed
+ *
+ * (window events)
+ *
+ * window:minimize
+ * window:maximize
+ * window:restore
+ * window:close
+ * window:create
+ * window:reparent
+ * window:desktop-create
+ * window:desktop-destroy
+ * window:focus-in
+ * window:focus-out
+ * window:raise
+ * window:lower
+ * window:move
+ * window:resize
+ * window:shade
+ * window:unshade
+ * window:restyle
+ *
+ * NOTE: this string may be UTF-8, but should not contain byte value 56
+ * (ascii ':'), except as a delimiter, since non-UTF-8 string
+ * delimiting functions are used internally.
+ * In general, listening to
* toolkit-specific events is not recommended.
*
* Add an in-process callback function to an existing AccessibleEventListener.
*
* Returns: #TRUE if successful, otherwise #FALSE.
- *
**/
-boolean
-registerGlobalEventListener (AccessibleEventListener *listener,
- char *eventType)
+SPIBoolean
+SPI_registerGlobalEventListener (AccessibleEventListener *listener,
+ const char *eventType)
{
- Accessibility_Registry_registerGlobalEventListener (
- registry,
- (Accessibility_EventListener)
- bonobo_object_corba_objref (bonobo_object (listener)),
- eventType,
- &ev);
+ SPIBoolean retval;
- if (ev._major != CORBA_NO_EXCEPTION)
+ if (!listener)
{
- return FALSE;
- }
- else
- {
- return TRUE;
+ return FALSE;
}
+
+ Accessibility_Registry_registerGlobalEventListener (
+ cspi_registry (),
+ cspi_event_listener_get_corba (listener),
+ eventType, cspi_ev ());
+
+ retval = !cspi_exception ();
+
+ return retval;
}
/**
- * deregisterGlobalEventListener:
- * @listener: the #AccessibleEventListener to be registered against an event type.
+ * SPI_deregisterGlobalEventListenerAll:
+ * @listener: the #AccessibleEventListener to be registered against
+ * an event type.
*
- * deregisters an AccessibleEventListener from the registry, for all event types it may be listening to.
+ * deregisters an AccessibleEventListener from the registry, for all
+ * event types it may be listening to. Use
+ * AccessibleEventListener_unref to release the
+ * listener reference.
*
* Returns: #TRUE if successful, otherwise #FALSE.
- *
**/
-boolean
-deregisterGlobalEventListenerAll (AccessibleEventListener *listener)
+SPIBoolean
+SPI_deregisterGlobalEventListenerAll (AccessibleEventListener *listener)
{
- Accessibility_Registry_deregisterGlobalEventListenerAll (
- registry,
- (Accessibility_EventListener)
- CORBA_Object_duplicate (bonobo_object_corba_objref (bonobo_object (listener)), &ev),
- &ev);
-
- if (ev._major != CORBA_NO_EXCEPTION)
+ if (!listener)
{
- return FALSE;
+ return FALSE;
}
- else
+
+ Accessibility_Registry_deregisterGlobalEventListenerAll (
+ cspi_registry (),
+ cspi_event_listener_get_corba (listener),
+ cspi_ev ());
+
+ return !cspi_exception ();
+}
+
+/**
+ * SPI_deregisterGlobalEventListener:
+ * @listener: the #AccessibleEventListener registered against an event type.
+ * @eventType: a string specifying the event type for which this
+ * listener is to be deregistered.
+ *
+ * deregisters an AccessibleEventListener from the registry, for a specific
+ * event type.
+ *
+ * Returns: #TRUE if successful, otherwise #FALSE.
+ **/
+SPIBoolean
+SPI_deregisterGlobalEventListener (AccessibleEventListener *listener,
+ const char *eventType)
+{
+ if (!listener)
{
- return TRUE;
+ return FALSE;
}
+
+ Accessibility_Registry_deregisterGlobalEventListener (
+ cspi_registry (),
+ cspi_event_listener_get_corba (listener),
+ (CORBA_char *) eventType, cspi_ev ());
+
+ return !cspi_exception ();
}
/**
- * getDesktopCount:
+ * SPI_getDesktopCount:
*
* Get the number of virtual desktops.
* NOTE: currently multiple virtual desktops are not implemented, this
* function always returns '1'.
*
* Returns: an integer indicating the number of active virtual desktops.
- *
**/
int
-getDesktopCount ()
+SPI_getDesktopCount ()
{
- return Accessibility_Registry_getDesktopCount (registry, &ev);
+ int retval;
+
+ retval = Accessibility_Registry_getDesktopCount (
+ cspi_registry (), cspi_ev ());
+
+ cspi_return_val_if_ev ("getDesktopCount", -1);
+
+ return retval;
}
/**
- * getDesktop:
+ * SPI_getDesktop:
* @i: an integer indicating which of the accessible desktops is to be returned.
*
* Get the virtual desktop indicated by index @i.
* function always returns '1'.
*
* Returns: a pointer to the 'i-th' virtual desktop's #Accessible representation.
- *
**/
Accessible*
-getDesktop (int n)
+SPI_getDesktop (int i)
{
- return Obj_Add (Accessibility_Registry_getDesktop (registry, (CORBA_short) n, &ev));
+ return cspi_object_add (
+ Accessibility_Registry_getDesktop (
+ cspi_registry (), (CORBA_short) i, cspi_ev ()));
}
/**
- * getDesktopList:
+ * SPI_getDesktopList:
* @list: a pointer to an array of #Accessible objects.
*
* Get the list of virtual desktops. On return, @list will point
* It is the responsibility of the caller to free this array when
* it is no longer needed.
*
- * Not Yet Implemented.
+ * Not Yet Implemented : this implementation always returns a single
+ * #Accessible desktop.
*
* Returns: an integer indicating how many virtual desktops have been
* placed in the list pointed to by parameter @list.
**/
int
-getDesktopList (Accessible **list)
+SPI_getDesktopList (Accessible **list)
{
*list = NULL;
return 0;
}
-static gboolean
-key_event_source_func (void *p)
+/**
+ * SPI_registerAccessibleKeystrokeListener:
+ * @listener: a pointer to the #AccessibleKeystrokeListener for which
+ * keystroke events are requested.
+ * @keys: a pointer to the #AccessibleKeySet indicating which
+ * keystroke events are requested, or #CSPI_KEYSET_ALL_KEYS.
+ * @modmask: an #AccessibleKeyMaskType mask indicating which
+ * key event modifiers must be set in combination with @keys,
+ * events will only be reported for key events for which all
+ * modifiers in @modmask are set. If you wish to listen for
+ * events with multiple modifier combinations you must call
+ * registerAccessibleKeystrokeListener() once for each combination.
+ * @eventmask: an #AccessibleKeyMaskType mask indicating which
+ * types of key events are requested (#SPI_KEY_PRESSED, etc.).
+ * @sync_type: a #AccessibleKeyListenerSyncType parameter indicating
+ * the behavior of the notification/listener transaction.
+ *
+ * Register a listener for keystroke events, either pre-emptively for
+ * all windows (CSPI_KEYLISTENER_ALL_WINDOWS), or
+ * non-preemptively (CSPI_KEYLISTENER_NOSYNC).
+ * ( Other sync_type values may be available in the future.)
+ *
+ * Returns: #TRUE if successful, otherwise #FALSE.
+ **/
+SPIBoolean
+SPI_registerAccessibleKeystrokeListener (AccessibleKeystrokeListener *listener,
+ AccessibleKeySet *keys,
+ AccessibleKeyMaskType modmask,
+ AccessibleKeyEventMask eventmask,
+ AccessibleKeyListenerSyncType sync_type)
{
- GList *listeners = (GList *)p;
- XEvent *x_event = g_new0 (XEvent, 1);
- while (XPending (display))
+ gint i, mask;
+ Accessibility_KeySet key_set;
+ Accessibility_KeyEventTypeSeq key_events;
+ Accessibility_ControllerEventMask controller_event_mask;
+ Accessibility_DeviceEventController device_event_controller;
+ Accessibility_EventListenerMode listener_mode;
+
+ if (!listener)
+ {
+ return FALSE;
+ }
+
+ device_event_controller =
+ Accessibility_Registry_getDeviceEventController (cspi_registry (), cspi_ev ());
+
+ cspi_return_val_if_ev ("getting event controller", FALSE);
+
+ /* copy the keyval filter values from the C api into the CORBA KeySet */
+ if (keys)
+ {
+ key_set._length = keys->len;
+ key_set._buffer = Accessibility_KeySet_allocbuf (keys->len);
+ for (i = 0; i < key_set._length; ++i)
+ {
+ /* we overload the keyset long w/keycodes, the - bit acts as a flag */
+ key_set._buffer[i] = (keys->keysyms[i]) ? keys->keysyms[i] :
+ - keys->keycodes[i];
+ /* fprintf (stderr, "key-set %d = %d\n", i, (int) key_set->_buffer[i]); */
+ }
+ }
+ else
{
- XNextEvent (display, x_event);
- while (listeners)
+ key_set._length = 0;
+ key_set._buffer = NULL;
+ }
+
+ /* copy the event filter values from the C api into the CORBA KeyEventTypeSeq */
+ mask = 1;
+ i = 0;
+ do
+ {
+ if (mask & eventmask)
{
- /* if the listener mask matches, notify it*/
- if (1)
- {
- ;
- }
+ ++i;
}
+ mask <<= 1;
}
- return TRUE;
-}
-
-void
-save_this_impl_registerKeystrokeListener (KeystrokeListener *listener, KeyMaskType keymask)
-{
- static gboolean initialized = FALSE;
- static Window grab_window;
- XEvent *x_event = g_new0(XEvent, 1);
- key_listeners = g_list_append (key_listeners, listener);
- if (!initialized)
+ while (mask & 0xFFFF);
+
+ key_events._buffer = Accessibility_KeyEventTypeSeq_allocbuf (i);
+ i = 0;
+ if (eventmask & SPI_KEY_PRESSED)
{
- g_timeout_add_full (G_PRIORITY_HIGH_IDLE, 200, key_event_source_func, key_listeners, NULL);
- display = XOpenDisplay (getenv ("DISPLAY"));
- grab_window = DefaultRootWindow (display);
- XSelectInput (display, grab_window, KeyPress | KeyRelease);
- initialized = TRUE;
+ key_events._buffer[i++] = Accessibility_KEY_PRESSED;
}
- /* */
- XGrabKey (display,
- AnyKey,
- LockMask,
- grab_window,
- False,
- GrabModeAsync,
- GrabModeAsync);
- while (0)
- {
- XNextEvent (display, x_event);
- g_print ("foo!\n");
- }
-}
-
-/**
- * registerKeystrokeListener:
- * @listener: a pointer to the #KeystrokeListener for which
- * keystroke events are requested.
- *
- **/
-void
-registerKeystrokeListener (KeystrokeListener *listener,
- KeySet *keys,
- KeyMaskType modmask,
- KeyEventMask eventmask,
- KeyListenerSyncType sync_type)
-{
- Accessibility_ControllerEventMask *controller_event_mask =
- Accessibility_ControllerEventMask__alloc();
- Accessibility_DeviceEventController device_event_controller =
- Accessibility_Registry_getDeviceEventController (registry, &ev);
- Accessibility_KeySet *all_keys = Accessibility_KeySet__alloc();
- Accessibility_KeyEventTypeSeq *key_events = Accessibility_KeyEventTypeSeq__alloc();
- Accessibility_KeystrokeListener listener_corba_ref;
- Accessibility_DeviceEventController_ref (device_event_controller, &ev);
- controller_event_mask->value = (CORBA_unsigned_long) modmask;
- controller_event_mask->refcount = (CORBA_unsigned_short) 1;
-
- listener_corba_ref = (Accessibility_KeystrokeListener)
- CORBA_Object_duplicate (bonobo_object_corba_objref (bonobo_object (listener)), &ev);
+ if (eventmask & SPI_KEY_RELEASED)
+ {
+ key_events._buffer[i++] = Accessibility_KEY_RELEASED;
+ }
+ key_events._length = i;
- Accessibility_DeviceEventController_registerKeystrokeListener (
- device_event_controller,
- listener_corba_ref,
- all_keys,
- controller_event_mask,
- key_events,
- (CORBA_boolean) ((sync_type | KEYLISTENER_CANCONSUME)!=0),
- &ev);
+ controller_event_mask = (CORBA_unsigned_long) modmask;
+
+ listener_mode.synchronous =
+ (CORBA_boolean) ((sync_type & SPI_KEYLISTENER_SYNCHRONOUS)!=0);
+ listener_mode.preemptive =
+ (CORBA_boolean) ((sync_type & SPI_KEYLISTENER_CANCONSUME)!=0);
+ listener_mode.global =
+ (CORBA_boolean) ((sync_type & SPI_KEYLISTENER_ALL_WINDOWS)!=0);
+
+ Accessibility_DeviceEventController_registerKeystrokeListener (
+ device_event_controller,
+ cspi_event_listener_get_corba (listener),
+ &key_set,
+ controller_event_mask,
+ &key_events,
+ &listener_mode,
+ cspi_ev ());
+
+ cspi_return_val_if_ev ("registering keystroke listener", FALSE);
+
+ cspi_release_unref (device_event_controller);
+
+ return TRUE;
}
/**
- * deregisterKeystrokeListener:
- * @listener: a pointer to the #KeystrokeListener for which
+ * SPI_deregisterAccessibleKeystrokeListener:
+ * @listener: a pointer to the #AccessibleKeystrokeListener for which
* keystroke events are requested.
+ * @modmask: the key modifier mask for which this listener is to be
+ * 'deregistered' (of type #AccessibleeyMaskType).
+ *
+ * Removes a keystroke event listener from the registry's listener queue,
+ * ceasing notification of events with modifiers matching @modmask.
*
+ * Returns: #TRUE if successful, otherwise #FALSE.
**/
-void
-deregisterKeystrokeListener (KeystrokeListener *listener, KeyMaskType keymask)
+SPIBoolean
+SPI_deregisterAccessibleKeystrokeListener (AccessibleKeystrokeListener *listener,
+ AccessibleKeyMaskType modmask)
{
- Accessibility_ControllerEventMask *controller_event_mask =
- Accessibility_ControllerEventMask__alloc();
- Accessibility_DeviceEventController device_event_controller =
- Accessibility_Registry_getDeviceEventController (registry, &ev);
- Accessibility_KeySet *all_keys = Accessibility_KeySet__alloc();
- Accessibility_KeyEventTypeSeq *key_events = Accessibility_KeyEventTypeSeq__alloc();
- Accessibility_KeystrokeListener listener_corba_ref;
- Accessibility_DeviceEventController_unref (device_event_controller, &ev);
- controller_event_mask->value = (CORBA_unsigned_long) keymask;
- controller_event_mask->refcount = (CORBA_unsigned_short) 1;
-
- listener_corba_ref = (Accessibility_KeystrokeListener)
- CORBA_Object_duplicate (bonobo_object_corba_objref (bonobo_object (listener)), &ev);
-
+ Accessibility_ControllerEventMask controller_event_mask;
+ Accessibility_KeySet key_set;
+ Accessibility_KeyEventTypeSeq key_events;
+ Accessibility_DeviceEventController device_event_controller;
+
+ if (!listener)
+ {
+ return FALSE;
+ }
+
+ device_event_controller =
+ Accessibility_Registry_getDeviceEventController (cspi_registry (), cspi_ev ());
+
+ cspi_return_val_if_ev ("getting keystroke listener", FALSE);
+
+ controller_event_mask = (CORBA_unsigned_long) modmask;
+
+ key_events._buffer = NULL;
+ key_events._length = 0;
+
+ key_set._buffer = NULL;
+ key_set._length = 0;
+
Accessibility_DeviceEventController_deregisterKeystrokeListener (
- device_event_controller,
- listener_corba_ref,
- all_keys,
- controller_event_mask,
- key_events,
- (CORBA_boolean) TRUE,
- &ev);
+ device_event_controller,
+ cspi_event_listener_get_corba (listener),
+ &key_set,
+ controller_event_mask,
+ &key_events,
+ cspi_ev ());
+
+ cspi_release_unref (device_event_controller);
+
+ return TRUE;
}
/**
- * generateKeyEvent:
- * @keycode: a #long indicating the keycode of the key event
+ * SPI_generateKeyboardEvent:
+ * @keyval: a long integer indicating the keycode or keysym of the key event
* being synthesized.
- * @meta: a #long indicating the key modifiers to be sent
- * with the event, if any.
+ * @synth_type: a #AccessibleKeySynthType flag indicating whether @keyval
+ * is to be interpreted as a keysym rather than a keycode
+ * (CSPI_KEYSYM), or whether to synthesize
+ * SPI_KEY_PRESS, SPI_KEY_RELEASE, or both (SPI_KEY_PRESSRELEASE).
*
* Synthesize a keyboard event (as if a hardware keyboard event occurred in the
* current UI context).
- * Not Yet Implemented.
*
+ * Returns: #TRUE if successful, otherwise #FALSE.
**/
-void
-generateKeyEvent (long keyval, KeySynthType type)
+SPIBoolean
+SPI_generateKeyboardEvent (long int keyval,
+ char *keystring,
+ AccessibleKeySynthType synth_type)
{
/* TODO: check current modifier status and
* send keycode to alter, if necessary
*/
+
+ /* TODO: implement keystring use case */
+ Accessibility_KeySynthType keysynth_type;
Accessibility_DeviceEventController device_event_controller =
- Accessibility_Registry_getDeviceEventController (registry, &ev);
- Accessibility_DeviceEventController_generateKeyEvent (device_event_controller,
- keyval,
- (unsigned long) type,
- &ev);
+ Accessibility_Registry_getDeviceEventController (cspi_registry (), cspi_ev ());
+
+ cspi_return_val_if_ev ("getting event controller for key event gen", FALSE);
+
+ switch (synth_type)
+ {
+ case SPI_KEY_PRESS:
+ keysynth_type = Accessibility_KEY_PRESS;
+ break;
+ case SPI_KEY_RELEASE:
+ keysynth_type = Accessibility_KEY_RELEASE;
+ break;
+ case SPI_KEY_PRESSRELEASE:
+ keysynth_type = Accessibility_KEY_PRESSRELEASE;
+ break;
+ case SPI_KEY_SYM:
+ keysynth_type = Accessibility_KEY_SYM;
+ break;
+ case SPI_KEY_STRING:
+ keysynth_type = Accessibility_KEY_STRING;
+ break;
+ }
+
+ Accessibility_DeviceEventController_generateKeyboardEvent (device_event_controller,
+ keyval,
+ "",
+ keysynth_type,
+ cspi_ev ());
+
+ cspi_return_val_if_ev ("generating keyboard event", FALSE);
+
+ cspi_release_unref (device_event_controller);
+
+ return TRUE;
}
/**
- * generateMouseEvent:
+ * SPI_generateMouseEvent:
* @x: a #long indicating the screen x coordinate of the mouse event.
* @y: a #long indicating the screen y coordinate of the mouse event.
* @name: a string indicating which mouse event to be synthesized
* (e.g. "button1", "button2", "mousemove").
*
* Synthesize a mouse event at a specific screen coordinate.
+ * Most AT clients should use the #AccessibleAction interface when
+ * tempted to generate mouse events, rather than this method.
* Not Yet Implemented.
*
+ * Returns: #TRUE if successful, otherwise #FALSE.
**/
-void
-generateMouseEvent (long x, long y, char *name)
+SPIBoolean
+SPI_generateMouseEvent (long x, long y, char *name)
{
- ;
+ return FALSE;
}