2003-04-25 Padraig O'Briain <padraig.obriain@sun.com>
[platform/core/uifw/at-spi2-atk.git] / cspi / spi_registry.c
1 /*
2  * AT-SPI - Assistive Technology Service Provider Interface
3  * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
4  *
5  * Copyright 2001, 2002 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 /* spi_registry.c: Global functions wrapping the registry */
25
26 #include <cspi/spi-private.h>
27
28 /**
29  * SPI_registerGlobalEventListener:
30  * @listener: the #AccessibleEventListener to be registered against an
31  *            event type.
32  * @eventType: a character string indicating the type of events for which
33  *            notification is requested.  Format is
34  *            EventClass:major_type:minor_type:detail
35  *            where all subfields other than EventClass are optional.
36  *            EventClasses include "object", "window", "mouse",
37  *            and toolkit events (e.g. "Gtk", "AWT").
38  *            Examples: "focus:", "Gtk:GtkWidget:button_press_event".
39  *
40  * Legal object event types:
41  *
42  *    (property change events)
43  *
44  *            object:property-change
45  *            object:property-change:accessible-name
46  *            object:property-change:accessible-description
47  *            object:property-change:accessible-parent
48  *            object:property-change:accessible-value
49  *            object:property-change:accessible-role
50  *            object:property-change:accessible-table-caption
51  *            object:property-change:accessible-table-column-description
52  *            object:property-change:accessible-table-column-header
53  *            object:property-change:accessible-table-row-description
54  *            object:property-change:accessible-table-row-header
55  *            object:property-change:accessible-table-summary
56  *
57  *    (other object events)
58  *
59  *            object:state-changed 
60  *            object:children-changed
61  *            object:visible-data-changed
62  *            object:selection-changed
63  *            object:text-selection-changed
64  *            object:text-changed
65  *            object:text-caret-moved
66  *            object:row-inserted
67  *            object:row-reordered
68  *            object:row-deleted
69  *            object:column-inserted
70  *            object:column-reordered
71  *            object:column-deleted
72  *            object:model-changed
73  *            object:active-descendant-changed
74  *
75  *  (window events)
76  *
77  *            window:minimize
78  *            window:maximize
79  *            window:restore
80  *            window:close
81  *            window:create
82  *            window:reparent
83  *            window:desktop-create
84  *            window:desktop-destroy
85  *            window:activate
86  *            window:deactivate
87  *            window:raise
88  *            window:lower
89  *            window:move
90  *            window:resize
91  *            window:shade
92  *            window:unshade
93  *            window:restyle
94  *
95  *  (other events)
96  *
97  *            focus:
98  *            mouse:abs
99  *            mouse:rel
100  *            mouse:b1p
101  *            mouse:b1r
102  *            mouse:b2p
103  *            mouse:b2r
104  *            mouse:b3p
105  *            mouse:b3r
106  *
107  * NOTE: this string may be UTF-8, but should not contain byte value 56
108  *            (ascii ':'), except as a delimiter, since non-UTF-8 string
109  *            delimiting functions are used internally.
110  *            In general, listening to
111  *            toolkit-specific events is not recommended.
112  *
113  * Add an in-process callback function to an existing AccessibleEventListener.
114  *
115  * Returns: #TRUE if successful, otherwise #FALSE.
116  **/
117 SPIBoolean
118 SPI_registerGlobalEventListener (AccessibleEventListener *listener,
119                                  const char              *eventType)
120 {
121   if (!listener)
122     {
123       return FALSE;
124     }
125
126   Accessibility_Registry_registerGlobalEventListener (
127     cspi_registry (),
128     cspi_event_listener_get_corba (listener),
129     eventType, cspi_ev ());
130
131   return  !cspi_exception ();
132 }
133
134 /**
135  * SPI_deregisterGlobalEventListenerAll:
136  * @listener: the #AccessibleEventListener to be registered against
137  *            an event type.
138  *
139  * deregisters an AccessibleEventListener from the registry, for all
140  *            event types it may be listening to. Use
141  *            AccessibleEventListener_unref to release the
142  *            listener reference.
143  *
144  * Returns: #TRUE if successful, otherwise #FALSE.
145  **/
146 SPIBoolean
147 SPI_deregisterGlobalEventListenerAll (AccessibleEventListener *listener)
148 {
149   if (!listener)
150     {
151       return FALSE;
152     }
153
154   Accessibility_Registry_deregisterGlobalEventListenerAll (
155     cspi_registry (),
156     cspi_event_listener_get_corba (listener),
157     cspi_ev ());
158
159   return !cspi_exception ();
160 }
161
162 /**
163  * SPI_deregisterGlobalEventListener:
164  * @listener: the #AccessibleEventListener registered against an event type.
165  * @eventType: a string specifying the event type for which this
166  *             listener is to be deregistered.
167  *
168  * deregisters an AccessibleEventListener from the registry, for a specific
169  *             event type.
170  *
171  * Returns: #TRUE if successful, otherwise #FALSE.
172  **/
173 SPIBoolean
174 SPI_deregisterGlobalEventListener (AccessibleEventListener *listener,
175                                    const char              *eventType)
176 {
177   if (!listener)
178     {
179       return FALSE;
180     }
181
182   Accessibility_Registry_deregisterGlobalEventListener (
183     cspi_registry (), 
184     cspi_event_listener_get_corba (listener),
185     eventType, cspi_ev ());
186
187   return !cspi_exception ();
188 }
189
190 /**
191  * SPI_getDesktopCount:
192  *
193  * Get the number of virtual desktops.
194  * NOTE: currently multiple virtual desktops are not implemented, this
195  *       function always returns '1'.
196  *
197  * Returns: an integer indicating the number of active virtual desktops.
198  **/
199 int
200 SPI_getDesktopCount ()
201 {
202   int retval;
203
204   retval = Accessibility_Registry_getDesktopCount (
205     cspi_registry (), cspi_ev ());
206
207   cspi_return_val_if_ev ("getDesktopCount", -1);
208
209   return retval;
210 }
211
212 /**
213  * SPI_getDesktop:
214  * @i: an integer indicating which of the accessible desktops is to be returned.
215  *
216  * Get the virtual desktop indicated by index @i.
217  * NOTE: currently multiple virtual desktops are not implemented, this
218  *       function always returns '1'.
219  *
220  * Returns: a pointer to the 'i-th' virtual desktop's #Accessible representation.
221  **/
222 Accessible*
223 SPI_getDesktop (int i)
224 {
225   return cspi_object_add (
226     Accessibility_Registry_getDesktop (
227       cspi_registry (), i, cspi_ev ()));
228 }
229
230 /**
231  * SPI_getDesktopList:
232  * @desktop_list: a pointer to an array of #Accessible references.
233  *
234  * Get the list of virtual desktops.  On return, @list will point
235  *     to a newly-created, NULL terminated array of virtual desktop
236  *     pointers.
237  *     It is the responsibility of the caller to free this array when
238  *     it is no longer needed.
239  *
240  * Not Yet Implemented : this implementation always returns a single
241  * #Accessible desktop.
242  *
243  * Returns: an integer indicating how many virtual desktops have been
244  *          placed in the list pointed to by parameter @list.
245  **/
246 int
247 SPI_getDesktopList (Accessible ***desktop_list)
248 {
249   int i;
250   Accessible **list;
251   Accessibility_DesktopSeq *desktops;
252
253   if (!desktop_list)
254           return 0;
255
256   *desktop_list = NULL;
257
258   desktops = Accessibility_Registry_getDesktopList (cspi_registry (),
259                                                     cspi_ev ());
260
261   cspi_return_val_if_ev ("getDesktopList", 0);
262
263   list = g_new0 (Accessible *, desktops->_length + 1);
264
265   for (i = 0; i < desktops->_length; i++)
266     {
267       list [i] = cspi_object_add (
268               CORBA_Object_duplicate (desktops->_buffer [i], cspi_ev ()));
269     }
270   list [i] = NULL;
271
272   CORBA_free (desktops);
273
274   *desktop_list = list;
275
276   return i;
277 }
278
279 /**
280  * SPI_freeDesktopList:
281  * @desktop_list: a pointer to an array of #Accessible objects
282  * as returned from @SPI_getDesktopList
283  * 
284  * This routine frees the memory associated with the list.
285  **/
286 void
287 SPI_freeDesktopList (Accessible **desktop_list)
288 {
289   Accessible **p;
290   
291   for (p = desktop_list; p && *p; p++)
292     {
293       cspi_object_unref (*p);
294     }
295   g_free (desktop_list);
296 }
297
298 /**
299  * SPI_KEYSET_ALL_KEYS:
300  * @SPI_KEYSET_ALL_KEYS: A special value for an AccessibleKeySet type, which tacitly
301  *                       includes all keycodes and keyvals for the specified modifier set.
302  **/
303
304 /**
305  * SPI_registerAccessibleKeystrokeListener:
306  * @listener:  a pointer to the #AccessibleKeystrokeListener for which
307  *             keystroke events are requested.
308  * @keys:      a pointer to the #AccessibleKeySet indicating which
309  *             keystroke events are requested, or #CSPI_KEYSET_ALL_KEYS
310  *             to indicate that all keycodes and keyvals for the specified
311  *             modifier set are to be included.
312  * @modmask:   an #AccessibleKeyMaskType mask indicating which
313  *             key event modifiers must be set in combination with @keys,
314  *             events will only be reported for key events for which all
315  *             modifiers in @modmask are set.  If you wish to listen for
316  *             events with multiple modifier combinations you must call
317  *             registerAccessibleKeystrokeListener() once for each combination.
318  * @eventmask: an #AccessibleKeyMaskType mask indicating which
319  *             types of key events are requested (#SPI_KEY_PRESSED, etc.).
320  * @sync_type: a #AccessibleKeyListenerSyncType parameter indicating
321  *             the behavior of the notification/listener transaction.
322  *             
323  * Register a listener for keystroke events, either pre-emptively for
324  *             all windows (CSPI_KEYLISTENER_ALL_WINDOWS), or
325  *             non-preemptively (CSPI_KEYLISTENER_NOSYNC).
326  *             ( Other sync_type values may be available in the future.)
327  *
328  * Returns: #TRUE if successful, otherwise #FALSE.
329  **/
330 SPIBoolean
331 SPI_registerAccessibleKeystrokeListener (AccessibleKeystrokeListener  *listener,
332                                          AccessibleKeySet             *keys,
333                                          AccessibleKeyMaskType         modmask,
334                                          AccessibleKeyEventMask        eventmask,
335                                          AccessibleKeyListenerSyncType sync_type)
336 {
337   gint                                i;
338   Accessibility_KeySet                key_set;
339   Accessibility_KeyEventTypeSeq       key_events;
340   Accessibility_ControllerEventMask   controller_event_mask;
341   Accessibility_DeviceEventController device_event_controller;
342   Accessibility_EventListenerMode     listener_mode;
343   Accessibility_EventType             key_event_types [2];
344   SPIBoolean                          retval = FALSE;
345
346   if (!listener)
347     {
348       return retval;
349     }
350
351   device_event_controller = 
352     Accessibility_Registry_getDeviceEventController (cspi_registry (), cspi_ev ());
353
354   cspi_return_val_if_ev ("getting event controller", FALSE);
355
356   /* copy the keyval filter values from the C api into the CORBA KeySet */
357   if (keys)
358     {
359       key_set._length = keys->len;
360       key_set._buffer = Accessibility_KeySet_allocbuf (keys->len);
361       for (i = 0; i < key_set._length; ++i)
362         {
363           key_set._buffer[i].keycode = keys->keycodes[i];
364           key_set._buffer[i].keysym = keys->keysyms[i];
365           if (keys->keystrings && keys->keystrings[i]) 
366             {
367               key_set._buffer[i].keystring = CORBA_string_dup(keys->keystrings[i]);
368             } 
369           else 
370             {
371               key_set._buffer[i].keystring = CORBA_string_dup("");
372             }
373         }
374     }
375   else
376     {
377       key_set._length = 0;
378       key_set._buffer = NULL;
379     }
380         
381   /* copy the event filter values from the C api into the CORBA KeyEventTypeSeq */
382   i = 0;
383   key_events._buffer = key_event_types;
384   if (eventmask & SPI_KEY_PRESSED)
385     {
386       key_events._buffer[i++] = Accessibility_KEY_PRESSED_EVENT;
387     }
388   if (eventmask & SPI_KEY_RELEASED)
389     {
390       key_events._buffer[i++] = Accessibility_KEY_RELEASED_EVENT;
391     }
392   key_events._length = i;
393   
394   controller_event_mask = (CORBA_unsigned_long) modmask;
395
396   listener_mode.synchronous =
397           (CORBA_boolean) ((sync_type & SPI_KEYLISTENER_SYNCHRONOUS)!=0);
398   listener_mode.preemptive =
399           (CORBA_boolean) ((sync_type & SPI_KEYLISTENER_CANCONSUME)!=0);
400   listener_mode.global =
401           (CORBA_boolean) ((sync_type & SPI_KEYLISTENER_ALL_WINDOWS)!=0);
402
403   retval = Accessibility_DeviceEventController_registerKeystrokeListener (
404     device_event_controller,
405     cspi_event_listener_get_corba (listener),
406     &key_set,
407     controller_event_mask,
408     &key_events,
409     &listener_mode,
410     cspi_ev ());
411
412   CORBA_free (key_set._buffer);
413
414   cspi_return_val_if_ev ("registering keystroke listener", FALSE);
415
416   cspi_release_unref (device_event_controller);
417
418   return retval;
419 }
420
421 /**
422  * SPI_deregisterAccessibleKeystrokeListener:
423  * @listener: a pointer to the #AccessibleKeystrokeListener for which
424  *            keystroke events are requested.
425  * @modmask:  the key modifier mask for which this listener is to be
426  *            'deregistered' (of type #AccessibleeyMaskType).
427  *
428  * Removes a keystroke event listener from the registry's listener queue,
429  *            ceasing notification of events with modifiers matching @modmask.
430  *
431  * Returns: #TRUE if successful, otherwise #FALSE.
432  **/
433 SPIBoolean
434 SPI_deregisterAccessibleKeystrokeListener (AccessibleKeystrokeListener *listener,
435                                            AccessibleKeyMaskType        modmask)
436 {
437   Accessibility_ControllerEventMask   controller_event_mask;
438   Accessibility_KeySet                key_set;
439   Accessibility_KeyEventTypeSeq       key_events;
440   Accessibility_DeviceEventController device_event_controller;
441
442   if (!listener)
443     {
444       return FALSE;
445     }
446
447   device_event_controller = 
448     Accessibility_Registry_getDeviceEventController (cspi_registry (), cspi_ev ());
449
450   cspi_return_val_if_ev ("getting keystroke listener", FALSE);
451
452   controller_event_mask = (CORBA_unsigned_long) modmask;
453
454   key_events._buffer = NULL;
455   key_events._length = 0;
456
457   key_set._buffer = NULL;
458   key_set._length = 0;
459
460   Accessibility_DeviceEventController_deregisterKeystrokeListener (
461     device_event_controller,
462     cspi_event_listener_get_corba (listener),
463     &key_set,
464     controller_event_mask,
465     &key_events,
466     cspi_ev ());
467
468   cspi_release_unref (device_event_controller);
469
470   return TRUE;
471 }
472
473 /**
474  * SPI_registerDeviceEventListener:
475  * @listener:  a pointer to the #AccessibleDeviceListener which requests
476  *             the events.
477  * @eventmask: an #AccessibleDeviceEventMask mask indicating which
478  *             types of key events are requested (#SPI_KEY_PRESSED, etc.).
479  * @filter: Unused parameter.
480  *             
481  * Register a listener for device events, for instance button events.
482  *
483  * Returns: #TRUE if successful, otherwise #FALSE.
484  **/
485 SPIBoolean
486 SPI_registerDeviceEventListener (AccessibleDeviceListener  *listener,
487                                  AccessibleDeviceEventMask  eventmask,
488                                  void                      *filter)
489 {
490   Accessibility_DeviceEventController device_event_controller;
491   SPIBoolean                          retval = FALSE;
492   Accessibility_EventTypeSeq          event_types;
493   Accessibility_EventType             event_type_buffer[2];
494   gint                                i;
495
496   if (!listener)
497     {
498       return retval;
499     }
500
501   device_event_controller = 
502     Accessibility_Registry_getDeviceEventController (cspi_registry (), cspi_ev ());
503
504   cspi_return_val_if_ev ("getting event controller", FALSE);
505
506   /* copy the event filter values from the C api into the CORBA KeyEventTypeSeq */
507   
508   event_types._buffer = event_type_buffer;
509   i = 0;
510
511   if (eventmask & SPI_BUTTON_PRESSED)
512     {
513       event_types._buffer[i++] = Accessibility_BUTTON_PRESSED_EVENT;
514     }
515   if (eventmask & SPI_BUTTON_RELEASED)
516     {
517       event_types._buffer[i++] = Accessibility_BUTTON_RELEASED_EVENT;
518     }
519
520   event_types._length = i;
521   
522   retval = Accessibility_DeviceEventController_registerDeviceEventListener (
523     device_event_controller,
524     cspi_event_listener_get_corba (listener),
525     &event_types,
526     cspi_ev ());
527
528   cspi_return_val_if_ev ("registering keystroke listener", FALSE);
529
530   cspi_release_unref (device_event_controller);
531
532   return retval;
533 }
534
535 /**
536  * SPI_deregisterDeviceEventListener:
537  * @listener: a pointer to the #AccessibleDeviceListener for which
538  *            device events are requested.
539  * @filter: Unused parameter.
540  *
541  * Removes a device event listener from the registry's listener queue,
542  *            ceasing notification of events of the specified type.
543  *
544  * Returns: #TRUE if successful, otherwise #FALSE.
545  **/
546 SPIBoolean
547 SPI_deregisterDeviceEventListener (AccessibleDeviceListener *listener,
548                                    void                     *filter)
549 {
550   Accessibility_DeviceEventController device_event_controller;
551   Accessibility_EventTypeSeq       event_types;
552   Accessibility_EventType          event_type_buff[2];
553
554   if (!listener)
555     {
556       return FALSE;
557     }
558
559   device_event_controller = 
560     Accessibility_Registry_getDeviceEventController (cspi_registry (), cspi_ev ());
561
562   cspi_return_val_if_ev ("getting keystroke listener", FALSE);
563
564   event_types._buffer = event_type_buff;
565   event_types._length = 2;
566   event_types._buffer[0] = Accessibility_BUTTON_PRESSED_EVENT;
567   event_types._buffer[1] = Accessibility_BUTTON_RELEASED_EVENT;
568
569   Accessibility_DeviceEventController_deregisterDeviceEventListener (
570     device_event_controller,
571     cspi_event_listener_get_corba (listener),
572     &event_types,    
573     cspi_ev ());
574
575   cspi_release_unref (device_event_controller);
576
577   return TRUE;
578 }
579
580 /**
581  * SPI_generateKeyboardEvent:
582  * @keyval: a long integer indicating the keycode or keysym of the key event
583  *           being synthesized.
584  * @keystring: an (optional) UTF-8 string which, if @keyval is NULL,
585  *           indicates a 'composed' keyboard input string which is 
586  *           being synthesized; this type of keyboard event synthesis does
587  *           not emulate hardware keypresses but injects the string 
588  *           as though a composing input method (such as XIM) were used.
589  * @synth_type: a #AccessibleKeySynthType flag indicating whether @keyval
590  *           is to be interpreted as a keysym rather than a keycode
591  *           (CSPI_KEYSYM), or whether to synthesize
592  *           SPI_KEY_PRESS, SPI_KEY_RELEASE, or both (SPI_KEY_PRESSRELEASE).
593  *
594  * Synthesize a keyboard event (as if a hardware keyboard event occurred in the
595  * current UI context).
596  *
597  * Returns: #TRUE if successful, otherwise #FALSE.
598  **/
599 SPIBoolean
600 SPI_generateKeyboardEvent (long int keyval,
601                            char *keystring,
602                            AccessibleKeySynthType synth_type)
603 {
604 /* TODO: check current modifier status and
605  *  send keycode to alter, if necessary
606  */
607         
608   /* TODO: implement keystring use case */
609   Accessibility_KeySynthType keysynth_type;
610   Accessibility_DeviceEventController device_event_controller = 
611           Accessibility_Registry_getDeviceEventController (cspi_registry (), cspi_ev ());
612
613   cspi_return_val_if_ev ("getting event controller for key event gen", FALSE);
614
615   switch (synth_type)
616     {
617       case SPI_KEY_PRESS:
618           keysynth_type = Accessibility_KEY_PRESS;
619           break;
620       case SPI_KEY_RELEASE:
621           keysynth_type = Accessibility_KEY_RELEASE;
622           break;
623       case SPI_KEY_PRESSRELEASE:
624           keysynth_type = Accessibility_KEY_PRESSRELEASE;
625           break;
626       case SPI_KEY_SYM:
627           keysynth_type = Accessibility_KEY_SYM;
628           break;
629       case SPI_KEY_STRING:
630           keysynth_type = Accessibility_KEY_STRING;
631           break;
632       default:
633           return FALSE;
634     }
635
636   Accessibility_DeviceEventController_generateKeyboardEvent (device_event_controller,
637                                                              keyval,
638                                                              "",
639                                                              keysynth_type,
640                                                              cspi_ev ());
641
642   cspi_return_val_if_ev ("generating keyboard event", FALSE);
643
644   cspi_release_unref (device_event_controller);
645
646   return TRUE;
647 }
648
649 /**
650  * SPI_generateMouseEvent:
651  * @x: a #long indicating the screen x coordinate of the mouse event.
652  * @y: a #long indicating the screen y coordinate of the mouse event.
653  * @name: a string indicating which mouse event to be synthesized
654  *        (e.g. "b1p", "b1c", "b2r", "rel", "abs").
655  *
656  * Synthesize a mouse event at a specific screen coordinate.
657  * Most AT clients should use the #AccessibleAction interface when
658  * tempted to generate mouse events, rather than this method.
659  * Event names: b1p = button 1 press; b2r = button 2 release;
660  *              b3c = button 3 click; b2d = button 2 double-click;
661  *              abs = absolute motion; rel = relative motion.
662  *
663  * Returns: #TRUE if successful, otherwise #FALSE.
664  **/
665 SPIBoolean
666 SPI_generateMouseEvent (long x, long y, char *name)
667 {
668   Accessibility_DeviceEventController device_event_controller = 
669           Accessibility_Registry_getDeviceEventController (cspi_registry (), cspi_ev ());
670
671   cspi_return_val_if_ev ("getting event controller for mouse event gen", FALSE);
672
673   Accessibility_DeviceEventController_generateMouseEvent (device_event_controller,
674                                                           x, y, name, cspi_ev ());
675   cspi_return_val_if_ev ("generating mouse event", FALSE);
676
677   cspi_release_unref (device_event_controller);
678
679   return TRUE;
680 }
681