]> Pileus Git - ~andy/gtk/blob - gdk/gdkevents.c
Tons of transfer annotations
[~andy/gtk] / gdk / gdkevents.c
1 /* GDK - The GIMP Drawing Kit
2  * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2 of the License, or (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * Lesser General Public License for more details.
13  *
14  * You should have received a copy of the GNU Lesser General Public
15  * License along with this library; if not, write to the
16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17  * Boston, MA 02111-1307, USA.
18  */
19
20 /*
21  * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
22  * file for a list of people on the GTK+ Team.  See the ChangeLog
23  * files for a list of changes.  These files are distributed with
24  * GTK+ at ftp://ftp.gtk.org/pub/gtk/. 
25  */
26
27 #include "config.h"
28 #include <string.h>             /* For memset() */
29 #include <math.h>
30
31 #include "gdk.h"
32 #include "gdkinternals.h"
33
34
35 typedef struct _GdkIOClosure GdkIOClosure;
36
37 struct _GdkIOClosure
38 {
39   GDestroyNotify notify;
40   gpointer data;
41 };
42
43 /* Private variable declarations
44  */
45
46 GdkEventFunc   _gdk_event_func = NULL;    /* Callback for events */
47 gpointer       _gdk_event_data = NULL;
48 GDestroyNotify _gdk_event_notify = NULL;
49
50 /*********************************************
51  * Functions for maintaining the event queue *
52  *********************************************/
53
54 /**
55  * _gdk_event_queue_find_first:
56  * @display: a #GdkDisplay
57  * 
58  * Find the first event on the queue that is not still
59  * being filled in.
60  * 
61  * Return value: Pointer to the list node for that event, or NULL.
62  **/
63 GList*
64 _gdk_event_queue_find_first (GdkDisplay *display)
65 {
66   GList *tmp_list = display->queued_events;
67
68   while (tmp_list)
69     {
70       GdkEventPrivate *event = tmp_list->data;
71       if (!(event->flags & GDK_EVENT_PENDING))
72         return tmp_list;
73
74       tmp_list = g_list_next (tmp_list);
75     }
76
77   return NULL;
78 }
79
80 /**
81  * _gdk_event_queue_prepend:
82  * @display: a #GdkDisplay
83  * @event: Event to prepend.
84  *
85  * Prepends an event before the head of the event queue.
86  *
87  * Returns: the newly prepended list node.
88  **/
89 GList*
90 _gdk_event_queue_prepend (GdkDisplay *display,
91                           GdkEvent   *event)
92 {
93   display->queued_events = g_list_prepend (display->queued_events, event);
94   if (!display->queued_tail)
95     display->queued_tail = display->queued_events;
96   return display->queued_events;
97 }
98
99 /**
100  * _gdk_event_queue_append:
101  * @display: a #GdkDisplay
102  * @event: Event to append.
103  * 
104  * Appends an event onto the tail of the event queue.
105  *
106  * Returns: the newly appended list node.
107  **/
108 GList *
109 _gdk_event_queue_append (GdkDisplay *display,
110                          GdkEvent   *event)
111 {
112   display->queued_tail = g_list_append (display->queued_tail, event);
113   
114   if (!display->queued_events)
115     display->queued_events = display->queued_tail;
116   else
117     display->queued_tail = display->queued_tail->next;
118
119   return display->queued_tail;
120 }
121
122 /**
123  * _gdk_event_queue_insert_after:
124  * @display: a #GdkDisplay
125  * @sibling: Append after this event.
126  * @event: Event to append.
127  *
128  * Appends an event after the specified event, or if it isn't in
129  * the queue, onto the tail of the event queue.
130  *
131  * Returns: the newly appended list node.
132  *
133  * Since: 2.16
134  */
135 GList*
136 _gdk_event_queue_insert_after (GdkDisplay *display,
137                                GdkEvent   *sibling,
138                                GdkEvent   *event)
139 {
140   GList *prev = g_list_find (display->queued_events, sibling);
141   if (prev && prev->next)
142     {
143       display->queued_events = g_list_insert_before (display->queued_events, prev->next, event);
144       return prev->next;
145     }
146   else
147     return _gdk_event_queue_append (display, event);
148 }
149
150 /**
151  * _gdk_event_queue_insert_after:
152  * @display: a #GdkDisplay
153  * @sibling: Append after this event.
154  * @event: Event to append.
155  *
156  * Appends an event before the specified event, or if it isn't in
157  * the queue, onto the tail of the event queue.
158  *
159  * Returns: the newly appended list node.
160  *
161  * Since: 2.16
162  */
163 GList*
164 _gdk_event_queue_insert_before (GdkDisplay *display,
165                                 GdkEvent   *sibling,
166                                 GdkEvent   *event)
167 {
168   GList *next = g_list_find (display->queued_events, sibling);
169   if (next)
170     {
171       display->queued_events = g_list_insert_before (display->queued_events, next, event);
172       return next->prev;
173     }
174   else
175     return _gdk_event_queue_append (display, event);
176 }
177
178
179 /**
180  * _gdk_event_queue_remove_link:
181  * @display: a #GdkDisplay
182  * @node: node to remove
183  * 
184  * Removes a specified list node from the event queue.
185  **/
186 void
187 _gdk_event_queue_remove_link (GdkDisplay *display,
188                               GList      *node)
189 {
190   if (node->prev)
191     node->prev->next = node->next;
192   else
193     display->queued_events = node->next;
194   
195   if (node->next)
196     node->next->prev = node->prev;
197   else
198     display->queued_tail = node->prev;
199 }
200
201 /**
202  * _gdk_event_unqueue:
203  * @display: a #GdkDisplay
204  * 
205  * Removes and returns the first event from the event
206  * queue that is not still being filled in.
207  * 
208  * Return value: the event, or %NULL. Ownership is transferred
209  * to the caller.
210  **/
211 GdkEvent*
212 _gdk_event_unqueue (GdkDisplay *display)
213 {
214   GdkEvent *event = NULL;
215   GList *tmp_list;
216
217   tmp_list = _gdk_event_queue_find_first (display);
218
219   if (tmp_list)
220     {
221       event = tmp_list->data;
222       _gdk_event_queue_remove_link (display, tmp_list);
223       g_list_free_1 (tmp_list);
224     }
225
226   return event;
227 }
228
229 /**
230  * gdk_event_handler_set:
231  * @func: the function to call to handle events from GDK.
232  * @data: user data to pass to the function. 
233  * @notify: the function to call when the handler function is removed, i.e. when
234  *          gdk_event_handler_set() is called with another event handler.
235  * 
236  * Sets the function to call to handle all events from GDK.
237  *
238  * Note that GTK+ uses this to install its own event handler, so it is
239  * usually not useful for GTK+ applications. (Although an application
240  * can call this function then call gtk_main_do_event() to pass
241  * events to GTK+.)
242  **/
243 void 
244 gdk_event_handler_set (GdkEventFunc   func,
245                        gpointer       data,
246                        GDestroyNotify notify)
247 {
248   if (_gdk_event_notify)
249     (*_gdk_event_notify) (_gdk_event_data);
250
251   _gdk_event_func = func;
252   _gdk_event_data = data;
253   _gdk_event_notify = notify;
254 }
255
256 /**
257  * gdk_event_get:
258  * 
259  * Checks all open displays for a #GdkEvent to process,to be processed
260  * on, fetching events from the windowing system if necessary.
261  * See gdk_display_get_event().
262  * 
263  * Return value: the next #GdkEvent to be processed, or %NULL if no events
264  * are pending. The returned #GdkEvent should be freed with gdk_event_free().
265  **/
266 GdkEvent*
267 gdk_event_get (void)
268 {
269   GSList *tmp_list;
270
271   for (tmp_list = _gdk_displays; tmp_list; tmp_list = tmp_list->next)
272     {
273       GdkEvent *event = gdk_display_get_event (tmp_list->data);
274       if (event)
275         return event;
276     }
277
278   return NULL;
279 }
280
281 /**
282  * gdk_event_peek:
283  *
284  * If there is an event waiting in the event queue of some open
285  * display, returns a copy of it. See gdk_display_peek_event().
286  * 
287  * Return value: a copy of the first #GdkEvent on some event queue, or %NULL if no
288  * events are in any queues. The returned #GdkEvent should be freed with
289  * gdk_event_free().
290  **/
291 GdkEvent*
292 gdk_event_peek (void)
293 {
294   GSList *tmp_list;
295
296   for (tmp_list = _gdk_displays; tmp_list; tmp_list = tmp_list->next)
297     {
298       GdkEvent *event = gdk_display_peek_event (tmp_list->data);
299       if (event)
300         return event;
301     }
302
303   return NULL;
304 }
305
306 /**
307  * gdk_event_put:
308  * @event: a #GdkEvent.
309  *
310  * Appends a copy of the given event onto the front of the event
311  * queue for event->any.window's display, or the default event
312  * queue if event->any.window is %NULL. See gdk_display_put_event().
313  **/
314 void
315 gdk_event_put (const GdkEvent *event)
316 {
317   GdkDisplay *display;
318   
319   g_return_if_fail (event != NULL);
320
321   if (event->any.window)
322     display = gdk_drawable_get_display (event->any.window);
323   else
324     {
325       GDK_NOTE (MULTIHEAD,
326                 g_message ("Falling back to default display for gdk_event_put()"));
327       display = gdk_display_get_default ();
328     }
329
330   gdk_display_put_event (display, event);
331 }
332
333 static GHashTable *event_hash = NULL;
334
335 /**
336  * gdk_event_new:
337  * @type: a #GdkEventType 
338  * 
339  * Creates a new event of the given type. All fields are set to 0.
340  * 
341  * Return value: a newly-allocated #GdkEvent. The returned #GdkEvent 
342  * should be freed with gdk_event_free().
343  *
344  * Since: 2.2
345  **/
346 GdkEvent*
347 gdk_event_new (GdkEventType type)
348 {
349   GdkEventPrivate *new_private;
350   GdkEvent *new_event;
351   
352   if (!event_hash)
353     event_hash = g_hash_table_new (g_direct_hash, NULL);
354
355   new_private = g_slice_new0 (GdkEventPrivate);
356   
357   new_private->flags = 0;
358   new_private->screen = NULL;
359
360   g_hash_table_insert (event_hash, new_private, GUINT_TO_POINTER (1));
361
362   new_event = (GdkEvent *) new_private;
363
364   new_event->any.type = type;
365
366   /*
367    * Bytewise 0 initialization is reasonable for most of the 
368    * current event types. Explicitely initialize double fields
369    * since I trust bytewise 0 == 0. less than for integers
370    * or pointers.
371    */
372   switch (type)
373     {
374     case GDK_MOTION_NOTIFY:
375       new_event->motion.x = 0.;
376       new_event->motion.y = 0.;
377       new_event->motion.x_root = 0.;
378       new_event->motion.y_root = 0.;
379       break;
380     case GDK_BUTTON_PRESS:
381     case GDK_2BUTTON_PRESS:
382     case GDK_3BUTTON_PRESS:
383     case GDK_BUTTON_RELEASE:
384       new_event->button.x = 0.;
385       new_event->button.y = 0.;
386       new_event->button.x_root = 0.;
387       new_event->button.y_root = 0.;
388       break;
389     case GDK_SCROLL:
390       new_event->scroll.x = 0.;
391       new_event->scroll.y = 0.;
392       new_event->scroll.x_root = 0.;
393       new_event->scroll.y_root = 0.;
394       break;
395     case GDK_ENTER_NOTIFY:
396     case GDK_LEAVE_NOTIFY:
397       new_event->crossing.x = 0.;
398       new_event->crossing.y = 0.;
399       new_event->crossing.x_root = 0.;
400       new_event->crossing.y_root = 0.;
401       break;
402     default:
403       break;
404     }
405   
406   return new_event;
407 }
408
409 static gboolean
410 gdk_event_is_allocated (const GdkEvent *event)
411 {
412   if (event_hash)
413     return g_hash_table_lookup (event_hash, event) != NULL;
414
415   return FALSE;
416 }
417  
418 /**
419  * gdk_event_copy:
420  * @event: a #GdkEvent
421  * 
422  * Copies a #GdkEvent, copying or incrementing the reference count of the
423  * resources associated with it (e.g. #GdkWindow's and strings).
424  * 
425  * Return value: a copy of @event. The returned #GdkEvent should be freed with
426  * gdk_event_free().
427  **/
428 GdkEvent*
429 gdk_event_copy (const GdkEvent *event)
430 {
431   GdkEventPrivate *new_private;
432   GdkEvent *new_event;
433   
434   g_return_val_if_fail (event != NULL, NULL);
435   
436   new_event = gdk_event_new (GDK_NOTHING);
437   new_private = (GdkEventPrivate *)new_event;
438
439   *new_event = *event;
440   if (new_event->any.window)
441     g_object_ref (new_event->any.window);
442
443   if (gdk_event_is_allocated (event))
444     {
445       GdkEventPrivate *private = (GdkEventPrivate *)event;
446
447       new_private->screen = private->screen;
448       new_private->device = private->device;
449     }
450   
451   switch (event->any.type)
452     {
453     case GDK_KEY_PRESS:
454     case GDK_KEY_RELEASE:
455       new_event->key.string = g_strdup (event->key.string);
456       break;
457       
458     case GDK_ENTER_NOTIFY:
459     case GDK_LEAVE_NOTIFY:
460       if (event->crossing.subwindow != NULL)
461         g_object_ref (event->crossing.subwindow);
462       break;
463       
464     case GDK_DRAG_ENTER:
465     case GDK_DRAG_LEAVE:
466     case GDK_DRAG_MOTION:
467     case GDK_DRAG_STATUS:
468     case GDK_DROP_START:
469     case GDK_DROP_FINISHED:
470       g_object_ref (event->dnd.context);
471       break;
472       
473     case GDK_EXPOSE:
474     case GDK_DAMAGE:
475       if (event->expose.region)
476         new_event->expose.region = cairo_region_copy (event->expose.region);
477       break;
478       
479     case GDK_SETTING:
480       new_event->setting.name = g_strdup (new_event->setting.name);
481       break;
482
483     case GDK_BUTTON_PRESS:
484     case GDK_BUTTON_RELEASE:
485       if (event->button.axes) 
486         new_event->button.axes = g_memdup (event->button.axes, 
487                                              sizeof (gdouble) * event->button.device->num_axes);
488       break;
489
490     case GDK_MOTION_NOTIFY:
491       if (event->motion.axes) 
492         new_event->motion.axes = g_memdup (event->motion.axes, 
493                                            sizeof (gdouble) * event->motion.device->num_axes);
494       
495       break;
496       
497     default:
498       break;
499     }
500
501   if (gdk_event_is_allocated (event))
502     _gdk_windowing_event_data_copy (event, new_event);
503   
504   return new_event;
505 }
506
507 /**
508  * gdk_event_free:
509  * @event:  a #GdkEvent.
510  * 
511  * Frees a #GdkEvent, freeing or decrementing any resources associated with it.
512  * Note that this function should only be called with events returned from
513  * functions such as gdk_event_peek(), gdk_event_get(), gdk_event_copy()
514  * and gdk_event_new().
515  **/
516 void
517 gdk_event_free (GdkEvent *event)
518 {
519   g_return_if_fail (event != NULL);
520
521   if (event->any.window)
522     g_object_unref (event->any.window);
523   
524   switch (event->any.type)
525     {
526     case GDK_KEY_PRESS:
527     case GDK_KEY_RELEASE:
528       g_free (event->key.string);
529       break;
530       
531     case GDK_ENTER_NOTIFY:
532     case GDK_LEAVE_NOTIFY:
533       if (event->crossing.subwindow != NULL)
534         g_object_unref (event->crossing.subwindow);
535       break;
536       
537     case GDK_DRAG_ENTER:
538     case GDK_DRAG_LEAVE:
539     case GDK_DRAG_MOTION:
540     case GDK_DRAG_STATUS:
541     case GDK_DROP_START:
542     case GDK_DROP_FINISHED:
543       g_object_unref (event->dnd.context);
544       break;
545
546     case GDK_BUTTON_PRESS:
547     case GDK_BUTTON_RELEASE:
548       g_free (event->button.axes);
549       break;
550       
551     case GDK_EXPOSE:
552     case GDK_DAMAGE:
553       if (event->expose.region)
554         cairo_region_destroy (event->expose.region);
555       break;
556       
557     case GDK_MOTION_NOTIFY:
558       g_free (event->motion.axes);
559       break;
560       
561     case GDK_SETTING:
562       g_free (event->setting.name);
563       break;
564       
565     default:
566       break;
567     }
568
569   _gdk_windowing_event_data_free (event);
570
571   g_hash_table_remove (event_hash, event);
572   g_slice_free (GdkEventPrivate, (GdkEventPrivate*) event);
573 }
574
575 /**
576  * gdk_event_get_time:
577  * @event: a #GdkEvent
578  * 
579  * Returns the time stamp from @event, if there is one; otherwise
580  * returns #GDK_CURRENT_TIME. If @event is %NULL, returns #GDK_CURRENT_TIME.
581  * 
582  * Return value: time stamp field from @event
583  **/
584 guint32
585 gdk_event_get_time (const GdkEvent *event)
586 {
587   if (event)
588     switch (event->type)
589       {
590       case GDK_MOTION_NOTIFY:
591         return event->motion.time;
592       case GDK_BUTTON_PRESS:
593       case GDK_2BUTTON_PRESS:
594       case GDK_3BUTTON_PRESS:
595       case GDK_BUTTON_RELEASE:
596         return event->button.time;
597       case GDK_SCROLL:
598         return event->scroll.time;
599       case GDK_KEY_PRESS:
600       case GDK_KEY_RELEASE:
601         return event->key.time;
602       case GDK_ENTER_NOTIFY:
603       case GDK_LEAVE_NOTIFY:
604         return event->crossing.time;
605       case GDK_PROPERTY_NOTIFY:
606         return event->property.time;
607       case GDK_SELECTION_CLEAR:
608       case GDK_SELECTION_REQUEST:
609       case GDK_SELECTION_NOTIFY:
610         return event->selection.time;
611       case GDK_PROXIMITY_IN:
612       case GDK_PROXIMITY_OUT:
613         return event->proximity.time;
614       case GDK_DRAG_ENTER:
615       case GDK_DRAG_LEAVE:
616       case GDK_DRAG_MOTION:
617       case GDK_DRAG_STATUS:
618       case GDK_DROP_START:
619       case GDK_DROP_FINISHED:
620         return event->dnd.time;
621       case GDK_CLIENT_EVENT:
622       case GDK_VISIBILITY_NOTIFY:
623       case GDK_NO_EXPOSE:
624       case GDK_CONFIGURE:
625       case GDK_FOCUS_CHANGE:
626       case GDK_NOTHING:
627       case GDK_DAMAGE:
628       case GDK_DELETE:
629       case GDK_DESTROY:
630       case GDK_EXPOSE:
631       case GDK_MAP:
632       case GDK_UNMAP:
633       case GDK_WINDOW_STATE:
634       case GDK_SETTING:
635       case GDK_OWNER_CHANGE:
636       case GDK_GRAB_BROKEN:
637       case GDK_EVENT_LAST:
638         /* return current time */
639         break;
640       }
641   
642   return GDK_CURRENT_TIME;
643 }
644
645 /**
646  * gdk_event_get_state:
647  * @event: a #GdkEvent or NULL
648  * @state: (out): return location for state
649  * 
650  * If the event contains a "state" field, puts that field in @state. Otherwise
651  * stores an empty state (0). Returns %TRUE if there was a state field
652  * in the event. @event may be %NULL, in which case it's treated
653  * as if the event had no state field.
654  * 
655  * Return value: %TRUE if there was a state field in the event 
656  **/
657 gboolean
658 gdk_event_get_state (const GdkEvent        *event,
659                      GdkModifierType       *state)
660 {
661   g_return_val_if_fail (state != NULL, FALSE);
662   
663   if (event)
664     switch (event->type)
665       {
666       case GDK_MOTION_NOTIFY:
667         *state = event->motion.state;
668         return TRUE;
669       case GDK_BUTTON_PRESS:
670       case GDK_2BUTTON_PRESS:
671       case GDK_3BUTTON_PRESS:
672       case GDK_BUTTON_RELEASE:
673         *state =  event->button.state;
674         return TRUE;
675       case GDK_SCROLL:
676         *state =  event->scroll.state;
677         return TRUE;
678       case GDK_KEY_PRESS:
679       case GDK_KEY_RELEASE:
680         *state =  event->key.state;
681         return TRUE;
682       case GDK_ENTER_NOTIFY:
683       case GDK_LEAVE_NOTIFY:
684         *state =  event->crossing.state;
685         return TRUE;
686       case GDK_PROPERTY_NOTIFY:
687         *state =  event->property.state;
688         return TRUE;
689       case GDK_VISIBILITY_NOTIFY:
690       case GDK_CLIENT_EVENT:
691       case GDK_NO_EXPOSE:
692       case GDK_CONFIGURE:
693       case GDK_FOCUS_CHANGE:
694       case GDK_SELECTION_CLEAR:
695       case GDK_SELECTION_REQUEST:
696       case GDK_SELECTION_NOTIFY:
697       case GDK_PROXIMITY_IN:
698       case GDK_PROXIMITY_OUT:
699       case GDK_DAMAGE:
700       case GDK_DRAG_ENTER:
701       case GDK_DRAG_LEAVE:
702       case GDK_DRAG_MOTION:
703       case GDK_DRAG_STATUS:
704       case GDK_DROP_START:
705       case GDK_DROP_FINISHED:
706       case GDK_NOTHING:
707       case GDK_DELETE:
708       case GDK_DESTROY:
709       case GDK_EXPOSE:
710       case GDK_MAP:
711       case GDK_UNMAP:
712       case GDK_WINDOW_STATE:
713       case GDK_SETTING:
714       case GDK_OWNER_CHANGE:
715       case GDK_GRAB_BROKEN:
716       case GDK_EVENT_LAST:
717         /* no state field */
718         break;
719       }
720
721   *state = 0;
722   return FALSE;
723 }
724
725 /**
726  * gdk_event_get_coords:
727  * @event: a #GdkEvent
728  * @x_win: (out): location to put event window x coordinate
729  * @y_win: (out): location to put event window y coordinate
730  * 
731  * Extract the event window relative x/y coordinates from an event.
732  * 
733  * Return value: %TRUE if the event delivered event window coordinates
734  **/
735 gboolean
736 gdk_event_get_coords (const GdkEvent *event,
737                       gdouble        *x_win,
738                       gdouble        *y_win)
739 {
740   gdouble x = 0, y = 0;
741   gboolean fetched = TRUE;
742   
743   g_return_val_if_fail (event != NULL, FALSE);
744
745   switch (event->type)
746     {
747     case GDK_CONFIGURE:
748       x = event->configure.x;
749       y = event->configure.y;
750       break;
751     case GDK_ENTER_NOTIFY:
752     case GDK_LEAVE_NOTIFY:
753       x = event->crossing.x;
754       y = event->crossing.y;
755       break;
756     case GDK_SCROLL:
757       x = event->scroll.x;
758       y = event->scroll.y;
759       break;
760     case GDK_BUTTON_PRESS:
761     case GDK_2BUTTON_PRESS:
762     case GDK_3BUTTON_PRESS:
763     case GDK_BUTTON_RELEASE:
764       x = event->button.x;
765       y = event->button.y;
766       break;
767     case GDK_MOTION_NOTIFY:
768       x = event->motion.x;
769       y = event->motion.y;
770       break;
771     default:
772       fetched = FALSE;
773       break;
774     }
775
776   if (x_win)
777     *x_win = x;
778   if (y_win)
779     *y_win = y;
780
781   return fetched;
782 }
783
784 /**
785  * gdk_event_get_root_coords:
786  * @event: a #GdkEvent
787  * @x_root: (out): location to put root window x coordinate
788  * @y_root: (out): location to put root window y coordinate
789  * 
790  * Extract the root window relative x/y coordinates from an event.
791  * 
792  * Return value: %TRUE if the event delivered root window coordinates
793  **/
794 gboolean
795 gdk_event_get_root_coords (const GdkEvent *event,
796                            gdouble        *x_root,
797                            gdouble        *y_root)
798 {
799   gdouble x = 0, y = 0;
800   gboolean fetched = TRUE;
801   
802   g_return_val_if_fail (event != NULL, FALSE);
803
804   switch (event->type)
805     {
806     case GDK_MOTION_NOTIFY:
807       x = event->motion.x_root;
808       y = event->motion.y_root;
809       break;
810     case GDK_SCROLL:
811       x = event->scroll.x_root;
812       y = event->scroll.y_root;
813       break;
814     case GDK_BUTTON_PRESS:
815     case GDK_2BUTTON_PRESS:
816     case GDK_3BUTTON_PRESS:
817     case GDK_BUTTON_RELEASE:
818       x = event->button.x_root;
819       y = event->button.y_root;
820       break;
821     case GDK_ENTER_NOTIFY:
822     case GDK_LEAVE_NOTIFY:
823       x = event->crossing.x_root;
824       y = event->crossing.y_root;
825       break;
826     case GDK_DRAG_ENTER:
827     case GDK_DRAG_LEAVE:
828     case GDK_DRAG_MOTION:
829     case GDK_DRAG_STATUS:
830     case GDK_DROP_START:
831     case GDK_DROP_FINISHED:
832       x = event->dnd.x_root;
833       y = event->dnd.y_root;
834       break;
835     default:
836       fetched = FALSE;
837       break;
838     }
839
840   if (x_root)
841     *x_root = x;
842   if (y_root)
843     *y_root = y;
844
845   return fetched;
846 }
847
848 /**
849  * gdk_event_get_axis:
850  * @event: a #GdkEvent
851  * @axis_use: (out): the axis use to look for
852  * @value: (out): location to store the value found
853  * 
854  * Extract the axis value for a particular axis use from
855  * an event structure.
856  * 
857  * Return value: %TRUE if the specified axis was found, otherwise %FALSE
858  **/
859 gboolean
860 gdk_event_get_axis (const GdkEvent *event,
861                     GdkAxisUse      axis_use,
862                     gdouble        *value)
863 {
864   gdouble *axes;
865   GdkDevice *device;
866   
867   g_return_val_if_fail (event != NULL, FALSE);
868   
869   if (axis_use == GDK_AXIS_X || axis_use == GDK_AXIS_Y)
870     {
871       gdouble x, y;
872       
873       switch (event->type)
874         {
875         case GDK_MOTION_NOTIFY:
876           x = event->motion.x;
877           y = event->motion.y;
878           break;
879         case GDK_SCROLL:
880           x = event->scroll.x;
881           y = event->scroll.y;
882           break;
883         case GDK_BUTTON_PRESS:
884         case GDK_BUTTON_RELEASE:
885           x = event->button.x;
886           y = event->button.y;
887           break;
888         case GDK_ENTER_NOTIFY:
889         case GDK_LEAVE_NOTIFY:
890           x = event->crossing.x;
891           y = event->crossing.y;
892           break;
893           
894         default:
895           return FALSE;
896         }
897
898       if (axis_use == GDK_AXIS_X && value)
899         *value = x;
900       if (axis_use == GDK_AXIS_Y && value)
901         *value = y;
902
903       return TRUE;
904     }
905   else if (event->type == GDK_BUTTON_PRESS ||
906            event->type == GDK_BUTTON_RELEASE)
907     {
908       device = event->button.device;
909       axes = event->button.axes;
910     }
911   else if (event->type == GDK_MOTION_NOTIFY)
912     {
913       device = event->motion.device;
914       axes = event->motion.axes;
915     }
916   else
917     return FALSE;
918
919   return gdk_device_get_axis (device, axes, axis_use, value);
920 }
921
922 /**
923  * gdk_event_set_device:
924  * @event: a #GdkEvent
925  * @device: a #GdkDevice
926  *
927  * Sets the device for @event to @device. The event must
928  * have been allocated by GTK+, for instance, by
929  * gdk_event_copy().
930  *
931  * Since: 3.0
932  **/
933 void
934 gdk_event_set_device (GdkEvent  *event,
935                       GdkDevice *device)
936 {
937   GdkEventPrivate *private;
938
939   g_return_if_fail (gdk_event_is_allocated (event));
940
941   private = (GdkEventPrivate *) event;
942
943   private->device = device;
944
945   switch (event->type)
946     {
947     case GDK_MOTION_NOTIFY:
948       event->motion.device = device;
949       break;
950     case GDK_BUTTON_PRESS:
951     case GDK_2BUTTON_PRESS:
952     case GDK_3BUTTON_PRESS:
953     case GDK_BUTTON_RELEASE:
954       event->button.device = device;
955       break;
956     case GDK_SCROLL:
957       event->scroll.device = device;
958       break;
959     case GDK_PROXIMITY_IN:
960     case GDK_PROXIMITY_OUT:
961       event->proximity.device = device;
962       break;
963     default:
964       break;
965     }
966 }
967
968 /**
969  * gdk_event_get_device:
970  * @event: a #GdkEvent.
971  *
972  * If the event contains a "device" field, this function will return
973  * it, else it will return %NULL.
974  *
975  * Returns: (transfer none): a #GdkDevice, or %NULL.
976  *
977  * Since: 3.0
978  **/
979 GdkDevice *
980 gdk_event_get_device (const GdkEvent *event)
981 {
982   g_return_val_if_fail (event != NULL, NULL);
983
984   if (gdk_event_is_allocated (event))
985     {
986       GdkEventPrivate *private = (GdkEventPrivate *) event;
987
988       if (private->device)
989         return private->device;
990     }
991
992   switch (event->type)
993     {
994     case GDK_MOTION_NOTIFY:
995       return event->motion.device;
996     case GDK_BUTTON_PRESS:
997     case GDK_2BUTTON_PRESS:
998     case GDK_3BUTTON_PRESS:
999     case GDK_BUTTON_RELEASE:
1000       return event->button.device;
1001     case GDK_SCROLL:
1002       return event->scroll.device;
1003     case GDK_PROXIMITY_IN:
1004     case GDK_PROXIMITY_OUT:
1005       return event->proximity.device;
1006     default:
1007       break;
1008     }
1009
1010   /* Fallback if event has no device set */
1011   switch (event->type)
1012     {
1013     case GDK_MOTION_NOTIFY:
1014     case GDK_BUTTON_PRESS:
1015     case GDK_2BUTTON_PRESS:
1016     case GDK_3BUTTON_PRESS:
1017     case GDK_BUTTON_RELEASE:
1018     case GDK_ENTER_NOTIFY:
1019     case GDK_LEAVE_NOTIFY:
1020     case GDK_FOCUS_CHANGE:
1021     case GDK_PROXIMITY_IN:
1022     case GDK_PROXIMITY_OUT:
1023     case GDK_DRAG_ENTER:
1024     case GDK_DRAG_LEAVE:
1025     case GDK_DRAG_MOTION:
1026     case GDK_DRAG_STATUS:
1027     case GDK_DROP_START:
1028     case GDK_DROP_FINISHED:
1029     case GDK_SCROLL:
1030     case GDK_GRAB_BROKEN:
1031     case GDK_KEY_PRESS:
1032     case GDK_KEY_RELEASE:
1033       {
1034         GdkDisplay *display;
1035         GdkDevice *core_pointer;
1036
1037         g_warning ("Event with type %d not holding a GdkDevice. "
1038                    "It is most likely synthesized outside Gdk/GTK+\n",
1039                    event->type);
1040
1041         display = gdk_drawable_get_display (event->any.window);
1042         core_pointer = gdk_display_get_core_pointer (display);
1043
1044         if (event->type == GDK_KEY_PRESS ||
1045             event->type == GDK_KEY_RELEASE)
1046           return gdk_device_get_associated_device (core_pointer);
1047         else
1048           return core_pointer;
1049       }
1050       break;
1051     default:
1052       return NULL;
1053     }
1054 }
1055
1056 /**
1057  * gdk_event_request_motions:
1058  * @event: a valid #GdkEvent
1059  *
1060  * Request more motion notifies if @event is a motion notify hint event.
1061  * This function should be used instead of gdk_window_get_pointer() to
1062  * request further motion notifies, because it also works for extension
1063  * events where motion notifies are provided for devices other than the
1064  * core pointer. Coordinate extraction, processing and requesting more
1065  * motion events from a %GDK_MOTION_NOTIFY event usually works like this:
1066  *
1067  * |[
1068  * { 
1069  *   /&ast; motion_event handler &ast;/
1070  *   x = motion_event->x;
1071  *   y = motion_event->y;
1072  *   /&ast; handle (x,y) motion &ast;/
1073  *   gdk_event_request_motions (motion_event); /&ast; handles is_hint events &ast;/
1074  * }
1075  * ]|
1076  *
1077  * Since: 2.12
1078  **/
1079 void
1080 gdk_event_request_motions (const GdkEventMotion *event)
1081 {
1082   GdkDisplay *display;
1083   
1084   g_return_if_fail (event != NULL);
1085   
1086   if (event->type == GDK_MOTION_NOTIFY && event->is_hint)
1087     {
1088       gdk_device_get_state (event->device, event->window, NULL, NULL);
1089       
1090       display = gdk_drawable_get_display (event->window);
1091       _gdk_display_enable_motion_hints (display, event->device);
1092     }
1093 }
1094
1095 static gboolean
1096 gdk_events_get_axis_distances (GdkEvent *event1,
1097                                GdkEvent *event2,
1098                                gdouble  *x_distance,
1099                                gdouble  *y_distance,
1100                                gdouble  *distance)
1101 {
1102   gdouble x1, x2, y1, y2;
1103   gdouble xd, yd;
1104
1105   if (!gdk_event_get_coords (event1, &x1, &y1) ||
1106       !gdk_event_get_coords (event2, &x2, &y2))
1107     return FALSE;
1108
1109   xd = x2 - x1;
1110   yd = y2 - y1;
1111
1112   if (x_distance)
1113     *x_distance = xd;
1114
1115   if (y_distance)
1116     *y_distance = yd;
1117
1118   if (distance)
1119     *distance = sqrt ((xd * xd) + (yd * yd));
1120
1121   return TRUE;
1122 }
1123
1124 /**
1125  * gdk_events_get_distance:
1126  * @event1: first #GdkEvent
1127  * @event2: second #GdkEvent
1128  * @distance: return location for the distance
1129  *
1130  * If both events have X/Y information, the distance between both coordinates
1131  * (as in a straight line going from @event1 to @event2) will be returned.
1132  *
1133  * Returns: %TRUE if the distance could be calculated.
1134  *
1135  * Since: 3.0
1136  **/
1137 gboolean
1138 gdk_events_get_distance (GdkEvent *event1,
1139                          GdkEvent *event2,
1140                          gdouble  *distance)
1141 {
1142   return gdk_events_get_axis_distances (event1, event2,
1143                                         NULL, NULL,
1144                                         distance);
1145 }
1146
1147 /**
1148  * gdk_events_get_angle:
1149  * @event1: first #GdkEvent
1150  * @event2: second #GdkEvent
1151  * @angle: return location for the relative angle between both events
1152  *
1153  * If both events contain X/Y information, this function will return %TRUE
1154  * and return in @angle the relative angle from @event1 to @event2. The rotation
1155  * direction for positive angles is from the positive X axis towards the positive
1156  * Y axis.
1157  *
1158  * Returns: %TRUE if the angle could be calculated.
1159  *
1160  * Since: 3.0
1161  **/
1162 gboolean
1163 gdk_events_get_angle (GdkEvent *event1,
1164                       GdkEvent *event2,
1165                       gdouble  *angle)
1166 {
1167   gdouble x_distance, y_distance, distance;
1168
1169   if (!gdk_events_get_axis_distances (event1, event2,
1170                                       &x_distance, &y_distance,
1171                                       &distance))
1172     return FALSE;
1173
1174   if (angle)
1175     {
1176       *angle = atan2 (x_distance, y_distance);
1177
1178       /* Invert angle */
1179       *angle = (2 * G_PI) - *angle;
1180
1181       /* Shift it 90° */
1182       *angle += G_PI / 2;
1183
1184       /* And constraint it to 0°-360° */
1185       *angle = fmod (*angle, 2 * G_PI);
1186     }
1187
1188   return TRUE;
1189 }
1190
1191 /**
1192  * gdk_events_get_center:
1193  * @event1: first #GdkEvent
1194  * @event2: second #GdkEvent
1195  * @x: (out): return location for the X coordinate of the center
1196  * @y: (out): return location for the Y coordinate of the center
1197  *
1198  * If both events contain X/Y information, the center of both coordinates
1199  * will be returned in @x and @y.
1200  *
1201  * Returns: %TRUE if the center could be calculated.
1202  *
1203  * Since: 3.0
1204  **/
1205 gboolean
1206 gdk_events_get_center (GdkEvent *event1,
1207                        GdkEvent *event2,
1208                        gdouble  *x,
1209                        gdouble  *y)
1210 {
1211   gdouble x1, x2, y1, y2;
1212
1213   if (!gdk_event_get_coords (event1, &x1, &y1) ||
1214       !gdk_event_get_coords (event2, &x2, &y2))
1215     return FALSE;
1216
1217   if (x)
1218     *x = (x2 + x1) / 2;
1219
1220   if (y)
1221     *y = (y2 + y1) / 2;
1222
1223   return TRUE;
1224 }
1225
1226 /**
1227  * gdk_event_set_screen:
1228  * @event: a #GdkEvent
1229  * @screen: a #GdkScreen
1230  * 
1231  * Sets the screen for @event to @screen. The event must
1232  * have been allocated by GTK+, for instance, by
1233  * gdk_event_copy().
1234  *
1235  * Since: 2.2
1236  **/
1237 void
1238 gdk_event_set_screen (GdkEvent  *event,
1239                       GdkScreen *screen)
1240 {
1241   GdkEventPrivate *private;
1242   
1243   g_return_if_fail (gdk_event_is_allocated (event));
1244
1245   private = (GdkEventPrivate *)event;
1246   
1247   private->screen = screen;
1248 }
1249
1250 /**
1251  * gdk_event_get_screen:
1252  * @event: a #GdkEvent
1253  * 
1254  * Returns the screen for the event. The screen is
1255  * typically the screen for <literal>event->any.window</literal>, but
1256  * for events such as mouse events, it is the screen
1257  * where the pointer was when the event occurs -
1258  * that is, the screen which has the root window 
1259  * to which <literal>event->motion.x_root</literal> and
1260  * <literal>event->motion.y_root</literal> are relative.
1261  * 
1262  * Return value: the screen for the event
1263  *
1264  * Since: 2.2
1265  **/
1266 GdkScreen *
1267 gdk_event_get_screen (const GdkEvent *event)
1268 {
1269   if (gdk_event_is_allocated (event))
1270     {
1271       GdkEventPrivate *private = (GdkEventPrivate *)event;
1272
1273       if (private->screen)
1274         return private->screen;
1275     }
1276
1277   if (event->any.window)
1278     return gdk_drawable_get_screen (event->any.window);
1279
1280   return NULL;
1281 }
1282
1283 /**
1284  * gdk_set_show_events:
1285  * @show_events:  %TRUE to output event debugging information.
1286  * 
1287  * Sets whether a trace of received events is output.
1288  * Note that GTK+ must be compiled with debugging (that is,
1289  * configured using the <option>--enable-debug</option> option)
1290  * to use this option.
1291  **/
1292 void
1293 gdk_set_show_events (gboolean show_events)
1294 {
1295   if (show_events)
1296     _gdk_debug_flags |= GDK_DEBUG_EVENTS;
1297   else
1298     _gdk_debug_flags &= ~GDK_DEBUG_EVENTS;
1299 }
1300
1301 /**
1302  * gdk_get_show_events:
1303  * 
1304  * Gets whether event debugging output is enabled.
1305  * 
1306  * Return value: %TRUE if event debugging output is enabled.
1307  **/
1308 gboolean
1309 gdk_get_show_events (void)
1310 {
1311   return (_gdk_debug_flags & GDK_DEBUG_EVENTS) != 0;
1312 }
1313
1314 /* What do we do with G_IO_NVAL?
1315  */
1316 #define READ_CONDITION (G_IO_IN | G_IO_HUP | G_IO_ERR)
1317 #define WRITE_CONDITION (G_IO_OUT | G_IO_ERR)
1318 #define EXCEPTION_CONDITION (G_IO_PRI)
1319
1320 static void
1321 gdk_synthesize_click (GdkDisplay *display,
1322                       GdkEvent   *event,
1323                       gint        nclicks)
1324 {
1325   GdkEvent temp_event;
1326   GdkEvent *event_copy;
1327   GList *link;
1328   
1329   g_return_if_fail (event != NULL);
1330   
1331   temp_event = *event;
1332   temp_event.type = (nclicks == 2) ? GDK_2BUTTON_PRESS : GDK_3BUTTON_PRESS;
1333
1334   event_copy = gdk_event_copy (&temp_event);
1335   link = _gdk_event_queue_append (display, event_copy);
1336 }
1337
1338 void
1339 _gdk_event_button_generate (GdkDisplay *display,
1340                             GdkEvent   *event)
1341 {
1342   GdkMultipleClickInfo *info;
1343
1344   info = g_hash_table_lookup (display->multiple_click_info, event->button.device);
1345
1346   if (G_UNLIKELY (!info))
1347     {
1348       info = g_new0 (GdkMultipleClickInfo, 1);
1349       info->button_number[0] = info->button_number[1] = -1;
1350
1351       g_hash_table_insert (display->multiple_click_info,
1352                            event->button.device, info);
1353     }
1354
1355   if ((event->button.time < (info->button_click_time[1] + 2 * display->double_click_time)) &&
1356       (event->button.window == info->button_window[1]) &&
1357       (event->button.button == info->button_number[1]) &&
1358       (ABS (event->button.x - info->button_x[1]) <= display->double_click_distance) &&
1359       (ABS (event->button.y - info->button_y[1]) <= display->double_click_distance))
1360     {
1361       gdk_synthesize_click (display, event, 3);
1362
1363       info->button_click_time[1] = 0;
1364       info->button_click_time[0] = 0;
1365       info->button_window[1] = NULL;
1366       info->button_window[0] = NULL;
1367       info->button_number[1] = -1;
1368       info->button_number[0] = -1;
1369       info->button_x[0] = info->button_x[1] = 0;
1370       info->button_y[0] = info->button_y[1] = 0;
1371     }
1372   else if ((event->button.time < (info->button_click_time[0] + display->double_click_time)) &&
1373            (event->button.window == info->button_window[0]) &&
1374            (event->button.button == info->button_number[0]) &&
1375            (ABS (event->button.x - info->button_x[0]) <= display->double_click_distance) &&
1376            (ABS (event->button.y - info->button_y[0]) <= display->double_click_distance))
1377     {
1378       gdk_synthesize_click (display, event, 2);
1379       
1380       info->button_click_time[1] = info->button_click_time[0];
1381       info->button_click_time[0] = event->button.time;
1382       info->button_window[1] = info->button_window[0];
1383       info->button_window[0] = event->button.window;
1384       info->button_number[1] = info->button_number[0];
1385       info->button_number[0] = event->button.button;
1386       info->button_x[1] = info->button_x[0];
1387       info->button_x[0] = event->button.x;
1388       info->button_y[1] = info->button_y[0];
1389       info->button_y[0] = event->button.y;
1390     }
1391   else
1392     {
1393       info->button_click_time[1] = 0;
1394       info->button_click_time[0] = event->button.time;
1395       info->button_window[1] = NULL;
1396       info->button_window[0] = event->button.window;
1397       info->button_number[1] = -1;
1398       info->button_number[0] = event->button.button;
1399       info->button_x[1] = 0;
1400       info->button_x[0] = event->button.x;
1401       info->button_y[1] = 0;
1402       info->button_y[0] = event->button.y;
1403     }
1404 }
1405
1406 void
1407 gdk_synthesize_window_state (GdkWindow     *window,
1408                              GdkWindowState unset_flags,
1409                              GdkWindowState set_flags)
1410 {
1411   GdkEvent temp_event;
1412   GdkWindowState old;
1413   
1414   g_return_if_fail (window != NULL);
1415   
1416   temp_event.window_state.window = window;
1417   temp_event.window_state.type = GDK_WINDOW_STATE;
1418   temp_event.window_state.send_event = FALSE;
1419   
1420   old = ((GdkWindowObject*) temp_event.window_state.window)->state;
1421   
1422   temp_event.window_state.new_window_state = old;
1423   temp_event.window_state.new_window_state |= set_flags;
1424   temp_event.window_state.new_window_state &= ~unset_flags;
1425   temp_event.window_state.changed_mask = temp_event.window_state.new_window_state ^ old;
1426
1427   if (temp_event.window_state.new_window_state == old)
1428     return; /* No actual work to do, nothing changed. */
1429
1430   /* Actually update the field in GdkWindow, this is sort of an odd
1431    * place to do it, but seems like the safest since it ensures we expose no
1432    * inconsistent state to the user.
1433    */
1434   
1435   ((GdkWindowObject*) window)->state = temp_event.window_state.new_window_state;
1436
1437   if (temp_event.window_state.changed_mask & GDK_WINDOW_STATE_WITHDRAWN)
1438     _gdk_window_update_viewable (window);
1439
1440   /* We only really send the event to toplevels, since
1441    * all the window states don't apply to non-toplevels.
1442    * Non-toplevels do use the GDK_WINDOW_STATE_WITHDRAWN flag
1443    * internally so we needed to update window->state.
1444    */
1445   switch (((GdkWindowObject*) window)->window_type)
1446     {
1447     case GDK_WINDOW_TOPLEVEL:
1448     case GDK_WINDOW_TEMP: /* ? */
1449       gdk_display_put_event (gdk_drawable_get_display (window), &temp_event);
1450       break;
1451       
1452     case GDK_WINDOW_FOREIGN:
1453     case GDK_WINDOW_ROOT:
1454     case GDK_WINDOW_CHILD:
1455       break;
1456     }
1457 }
1458
1459 /**
1460  * gdk_display_set_double_click_time:
1461  * @display: a #GdkDisplay
1462  * @msec: double click time in milliseconds (thousandths of a second) 
1463  * 
1464  * Sets the double click time (two clicks within this time interval
1465  * count as a double click and result in a #GDK_2BUTTON_PRESS event).
1466  * Applications should <emphasis>not</emphasis> set this, it is a global 
1467  * user-configured setting.
1468  *
1469  * Since: 2.2
1470  **/
1471 void
1472 gdk_display_set_double_click_time (GdkDisplay *display,
1473                                    guint       msec)
1474 {
1475   display->double_click_time = msec;
1476 }
1477
1478 /**
1479  * gdk_set_double_click_time:
1480  * @msec: double click time in milliseconds (thousandths of a second)
1481  *
1482  * Set the double click time for the default display. See
1483  * gdk_display_set_double_click_time(). 
1484  * See also gdk_display_set_double_click_distance().
1485  * Applications should <emphasis>not</emphasis> set this, it is a 
1486  * global user-configured setting.
1487  **/
1488 void
1489 gdk_set_double_click_time (guint msec)
1490 {
1491   gdk_display_set_double_click_time (gdk_display_get_default (), msec);
1492 }
1493
1494 /**
1495  * gdk_display_set_double_click_distance:
1496  * @display: a #GdkDisplay
1497  * @distance: distance in pixels
1498  * 
1499  * Sets the double click distance (two clicks within this distance
1500  * count as a double click and result in a #GDK_2BUTTON_PRESS event).
1501  * See also gdk_display_set_double_click_time().
1502  * Applications should <emphasis>not</emphasis> set this, it is a global 
1503  * user-configured setting.
1504  *
1505  * Since: 2.4
1506  **/
1507 void
1508 gdk_display_set_double_click_distance (GdkDisplay *display,
1509                                        guint       distance)
1510 {
1511   display->double_click_distance = distance;
1512 }
1513
1514 G_DEFINE_BOXED_TYPE (GdkEvent, gdk_event,
1515                      gdk_event_copy,
1516                      gdk_event_free)
1517
1518 /**
1519  * gdk_setting_get:
1520  * @name: the name of the setting.
1521  * @value: location to store the value of the setting.
1522  *
1523  * Obtains a desktop-wide setting, such as the double-click time,
1524  * for the default screen. See gdk_screen_get_setting().
1525  *
1526  * Returns: %TRUE if the setting existed and a value was stored
1527  *   in @value, %FALSE otherwise.
1528  **/
1529 gboolean
1530 gdk_setting_get (const gchar *name,
1531                  GValue      *value)
1532 {
1533   return gdk_screen_get_setting (gdk_screen_get_default (), name, value);
1534 }