]> Pileus Git - ~andy/gtk/blob - gdk/gdkwindow.c
gdk: Don't crash when resetting cursor
[~andy/gtk] / gdk / gdkwindow.c
1 /* GDK - The GIMP Drawing Kit
2  * Copyright (C) 1995-2007 Peter Mattis, Spencer Kimball,
3  * Josh MacDonald, Ryan Lortie
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Lesser General Public
7  * License as published by the Free Software Foundation; either
8  * version 2 of the License, or (at your option) any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public
16  * License along with this library. If not, see <http://www.gnu.org/licenses/>.
17  */
18
19 /*
20  * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
21  * file for a list of people on the GTK+ Team.  See the ChangeLog
22  * files for a list of changes.  These files are distributed with
23  * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
24  */
25
26 #include "config.h"
27
28 #include <cairo-gobject.h>
29
30 #include "gdkwindow.h"
31
32 #include "gdkrectangle.h"
33 #include "gdkinternals.h"
34 #include "gdkintl.h"
35 #include "gdkscreenprivate.h"
36 #include "gdkdisplayprivate.h"
37 #include "gdkdeviceprivate.h"
38 #include "gdkvisualprivate.h"
39 #include "gdkmarshalers.h"
40 #include "gdkwindowimpl.h"
41
42 #include <math.h>
43
44 #undef DEBUG_WINDOW_PRINTING
45
46
47 /**
48  * SECTION:windows
49  * @Short_description: Onscreen display areas in the target window system
50  * @Title: Windows
51  *
52  * A #GdkWindow is a (usually) rectangular region on the screen.
53  * It's a low-level object, used to implement high-level objects such as
54  * #GtkWidget and #GtkWindow on the GTK+ level. A #GtkWindow is a toplevel
55  * window, the thing a user might think of as a "window" with a titlebar and
56  * so on; a #GtkWindow may contain many #GdkWindows. For example, each
57  * #GtkButton has a #GdkWindow associated with it.
58  *
59  * <refsect2 id="COMPOSITED-WINDOWS">
60  * <title>Composited Windows</title>
61  * <para>
62  * Normally, the windowing system takes care of rendering the contents of a
63  * child window onto its parent window. This mechanism can be intercepted by
64  * calling gdk_window_set_composited() on the child window. For a
65  * <firstterm>composited</firstterm> window it is the responsibility of the
66  * application to render the window contents at the right spot.
67  * </para>
68  * <example id="composited-window-example">
69  * <title>Composited windows</title>
70  * <programlisting>
71  * <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" parse="text" href="../../../../examples/gdk/composited-window-example.c"><xi:fallback>FIXME: MISSING XINCLUDE CONTENT</xi:fallback></xi:include>
72  * </programlisting></example>
73  * <para>
74  * In the example <xref linkend="composited-window-example"/>, a button is
75  * placed inside of an event box inside of a window. The event box is set as
76  * composited and therefore is no longer automatically drawn to the screen.
77  *
78  * When the contents of the event box change, an expose event is generated on
79  * its parent window (which, in this case, belongs to the toplevel #GtkWindow).
80  * The expose handler for this widget is responsible for merging the changes
81  * back on the screen in the way that it wishes.
82  *
83  * In our case, we merge the contents with a 50% transparency. We also set the
84  * background colour of the window to red. The effect is that the background
85  * shows through the button.
86  * </para>
87  * </refsect2>
88  * <refsect2 id="OFFSCREEN-WINDOWS">
89  * <title>Offscreen Windows</title>
90  * <para>
91  * Offscreen windows are more general than composited windows, since they allow
92  * not only to modify the rendering of the child window onto its parent, but
93  * also to apply coordinate transformations.
94  *
95  * To integrate an offscreen window into a window hierarchy, one has to call
96  * gdk_offscreen_window_set_embedder() and handle a number of signals. The
97  * #GdkWindow::pick-embedded-child signal on the embedder window is used to
98  * select an offscreen child at given coordinates, and the
99  * #GdkWindow::to-embedder and #GdkWindow::from-embedder signals on the
100  * offscreen window are used to translate coordinates between the embedder and
101  * the offscreen window.
102  *
103  * For rendering an offscreen window onto its embedder, the contents of the
104  * offscreen window are available as a surface, via
105  * gdk_offscreen_window_get_surface().
106  * </para>
107  * </refsect2>
108  */
109
110
111 /* Historically a GdkWindow always matches a platform native window,
112  * be it a toplevel window or a child window. In this setup the
113  * GdkWindow (and other GdkDrawables) were platform independent classes,
114  * and the actual platform specific implementation was in a delegate
115  * object availible as "impl" in the window object.
116  *
117  * With the addition of client side windows and offscreen windows this
118  * changes a bit. The application-visible GdkWindow object behaves as
119  * it did before, but not all such windows now have a corresponding native
120  * window. Instead windows that are "client side" are emulated by the gdk
121  * code such that clipping, drawing, moving, events etc work as expected.
122  *
123  * For GdkWindows that have a native window the "impl" object is the
124  * same as before. However, for all client side windows the impl object
125  * is shared with its parent (i.e. all client windows descendants of one
126  * native window has the same impl.
127  *
128  * Additionally there is a new type of platform independent impl object,
129  * GdkOffscreenWindow. All windows of type GDK_WINDOW_OFFSCREEN get an impl
130  * of this type (while their children are generally GDK_WINDOW_CHILD virtual
131  * windows). Such windows work by allocating a #cairo_surface_t as the backing
132  * store for drawing operations, which is resized with the window.
133  *
134  * GdkWindows have a pointer to the "impl window" they are in, i.e.
135  * the topmost GdkWindow which have the same "impl" value. This is stored
136  * in impl_window, which is different from the window itself only for client
137  * side windows.
138  * All GdkWindows (native or not) track the position of the window in the parent
139  * (x, y), the size of the window (width, height), the position of the window
140  * with respect to the impl window (abs_x, abs_y). We also track the clip
141  * region of the window wrt parent windows and siblings, in window-relative
142  * coordinates with and without child windows included (clip_region,
143  * clip_region_with_children).
144  *
145  * All toplevel windows are native windows, but also child windows can be
146  * native (although not children of offscreens). We always listen to
147  * a basic set of events (see get_native_event_mask) for these windows
148  * so that we can emulate events for any client side children.
149  *
150  * For native windows we apply the calculated clip region as a window shape
151  * so that eg. client side siblings that overlap the native child properly
152  * draws over the native child window.
153  *
154  * In order to minimize flicker and for performance we use a couple of cacheing
155  * tricks. First of all, every time we do a window to window copy area, for instance
156  * when moving a client side window or when scrolling/moving a region in a window
157  * we store this in outstanding_moves instead of applying immediately. We then
158  * delay this move until we really need it (because something depends on being
159  * able to read it), or until we're handing a redraw from an expose/invalidation
160  * (actually we delay it past redraw, but before blitting the double buffer
161  * to the window). This gives us two advantages. First of all it minimizes the time
162  * from the window is moved to the exposes related to that move, secondly it allows
163  * us to be smart about how to do the copy. We combine multiple moves into one (when
164  * possible) and we don't actually do copies to anything that is or will be
165  * invalidated and exposed anyway.
166  *
167  * Secondly, we use something called a "implicit paint" during repaint handling.
168  * An implicit paint is similar to a regular paint for the paint stack, but it is
169  * not put on the stack. Instead, it is set on the impl window, and later when
170  * regular gdk_window_begin_paint_region()  happen on a window of this impl window
171  * we reuse the surface from the implicit paint. During repaint we create and at the
172  * end flush an implicit paint, which means we can collect all the paints on
173  * multiple client side windows in the same backing store.
174  */
175
176 #define USE_BACKING_STORE       /* Appears to work on Win32, too, now. */
177
178 /* This adds a local value to the GdkVisibilityState enum */
179 #define GDK_VISIBILITY_NOT_VIEWABLE 3
180
181 enum {
182   PICK_EMBEDDED_CHILD, /* only called if children are embedded */
183   TO_EMBEDDER,
184   FROM_EMBEDDER,
185   CREATE_SURFACE,
186   LAST_SIGNAL
187 };
188
189 enum {
190   PROP_0,
191   PROP_CURSOR
192 };
193
194 typedef enum {
195   CLEAR_BG_NONE,
196   CLEAR_BG_WINCLEARED, /* Clear backgrounds except those that the window system clears */
197   CLEAR_BG_ALL
198 } ClearBg;
199
200 struct _GdkWindowPaint
201 {
202   cairo_region_t *region;
203   cairo_surface_t *surface;
204   cairo_region_t *flushed;
205   guint uses_implicit : 1;
206 };
207
208 typedef struct {
209   cairo_region_t *dest_region; /* The destination region */
210   int dx, dy; /* The amount that the source was moved to reach dest_region */
211 } GdkWindowRegionMove;
212
213 /* Global info */
214
215 static void             gdk_window_drop_cairo_surface (GdkWindow *private);
216
217 static void gdk_window_free_paint_stack (GdkWindow *window);
218
219 static void gdk_window_finalize   (GObject              *object);
220
221 static void gdk_window_set_property (GObject      *object,
222                                      guint         prop_id,
223                                      const GValue *value,
224                                      GParamSpec   *pspec);
225 static void gdk_window_get_property (GObject      *object,
226                                      guint         prop_id,
227                                      GValue       *value,
228                                      GParamSpec   *pspec);
229
230 static void gdk_window_clear_backing_region (GdkWindow *window,
231                                              cairo_region_t *region);
232
233 static void recompute_visible_regions   (GdkWindow *private,
234                                          gboolean recalculate_siblings,
235                                          gboolean recalculate_children);
236 static void gdk_window_flush_outstanding_moves (GdkWindow *window);
237 static void gdk_window_flush_recursive  (GdkWindow *window);
238 static void do_move_region_bits_on_impl (GdkWindow *window,
239                                          cairo_region_t *region, /* In impl window coords */
240                                          int dx, int dy);
241 static void gdk_window_invalidate_in_parent (GdkWindow *private);
242 static void move_native_children        (GdkWindow *private);
243 static void update_cursor               (GdkDisplay *display,
244                                          GdkDevice  *device);
245 static void impl_window_add_update_area (GdkWindow *impl_window,
246                                          cairo_region_t *region);
247 static void gdk_window_region_move_free (GdkWindowRegionMove *move);
248 static void gdk_window_invalidate_region_full (GdkWindow       *window,
249                                                const cairo_region_t *region,
250                                                gboolean         invalidate_children,
251                                                ClearBg          clear_bg);
252 static void gdk_window_invalidate_rect_full (GdkWindow          *window,
253                                              const GdkRectangle *rect,
254                                              gboolean            invalidate_children,
255                                              ClearBg             clear_bg);
256 static void _gdk_window_propagate_has_alpha_background (GdkWindow *window);
257
258 static guint signals[LAST_SIGNAL] = { 0 };
259
260 static gpointer parent_class = NULL;
261
262 static const cairo_user_data_key_t gdk_window_cairo_key;
263
264 G_DEFINE_ABSTRACT_TYPE (GdkWindow, gdk_window, G_TYPE_OBJECT)
265
266 GType
267 _gdk_paintable_get_type (void)
268 {
269   static GType paintable_type = 0;
270
271   if (!paintable_type)
272     {
273       const GTypeInfo paintable_info =
274       {
275         sizeof (GdkPaintableIface),  /* class_size */
276         NULL,                        /* base_init */
277         NULL,                        /* base_finalize */
278       };
279
280       paintable_type = g_type_register_static (G_TYPE_INTERFACE,
281                                                g_intern_static_string ("GdkPaintable"),
282                                                &paintable_info, 0);
283
284       g_type_interface_add_prerequisite (paintable_type, G_TYPE_OBJECT);
285     }
286
287   return paintable_type;
288 }
289
290 static void
291 gdk_window_init (GdkWindow *window)
292 {
293   /* 0-initialization is good for all other fields. */
294
295   window->window_type = GDK_WINDOW_CHILD;
296
297   window->state = GDK_WINDOW_STATE_WITHDRAWN;
298   window->width = 1;
299   window->height = 1;
300   window->toplevel_window_type = -1;
301   /* starts hidden */
302   window->effective_visibility = GDK_VISIBILITY_NOT_VIEWABLE;
303   window->visibility = GDK_VISIBILITY_FULLY_OBSCURED;
304   /* Default to unobscured since some backends don't send visibility events */
305   window->native_visibility = GDK_VISIBILITY_UNOBSCURED;
306
307   window->device_cursor = g_hash_table_new_full (NULL, NULL,
308                                                  NULL, g_object_unref);
309 }
310
311 /* Stop and return on the first non-NULL parent */
312 static gboolean
313 accumulate_get_window (GSignalInvocationHint *ihint,
314                        GValue                  *return_accu,
315                        const GValue            *handler_return,
316                        gpointer               data)
317 {
318   g_value_copy (handler_return, return_accu);
319   /* Continue while returning NULL */
320   return g_value_get_object (handler_return) == NULL;
321 }
322
323 static gboolean
324 create_surface_accumulator (GSignalInvocationHint *ihint,
325                             GValue                *return_accu,
326                             const GValue          *handler_return,
327                             gpointer               data)
328 {
329   g_value_copy (handler_return, return_accu);
330
331   /* Stop on the first non-NULL return value */
332   return g_value_get_boxed (handler_return) == NULL;
333 }
334
335 static GQuark quark_pointer_window = 0;
336
337 static void
338 gdk_window_class_init (GdkWindowClass *klass)
339 {
340   GObjectClass *object_class = G_OBJECT_CLASS (klass);
341
342   parent_class = g_type_class_peek_parent (klass);
343
344   object_class->finalize = gdk_window_finalize;
345   object_class->set_property = gdk_window_set_property;
346   object_class->get_property = gdk_window_get_property;
347
348   klass->create_surface = _gdk_offscreen_window_create_surface;
349
350   quark_pointer_window = g_quark_from_static_string ("gtk-pointer-window");
351
352
353   /* Properties */
354
355   /**
356    * GdkWindow:cursor:
357    *
358    * The mouse pointer for a #GdkWindow. See gdk_window_set_cursor() and
359    * gdk_window_get_cursor() for details.
360    *
361    * Since: 2.18
362    */
363   g_object_class_install_property (object_class,
364                                    PROP_CURSOR,
365                                    g_param_spec_object ("cursor",
366                                                         P_("Cursor"),
367                                                         P_("Cursor"),
368                                                         GDK_TYPE_CURSOR,
369                                                         G_PARAM_READWRITE));
370
371   /**
372    * GdkWindow::pick-embedded-child:
373    * @window: the window on which the signal is emitted
374    * @x: x coordinate in the window
375    * @y: y coordinate in the window
376    *
377    * The ::pick-embedded-child signal is emitted to find an embedded
378    * child at the given position.
379    *
380    * Returns: (transfer none): the #GdkWindow of the embedded child at
381    *     @x, @y, or %NULL
382    *
383    * Since: 2.18
384    */
385   signals[PICK_EMBEDDED_CHILD] =
386     g_signal_new (g_intern_static_string ("pick-embedded-child"),
387                   G_OBJECT_CLASS_TYPE (object_class),
388                   G_SIGNAL_RUN_LAST,
389                   G_STRUCT_OFFSET (GdkWindowClass, pick_embedded_child),
390                   accumulate_get_window, NULL,
391                   _gdk_marshal_OBJECT__DOUBLE_DOUBLE,
392                   GDK_TYPE_WINDOW,
393                   2,
394                   G_TYPE_DOUBLE,
395                   G_TYPE_DOUBLE);
396
397   /**
398    * GdkWindow::to-embedder:
399    * @window: the offscreen window on which the signal is emitted
400    * @offscreen-x: x coordinate in the offscreen window
401    * @offscreen-y: y coordinate in the offscreen window
402    * @embedder-x: (out) (type double): return location for the x
403    *     coordinate in the embedder window
404    * @embedder-y: (out) (type double): return location for the y
405    *     coordinate in the embedder window
406    *
407    * The ::to-embedder signal is emitted to translate coordinates
408    * in an offscreen window to its embedder.
409    *
410    * See also #GtkWindow::from-embedder.
411    *
412    * Since: 2.18
413    */
414   signals[TO_EMBEDDER] =
415     g_signal_new (g_intern_static_string ("to-embedder"),
416                   G_OBJECT_CLASS_TYPE (object_class),
417                   G_SIGNAL_RUN_LAST,
418                   G_STRUCT_OFFSET (GdkWindowClass, to_embedder),
419                   NULL, NULL,
420                   _gdk_marshal_VOID__DOUBLE_DOUBLE_POINTER_POINTER,
421                   G_TYPE_NONE,
422                   4,
423                   G_TYPE_DOUBLE,
424                   G_TYPE_DOUBLE,
425                   G_TYPE_POINTER,
426                   G_TYPE_POINTER);
427
428   /**
429    * GdkWindow::from-embedder:
430    * @window: the offscreen window on which the signal is emitted
431    * @embedder-x: x coordinate in the embedder window
432    * @embedder-y: y coordinate in the embedder window
433    * @offscreen-x: (out) (type double): return location for the x
434    *     coordinate in the offscreen window
435    * @offscreen-y: (out) (type double): return location for the y
436    *     coordinate in the offscreen window
437    *
438    * The ::from-embedder signal is emitted to translate coordinates
439    * in the embedder of an offscreen window to the offscreen window.
440    *
441    * See also #GtkWindow::to-embedder.
442    *
443    * Since: 2.18
444    */
445   signals[FROM_EMBEDDER] =
446     g_signal_new (g_intern_static_string ("from-embedder"),
447                   G_OBJECT_CLASS_TYPE (object_class),
448                   G_SIGNAL_RUN_LAST,
449                   G_STRUCT_OFFSET (GdkWindowClass, from_embedder),
450                   NULL, NULL,
451                   _gdk_marshal_VOID__DOUBLE_DOUBLE_POINTER_POINTER,
452                   G_TYPE_NONE,
453                   4,
454                   G_TYPE_DOUBLE,
455                   G_TYPE_DOUBLE,
456                   G_TYPE_POINTER,
457                   G_TYPE_POINTER);
458
459   /**
460    * GdkWindow::create-surface:
461    * @window: the offscreen window on which the signal is emitted
462    * @width: the width of the offscreen surface to create
463    * @height: the height of the offscreen surface to create
464    *
465    * The ::create-surface signal is emitted when an offscreen window
466    * needs its surface (re)created, which happens either when the the
467    * window is first drawn to, or when the window is being
468    * resized. The first signal handler that returns a non-%NULL
469    * surface will stop any further signal emission, and its surface
470    * will be used.
471    *
472    * Note that it is not possible to access the window's previous
473    * surface from within any callback of this signal. Calling
474    * gdk_offscreen_window_get_surface() will lead to a crash.
475    *
476    * Returns: the newly created #cairo_surface_t for the offscreen window
477    *
478    * Since: 3.0
479    */
480   signals[CREATE_SURFACE] =
481     g_signal_new (g_intern_static_string ("create-surface"),
482                   G_OBJECT_CLASS_TYPE (object_class),
483                   G_SIGNAL_RUN_LAST,
484                   G_STRUCT_OFFSET (GdkWindowClass, create_surface),
485                   create_surface_accumulator, NULL,
486                   _gdk_marshal_BOXED__INT_INT,
487                   CAIRO_GOBJECT_TYPE_SURFACE,
488                   2,
489                   G_TYPE_INT,
490                   G_TYPE_INT);
491 }
492
493 static void
494 device_removed_cb (GdkDeviceManager *device_manager,
495                    GdkDevice        *device,
496                    GdkWindow        *window)
497 {
498   window->devices_inside = g_list_remove (window->devices_inside, device);
499   g_hash_table_remove (window->device_cursor, device);
500
501   if (window->device_events)
502     g_hash_table_remove (window->device_events, device);
503 }
504
505 static void
506 gdk_window_finalize (GObject *object)
507 {
508   GdkWindow *window = GDK_WINDOW (object);
509   GdkDeviceManager *device_manager;
510
511   device_manager = gdk_display_get_device_manager (gdk_window_get_display (window));
512   g_signal_handlers_disconnect_by_func (device_manager, device_removed_cb, window);
513
514   if (!GDK_WINDOW_DESTROYED (window))
515     {
516       if (GDK_WINDOW_TYPE (window) != GDK_WINDOW_FOREIGN)
517         {
518           g_warning ("losing last reference to undestroyed window\n");
519           _gdk_window_destroy (window, FALSE);
520         }
521       else
522         /* We use TRUE here, to keep us from actually calling
523          * XDestroyWindow() on the window
524          */
525         _gdk_window_destroy (window, TRUE);
526     }
527
528   gdk_window_drop_cairo_surface (window);
529
530   if (window->impl)
531     {
532       g_object_unref (window->impl);
533       window->impl = NULL;
534     }
535
536   if (window->impl_window != window)
537     {
538       g_object_unref (window->impl_window);
539       window->impl_window = NULL;
540     }
541
542   if (window->shape)
543     cairo_region_destroy (window->shape);
544
545   if (window->input_shape)
546     cairo_region_destroy (window->input_shape);
547
548   if (window->cursor)
549     g_object_unref (window->cursor);
550
551   if (window->device_cursor)
552     g_hash_table_destroy (window->device_cursor);
553
554   if (window->device_events)
555     g_hash_table_destroy (window->device_events);
556
557   if (window->source_event_masks)
558     g_hash_table_destroy (window->source_event_masks);
559
560   if (window->devices_inside)
561     g_list_free (window->devices_inside);
562
563   if (window->layered_region)
564       cairo_region_destroy (window->layered_region);
565
566   G_OBJECT_CLASS (parent_class)->finalize (object);
567 }
568
569 static void
570 gdk_window_set_property (GObject      *object,
571                          guint         prop_id,
572                          const GValue *value,
573                          GParamSpec   *pspec)
574 {
575   GdkWindow *window = (GdkWindow *)object;
576
577   switch (prop_id)
578     {
579     case PROP_CURSOR:
580       gdk_window_set_cursor (window, g_value_get_object (value));
581       break;
582
583     default:
584       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
585       break;
586     }
587 }
588
589 static void
590 gdk_window_get_property (GObject    *object,
591                          guint       prop_id,
592                          GValue     *value,
593                          GParamSpec *pspec)
594 {
595   GdkWindow *window = (GdkWindow *) object;
596
597   switch (prop_id)
598     {
599     case PROP_CURSOR:
600       g_value_set_object (value, gdk_window_get_cursor (window));
601       break;
602
603     default:
604       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
605       break;
606     }
607 }
608
609 static gboolean
610 gdk_window_is_offscreen (GdkWindow *window)
611 {
612   return window->window_type == GDK_WINDOW_OFFSCREEN;
613 }
614
615 static GdkWindow *
616 gdk_window_get_impl_window (GdkWindow *window)
617 {
618   return window->impl_window;
619 }
620
621 GdkWindow *
622 _gdk_window_get_impl_window (GdkWindow *window)
623 {
624   return gdk_window_get_impl_window (window);
625 }
626
627 static gboolean
628 gdk_window_has_impl (GdkWindow *window)
629 {
630   return window->impl_window == window;
631 }
632
633 static gboolean
634 gdk_window_is_toplevel (GdkWindow *window)
635 {
636   return
637     window->parent == NULL ||
638     window->parent->window_type == GDK_WINDOW_ROOT;
639 }
640
641 gboolean
642 _gdk_window_has_impl (GdkWindow *window)
643 {
644   return gdk_window_has_impl (window);
645 }
646
647 static gboolean
648 gdk_window_has_no_impl (GdkWindow *window)
649 {
650   return window->impl_window != window;
651 }
652
653 static void
654 remove_layered_child_area (GdkWindow *window,
655                            cairo_region_t *region)
656 {
657   GdkWindow *child;
658   cairo_region_t *child_region;
659   GdkRectangle r;
660   GList *l;
661
662   for (l = window->children; l; l = l->next)
663     {
664       child = l->data;
665
666       /* If region is empty already, no need to do
667          anything potentially costly */
668       if (cairo_region_is_empty (region))
669         break;
670
671       if (!GDK_WINDOW_IS_MAPPED (child) || child->input_only || child->composited)
672         continue;
673
674       /* Ignore offscreen children, as they don't draw in their parent and
675        * don't take part in the clipping */
676       if (gdk_window_is_offscreen (child))
677         continue;
678
679       /* Only non-impl children with alpha add to the layered region */
680       if (!child->has_alpha_background && gdk_window_has_impl (child))
681         continue;
682
683       r.x = child->x;
684       r.y = child->y;
685       r.width = child->width;
686       r.height = child->height;
687
688       /* Bail early if child totally outside region */
689       if (cairo_region_contains_rectangle (region, &r) == CAIRO_REGION_OVERLAP_OUT)
690         continue;
691
692       child_region = cairo_region_create_rectangle (&r);
693       if (child->shape)
694         {
695           /* Adjust shape region to parent window coords */
696           cairo_region_translate (child->shape, child->x, child->y);
697           cairo_region_intersect (child_region, child->shape);
698           cairo_region_translate (child->shape, -child->x, -child->y);
699         }
700
701       cairo_region_subtract (region, child_region);
702       cairo_region_destroy (child_region);
703     }
704 }
705
706 static void
707 remove_child_area (GdkWindow *window,
708                    GdkWindow *until,
709                    gboolean for_input,
710                    cairo_region_t *region,
711                    cairo_region_t *layered_region)
712 {
713   GdkWindow *child;
714   cairo_region_t *child_region;
715   GdkRectangle r;
716   GList *l;
717   cairo_region_t *shape;
718
719   for (l = window->children; l; l = l->next)
720     {
721       child = l->data;
722
723       if (child == until)
724         break;
725
726       /* If region is empty already, no need to do
727          anything potentially costly */
728       if (cairo_region_is_empty (region))
729         break;
730
731       if (!GDK_WINDOW_IS_MAPPED (child) || child->input_only || child->composited)
732         continue;
733
734       /* Ignore offscreen children, as they don't draw in their parent and
735        * don't take part in the clipping */
736       if (gdk_window_is_offscreen (child))
737         continue;
738
739       r.x = child->x;
740       r.y = child->y;
741       r.width = child->width;
742       r.height = child->height;
743
744       /* Bail early if child totally outside region */
745       if (cairo_region_contains_rectangle (region, &r) == CAIRO_REGION_OVERLAP_OUT)
746         continue;
747
748       child_region = cairo_region_create_rectangle (&r);
749
750       if (child->shape)
751         {
752           /* Adjust shape region to parent window coords */
753           cairo_region_translate (child->shape, child->x, child->y);
754           cairo_region_intersect (child_region, child->shape);
755           cairo_region_translate (child->shape, -child->x, -child->y);
756         }
757       else if (window->window_type == GDK_WINDOW_FOREIGN)
758         {
759           shape = GDK_WINDOW_IMPL_GET_CLASS (child)->get_shape (child);
760           if (shape)
761             {
762               cairo_region_intersect (child_region, shape);
763               cairo_region_destroy (shape);
764             }
765         }
766
767       if (for_input)
768         {
769           if (child->input_shape)
770             cairo_region_intersect (child_region, child->input_shape);
771           else if (window->window_type == GDK_WINDOW_FOREIGN)
772             {
773               shape = GDK_WINDOW_IMPL_GET_CLASS (child)->get_input_shape (child);
774               if (shape)
775                 {
776                   cairo_region_intersect (child_region, shape);
777                   cairo_region_destroy (shape);
778                 }
779             }
780         }
781
782       if (child->has_alpha_background)
783         {
784           if (layered_region != NULL)
785             cairo_region_union (layered_region, child_region);
786         }
787       else
788         cairo_region_subtract (region, child_region);
789       cairo_region_destroy (child_region);
790     }
791 }
792
793 static GdkVisibilityState
794 effective_visibility (GdkWindow *window)
795 {
796   GdkVisibilityState native;
797
798   if (!gdk_window_is_viewable (window))
799     return GDK_VISIBILITY_NOT_VIEWABLE;
800
801   native = window->impl_window->native_visibility;
802
803   if (native == GDK_VISIBILITY_FULLY_OBSCURED ||
804       window->visibility == GDK_VISIBILITY_FULLY_OBSCURED)
805     return GDK_VISIBILITY_FULLY_OBSCURED;
806   else if (native == GDK_VISIBILITY_UNOBSCURED)
807     return window->visibility;
808   else /* native PARTIAL, private partial or unobscured  */
809     return GDK_VISIBILITY_PARTIAL;
810 }
811
812 static void
813 gdk_window_update_visibility (GdkWindow *window)
814 {
815   GdkVisibilityState new_visibility;
816   GdkEvent *event;
817
818   new_visibility = effective_visibility (window);
819
820   if (new_visibility != window->effective_visibility)
821     {
822       window->effective_visibility = new_visibility;
823
824       if (new_visibility != GDK_VISIBILITY_NOT_VIEWABLE &&
825           window->event_mask & GDK_VISIBILITY_NOTIFY_MASK)
826         {
827           event = _gdk_make_event (window, GDK_VISIBILITY_NOTIFY,
828                                    NULL, FALSE);
829           event->visibility.state = new_visibility;
830         }
831     }
832 }
833
834 static void
835 gdk_window_update_visibility_recursively (GdkWindow *window,
836                                           GdkWindow *only_for_impl)
837 {
838   GdkWindow *child;
839   GList *l;
840
841   gdk_window_update_visibility (window);
842   for (l = window->children; l != NULL; l = l->next)
843     {
844       child = l->data;
845       if ((only_for_impl == NULL) ||
846           (only_for_impl == child->impl_window))
847         gdk_window_update_visibility_recursively (child, only_for_impl);
848     }
849 }
850
851 static gboolean
852 should_apply_clip_as_shape (GdkWindow *window)
853 {
854   return
855     gdk_window_has_impl (window) &&
856     /* Not for offscreens */
857     !gdk_window_is_offscreen (window) &&
858     /* or for toplevels */
859     !gdk_window_is_toplevel (window) &&
860     /* or for foreign windows */
861     window->window_type != GDK_WINDOW_FOREIGN &&
862     /* or for the root window */
863     window->window_type != GDK_WINDOW_ROOT;
864 }
865
866 static void
867 apply_shape (GdkWindow *window,
868              cairo_region_t *region)
869 {
870   GdkWindowImplClass *impl_class;
871
872   /* We trash whether we applied a shape so that
873      we can avoid unsetting it many times, which
874      could happen in e.g. apply_clip_as_shape as
875      windows get resized */
876   impl_class = GDK_WINDOW_IMPL_GET_CLASS (window->impl);
877   if (region)
878     impl_class->shape_combine_region (window,
879                                       region, 0, 0);
880   else if (window->applied_shape)
881     impl_class->shape_combine_region (window,
882                                       NULL, 0, 0);
883
884   window->applied_shape = region != NULL;
885 }
886
887 static gboolean
888 region_rect_equal (const cairo_region_t *region,
889                    const GdkRectangle *rect)
890 {
891     GdkRectangle extents;
892
893     if (cairo_region_num_rectangles (region) != 1)
894         return FALSE;
895
896     cairo_region_get_extents (region, &extents);
897
898     return extents.x == rect->x &&
899         extents.y == rect->y &&
900         extents.width == rect->width &&
901         extents.height == rect->height;
902 }
903
904 static void
905 apply_clip_as_shape (GdkWindow *window)
906 {
907   GdkRectangle r;
908
909   r.x = r.y = 0;
910   r.width = window->width;
911   r.height = window->height;
912
913   /* We only apply the clip region if would differ
914      from the actual clip region implied by the size
915      of the window. This is to avoid unneccessarily
916      adding meaningless shapes to all native subwindows */
917   if (!region_rect_equal (window->clip_region, &r))
918     apply_shape (window, window->clip_region);
919   else
920     apply_shape (window, NULL);
921 }
922
923 static void
924 recompute_visible_regions_internal (GdkWindow *private,
925                                     gboolean   recalculate_clip,
926                                     gboolean   recalculate_siblings,
927                                     gboolean   recalculate_children)
928 {
929   GdkRectangle r;
930   GList *l;
931   GdkWindow *child;
932   cairo_region_t *new_clip, *new_layered;
933   gboolean clip_region_changed;
934   gboolean abs_pos_changed;
935   int old_abs_x, old_abs_y;
936
937   old_abs_x = private->abs_x;
938   old_abs_y = private->abs_y;
939
940   /* Update absolute position */
941   if (gdk_window_has_impl (private))
942     {
943       /* Native window starts here */
944       private->abs_x = 0;
945       private->abs_y = 0;
946     }
947   else
948     {
949       private->abs_x = private->parent->abs_x + private->x;
950       private->abs_y = private->parent->abs_y + private->y;
951     }
952
953   abs_pos_changed =
954     private->abs_x != old_abs_x ||
955     private->abs_y != old_abs_y;
956
957   /* Update clip region based on:
958    * parent clip
959    * window size
960    * siblings in parents above window
961    */
962   clip_region_changed = FALSE;
963   if (recalculate_clip)
964     {
965       new_layered = cairo_region_create ();
966       if (private->viewable)
967         {
968           /* Calculate visible region (sans children) in parent window coords */
969           r.x = private->x;
970           r.y = private->y;
971           r.width = private->width;
972           r.height = private->height;
973           new_clip = cairo_region_create_rectangle (&r);
974
975           if (!gdk_window_is_toplevel (private))
976             {
977               cairo_region_intersect (new_clip, private->parent->clip_region);
978               cairo_region_union (new_layered, private->parent->layered_region);
979
980               /* Remove all overlapping children from parent. */
981               remove_child_area (private->parent, private, FALSE, new_clip, new_layered);
982             }
983
984           /* Convert from parent coords to window coords */
985           cairo_region_translate (new_clip, -private->x, -private->y);
986           cairo_region_translate (new_layered, -private->x, -private->y);
987
988           if (private->shape)
989             cairo_region_intersect (new_clip, private->shape);
990         }
991       else
992           new_clip = cairo_region_create ();
993
994       cairo_region_intersect (new_layered, new_clip);
995       
996       if (private->clip_region == NULL ||
997           !cairo_region_equal (private->clip_region, new_clip))
998         clip_region_changed = TRUE;
999
1000       if (private->layered_region == NULL ||
1001           !cairo_region_equal (private->layered_region, new_layered))
1002         clip_region_changed = TRUE;
1003       
1004       if (private->clip_region)
1005         cairo_region_destroy (private->clip_region);
1006       private->clip_region = new_clip;
1007
1008       if (private->layered_region != NULL)
1009         cairo_region_destroy (private->layered_region);
1010       private->layered_region = new_layered;
1011
1012       if (private->clip_region_with_children)
1013         cairo_region_destroy (private->clip_region_with_children);
1014       private->clip_region_with_children = cairo_region_copy (private->clip_region);
1015       if (private->window_type != GDK_WINDOW_ROOT)
1016         remove_child_area (private, NULL, FALSE, private->clip_region_with_children, NULL);
1017     }
1018
1019   if (clip_region_changed)
1020     {
1021       GdkVisibilityState visibility;
1022       gboolean fully_visible;
1023
1024       if (cairo_region_is_empty (private->clip_region))
1025         visibility = GDK_VISIBILITY_FULLY_OBSCURED;
1026       else
1027         {
1028           if (private->shape)
1029             {
1030               fully_visible = cairo_region_equal (private->clip_region,
1031                                                 private->shape);
1032             }
1033           else
1034             {
1035               r.x = 0;
1036               r.y = 0;
1037               r.width = private->width;
1038               r.height = private->height;
1039               fully_visible = region_rect_equal (private->clip_region, &r);
1040             }
1041
1042           if (fully_visible)
1043             visibility = GDK_VISIBILITY_UNOBSCURED;
1044           else
1045             visibility = GDK_VISIBILITY_PARTIAL;
1046         }
1047
1048       if (private->visibility != visibility)
1049         {
1050           private->visibility = visibility;
1051           gdk_window_update_visibility (private);
1052         }
1053     }
1054
1055   /* Update all children, recursively (except for root, where children are not exact). */
1056   if ((abs_pos_changed || clip_region_changed || recalculate_children) &&
1057       private->window_type != GDK_WINDOW_ROOT)
1058     {
1059       for (l = private->children; l; l = l->next)
1060         {
1061           child = l->data;
1062           /* Only recalculate clip if the the clip region changed, otherwise
1063            * there is no way the child clip region could change (its has not e.g. moved)
1064            * Except if recalculate_children is set to force child updates
1065            */
1066           recompute_visible_regions_internal (child,
1067                                               recalculate_clip && (clip_region_changed || recalculate_children),
1068                                               FALSE, FALSE);
1069         }
1070     }
1071
1072   if (clip_region_changed &&
1073       should_apply_clip_as_shape (private))
1074     apply_clip_as_shape (private);
1075
1076   if (recalculate_siblings &&
1077       !gdk_window_is_toplevel (private))
1078     {
1079       /* If we moved a child window in parent or changed the stacking order, then we
1080        * need to recompute the visible area of all the other children in the parent
1081        */
1082       for (l = private->parent->children; l; l = l->next)
1083         {
1084           child = l->data;
1085
1086           if (child != private)
1087             recompute_visible_regions_internal (child, TRUE, FALSE, FALSE);
1088         }
1089
1090       /* We also need to recompute the _with_children clip for the parent */
1091       recompute_visible_regions_internal (private->parent, TRUE, FALSE, FALSE);
1092     }
1093
1094   if (private->cairo_surface && gdk_window_has_impl (private))
1095     {
1096       GdkWindowImplClass *iface = GDK_WINDOW_IMPL_GET_CLASS (private->impl);
1097
1098       private->cairo_surface = iface->resize_cairo_surface (private,
1099                                                             private->cairo_surface,
1100                                                             private->width,
1101                                                             private->height);
1102     }
1103   else if (private->cairo_surface)
1104     gdk_window_drop_cairo_surface (private);
1105 }
1106
1107 /* Call this when private has changed in one or more of these ways:
1108  *  size changed
1109  *  window moved
1110  *  new window added
1111  *  stacking order of window changed
1112  *  child deleted
1113  *
1114  * It will recalculate abs_x/y and the clip regions
1115  *
1116  * Unless the window didn't change stacking order or size/pos, pass in TRUE
1117  * for recalculate_siblings. (Mostly used internally for the recursion)
1118  *
1119  * If a child window was removed (and you can't use that child for
1120  * recompute_visible_regions), pass in TRUE for recalculate_children on the parent
1121  */
1122 static void
1123 recompute_visible_regions (GdkWindow *private,
1124                            gboolean recalculate_siblings,
1125                            gboolean recalculate_children)
1126 {
1127   recompute_visible_regions_internal (private,
1128                                       TRUE,
1129                                       recalculate_siblings,
1130                                       recalculate_children);
1131 }
1132
1133 void
1134 _gdk_window_update_size (GdkWindow *window)
1135 {
1136   recompute_visible_regions (window, TRUE, FALSE);
1137 }
1138
1139 /* Find the native window that would be just above "child"
1140  * in the native stacking order if "child" was a native window
1141  * (it doesn't have to be native). If there is no such native
1142  * window inside this native parent then NULL is returned.
1143  * If child is NULL, find lowest native window in parent.
1144  */
1145 static GdkWindow *
1146 find_native_sibling_above_helper (GdkWindow *parent,
1147                                   GdkWindow *child)
1148 {
1149   GdkWindow *w;
1150   GList *l;
1151
1152   if (child)
1153     {
1154       l = g_list_find (parent->children, child);
1155       g_assert (l != NULL); /* Better be a child of its parent... */
1156       l = l->prev; /* Start looking at the one above the child */
1157     }
1158   else
1159     l = g_list_last (parent->children);
1160
1161   for (; l != NULL; l = l->prev)
1162     {
1163       w = l->data;
1164
1165       if (gdk_window_has_impl (w))
1166         return w;
1167
1168       g_assert (parent != w);
1169       w = find_native_sibling_above_helper (w, NULL);
1170       if (w)
1171         return w;
1172     }
1173
1174   return NULL;
1175 }
1176
1177
1178 static GdkWindow *
1179 find_native_sibling_above (GdkWindow *parent,
1180                            GdkWindow *child)
1181 {
1182   GdkWindow *w;
1183
1184   w = find_native_sibling_above_helper (parent, child);
1185   if (w)
1186     return w;
1187
1188   if (gdk_window_has_impl (parent))
1189     return NULL;
1190   else
1191     return find_native_sibling_above (parent->parent, parent);
1192 }
1193
1194 static GdkEventMask
1195 get_native_device_event_mask (GdkWindow *private,
1196                               GdkDevice *device)
1197 {
1198   GdkEventMask event_mask;
1199
1200   if (device)
1201     event_mask = GPOINTER_TO_INT (g_hash_table_lookup (private->device_events, device));
1202   else
1203     event_mask = private->event_mask;
1204
1205   if (private->window_type == GDK_WINDOW_ROOT ||
1206       private->window_type == GDK_WINDOW_FOREIGN)
1207     return event_mask;
1208   else
1209     {
1210       GdkEventMask mask;
1211
1212       /* Do whatever the app asks to, since the app
1213        * may be asking for weird things for native windows,
1214        * but don't use motion hints as that may affect non-native
1215        * child windows that don't want it. Also, we need to
1216        * set all the app-specified masks since they will be picked
1217        * up by any implicit grabs (i.e. if they were not set as
1218        * native we would not get the events we need). */
1219       mask = private->event_mask & ~GDK_POINTER_MOTION_HINT_MASK;
1220
1221       /* We need thse for all native windows so we can
1222          emulate events on children: */
1223       mask |=
1224         GDK_EXPOSURE_MASK |
1225         GDK_VISIBILITY_NOTIFY_MASK |
1226         GDK_ENTER_NOTIFY_MASK | GDK_LEAVE_NOTIFY_MASK;
1227
1228       /* Additionally we select for pointer and button events
1229        * for toplevels as we need to get these to emulate
1230        * them for non-native subwindows. Even though we don't
1231        * select on them for all native windows we will get them
1232        * as the events are propagated out to the first window
1233        * that select for them.
1234        * Not selecting for button press on all windows is an
1235        * important thing, because in X only one client can do
1236        * so, and we don't want to unexpectedly prevent another
1237        * client from doing it.
1238        *
1239        * We also need to do the same if the app selects for button presses
1240        * because then we will get implicit grabs for this window, and the
1241        * event mask used for that grab is based on the rest of the mask
1242        * for the window, but we might need more events than this window
1243        * lists due to some non-native child window.
1244        */
1245       if (gdk_window_is_toplevel (private) ||
1246           mask & GDK_BUTTON_PRESS_MASK)
1247         mask |=
1248           GDK_TOUCH_MASK |
1249           GDK_POINTER_MOTION_MASK |
1250           GDK_BUTTON_PRESS_MASK | GDK_BUTTON_RELEASE_MASK |
1251           GDK_SCROLL_MASK;
1252
1253       return mask;
1254     }
1255 }
1256
1257 static GdkEventMask
1258 get_native_grab_event_mask (GdkEventMask grab_mask)
1259 {
1260   /* Similar to the above but for pointer events only */
1261   return
1262     GDK_POINTER_MOTION_MASK |
1263     GDK_BUTTON_PRESS_MASK | GDK_BUTTON_RELEASE_MASK |
1264     GDK_ENTER_NOTIFY_MASK | GDK_LEAVE_NOTIFY_MASK |
1265     GDK_SCROLL_MASK |
1266     (grab_mask &
1267      ~GDK_POINTER_MOTION_HINT_MASK);
1268 }
1269
1270 static GdkEventMask
1271 get_native_event_mask (GdkWindow *private)
1272 {
1273   return get_native_device_event_mask (private, NULL);
1274 }
1275
1276 /* Puts the native window in the right order wrt the other native windows
1277  * in the hierarchy, given the position it has in the client side data.
1278  * This is useful if some operation changed the stacking order.
1279  * This calls assumes the native window is now topmost in its native parent.
1280  */
1281 static void
1282 sync_native_window_stack_position (GdkWindow *window)
1283 {
1284   GdkWindow *above;
1285   GdkWindowImplClass *impl_class;
1286   GList listhead = {0};
1287
1288   impl_class = GDK_WINDOW_IMPL_GET_CLASS (window->impl);
1289
1290   above = find_native_sibling_above (window->parent, window);
1291   if (above)
1292     {
1293       listhead.data = window;
1294       impl_class->restack_under (above, &listhead);
1295     }
1296 }
1297
1298 /**
1299  * gdk_window_new: (constructor)
1300  * @parent: (allow-none): a #GdkWindow, or %NULL to create the window as a child of
1301  *   the default root window for the default display.
1302  * @attributes: attributes of the new window
1303  * @attributes_mask: mask indicating which fields in @attributes are valid
1304  *
1305  * Creates a new #GdkWindow using the attributes from
1306  * @attributes. See #GdkWindowAttr and #GdkWindowAttributesType for
1307  * more details.  Note: to use this on displays other than the default
1308  * display, @parent must be specified.
1309  *
1310  * Return value: (transfer full): the new #GdkWindow
1311  **/
1312 GdkWindow*
1313 gdk_window_new (GdkWindow     *parent,
1314                 GdkWindowAttr *attributes,
1315                 gint           attributes_mask)
1316 {
1317   GdkWindow *window;
1318   GdkScreen *screen;
1319   GdkDisplay *display;
1320   int x, y;
1321   gboolean native;
1322   GdkEventMask event_mask;
1323   GdkWindow *real_parent;
1324   GdkDeviceManager *device_manager;
1325
1326   g_return_val_if_fail (attributes != NULL, NULL);
1327
1328   if (!parent)
1329     {
1330       GDK_NOTE (MULTIHEAD,
1331                 g_warning ("gdk_window_new(): no parent specified reverting to parent = default root window"));
1332
1333       screen = gdk_screen_get_default ();
1334       parent = gdk_screen_get_root_window (screen);
1335     }
1336   else
1337     screen = gdk_window_get_screen (parent);
1338
1339   g_return_val_if_fail (GDK_IS_WINDOW (parent), NULL);
1340
1341   if (GDK_WINDOW_DESTROYED (parent))
1342     {
1343       g_warning ("gdk_window_new(): parent is destroyed\n");
1344       return NULL;
1345     }
1346
1347   display = gdk_screen_get_display (screen);
1348
1349   window = _gdk_display_create_window (display);
1350
1351   /* Windows with a foreign parent are treated as if they are children
1352    * of the root window, except for actual creation.
1353    */
1354   real_parent = parent;
1355   if (GDK_WINDOW_TYPE (parent) == GDK_WINDOW_FOREIGN)
1356     parent = gdk_screen_get_root_window (screen);
1357
1358   window->parent = parent;
1359
1360   window->accept_focus = TRUE;
1361   window->focus_on_map = TRUE;
1362
1363   if (attributes_mask & GDK_WA_X)
1364     x = attributes->x;
1365   else
1366     x = 0;
1367
1368   if (attributes_mask & GDK_WA_Y)
1369     y = attributes->y;
1370   else
1371     y = 0;
1372
1373   window->x = x;
1374   window->y = y;
1375   window->width = (attributes->width > 1) ? (attributes->width) : (1);
1376   window->height = (attributes->height > 1) ? (attributes->height) : (1);
1377
1378   if (attributes->wclass == GDK_INPUT_ONLY)
1379     {
1380       /* Backwards compatiblity - we've always ignored
1381        * attributes->window_type for input-only windows
1382        * before
1383        */
1384       if (GDK_WINDOW_TYPE (parent) == GDK_WINDOW_ROOT)
1385         window->window_type = GDK_WINDOW_TEMP;
1386       else
1387         window->window_type = GDK_WINDOW_CHILD;
1388     }
1389   else
1390     window->window_type = attributes->window_type;
1391
1392   /* Sanity checks */
1393   switch (window->window_type)
1394     {
1395     case GDK_WINDOW_TOPLEVEL:
1396     case GDK_WINDOW_TEMP:
1397     case GDK_WINDOW_OFFSCREEN:
1398       if (GDK_WINDOW_TYPE (parent) != GDK_WINDOW_ROOT)
1399         g_warning (G_STRLOC "Toplevel windows must be created as children of\n"
1400                    "of a window of type GDK_WINDOW_ROOT or GDK_WINDOW_FOREIGN");
1401     case GDK_WINDOW_CHILD:
1402       break;
1403       break;
1404     default:
1405       g_warning (G_STRLOC "cannot make windows of type %d", window->window_type);
1406       return NULL;
1407     }
1408
1409   if (attributes_mask & GDK_WA_VISUAL)
1410     window->visual = attributes->visual;
1411   else
1412     window->visual = gdk_screen_get_system_visual (screen);
1413
1414   window->event_mask = attributes->event_mask;
1415
1416   if (attributes->wclass == GDK_INPUT_OUTPUT)
1417     {
1418       window->input_only = FALSE;
1419       window->depth = window->visual->depth;
1420
1421       /* XXX: Cache this somehow? */
1422       window->background = cairo_pattern_create_rgba (0, 0, 0, 0);
1423       window->has_alpha_background = TRUE;
1424     }
1425   else
1426     {
1427       window->depth = 0;
1428       window->input_only = TRUE;
1429     }
1430
1431   if (window->parent)
1432     window->parent->children = g_list_prepend (window->parent->children, window);
1433
1434   native = FALSE;
1435   if (window->parent->window_type == GDK_WINDOW_ROOT)
1436     native = TRUE; /* Always use native windows for toplevels */
1437   else if (!window->input_only &&
1438            (attributes_mask & GDK_WA_VISUAL &&
1439             attributes->visual != gdk_window_get_visual (window->parent)))
1440     native = TRUE; /* InputOutput window with different visual than parent, needs native window */
1441
1442   if (gdk_window_is_offscreen (window))
1443     {
1444       _gdk_offscreen_window_new (window, attributes, attributes_mask);
1445       window->impl_window = window;
1446     }
1447   else if (native)
1448     {
1449       event_mask = get_native_event_mask (window);
1450
1451       /* Create the impl */
1452       _gdk_display_create_window_impl (display, window, real_parent, screen, event_mask, attributes, attributes_mask);
1453       window->impl_window = window;
1454
1455       /* This will put the native window topmost in the native parent, which may
1456        * be wrong wrt other native windows in the non-native hierarchy, so restack */
1457       if (!_gdk_window_has_impl (real_parent))
1458         sync_native_window_stack_position (window);
1459     }
1460   else
1461     {
1462       window->impl_window = g_object_ref (window->parent->impl_window);
1463       window->impl = g_object_ref (window->impl_window->impl);
1464     }
1465
1466   recompute_visible_regions (window, TRUE, FALSE);
1467
1468   gdk_window_set_cursor (window, ((attributes_mask & GDK_WA_CURSOR) ?
1469                                   (attributes->cursor) :
1470                                   NULL));
1471
1472   device_manager = gdk_display_get_device_manager (gdk_window_get_display (parent));
1473   g_signal_connect (device_manager, "device-removed",
1474                     G_CALLBACK (device_removed_cb), window);
1475
1476   return window;
1477 }
1478
1479 static gboolean
1480 is_parent_of (GdkWindow *parent,
1481               GdkWindow *child)
1482 {
1483   GdkWindow *w;
1484
1485   w = child;
1486   while (w != NULL)
1487     {
1488       if (w == parent)
1489         return TRUE;
1490
1491       w = gdk_window_get_parent (w);
1492     }
1493
1494   return FALSE;
1495 }
1496
1497 static void
1498 change_impl (GdkWindow *private,
1499              GdkWindow *impl_window,
1500              GdkWindowImpl *new)
1501 {
1502   GList *l;
1503   GdkWindow *child;
1504   GdkWindowImpl *old_impl;
1505   GdkWindow *old_impl_window;
1506
1507   old_impl = private->impl;
1508   old_impl_window = private->impl_window;
1509   if (private != impl_window)
1510     private->impl_window = g_object_ref (impl_window);
1511   else
1512     private->impl_window = private;
1513   private->impl = g_object_ref (new);
1514   if (old_impl_window != private)
1515     g_object_unref (old_impl_window);
1516   g_object_unref (old_impl);
1517
1518   for (l = private->children; l != NULL; l = l->next)
1519     {
1520       child = l->data;
1521
1522       if (child->impl == old_impl)
1523         change_impl (child, impl_window, new);
1524     }
1525 }
1526
1527 static void
1528 reparent_to_impl (GdkWindow *private)
1529 {
1530   GList *l;
1531   GdkWindow *child;
1532   gboolean show;
1533   GdkWindowImplClass *impl_class;
1534
1535   impl_class = GDK_WINDOW_IMPL_GET_CLASS (private->impl);
1536
1537   /* Enumerate in reverse order so we get the right order for the native
1538      windows (first in childrens list is topmost, and reparent places on top) */
1539   for (l = g_list_last (private->children); l != NULL; l = l->prev)
1540     {
1541       child = l->data;
1542
1543       if (child->impl == private->impl)
1544         reparent_to_impl (child);
1545       else
1546         {
1547           show = impl_class->reparent ((GdkWindow *)child,
1548                                        (GdkWindow *)private,
1549                                        child->x, child->y);
1550           if (show)
1551             gdk_window_show_unraised ((GdkWindow *)child);
1552         }
1553     }
1554 }
1555
1556
1557 /**
1558  * gdk_window_reparent:
1559  * @window: a #GdkWindow
1560  * @new_parent: new parent to move @window into
1561  * @x: X location inside the new parent
1562  * @y: Y location inside the new parent
1563  *
1564  * Reparents @window into the given @new_parent. The window being
1565  * reparented will be unmapped as a side effect.
1566  *
1567  **/
1568 void
1569 gdk_window_reparent (GdkWindow *window,
1570                      GdkWindow *new_parent,
1571                      gint       x,
1572                      gint       y)
1573 {
1574   GdkWindow *old_parent;
1575   GdkScreen *screen;
1576   gboolean show, was_mapped, applied_clip_as_shape;
1577   gboolean do_reparent_to_impl;
1578   GdkEventMask old_native_event_mask;
1579   GdkWindowImplClass *impl_class;
1580
1581   g_return_if_fail (GDK_IS_WINDOW (window));
1582   g_return_if_fail (new_parent == NULL || GDK_IS_WINDOW (new_parent));
1583   g_return_if_fail (GDK_WINDOW_TYPE (window) != GDK_WINDOW_ROOT);
1584
1585   if (GDK_WINDOW_DESTROYED (window) ||
1586       (new_parent && GDK_WINDOW_DESTROYED (new_parent)))
1587     return;
1588
1589   screen = gdk_window_get_screen (window);
1590   if (!new_parent)
1591     new_parent = gdk_screen_get_root_window (screen);
1592
1593   /* No input-output children of input-only windows */
1594   if (new_parent->input_only && !window->input_only)
1595     return;
1596
1597   /* Don't create loops in hierarchy */
1598   if (is_parent_of (window, new_parent))
1599     return;
1600
1601   /* This might be wrong in the new parent, e.g. for non-native surfaces.
1602      To make sure we're ok, just wipe it. */
1603   gdk_window_drop_cairo_surface (window);
1604
1605   impl_class = GDK_WINDOW_IMPL_GET_CLASS (window->impl);
1606   old_parent = window->parent;
1607
1608   was_mapped = GDK_WINDOW_IS_MAPPED (window);
1609   show = FALSE;
1610
1611   /* Reparenting to toplevel. Ensure we have a native window so this can work */
1612   if (new_parent->window_type == GDK_WINDOW_ROOT ||
1613       new_parent->window_type == GDK_WINDOW_FOREIGN)
1614     gdk_window_ensure_native (window);
1615
1616   applied_clip_as_shape = should_apply_clip_as_shape (window);
1617
1618   old_native_event_mask = 0;
1619   do_reparent_to_impl = FALSE;
1620   if (gdk_window_has_impl (window))
1621     {
1622       old_native_event_mask = get_native_event_mask (window);
1623       /* Native window */
1624       show = impl_class->reparent (window, new_parent, x, y);
1625     }
1626   else
1627     {
1628       /* This shouldn't happen, as we created a native in this case, check anyway to see if that ever fails */
1629       g_assert (new_parent->window_type != GDK_WINDOW_ROOT &&
1630                 new_parent->window_type != GDK_WINDOW_FOREIGN);
1631
1632       show = was_mapped;
1633       gdk_window_hide (window);
1634
1635       do_reparent_to_impl = TRUE;
1636       change_impl (window,
1637                    new_parent->impl_window,
1638                    new_parent->impl);
1639     }
1640
1641   /* From here on, we treat parents of type GDK_WINDOW_FOREIGN like
1642    * the root window
1643    */
1644   if (GDK_WINDOW_TYPE (new_parent) == GDK_WINDOW_FOREIGN)
1645     {
1646       new_parent = gdk_screen_get_root_window (screen);
1647     }
1648
1649   if (old_parent)
1650     old_parent->children = g_list_remove (old_parent->children, window);
1651
1652   window->parent = new_parent;
1653   window->x = x;
1654   window->y = y;
1655
1656   new_parent->children = g_list_prepend (new_parent->children, window);
1657
1658   /* Switch the window type as appropriate */
1659
1660   switch (GDK_WINDOW_TYPE (new_parent))
1661     {
1662     case GDK_WINDOW_ROOT:
1663     case GDK_WINDOW_FOREIGN:
1664       if (window->toplevel_window_type != -1)
1665         GDK_WINDOW_TYPE (window) = window->toplevel_window_type;
1666       else if (GDK_WINDOW_TYPE (window) == GDK_WINDOW_CHILD)
1667         GDK_WINDOW_TYPE (window) = GDK_WINDOW_TOPLEVEL;
1668       break;
1669     case GDK_WINDOW_OFFSCREEN:
1670     case GDK_WINDOW_TOPLEVEL:
1671     case GDK_WINDOW_CHILD:
1672     case GDK_WINDOW_TEMP:
1673       if (GDK_WINDOW_TYPE (window) != GDK_WINDOW_CHILD && \
1674           GDK_WINDOW_TYPE (window) != GDK_WINDOW_FOREIGN)
1675         {
1676           /* Save the original window type so we can restore it if the
1677            * window is reparented back to be a toplevel
1678            */
1679           window->toplevel_window_type = GDK_WINDOW_TYPE (window);
1680           GDK_WINDOW_TYPE (window) = GDK_WINDOW_CHILD;
1681         }
1682     }
1683
1684   /* We might have changed window type for a native windows, so we
1685      need to change the event mask too. */
1686   if (gdk_window_has_impl (window))
1687     {
1688       GdkEventMask native_event_mask = get_native_event_mask (window);
1689
1690       if (native_event_mask != old_native_event_mask)
1691         impl_class->set_events (window, native_event_mask);
1692     }
1693
1694   _gdk_window_update_viewable (window);
1695
1696   if (window->background == NULL)
1697     {
1698       /* parent relative background, update has_alpha_background */
1699       if (window->parent == NULL ||
1700           window->parent->window_type == GDK_WINDOW_ROOT)
1701         window->has_alpha_background = FALSE;
1702       else
1703         window->has_alpha_background = window->parent->has_alpha_background;
1704     }
1705
1706   recompute_visible_regions (window, TRUE, FALSE);
1707   if (old_parent && GDK_WINDOW_TYPE (old_parent) != GDK_WINDOW_ROOT)
1708     recompute_visible_regions (old_parent, FALSE, TRUE);
1709
1710   _gdk_window_propagate_has_alpha_background (window);
1711
1712   /* We used to apply the clip as the shape, but no more.
1713      Reset this to the real shape */
1714   if (gdk_window_has_impl (window) &&
1715       applied_clip_as_shape &&
1716       !should_apply_clip_as_shape (window))
1717     apply_shape (window, window->shape);
1718
1719   if (do_reparent_to_impl)
1720     reparent_to_impl (window);
1721   else
1722     {
1723       /* The reparent will have put the native window topmost in the native parent,
1724        * which may be wrong wrt other native windows in the non-native hierarchy,
1725        * so restack */
1726       if (!gdk_window_has_impl (new_parent))
1727         sync_native_window_stack_position (window);
1728     }
1729
1730   if (show)
1731     gdk_window_show_unraised (window);
1732   else
1733     _gdk_synthesize_crossing_events_for_geometry_change (window);
1734 }
1735
1736 /**
1737  * gdk_window_ensure_native:
1738  * @window: a #GdkWindow
1739  *
1740  * Tries to ensure that there is a window-system native window for this
1741  * GdkWindow. This may fail in some situations, returning %FALSE.
1742  *
1743  * Offscreen window and children of them can never have native windows.
1744  *
1745  * Some backends may not support native child windows.
1746  *
1747  * Returns: %TRUE if the window has a native window, %FALSE otherwise
1748  *
1749  * Since: 2.18
1750  */
1751 gboolean
1752 gdk_window_ensure_native (GdkWindow *window)
1753 {
1754   GdkWindow *impl_window;
1755   GdkWindowImpl *new_impl, *old_impl;
1756   GdkDisplay *display;
1757   GdkScreen *screen;
1758   GdkWindow *above;
1759   GList listhead;
1760   GdkWindowImplClass *impl_class;
1761
1762   g_return_val_if_fail (GDK_IS_WINDOW (window), FALSE);
1763
1764   if (GDK_WINDOW_TYPE (window) == GDK_WINDOW_ROOT ||
1765       GDK_WINDOW_DESTROYED (window))
1766     return FALSE;
1767
1768   impl_window = gdk_window_get_impl_window (window);
1769
1770   if (gdk_window_is_offscreen (impl_window))
1771     return FALSE; /* native in offscreens not supported */
1772
1773   if (impl_window == window)
1774     /* Already has an impl, and its not offscreen . */
1775     return TRUE;
1776
1777   /* Need to create a native window */
1778
1779   gdk_window_drop_cairo_surface (window);
1780
1781   screen = gdk_window_get_screen (window);
1782   display = gdk_screen_get_display (screen);
1783
1784   old_impl = window->impl;
1785   _gdk_display_create_window_impl (display,
1786                                    window, window->parent,
1787                                    screen,
1788                                    get_native_event_mask (window),
1789                                    NULL, 0);
1790   new_impl = window->impl;
1791
1792   window->impl = old_impl;
1793   change_impl (window, window, new_impl);
1794
1795   impl_class = GDK_WINDOW_IMPL_GET_CLASS (window->impl);
1796
1797   /* Native window creation will put the native window topmost in the
1798    * native parent, which may be wrong wrt the position of the previous
1799    * non-native window wrt to the other non-native children, so correct this.
1800    */
1801   above = find_native_sibling_above (window->parent, window);
1802   if (above)
1803     {
1804       listhead.data = window;
1805       listhead.prev = NULL;
1806       listhead.next = NULL;
1807       impl_class->restack_under ((GdkWindow *)above, &listhead);
1808     }
1809
1810   recompute_visible_regions (window, FALSE, FALSE);
1811
1812   /* The shape may not have been set, as the clip region doesn't actually
1813      change, so do it here manually */
1814   if (should_apply_clip_as_shape (window))
1815     apply_clip_as_shape (window);
1816
1817   reparent_to_impl (window);
1818
1819   if (!window->input_only)
1820     impl_class->set_background (window, window->background);
1821
1822   impl_class->input_shape_combine_region (window,
1823                                           window->input_shape,
1824                                           0, 0);
1825
1826   if (gdk_window_is_viewable (window))
1827     impl_class->show (window, FALSE);
1828
1829   return TRUE;
1830 }
1831
1832 /**
1833  * _gdk_event_filter_unref:
1834  * @window: (allow-none): A #GdkWindow, or %NULL to be the global window
1835  * @filter: A window filter
1836  *
1837  * Release a reference to @filter.  Note this function may
1838  * mutate the list storage, so you need to handle this
1839  * if iterating over a list of filters.
1840  */
1841 void
1842 _gdk_event_filter_unref (GdkWindow       *window,
1843                          GdkEventFilter  *filter)
1844 {
1845   GList **filters;
1846   GList *tmp_list;
1847
1848   if (window == NULL)
1849     filters = &_gdk_default_filters;
1850   else
1851     filters = &window->filters;
1852
1853   tmp_list = *filters;
1854   while (tmp_list)
1855     {
1856       GdkEventFilter *iter_filter = tmp_list->data;
1857       GList *node;
1858
1859       node = tmp_list;
1860       tmp_list = tmp_list->next;
1861
1862       if (iter_filter != filter)
1863         continue;
1864
1865       g_assert (iter_filter->ref_count > 0);
1866
1867       filter->ref_count--;
1868       if (filter->ref_count != 0)
1869         continue;
1870
1871       *filters = g_list_remove_link (*filters, node);
1872       g_free (filter);
1873       g_list_free_1 (node);
1874     }
1875 }
1876
1877 static void
1878 window_remove_filters (GdkWindow *window)
1879 {
1880   while (window->filters)
1881     _gdk_event_filter_unref (window, window->filters->data);
1882 }
1883
1884 static void
1885 update_pointer_info_foreach (GdkDisplay           *display,
1886                              GdkDevice            *device,
1887                              GdkPointerWindowInfo *pointer_info,
1888                              gpointer              user_data)
1889 {
1890   GdkWindow *window = user_data;
1891
1892   if (pointer_info->toplevel_under_pointer == window)
1893     {
1894       g_object_unref (pointer_info->toplevel_under_pointer);
1895       pointer_info->toplevel_under_pointer = NULL;
1896     }
1897 }
1898
1899 static void
1900 window_remove_from_pointer_info (GdkWindow  *window,
1901                                  GdkDisplay *display)
1902 {
1903   _gdk_display_pointer_info_foreach (display,
1904                                      update_pointer_info_foreach,
1905                                      window);
1906 }
1907
1908 /**
1909  * _gdk_window_destroy_hierarchy:
1910  * @window: a #GdkWindow
1911  * @recursing: If TRUE, then this is being called because a parent
1912  *            was destroyed.
1913  * @recursing_native: If TRUE, then this is being called because a native parent
1914  *            was destroyed. This generally means that the call to the
1915  *            windowing system to destroy the window can be omitted, since
1916  *            it will be destroyed as a result of the parent being destroyed.
1917  *            Unless @foreign_destroy.
1918  * @foreign_destroy: If TRUE, the window or a parent was destroyed by some
1919  *            external agency. The window has already been destroyed and no
1920  *            windowing system calls should be made. (This may never happen
1921  *            for some windowing systems.)
1922  *
1923  * Internal function to destroy a window. Like gdk_window_destroy(),
1924  * but does not drop the reference count created by gdk_window_new().
1925  **/
1926 static void
1927 _gdk_window_destroy_hierarchy (GdkWindow *window,
1928                                gboolean   recursing,
1929                                gboolean   recursing_native,
1930                                gboolean   foreign_destroy)
1931 {
1932   GdkWindowImplClass *impl_class;
1933   GdkWindow *temp_window;
1934   GdkScreen *screen;
1935   GdkDisplay *display;
1936   GList *children;
1937   GList *tmp;
1938
1939   g_return_if_fail (GDK_IS_WINDOW (window));
1940
1941   if (GDK_WINDOW_DESTROYED (window))
1942     return;
1943
1944   display = gdk_window_get_display (window);
1945   screen = gdk_window_get_screen (window);
1946   temp_window = g_object_get_qdata (G_OBJECT (screen), quark_pointer_window);
1947   if (temp_window == window)
1948     g_object_set_qdata (G_OBJECT (screen), quark_pointer_window, NULL);
1949
1950
1951   switch (window->window_type)
1952     {
1953     case GDK_WINDOW_ROOT:
1954       if (!screen->closed)
1955         {
1956           g_error ("attempted to destroy root window");
1957           break;
1958         }
1959       /* else fall thru */
1960     case GDK_WINDOW_TOPLEVEL:
1961     case GDK_WINDOW_CHILD:
1962     case GDK_WINDOW_TEMP:
1963     case GDK_WINDOW_FOREIGN:
1964     case GDK_WINDOW_OFFSCREEN:
1965       if (window->window_type == GDK_WINDOW_FOREIGN && !foreign_destroy)
1966         {
1967           /* Logically, it probably makes more sense to send
1968            * a "destroy yourself" message to the foreign window
1969            * whether or not it's in our hierarchy; but for historical
1970            * reasons, we only send "destroy yourself" messages to
1971            * foreign windows in our hierarchy.
1972            */
1973           if (window->parent)
1974             {
1975               impl_class = GDK_WINDOW_IMPL_GET_CLASS (window->impl);
1976
1977               if (gdk_window_has_impl (window))
1978                 impl_class->destroy_foreign (window);
1979             }
1980
1981           /* Also for historical reasons, we remove any filters
1982            * on a foreign window when it or a parent is destroyed;
1983            * this likely causes problems if two separate portions
1984            * of code are maintaining filter lists on a foreign window.
1985            */
1986           window_remove_filters (window);
1987         }
1988       else
1989         {
1990           if (window->parent)
1991             {
1992               if (window->parent->children)
1993                 window->parent->children = g_list_remove (window->parent->children, window);
1994
1995               if (!recursing &&
1996                   GDK_WINDOW_IS_MAPPED (window))
1997                 {
1998                   recompute_visible_regions (window, TRUE, FALSE);
1999                   gdk_window_invalidate_in_parent (window);
2000                 }
2001             }
2002
2003           gdk_window_free_paint_stack (window);
2004
2005           if (window->background)
2006             {
2007               cairo_pattern_destroy (window->background);
2008               window->background = NULL;
2009             }
2010
2011           if (window->window_type == GDK_WINDOW_FOREIGN)
2012             g_assert (window->children == NULL);
2013           else
2014             {
2015               children = tmp = window->children;
2016               window->children = NULL;
2017
2018               while (tmp)
2019                 {
2020                   temp_window = tmp->data;
2021                   tmp = tmp->next;
2022
2023                   if (temp_window)
2024                     _gdk_window_destroy_hierarchy (temp_window,
2025                                                    TRUE,
2026                                                    recursing_native || gdk_window_has_impl (window),
2027                                                    foreign_destroy);
2028                 }
2029
2030               g_list_free (children);
2031             }
2032
2033           _gdk_window_clear_update_area (window);
2034
2035           gdk_window_drop_cairo_surface (window);
2036
2037           impl_class = GDK_WINDOW_IMPL_GET_CLASS (window->impl);
2038
2039           if (gdk_window_has_impl (window))
2040             impl_class->destroy (window, recursing_native,
2041                                  foreign_destroy);
2042           else
2043             {
2044               /* hide to make sure we repaint and break grabs */
2045               gdk_window_hide (window);
2046             }
2047
2048           window->state |= GDK_WINDOW_STATE_WITHDRAWN;
2049           window->parent = NULL;
2050           window->destroyed = TRUE;
2051
2052           window_remove_filters (window);
2053
2054           window_remove_from_pointer_info (window, display);
2055
2056           if (window->clip_region)
2057             {
2058               cairo_region_destroy (window->clip_region);
2059               window->clip_region = NULL;
2060             }
2061
2062           if (window->clip_region_with_children)
2063             {
2064               cairo_region_destroy (window->clip_region_with_children);
2065               window->clip_region_with_children = NULL;
2066             }
2067
2068           g_list_free_full (window->outstanding_moves, (GDestroyNotify) gdk_window_region_move_free);
2069           window->outstanding_moves = NULL;
2070         }
2071       break;
2072     }
2073 }
2074
2075 /**
2076  * _gdk_window_destroy:
2077  * @window: a #GdkWindow
2078  * @foreign_destroy: If TRUE, the window or a parent was destroyed by some
2079  *            external agency. The window has already been destroyed and no
2080  *            windowing system calls should be made. (This may never happen
2081  *            for some windowing systems.)
2082  *
2083  * Internal function to destroy a window. Like gdk_window_destroy(),
2084  * but does not drop the reference count created by gdk_window_new().
2085  **/
2086 void
2087 _gdk_window_destroy (GdkWindow *window,
2088                      gboolean   foreign_destroy)
2089 {
2090   _gdk_window_destroy_hierarchy (window, FALSE, FALSE, foreign_destroy);
2091 }
2092
2093 /**
2094  * gdk_window_destroy:
2095  * @window: a #GdkWindow
2096  *
2097  * Destroys the window system resources associated with @window and decrements @window's
2098  * reference count. The window system resources for all children of @window are also
2099  * destroyed, but the children's reference counts are not decremented.
2100  *
2101  * Note that a window will not be destroyed automatically when its reference count
2102  * reaches zero. You must call this function yourself before that happens.
2103  *
2104  **/
2105 void
2106 gdk_window_destroy (GdkWindow *window)
2107 {
2108   _gdk_window_destroy_hierarchy (window, FALSE, FALSE, FALSE);
2109   g_object_unref (window);
2110 }
2111
2112 /**
2113  * gdk_window_set_user_data:
2114  * @window: a #GdkWindow
2115  * @user_data: (allow-none) (type GObject.Object): user data
2116  *
2117  * For most purposes this function is deprecated in favor of
2118  * g_object_set_data(). However, for historical reasons GTK+ stores
2119  * the #GtkWidget that owns a #GdkWindow as user data on the
2120  * #GdkWindow. So, custom widget implementations should use
2121  * this function for that. If GTK+ receives an event for a #GdkWindow,
2122  * and the user data for the window is non-%NULL, GTK+ will assume the
2123  * user data is a #GtkWidget, and forward the event to that widget.
2124  *
2125  **/
2126 void
2127 gdk_window_set_user_data (GdkWindow *window,
2128                           gpointer   user_data)
2129 {
2130   g_return_if_fail (GDK_IS_WINDOW (window));
2131
2132   window->user_data = user_data;
2133 }
2134
2135 /**
2136  * gdk_window_get_user_data:
2137  * @window: a #GdkWindow
2138  * @data: (out): return location for user data
2139  *
2140  * Retrieves the user data for @window, which is normally the widget
2141  * that @window belongs to. See gdk_window_set_user_data().
2142  *
2143  **/
2144 void
2145 gdk_window_get_user_data (GdkWindow *window,
2146                           gpointer  *data)
2147 {
2148   g_return_if_fail (GDK_IS_WINDOW (window));
2149
2150   *data = window->user_data;
2151 }
2152
2153 /**
2154  * gdk_window_get_window_type:
2155  * @window: a #GdkWindow
2156  *
2157  * Gets the type of the window. See #GdkWindowType.
2158  *
2159  * Return value: type of window
2160  **/
2161 GdkWindowType
2162 gdk_window_get_window_type (GdkWindow *window)
2163 {
2164   g_return_val_if_fail (GDK_IS_WINDOW (window), (GdkWindowType) -1);
2165
2166   return GDK_WINDOW_TYPE (window);
2167 }
2168
2169 /**
2170  * gdk_window_get_visual:
2171  * @window: a #GdkWindow
2172  * 
2173  * Gets the #GdkVisual describing the pixel format of @window.
2174  * 
2175  * Return value: (transfer none): a #GdkVisual
2176  *
2177  * Since: 2.24
2178  **/
2179 GdkVisual*
2180 gdk_window_get_visual (GdkWindow *window)
2181 {
2182   g_return_val_if_fail (GDK_IS_WINDOW (window), NULL);
2183   
2184   return window->visual;
2185 }
2186
2187 /**
2188  * gdk_window_get_screen:
2189  * @window: a #GdkWindow
2190  * 
2191  * Gets the #GdkScreen associated with a #GdkWindow.
2192  * 
2193  * Return value: (transfer none): the #GdkScreen associated with @window
2194  *
2195  * Since: 2.24
2196  **/
2197 GdkScreen*
2198 gdk_window_get_screen (GdkWindow *window)
2199 {
2200   g_return_val_if_fail (GDK_IS_WINDOW (window), NULL);
2201
2202   return gdk_visual_get_screen (window->visual);
2203 }
2204
2205 /**
2206  * gdk_window_get_display:
2207  * @window: a #GdkWindow
2208  * 
2209  * Gets the #GdkDisplay associated with a #GdkWindow.
2210  * 
2211  * Return value: (transfer none): the #GdkDisplay associated with @window
2212  *
2213  * Since: 2.24
2214  **/
2215 GdkDisplay *
2216 gdk_window_get_display (GdkWindow *window)
2217 {
2218   g_return_val_if_fail (GDK_IS_WINDOW (window), NULL);
2219
2220   return gdk_screen_get_display (gdk_visual_get_screen (window->visual));
2221 }
2222 /**
2223  * gdk_window_is_destroyed:
2224  * @window: a #GdkWindow
2225  *
2226  * Check to see if a window is destroyed..
2227  *
2228  * Return value: %TRUE if the window is destroyed
2229  *
2230  * Since: 2.18
2231  **/
2232 gboolean
2233 gdk_window_is_destroyed (GdkWindow *window)
2234 {
2235   return GDK_WINDOW_DESTROYED (window);
2236 }
2237
2238 static void
2239 to_embedder (GdkWindow *window,
2240              gdouble    offscreen_x,
2241              gdouble    offscreen_y,
2242              gdouble   *embedder_x,
2243              gdouble   *embedder_y)
2244 {
2245   g_signal_emit (window, signals[TO_EMBEDDER], 0,
2246                  offscreen_x, offscreen_y,
2247                  embedder_x, embedder_y);
2248 }
2249
2250 static void
2251 from_embedder (GdkWindow *window,
2252                gdouble    embedder_x,
2253                gdouble    embedder_y,
2254                gdouble   *offscreen_x,
2255                gdouble   *offscreen_y)
2256 {
2257   g_signal_emit (window, signals[FROM_EMBEDDER], 0,
2258                  embedder_x, embedder_y,
2259                  offscreen_x, offscreen_y);
2260 }
2261
2262 /**
2263  * gdk_window_has_native:
2264  * @window: a #GdkWindow
2265  *
2266  * Checks whether the window has a native window or not. Note that
2267  * you can use gdk_window_ensure_native() if a native window is needed.
2268  *
2269  * Returns: %TRUE if the %window has a native window, %FALSE otherwise.
2270  *
2271  * Since: 2.22
2272  */
2273 gboolean
2274 gdk_window_has_native (GdkWindow *window)
2275 {
2276   g_return_val_if_fail (GDK_IS_WINDOW (window), FALSE);
2277
2278   return window->parent == NULL || window->parent->impl != window->impl;
2279 }
2280
2281 /**
2282  * gdk_window_get_position:
2283  * @window: a #GdkWindow
2284  * @x: (out) (allow-none): X coordinate of window
2285  * @y: (out) (allow-none): Y coordinate of window
2286  *
2287  * Obtains the position of the window as reported in the
2288  * most-recently-processed #GdkEventConfigure. Contrast with
2289  * gdk_window_get_geometry() which queries the X server for the
2290  * current window position, regardless of which events have been
2291  * received or processed.
2292  *
2293  * The position coordinates are relative to the window's parent window.
2294  *
2295  **/
2296 void
2297 gdk_window_get_position (GdkWindow *window,
2298                          gint      *x,
2299                          gint      *y)
2300 {
2301   g_return_if_fail (GDK_IS_WINDOW (window));
2302
2303   if (x)
2304     *x = window->x;
2305   if (y)
2306     *y = window->y;
2307 }
2308
2309 /**
2310  * gdk_window_get_parent:
2311  * @window: a #GdkWindow
2312  *
2313  * Obtains the parent of @window, as known to GDK. Does not query the
2314  * X server; thus this returns the parent as passed to gdk_window_new(),
2315  * not the actual parent. This should never matter unless you're using
2316  * Xlib calls mixed with GDK calls on the X11 platform. It may also
2317  * matter for toplevel windows, because the window manager may choose
2318  * to reparent them.
2319  *
2320  * Note that you should use gdk_window_get_effective_parent() when
2321  * writing generic code that walks up a window hierarchy, because
2322  * gdk_window_get_parent() will most likely not do what you expect if
2323  * there are offscreen windows in the hierarchy.
2324  *
2325  * Return value: (transfer none): parent of @window
2326  **/
2327 GdkWindow*
2328 gdk_window_get_parent (GdkWindow *window)
2329 {
2330   g_return_val_if_fail (GDK_IS_WINDOW (window), NULL);
2331
2332   return window->parent;
2333 }
2334
2335 /**
2336  * gdk_window_get_effective_parent:
2337  * @window: a #GdkWindow
2338  *
2339  * Obtains the parent of @window, as known to GDK. Works like
2340  * gdk_window_get_parent() for normal windows, but returns the
2341  * window's embedder for offscreen windows.
2342  *
2343  * See also: gdk_offscreen_window_get_embedder()
2344  *
2345  * Return value: (transfer none): effective parent of @window
2346  *
2347  * Since: 2.22
2348  **/
2349 GdkWindow *
2350 gdk_window_get_effective_parent (GdkWindow *window)
2351 {
2352   g_return_val_if_fail (GDK_IS_WINDOW (window), NULL);
2353
2354   if (gdk_window_is_offscreen (window))
2355     return gdk_offscreen_window_get_embedder (window);
2356   else
2357     return window->parent;
2358 }
2359
2360 /**
2361  * gdk_window_get_toplevel:
2362  * @window: a #GdkWindow
2363  *
2364  * Gets the toplevel window that's an ancestor of @window.
2365  *
2366  * Any window type but %GDK_WINDOW_CHILD is considered a
2367  * toplevel window, as is a %GDK_WINDOW_CHILD window that
2368  * has a root window as parent.
2369  *
2370  * Note that you should use gdk_window_get_effective_toplevel() when
2371  * you want to get to a window's toplevel as seen on screen, because
2372  * gdk_window_get_toplevel() will most likely not do what you expect
2373  * if there are offscreen windows in the hierarchy.
2374  *
2375  * Return value: (transfer none): the toplevel window containing @window
2376  **/
2377 GdkWindow *
2378 gdk_window_get_toplevel (GdkWindow *window)
2379 {
2380   g_return_val_if_fail (GDK_IS_WINDOW (window), NULL);
2381
2382   while (window->window_type == GDK_WINDOW_CHILD)
2383     {
2384       if (gdk_window_is_toplevel (window))
2385         break;
2386       window = window->parent;
2387     }
2388
2389   return window;
2390 }
2391
2392 /**
2393  * gdk_window_get_effective_toplevel:
2394  * @window: a #GdkWindow
2395  *
2396  * Gets the toplevel window that's an ancestor of @window.
2397  *
2398  * Works like gdk_window_get_toplevel(), but treats an offscreen window's
2399  * embedder as its parent, using gdk_window_get_effective_parent().
2400  *
2401  * See also: gdk_offscreen_window_get_embedder()
2402  *
2403  * Return value: (transfer none): the effective toplevel window containing @window
2404  *
2405  * Since: 2.22
2406  **/
2407 GdkWindow *
2408 gdk_window_get_effective_toplevel (GdkWindow *window)
2409 {
2410   GdkWindow *parent;
2411
2412   g_return_val_if_fail (GDK_IS_WINDOW (window), NULL);
2413
2414   while ((parent = gdk_window_get_effective_parent (window)) != NULL &&
2415          (gdk_window_get_window_type (parent) != GDK_WINDOW_ROOT))
2416     window = parent;
2417
2418   return window;
2419 }
2420
2421 /**
2422  * gdk_window_get_children:
2423  * @window: a #GdkWindow
2424  *
2425  * Gets the list of children of @window known to GDK.
2426  * This function only returns children created via GDK,
2427  * so for example it's useless when used with the root window;
2428  * it only returns windows an application created itself.
2429  *
2430  * The returned list must be freed, but the elements in the
2431  * list need not be.
2432  *
2433  * Return value: (transfer container) (element-type GdkWindow):
2434  *     list of child windows inside @window
2435  **/
2436 GList*
2437 gdk_window_get_children (GdkWindow *window)
2438 {
2439   g_return_val_if_fail (GDK_IS_WINDOW (window), NULL);
2440
2441   if (GDK_WINDOW_DESTROYED (window))
2442     return NULL;
2443
2444   return g_list_copy (window->children);
2445 }
2446
2447 /**
2448  * gdk_window_peek_children:
2449  * @window: a #GdkWindow
2450  *
2451  * Like gdk_window_get_children(), but does not copy the list of
2452  * children, so the list does not need to be freed.
2453  *
2454  * Return value: (transfer none) (element-type GdkWindow):
2455  *     a reference to the list of child windows in @window
2456  **/
2457 GList *
2458 gdk_window_peek_children (GdkWindow *window)
2459 {
2460   g_return_val_if_fail (GDK_IS_WINDOW (window), NULL);
2461
2462   if (GDK_WINDOW_DESTROYED (window))
2463     return NULL;
2464
2465   return window->children;
2466 }
2467
2468 /**
2469  * gdk_window_add_filter: (skip)
2470  * @window: (allow-none): a #GdkWindow
2471  * @function: filter callback
2472  * @data: data to pass to filter callback
2473  *
2474  * Adds an event filter to @window, allowing you to intercept events
2475  * before they reach GDK. This is a low-level operation and makes it
2476  * easy to break GDK and/or GTK+, so you have to know what you're
2477  * doing. Pass %NULL for @window to get all events for all windows,
2478  * instead of events for a specific window.
2479  *
2480  * If you are interested in X GenericEvents, bear in mind that
2481  * XGetEventData() has been already called on the event, and
2482  * XFreeEventData() must not be called within @function.
2483  **/
2484 void
2485 gdk_window_add_filter (GdkWindow     *window,
2486                        GdkFilterFunc  function,
2487                        gpointer       data)
2488 {
2489   GList *tmp_list;
2490   GdkEventFilter *filter;
2491
2492   g_return_if_fail (window == NULL || GDK_IS_WINDOW (window));
2493
2494   if (window && GDK_WINDOW_DESTROYED (window))
2495     return;
2496
2497   /* Filters are for the native events on the native window, so
2498      ensure there is a native window. */
2499   if (window)
2500     gdk_window_ensure_native (window);
2501
2502   if (window)
2503     tmp_list = window->filters;
2504   else
2505     tmp_list = _gdk_default_filters;
2506
2507   while (tmp_list)
2508     {
2509       filter = (GdkEventFilter *)tmp_list->data;
2510       if ((filter->function == function) && (filter->data == data))
2511         {
2512           filter->ref_count++;
2513           return;
2514         }
2515       tmp_list = tmp_list->next;
2516     }
2517
2518   filter = g_new (GdkEventFilter, 1);
2519   filter->function = function;
2520   filter->data = data;
2521   filter->ref_count = 1;
2522   filter->flags = 0;
2523
2524   if (window)
2525     window->filters = g_list_append (window->filters, filter);
2526   else
2527     _gdk_default_filters = g_list_append (_gdk_default_filters, filter);
2528 }
2529
2530 /**
2531  * gdk_window_remove_filter: (skip)
2532  * @window: a #GdkWindow
2533  * @function: previously-added filter function
2534  * @data: user data for previously-added filter function
2535  *
2536  * Remove a filter previously added with gdk_window_add_filter().
2537  */
2538 void
2539 gdk_window_remove_filter (GdkWindow     *window,
2540                           GdkFilterFunc  function,
2541                           gpointer       data)
2542 {
2543   GList *tmp_list;
2544   GdkEventFilter *filter;
2545
2546   g_return_if_fail (window == NULL || GDK_IS_WINDOW (window));
2547
2548   if (window)
2549     tmp_list = window->filters;
2550   else
2551     tmp_list = _gdk_default_filters;
2552
2553   while (tmp_list)
2554     {
2555       filter = (GdkEventFilter *)tmp_list->data;
2556       tmp_list = tmp_list->next;
2557
2558       if ((filter->function == function) && (filter->data == data))
2559         {
2560           filter->flags |= GDK_EVENT_FILTER_REMOVED;
2561
2562           _gdk_event_filter_unref (window, filter);
2563
2564           return;
2565         }
2566     }
2567 }
2568
2569 /**
2570  * gdk_screen_get_toplevel_windows:
2571  * @screen: The #GdkScreen where the toplevels are located.
2572  *
2573  * Obtains a list of all toplevel windows known to GDK on the screen @screen.
2574  * A toplevel window is a child of the root window (see
2575  * gdk_get_default_root_window()).
2576  *
2577  * The returned list should be freed with g_list_free(), but
2578  * its elements need not be freed.
2579  *
2580  * Return value: (transfer container) (element-type GdkWindow):
2581  *     list of toplevel windows, free with g_list_free()
2582  *
2583  * Since: 2.2
2584  **/
2585 GList *
2586 gdk_screen_get_toplevel_windows (GdkScreen *screen)
2587 {
2588   GdkWindow * root_window;
2589   GList *new_list = NULL;
2590   GList *tmp_list;
2591
2592   g_return_val_if_fail (GDK_IS_SCREEN (screen), NULL);
2593
2594   root_window = gdk_screen_get_root_window (screen);
2595
2596   tmp_list = root_window->children;
2597   while (tmp_list)
2598     {
2599       GdkWindow *w = tmp_list->data;
2600
2601       if (w->window_type != GDK_WINDOW_FOREIGN)
2602         new_list = g_list_prepend (new_list, w);
2603       tmp_list = tmp_list->next;
2604     }
2605
2606   return new_list;
2607 }
2608
2609 /**
2610  * gdk_window_is_visible:
2611  * @window: a #GdkWindow
2612  *
2613  * Checks whether the window has been mapped (with gdk_window_show() or
2614  * gdk_window_show_unraised()).
2615  *
2616  * Return value: %TRUE if the window is mapped
2617  **/
2618 gboolean
2619 gdk_window_is_visible (GdkWindow *window)
2620 {
2621   g_return_val_if_fail (GDK_IS_WINDOW (window), FALSE);
2622
2623   return GDK_WINDOW_IS_MAPPED (window);
2624 }
2625
2626 /**
2627  * gdk_window_is_viewable:
2628  * @window: a #GdkWindow
2629  *
2630  * Check if the window and all ancestors of the window are
2631  * mapped. (This is not necessarily "viewable" in the X sense, since
2632  * we only check as far as we have GDK window parents, not to the root
2633  * window.)
2634  *
2635  * Return value: %TRUE if the window is viewable
2636  **/
2637 gboolean
2638 gdk_window_is_viewable (GdkWindow *window)
2639 {
2640   g_return_val_if_fail (GDK_IS_WINDOW (window), FALSE);
2641
2642   if (window->destroyed)
2643     return FALSE;
2644
2645   return window->viewable;
2646 }
2647
2648 /**
2649  * gdk_window_get_state:
2650  * @window: a #GdkWindow
2651  *
2652  * Gets the bitwise OR of the currently active window state flags,
2653  * from the #GdkWindowState enumeration.
2654  *
2655  * Return value: window state bitfield
2656  **/
2657 GdkWindowState
2658 gdk_window_get_state (GdkWindow *window)
2659 {
2660   g_return_val_if_fail (GDK_IS_WINDOW (window), FALSE);
2661
2662   return window->state;
2663 }
2664
2665 static cairo_content_t
2666 gdk_window_get_content (GdkWindow *window)
2667 {
2668   cairo_surface_t *surface;
2669   cairo_content_t content;
2670
2671   g_return_val_if_fail (GDK_IS_WINDOW (window), 0);
2672
2673   surface = _gdk_window_ref_cairo_surface (window);
2674   content = cairo_surface_get_content (surface);
2675   cairo_surface_destroy (surface);
2676
2677   return content;
2678 }
2679
2680 /* This creates an empty "implicit" paint region for the impl window.
2681  * By itself this does nothing, but real paints to this window
2682  * or children of it can use this surface as backing to avoid allocating
2683  * multiple surfaces for subwindow rendering. When doing so they
2684  * add to the region of the implicit paint region, which will be
2685  * pushed to the window when the implicit paint region is ended.
2686  * Such paints should not copy anything to the window on paint end, but
2687  * should rely on the implicit paint end.
2688  * The implicit paint will be automatically ended if someone draws
2689  * directly to the window or a child window.
2690  */
2691 static gboolean
2692 gdk_window_begin_implicit_paint (GdkWindow *window, GdkRectangle *rect)
2693 {
2694   GdkWindowPaint *paint;
2695
2696   g_assert (gdk_window_has_impl (window));
2697
2698   if (GDK_IS_PAINTABLE (window->impl))
2699     return FALSE; /* Implementation does double buffering */
2700
2701   if (window->paint_stack != NULL ||
2702       window->implicit_paint != NULL)
2703     return FALSE; /* Don't stack implicit paints */
2704
2705   /* Never do implicit paints for foreign windows, they don't need
2706    * double buffer combination since they have no client side children,
2707    * and creating surfaces for them is risky since they could disappear
2708    * at any time
2709    */
2710   if (window->window_type == GDK_WINDOW_FOREIGN)
2711     return FALSE;
2712
2713   paint = g_new (GdkWindowPaint, 1);
2714   paint->region = cairo_region_create (); /* Empty */
2715   paint->uses_implicit = FALSE;
2716   paint->flushed = NULL;
2717   paint->surface = gdk_window_create_similar_surface (window,
2718                                                       gdk_window_get_content (window),
2719                                                       MAX (rect->width, 1),
2720                                                       MAX (rect->height, 1));
2721   cairo_surface_set_device_offset (paint->surface, -rect->x, -rect->y);
2722
2723   window->implicit_paint = paint;
2724
2725   return TRUE;
2726 }
2727
2728 static cairo_surface_t *
2729 gdk_window_ref_impl_surface (GdkWindow *window)
2730 {
2731   return GDK_WINDOW_IMPL_GET_CLASS (window->impl)->ref_cairo_surface (gdk_window_get_impl_window (window));
2732 }
2733
2734 static cairo_t *
2735 gdk_cairo_create_for_impl (GdkWindow *window)
2736 {
2737   cairo_surface_t *surface;
2738   cairo_t *cr;
2739
2740   surface = gdk_window_ref_impl_surface (window);
2741   cr = cairo_create (surface);
2742
2743   cairo_surface_destroy (surface);
2744
2745   return cr;
2746 }
2747
2748 /* Ensure that all content related to this (sub)window is pushed to the
2749    native region. If there is an active paint then that area is not
2750    pushed, in order to not show partially finished double buffers. */
2751 static void
2752 gdk_window_flush_implicit_paint (GdkWindow *window)
2753 {
2754   GdkWindow *impl_window;
2755   GdkWindowPaint *paint;
2756   cairo_region_t *region;
2757   GSList *list;
2758
2759   impl_window = gdk_window_get_impl_window (window);
2760   if (impl_window->implicit_paint == NULL)
2761     return;
2762
2763   paint = impl_window->implicit_paint;
2764   region = cairo_region_copy (window->clip_region_with_children);
2765
2766   cairo_region_translate (region, window->abs_x, window->abs_y);
2767
2768   if (paint->flushed == NULL)
2769     paint->flushed = cairo_region_copy (region);
2770   else
2771     cairo_region_union (paint->flushed, region);
2772
2773   cairo_region_intersect (region, paint->region);
2774
2775   /* Don't flush active double buffers, as that may show partially done
2776    * rendering */
2777   for (list = window->paint_stack; list != NULL; list = list->next)
2778     {
2779       GdkWindowPaint *tmp_paint = list->data;
2780
2781       cairo_region_subtract (region, tmp_paint->region);
2782     }
2783
2784   if (!GDK_WINDOW_DESTROYED (window) && !cairo_region_is_empty (region))
2785     {
2786       cairo_t *cr;
2787
2788       /* Remove flushed region from the implicit paint */
2789       cairo_region_subtract (paint->region, region);
2790
2791       /* Some regions are valid, push these to window now */
2792       cr = gdk_cairo_create_for_impl (window);
2793       gdk_cairo_region (cr, region);
2794       cairo_clip (cr);
2795       cairo_set_source_surface (cr, paint->surface, 0, 0);
2796       cairo_set_operator (cr, CAIRO_OPERATOR_SOURCE);
2797       cairo_paint (cr);
2798       cairo_destroy (cr);
2799     }
2800
2801   cairo_region_destroy (region);
2802 }
2803
2804 /* Ends an implicit paint, paired with gdk_window_begin_implicit_paint returning TRUE */
2805 static void
2806 gdk_window_end_implicit_paint (GdkWindow *window)
2807 {
2808   GdkWindowPaint *paint;
2809
2810   g_assert (gdk_window_has_impl (window));
2811
2812   g_assert (window->implicit_paint != NULL);
2813
2814   paint = window->implicit_paint;
2815
2816   window->implicit_paint = NULL;
2817
2818   if (!GDK_WINDOW_DESTROYED (window) && !cairo_region_is_empty (paint->region))
2819     {
2820       cairo_t *cr;
2821
2822       /* Some regions are valid, push these to window now */
2823       cr = gdk_cairo_create_for_impl (window);
2824       gdk_cairo_region (cr, paint->region);
2825       cairo_clip (cr);
2826       cairo_set_source_surface (cr, paint->surface, 0, 0);
2827       cairo_set_operator (cr, CAIRO_OPERATOR_SOURCE);
2828       cairo_paint (cr);
2829       cairo_destroy (cr);
2830     }
2831   
2832   cairo_region_destroy (paint->region);
2833   if (paint->flushed)
2834     cairo_region_destroy (paint->flushed);
2835   cairo_surface_destroy (paint->surface);
2836   g_free (paint);
2837 }
2838
2839 /**
2840  * gdk_window_begin_paint_rect:
2841  * @window: a #GdkWindow
2842  * @rectangle: rectangle you intend to draw to
2843  *
2844  * A convenience wrapper around gdk_window_begin_paint_region() which
2845  * creates a rectangular region for you. See
2846  * gdk_window_begin_paint_region() for details.
2847  *
2848  **/
2849 void
2850 gdk_window_begin_paint_rect (GdkWindow          *window,
2851                              const GdkRectangle *rectangle)
2852 {
2853   cairo_region_t *region;
2854
2855   g_return_if_fail (GDK_IS_WINDOW (window));
2856
2857   region = cairo_region_create_rectangle (rectangle);
2858   gdk_window_begin_paint_region (window, region);
2859   cairo_region_destroy (region);
2860 }
2861
2862 /**
2863  * gdk_window_begin_paint_region:
2864  * @window: a #GdkWindow
2865  * @region: region you intend to draw to
2866  *
2867  * Indicates that you are beginning the process of redrawing @region.
2868  * A backing store (offscreen buffer) large enough to contain @region
2869  * will be created. The backing store will be initialized with the
2870  * background color or background surface for @window. Then, all
2871  * drawing operations performed on @window will be diverted to the
2872  * backing store.  When you call gdk_window_end_paint(), the backing
2873  * store will be copied to @window, making it visible onscreen. Only
2874  * the part of @window contained in @region will be modified; that is,
2875  * drawing operations are clipped to @region.
2876  *
2877  * The net result of all this is to remove flicker, because the user
2878  * sees the finished product appear all at once when you call
2879  * gdk_window_end_paint(). If you draw to @window directly without
2880  * calling gdk_window_begin_paint_region(), the user may see flicker
2881  * as individual drawing operations are performed in sequence.  The
2882  * clipping and background-initializing features of
2883  * gdk_window_begin_paint_region() are conveniences for the
2884  * programmer, so you can avoid doing that work yourself.
2885  *
2886  * When using GTK+, the widget system automatically places calls to
2887  * gdk_window_begin_paint_region() and gdk_window_end_paint() around
2888  * emissions of the expose_event signal. That is, if you're writing an
2889  * expose event handler, you can assume that the exposed area in
2890  * #GdkEventExpose has already been cleared to the window background,
2891  * is already set as the clip region, and already has a backing store.
2892  * Therefore in most cases, application code need not call
2893  * gdk_window_begin_paint_region(). (You can disable the automatic
2894  * calls around expose events on a widget-by-widget basis by calling
2895  * gtk_widget_set_double_buffered().)
2896  *
2897  * If you call this function multiple times before calling the
2898  * matching gdk_window_end_paint(), the backing stores are pushed onto
2899  * a stack. gdk_window_end_paint() copies the topmost backing store
2900  * onscreen, subtracts the topmost region from all other regions in
2901  * the stack, and pops the stack. All drawing operations affect only
2902  * the topmost backing store in the stack. One matching call to
2903  * gdk_window_end_paint() is required for each call to
2904  * gdk_window_begin_paint_region().
2905  *
2906  **/
2907 void
2908 gdk_window_begin_paint_region (GdkWindow       *window,
2909                                const cairo_region_t *region)
2910 {
2911 #ifdef USE_BACKING_STORE
2912   GdkRectangle clip_box;
2913   GdkWindowPaint *paint, *implicit_paint;
2914   GdkWindow *impl_window;
2915   GSList *list;
2916
2917   g_return_if_fail (GDK_IS_WINDOW (window));
2918
2919   if (GDK_WINDOW_DESTROYED (window))
2920     return;
2921
2922   if (GDK_IS_PAINTABLE (window->impl))
2923     {
2924       GdkPaintableIface *iface = GDK_PAINTABLE_GET_IFACE (window->impl);
2925
2926       if (iface->begin_paint_region)
2927         iface->begin_paint_region ((GdkPaintable*)window->impl, window, region);
2928
2929       return;
2930     }
2931
2932   impl_window = gdk_window_get_impl_window (window);
2933   implicit_paint = impl_window->implicit_paint;
2934
2935   paint = g_new (GdkWindowPaint, 1);
2936   paint->region = cairo_region_copy (region);
2937
2938   cairo_region_intersect (paint->region, window->clip_region_with_children);
2939   cairo_region_get_extents (paint->region, &clip_box);
2940
2941   cairo_region_translate (paint->region, window->abs_x, window->abs_y);
2942
2943   /* Mark the region as valid on the implicit paint */
2944
2945   if (implicit_paint)
2946     cairo_region_union (implicit_paint->region, paint->region);
2947
2948   /* Convert back to normal coords */
2949   cairo_region_translate (paint->region, -window->abs_x, -window->abs_y);
2950
2951   if (implicit_paint)
2952     {
2953       paint->uses_implicit = TRUE;
2954       paint->surface = cairo_surface_create_for_rectangle (implicit_paint->surface,
2955                                                            window->abs_x + clip_box.x,
2956                                                            window->abs_y + clip_box.y,
2957                                                            MAX (clip_box.width, 1),
2958                                                            MAX (clip_box.height, 1));
2959     }
2960   else
2961     {
2962       paint->uses_implicit = FALSE;
2963       paint->surface = gdk_window_create_similar_surface (window,
2964                                                           gdk_window_get_content (window),
2965                                                           MAX (clip_box.width, 1),
2966                                                           MAX (clip_box.height, 1));
2967     }
2968
2969   /* Normally alpha backgrounded client side windows are composited on the implicit paint
2970      by being drawn in back to front order. However, if implicit paints are not used, for
2971      instance if it was flushed due to a non-double-buffered paint in the middle of the
2972      expose we need to copy in the existing data here. */
2973   if (!gdk_window_has_impl (window) &&
2974       window->has_alpha_background &&
2975       (!implicit_paint ||
2976        (implicit_paint && implicit_paint->flushed != NULL && !cairo_region_is_empty (implicit_paint->flushed))))
2977     {
2978       cairo_t *cr = cairo_create (paint->surface);
2979       /* We can't use gdk_cairo_set_source_window here, as that might
2980          flush the implicit paint at an unfortunate time, since this
2981          would be detected as a draw during non-expose time */
2982       cairo_surface_t *source_surface  = gdk_window_ref_impl_surface (impl_window);
2983       cairo_set_source_surface (cr, source_surface,
2984                                 - (window->abs_x + clip_box.x),
2985                                 - (window->abs_y + clip_box.y));
2986       cairo_surface_destroy (source_surface);
2987
2988       /* Only read back the flushed area if any */
2989       if (implicit_paint)
2990         {
2991           cairo_region_t *flushed = cairo_region_copy (implicit_paint->flushed);
2992           /* Convert from impl coords */
2993           cairo_region_translate (flushed, -window->abs_x, -window->abs_y);
2994           cairo_region_intersect (flushed, paint->region);
2995           gdk_cairo_region (cr, flushed);
2996           cairo_clip (cr);
2997
2998           /* Convert to impl coords */
2999           cairo_region_translate (flushed, window->abs_x, window->abs_y);
3000           cairo_region_subtract (implicit_paint->flushed, flushed);
3001           cairo_region_destroy (flushed);
3002         }
3003       cairo_paint (cr);
3004       cairo_destroy (cr);
3005     }
3006
3007   cairo_surface_set_device_offset (paint->surface, -clip_box.x, -clip_box.y);
3008
3009   for (list = window->paint_stack; list != NULL; list = list->next)
3010     {
3011       GdkWindowPaint *tmp_paint = list->data;
3012
3013       cairo_region_subtract (tmp_paint->region, paint->region);
3014     }
3015
3016   window->paint_stack = g_slist_prepend (window->paint_stack, paint);
3017
3018   if (!cairo_region_is_empty (paint->region))
3019     {
3020       gdk_window_clear_backing_region (window,
3021                                        paint->region);
3022     }
3023
3024 #endif /* USE_BACKING_STORE */
3025 }
3026
3027 /**
3028  * gdk_window_end_paint:
3029  * @window: a #GdkWindow
3030  *
3031  * Indicates that the backing store created by the most recent call to
3032  * gdk_window_begin_paint_region() should be copied onscreen and
3033  * deleted, leaving the next-most-recent backing store or no backing
3034  * store at all as the active paint region. See
3035  * gdk_window_begin_paint_region() for full details. It is an error to
3036  * call this function without a matching
3037  * gdk_window_begin_paint_region() first.
3038  *
3039  **/
3040 void
3041 gdk_window_end_paint (GdkWindow *window)
3042 {
3043 #ifdef USE_BACKING_STORE
3044   GdkWindow *composited;
3045   GdkWindowPaint *paint;
3046   GdkRectangle clip_box;
3047   cairo_region_t *full_clip;
3048
3049   g_return_if_fail (GDK_IS_WINDOW (window));
3050
3051   if (GDK_WINDOW_DESTROYED (window))
3052     return;
3053
3054   if (GDK_IS_PAINTABLE (window->impl))
3055     {
3056       GdkPaintableIface *iface = GDK_PAINTABLE_GET_IFACE (window->impl);
3057
3058       if (iface->end_paint)
3059         iface->end_paint ((GdkPaintable*)window->impl);
3060       return;
3061     }
3062
3063   if (window->paint_stack == NULL)
3064     {
3065       g_warning (G_STRLOC": no preceding call to gdk_window_begin_paint_region(), see documentation");
3066       return;
3067     }
3068
3069   paint = window->paint_stack->data;
3070
3071   window->paint_stack = g_slist_delete_link (window->paint_stack,
3072                                              window->paint_stack);
3073
3074   cairo_region_get_extents (paint->region, &clip_box);
3075
3076   if (!paint->uses_implicit)
3077     {
3078       cairo_t *cr;
3079
3080       gdk_window_flush_outstanding_moves (window);
3081
3082       full_clip = cairo_region_copy (window->clip_region_with_children);
3083       cairo_region_intersect (full_clip, paint->region);
3084
3085       cr = gdk_cairo_create (window);
3086       cairo_set_operator (cr, CAIRO_OPERATOR_SOURCE);
3087       cairo_set_source_surface (cr, paint->surface, 0, 0);
3088       gdk_cairo_region (cr, full_clip);
3089       cairo_fill (cr);
3090
3091       cairo_destroy (cr);
3092       cairo_region_destroy (full_clip);
3093     }
3094
3095   cairo_surface_destroy (paint->surface);
3096   cairo_region_destroy (paint->region);
3097   g_free (paint);
3098
3099   /* find a composited window in our hierarchy to signal its
3100    * parent to redraw, calculating the clip box as we go...
3101    *
3102    * stop if parent becomes NULL since then we'd have nowhere
3103    * to draw (ie: 'composited' will always be non-NULL here).
3104    */
3105   for (composited = window;
3106        composited->parent;
3107        composited = composited->parent)
3108     {
3109       clip_box.x += composited->x;
3110       clip_box.y += composited->y;
3111       clip_box.width = MIN (clip_box.width, composited->parent->width - clip_box.x);
3112       clip_box.height = MIN (clip_box.height, composited->parent->height - clip_box.y);
3113
3114       if (composited->composited)
3115         {
3116           gdk_window_invalidate_rect (GDK_WINDOW (composited->parent),
3117                                       &clip_box, FALSE);
3118           break;
3119         }
3120     }
3121 #endif /* USE_BACKING_STORE */
3122 }
3123
3124 static void
3125 gdk_window_free_paint_stack (GdkWindow *window)
3126 {
3127   if (window->paint_stack)
3128     {
3129       GSList *tmp_list = window->paint_stack;
3130
3131       while (tmp_list)
3132         {
3133           GdkWindowPaint *paint = tmp_list->data;
3134
3135           if (tmp_list == window->paint_stack)
3136             cairo_surface_destroy (paint->surface);
3137
3138           cairo_region_destroy (paint->region);
3139           g_free (paint);
3140
3141           tmp_list = tmp_list->next;
3142         }
3143
3144       g_slist_free (window->paint_stack);
3145       window->paint_stack = NULL;
3146     }
3147 }
3148
3149 static void
3150 do_move_region_bits_on_impl (GdkWindow *impl_window,
3151                              cairo_region_t *dest_region, /* In impl window coords */
3152                              int dx, int dy)
3153 {
3154   GdkWindowImplClass *impl_class;
3155
3156   impl_class = GDK_WINDOW_IMPL_GET_CLASS (impl_window->impl);
3157
3158   impl_class->translate (impl_window, dest_region, dx, dy);
3159 }
3160
3161 static GdkWindowRegionMove *
3162 gdk_window_region_move_new (cairo_region_t *region,
3163                             int dx, int dy)
3164 {
3165   GdkWindowRegionMove *move;
3166
3167   move = g_slice_new (GdkWindowRegionMove);
3168   move->dest_region = cairo_region_copy (region);
3169   move->dx = dx;
3170   move->dy = dy;
3171
3172   return move;
3173 }
3174
3175 static void
3176 gdk_window_region_move_free (GdkWindowRegionMove *move)
3177 {
3178   cairo_region_destroy (move->dest_region);
3179   g_slice_free (GdkWindowRegionMove, move);
3180 }
3181
3182 static void
3183 append_move_region (GdkWindow *impl_window,
3184                     cairo_region_t *new_dest_region,
3185                     int dx, int dy)
3186 {
3187   GdkWindowRegionMove *move, *old_move;
3188   cairo_region_t *new_total_region, *old_total_region;
3189   cairo_region_t *source_overlaps_destination;
3190   cairo_region_t *non_overwritten;
3191   gboolean added_move;
3192   GList *l, *prev;
3193
3194   if (cairo_region_is_empty (new_dest_region))
3195     return;
3196
3197   /* In principle this could just append the move to the list of outstanding
3198      moves that will be replayed before drawing anything when we're handling
3199      exposes. However, we'd like to do a bit better since its commonly the case
3200      that we get multiple copies where A is copied to B and then B is copied
3201      to C, and we'd like to express this as a simple copy A to C operation. */
3202
3203   /* We approach this by taking the new move and pushing it ahead of moves
3204      starting at the end of the list and stopping when its not safe to do so.
3205      It's not safe to push past a move if either the source of the new move
3206      is in the destination of the old move, or if the destination of the new
3207      move is in the source of the new move, or if the destination of the new
3208      move overlaps the destination of the old move. We simplify this by
3209      just comparing the total regions (src + dest) */
3210   new_total_region = cairo_region_copy (new_dest_region);
3211   cairo_region_translate (new_total_region, -dx, -dy);
3212   cairo_region_union (new_total_region, new_dest_region);
3213
3214   added_move = FALSE;
3215   for (l = g_list_last (impl_window->outstanding_moves); l != NULL; l = prev)
3216     {
3217       prev = l->prev;
3218       old_move = l->data;
3219
3220       old_total_region = cairo_region_copy (old_move->dest_region);
3221       cairo_region_translate (old_total_region, -old_move->dx, -old_move->dy);
3222       cairo_region_union (old_total_region, old_move->dest_region);
3223
3224       cairo_region_intersect (old_total_region, new_total_region);
3225       /* If these regions intersect then its not safe to push the
3226          new region before the old one */
3227       if (!cairo_region_is_empty (old_total_region))
3228         {
3229           /* The area where the new moves source overlaps the old ones
3230              destination */
3231           source_overlaps_destination = cairo_region_copy (new_dest_region);
3232           cairo_region_translate (source_overlaps_destination, -dx, -dy);
3233           cairo_region_intersect (source_overlaps_destination, old_move->dest_region);
3234           cairo_region_translate (source_overlaps_destination, dx, dy);
3235
3236           /* We can do all sort of optimizations here, but to do things safely it becomes
3237              quite complicated. However, a very common case is that you copy something first,
3238              then copy all that or a subset of it to a new location (i.e. if you scroll twice
3239              in the same direction). We'd like to detect this case and optimize it to one
3240              copy. */
3241           if (cairo_region_equal (source_overlaps_destination, new_dest_region))
3242             {
3243               /* This means we might be able to replace the old move and the new one
3244                  with the new one read from the old ones source, and a second copy of
3245                  the non-overwritten parts of the old move. However, such a split
3246                  is only valid if the source in the old move isn't overwritten
3247                  by the destination of the new one */
3248
3249               /* the new destination of old move if split is ok: */
3250               non_overwritten = cairo_region_copy (old_move->dest_region);
3251               cairo_region_subtract (non_overwritten, new_dest_region);
3252               /* move to source region */
3253               cairo_region_translate (non_overwritten, -old_move->dx, -old_move->dy);
3254
3255               cairo_region_intersect (non_overwritten, new_dest_region);
3256               if (cairo_region_is_empty (non_overwritten))
3257                 {
3258                   added_move = TRUE;
3259                   move = gdk_window_region_move_new (new_dest_region,
3260                                                      dx + old_move->dx,
3261                                                      dy + old_move->dy);
3262
3263                   impl_window->outstanding_moves =
3264                     g_list_insert_before (impl_window->outstanding_moves,
3265                                           l, move);
3266                   cairo_region_subtract (old_move->dest_region, new_dest_region);
3267                 }
3268               cairo_region_destroy (non_overwritten);
3269             }
3270
3271           cairo_region_destroy (source_overlaps_destination);
3272           cairo_region_destroy (old_total_region);
3273           break;
3274         }
3275       cairo_region_destroy (old_total_region);
3276     }
3277
3278   cairo_region_destroy (new_total_region);
3279
3280   if (!added_move)
3281     {
3282       move = gdk_window_region_move_new (new_dest_region, dx, dy);
3283
3284       if (l == NULL)
3285         impl_window->outstanding_moves =
3286           g_list_prepend (impl_window->outstanding_moves,
3287                           move);
3288       else
3289         impl_window->outstanding_moves =
3290           g_list_insert_before (impl_window->outstanding_moves,
3291                                 l->next, move);
3292     }
3293 }
3294
3295 /* Moves bits and update area by dx/dy in impl window.
3296    Takes ownership of region to avoid copy (because we may change it) */
3297 static void
3298 move_region_on_impl (GdkWindow *impl_window,
3299                      cairo_region_t *region, /* In impl window coords */
3300                      int dx, int dy)
3301 {
3302   if ((dx == 0 && dy == 0) ||
3303       cairo_region_is_empty (region))
3304     {
3305       cairo_region_destroy (region);
3306       return;
3307     }
3308
3309   g_assert (impl_window == gdk_window_get_impl_window (impl_window));
3310
3311   /* Move any old invalid regions in the copy source area by dx/dy */
3312   if (impl_window->update_area)
3313     {
3314       cairo_region_t *update_area;
3315
3316       update_area = cairo_region_copy (region);
3317
3318       /* Convert from target to source */
3319       cairo_region_translate (update_area, -dx, -dy);
3320       cairo_region_intersect (update_area, impl_window->update_area);
3321       /* We only copy the area, so keep the old update area invalid.
3322          It would be safe to remove it too, as code that uses
3323          move_region_on_impl generally also invalidate the source
3324          area. However, it would just use waste cycles. */
3325
3326       /* Convert back */
3327       cairo_region_translate (update_area, dx, dy);
3328       cairo_region_union (impl_window->update_area, update_area);
3329
3330       /* This area of the destination is now invalid,
3331          so no need to copy to it.  */
3332       cairo_region_subtract (region, update_area);
3333
3334       cairo_region_destroy (update_area);
3335     }
3336
3337   /* If we're currently exposing this window, don't copy to this
3338      destination, as it will be overdrawn when the expose is done,
3339      instead invalidate it and repaint later. */
3340   if (impl_window->implicit_paint)
3341     {
3342       GdkWindowPaint *implicit_paint = impl_window->implicit_paint;
3343       cairo_region_t *exposing;
3344
3345       exposing = cairo_region_copy (implicit_paint->region);
3346       cairo_region_intersect (exposing, region);
3347       cairo_region_subtract (region, exposing);
3348
3349       impl_window_add_update_area (impl_window, exposing);
3350       cairo_region_destroy (exposing);
3351     }
3352
3353   append_move_region (impl_window, region, dx, dy);
3354
3355   cairo_region_destroy (region);
3356 }
3357
3358 /* Flushes all outstanding changes to the window, call this
3359  * before drawing directly to the window (i.e. outside a begin/end_paint pair).
3360  */
3361 static void
3362 gdk_window_flush_outstanding_moves (GdkWindow *window)
3363 {
3364   GdkWindow *impl_window;
3365   GList *l, *outstanding;
3366   GdkWindowRegionMove *move;
3367
3368   impl_window = gdk_window_get_impl_window (window);
3369   outstanding = impl_window->outstanding_moves;
3370   impl_window->outstanding_moves = NULL;
3371
3372   for (l = outstanding; l != NULL; l = l->next)
3373     {
3374       move = l->data;
3375
3376       do_move_region_bits_on_impl (impl_window,
3377                                    move->dest_region, move->dx, move->dy);
3378
3379       gdk_window_region_move_free (move);
3380     }
3381
3382   g_list_free (outstanding);
3383 }
3384
3385 /**
3386  * gdk_window_flush:
3387  * @window: a #GdkWindow
3388  *
3389  * Flush all outstanding cached operations on a window, leaving the
3390  * window in a state which reflects all that has been drawn before.
3391  *
3392  * Gdk uses multiple kinds of caching to get better performance and
3393  * nicer drawing. For instance, during exposes all paints to a window
3394  * using double buffered rendering are keep on a surface until the last
3395  * window has been exposed. It also delays window moves/scrolls until
3396  * as long as possible until next update to avoid tearing when moving
3397  * windows.
3398  *
3399  * Normally this should be completely invisible to applications, as
3400  * we automatically flush the windows when required, but this might
3401  * be needed if you for instance mix direct native drawing with
3402  * gdk drawing. For Gtk widgets that don't use double buffering this
3403  * will be called automatically before sending the expose event.
3404  *
3405  * Since: 2.18
3406  **/
3407 void
3408 gdk_window_flush (GdkWindow *window)
3409 {
3410   gdk_window_flush_outstanding_moves (window);
3411   gdk_window_flush_implicit_paint (window);
3412 }
3413
3414 /* If we're about to move/resize or otherwise change the
3415  * hierarchy of a client side window in an impl and we're
3416  * called from an expose event handler then we need to
3417  * flush any already painted parts of the implicit paint
3418  * that are not part of the current paint, as these may
3419  * be used when scrolling or may overdraw the changes
3420  * caused by the hierarchy change.
3421  */
3422 static void
3423 gdk_window_flush_if_exposing (GdkWindow *window)
3424 {
3425   GdkWindow *impl_window;
3426
3427   impl_window = gdk_window_get_impl_window (window);
3428
3429   /* If we're in an implicit paint (i.e. in an expose handler, flush
3430      all the already finished exposes to get things to an uptodate state. */
3431   if (impl_window->implicit_paint)
3432     gdk_window_flush (window);
3433 }
3434
3435
3436 static void
3437 gdk_window_flush_recursive_helper (GdkWindow *window,
3438                                    GdkWindowImpl *impl)
3439 {
3440   GdkWindow *child;
3441   GList *l;
3442
3443   for (l = window->children; l != NULL; l = l->next)
3444     {
3445       child = l->data;
3446
3447       if (child->impl == impl)
3448         /* Same impl, ignore */
3449         gdk_window_flush_recursive_helper (child, impl);
3450       else
3451         gdk_window_flush_recursive (child);
3452     }
3453 }
3454
3455 static void
3456 gdk_window_flush_recursive (GdkWindow *window)
3457 {
3458   gdk_window_flush (window);
3459   gdk_window_flush_recursive_helper (window, window->impl);
3460 }
3461
3462 /**
3463  * gdk_window_get_clip_region:
3464  * @window: a #GdkWindow
3465  * 
3466  * Computes the region of a window that potentially can be written
3467  * to by drawing primitives. This region may not take into account
3468  * other factors such as if the window is obscured by other windows,
3469  * but no area outside of this region will be affected by drawing
3470  * primitives.
3471  * 
3472  * Returns: a #cairo_region_t. This must be freed with cairo_region_destroy()
3473  *          when you are done.
3474  **/
3475 cairo_region_t*
3476 gdk_window_get_clip_region (GdkWindow *window)
3477 {
3478   cairo_region_t *result;
3479
3480   g_return_val_if_fail (GDK_WINDOW (window), NULL);
3481
3482   result = cairo_region_copy (window->clip_region);
3483
3484   if (window->paint_stack)
3485     {
3486       cairo_region_t *paint_region = cairo_region_create ();
3487       GSList *tmp_list = window->paint_stack;
3488
3489       while (tmp_list)
3490         {
3491           GdkWindowPaint *paint = tmp_list->data;
3492
3493           cairo_region_union (paint_region, paint->region);
3494
3495           tmp_list = tmp_list->next;
3496         }
3497
3498       cairo_region_intersect (result, paint_region);
3499       cairo_region_destroy (paint_region);
3500     }
3501
3502   return result;
3503 }
3504
3505 /**
3506  * gdk_window_get_visible_region:
3507  * @window: a #GdkWindow
3508  * 
3509  * Computes the region of the @window that is potentially visible.
3510  * This does not necessarily take into account if the window is
3511  * obscured by other windows, but no area outside of this region
3512  * is visible.
3513  * 
3514  * Returns: a #cairo_region_t. This must be freed with cairo_region_destroy()
3515  *          when you are done.
3516  **/
3517 cairo_region_t *
3518 gdk_window_get_visible_region (GdkWindow *window)
3519 {
3520   g_return_val_if_fail (GDK_IS_WINDOW (window), NULL);
3521
3522   return cairo_region_copy (window->clip_region);
3523 }
3524
3525 static cairo_t *
3526 setup_backing_rect (GdkWindow *window, GdkWindowPaint *paint)
3527 {
3528   GdkWindow *bg_window;
3529   cairo_pattern_t *pattern = NULL;
3530   int x_offset = 0, y_offset = 0;
3531   cairo_t *cr;
3532
3533   cr = cairo_create (paint->surface);
3534
3535   for (bg_window = window; bg_window; bg_window = bg_window->parent)
3536     {
3537       pattern = gdk_window_get_background_pattern (bg_window);
3538       if (pattern)
3539         break;
3540
3541       x_offset += bg_window->x;
3542       y_offset += bg_window->y;
3543     }
3544
3545   if (pattern)
3546     {
3547       cairo_translate (cr, -x_offset, -y_offset);
3548       cairo_set_source (cr, pattern);
3549       cairo_translate (cr, x_offset, y_offset);
3550     }
3551   else
3552     cairo_set_source_rgb (cr, 0, 0, 0);
3553
3554   return cr;
3555 }
3556
3557 static void
3558 gdk_window_clear_backing_region (GdkWindow *window,
3559                                  cairo_region_t *region)
3560 {
3561   GdkWindowPaint *paint = window->paint_stack->data;
3562   cairo_region_t *clip;
3563   cairo_t *cr;
3564
3565   if (GDK_WINDOW_DESTROYED (window))
3566     return;
3567
3568   cr = setup_backing_rect (window, paint);
3569
3570   clip = cairo_region_copy (paint->region);
3571   cairo_region_intersect (clip, region);
3572
3573   gdk_cairo_region (cr, clip);
3574   cairo_fill (cr);
3575
3576   cairo_destroy (cr);
3577
3578   cairo_region_destroy (clip);
3579 }
3580
3581 static void
3582 gdk_window_drop_cairo_surface (GdkWindow *window)
3583 {
3584   if (window->cairo_surface)
3585     {
3586       cairo_surface_finish (window->cairo_surface);
3587       cairo_surface_set_user_data (window->cairo_surface, &gdk_window_cairo_key,
3588                                    NULL, NULL);
3589       window->cairo_surface = NULL;
3590     }
3591 }
3592
3593 static void
3594 gdk_window_cairo_surface_destroy (void *data)
3595 {
3596   GdkWindow *window = data;
3597
3598   window->cairo_surface = NULL;
3599 }
3600
3601 static cairo_surface_t *
3602 gdk_window_create_cairo_surface (GdkWindow *window,
3603                                  int width,
3604                                  int height)
3605 {
3606   cairo_surface_t *surface, *subsurface;
3607   
3608   surface = gdk_window_ref_impl_surface (window);
3609   if (gdk_window_has_impl (window))
3610     return surface;
3611
3612   subsurface = cairo_surface_create_for_rectangle (surface,
3613                                                    window->abs_x,
3614                                                    window->abs_y,
3615                                                    width,
3616                                                    height);
3617   cairo_surface_destroy (surface);
3618   return subsurface;
3619 }
3620
3621
3622 cairo_surface_t *
3623 _gdk_window_ref_cairo_surface (GdkWindow *window)
3624 {
3625   cairo_surface_t *surface;
3626
3627   g_return_val_if_fail (GDK_IS_WINDOW (window), NULL);
3628
3629   if (window->paint_stack)
3630     {
3631       GdkWindowPaint *paint = window->paint_stack->data;
3632
3633       surface = paint->surface;
3634       cairo_surface_reference (surface);
3635     }
3636   else
3637     {
3638
3639       /* This will be drawing directly to the window, so flush implicit paint */
3640       gdk_window_flush (window);
3641
3642       if (!window->cairo_surface)
3643         {
3644           window->cairo_surface = gdk_window_create_cairo_surface (window,
3645                                                                    window->width,
3646                                                                    window->height);
3647
3648           if (window->cairo_surface)
3649             {
3650               cairo_surface_set_user_data (window->cairo_surface, &gdk_window_cairo_key,
3651                                            window, gdk_window_cairo_surface_destroy);
3652             }
3653         }
3654       else
3655         cairo_surface_reference (window->cairo_surface);
3656
3657       surface = window->cairo_surface;
3658     }
3659
3660   return surface;
3661 }
3662
3663 /**
3664  * gdk_cairo_create:
3665  * @window: a #GdkWindow
3666  * 
3667  * Creates a Cairo context for drawing to @window.
3668  *
3669  * <note><warning>
3670  * Note that calling cairo_reset_clip() on the resulting #cairo_t will
3671  * produce undefined results, so avoid it at all costs.
3672  * </warning></note>
3673  *
3674  * Return value: A newly created Cairo context. Free with
3675  *  cairo_destroy() when you are done drawing.
3676  * 
3677  * Since: 2.8
3678  **/
3679 cairo_t *
3680 gdk_cairo_create (GdkWindow *window)
3681 {
3682   cairo_surface_t *surface;
3683   cairo_t *cr;
3684     
3685   g_return_val_if_fail (GDK_IS_WINDOW (window), NULL);
3686
3687   surface = _gdk_window_ref_cairo_surface (window);
3688   cr = cairo_create (surface);
3689
3690   if (!window->paint_stack)
3691     {
3692       gdk_cairo_region (cr, window->clip_region_with_children);
3693       cairo_clip (cr);
3694     }
3695   else
3696     {
3697       GdkWindowPaint *paint = window->paint_stack->data;
3698
3699       /* Only needs to clip to region if piggybacking
3700          on an implicit paint */
3701       if (paint->uses_implicit)
3702         {
3703           gdk_cairo_region (cr, paint->region);
3704           cairo_clip (cr);
3705         }
3706     }
3707     
3708   cairo_surface_destroy (surface);
3709
3710   return cr;
3711 }
3712
3713 /* Code for dirty-region queueing
3714  */
3715 static GSList *update_windows = NULL;
3716 static guint update_idle = 0;
3717 static gboolean debug_updates = FALSE;
3718
3719 static inline gboolean
3720 gdk_window_is_ancestor (GdkWindow *window,
3721                         GdkWindow *ancestor)
3722 {
3723   while (window)
3724     {
3725       GdkWindow *parent = window->parent;
3726
3727       if (parent == ancestor)
3728         return TRUE;
3729
3730       window = parent;
3731     }
3732
3733   return FALSE;
3734 }
3735
3736 static void
3737 gdk_window_add_update_window (GdkWindow *window)
3738 {
3739   GSList *tmp;
3740   GSList *prev = NULL;
3741   gboolean has_ancestor_in_list = FALSE;
3742
3743   for (tmp = update_windows; tmp; tmp = tmp->next)
3744     {
3745       GdkWindow *parent = window->parent;
3746
3747       /*  check if tmp is an ancestor of "window"; if it is, set a
3748        *  flag indicating that all following windows are either
3749        *  children of "window" or from a differen hierarchy
3750        */
3751       if (!has_ancestor_in_list && gdk_window_is_ancestor (window, tmp->data))
3752         has_ancestor_in_list = TRUE;
3753
3754       /* insert in reverse stacking order when adding around siblings,
3755        * so processing updates properly paints over lower stacked windows
3756        */
3757       if (parent == GDK_WINDOW (tmp->data)->parent)
3758         {
3759           gint index = g_list_index (parent->children, window);
3760           for (; tmp && parent == GDK_WINDOW (tmp->data)->parent; tmp = tmp->next)
3761             {
3762               gint sibling_index = g_list_index (parent->children, tmp->data);
3763               if (index > sibling_index)
3764                 break;
3765               prev = tmp;
3766             }
3767           /* here, tmp got advanced past all lower stacked siblings */
3768           tmp = g_slist_prepend (tmp, window);
3769           if (prev)
3770             prev->next = tmp;
3771           else
3772             update_windows = tmp;
3773           return;
3774         }
3775
3776       /*  if "window" has an ancestor in the list and tmp is one of
3777        *  "window's" children, insert "window" before tmp
3778        */
3779       if (has_ancestor_in_list && gdk_window_is_ancestor (tmp->data, window))
3780         {
3781           tmp = g_slist_prepend (tmp, window);
3782
3783           if (prev)
3784             prev->next = tmp;
3785           else
3786             update_windows = tmp;
3787           return;
3788         }
3789
3790       /*  if we're at the end of the list and had an ancestor it it,
3791        *  append to the list
3792        */
3793       if (! tmp->next && has_ancestor_in_list)
3794         {
3795           tmp = g_slist_append (tmp, window);
3796           return;
3797         }
3798
3799       prev = tmp;
3800     }
3801
3802   /*  if all above checks failed ("window" is from a different
3803    *  hierarchy than what is already in the list) or the list is
3804    *  empty, prepend
3805    */
3806   update_windows = g_slist_prepend (update_windows, window);
3807 }
3808
3809 static void
3810 gdk_window_remove_update_window (GdkWindow *window)
3811 {
3812   update_windows = g_slist_remove (update_windows, window);
3813 }
3814
3815 static gboolean
3816 gdk_window_update_idle (gpointer data)
3817 {
3818   gdk_window_process_all_updates ();
3819
3820   return FALSE;
3821 }
3822
3823 static gboolean
3824 gdk_window_is_toplevel_frozen (GdkWindow *window)
3825 {
3826   GdkWindow *toplevel;
3827
3828   toplevel = gdk_window_get_toplevel (window);
3829
3830   return toplevel->update_and_descendants_freeze_count > 0;
3831 }
3832
3833 static void
3834 gdk_window_schedule_update (GdkWindow *window)
3835 {
3836   if (window &&
3837       (window->update_freeze_count ||
3838        gdk_window_is_toplevel_frozen (window)))
3839     return;
3840
3841   if (!update_idle)
3842     update_idle =
3843       gdk_threads_add_idle_full (GDK_PRIORITY_REDRAW,
3844                                  gdk_window_update_idle,
3845                                  NULL, NULL);
3846 }
3847
3848 void
3849 _gdk_window_process_updates_recurse (GdkWindow *window,
3850                                      cairo_region_t *expose_region)
3851 {
3852   GdkWindow *child;
3853   cairo_region_t *clipped_expose_region;
3854   GList *l, *children;
3855
3856   if (cairo_region_is_empty (expose_region))
3857     return;
3858
3859   if (gdk_window_is_offscreen (window->impl_window) &&
3860       gdk_window_has_impl (window))
3861     _gdk_window_add_damage ((GdkWindow *) window->impl_window, expose_region);
3862
3863
3864   /* Paint the window before the children, clipped to the window region
3865      with visible child windows removed */
3866   clipped_expose_region = cairo_region_copy (expose_region);
3867   cairo_region_intersect (clipped_expose_region, window->clip_region_with_children);
3868
3869   if (!cairo_region_is_empty (clipped_expose_region) &&
3870       !window->destroyed)
3871     {
3872       if (window->event_mask & GDK_EXPOSURE_MASK)
3873         {
3874           GdkEvent event;
3875
3876           event.expose.type = GDK_EXPOSE;
3877           event.expose.window = g_object_ref (window);
3878           event.expose.send_event = FALSE;
3879           event.expose.count = 0;
3880           event.expose.region = clipped_expose_region;
3881           cairo_region_get_extents (clipped_expose_region, &event.expose.area);
3882
3883           _gdk_event_emit (&event);
3884
3885           g_object_unref (window);
3886         }
3887       else if (window->window_type != GDK_WINDOW_FOREIGN)
3888         {
3889           /* No exposure mask set, so nothing will be drawn, the
3890            * app relies on the background being what it specified
3891            * for the window. So, we need to clear this manually.
3892            *
3893            * For foreign windows if expose is not set that generally
3894            * means some other client paints them, so don't clear
3895            * there.
3896            *
3897            * We use begin/end_paint around the clear so that we can
3898            * piggyback on the implicit paint */
3899
3900           gdk_window_begin_paint_region (window, clipped_expose_region);
3901           /* The actual clear happens in begin_paint_region */
3902           gdk_window_end_paint (window);
3903         }
3904     }
3905   cairo_region_destroy (clipped_expose_region);
3906
3907   /* Make this reentrancy safe for expose handlers freeing windows */
3908   children = g_list_copy (window->children);
3909   g_list_foreach (children, (GFunc)g_object_ref, NULL);
3910
3911   /* Iterate over children, starting at bottommost */
3912   for (l = g_list_last (children); l != NULL; l = l->prev)
3913     {
3914       child = l->data;
3915
3916       if (child->destroyed || !GDK_WINDOW_IS_MAPPED (child) || child->input_only || child->composited)
3917         continue;
3918
3919       /* Ignore offscreen children, as they don't draw in their parent and
3920        * don't take part in the clipping */
3921       if (gdk_window_is_offscreen (child))
3922         continue;
3923
3924       /* Client side child, expose */
3925       if (child->impl == window->impl)
3926         {
3927           cairo_region_translate (expose_region, -child->x, -child->y);
3928           _gdk_window_process_updates_recurse ((GdkWindow *)child, expose_region);
3929           cairo_region_translate (expose_region, child->x, child->y);
3930         }
3931     }
3932
3933   g_list_free_full (children, g_object_unref);
3934
3935 }
3936
3937 /* Process and remove any invalid area on the native window by creating
3938  * expose events for the window and all non-native descendants.
3939  * Also processes any outstanding moves on the window before doing
3940  * any drawing. Note that its possible to have outstanding moves without
3941  * any invalid area as we use the update idle mechanism to coalesce
3942  * multiple moves as well as multiple invalidations.
3943  */
3944 static void
3945 gdk_window_process_updates_internal (GdkWindow *window)
3946 {
3947   GdkWindowImplClass *impl_class;
3948   gboolean save_region = FALSE;
3949   GdkRectangle clip_box;
3950
3951   /* Ensure the window lives while updating it */
3952   g_object_ref (window);
3953
3954   /* If an update got queued during update processing, we can get a
3955    * window in the update queue that has an empty update_area.
3956    * just ignore it.
3957    */
3958   if (window->update_area)
3959     {
3960       cairo_region_t *update_area = window->update_area;
3961       window->update_area = NULL;
3962
3963       if (gdk_window_is_viewable (window))
3964         {
3965           cairo_region_t *expose_region;
3966           gboolean end_implicit;
3967
3968           /* Clip to part visible in toplevel */
3969           cairo_region_intersect (update_area, window->clip_region);
3970
3971           if (debug_updates)
3972             {
3973               /* Make sure we see the red invalid area before redrawing. */
3974               gdk_display_sync (gdk_window_get_display (window));
3975               g_usleep (70000);
3976             }
3977
3978           /* At this point we will be completely redrawing all of update_area.
3979            * If we have any outstanding moves that end up moving stuff inside
3980            * this area we don't actually need to move that as that part would
3981            * be overdrawn by the expose anyway. So, in order to copy less data
3982            * we remove these areas from the outstanding moves.
3983            */
3984           if (window->outstanding_moves)
3985             {
3986               GdkWindowRegionMove *move;
3987               cairo_region_t *remove;
3988               GList *l, *prev;
3989
3990               remove = cairo_region_copy (update_area);
3991               /* We iterate backwards, starting from the state that would be
3992                  if we had applied all the moves. */
3993               for (l = g_list_last (window->outstanding_moves); l != NULL; l = prev)
3994                 {
3995                   prev = l->prev;
3996                   move = l->data;
3997
3998                   /* Don't need this area */
3999                   cairo_region_subtract (move->dest_region, remove);
4000
4001                   /* However if any of the destination we do need has a source
4002                      in the updated region we do need that as a destination for
4003                      the earlier moves */
4004                   cairo_region_translate (move->dest_region, -move->dx, -move->dy);
4005                   cairo_region_subtract (remove, move->dest_region);
4006
4007                   if (cairo_region_is_empty (move->dest_region))
4008                     {
4009                       gdk_window_region_move_free (move);
4010                       window->outstanding_moves =
4011                         g_list_delete_link (window->outstanding_moves, l);
4012                     }
4013                   else /* move back */
4014                     cairo_region_translate (move->dest_region, move->dx, move->dy);
4015                 }
4016               cairo_region_destroy (remove);
4017             }
4018
4019           /* By now we a set of window moves that should be applied, and then
4020            * an update region that should be repainted. A trivial implementation
4021            * would just do that in order, however in order to get nicer drawing
4022            * we do some tricks:
4023            *
4024            * First of all, each subwindow expose may be double buffered by
4025            * itself (depending on widget setting) via
4026            * gdk_window_begin/end_paint(). But we also do an "implicit" paint,
4027            * creating a single surface the size of the invalid area on the
4028            * native window which all the individual normal paints will draw
4029            * into. This way in the normal case there will be only one surface
4030            * allocated and only once surface draw done for all the windows
4031            * in this native window.
4032            * There are a couple of reasons this may fail, for instance, some
4033            * backends (like quartz) do its own double buffering, so we disable
4034            * gdk double buffering there. Secondly, some subwindow could be
4035            * non-double buffered and draw directly to the window outside a
4036            * begin/end_paint pair. That will be lead to a gdk_window_flush
4037            * which immediately executes all outstanding moves and paints+removes
4038            * the implicit paint (further paints will allocate their own surfaces).
4039            *
4040            * Secondly, in the case of implicit double buffering we expose all
4041            * the child windows into the implicit surface before we execute
4042            * the outstanding moves. This way we minimize the time between
4043            * doing the moves and rendering the new update area, thus minimizing
4044            * flashing. Of course, if any subwindow is non-double buffered we
4045            * well flush earlier than that.
4046            *
4047            * Thirdly, after having done the outstanding moves we queue an
4048            * "antiexpose" on the area that will be drawn by the expose, which
4049            * means that any invalid region on the native window side before
4050            * the first expose drawing operation will be discarded, as it
4051            * has by then been overdrawn with valid data. This means we can
4052            * avoid doing the unnecessary repaint any outstanding expose events.
4053            */
4054
4055           cairo_region_get_extents (update_area, &clip_box);
4056           end_implicit = gdk_window_begin_implicit_paint (window, &clip_box);
4057           expose_region = cairo_region_copy (update_area);
4058           impl_class = GDK_WINDOW_IMPL_GET_CLASS (window->impl);
4059           if (!end_implicit)
4060             {
4061               /* Rendering is not double buffered by gdk, do outstanding
4062                * moves and queue antiexposure immediately. No need to do
4063                * any tricks */
4064               gdk_window_flush_outstanding_moves (window);
4065               save_region = impl_class->queue_antiexpose (window, update_area);
4066             }
4067           /* Render the invalid areas to the implicit paint, by sending exposes.
4068            * May flush if non-double buffered widget draw. */
4069           impl_class->process_updates_recurse (window, expose_region);
4070
4071           if (end_implicit)
4072             {
4073               /* Do moves right before exposes are rendered to the window */
4074               gdk_window_flush_outstanding_moves (window);
4075
4076               /* By this time we know that any outstanding expose for this
4077                * area is invalid and we can avoid it, so queue an antiexpose.
4078                * we have already started drawing to the window, so it would
4079                * be to late to anti-expose now. Since this is merely an
4080                * optimization we just avoid doing it at all in that case.
4081                */
4082               if (window->implicit_paint != NULL && !window->implicit_paint->flushed)
4083                 save_region = impl_class->queue_antiexpose (window, update_area);
4084
4085               gdk_window_end_implicit_paint (window);
4086             }
4087           cairo_region_destroy (expose_region);
4088         }
4089       if (!save_region)
4090         cairo_region_destroy (update_area);
4091     }
4092
4093   if (window->outstanding_moves)
4094     {
4095       /* Flush any outstanding moves, may happen if we moved a window but got
4096          no actual invalid area */
4097       gdk_window_flush_outstanding_moves (window);
4098     }
4099
4100   g_object_unref (window);
4101 }
4102
4103 static void
4104 flush_all_displays (void)
4105 {
4106   GSList *displays, *l;
4107
4108   displays = gdk_display_manager_list_displays (gdk_display_manager_get ());
4109   for (l = displays; l; l = l->next)
4110     gdk_display_flush (l->data);
4111
4112   g_slist_free (displays);
4113 }
4114
4115 static void
4116 before_process_all_updates (void)
4117 {
4118   GSList *displays, *l;
4119   GdkDisplayClass *display_class;
4120
4121   displays = gdk_display_manager_list_displays (gdk_display_manager_get ());
4122   display_class = GDK_DISPLAY_GET_CLASS (displays->data);
4123   for (l = displays; l; l = l->next)
4124     display_class->before_process_all_updates (l->data);
4125
4126   g_slist_free (displays);
4127 }
4128
4129 static void
4130 after_process_all_updates (void)
4131 {
4132   GSList *displays, *l;
4133   GdkDisplayClass *display_class;
4134
4135   displays = gdk_display_manager_list_displays (gdk_display_manager_get ());
4136   display_class = GDK_DISPLAY_GET_CLASS (displays->data);
4137   for (l = displays; l; l = l->next)
4138     display_class->after_process_all_updates (l->data);
4139
4140   g_slist_free (displays);
4141 }
4142
4143 /* Currently it is not possible to override
4144  * gdk_window_process_all_updates in the same manner as
4145  * gdk_window_process_updates and gdk_window_invalidate_maybe_recurse
4146  * by implementing the GdkPaintable interface.  If in the future a
4147  * backend would need this, the right solution would be to add a
4148  * method to GdkDisplay that can be optionally
4149  * NULL. gdk_window_process_all_updates can then walk the list of open
4150  * displays and call the mehod.
4151  */
4152
4153 /**
4154  * gdk_window_process_all_updates:
4155  *
4156  * Calls gdk_window_process_updates() for all windows (see #GdkWindow)
4157  * in the application.
4158  *
4159  **/
4160 void
4161 gdk_window_process_all_updates (void)
4162 {
4163   GSList *old_update_windows = update_windows;
4164   GSList *tmp_list = update_windows;
4165   static gboolean in_process_all_updates = FALSE;
4166   static gboolean got_recursive_update = FALSE;
4167
4168   if (in_process_all_updates)
4169     {
4170       /* We can't do this now since that would recurse, so
4171          delay it until after the recursion is done. */
4172       got_recursive_update = TRUE;
4173       update_idle = 0;
4174       return;
4175     }
4176
4177   in_process_all_updates = TRUE;
4178   got_recursive_update = FALSE;
4179
4180   if (update_idle)
4181     g_source_remove (update_idle);
4182
4183   update_windows = NULL;
4184   update_idle = 0;
4185
4186   before_process_all_updates ();
4187
4188   g_slist_foreach (old_update_windows, (GFunc)g_object_ref, NULL);
4189
4190   while (tmp_list)
4191     {
4192       GdkWindow *window = tmp_list->data;
4193
4194       if (!GDK_WINDOW_DESTROYED (window))
4195         {
4196           if (window->update_freeze_count ||
4197               gdk_window_is_toplevel_frozen (window))
4198             gdk_window_add_update_window (window);
4199           else
4200             gdk_window_process_updates_internal (window);
4201         }
4202
4203       g_object_unref (window);
4204       tmp_list = tmp_list->next;
4205     }
4206
4207   g_slist_free (old_update_windows);
4208
4209   flush_all_displays ();
4210
4211   after_process_all_updates ();
4212
4213   in_process_all_updates = FALSE;
4214
4215   /* If we ignored a recursive call, schedule a
4216      redraw now so that it eventually happens,
4217      otherwise we could miss an update if nothing
4218      else schedules an update. */
4219   if (got_recursive_update && !update_idle)
4220     update_idle =
4221       gdk_threads_add_idle_full (GDK_PRIORITY_REDRAW,
4222                                  gdk_window_update_idle,
4223                                  NULL, NULL);
4224 }
4225
4226 /**
4227  * gdk_window_process_updates:
4228  * @window: a #GdkWindow
4229  * @update_children: whether to also process updates for child windows
4230  *
4231  * Sends one or more expose events to @window. The areas in each
4232  * expose event will cover the entire update area for the window (see
4233  * gdk_window_invalidate_region() for details). Normally GDK calls
4234  * gdk_window_process_all_updates() on your behalf, so there's no
4235  * need to call this function unless you want to force expose events
4236  * to be delivered immediately and synchronously (vs. the usual
4237  * case, where GDK delivers them in an idle handler). Occasionally
4238  * this is useful to produce nicer scrolling behavior, for example.
4239  *
4240  **/
4241 void
4242 gdk_window_process_updates (GdkWindow *window,
4243                             gboolean   update_children)
4244 {
4245   GdkWindow *impl_window;
4246
4247   g_return_if_fail (GDK_IS_WINDOW (window));
4248
4249   if (GDK_WINDOW_DESTROYED (window))
4250     return;
4251
4252   /* Make sure the window lives during the expose callouts */
4253   g_object_ref (window);
4254
4255   impl_window = gdk_window_get_impl_window (window);
4256   if ((impl_window->update_area ||
4257        impl_window->outstanding_moves) &&
4258       !impl_window->update_freeze_count &&
4259       !gdk_window_is_toplevel_frozen (window) &&
4260
4261       /* Don't recurse into process_updates_internal, we'll
4262        * do the update later when idle instead. */
4263       impl_window->implicit_paint == NULL)
4264     {
4265       gdk_window_process_updates_internal ((GdkWindow *)impl_window);
4266       gdk_window_remove_update_window ((GdkWindow *)impl_window);
4267     }
4268
4269   if (update_children)
4270     {
4271       /* process updates in reverse stacking order so composition or
4272        * painting over achieves the desired effect for offscreen windows
4273        */
4274       GList *node, *children;
4275
4276       children = g_list_copy (window->children);
4277       g_list_foreach (children, (GFunc)g_object_ref, NULL);
4278
4279       for (node = g_list_last (children); node; node = node->prev)
4280         {
4281           gdk_window_process_updates (node->data, TRUE);
4282           g_object_unref (node->data);
4283         }
4284
4285       g_list_free (children);
4286     }
4287
4288   g_object_unref (window);
4289 }
4290
4291 static void
4292 gdk_window_invalidate_rect_full (GdkWindow          *window,
4293                                   const GdkRectangle *rect,
4294                                   gboolean            invalidate_children,
4295                                   ClearBg             clear_bg)
4296 {
4297   GdkRectangle window_rect;
4298   cairo_region_t *region;
4299
4300   g_return_if_fail (GDK_IS_WINDOW (window));
4301
4302   if (GDK_WINDOW_DESTROYED (window))
4303     return;
4304
4305   if (window->input_only || !window->viewable)
4306     return;
4307
4308   if (!rect)
4309     {
4310       window_rect.x = 0;
4311       window_rect.y = 0;
4312       window_rect.width = window->width;
4313       window_rect.height = window->height;
4314       rect = &window_rect;
4315     }
4316
4317   region = cairo_region_create_rectangle (rect);
4318   gdk_window_invalidate_region_full (window, region, invalidate_children, clear_bg);
4319   cairo_region_destroy (region);
4320 }
4321
4322 /**
4323  * gdk_window_invalidate_rect:
4324  * @window: a #GdkWindow
4325  * @rect: (allow-none): rectangle to invalidate or %NULL to invalidate the whole
4326  *      window
4327  * @invalidate_children: whether to also invalidate child windows
4328  *
4329  * A convenience wrapper around gdk_window_invalidate_region() which
4330  * invalidates a rectangular region. See
4331  * gdk_window_invalidate_region() for details.
4332  **/
4333 void
4334 gdk_window_invalidate_rect (GdkWindow          *window,
4335                             const GdkRectangle *rect,
4336                             gboolean            invalidate_children)
4337 {
4338   gdk_window_invalidate_rect_full (window, rect, invalidate_children, CLEAR_BG_NONE);
4339 }
4340
4341 static void
4342 draw_ugly_color (GdkWindow       *window,
4343                  const cairo_region_t *region)
4344 {
4345   cairo_t *cr;
4346
4347   cr = gdk_cairo_create (window);
4348   /* Draw ugly color all over the newly-invalid region */
4349   cairo_set_source_rgb (cr, 50000/65535., 10000/65535., 10000/65535.);
4350   gdk_cairo_region (cr, region);
4351   cairo_fill (cr);
4352
4353   cairo_destroy (cr);
4354 }
4355
4356 static void
4357 impl_window_add_update_area (GdkWindow *impl_window,
4358                              cairo_region_t *region)
4359 {
4360   if (impl_window->update_area)
4361     cairo_region_union (impl_window->update_area, region);
4362   else
4363     {
4364       gdk_window_add_update_window (impl_window);
4365       impl_window->update_area = cairo_region_copy (region);
4366       gdk_window_schedule_update (impl_window);
4367     }
4368 }
4369
4370 /* clear_bg controls if the region will be cleared to
4371  * the background pattern if the exposure mask is not
4372  * set for the window, whereas this might not otherwise be
4373  * done (unless necessary to emulate background settings).
4374  * Set this to CLEAR_BG_WINCLEARED or CLEAR_BG_ALL if you
4375  * need to clear the background, such as when exposing the area beneath a
4376  * hidden or moved window, but not when an app requests repaint or when the
4377  * windowing system exposes a newly visible area (because then the windowing
4378  * system has already cleared the area).
4379  */
4380 static void
4381 gdk_window_invalidate_maybe_recurse_full (GdkWindow            *window,
4382                                           const cairo_region_t *region,
4383                                           ClearBg               clear_bg,
4384                                           GdkWindowChildFunc    child_func,
4385                                           gpointer              user_data)
4386 {
4387   GdkWindow *impl_window;
4388   cairo_region_t *visible_region;
4389   GList *tmp_list;
4390
4391   g_return_if_fail (GDK_IS_WINDOW (window));
4392
4393   if (GDK_WINDOW_DESTROYED (window))
4394     return;
4395
4396   if (window->input_only ||
4397       !window->viewable ||
4398       cairo_region_is_empty (region) ||
4399       window->window_type == GDK_WINDOW_ROOT)
4400     return;
4401
4402   visible_region = gdk_window_get_visible_region (window);
4403   cairo_region_intersect (visible_region, region);
4404
4405   tmp_list = window->children;
4406   while (tmp_list)
4407     {
4408       GdkWindow *child = tmp_list->data;
4409
4410       if (!child->input_only)
4411         {
4412           cairo_region_t *child_region;
4413           GdkRectangle child_rect;
4414
4415           child_rect.x = child->x;
4416           child_rect.y = child->y;
4417           child_rect.width = child->width;
4418           child_rect.height = child->height;
4419           child_region = cairo_region_create_rectangle (&child_rect);
4420
4421           /* remove child area from the invalid area of the parent */
4422           if (GDK_WINDOW_IS_MAPPED (child) && !child->shaped &&
4423               !child->composited &&
4424               !gdk_window_is_offscreen (child))
4425             cairo_region_subtract (visible_region, child_region);
4426
4427           if (child_func && (*child_func) ((GdkWindow *)child, user_data))
4428             {
4429               cairo_region_t *tmp = cairo_region_copy (region);
4430
4431               cairo_region_translate (tmp, - child_rect.x, - child_rect.y);
4432               cairo_region_translate (child_region, - child_rect.x, - child_rect.y);
4433               cairo_region_intersect (child_region, tmp);
4434
4435               gdk_window_invalidate_maybe_recurse_full ((GdkWindow *)child,
4436                                                         child_region, clear_bg, child_func, user_data);
4437
4438               cairo_region_destroy (tmp);
4439             }
4440
4441           cairo_region_destroy (child_region);
4442         }
4443
4444       tmp_list = tmp_list->next;
4445     }
4446
4447   impl_window = gdk_window_get_impl_window (window);
4448
4449   if (!cairo_region_is_empty (visible_region)  ||
4450       /* Even if we're not exposing anything, make sure we process
4451          idles for windows with outstanding moves */
4452       (impl_window->outstanding_moves != NULL &&
4453        impl_window->update_area == NULL))
4454     {
4455       if (debug_updates)
4456         draw_ugly_color (window, region);
4457
4458       /* Convert to impl coords */
4459       cairo_region_translate (visible_region, window->abs_x, window->abs_y);
4460
4461       /* Only invalidate area if app requested expose events or if
4462          we need to clear the area (by request or to emulate background
4463          clearing for non-native windows or native windows with no support
4464          for window backgrounds */
4465       if (window->event_mask & GDK_EXPOSURE_MASK ||
4466           clear_bg == CLEAR_BG_ALL ||
4467           clear_bg == CLEAR_BG_WINCLEARED)
4468         impl_window_add_update_area (impl_window, visible_region);
4469     }
4470
4471   cairo_region_destroy (visible_region);
4472 }
4473
4474 /**
4475  * gdk_window_invalidate_maybe_recurse:
4476  * @window: a #GdkWindow
4477  * @region: a #cairo_region_t
4478  * @child_func: (scope call) (allow-none): function to use to decide if to
4479  *     recurse to a child, %NULL means never recurse.
4480  * @user_data: data passed to @child_func
4481  *
4482  * Adds @region to the update area for @window. The update area is the
4483  * region that needs to be redrawn, or "dirty region." The call
4484  * gdk_window_process_updates() sends one or more expose events to the
4485  * window, which together cover the entire update area. An
4486  * application would normally redraw the contents of @window in
4487  * response to those expose events.
4488  *
4489  * GDK will call gdk_window_process_all_updates() on your behalf
4490  * whenever your program returns to the main loop and becomes idle, so
4491  * normally there's no need to do that manually, you just need to
4492  * invalidate regions that you know should be redrawn.
4493  *
4494  * The @child_func parameter controls whether the region of
4495  * each child window that intersects @region will also be invalidated.
4496  * Only children for which @child_func returns TRUE will have the area
4497  * invalidated.
4498  **/
4499 void
4500 gdk_window_invalidate_maybe_recurse (GdkWindow            *window,
4501                                      const cairo_region_t *region,
4502                                      GdkWindowChildFunc    child_func,
4503                                      gpointer              user_data)
4504 {
4505   gdk_window_invalidate_maybe_recurse_full (window, region, CLEAR_BG_NONE,
4506                                             child_func, user_data);
4507 }
4508
4509 static gboolean
4510 true_predicate (GdkWindow *window,
4511                 gpointer   user_data)
4512 {
4513   return TRUE;
4514 }
4515
4516 static void
4517 gdk_window_invalidate_region_full (GdkWindow       *window,
4518                                     const cairo_region_t *region,
4519                                     gboolean         invalidate_children,
4520                                     ClearBg          clear_bg)
4521 {
4522   gdk_window_invalidate_maybe_recurse_full (window, region, clear_bg,
4523                                             invalidate_children ?
4524                                             true_predicate : (gboolean (*) (GdkWindow *, gpointer))NULL,
4525                                        NULL);
4526 }
4527
4528 /**
4529  * gdk_window_invalidate_region:
4530  * @window: a #GdkWindow
4531  * @region: a #cairo_region_t
4532  * @invalidate_children: %TRUE to also invalidate child windows
4533  *
4534  * Adds @region to the update area for @window. The update area is the
4535  * region that needs to be redrawn, or "dirty region." The call
4536  * gdk_window_process_updates() sends one or more expose events to the
4537  * window, which together cover the entire update area. An
4538  * application would normally redraw the contents of @window in
4539  * response to those expose events.
4540  *
4541  * GDK will call gdk_window_process_all_updates() on your behalf
4542  * whenever your program returns to the main loop and becomes idle, so
4543  * normally there's no need to do that manually, you just need to
4544  * invalidate regions that you know should be redrawn.
4545  *
4546  * The @invalidate_children parameter controls whether the region of
4547  * each child window that intersects @region will also be invalidated.
4548  * If %FALSE, then the update area for child windows will remain
4549  * unaffected. See gdk_window_invalidate_maybe_recurse if you need
4550  * fine grained control over which children are invalidated.
4551  **/
4552 void
4553 gdk_window_invalidate_region (GdkWindow       *window,
4554                               const cairo_region_t *region,
4555                               gboolean         invalidate_children)
4556 {
4557   gdk_window_invalidate_maybe_recurse (window, region,
4558                                        invalidate_children ?
4559                                          true_predicate : (gboolean (*) (GdkWindow *, gpointer))NULL,
4560                                        NULL);
4561 }
4562
4563 /**
4564  * _gdk_window_invalidate_for_expose:
4565  * @window: a #GdkWindow
4566  * @region: a #cairo_region_t
4567  *
4568  * Adds @region to the update area for @window. The update area is the
4569  * region that needs to be redrawn, or "dirty region." The call
4570  * gdk_window_process_updates() sends one or more expose events to the
4571  * window, which together cover the entire update area. An
4572  * application would normally redraw the contents of @window in
4573  * response to those expose events.
4574  *
4575  * GDK will call gdk_window_process_all_updates() on your behalf
4576  * whenever your program returns to the main loop and becomes idle, so
4577  * normally there's no need to do that manually, you just need to
4578  * invalidate regions that you know should be redrawn.
4579  *
4580  * This version of invalidation is used when you recieve expose events
4581  * from the native window system. It exposes the native window, plus
4582  * any non-native child windows (but not native child windows, as those would
4583  * have gotten their own expose events).
4584  **/
4585 void
4586 _gdk_window_invalidate_for_expose (GdkWindow       *window,
4587                                    cairo_region_t       *region)
4588 {
4589   GdkWindowRegionMove *move;
4590   cairo_region_t *move_region;
4591   GList *l;
4592
4593   /* Any invalidations comming from the windowing system will
4594      be in areas that may be moved by outstanding moves,
4595      so we need to modify the expose region correspondingly,
4596      otherwise we would expose in the wrong place, as the
4597      outstanding moves will be copied before we draw the
4598      exposes. */
4599   for (l = window->outstanding_moves; l != NULL; l = l->next)
4600     {
4601       move = l->data;
4602
4603       /* covert to move source region */
4604       move_region = cairo_region_copy (move->dest_region);
4605       cairo_region_translate (move_region, -move->dx, -move->dy);
4606
4607       /* Move area of region that intersects with move source
4608          by dx, dy of the move*/
4609       cairo_region_intersect (move_region, region);
4610       cairo_region_subtract (region, move_region);
4611       cairo_region_translate (move_region, move->dx, move->dy);
4612       cairo_region_union (region, move_region);
4613
4614       cairo_region_destroy (move_region);
4615     }
4616
4617   gdk_window_invalidate_maybe_recurse_full (window, region, CLEAR_BG_WINCLEARED,
4618                                             (gboolean (*) (GdkWindow *, gpointer))gdk_window_has_no_impl,
4619                                             NULL);
4620 }
4621
4622
4623 /**
4624  * gdk_window_get_update_area:
4625  * @window: a #GdkWindow
4626  *
4627  * Transfers ownership of the update area from @window to the caller
4628  * of the function. That is, after calling this function, @window will
4629  * no longer have an invalid/dirty region; the update area is removed
4630  * from @window and handed to you. If a window has no update area,
4631  * gdk_window_get_update_area() returns %NULL. You are responsible for
4632  * calling cairo_region_destroy() on the returned region if it's non-%NULL.
4633  *
4634  * Return value: the update area for @window
4635  **/
4636 cairo_region_t *
4637 gdk_window_get_update_area (GdkWindow *window)
4638 {
4639   GdkWindow *impl_window;
4640   cairo_region_t *tmp_region, *to_remove;
4641
4642   g_return_val_if_fail (GDK_IS_WINDOW (window), NULL);
4643
4644   impl_window = gdk_window_get_impl_window (window);
4645
4646   if (impl_window->update_area)
4647     {
4648       tmp_region = cairo_region_copy (window->clip_region_with_children);
4649       /* Convert to impl coords */
4650       cairo_region_translate (tmp_region, window->abs_x, window->abs_y);
4651       cairo_region_intersect (tmp_region, impl_window->update_area);
4652
4653       if (cairo_region_is_empty (tmp_region))
4654         {
4655           cairo_region_destroy (tmp_region);
4656           return NULL;
4657         }
4658       else
4659         {
4660           /* Convert from impl coords */
4661           cairo_region_translate (tmp_region, -window->abs_x, -window->abs_y);
4662
4663           /* Don't remove any update area that is overlapped by non-opaque windows
4664              (children or siblings) with alpha, as these really need to be repainted
4665              independently of this window. */
4666           to_remove = cairo_region_copy (tmp_region);
4667           cairo_region_subtract (to_remove, window->parent->layered_region);
4668           remove_layered_child_area (window, to_remove);
4669
4670           /* Remove from update_area */
4671           cairo_region_translate (to_remove, window->abs_x, window->abs_y);
4672           cairo_region_subtract (impl_window->update_area, to_remove);
4673
4674           cairo_region_destroy (to_remove);
4675
4676           if (cairo_region_is_empty (impl_window->update_area) &&
4677               impl_window->outstanding_moves == NULL)
4678             {
4679               cairo_region_destroy (impl_window->update_area);
4680               impl_window->update_area = NULL;
4681
4682               gdk_window_remove_update_window ((GdkWindow *)impl_window);
4683             }
4684
4685           return tmp_region;
4686         }
4687     }
4688   else
4689     return NULL;
4690 }
4691
4692 /**
4693  * _gdk_window_clear_update_area:
4694  * @window: a #GdkWindow.
4695  *
4696  * Internal function to clear the update area for a window. This
4697  * is called when the window is hidden or destroyed.
4698  **/
4699 void
4700 _gdk_window_clear_update_area (GdkWindow *window)
4701 {
4702   g_return_if_fail (GDK_IS_WINDOW (window));
4703
4704   if (window->update_area)
4705     {
4706       gdk_window_remove_update_window (window);
4707
4708       cairo_region_destroy (window->update_area);
4709       window->update_area = NULL;
4710     }
4711 }
4712
4713 /**
4714  * gdk_window_freeze_updates:
4715  * @window: a #GdkWindow
4716  *
4717  * Temporarily freezes a window such that it won't receive expose
4718  * events.  The window will begin receiving expose events again when
4719  * gdk_window_thaw_updates() is called. If gdk_window_freeze_updates()
4720  * has been called more than once, gdk_window_thaw_updates() must be called
4721  * an equal number of times to begin processing exposes.
4722  **/
4723 void
4724 gdk_window_freeze_updates (GdkWindow *window)
4725 {
4726   GdkWindow *impl_window;
4727
4728   g_return_if_fail (GDK_IS_WINDOW (window));
4729
4730   impl_window = gdk_window_get_impl_window (window);
4731   impl_window->update_freeze_count++;
4732 }
4733
4734 /**
4735  * gdk_window_thaw_updates:
4736  * @window: a #GdkWindow
4737  *
4738  * Thaws a window frozen with gdk_window_freeze_updates().
4739  **/
4740 void
4741 gdk_window_thaw_updates (GdkWindow *window)
4742 {
4743   GdkWindow *impl_window;
4744
4745   g_return_if_fail (GDK_IS_WINDOW (window));
4746
4747   impl_window = gdk_window_get_impl_window (window);
4748
4749   g_return_if_fail (impl_window->update_freeze_count > 0);
4750
4751   if (--impl_window->update_freeze_count == 0)
4752     gdk_window_schedule_update (GDK_WINDOW (impl_window));
4753 }
4754
4755 /**
4756  * gdk_window_freeze_toplevel_updates_libgtk_only:
4757  * @window: a #GdkWindow
4758  *
4759  * Temporarily freezes a window and all its descendants such that it won't
4760  * receive expose events.  The window will begin receiving expose events
4761  * again when gdk_window_thaw_toplevel_updates_libgtk_only() is called. If
4762  * gdk_window_freeze_toplevel_updates_libgtk_only()
4763  * has been called more than once,
4764  * gdk_window_thaw_toplevel_updates_libgtk_only() must be called
4765  * an equal number of times to begin processing exposes.
4766  *
4767  * This function is not part of the GDK public API and is only
4768  * for use by GTK+.
4769  **/
4770 void
4771 gdk_window_freeze_toplevel_updates_libgtk_only (GdkWindow *window)
4772 {
4773   g_return_if_fail (GDK_IS_WINDOW (window));
4774   g_return_if_fail (window->window_type != GDK_WINDOW_CHILD);
4775
4776   window->update_and_descendants_freeze_count++;
4777 }
4778
4779 /**
4780  * gdk_window_thaw_toplevel_updates_libgtk_only:
4781  * @window: a #GdkWindow
4782  *
4783  * Thaws a window frozen with
4784  * gdk_window_freeze_toplevel_updates_libgtk_only().
4785  *
4786  * This function is not part of the GDK public API and is only
4787  * for use by GTK+.
4788  **/
4789 void
4790 gdk_window_thaw_toplevel_updates_libgtk_only (GdkWindow *window)
4791 {
4792   g_return_if_fail (GDK_IS_WINDOW (window));
4793   g_return_if_fail (window->window_type != GDK_WINDOW_CHILD);
4794   g_return_if_fail (window->update_and_descendants_freeze_count > 0);
4795
4796   window->update_and_descendants_freeze_count--;
4797
4798   gdk_window_schedule_update (window);
4799 }
4800
4801 /**
4802  * gdk_window_set_debug_updates:
4803  * @setting: %TRUE to turn on update debugging
4804  *
4805  * With update debugging enabled, calls to
4806  * gdk_window_invalidate_region() clear the invalidated region of the
4807  * screen to a noticeable color, and GDK pauses for a short time
4808  * before sending exposes to windows during
4809  * gdk_window_process_updates().  The net effect is that you can see
4810  * the invalid region for each window and watch redraws as they
4811  * occur. This allows you to diagnose inefficiencies in your application.
4812  *
4813  * In essence, because the GDK rendering model prevents all flicker,
4814  * if you are redrawing the same region 400 times you may never
4815  * notice, aside from noticing a speed problem. Enabling update
4816  * debugging causes GTK to flicker slowly and noticeably, so you can
4817  * see exactly what's being redrawn when, in what order.
4818  *
4819  * The --gtk-debug=updates command line option passed to GTK+ programs
4820  * enables this debug option at application startup time. That's
4821  * usually more useful than calling gdk_window_set_debug_updates()
4822  * yourself, though you might want to use this function to enable
4823  * updates sometime after application startup time.
4824  *
4825  **/
4826 void
4827 gdk_window_set_debug_updates (gboolean setting)
4828 {
4829   debug_updates = setting;
4830 }
4831
4832 /**
4833  * gdk_window_constrain_size:
4834  * @geometry: a #GdkGeometry structure
4835  * @flags: a mask indicating what portions of @geometry are set
4836  * @width: desired width of window
4837  * @height: desired height of the window
4838  * @new_width: (out): location to store resulting width
4839  * @new_height: (out): location to store resulting height
4840  *
4841  * Constrains a desired width and height according to a
4842  * set of geometry hints (such as minimum and maximum size).
4843  */
4844 void
4845 gdk_window_constrain_size (GdkGeometry *geometry,
4846                            guint        flags,
4847                            gint         width,
4848                            gint         height,
4849                            gint        *new_width,
4850                            gint        *new_height)
4851 {
4852   /* This routine is partially borrowed from fvwm.
4853    *
4854    * Copyright 1993, Robert Nation
4855    *     You may use this code for any purpose, as long as the original
4856    *     copyright remains in the source code and all documentation
4857    *
4858    * which in turn borrows parts of the algorithm from uwm
4859    */
4860   gint min_width = 0;
4861   gint min_height = 0;
4862   gint base_width = 0;
4863   gint base_height = 0;
4864   gint xinc = 1;
4865   gint yinc = 1;
4866   gint max_width = G_MAXINT;
4867   gint max_height = G_MAXINT;
4868
4869 #define FLOOR(value, base)      ( ((gint) ((value) / (base))) * (base) )
4870
4871   if ((flags & GDK_HINT_BASE_SIZE) && (flags & GDK_HINT_MIN_SIZE))
4872     {
4873       base_width = geometry->base_width;
4874       base_height = geometry->base_height;
4875       min_width = geometry->min_width;
4876       min_height = geometry->min_height;
4877     }
4878   else if (flags & GDK_HINT_BASE_SIZE)
4879     {
4880       base_width = geometry->base_width;
4881       base_height = geometry->base_height;
4882       min_width = geometry->base_width;
4883       min_height = geometry->base_height;
4884     }
4885   else if (flags & GDK_HINT_MIN_SIZE)
4886     {
4887       base_width = geometry->min_width;
4888       base_height = geometry->min_height;
4889       min_width = geometry->min_width;
4890       min_height = geometry->min_height;
4891     }
4892
4893   if (flags & GDK_HINT_MAX_SIZE)
4894     {
4895       max_width = geometry->max_width ;
4896       max_height = geometry->max_height;
4897     }
4898
4899   if (flags & GDK_HINT_RESIZE_INC)
4900     {
4901       xinc = MAX (xinc, geometry->width_inc);
4902       yinc = MAX (yinc, geometry->height_inc);
4903     }
4904
4905   /* clamp width and height to min and max values
4906    */
4907   width = CLAMP (width, min_width, max_width);
4908   height = CLAMP (height, min_height, max_height);
4909
4910   /* shrink to base + N * inc
4911    */
4912   width = base_width + FLOOR (width - base_width, xinc);
4913   height = base_height + FLOOR (height - base_height, yinc);
4914
4915   /* constrain aspect ratio, according to:
4916    *
4917    *                width
4918    * min_aspect <= -------- <= max_aspect
4919    *                height
4920    */
4921
4922   if (flags & GDK_HINT_ASPECT &&
4923       geometry->min_aspect > 0 &&
4924       geometry->max_aspect > 0)
4925     {
4926       gint delta;
4927
4928       if (geometry->min_aspect * height > width)
4929         {
4930           delta = FLOOR (height - width / geometry->min_aspect, yinc);
4931           if (height - delta >= min_height)
4932             height -= delta;
4933           else
4934             {
4935               delta = FLOOR (height * geometry->min_aspect - width, xinc);
4936               if (width + delta <= max_width)
4937                 width += delta;
4938             }
4939         }
4940
4941       if (geometry->max_aspect * height < width)
4942         {
4943           delta = FLOOR (width - height * geometry->max_aspect, xinc);
4944           if (width - delta >= min_width)
4945             width -= delta;
4946           else
4947             {
4948               delta = FLOOR (width / geometry->max_aspect - height, yinc);
4949               if (height + delta <= max_height)
4950                 height += delta;
4951             }
4952         }
4953     }
4954
4955 #undef FLOOR
4956
4957   *new_width = width;
4958   *new_height = height;
4959 }
4960
4961 /**
4962  * gdk_window_get_pointer:
4963  * @window: a #GdkWindow
4964  * @x: (out) (allow-none): return location for X coordinate of pointer or %NULL to not
4965  *      return the X coordinate
4966  * @y: (out) (allow-none):  return location for Y coordinate of pointer or %NULL to not
4967  *      return the Y coordinate
4968  * @mask: (out) (allow-none): return location for modifier mask or %NULL to not return the
4969  *      modifier mask
4970  *
4971  * Obtains the current pointer position and modifier state.
4972  * The position is given in coordinates relative to the upper left
4973  * corner of @window.
4974  *
4975  * Return value: (transfer none): the window containing the pointer (as with
4976  * gdk_window_at_pointer()), or %NULL if the window containing the
4977  * pointer isn't known to GDK
4978  *
4979  * Deprecated: 3.0: Use gdk_window_get_device_position() instead.
4980  **/
4981 GdkWindow*
4982 gdk_window_get_pointer (GdkWindow         *window,
4983                         gint              *x,
4984                         gint              *y,
4985                         GdkModifierType   *mask)
4986 {
4987   GdkDisplay *display;
4988
4989   g_return_val_if_fail (GDK_IS_WINDOW (window), NULL);
4990
4991   display = gdk_window_get_display (window);
4992
4993   return gdk_window_get_device_position (window, display->core_pointer, x, y, mask);
4994 }
4995
4996 /**
4997  * gdk_window_get_device_position:
4998  * @window: a #GdkWindow.
4999  * @device: pointer #GdkDevice to query to.
5000  * @x: (out) (allow-none): return location for the X coordinate of @device, or %NULL.
5001  * @y: (out) (allow-none): return location for the Y coordinate of @device, or %NULL.
5002  * @mask: (out) (allow-none): return location for the modifier mask, or %NULL.
5003  *
5004  * Obtains the current device position and modifier state.
5005  * The position is given in coordinates relative to the upper left
5006  * corner of @window.
5007  *
5008  * Return value: (transfer none): The window underneath @device (as with
5009  * gdk_device_get_window_at_position()), or %NULL if the window is not known to GDK.
5010  *
5011  * Since: 3.0
5012  **/
5013 GdkWindow *
5014 gdk_window_get_device_position (GdkWindow       *window,
5015                                 GdkDevice       *device,
5016                                 gint            *x,
5017                                 gint            *y,
5018                                 GdkModifierType *mask)
5019 {
5020   gint tmp_x, tmp_y;
5021   GdkModifierType tmp_mask;
5022   gboolean normal_child;
5023
5024   g_return_val_if_fail (GDK_IS_WINDOW (window), NULL);
5025   g_return_val_if_fail (GDK_IS_DEVICE (device), NULL);
5026   g_return_val_if_fail (gdk_device_get_source (device) != GDK_SOURCE_KEYBOARD, NULL);
5027
5028   normal_child = GDK_WINDOW_IMPL_GET_CLASS (window->impl)->get_device_state (window,
5029                                                                              device,
5030                                                                              &tmp_x, &tmp_y,
5031                                                                              &tmp_mask);
5032   /* We got the coords on the impl, convert to the window */
5033   tmp_x -= window->abs_x;
5034   tmp_y -= window->abs_y;
5035
5036   if (x)
5037     *x = tmp_x;
5038   if (y)
5039     *y = tmp_y;
5040   if (mask)
5041     *mask = tmp_mask;
5042
5043   _gdk_display_enable_motion_hints (gdk_window_get_display (window), device);
5044
5045   if (normal_child)
5046     return _gdk_window_find_child_at (window, tmp_x, tmp_y);
5047   return NULL;
5048 }
5049
5050 /**
5051  * gdk_get_default_root_window:
5052  *
5053  * Obtains the root window (parent all other windows are inside)
5054  * for the default display and screen.
5055  *
5056  * Return value: (transfer none): the default root window
5057  **/
5058 GdkWindow *
5059 gdk_get_default_root_window (void)
5060 {
5061   return gdk_screen_get_root_window (gdk_screen_get_default ());
5062 }
5063
5064 static void
5065 get_all_native_children (GdkWindow *window,
5066                          GList **native)
5067 {
5068   GdkWindow *child;
5069   GList *l;
5070
5071   for (l = window->children; l != NULL; l = l->next)
5072     {
5073       child = l->data;
5074
5075       if (gdk_window_has_impl (child))
5076         *native = g_list_prepend (*native, child);
5077       else
5078         get_all_native_children (child, native);
5079     }
5080 }
5081
5082
5083 static inline void
5084 gdk_window_raise_internal (GdkWindow *window)
5085 {
5086   GdkWindow *parent = window->parent;
5087   GdkWindow *above;
5088   GList *native_children;
5089   GList *l, listhead;
5090   GdkWindowImplClass *impl_class;
5091
5092   if (parent)
5093     {
5094       parent->children = g_list_remove (parent->children, window);
5095       parent->children = g_list_prepend (parent->children, window);
5096     }
5097
5098   impl_class = GDK_WINDOW_IMPL_GET_CLASS (window->impl);
5099   /* Just do native raise for toplevels */
5100   if (gdk_window_is_toplevel (window) ||
5101       /* The restack_under codepath should work correctly even if the parent
5102          is native, but it relies on the order of ->children to be correct,
5103          and some apps like SWT reorder the x windows without gdks knowledge,
5104          so we use raise directly in order to make these behave as before
5105          when using native windows */
5106       (gdk_window_has_impl (window) && gdk_window_has_impl (parent)))
5107     {
5108       impl_class->raise (window);
5109     }
5110   else if (gdk_window_has_impl (window))
5111     {
5112       above = find_native_sibling_above (parent, window);
5113       if (above)
5114         {
5115           listhead.data = window;
5116           listhead.next = NULL;
5117           listhead.prev = NULL;
5118           impl_class->restack_under ((GdkWindow *)above,
5119                                      &listhead);
5120         }
5121       else
5122         impl_class->raise (window);
5123     }
5124   else
5125     {
5126       native_children = NULL;
5127       get_all_native_children (window, &native_children);
5128       if (native_children != NULL)
5129         {
5130           above = find_native_sibling_above (parent, window);
5131
5132           if (above)
5133             impl_class->restack_under (above, native_children);
5134           else
5135             {
5136               /* Right order, since native_children is bottom-topmost first */
5137               for (l = native_children; l != NULL; l = l->next)
5138                 impl_class->raise (l->data);
5139             }
5140
5141           g_list_free (native_children);
5142         }
5143
5144     }
5145 }
5146
5147 /* Returns TRUE If the native window was mapped or unmapped */
5148 static gboolean
5149 set_viewable (GdkWindow *w,
5150               gboolean val)
5151 {
5152   GdkWindow *child;
5153   GdkWindowImplClass *impl_class;
5154   GList *l;
5155
5156   if (w->viewable == val)
5157     return FALSE;
5158
5159   w->viewable = val;
5160
5161   if (val)
5162     recompute_visible_regions (w, FALSE, FALSE);
5163
5164   for (l = w->children; l != NULL; l = l->next)
5165     {
5166       child = l->data;
5167
5168       if (GDK_WINDOW_IS_MAPPED (child) &&
5169           child->window_type != GDK_WINDOW_FOREIGN)
5170         set_viewable (child, val);
5171     }
5172
5173   if (gdk_window_has_impl (w)  &&
5174       w->window_type != GDK_WINDOW_FOREIGN &&
5175       !gdk_window_is_toplevel (w))
5176     {
5177       /* For most native windows we show/hide them not when they are
5178        * mapped/unmapped, because that may not produce the correct results.
5179        * For instance, if a native window have a non-native parent which is
5180        * hidden, but its native parent is viewable then showing the window
5181        * would make it viewable to X but its not viewable wrt the non-native
5182        * hierarchy. In order to handle this we track the gdk side viewability
5183        * and only map really viewable windows.
5184        *
5185        * There are two exceptions though:
5186        *
5187        * For foreign windows we don't want ever change the mapped state
5188        * except when explicitly done via gdk_window_show/hide, as this may
5189        * cause problems for client owning the foreign window when its window
5190        * is suddenly mapped or unmapped.
5191        *
5192        * For toplevel windows embedded in a foreign window (e.g. a plug)
5193        * we sometimes synthesize a map of a window, but the native
5194        * window is really shown by the embedder, so we don't want to
5195        * do the show ourselves. We can't really tell this case from the normal
5196        * toplevel show as such toplevels are seen by gdk as parents of the
5197        * root window, so we make an exception for all toplevels.
5198        */
5199
5200       impl_class = GDK_WINDOW_IMPL_GET_CLASS (w->impl);
5201       if (val)
5202         impl_class->show ((GdkWindow *)w, FALSE);
5203       else
5204         impl_class->hide ((GdkWindow *)w);
5205
5206       return TRUE;
5207     }
5208
5209   return FALSE;
5210 }
5211
5212 /* Returns TRUE If the native window was mapped or unmapped */
5213 gboolean
5214 _gdk_window_update_viewable (GdkWindow *window)
5215 {
5216   gboolean viewable;
5217
5218   if (window->window_type == GDK_WINDOW_FOREIGN ||
5219       window->window_type == GDK_WINDOW_ROOT)
5220     viewable = TRUE;
5221   else if (gdk_window_is_toplevel (window) ||
5222            window->parent->viewable)
5223     viewable = GDK_WINDOW_IS_MAPPED (window);
5224   else
5225     viewable = FALSE;
5226
5227   return set_viewable (window, viewable);
5228 }
5229
5230 static void
5231 gdk_window_show_internal (GdkWindow *window, gboolean raise)
5232 {
5233   GdkWindowImplClass *impl_class;
5234   gboolean was_mapped, was_viewable;
5235   gboolean did_show;
5236
5237   g_return_if_fail (GDK_IS_WINDOW (window));
5238
5239   if (window->destroyed)
5240     return;
5241
5242   was_mapped = GDK_WINDOW_IS_MAPPED (window);
5243   was_viewable = window->viewable;
5244
5245   if (raise)
5246     /* Keep children in (reverse) stacking order */
5247     gdk_window_raise_internal (window);
5248
5249   if (gdk_window_has_impl (window))
5250     {
5251       if (!was_mapped)
5252         gdk_synthesize_window_state (window,
5253                                      GDK_WINDOW_STATE_WITHDRAWN,
5254                                      GDK_WINDOW_STATE_FOCUSED);
5255     }
5256   else
5257     {
5258       window->state = 0;
5259     }
5260
5261   did_show = _gdk_window_update_viewable (window);
5262
5263   /* If it was already viewable the backend show op won't be called, call it
5264      again to ensure things happen right if the mapped tracking was not right
5265      for e.g. a foreign window.
5266      Dunno if this is strictly needed but its what happened pre-csw.
5267      Also show if not done by gdk_window_update_viewable. */
5268   if (gdk_window_has_impl (window) && (was_viewable || !did_show))
5269     {
5270       impl_class = GDK_WINDOW_IMPL_GET_CLASS (window->impl);
5271       impl_class->show (window, !did_show ? was_mapped : TRUE);
5272     }
5273
5274   if (!was_mapped && !gdk_window_has_impl (window))
5275     {
5276       if (window->event_mask & GDK_STRUCTURE_MASK)
5277         _gdk_make_event (window, GDK_MAP, NULL, FALSE);
5278
5279       if (window->parent && window->parent->event_mask & GDK_SUBSTRUCTURE_MASK)
5280         _gdk_make_event (window, GDK_MAP, NULL, FALSE);
5281     }
5282
5283   if (!was_mapped || raise)
5284     {
5285       recompute_visible_regions (window, TRUE, FALSE);
5286
5287       /* If any decendants became visible we need to send visibility notify */
5288       gdk_window_update_visibility_recursively (window, NULL);
5289
5290       if (gdk_window_is_viewable (window))
5291         {
5292           _gdk_synthesize_crossing_events_for_geometry_change (window);
5293           gdk_window_invalidate_rect_full (window, NULL, TRUE, CLEAR_BG_ALL);
5294         }
5295     }
5296 }
5297
5298 /**
5299  * gdk_window_show_unraised:
5300  * @window: a #GdkWindow
5301  *
5302  * Shows a #GdkWindow onscreen, but does not modify its stacking
5303  * order. In contrast, gdk_window_show() will raise the window
5304  * to the top of the window stack.
5305  *
5306  * On the X11 platform, in Xlib terms, this function calls
5307  * XMapWindow() (it also updates some internal GDK state, which means
5308  * that you can't really use XMapWindow() directly on a GDK window).
5309  */
5310 void
5311 gdk_window_show_unraised (GdkWindow *window)
5312 {
5313   gdk_window_show_internal (window, FALSE);
5314 }
5315
5316 /**
5317  * gdk_window_raise:
5318  * @window: a #GdkWindow
5319  *
5320  * Raises @window to the top of the Z-order (stacking order), so that
5321  * other windows with the same parent window appear below @window.
5322  * This is true whether or not the windows are visible.
5323  *
5324  * If @window is a toplevel, the window manager may choose to deny the
5325  * request to move the window in the Z-order, gdk_window_raise() only
5326  * requests the restack, does not guarantee it.
5327  */
5328 void
5329 gdk_window_raise (GdkWindow *window)
5330 {
5331   g_return_if_fail (GDK_IS_WINDOW (window));
5332
5333   if (window->destroyed)
5334     return;
5335
5336   gdk_window_flush_if_exposing (window);
5337
5338   /* Keep children in (reverse) stacking order */
5339   gdk_window_raise_internal (window);
5340
5341   recompute_visible_regions (window, TRUE, FALSE);
5342
5343   if (gdk_window_is_viewable (window) &&
5344       !window->input_only)
5345     gdk_window_invalidate_region_full (window, window->clip_region, TRUE, CLEAR_BG_ALL);
5346 }
5347
5348 static void
5349 gdk_window_lower_internal (GdkWindow *window)
5350 {
5351   GdkWindow *parent = window->parent;
5352   GdkWindowImplClass *impl_class;
5353   GdkWindow *above;
5354   GList *native_children;
5355   GList *l, listhead;
5356
5357   if (parent)
5358     {
5359       parent->children = g_list_remove (parent->children, window);
5360       parent->children = g_list_append (parent->children, window);
5361     }
5362
5363   impl_class = GDK_WINDOW_IMPL_GET_CLASS (window->impl);
5364   /* Just do native lower for toplevels */
5365   if (gdk_window_is_toplevel (window) ||
5366       /* The restack_under codepath should work correctly even if the parent
5367          is native, but it relies on the order of ->children to be correct,
5368          and some apps like SWT reorder the x windows without gdks knowledge,
5369          so we use lower directly in order to make these behave as before
5370          when using native windows */
5371       (gdk_window_has_impl (window) && gdk_window_has_impl (parent)))
5372     {
5373       impl_class->lower (window);
5374     }
5375   else if (gdk_window_has_impl (window))
5376     {
5377       above = find_native_sibling_above (parent, window);
5378       if (above)
5379         {
5380           listhead.data = window;
5381           listhead.next = NULL;
5382           listhead.prev = NULL;
5383           impl_class->restack_under ((GdkWindow *)above, &listhead);
5384         }
5385       else
5386         impl_class->raise (window);
5387     }
5388   else
5389     {
5390       native_children = NULL;
5391       get_all_native_children (window, &native_children);
5392       if (native_children != NULL)
5393         {
5394           above = find_native_sibling_above (parent, window);
5395
5396           if (above)
5397             impl_class->restack_under ((GdkWindow *)above,
5398                                        native_children);
5399           else
5400             {
5401               /* Right order, since native_children is bottom-topmost first */
5402               for (l = native_children; l != NULL; l = l->next)
5403                 impl_class->raise (l->data);
5404             }
5405
5406           g_list_free (native_children);
5407         }
5408
5409     }
5410 }
5411
5412 static void
5413 gdk_window_invalidate_in_parent (GdkWindow *private)
5414 {
5415   GdkRectangle r, child;
5416
5417   if (gdk_window_is_toplevel (private))
5418     return;
5419
5420   /* get the visible rectangle of the parent */
5421   r.x = r.y = 0;
5422   r.width = private->parent->width;
5423   r.height = private->parent->height;
5424
5425   child.x = private->x;
5426   child.y = private->y;
5427   child.width = private->width;
5428   child.height = private->height;
5429   gdk_rectangle_intersect (&r, &child, &r);
5430
5431   gdk_window_invalidate_rect_full (private->parent, &r, TRUE, CLEAR_BG_ALL);
5432 }
5433
5434
5435 /**
5436  * gdk_window_lower:
5437  * @window: a #GdkWindow
5438  *
5439  * Lowers @window to the bottom of the Z-order (stacking order), so that
5440  * other windows with the same parent window appear above @window.
5441  * This is true whether or not the other windows are visible.
5442  *
5443  * If @window is a toplevel, the window manager may choose to deny the
5444  * request to move the window in the Z-order, gdk_window_lower() only
5445  * requests the restack, does not guarantee it.
5446  *
5447  * Note that gdk_window_show() raises the window again, so don't call this
5448  * function before gdk_window_show(). (Try gdk_window_show_unraised().)
5449  */
5450 void
5451 gdk_window_lower (GdkWindow *window)
5452 {
5453   g_return_if_fail (GDK_IS_WINDOW (window));
5454
5455   if (window->destroyed)
5456     return;
5457
5458   gdk_window_flush_if_exposing (window);
5459
5460   /* Keep children in (reverse) stacking order */
5461   gdk_window_lower_internal (window);
5462
5463   recompute_visible_regions (window, TRUE, FALSE);
5464
5465   _gdk_synthesize_crossing_events_for_geometry_change (window);
5466   gdk_window_invalidate_in_parent (window);
5467 }
5468
5469 /**
5470  * gdk_window_restack:
5471  * @window: a #GdkWindow
5472  * @sibling: (allow-none): a #GdkWindow that is a sibling of @window, or %NULL
5473  * @above: a boolean
5474  *
5475  * Changes the position of  @window in the Z-order (stacking order), so that
5476  * it is above @sibling (if @above is %TRUE) or below @sibling (if @above is
5477  * %FALSE).
5478  *
5479  * If @sibling is %NULL, then this either raises (if @above is %TRUE) or
5480  * lowers the window.
5481  *
5482  * If @window is a toplevel, the window manager may choose to deny the
5483  * request to move the window in the Z-order, gdk_window_restack() only
5484  * requests the restack, does not guarantee it.
5485  *
5486  * Since: 2.18
5487  */
5488 void
5489 gdk_window_restack (GdkWindow     *window,
5490                     GdkWindow     *sibling,
5491                     gboolean       above)
5492 {
5493   GdkWindowImplClass *impl_class;
5494   GdkWindow *parent;
5495   GdkWindow *above_native;
5496   GList *sibling_link;
5497   GList *native_children;
5498   GList *l, listhead;
5499
5500   g_return_if_fail (GDK_IS_WINDOW (window));
5501   g_return_if_fail (sibling == NULL || GDK_IS_WINDOW (sibling));
5502
5503   if (window->destroyed)
5504     return;
5505
5506   if (sibling == NULL)
5507     {
5508       if (above)
5509         gdk_window_raise (window);
5510       else
5511         gdk_window_lower (window);
5512       return;
5513     }
5514
5515   gdk_window_flush_if_exposing (window);
5516
5517   if (gdk_window_is_toplevel (window))
5518     {
5519       g_return_if_fail (gdk_window_is_toplevel (sibling));
5520       impl_class = GDK_WINDOW_IMPL_GET_CLASS (window->impl);
5521       impl_class->restack_toplevel (window, sibling, above);
5522       return;
5523     }
5524
5525   parent = window->parent;
5526   if (parent)
5527     {
5528       sibling_link = g_list_find (parent->children, sibling);
5529       g_return_if_fail (sibling_link != NULL);
5530       if (sibling_link == NULL)
5531         return;
5532
5533       parent->children = g_list_remove (parent->children, window);
5534       if (above)
5535         parent->children = g_list_insert_before (parent->children,
5536                                                  sibling_link,
5537                                                  window);
5538       else
5539         parent->children = g_list_insert_before (parent->children,
5540                                                  sibling_link->next,
5541                                                  window);
5542
5543       impl_class = GDK_WINDOW_IMPL_GET_CLASS (window->impl);
5544       if (gdk_window_has_impl (window))
5545         {
5546           above_native = find_native_sibling_above (parent, window);
5547           if (above_native)
5548             {
5549               listhead.data = window;
5550               listhead.next = NULL;
5551               listhead.prev = NULL;
5552               impl_class->restack_under (above_native, &listhead);
5553             }
5554           else
5555             impl_class->raise (window);
5556         }
5557       else
5558         {
5559           native_children = NULL;
5560           get_all_native_children (window, &native_children);
5561           if (native_children != NULL)
5562             {
5563               above_native = find_native_sibling_above (parent, window);
5564               if (above_native)
5565                 impl_class->restack_under (above_native,
5566                                            native_children);
5567               else
5568                 {
5569                   /* Right order, since native_children is bottom-topmost first */
5570                   for (l = native_children; l != NULL; l = l->next)
5571                     impl_class->raise (l->data);
5572                 }
5573
5574               g_list_free (native_children);
5575             }
5576         }
5577     }
5578
5579   recompute_visible_regions (window, TRUE, FALSE);
5580
5581   _gdk_synthesize_crossing_events_for_geometry_change (window);
5582   gdk_window_invalidate_in_parent (window);
5583 }
5584
5585
5586 /**
5587  * gdk_window_show:
5588  * @window: a #GdkWindow
5589  *
5590  * Like gdk_window_show_unraised(), but also raises the window to the
5591  * top of the window stack (moves the window to the front of the
5592  * Z-order).
5593  *
5594  * This function maps a window so it's visible onscreen. Its opposite
5595  * is gdk_window_hide().
5596  *
5597  * When implementing a #GtkWidget, you should call this function on the widget's
5598  * #GdkWindow as part of the "map" method.
5599  */
5600 void
5601 gdk_window_show (GdkWindow *window)
5602 {
5603   gdk_window_show_internal (window, TRUE);
5604 }
5605
5606 /**
5607  * gdk_window_hide:
5608  * @window: a #GdkWindow
5609  *
5610  * For toplevel windows, withdraws them, so they will no longer be
5611  * known to the window manager; for all windows, unmaps them, so
5612  * they won't be displayed. Normally done automatically as
5613  * part of gtk_widget_hide().
5614  */
5615 void
5616 gdk_window_hide (GdkWindow *window)
5617 {
5618   GdkWindowImplClass *impl_class;
5619   gboolean was_mapped, did_hide;
5620
5621   g_return_if_fail (GDK_IS_WINDOW (window));
5622
5623   if (window->destroyed)
5624     return;
5625
5626   was_mapped = GDK_WINDOW_IS_MAPPED (window);
5627
5628   if (gdk_window_has_impl (window))
5629     {
5630
5631       if (GDK_WINDOW_IS_MAPPED (window))
5632         gdk_synthesize_window_state (window,
5633                                      0,
5634                                      GDK_WINDOW_STATE_WITHDRAWN);
5635     }
5636   else if (was_mapped)
5637     {
5638       GdkDisplay *display;
5639       GdkDeviceManager *device_manager;
5640       GList *devices, *d;
5641
5642       /* May need to break grabs on children */
5643       display = gdk_window_get_display (window);
5644       device_manager = gdk_display_get_device_manager (display);
5645
5646       /* Get all devices */
5647       devices = gdk_device_manager_list_devices (device_manager, GDK_DEVICE_TYPE_MASTER);
5648       devices = g_list_concat (devices, gdk_device_manager_list_devices (device_manager, GDK_DEVICE_TYPE_SLAVE));
5649       devices = g_list_concat (devices, gdk_device_manager_list_devices (device_manager, GDK_DEVICE_TYPE_FLOATING));
5650
5651       for (d = devices; d; d = d->next)
5652         {
5653           GdkDevice *device = d->data;
5654
5655           if (_gdk_display_end_device_grab (display,
5656                                             device,
5657                                             _gdk_display_get_next_serial (display),
5658                                             window,
5659                                             TRUE))
5660             gdk_device_ungrab (device, GDK_CURRENT_TIME);
5661         }
5662
5663       window->state = GDK_WINDOW_STATE_WITHDRAWN;
5664       g_list_free (devices);
5665     }
5666
5667   did_hide = _gdk_window_update_viewable (window);
5668
5669   /* Hide foreign window as those are not handled by update_viewable. */
5670   if (gdk_window_has_impl (window) && (!did_hide))
5671     {
5672       impl_class = GDK_WINDOW_IMPL_GET_CLASS (window->impl);
5673       impl_class->hide (window);
5674     }
5675
5676   recompute_visible_regions (window, TRUE, FALSE);
5677
5678   /* all decendants became non-visible, we need to send visibility notify */
5679   gdk_window_update_visibility_recursively (window, NULL);
5680
5681   if (was_mapped && !gdk_window_has_impl (window))
5682     {
5683       if (window->event_mask & GDK_STRUCTURE_MASK)
5684         _gdk_make_event (window, GDK_UNMAP, NULL, FALSE);
5685
5686       if (window->parent && window->parent->event_mask & GDK_SUBSTRUCTURE_MASK)
5687         _gdk_make_event (window, GDK_UNMAP, NULL, FALSE);
5688
5689       _gdk_synthesize_crossing_events_for_geometry_change (window->parent);
5690     }
5691
5692   /* Invalidate the rect */
5693   if (was_mapped)
5694     gdk_window_invalidate_in_parent (window);
5695 }
5696
5697 /**
5698  * gdk_window_withdraw:
5699  * @window: a toplevel #GdkWindow
5700  *
5701  * Withdraws a window (unmaps it and asks the window manager to forget about it).
5702  * This function is not really useful as gdk_window_hide() automatically
5703  * withdraws toplevel windows before hiding them.
5704  **/
5705 void
5706 gdk_window_withdraw (GdkWindow *window)
5707 {
5708   GdkWindowImplClass *impl_class;
5709   gboolean was_mapped;
5710
5711   g_return_if_fail (GDK_IS_WINDOW (window));
5712
5713   if (window->destroyed)
5714     return;
5715
5716   was_mapped = GDK_WINDOW_IS_MAPPED (window);
5717
5718   if (gdk_window_has_impl (window))
5719     {
5720       impl_class = GDK_WINDOW_IMPL_GET_CLASS (window->impl);
5721       impl_class->withdraw (window);
5722
5723       if (was_mapped)
5724         {
5725           if (window->event_mask & GDK_STRUCTURE_MASK)
5726             _gdk_make_event (window, GDK_UNMAP, NULL, FALSE);
5727
5728           if (window->parent && window->parent->event_mask & GDK_SUBSTRUCTURE_MASK)
5729             _gdk_make_event (window, GDK_UNMAP, NULL, FALSE);
5730
5731           _gdk_synthesize_crossing_events_for_geometry_change (window->parent);
5732         }
5733
5734       recompute_visible_regions (window, TRUE, FALSE);
5735     }
5736 }
5737
5738 /**
5739  * gdk_window_set_events:
5740  * @window: a #GdkWindow
5741  * @event_mask: event mask for @window
5742  *
5743  * The event mask for a window determines which events will be reported
5744  * for that window from all master input devices. For example, an event mask
5745  * including #GDK_BUTTON_PRESS_MASK means the window should report button
5746  * press events. The event mask is the bitwise OR of values from the
5747  * #GdkEventMask enumeration.
5748  **/
5749 void
5750 gdk_window_set_events (GdkWindow       *window,
5751                        GdkEventMask     event_mask)
5752 {
5753   GdkWindowImplClass *impl_class;
5754   GdkDisplay *display;
5755
5756   g_return_if_fail (GDK_IS_WINDOW (window));
5757
5758   if (window->destroyed)
5759     return;
5760
5761   /* If motion hint is disabled, enable motion events again */
5762   display = gdk_window_get_display (window);
5763   if ((window->event_mask & GDK_POINTER_MOTION_HINT_MASK) &&
5764       !(event_mask & GDK_POINTER_MOTION_HINT_MASK))
5765     {
5766       GList *devices = window->devices_inside;
5767
5768       while (devices)
5769         {
5770           _gdk_display_enable_motion_hints (display, (GdkDevice *) devices->data);
5771           devices = devices->next;
5772         }
5773     }
5774
5775   window->event_mask = event_mask;
5776
5777   if (gdk_window_has_impl (window))
5778     {
5779       impl_class = GDK_WINDOW_IMPL_GET_CLASS (window->impl);
5780       impl_class->set_events (window,
5781                               get_native_event_mask (window));
5782     }
5783
5784 }
5785
5786 /**
5787  * gdk_window_get_events:
5788  * @window: a #GdkWindow
5789  *
5790  * Gets the event mask for @window for all master input devices. See
5791  * gdk_window_set_events().
5792  *
5793  * Return value: event mask for @window
5794  **/
5795 GdkEventMask
5796 gdk_window_get_events (GdkWindow *window)
5797 {
5798   g_return_val_if_fail (GDK_IS_WINDOW (window), 0);
5799
5800   if (window->destroyed)
5801     return 0;
5802
5803   return window->event_mask;
5804 }
5805
5806 /**
5807  * gdk_window_set_device_events:
5808  * @window: a #GdkWindow
5809  * @device: #GdkDevice to enable events for.
5810  * @event_mask: event mask for @window
5811  *
5812  * Sets the event mask for a given device (Normally a floating device, not
5813  * attached to any visible pointer) to @window. For example, an event mask
5814  * including #GDK_BUTTON_PRESS_MASK means the window should report button
5815  * press events. The event mask is the bitwise OR of values from the
5816  * #GdkEventMask enumeration.
5817  *
5818  * Since: 3.0
5819  **/
5820 void
5821 gdk_window_set_device_events (GdkWindow    *window,
5822                               GdkDevice    *device,
5823                               GdkEventMask  event_mask)
5824 {
5825   GdkEventMask device_mask;
5826   GdkDisplay *display;
5827   GdkWindow *native;
5828
5829   g_return_if_fail (GDK_IS_WINDOW (window));
5830   g_return_if_fail (GDK_IS_DEVICE (device));
5831
5832   if (GDK_WINDOW_DESTROYED (window))
5833     return;
5834
5835   /* If motion hint is disabled, enable motion events again */
5836   display = gdk_window_get_display (window);
5837   if ((window->event_mask & GDK_POINTER_MOTION_HINT_MASK) &&
5838       !(event_mask & GDK_POINTER_MOTION_HINT_MASK))
5839     _gdk_display_enable_motion_hints (display, device);
5840
5841   if (G_UNLIKELY (!window->device_events))
5842     window->device_events = g_hash_table_new (NULL, NULL);
5843
5844   if (event_mask == 0)
5845     {
5846       /* FIXME: unsetting events on a master device
5847        * would restore window->event_mask
5848        */
5849       g_hash_table_remove (window->device_events, device);
5850     }
5851   else
5852     g_hash_table_insert (window->device_events, device,
5853                          GINT_TO_POINTER (event_mask));
5854
5855   native = gdk_window_get_toplevel (window);
5856
5857   while (gdk_window_is_offscreen (native))
5858     {
5859       native = gdk_offscreen_window_get_embedder (native);
5860
5861       if (native == NULL ||
5862           (!_gdk_window_has_impl (native) &&
5863            !gdk_window_is_viewable (native)))
5864         return;
5865
5866       native = gdk_window_get_toplevel (native);
5867     }
5868
5869   device_mask = get_native_device_event_mask (window, device);
5870   GDK_DEVICE_GET_CLASS (device)->select_window_events (device, native, device_mask);
5871 }
5872
5873 /**
5874  * gdk_window_get_device_events:
5875  * @window: a #GdkWindow.
5876  * @device: a #GdkDevice.
5877  *
5878  * Returns the event mask for @window corresponding to an specific device.
5879  *
5880  * Returns: device event mask for @window
5881  *
5882  * Since: 3.0
5883  **/
5884 GdkEventMask
5885 gdk_window_get_device_events (GdkWindow *window,
5886                               GdkDevice *device)
5887 {
5888   GdkEventMask mask;
5889
5890   g_return_val_if_fail (GDK_IS_WINDOW (window), 0);
5891   g_return_val_if_fail (GDK_IS_DEVICE (device), 0);
5892
5893   if (GDK_WINDOW_DESTROYED (window))
5894     return 0;
5895
5896   if (!window->device_events)
5897     return 0;
5898
5899   mask = GPOINTER_TO_INT (g_hash_table_lookup (window->device_events, device));
5900
5901   /* FIXME: device could be controlled by window->event_mask */
5902
5903   return mask;
5904 }
5905
5906 static void
5907 gdk_window_move_resize_toplevel (GdkWindow *window,
5908                                  gboolean   with_move,
5909                                  gint       x,
5910                                  gint       y,
5911                                  gint       width,
5912                                  gint       height)
5913 {
5914   cairo_region_t *old_region, *new_region;
5915   GdkWindowImplClass *impl_class;
5916   gboolean expose;
5917   gboolean is_resize;
5918
5919   expose = FALSE;
5920   old_region = NULL;
5921
5922   is_resize = (width != -1) || (height != -1);
5923
5924   if (gdk_window_is_viewable (window) &&
5925       !window->input_only)
5926     {
5927       expose = TRUE;
5928       old_region = cairo_region_copy (window->clip_region);
5929     }
5930
5931   impl_class = GDK_WINDOW_IMPL_GET_CLASS (window->impl);
5932   impl_class->move_resize (window, with_move, x, y, width, height);
5933
5934   /* Avoid recomputing for pure toplevel moves, for performance reasons */
5935   if (is_resize)
5936     recompute_visible_regions (window, TRUE, FALSE);
5937
5938   if (expose)
5939     {
5940       new_region = cairo_region_copy (window->clip_region);
5941
5942       /* This is the newly exposed area (due to any resize),
5943        * X will expose it, but lets do that without the roundtrip
5944        */
5945       cairo_region_subtract (new_region, old_region);
5946       gdk_window_invalidate_region_full (window, new_region, TRUE, CLEAR_BG_WINCLEARED);
5947
5948       cairo_region_destroy (old_region);
5949       cairo_region_destroy (new_region);
5950     }
5951
5952   _gdk_synthesize_crossing_events_for_geometry_change (window);
5953 }
5954
5955
5956 static void
5957 move_native_children (GdkWindow *private)
5958 {
5959   GList *l;
5960   GdkWindow *child;
5961   GdkWindowImplClass *impl_class;
5962
5963   for (l = private->children; l; l = l->next)
5964     {
5965       child = l->data;
5966
5967       if (child->impl != private->impl)
5968         {
5969           impl_class = GDK_WINDOW_IMPL_GET_CLASS (child->impl);
5970           impl_class->move_resize (child, TRUE,
5971                                    child->x, child->y,
5972                                    child->width, child->height);
5973         }
5974       else
5975         move_native_children  (child);
5976     }
5977 }
5978
5979 static gboolean
5980 collect_native_child_region_helper (GdkWindow *window,
5981                                     GdkWindowImpl *impl,
5982                                     cairo_region_t **region,
5983                                     int x_offset,
5984                                     int y_offset)
5985 {
5986   GdkWindow *child;
5987   cairo_region_t *tmp;
5988   GList *l;
5989
5990   for (l = window->children; l != NULL; l = l->next)
5991     {
5992       child = l->data;
5993
5994       if (!GDK_WINDOW_IS_MAPPED (child) || child->input_only)
5995         continue;
5996
5997       if (child->impl != impl)
5998         {
5999           tmp = cairo_region_copy (child->clip_region);
6000           cairo_region_translate (tmp,
6001                              x_offset + child->x,
6002                              y_offset + child->y);
6003           if (*region == NULL)
6004             *region = tmp;
6005           else
6006             {
6007               cairo_region_union (*region, tmp);
6008               cairo_region_destroy (tmp);
6009             }
6010         }
6011       else
6012         collect_native_child_region_helper (child, impl, region,
6013                                             x_offset + child->x,
6014                                             y_offset + child->y);
6015     }
6016
6017   return FALSE;
6018 }
6019
6020 static cairo_region_t *
6021 collect_native_child_region (GdkWindow *window,
6022                              gboolean include_this)
6023 {
6024   cairo_region_t *region;
6025
6026   if (include_this && gdk_window_has_impl (window) && window->viewable)
6027     return cairo_region_copy (window->clip_region);
6028
6029   region = NULL;
6030
6031   collect_native_child_region_helper (window, window->impl, &region, 0, 0);
6032
6033   return region;
6034 }
6035
6036
6037 static void
6038 gdk_window_move_resize_internal (GdkWindow *window,
6039                                  gboolean   with_move,
6040                                  gint       x,
6041                                  gint       y,
6042                                  gint       width,
6043                                  gint       height)
6044 {
6045   cairo_region_t *old_region, *old_layered, *new_region, *copy_area;
6046   cairo_region_t *old_native_child_region, *new_native_child_region;
6047   GdkWindow *impl_window;
6048   GdkWindowImplClass *impl_class;
6049   gboolean expose;
6050   int old_x, old_y, old_abs_x, old_abs_y;
6051   int dx, dy;
6052
6053   g_return_if_fail (GDK_IS_WINDOW (window));
6054
6055   if (window->destroyed)
6056     return;
6057
6058   if (gdk_window_is_toplevel (window))
6059     {
6060       gdk_window_move_resize_toplevel (window, with_move, x, y, width, height);
6061       return;
6062     }
6063
6064   /* Bail early if no change */
6065   if (window->width == width &&
6066       window->height == height &&
6067       (!with_move ||
6068        (window->x == x &&
6069         window->y == y)))
6070     return;
6071
6072   gdk_window_flush_if_exposing (window);
6073
6074   /* Handle child windows */
6075
6076   expose = FALSE;
6077   old_region = NULL;
6078   old_layered = NULL;
6079
6080   impl_window = gdk_window_get_impl_window (window);
6081
6082   old_x = window->x;
6083   old_y = window->y;
6084
6085   old_native_child_region = NULL;
6086   if (gdk_window_is_viewable (window) &&
6087       !window->input_only)
6088     {
6089       expose = TRUE;
6090
6091       old_region = cairo_region_copy (window->clip_region);
6092       old_layered = cairo_region_copy (window->layered_region);
6093       /* Adjust regions to parent window coords */
6094       cairo_region_translate (old_region, window->x, window->y);
6095       cairo_region_translate (old_layered, window->x, window->y);
6096
6097       old_native_child_region = collect_native_child_region (window, TRUE);
6098       if (old_native_child_region)
6099         {
6100           /* Adjust region to parent window coords */
6101           cairo_region_translate (old_native_child_region, window->x, window->y);
6102
6103           /* Any native window move will immediately copy stuff to the destination, which may overwrite a
6104            * source or destination for a delayed GdkWindowRegionMove. So, we need
6105            * to flush those here for the parent window and all overlapped subwindows
6106            * of it. And we need to do this before setting the new clips as those will be
6107            * affecting this.
6108            */
6109           gdk_window_flush_recursive (window->parent);
6110         }
6111     }
6112
6113   /* Set the new position and size */
6114   if (with_move)
6115     {
6116       window->x = x;
6117       window->y = y;
6118     }
6119   if (!(width < 0 && height < 0))
6120     {
6121       if (width < 1)
6122         width = 1;
6123       window->width = width;
6124       if (height < 1)
6125         height = 1;
6126       window->height = height;
6127     }
6128
6129   dx = window->x - old_x;
6130   dy = window->y - old_y;
6131
6132   old_abs_x = window->abs_x;
6133   old_abs_y = window->abs_y;
6134
6135   recompute_visible_regions (window, TRUE, FALSE);
6136
6137   new_native_child_region = NULL;
6138   if (old_native_child_region)
6139     {
6140       new_native_child_region = collect_native_child_region (window, TRUE);
6141       /* Adjust region to parent window coords */
6142       cairo_region_translate (new_native_child_region, window->x, window->y);
6143     }
6144
6145   if (gdk_window_has_impl (window))
6146     {
6147       impl_class = GDK_WINDOW_IMPL_GET_CLASS (window->impl);
6148
6149       /* Do the actual move after recomputing things, as this will have set the shape to
6150          the now correct one, thus avoiding copying regions that should not be copied. */
6151       impl_class->move_resize (window, TRUE,
6152                                window->x, window->y,
6153                                window->width, window->height);
6154     }
6155   else if (old_abs_x != window->abs_x ||
6156            old_abs_y != window->abs_y)
6157     move_native_children (window);
6158
6159   if (expose)
6160     {
6161       new_region = cairo_region_copy (window->clip_region);
6162       /* Adjust region to parent window coords */
6163       cairo_region_translate (new_region, window->x, window->y);
6164
6165       /* copy_area:
6166        * Part of the data at the new location can be copied from the
6167        * old location, this area is the intersection of the old region
6168        * moved as the copy will move it and then intersected with
6169        * the new region.
6170        *
6171        * new_region:
6172        * Everything in the old and new regions that is not copied must be
6173        * invalidated (including children) as this is newly exposed
6174        */
6175       if (window->has_alpha_background)
6176         copy_area = cairo_region_create (); /* Copy nothing for alpha windows */
6177       else
6178         copy_area = cairo_region_copy (new_region);
6179
6180       /* Don't copy from a previously layered region */
6181       cairo_region_translate (old_layered, dx, dy);
6182       cairo_region_subtract (copy_area, old_layered);
6183
6184       /* Don't copy into a layered region */
6185       cairo_region_translate (copy_area, -window->x, -window->y);
6186       cairo_region_subtract (copy_area, window->layered_region);
6187       cairo_region_translate (copy_area, window->x, window->y);
6188
6189       cairo_region_union (new_region, old_region);
6190
6191       if (old_native_child_region)
6192         {
6193           /* Don't copy from inside native children, as this is copied by
6194            * the native window move.
6195            */
6196           cairo_region_subtract (old_region, old_native_child_region);
6197         }
6198       cairo_region_translate (old_region, dx, dy);
6199
6200       cairo_region_intersect (copy_area, old_region);
6201
6202       if (new_native_child_region)
6203         {
6204           /* Don't copy any bits that would cause a read from the moved
6205              native windows, as we can't read that data */
6206           cairo_region_translate (new_native_child_region, dx, dy);
6207           cairo_region_subtract (copy_area, new_native_child_region);
6208           cairo_region_translate (new_native_child_region, -dx, -dy);
6209         }
6210
6211       cairo_region_subtract (new_region, copy_area);
6212
6213       /* Convert old region to impl coords */
6214       cairo_region_translate (old_region, -dx + window->abs_x - window->x, -dy + window->abs_y - window->y);
6215
6216       /* convert from parent coords to impl */
6217       cairo_region_translate (copy_area, window->abs_x - window->x, window->abs_y - window->y);
6218
6219       move_region_on_impl (impl_window, copy_area, dx, dy); /* takes ownership of copy_area */
6220
6221       /* Invalidate affected part in the parent window
6222        *  (no higher window should be affected)
6223        * We also invalidate any children in that area, which could include
6224        * this window if it still overlaps that area.
6225        */
6226       if (old_native_child_region)
6227         {
6228           /* No need to expose the region that the native window move copies */
6229           cairo_region_translate (old_native_child_region, dx, dy);
6230           cairo_region_intersect (old_native_child_region, new_native_child_region);
6231           cairo_region_subtract (new_region, old_native_child_region);
6232         }
6233       gdk_window_invalidate_region_full (window->parent, new_region, TRUE, CLEAR_BG_ALL);
6234
6235       cairo_region_destroy (old_region);
6236       cairo_region_destroy (old_layered);
6237       cairo_region_destroy (new_region);
6238     }
6239
6240   if (old_native_child_region)
6241     {
6242       cairo_region_destroy (old_native_child_region);
6243       cairo_region_destroy (new_native_child_region);
6244     }
6245
6246   _gdk_synthesize_crossing_events_for_geometry_change (window);
6247 }
6248
6249
6250
6251 /**
6252  * gdk_window_move:
6253  * @window: a #GdkWindow
6254  * @x: X coordinate relative to window's parent
6255  * @y: Y coordinate relative to window's parent
6256  *
6257  * Repositions a window relative to its parent window.
6258  * For toplevel windows, window managers may ignore or modify the move;
6259  * you should probably use gtk_window_move() on a #GtkWindow widget
6260  * anyway, instead of using GDK functions. For child windows,
6261  * the move will reliably succeed.
6262  *
6263  * If you're also planning to resize the window, use gdk_window_move_resize()
6264  * to both move and resize simultaneously, for a nicer visual effect.
6265  **/
6266 void
6267 gdk_window_move (GdkWindow *window,
6268                  gint       x,
6269                  gint       y)
6270 {
6271   gdk_window_move_resize_internal (window, TRUE, x, y, -1, -1);
6272 }
6273
6274 /**
6275  * gdk_window_resize:
6276  * @window: a #GdkWindow
6277  * @width: new width of the window
6278  * @height: new height of the window
6279  *
6280  * Resizes @window; for toplevel windows, asks the window manager to resize
6281  * the window. The window manager may not allow the resize. When using GTK+,
6282  * use gtk_window_resize() instead of this low-level GDK function.
6283  *
6284  * Windows may not be resized below 1x1.
6285  *
6286  * If you're also planning to move the window, use gdk_window_move_resize()
6287  * to both move and resize simultaneously, for a nicer visual effect.
6288  **/
6289 void
6290 gdk_window_resize (GdkWindow *window,
6291                    gint       width,
6292                    gint       height)
6293 {
6294   gdk_window_move_resize_internal (window, FALSE, 0, 0, width, height);
6295 }
6296
6297
6298 /**
6299  * gdk_window_move_resize:
6300  * @window: a #GdkWindow
6301  * @x: new X position relative to window's parent
6302  * @y: new Y position relative to window's parent
6303  * @width: new width
6304  * @height: new height
6305  *
6306  * Equivalent to calling gdk_window_move() and gdk_window_resize(),
6307  * except that both operations are performed at once, avoiding strange
6308  * visual effects. (i.e. the user may be able to see the window first
6309  * move, then resize, if you don't use gdk_window_move_resize().)
6310  **/
6311 void
6312 gdk_window_move_resize (GdkWindow *window,
6313                         gint       x,
6314                         gint       y,
6315                         gint       width,
6316                         gint       height)
6317 {
6318   gdk_window_move_resize_internal (window, TRUE, x, y, width, height);
6319 }
6320
6321
6322 /**
6323  * gdk_window_scroll:
6324  * @window: a #GdkWindow
6325  * @dx: Amount to scroll in the X direction
6326  * @dy: Amount to scroll in the Y direction
6327  *
6328  * Scroll the contents of @window, both pixels and children, by the
6329  * given amount. @window itself does not move. Portions of the window
6330  * that the scroll operation brings in from offscreen areas are
6331  * invalidated. The invalidated region may be bigger than what would
6332  * strictly be necessary.
6333  *
6334  * For X11, a minimum area will be invalidated if the window has no
6335  * subwindows, or if the edges of the window's parent do not extend
6336  * beyond the edges of the window. In other cases, a multi-step process
6337  * is used to scroll the window which may produce temporary visual
6338  * artifacts and unnecessary invalidations.
6339  **/
6340 void
6341 gdk_window_scroll (GdkWindow *window,
6342                    gint       dx,
6343                    gint       dy)
6344 {
6345   GdkWindow *impl_window;
6346   cairo_region_t *copy_area, *noncopy_area, *old_layered_area;
6347   cairo_region_t *old_native_child_region, *new_native_child_region;
6348   GList *tmp_list;
6349
6350   g_return_if_fail (GDK_IS_WINDOW (window));
6351
6352   if (dx == 0 && dy == 0)
6353     return;
6354
6355   if (window->destroyed)
6356     return;
6357
6358   gdk_window_flush_if_exposing (window);
6359
6360   old_layered_area = cairo_region_copy (window->layered_region);
6361   old_native_child_region = collect_native_child_region (window, FALSE);
6362   if (old_native_child_region)
6363     {
6364       /* Any native window move will immediately copy stuff to the destination, which may overwrite a
6365        * source or destination for a delayed GdkWindowRegionMove. So, we need
6366        * to flush those here for the window and all overlapped subwindows
6367        * of it. And we need to do this before setting the new clips as those will be
6368        * affecting this.
6369        */
6370       gdk_window_flush_recursive (window);
6371     }
6372
6373
6374   /* First move all child windows, without causing invalidation */
6375
6376   tmp_list = window->children;
6377   while (tmp_list)
6378     {
6379       GdkWindow *child = GDK_WINDOW (tmp_list->data);
6380
6381       /* Just update the positions, the bits will move with the copy */
6382       child->x += dx;
6383       child->y += dy;
6384
6385       tmp_list = tmp_list->next;
6386     }
6387
6388   recompute_visible_regions (window, FALSE, TRUE);
6389
6390   new_native_child_region = NULL;
6391   if (old_native_child_region)
6392     new_native_child_region = collect_native_child_region (window, FALSE);
6393
6394   move_native_children (window);
6395
6396   /* Then copy the actual bits of the window w/ child windows */
6397
6398   impl_window = gdk_window_get_impl_window (window);
6399
6400   /* Calculate the area that can be gotten by copying the old area */
6401   if (window->has_alpha_background)
6402     copy_area = cairo_region_create (); /* Copy nothing for alpha windows */
6403   else
6404     copy_area = cairo_region_copy (window->clip_region);
6405   cairo_region_subtract (copy_area, old_layered_area);
6406   if (old_native_child_region)
6407     {
6408       /* Don't copy from inside native children, as this is copied by
6409        * the native window move.
6410        */
6411       cairo_region_subtract (copy_area, old_native_child_region);
6412
6413       /* Don't copy any bits that would cause a read from the moved
6414          native windows, as we can't read that data */
6415       cairo_region_subtract (copy_area, new_native_child_region);
6416     }
6417   cairo_region_translate (copy_area, dx, dy);
6418   cairo_region_intersect (copy_area, window->clip_region);
6419   cairo_region_subtract (copy_area, window->layered_region);
6420
6421   /* And the rest need to be invalidated */
6422   noncopy_area = cairo_region_copy (window->clip_region);
6423   cairo_region_subtract (noncopy_area, copy_area);
6424
6425   /* convert from window coords to impl */
6426   cairo_region_translate (copy_area, window->abs_x, window->abs_y);
6427
6428   move_region_on_impl (impl_window, copy_area, dx, dy); /* takes ownership of copy_area */
6429
6430   /* Invalidate not copied regions */
6431   if (old_native_child_region)
6432     {
6433       /* No need to expose the region that the native window move copies */
6434       cairo_region_translate (old_native_child_region, dx, dy);
6435       cairo_region_intersect (old_native_child_region, new_native_child_region);
6436       cairo_region_subtract (noncopy_area, old_native_child_region);
6437     }
6438   gdk_window_invalidate_region_full (window, noncopy_area, TRUE, CLEAR_BG_ALL);
6439
6440   cairo_region_destroy (noncopy_area);
6441   cairo_region_destroy (old_layered_area);
6442
6443   if (old_native_child_region)
6444     {
6445       cairo_region_destroy (old_native_child_region);
6446       cairo_region_destroy (new_native_child_region);
6447     }
6448
6449   _gdk_synthesize_crossing_events_for_geometry_change (window);
6450 }
6451
6452 /**
6453  * gdk_window_move_region:
6454  * @window: a #GdkWindow
6455  * @region: The #cairo_region_t to move
6456  * @dx: Amount to move in the X direction
6457  * @dy: Amount to move in the Y direction
6458  *
6459  * Move the part of @window indicated by @region by @dy pixels in the Y
6460  * direction and @dx pixels in the X direction. The portions of @region
6461  * that not covered by the new position of @region are invalidated.
6462  *
6463  * Child windows are not moved.
6464  *
6465  * Since: 2.8
6466  */
6467 void
6468 gdk_window_move_region (GdkWindow       *window,
6469                         const cairo_region_t *region,
6470                         gint             dx,
6471                         gint             dy)
6472 {
6473   GdkWindow *impl_window;
6474   cairo_region_t *nocopy_area;
6475   cairo_region_t *copy_area;
6476
6477   g_return_if_fail (GDK_IS_WINDOW (window));
6478   g_return_if_fail (region != NULL);
6479
6480   if (dx == 0 && dy == 0)
6481     return;
6482
6483   if (window->destroyed)
6484     return;
6485
6486   impl_window = gdk_window_get_impl_window (window);
6487
6488   /* compute source regions */
6489   if (window->has_alpha_background)
6490     copy_area = cairo_region_create (); /* Copy nothing for alpha windows */
6491   else
6492     copy_area = cairo_region_copy (region);
6493   cairo_region_intersect (copy_area, window->clip_region_with_children);
6494   cairo_region_subtract (copy_area, window->layered_region);
6495   remove_layered_child_area (window, copy_area);
6496
6497   /* compute destination regions */
6498   cairo_region_translate (copy_area, dx, dy);
6499   cairo_region_intersect (copy_area, window->clip_region_with_children);
6500   cairo_region_subtract (copy_area, window->layered_region);
6501   remove_layered_child_area (window, copy_area);
6502
6503   /* Invalidate parts of the region (source and dest) not covered
6504      by the copy */
6505   nocopy_area = cairo_region_copy (region);
6506   cairo_region_translate (nocopy_area, dx, dy);
6507   cairo_region_union (nocopy_area, region);
6508   cairo_region_subtract (nocopy_area, copy_area);
6509
6510   /* convert from window coords to impl */
6511   cairo_region_translate (copy_area, window->abs_x, window->abs_y);
6512   move_region_on_impl (impl_window, copy_area, dx, dy); /* Takes ownership of copy_area */
6513
6514   gdk_window_invalidate_region_full (window, nocopy_area, FALSE, CLEAR_BG_ALL);
6515   cairo_region_destroy (nocopy_area);
6516 }
6517
6518 /**
6519  * gdk_window_set_background:
6520  * @window: a #GdkWindow
6521  * @color: a #GdkColor
6522  *
6523  * Sets the background color of @window. (However, when using GTK+,
6524  * set the background of a widget with gtk_widget_modify_bg() - if
6525  * you're an application - or gtk_style_set_background() - if you're
6526  * implementing a custom widget.)
6527  *
6528  * See also gdk_window_set_background_pattern().
6529  *
6530  * Deprecated: 3.4: Use gdk_window_set_background_rgba() instead.
6531  */
6532 void
6533 gdk_window_set_background (GdkWindow      *window,
6534                            const GdkColor *color)
6535 {
6536   cairo_pattern_t *pattern;
6537
6538   g_return_if_fail (GDK_IS_WINDOW (window));
6539
6540   pattern = cairo_pattern_create_rgb (color->red   / 65535.,
6541                                       color->green / 65535.,
6542                                       color->blue  / 65535.);
6543
6544   gdk_window_set_background_pattern (window, pattern);
6545
6546   cairo_pattern_destroy (pattern);
6547 }
6548
6549 /**
6550  * gdk_window_set_background_rgba:
6551  * @window: a #GdkWindow
6552  * @rgba: a #GdkRGBA color
6553  *
6554  * Sets the background color of @window.
6555  *
6556  * See also gdk_window_set_background_pattern().
6557  **/
6558 void
6559 gdk_window_set_background_rgba (GdkWindow *window,
6560                                 GdkRGBA   *rgba)
6561 {
6562   cairo_pattern_t *pattern;
6563
6564   g_return_if_fail (GDK_IS_WINDOW (window));
6565   g_return_if_fail (rgba != NULL);
6566
6567   pattern = cairo_pattern_create_rgba (rgba->red, rgba->green,
6568                                        rgba->blue, rgba->alpha);
6569
6570   gdk_window_set_background_pattern (window, pattern);
6571
6572   cairo_pattern_destroy (pattern);
6573 }
6574
6575
6576 /* Updates has_alpha_background recursively for all child windows
6577    that have parent-relative alpha */
6578 static void
6579 _gdk_window_propagate_has_alpha_background (GdkWindow *window)
6580 {
6581   GdkWindow *child;
6582   GList *l;
6583
6584   for (l = window->children; l; l = l->next)
6585     {
6586       child = l->data;
6587
6588       if (child->background == NULL &&
6589           child->has_alpha_background != window->has_alpha_background)
6590         {
6591           child->has_alpha_background = window->has_alpha_background;
6592           recompute_visible_regions (child, TRUE, FALSE);
6593           _gdk_window_propagate_has_alpha_background (child);
6594         }
6595     }
6596 }
6597
6598 /**
6599  * gdk_window_set_background_pattern:
6600  * @window: a #GdkWindow
6601  * @pattern: (allow-none): a pattern to use, or %NULL
6602  *
6603  * Sets the background of @window.
6604  *
6605  * A background of %NULL means that the window will inherit its
6606  * background form its parent window.
6607  *
6608  * The windowing system will normally fill a window with its background
6609  * when the window is obscured then exposed.
6610  */
6611 void
6612 gdk_window_set_background_pattern (GdkWindow *window,
6613                                    cairo_pattern_t *pattern)
6614 {
6615   gboolean has_alpha;
6616   cairo_pattern_type_t type;
6617   
6618   g_return_if_fail (GDK_IS_WINDOW (window));
6619
6620   if (window->input_only)
6621     return;
6622
6623   if (pattern)
6624     cairo_pattern_reference (pattern);
6625   if (window->background)
6626     cairo_pattern_destroy (window->background);
6627   window->background = pattern;
6628
6629   has_alpha = TRUE;
6630
6631   if (pattern == NULL)
6632     {
6633       /* parent-relative, copy has_alpha from parent */
6634       if (window->parent == NULL ||
6635           window->parent->window_type == GDK_WINDOW_ROOT)
6636         has_alpha = FALSE;
6637       else
6638         has_alpha = window->parent->has_alpha_background;
6639     }
6640   else
6641     {
6642       type = cairo_pattern_get_type (pattern);
6643
6644       if (type == CAIRO_PATTERN_TYPE_SOLID)
6645         {
6646           double alpha;
6647           cairo_pattern_get_rgba (pattern, NULL, NULL, NULL, &alpha);
6648           if (alpha == 1.0)
6649             has_alpha = FALSE;
6650         }
6651       else if (type == CAIRO_PATTERN_TYPE_LINEAR ||
6652                type == CAIRO_PATTERN_TYPE_RADIAL)
6653         {
6654           int i, n;
6655           double alpha;
6656
6657           n = 0;
6658           cairo_pattern_get_color_stop_count (pattern, &n);
6659           has_alpha = FALSE;
6660           for (i = 0; i < n; i++)
6661             {
6662               cairo_pattern_get_color_stop_rgba (pattern, i, NULL,
6663                                                  NULL, NULL, NULL, &alpha);
6664               if (alpha != 1.0)
6665                 {
6666                   has_alpha = TRUE;
6667                   break;
6668                 }
6669             }
6670         }
6671       else if (type == CAIRO_PATTERN_TYPE_SURFACE)
6672         {
6673           cairo_surface_t *surface;
6674           cairo_content_t content;
6675
6676           cairo_pattern_get_surface (pattern, &surface);
6677           content = cairo_surface_get_content (surface);
6678           has_alpha =
6679             (content == CAIRO_CONTENT_ALPHA) ||
6680             (content == CAIRO_CONTENT_COLOR_ALPHA);
6681         }
6682     }
6683
6684   if (has_alpha != window->has_alpha_background)
6685     {
6686       window->has_alpha_background = has_alpha;  
6687       recompute_visible_regions (window, TRUE, FALSE);
6688
6689       _gdk_window_propagate_has_alpha_background (window);
6690     }
6691
6692   if (gdk_window_has_impl (window))
6693     {
6694       GdkWindowImplClass *impl_class = GDK_WINDOW_IMPL_GET_CLASS (window->impl);
6695       impl_class->set_background (window, pattern);
6696     }
6697   else
6698     gdk_window_invalidate_rect_full (window, NULL, TRUE, CLEAR_BG_ALL);
6699 }
6700
6701 /**
6702  * gdk_window_get_background_pattern:
6703  * @window: a window
6704  *
6705  * Gets the pattern used to clear the background on @window. If @window
6706  * does not have its own background and reuses the parent's, %NULL is
6707  * returned and you'll have to query it yourself.
6708  *
6709  * Returns: (transfer none): The pattern to use for the background or
6710  *     %NULL to use the parent's background.
6711  *
6712  * Since: 2.22
6713  **/
6714 cairo_pattern_t *
6715 gdk_window_get_background_pattern (GdkWindow *window)
6716 {
6717   g_return_val_if_fail (GDK_IS_WINDOW (window), NULL);
6718
6719   return window->background;
6720 }
6721
6722 static void
6723 gdk_window_set_cursor_internal (GdkWindow *window,
6724                                 GdkDevice *device,
6725                                 GdkCursor *cursor)
6726 {
6727   if (GDK_WINDOW_DESTROYED (window))
6728     return;
6729
6730   if (window->window_type == GDK_WINDOW_ROOT ||
6731       window->window_type == GDK_WINDOW_FOREIGN)
6732     GDK_WINDOW_IMPL_GET_CLASS (window->impl)->set_device_cursor (window, device, cursor);
6733   else
6734     {
6735       GdkPointerWindowInfo *pointer_info;
6736       GdkDisplay *display;
6737
6738       display = gdk_window_get_display (window);
6739       pointer_info = _gdk_display_get_pointer_info (display, device);
6740
6741       if (_gdk_window_event_parent_of (window, pointer_info->window_under_pointer))
6742         update_cursor (display, device);
6743     }
6744 }
6745
6746 /**
6747  * gdk_window_get_cursor:
6748  * @window: a #GdkWindow
6749  *
6750  * Retrieves a #GdkCursor pointer for the cursor currently set on the
6751  * specified #GdkWindow, or %NULL.  If the return value is %NULL then
6752  * there is no custom cursor set on the specified window, and it is
6753  * using the cursor for its parent window.
6754  *
6755  * Return value: (transfer none): a #GdkCursor, or %NULL. The returned
6756  *   object is owned by the #GdkWindow and should not be unreferenced
6757  *   directly. Use gdk_window_set_cursor() to unset the cursor of the
6758  *   window
6759  *
6760  * Since: 2.18
6761  */
6762 GdkCursor *
6763 gdk_window_get_cursor (GdkWindow *window)
6764 {
6765   g_return_val_if_fail (GDK_IS_WINDOW (window), NULL);
6766
6767   return window->cursor;
6768 }
6769
6770 /**
6771  * gdk_window_set_cursor:
6772  * @window: a #GdkWindow
6773  * @cursor: (allow-none): a cursor
6774  *
6775  * Sets the default mouse pointer for a #GdkWindow. Use gdk_cursor_new_for_display()
6776  * or gdk_cursor_new_from_pixbuf() to create the cursor. To make the cursor
6777  * invisible, use %GDK_BLANK_CURSOR. Passing %NULL for the @cursor argument
6778  * to gdk_window_set_cursor() means that @window will use the cursor of its
6779  * parent window. Most windows should use this default.
6780  */
6781 void
6782 gdk_window_set_cursor (GdkWindow *window,
6783                        GdkCursor *cursor)
6784 {
6785   GdkDisplay *display;
6786
6787   g_return_if_fail (GDK_IS_WINDOW (window));
6788
6789   display = gdk_window_get_display (window);
6790
6791   if (window->cursor)
6792     {
6793       g_object_unref (window->cursor);
6794       window->cursor = NULL;
6795     }
6796
6797   if (!GDK_WINDOW_DESTROYED (window))
6798     {
6799       GdkDeviceManager *device_manager;
6800       GList *devices, *d;
6801
6802       if (cursor)
6803         window->cursor = g_object_ref (cursor);
6804
6805       device_manager = gdk_display_get_device_manager (display);
6806       devices = gdk_device_manager_list_devices (device_manager, GDK_DEVICE_TYPE_MASTER);
6807
6808       for (d = devices; d; d = d->next)
6809         {
6810           GdkDevice *device;
6811
6812           device = d->data;
6813
6814           if (gdk_device_get_source (device) == GDK_SOURCE_KEYBOARD)
6815             continue;
6816
6817           gdk_window_set_cursor_internal (window, device, window->cursor);
6818         }
6819
6820       g_list_free (devices);
6821       g_object_notify (G_OBJECT (window), "cursor");
6822     }
6823 }
6824
6825 /**
6826  * gdk_window_get_device_cursor:
6827  * @window: a #GdkWindow.
6828  * @device: a master, pointer #GdkDevice.
6829  *
6830  * Retrieves a #GdkCursor pointer for the @device currently set on the
6831  * specified #GdkWindow, or %NULL.  If the return value is %NULL then
6832  * there is no custom cursor set on the specified window, and it is
6833  * using the cursor for its parent window.
6834  *
6835  * Returns: (transfer none): a #GdkCursor, or %NULL. The returned
6836  *   object is owned by the #GdkWindow and should not be unreferenced
6837  *   directly. Use gdk_window_set_cursor() to unset the cursor of the
6838  *   window
6839  *
6840  * Since: 3.0
6841  **/
6842 GdkCursor *
6843 gdk_window_get_device_cursor (GdkWindow *window,
6844                               GdkDevice *device)
6845 {
6846   g_return_val_if_fail (GDK_IS_WINDOW (window), NULL);
6847   g_return_val_if_fail (GDK_IS_DEVICE (device), NULL);
6848   g_return_val_if_fail (gdk_device_get_source (device) != GDK_SOURCE_KEYBOARD, NULL);
6849   g_return_val_if_fail (gdk_device_get_device_type (device) == GDK_DEVICE_TYPE_MASTER, NULL);
6850
6851   return g_hash_table_lookup (window->device_cursor, device);
6852 }
6853
6854 /**
6855  * gdk_window_set_device_cursor:
6856  * @window: a #Gdkwindow
6857  * @device: a master, pointer #GdkDevice
6858  * @cursor: a #GdkCursor
6859  *
6860  * Sets a specific #GdkCursor for a given device when it gets inside @window.
6861  * Use gdk_cursor_new_for_display() or gdk_cursor_new_from_pixbuf() to create
6862  * the cursor. To make the cursor invisible, use %GDK_BLANK_CURSOR. Passing
6863  * %NULL for the @cursor argument to gdk_window_set_cursor() means that
6864  * @window will use the cursor of its parent window. Most windows should
6865  * use this default.
6866  *
6867  * Since: 3.0
6868  **/
6869 void
6870 gdk_window_set_device_cursor (GdkWindow *window,
6871                               GdkDevice *device,
6872                               GdkCursor *cursor)
6873 {
6874   g_return_if_fail (GDK_IS_WINDOW (window));
6875   g_return_if_fail (GDK_IS_DEVICE (device));
6876   g_return_if_fail (gdk_device_get_source (device) != GDK_SOURCE_KEYBOARD);
6877   g_return_if_fail (gdk_device_get_device_type (device) == GDK_DEVICE_TYPE_MASTER);
6878
6879   if (!cursor)
6880     g_hash_table_remove (window->device_cursor, device);
6881   else
6882     g_hash_table_replace (window->device_cursor, device, g_object_ref (cursor));
6883
6884   gdk_window_set_cursor_internal (window, device, cursor);
6885 }
6886
6887 /**
6888  * gdk_window_get_geometry:
6889  * @window: a #GdkWindow
6890  * @x: (out) (allow-none): return location for X coordinate of window (relative to its parent)
6891  * @y: (out) (allow-none): return location for Y coordinate of window (relative to its parent)
6892  * @width: (out) (allow-none): return location for width of window
6893  * @height: (out) (allow-none): return location for height of window
6894  *
6895  * Any of the return location arguments to this function may be %NULL,
6896  * if you aren't interested in getting the value of that field.
6897  *
6898  * The X and Y coordinates returned are relative to the parent window
6899  * of @window, which for toplevels usually means relative to the
6900  * window decorations (titlebar, etc.) rather than relative to the
6901  * root window (screen-size background window).
6902  *
6903  * On the X11 platform, the geometry is obtained from the X server,
6904  * so reflects the latest position of @window; this may be out-of-sync
6905  * with the position of @window delivered in the most-recently-processed
6906  * #GdkEventConfigure. gdk_window_get_position() in contrast gets the
6907  * position from the most recent configure event.
6908  *
6909  * <note>
6910  * If @window is not a toplevel, it is <emphasis>much</emphasis> better
6911  * to call gdk_window_get_position(), gdk_window_get_width() and
6912  * gdk_window_get_height() instead, because it avoids the roundtrip to
6913  * the X server and because these functions support the full 32-bit
6914  * coordinate space, whereas gdk_window_get_geometry() is restricted to
6915  * the 16-bit coordinates of X11.
6916  *</note>
6917  **/
6918 void
6919 gdk_window_get_geometry (GdkWindow *window,
6920                          gint      *x,
6921                          gint      *y,
6922                          gint      *width,
6923                          gint      *height)
6924 {
6925   GdkWindow *parent;
6926   GdkWindowImplClass *impl_class;
6927
6928   if (!window)
6929     {
6930       GDK_NOTE (MULTIHEAD,
6931                 g_message ("gdk_window_get_geometry(): Window needs "
6932                            "to be non-NULL to be multi head safe"));
6933       window = gdk_screen_get_root_window ((gdk_screen_get_default ()));
6934     }
6935
6936   g_return_if_fail (GDK_IS_WINDOW (window));
6937
6938   if (!GDK_WINDOW_DESTROYED (window))
6939     {
6940       if (gdk_window_has_impl (window))
6941         {
6942           impl_class = GDK_WINDOW_IMPL_GET_CLASS (window->impl);
6943           impl_class->get_geometry (window, x, y,
6944                                     width, height);
6945           /* This reports the position wrt to the native parent, we need to convert
6946              it to be relative to the client side parent */
6947           parent = window->parent;
6948           if (parent && !gdk_window_has_impl (parent))
6949             {
6950               if (x)
6951                 *x -= parent->abs_x;
6952               if (y)
6953                 *y -= parent->abs_y;
6954             }
6955         }
6956       else
6957         {
6958           if (x)
6959             *x = window->x;
6960           if (y)
6961             *y = window->y;
6962           if (width)
6963             *width = window->width;
6964           if (height)
6965             *height = window->height;
6966         }
6967     }
6968 }
6969
6970 /**
6971  * gdk_window_get_width:
6972  * @window: a #GdkWindow
6973  *
6974  * Returns the width of the given @window.
6975  *
6976  * On the X11 platform the returned size is the size reported in the
6977  * most-recently-processed configure event, rather than the current
6978  * size on the X server.
6979  *
6980  * Returns: The width of @window
6981  *
6982  * Since: 2.24
6983  */
6984 int
6985 gdk_window_get_width (GdkWindow *window)
6986 {
6987   g_return_val_if_fail (GDK_IS_WINDOW (window), 0);
6988
6989   return window->width;
6990 }
6991
6992 /**
6993  * gdk_window_get_height:
6994  * @window: a #GdkWindow
6995  *
6996  * Returns the height of the given @window.
6997  *
6998  * On the X11 platform the returned size is the size reported in the
6999  * most-recently-processed configure event, rather than the current
7000  * size on the X server.
7001  *
7002  * Returns: The height of @window
7003  *
7004  * Since: 2.24
7005  */
7006 int
7007 gdk_window_get_height (GdkWindow *window)
7008 {
7009   g_return_val_if_fail (GDK_IS_WINDOW (window), 0);
7010
7011   return window->height;
7012 }
7013
7014 /**
7015  * gdk_window_get_origin:
7016  * @window: a #GdkWindow
7017  * @x: (out) (allow-none): return location for X coordinate
7018  * @y: (out) (allow-none): return location for Y coordinate
7019  *
7020  * Obtains the position of a window in root window coordinates.
7021  * (Compare with gdk_window_get_position() and
7022  * gdk_window_get_geometry() which return the position of a window
7023  * relative to its parent window.)
7024  *
7025  * Return value: not meaningful, ignore
7026  */
7027 gint
7028 gdk_window_get_origin (GdkWindow *window,
7029                        gint      *x,
7030                        gint      *y)
7031 {
7032   GdkWindowImplClass *impl_class;
7033
7034   g_return_val_if_fail (GDK_IS_WINDOW (window), 0);
7035
7036   if (GDK_WINDOW_DESTROYED (window))
7037     {
7038       if (x)
7039         *x = 0;
7040       if (y)
7041         *y = 0;
7042       return 0;
7043     }
7044
7045   impl_class = GDK_WINDOW_IMPL_GET_CLASS (window->impl);
7046   impl_class->get_root_coords (window,
7047                                window->abs_x,
7048                                window->abs_y,
7049                                x, y);
7050
7051   return TRUE;
7052 }
7053
7054 /**
7055  * gdk_window_get_root_coords:
7056  * @window: a #GdkWindow
7057  * @x: X coordinate in window
7058  * @y: Y coordinate in window
7059  * @root_x: (out): return location for X coordinate
7060  * @root_y: (out): return location for Y coordinate
7061  *
7062  * Obtains the position of a window position in root
7063  * window coordinates. This is similar to
7064  * gdk_window_get_origin() but allows you go pass
7065  * in any position in the window, not just the origin.
7066  *
7067  * Since: 2.18
7068  */
7069 void
7070 gdk_window_get_root_coords (GdkWindow *window,
7071                             gint       x,
7072                             gint       y,
7073                             gint      *root_x,
7074                             gint      *root_y)
7075 {
7076   GdkWindowImplClass *impl_class;
7077
7078   g_return_if_fail (GDK_IS_WINDOW (window));
7079
7080   if (GDK_WINDOW_DESTROYED (window))
7081     {
7082       *root_x = 0;
7083       *root_y = 0;
7084       return;
7085     }
7086   
7087   impl_class = GDK_WINDOW_IMPL_GET_CLASS (window->impl);
7088   impl_class->get_root_coords (window,
7089                                x + window->abs_x,
7090                                y + window->abs_y,
7091                                root_x, root_y);
7092 }
7093
7094 /**
7095  * gdk_window_coords_to_parent:
7096  * @window: a child window
7097  * @x: X coordinate in child's coordinate system
7098  * @y: Y coordinate in child's coordinate system
7099  * @parent_x: (out) (allow-none): return location for X coordinate
7100  * in parent's coordinate system, or %NULL
7101  * @parent_y: (out) (allow-none): return location for Y coordinate
7102  * in parent's coordinate system, or %NULL
7103  *
7104  * Transforms window coordinates from a child window to its parent
7105  * window, where the parent window is the normal parent as returned by
7106  * gdk_window_get_parent() for normal windows, and the window's
7107  * embedder as returned by gdk_offscreen_window_get_embedder() for
7108  * offscreen windows.
7109  *
7110  * For normal windows, calling this function is equivalent to adding
7111  * the return values of gdk_window_get_position() to the child coordinates.
7112  * For offscreen windows however (which can be arbitrarily transformed),
7113  * this function calls the GdkWindow::to-embedder: signal to translate
7114  * the coordinates.
7115  *
7116  * You should always use this function when writing generic code that
7117  * walks up a window hierarchy.
7118  *
7119  * See also: gdk_window_coords_from_parent()
7120  *
7121  * Since: 2.22
7122  **/
7123 void
7124 gdk_window_coords_to_parent (GdkWindow *window,
7125                              gdouble    x,
7126                              gdouble    y,
7127                              gdouble   *parent_x,
7128                              gdouble   *parent_y)
7129 {
7130   g_return_if_fail (GDK_IS_WINDOW (window));
7131
7132   if (gdk_window_is_offscreen (window))
7133     {
7134       gdouble px, py;
7135
7136       to_embedder (window, x, y, &px, &py);
7137
7138       if (parent_x)
7139         *parent_x = px;
7140
7141       if (parent_y)
7142         *parent_y = py;
7143     }
7144   else
7145     {
7146       if (parent_x)
7147         *parent_x = x + window->x;
7148
7149       if (parent_y)
7150         *parent_y = y + window->y;
7151     }
7152 }
7153
7154 /**
7155  * gdk_window_coords_from_parent:
7156  * @window: a child window
7157  * @parent_x: X coordinate in parent's coordinate system
7158  * @parent_y: Y coordinate in parent's coordinate system
7159  * @x: (out) (allow-none): return location for X coordinate in child's coordinate system
7160  * @y: (out) (allow-none): return location for Y coordinate in child's coordinate system
7161  *
7162  * Transforms window coordinates from a parent window to a child
7163  * window, where the parent window is the normal parent as returned by
7164  * gdk_window_get_parent() for normal windows, and the window's
7165  * embedder as returned by gdk_offscreen_window_get_embedder() for
7166  * offscreen windows.
7167  *
7168  * For normal windows, calling this function is equivalent to subtracting
7169  * the return values of gdk_window_get_position() from the parent coordinates.
7170  * For offscreen windows however (which can be arbitrarily transformed),
7171  * this function calls the GdkWindow::from-embedder: signal to translate
7172  * the coordinates.
7173  *
7174  * You should always use this function when writing generic code that
7175  * walks down a window hierarchy.
7176  *
7177  * See also: gdk_window_coords_to_parent()
7178  *
7179  * Since: 2.22
7180  **/
7181 void
7182 gdk_window_coords_from_parent (GdkWindow *window,
7183                                gdouble    parent_x,
7184                                gdouble    parent_y,
7185                                gdouble   *x,
7186                                gdouble   *y)
7187 {
7188   g_return_if_fail (GDK_IS_WINDOW (window));
7189
7190   if (gdk_window_is_offscreen (window))
7191     {
7192       gdouble cx, cy;
7193
7194       from_embedder (window, parent_x, parent_y, &cx, &cy);
7195
7196       if (x)
7197         *x = cx;
7198
7199       if (y)
7200         *y = cy;
7201     }
7202   else
7203     {
7204       if (x)
7205         *x = parent_x - window->x;
7206
7207       if (y)
7208         *y = parent_y - window->y;
7209     }
7210 }
7211
7212 /**
7213  * gdk_window_shape_combine_region:
7214  * @window: a #GdkWindow
7215  * @shape_region: (allow-none): region of window to be non-transparent
7216  * @offset_x: X position of @shape_region in @window coordinates
7217  * @offset_y: Y position of @shape_region in @window coordinates
7218  *
7219  * Makes pixels in @window outside @shape_region be transparent,
7220  * so that the window may be nonrectangular.
7221  *
7222  * If @shape_region is %NULL, the shape will be unset, so the whole
7223  * window will be opaque again. @offset_x and @offset_y are ignored
7224  * if @shape_region is %NULL.
7225  *
7226  * On the X11 platform, this uses an X server extension which is
7227  * widely available on most common platforms, but not available on
7228  * very old X servers, and occasionally the implementation will be
7229  * buggy. On servers without the shape extension, this function
7230  * will do nothing.
7231  *
7232  * This function works on both toplevel and child windows.
7233  */
7234 void
7235 gdk_window_shape_combine_region (GdkWindow       *window,
7236                                  const cairo_region_t *shape_region,
7237                                  gint             offset_x,
7238                                  gint             offset_y)
7239 {
7240   cairo_region_t *old_region, *new_region, *diff;
7241
7242   g_return_if_fail (GDK_IS_WINDOW (window));
7243
7244   if (GDK_WINDOW_DESTROYED (window))
7245     return;
7246
7247   if (!window->shape && shape_region == NULL)
7248     return;
7249
7250   window->shaped = (shape_region != NULL);
7251
7252   if (window->shape)
7253     cairo_region_destroy (window->shape);
7254
7255   old_region = NULL;
7256   if (GDK_WINDOW_IS_MAPPED (window))
7257     old_region = cairo_region_copy (window->clip_region);
7258
7259   if (shape_region)
7260     {
7261       window->shape = cairo_region_copy (shape_region);
7262       cairo_region_translate (window->shape, offset_x, offset_y);
7263     }
7264   else
7265     window->shape = NULL;
7266
7267   recompute_visible_regions (window, TRUE, FALSE);
7268
7269   if (gdk_window_has_impl (window) &&
7270       !should_apply_clip_as_shape (window))
7271     apply_shape (window, window->shape);
7272
7273   if (old_region)
7274     {
7275       new_region = cairo_region_copy (window->clip_region);
7276
7277       /* New area in the window, needs invalidation */
7278       diff = cairo_region_copy (new_region);
7279       cairo_region_subtract (diff, old_region);
7280
7281       gdk_window_invalidate_region_full (window, diff, TRUE, CLEAR_BG_ALL);
7282
7283       cairo_region_destroy (diff);
7284
7285       if (!gdk_window_is_toplevel (window))
7286         {
7287           /* New area in the non-root parent window, needs invalidation */
7288           diff = cairo_region_copy (old_region);
7289           cairo_region_subtract (diff, new_region);
7290
7291           /* Adjust region to parent window coords */
7292           cairo_region_translate (diff, window->x, window->y);
7293
7294           gdk_window_invalidate_region_full (window->parent, diff, TRUE, CLEAR_BG_ALL);
7295
7296           cairo_region_destroy (diff);
7297         }
7298
7299       cairo_region_destroy (new_region);
7300       cairo_region_destroy (old_region);
7301     }
7302 }
7303
7304 static void
7305 do_child_shapes (GdkWindow *window,
7306                  gboolean merge)
7307 {
7308   GdkRectangle r;
7309   cairo_region_t *region;
7310
7311   r.x = 0;
7312   r.y = 0;
7313   r.width = window->width;
7314   r.height = window->height;
7315
7316   region = cairo_region_create_rectangle (&r);
7317   remove_child_area (window, NULL, FALSE, region, NULL);
7318
7319   if (merge && window->shape)
7320     cairo_region_subtract (region, window->shape);
7321
7322   gdk_window_shape_combine_region (window, region, 0, 0);
7323 }
7324
7325 /**
7326  * gdk_window_set_child_shapes:
7327  * @window: a #GdkWindow
7328  *
7329  * Sets the shape mask of @window to the union of shape masks
7330  * for all children of @window, ignoring the shape mask of @window
7331  * itself. Contrast with gdk_window_merge_child_shapes() which includes
7332  * the shape mask of @window in the masks to be merged.
7333  **/
7334 void
7335 gdk_window_set_child_shapes (GdkWindow *window)
7336 {
7337   g_return_if_fail (GDK_IS_WINDOW (window));
7338
7339   do_child_shapes (window, FALSE);
7340 }
7341
7342 /**
7343  * gdk_window_merge_child_shapes:
7344  * @window: a #GdkWindow
7345  *
7346  * Merges the shape masks for any child windows into the
7347  * shape mask for @window. i.e. the union of all masks
7348  * for @window and its children will become the new mask
7349  * for @window. See gdk_window_shape_combine_region().
7350  *
7351  * This function is distinct from gdk_window_set_child_shapes()
7352  * because it includes @window's shape mask in the set of shapes to
7353  * be merged.
7354  */
7355 void
7356 gdk_window_merge_child_shapes (GdkWindow *window)
7357 {
7358   g_return_if_fail (GDK_IS_WINDOW (window));
7359
7360   do_child_shapes (window, TRUE);
7361 }
7362
7363 /**
7364  * gdk_window_input_shape_combine_region:
7365  * @window: a #GdkWindow
7366  * @shape_region: region of window to be non-transparent
7367  * @offset_x: X position of @shape_region in @window coordinates
7368  * @offset_y: Y position of @shape_region in @window coordinates
7369  *
7370  * Like gdk_window_shape_combine_region(), but the shape applies
7371  * only to event handling. Mouse events which happen while
7372  * the pointer position corresponds to an unset bit in the
7373  * mask will be passed on the window below @window.
7374  *
7375  * An input shape is typically used with RGBA windows.
7376  * The alpha channel of the window defines which pixels are
7377  * invisible and allows for nicely antialiased borders,
7378  * and the input shape controls where the window is
7379  * "clickable".
7380  *
7381  * On the X11 platform, this requires version 1.1 of the
7382  * shape extension.
7383  *
7384  * On the Win32 platform, this functionality is not present and the
7385  * function does nothing.
7386  *
7387  * Since: 2.10
7388  */
7389 void
7390 gdk_window_input_shape_combine_region (GdkWindow       *window,
7391                                        const cairo_region_t *shape_region,
7392                                        gint             offset_x,
7393                                        gint             offset_y)
7394 {
7395   GdkWindowImplClass *impl_class;
7396
7397   g_return_if_fail (GDK_IS_WINDOW (window));
7398
7399   if (GDK_WINDOW_DESTROYED (window))
7400     return;
7401
7402   if (window->input_shape)
7403     cairo_region_destroy (window->input_shape);
7404
7405   if (shape_region)
7406     {
7407       window->input_shape = cairo_region_copy (shape_region);
7408       cairo_region_translate (window->input_shape, offset_x, offset_y);
7409     }
7410   else
7411     window->input_shape = NULL;
7412
7413   if (gdk_window_has_impl (window))
7414     {
7415       impl_class = GDK_WINDOW_IMPL_GET_CLASS (window->impl);
7416       impl_class->input_shape_combine_region (window, window->input_shape, 0, 0);
7417     }
7418
7419   /* Pointer may have e.g. moved outside window due to the input mask change */
7420   _gdk_synthesize_crossing_events_for_geometry_change (window);
7421 }
7422
7423 static void
7424 do_child_input_shapes (GdkWindow *window,
7425                        gboolean merge)
7426 {
7427   GdkRectangle r;
7428   cairo_region_t *region;
7429
7430   r.x = 0;
7431   r.y = 0;
7432   r.width = window->width;
7433   r.height = window->height;
7434
7435   region = cairo_region_create_rectangle (&r);
7436   remove_child_area (window, NULL, TRUE, region, NULL);
7437
7438   if (merge && window->shape)
7439     cairo_region_subtract (region, window->shape);
7440   if (merge && window->input_shape)
7441     cairo_region_subtract (region, window->input_shape);
7442
7443   gdk_window_input_shape_combine_region (window, region, 0, 0);
7444 }
7445
7446
7447 /**
7448  * gdk_window_set_child_input_shapes:
7449  * @window: a #GdkWindow
7450  *
7451  * Sets the input shape mask of @window to the union of input shape masks
7452  * for all children of @window, ignoring the input shape mask of @window
7453  * itself. Contrast with gdk_window_merge_child_input_shapes() which includes
7454  * the input shape mask of @window in the masks to be merged.
7455  *
7456  * Since: 2.10
7457  **/
7458 void
7459 gdk_window_set_child_input_shapes (GdkWindow *window)
7460 {
7461   g_return_if_fail (GDK_IS_WINDOW (window));
7462
7463   do_child_input_shapes (window, FALSE);
7464 }
7465
7466 /**
7467  * gdk_window_merge_child_input_shapes:
7468  * @window: a #GdkWindow
7469  *
7470  * Merges the input shape masks for any child windows into the
7471  * input shape mask for @window. i.e. the union of all input masks
7472  * for @window and its children will become the new input mask
7473  * for @window. See gdk_window_input_shape_combine_region().
7474  *
7475  * This function is distinct from gdk_window_set_child_input_shapes()
7476  * because it includes @window's input shape mask in the set of
7477  * shapes to be merged.
7478  *
7479  * Since: 2.10
7480  **/
7481 void
7482 gdk_window_merge_child_input_shapes (GdkWindow *window)
7483 {
7484   g_return_if_fail (GDK_IS_WINDOW (window));
7485
7486   do_child_input_shapes (window, TRUE);
7487 }
7488
7489
7490 /**
7491  * gdk_window_set_static_gravities:
7492  * @window: a #GdkWindow
7493  * @use_static: %TRUE to turn on static gravity
7494  *
7495  * Set the bit gravity of the given window to static, and flag it so
7496  * all children get static subwindow gravity. This is used if you are
7497  * implementing scary features that involve deep knowledge of the
7498  * windowing system. Don't worry about it unless you have to.
7499  *
7500  * Return value: %TRUE if the server supports static gravity
7501  */
7502 gboolean
7503 gdk_window_set_static_gravities (GdkWindow *window,
7504                                  gboolean   use_static)
7505 {
7506   GdkWindowImplClass *impl_class;
7507
7508   g_return_val_if_fail (GDK_IS_WINDOW (window), FALSE);
7509
7510   if (gdk_window_has_impl (window))
7511     {
7512       impl_class = GDK_WINDOW_IMPL_GET_CLASS (window->impl);
7513       return impl_class->set_static_gravities (window, use_static);
7514     }
7515
7516   return FALSE;
7517 }
7518
7519 /**
7520  * gdk_window_get_composited:
7521  * @window: a #GdkWindow
7522  *
7523  * Determines whether @window is composited.
7524  *
7525  * See gdk_window_set_composited().
7526  *
7527  * Returns: %TRUE if the window is composited.
7528  *
7529  * Since: 2.22
7530  **/
7531 gboolean
7532 gdk_window_get_composited (GdkWindow *window)
7533 {
7534   g_return_val_if_fail (GDK_IS_WINDOW (window), FALSE);
7535
7536   return window->composited;
7537 }
7538
7539 /**
7540  * gdk_window_set_composited:
7541  * @window: a #GdkWindow
7542  * @composited: %TRUE to set the window as composited
7543  *
7544  * Sets a #GdkWindow as composited, or unsets it. Composited
7545  * windows do not automatically have their contents drawn to
7546  * the screen. Drawing is redirected to an offscreen buffer
7547  * and an expose event is emitted on the parent of the composited
7548  * window. It is the responsibility of the parent's expose handler
7549  * to manually merge the off-screen content onto the screen in
7550  * whatever way it sees fit. See <xref linkend="composited-window-example"/>
7551  * for an example.
7552  *
7553  * It only makes sense for child windows to be composited; see
7554  * gdk_window_set_opacity() if you need translucent toplevel
7555  * windows.
7556  *
7557  * An additional effect of this call is that the area of this
7558  * window is no longer clipped from regions marked for
7559  * invalidation on its parent. Draws done on the parent
7560  * window are also no longer clipped by the child.
7561  *
7562  * This call is only supported on some systems (currently,
7563  * only X11 with new enough Xcomposite and Xdamage extensions).
7564  * You must call gdk_display_supports_composite() to check if
7565  * setting a window as composited is supported before
7566  * attempting to do so.
7567  *
7568  * Since: 2.12
7569  */
7570 void
7571 gdk_window_set_composited (GdkWindow *window,
7572                            gboolean   composited)
7573 {
7574   GdkDisplay *display;
7575   GdkWindowImplClass *impl_class;
7576
7577   g_return_if_fail (GDK_IS_WINDOW (window));
7578
7579   composited = composited != FALSE;
7580
7581   if (window->composited == composited)
7582     return;
7583
7584   if (composited)
7585     gdk_window_ensure_native (window);
7586
7587   display = gdk_window_get_display (window);
7588
7589   impl_class = GDK_WINDOW_IMPL_GET_CLASS (window->impl);
7590
7591   if (composited && (!gdk_display_supports_composite (display) || !impl_class->set_composited))
7592     {
7593       g_warning ("gdk_window_set_composited called but "
7594                  "compositing is not supported");
7595       return;
7596     }
7597
7598   impl_class->set_composited (window, composited);
7599
7600   recompute_visible_regions (window, TRUE, FALSE);
7601
7602   if (GDK_WINDOW_IS_MAPPED (window))
7603     gdk_window_invalidate_in_parent (window);
7604
7605   window->composited = composited;
7606 }
7607
7608 /**
7609  * gdk_window_get_modal_hint:
7610  * @window: A toplevel #GdkWindow.
7611  *
7612  * Determines whether or not the window manager is hinted that @window
7613  * has modal behaviour.
7614  *
7615  * Return value: whether or not the window has the modal hint set.
7616  *
7617  * Since: 2.22
7618  */
7619 gboolean
7620 gdk_window_get_modal_hint (GdkWindow *window)
7621 {
7622   g_return_val_if_fail (GDK_IS_WINDOW (window), FALSE);
7623
7624   return window->modal_hint;
7625 }
7626
7627 /**
7628  * gdk_window_get_accept_focus:
7629  * @window: a toplevel #GdkWindow.
7630  *
7631  * Determines whether or not the desktop environment shuld be hinted that
7632  * the window does not want to receive input focus.
7633  *
7634  * Return value: whether or not the window should receive input focus.
7635  *
7636  * Since: 2.22
7637  */
7638 gboolean
7639 gdk_window_get_accept_focus (GdkWindow *window)
7640 {
7641   g_return_val_if_fail (GDK_IS_WINDOW (window), FALSE);
7642
7643   return window->accept_focus;
7644 }
7645
7646 /**
7647  * gdk_window_get_focus_on_map:
7648  * @window: a toplevel #GdkWindow.
7649  *
7650  * Determines whether or not the desktop environment should be hinted that the
7651  * window does not want to receive input focus when it is mapped.
7652  *
7653  * Return value: whether or not the window wants to receive input focus when
7654  * it is mapped.
7655  *
7656  * Since: 2.22
7657  */
7658 gboolean
7659 gdk_window_get_focus_on_map (GdkWindow *window)
7660 {
7661   g_return_val_if_fail (GDK_IS_WINDOW (window), FALSE);
7662
7663   return window->focus_on_map;
7664 }
7665
7666 /**
7667  * gdk_window_is_input_only:
7668  * @window: a toplevel #GdkWindow
7669  *
7670  * Determines whether or not the window is an input only window.
7671  *
7672  * Return value: %TRUE if @window is input only
7673  *
7674  * Since: 2.22
7675  */
7676 gboolean
7677 gdk_window_is_input_only (GdkWindow *window)
7678 {
7679   g_return_val_if_fail (GDK_IS_WINDOW (window), FALSE);
7680
7681   return window->input_only;
7682 }
7683
7684 /**
7685  * gdk_window_is_shaped:
7686  * @window: a toplevel #GdkWindow
7687  *
7688  * Determines whether or not the window is shaped.
7689  *
7690  * Return value: %TRUE if @window is shaped
7691  *
7692  * Since: 2.22
7693  */
7694 gboolean
7695 gdk_window_is_shaped (GdkWindow *window)
7696 {
7697   g_return_val_if_fail (GDK_IS_WINDOW (window), FALSE);
7698
7699   return window->shaped;
7700 }
7701
7702 void
7703 _gdk_window_add_damage (GdkWindow *toplevel,
7704                         cairo_region_t *damaged_region)
7705 {
7706   GdkDisplay *display;
7707   GdkEvent event = { 0, };
7708   event.expose.type = GDK_DAMAGE;
7709   event.expose.window = toplevel;
7710   event.expose.send_event = FALSE;
7711   event.expose.region = damaged_region;
7712   cairo_region_get_extents (event.expose.region, &event.expose.area);
7713   display = gdk_window_get_display (event.expose.window);
7714   _gdk_event_queue_append (display, gdk_event_copy (&event));
7715 }
7716
7717 /* Gets the toplevel for a window as used for events,
7718    i.e. including offscreen parents */
7719 static GdkWindow *
7720 get_event_parent (GdkWindow *window)
7721 {
7722   if (gdk_window_is_offscreen (window))
7723     return gdk_offscreen_window_get_embedder ((GdkWindow *)window);
7724   else
7725     return window->parent;
7726 }
7727
7728 /* Gets the toplevel for a window as used for events,
7729    i.e. including offscreen parents going up to the native
7730    toplevel */
7731 static GdkWindow *
7732 get_event_toplevel (GdkWindow *window)
7733 {
7734   GdkWindow *parent;
7735
7736   while ((parent = get_event_parent (window)) != NULL &&
7737          (parent->window_type != GDK_WINDOW_ROOT))
7738     window = parent;
7739
7740   return window;
7741 }
7742
7743 gboolean
7744 _gdk_window_event_parent_of (GdkWindow *parent,
7745                              GdkWindow *child)
7746 {
7747   GdkWindow *w;
7748
7749   w = child;
7750   while (w != NULL)
7751     {
7752       if (w == parent)
7753         return TRUE;
7754
7755       w = get_event_parent (w);
7756     }
7757
7758   return FALSE;
7759 }
7760
7761 static void
7762 update_cursor (GdkDisplay *display,
7763                GdkDevice  *device)
7764 {
7765   GdkWindow *cursor_window, *parent, *toplevel;
7766   GdkWindow *pointer_window;
7767   GdkWindowImplClass *impl_class;
7768   GdkPointerWindowInfo *pointer_info;
7769   GdkDeviceGrabInfo *grab;
7770   GdkCursor *cursor;
7771
7772   pointer_info = _gdk_display_get_pointer_info (display, device);
7773   pointer_window = pointer_info->window_under_pointer;
7774
7775   /* We ignore the serials here and just pick the last grab
7776      we've sent, as that would shortly be used anyway. */
7777   grab = _gdk_display_get_last_device_grab (display, device);
7778   if (/* have grab */
7779       grab != NULL &&
7780       /* the pointer is not in a descendant of the grab window */
7781       !_gdk_window_event_parent_of (grab->window, pointer_window))
7782     {
7783       /* use the cursor from the grab window */
7784       cursor_window = grab->window;
7785     }
7786   else
7787     {
7788       /* otherwise use the cursor from the pointer window */
7789       cursor_window = pointer_window;
7790     }
7791
7792   /* Find the first window with the cursor actually set, as
7793      the cursor is inherited from the parent */
7794   while (cursor_window->cursor == NULL &&
7795          (parent = get_event_parent (cursor_window)) != NULL &&
7796          parent->window_type != GDK_WINDOW_ROOT)
7797     cursor_window = parent;
7798
7799   cursor = g_hash_table_lookup (cursor_window->device_cursor, device);
7800
7801   if (!cursor)
7802     cursor = cursor_window->cursor;
7803
7804   /* Set all cursors on toplevel, otherwise its tricky to keep track of
7805    * which native window has what cursor set. */
7806   toplevel = get_event_toplevel (pointer_window);
7807   impl_class = GDK_WINDOW_IMPL_GET_CLASS (toplevel->impl);
7808   if (impl_class->set_device_cursor)
7809     impl_class->set_device_cursor (toplevel, device, cursor);
7810 }
7811
7812 static gboolean
7813 point_in_window (GdkWindow *window,
7814                  gdouble    x,
7815                  gdouble    y)
7816 {
7817   return
7818     x >= 0 && x < window->width &&
7819     y >= 0 && y < window->height &&
7820     (window->shape == NULL ||
7821      cairo_region_contains_point (window->shape,
7822                           x, y)) &&
7823     (window->input_shape == NULL ||
7824      cairo_region_contains_point (window->input_shape,
7825                           x, y));
7826 }
7827
7828 static GdkWindow *
7829 convert_native_coords_to_toplevel (GdkWindow *window,
7830                                    gdouble    child_x,
7831                                    gdouble    child_y,
7832                                    gdouble   *toplevel_x,
7833                                    gdouble   *toplevel_y)
7834 {
7835   gdouble x, y;
7836
7837   x = child_x;
7838   y = child_y;
7839
7840   while (!gdk_window_is_toplevel (window))
7841     {
7842       x += window->x;
7843       y += window->y;
7844       window = window->parent;
7845     }
7846
7847   *toplevel_x = x;
7848   *toplevel_y = y;
7849
7850   return window;
7851 }
7852
7853 static void
7854 convert_toplevel_coords_to_window (GdkWindow *window,
7855                                    gdouble    toplevel_x,
7856                                    gdouble    toplevel_y,
7857                                    gdouble   *window_x,
7858                                    gdouble   *window_y)
7859 {
7860   GdkWindow *parent;
7861   gdouble x, y;
7862   GList *children, *l;
7863
7864   x = toplevel_x;
7865   y = toplevel_y;
7866
7867   children = NULL;
7868   while ((parent = get_event_parent (window)) != NULL &&
7869          (parent->window_type != GDK_WINDOW_ROOT))
7870     {
7871       children = g_list_prepend (children, window);
7872       window = parent;
7873     }
7874
7875   for (l = children; l != NULL; l = l->next)
7876     gdk_window_coords_from_parent (l->data, x, y, &x, &y);
7877
7878   g_list_free (children);
7879
7880   *window_x = x;
7881   *window_y = y;
7882 }
7883
7884 static GdkWindow *
7885 pick_embedded_child (GdkWindow *window,
7886                      gdouble    x,
7887                      gdouble    y)
7888 {
7889   GdkWindow *res;
7890
7891   res = NULL;
7892   g_signal_emit (window,
7893                  signals[PICK_EMBEDDED_CHILD], 0,
7894                  x, y, &res);
7895
7896   return res;
7897 }
7898
7899 GdkWindow *
7900 _gdk_window_find_child_at (GdkWindow *window,
7901                            int        x,
7902                            int        y)
7903 {
7904   GdkWindow *sub;
7905   double child_x, child_y;
7906   GList *l;
7907
7908   if (point_in_window (window, x, y))
7909     {
7910       /* Children is ordered in reverse stack order, i.e. first is topmost */
7911       for (l = window->children; l != NULL; l = l->next)
7912         {
7913           sub = l->data;
7914
7915           if (!GDK_WINDOW_IS_MAPPED (sub))
7916             continue;
7917
7918           gdk_window_coords_from_parent ((GdkWindow *)sub,
7919                                          x, y,
7920                                          &child_x, &child_y);
7921           if (point_in_window (sub, child_x, child_y))
7922             return (GdkWindow *)sub;
7923         }
7924
7925       if (window->num_offscreen_children > 0)
7926         {
7927           sub = pick_embedded_child (window,
7928                                      x, y);
7929           if (sub)
7930             return (GdkWindow *)sub;
7931         }
7932     }
7933
7934   return NULL;
7935 }
7936
7937 GdkWindow *
7938 _gdk_window_find_descendant_at (GdkWindow *window,
7939                                 gdouble    x,
7940                                 gdouble    y,
7941                                 gdouble   *found_x,
7942                                 gdouble   *found_y)
7943 {
7944   GdkWindow *sub;
7945   gdouble child_x, child_y;
7946   GList *l;
7947   gboolean found;
7948
7949   if (point_in_window (window, x, y))
7950     {
7951       do
7952         {
7953           found = FALSE;
7954           /* Children is ordered in reverse stack order, i.e. first is topmost */
7955           for (l = window->children; l != NULL; l = l->next)
7956             {
7957               sub = l->data;
7958
7959               if (!GDK_WINDOW_IS_MAPPED (sub))
7960                 continue;
7961
7962               gdk_window_coords_from_parent ((GdkWindow *)sub,
7963                                              x, y,
7964                                              &child_x, &child_y);
7965               if (point_in_window (sub, child_x, child_y))
7966                 {
7967                   x = child_x;
7968                   y = child_y;
7969                   window = sub;
7970                   found = TRUE;
7971                   break;
7972                 }
7973             }
7974           if (!found &&
7975               window->num_offscreen_children > 0)
7976             {
7977               sub = pick_embedded_child (window,
7978                                          x, y);
7979               if (sub)
7980                 {
7981                   found = TRUE;
7982                   window = sub;
7983                   from_embedder (sub, x, y, &x, &y);
7984                 }
7985             }
7986         }
7987       while (found);
7988     }
7989   else
7990     {
7991       /* Not in window at all */
7992       window = NULL;
7993     }
7994
7995   if (found_x)
7996     *found_x = x;
7997   if (found_y)
7998     *found_y = y;
7999
8000   return window;
8001 }
8002
8003 /**
8004  * gdk_window_beep:
8005  * @window: a toplevel #GdkWindow
8006  *
8007  * Emits a short beep associated to @window in the appropriate
8008  * display, if supported. Otherwise, emits a short beep on
8009  * the display just as gdk_display_beep().
8010  *
8011  * Since: 2.12
8012  **/
8013 void
8014 gdk_window_beep (GdkWindow *window)
8015 {
8016   GdkDisplay *display;
8017   GdkWindow *toplevel;
8018
8019   g_return_if_fail (GDK_IS_WINDOW (window));
8020
8021   if (GDK_WINDOW_DESTROYED (window))
8022     return;
8023
8024   toplevel = get_event_toplevel (window);
8025   display = gdk_window_get_display (window);
8026
8027   if (toplevel)
8028     {
8029       if (GDK_WINDOW_IMPL_GET_CLASS (toplevel->impl)->beep (toplevel))
8030         return;
8031     }
8032   
8033   /* If windows fail to beep, we beep the display. */
8034   gdk_display_beep (display);
8035 }
8036
8037 /**
8038  * gdk_window_set_support_multidevice:
8039  * @window: a #GdkWindow.
8040  * @support_multidevice: %TRUE to enable multidevice support in @window.
8041  *
8042  * This function will enable multidevice features in @window.
8043  *
8044  * Multidevice aware windows will need to handle properly multiple,
8045  * per device enter/leave events, device grabs and grab ownerships.
8046  *
8047  * Since: 3.0
8048  **/
8049 void
8050 gdk_window_set_support_multidevice (GdkWindow *window,
8051                                     gboolean   support_multidevice)
8052 {
8053   g_return_if_fail (GDK_IS_WINDOW (window));
8054
8055   if (GDK_WINDOW_DESTROYED (window))
8056     return;
8057
8058   if (window->support_multidevice == support_multidevice)
8059     return;
8060
8061   window->support_multidevice = support_multidevice;
8062
8063   /* FIXME: What to do if called when some pointers are inside the window ? */
8064 }
8065
8066 /**
8067  * gdk_window_get_support_multidevice:
8068  * @window: a #GdkWindow.
8069  *
8070  * Returns %TRUE if the window is aware of the existence of multiple
8071  * devices.
8072  *
8073  * Returns: %TRUE if the window handles multidevice features.
8074  *
8075  * Since: 3.0
8076  **/
8077 gboolean
8078 gdk_window_get_support_multidevice (GdkWindow *window)
8079 {
8080   g_return_val_if_fail (GDK_IS_WINDOW (window), FALSE);
8081
8082   if (GDK_WINDOW_DESTROYED (window))
8083     return FALSE;
8084
8085   return window->support_multidevice;
8086 }
8087
8088 static const guint type_masks[] = {
8089   GDK_SUBSTRUCTURE_MASK, /* GDK_DELETE                 = 0  */
8090   GDK_STRUCTURE_MASK, /* GDK_DESTROY                   = 1  */
8091   GDK_EXPOSURE_MASK, /* GDK_EXPOSE                     = 2  */
8092   GDK_POINTER_MOTION_MASK, /* GDK_MOTION_NOTIFY        = 3  */
8093   GDK_BUTTON_PRESS_MASK, /* GDK_BUTTON_PRESS           = 4  */
8094   GDK_BUTTON_PRESS_MASK, /* GDK_2BUTTON_PRESS          = 5  */
8095   GDK_BUTTON_PRESS_MASK, /* GDK_3BUTTON_PRESS          = 6  */
8096   GDK_BUTTON_RELEASE_MASK, /* GDK_BUTTON_RELEASE       = 7  */
8097   GDK_KEY_PRESS_MASK, /* GDK_KEY_PRESS                 = 8  */
8098   GDK_KEY_RELEASE_MASK, /* GDK_KEY_RELEASE             = 9  */
8099   GDK_ENTER_NOTIFY_MASK, /* GDK_ENTER_NOTIFY           = 10 */
8100   GDK_LEAVE_NOTIFY_MASK, /* GDK_LEAVE_NOTIFY           = 11 */
8101   GDK_FOCUS_CHANGE_MASK, /* GDK_FOCUS_CHANGE           = 12 */
8102   GDK_STRUCTURE_MASK, /* GDK_CONFIGURE                 = 13 */
8103   GDK_VISIBILITY_NOTIFY_MASK, /* GDK_MAP               = 14 */
8104   GDK_VISIBILITY_NOTIFY_MASK, /* GDK_UNMAP             = 15 */
8105   GDK_PROPERTY_CHANGE_MASK, /* GDK_PROPERTY_NOTIFY     = 16 */
8106   GDK_PROPERTY_CHANGE_MASK, /* GDK_SELECTION_CLEAR     = 17 */
8107   GDK_PROPERTY_CHANGE_MASK, /* GDK_SELECTION_REQUEST   = 18 */
8108   GDK_PROPERTY_CHANGE_MASK, /* GDK_SELECTION_NOTIFY    = 19 */
8109   GDK_PROXIMITY_IN_MASK, /* GDK_PROXIMITY_IN           = 20 */
8110   GDK_PROXIMITY_OUT_MASK, /* GDK_PROXIMITY_OUT         = 21 */
8111   GDK_ALL_EVENTS_MASK, /* GDK_DRAG_ENTER               = 22 */
8112   GDK_ALL_EVENTS_MASK, /* GDK_DRAG_LEAVE               = 23 */
8113   GDK_ALL_EVENTS_MASK, /* GDK_DRAG_MOTION              = 24 */
8114   GDK_ALL_EVENTS_MASK, /* GDK_DRAG_STATUS              = 25 */
8115   GDK_ALL_EVENTS_MASK, /* GDK_DROP_START               = 26 */
8116   GDK_ALL_EVENTS_MASK, /* GDK_DROP_FINISHED            = 27 */
8117   GDK_ALL_EVENTS_MASK, /* GDK_CLIENT_EVENT             = 28 */
8118   GDK_VISIBILITY_NOTIFY_MASK, /* GDK_VISIBILITY_NOTIFY = 29 */
8119   GDK_EXPOSURE_MASK, /* GDK_NO_EXPOSE                  = 30 */
8120   GDK_SCROLL_MASK | GDK_SMOOTH_SCROLL_MASK,/* GDK_SCROLL= 31 */
8121   0, /* GDK_WINDOW_STATE = 32 */
8122   0, /* GDK_SETTING = 33 */
8123   0, /* GDK_OWNER_CHANGE = 34 */
8124   0, /* GDK_GRAB_BROKEN = 35 */
8125   0, /* GDK_DAMAGE = 36 */
8126   GDK_TOUCH_MASK, /* GDK_TOUCH_BEGIN = 37 */
8127   GDK_TOUCH_MASK, /* GDK_TOUCH_UPDATE = 38 */
8128   GDK_TOUCH_MASK, /* GDK_TOUCH_END = 39 */
8129   GDK_TOUCH_MASK /* GDK_TOUCH_CANCEL = 40 */
8130 };
8131 G_STATIC_ASSERT (G_N_ELEMENTS (type_masks) == GDK_EVENT_LAST);
8132
8133 /* send motion events if the right buttons are down */
8134 static guint
8135 update_evmask_for_button_motion (guint           evmask,
8136                                  GdkModifierType mask)
8137 {
8138   if (evmask & GDK_BUTTON_MOTION_MASK &&
8139       mask & (GDK_BUTTON1_MASK |
8140               GDK_BUTTON2_MASK |
8141               GDK_BUTTON3_MASK |
8142               GDK_BUTTON4_MASK |
8143               GDK_BUTTON5_MASK))
8144     evmask |= GDK_POINTER_MOTION_MASK;
8145
8146   if ((evmask & GDK_BUTTON1_MOTION_MASK && mask & GDK_BUTTON1_MASK) ||
8147       (evmask & GDK_BUTTON2_MOTION_MASK && mask & GDK_BUTTON2_MASK) ||
8148       (evmask & GDK_BUTTON3_MOTION_MASK && mask & GDK_BUTTON3_MASK))
8149     evmask |= GDK_POINTER_MOTION_MASK;
8150
8151   return evmask;
8152 }
8153
8154 static gboolean
8155 is_button_type (GdkEventType type)
8156 {
8157   return type == GDK_BUTTON_PRESS ||
8158          type == GDK_2BUTTON_PRESS ||
8159          type == GDK_3BUTTON_PRESS ||
8160          type == GDK_BUTTON_RELEASE ||
8161          type == GDK_TOUCH_BEGIN ||
8162          type == GDK_TOUCH_END ||
8163          type == GDK_SCROLL;
8164 }
8165
8166 static gboolean
8167 is_motion_type (GdkEventType type)
8168 {
8169   return type == GDK_MOTION_NOTIFY ||
8170          type == GDK_TOUCH_UPDATE ||
8171          type == GDK_ENTER_NOTIFY ||
8172          type == GDK_LEAVE_NOTIFY;
8173 }
8174
8175 static gboolean
8176 is_touch_type (GdkEventType type)
8177 {
8178   return type == GDK_TOUCH_BEGIN ||
8179          type == GDK_TOUCH_UPDATE ||
8180          type == GDK_TOUCH_END ||
8181          type == GDK_TOUCH_CANCEL;
8182 }
8183
8184 static GdkWindow *
8185 find_common_ancestor (GdkWindow *win1,
8186                       GdkWindow *win2)
8187 {
8188   GdkWindow *tmp;
8189   GList *path1 = NULL, *path2 = NULL;
8190   GList *list1, *list2;
8191
8192   tmp = win1;
8193   while (tmp != NULL && tmp->window_type != GDK_WINDOW_ROOT)
8194     {
8195       path1 = g_list_prepend (path1, tmp);
8196       tmp = get_event_parent (tmp);
8197     }
8198
8199   tmp = win2;
8200   while (tmp != NULL && tmp->window_type != GDK_WINDOW_ROOT)
8201     {
8202       path2 = g_list_prepend (path2, tmp);
8203       tmp = get_event_parent (tmp);
8204     }
8205
8206   list1 = path1;
8207   list2 = path2;
8208   tmp = NULL;
8209   while (list1 && list2 && (list1->data == list2->data))
8210     {
8211       tmp = list1->data;
8212       list1 = g_list_next (list1);
8213       list2 = g_list_next (list2);
8214     }
8215   g_list_free (path1);
8216   g_list_free (path2);
8217
8218   return tmp;
8219 }
8220
8221 GdkEvent *
8222 _gdk_make_event (GdkWindow    *window,
8223                  GdkEventType  type,
8224                  GdkEvent     *event_in_queue,
8225                  gboolean      before_event)
8226 {
8227   GdkEvent *event = gdk_event_new (type);
8228   guint32 the_time;
8229   GdkModifierType the_state;
8230
8231   the_time = gdk_event_get_time (event_in_queue);
8232   gdk_event_get_state (event_in_queue, &the_state);
8233
8234   event->any.window = g_object_ref (window);
8235   event->any.send_event = FALSE;
8236   if (event_in_queue && event_in_queue->any.send_event)
8237     event->any.send_event = TRUE;
8238
8239   switch (type)
8240     {
8241     case GDK_MOTION_NOTIFY:
8242       event->motion.time = the_time;
8243       event->motion.axes = NULL;
8244       event->motion.state = the_state;
8245       break;
8246
8247     case GDK_BUTTON_PRESS:
8248     case GDK_2BUTTON_PRESS:
8249     case GDK_3BUTTON_PRESS:
8250     case GDK_BUTTON_RELEASE:
8251       event->button.time = the_time;
8252       event->button.axes = NULL;
8253       event->button.state = the_state;
8254       break;
8255
8256     case GDK_TOUCH_BEGIN:
8257     case GDK_TOUCH_UPDATE:
8258     case GDK_TOUCH_END:
8259     case GDK_TOUCH_CANCEL:
8260       event->touch.time = the_time;
8261       event->touch.axes = NULL;
8262       event->touch.state = the_state;
8263       break;
8264
8265     case GDK_SCROLL:
8266       event->scroll.time = the_time;
8267       event->scroll.state = the_state;
8268       break;
8269
8270     case GDK_KEY_PRESS:
8271     case GDK_KEY_RELEASE:
8272       event->key.time = the_time;
8273       event->key.state = the_state;
8274       break;
8275
8276     case GDK_ENTER_NOTIFY:
8277     case GDK_LEAVE_NOTIFY:
8278       event->crossing.time = the_time;
8279       event->crossing.state = the_state;
8280       break;
8281
8282     case GDK_PROPERTY_NOTIFY:
8283       event->property.time = the_time;
8284       event->property.state = the_state;
8285       break;
8286
8287     case GDK_SELECTION_CLEAR:
8288     case GDK_SELECTION_REQUEST:
8289     case GDK_SELECTION_NOTIFY:
8290       event->selection.time = the_time;
8291       break;
8292
8293     case GDK_PROXIMITY_IN:
8294     case GDK_PROXIMITY_OUT:
8295       event->proximity.time = the_time;
8296       break;
8297
8298     case GDK_DRAG_ENTER:
8299     case GDK_DRAG_LEAVE:
8300     case GDK_DRAG_MOTION:
8301     case GDK_DRAG_STATUS:
8302     case GDK_DROP_START:
8303     case GDK_DROP_FINISHED:
8304       event->dnd.time = the_time;
8305       break;
8306
8307     case GDK_FOCUS_CHANGE:
8308     case GDK_CONFIGURE:
8309     case GDK_MAP:
8310     case GDK_UNMAP:
8311     case GDK_CLIENT_EVENT:
8312     case GDK_VISIBILITY_NOTIFY:
8313     case GDK_DELETE:
8314     case GDK_DESTROY:
8315     case GDK_EXPOSE:
8316     default:
8317       break;
8318     }
8319
8320   if (event_in_queue)
8321     {
8322     if (before_event)
8323       _gdk_event_queue_insert_before (gdk_window_get_display (window), event_in_queue, event);
8324     else
8325       _gdk_event_queue_insert_after (gdk_window_get_display (window), event_in_queue, event);
8326     }
8327   else
8328     _gdk_event_queue_append (gdk_window_get_display (window), event);
8329
8330   return event;
8331 }
8332
8333 static void
8334 send_crossing_event (GdkDisplay                 *display,
8335                      GdkWindow                  *toplevel,
8336                      GdkWindow                  *window,
8337                      GdkEventType                type,
8338                      GdkCrossingMode             mode,
8339                      GdkNotifyType               notify_type,
8340                      GdkWindow                  *subwindow,
8341                      GdkDevice                  *device,
8342                      GdkDevice                  *source_device,
8343                      gint                        toplevel_x,
8344                      gint                        toplevel_y,
8345                      GdkModifierType             mask,
8346                      guint32                     time_,
8347                      GdkEvent                   *event_in_queue,
8348                      gulong                      serial)
8349 {
8350   GdkEvent *event;
8351   guint32 window_event_mask, type_event_mask;
8352   GdkDeviceGrabInfo *grab;
8353   GdkTouchGrabInfo *touch_grab = NULL;
8354   GdkPointerWindowInfo *pointer_info;
8355   gboolean block_event = FALSE;
8356   GdkEventSequence *sequence;
8357
8358   grab = _gdk_display_has_device_grab (display, device, serial);
8359   pointer_info = _gdk_display_get_pointer_info (display, device);
8360
8361   sequence = gdk_event_get_event_sequence (event_in_queue);
8362   if (sequence)
8363     touch_grab = _gdk_display_has_touch_grab (display, device, sequence, serial);
8364
8365   if (touch_grab)
8366     {
8367       if (window != touch_grab->window)
8368         return;
8369
8370       window_event_mask = touch_grab->event_mask;
8371     }
8372   else if (grab != NULL &&
8373            !grab->owner_events)
8374     {
8375       /* !owner_event => only report events wrt grab window, ignore rest */
8376       if ((GdkWindow *)window != grab->window)
8377         return;
8378       window_event_mask = grab->event_mask;
8379     }
8380   else
8381     window_event_mask = window->event_mask;
8382
8383   if (type == GDK_ENTER_NOTIFY &&
8384       pointer_info->need_touch_press_enter &&
8385       mode != GDK_CROSSING_TOUCH_BEGIN &&
8386       mode != GDK_CROSSING_TOUCH_END)
8387     {
8388       block_event = TRUE;
8389     }
8390   else if (type == GDK_LEAVE_NOTIFY)
8391     {
8392       type_event_mask = GDK_LEAVE_NOTIFY_MASK;
8393       window->devices_inside = g_list_remove (window->devices_inside, device);
8394
8395       if (!window->support_multidevice && window->devices_inside)
8396         {
8397           /* Block leave events unless it's the last pointer */
8398           block_event = TRUE;
8399         }
8400     }
8401   else
8402     {
8403       type_event_mask = GDK_ENTER_NOTIFY_MASK;
8404
8405       if (!window->support_multidevice && window->devices_inside)
8406         {
8407           /* Only emit enter events for the first device */
8408           block_event = TRUE;
8409         }
8410
8411       if (gdk_device_get_device_type (device) == GDK_DEVICE_TYPE_MASTER &&
8412           gdk_device_get_mode (device) != GDK_MODE_DISABLED &&
8413           !g_list_find (window->devices_inside, device))
8414         window->devices_inside = g_list_prepend (window->devices_inside, device);
8415     }
8416
8417   if (block_event)
8418     return;
8419
8420   if (window_event_mask & type_event_mask)
8421     {
8422       event = _gdk_make_event ((GdkWindow *)window, type, event_in_queue, TRUE);
8423       gdk_event_set_device (event, device);
8424
8425       if (source_device)
8426         gdk_event_set_source_device (event, source_device);
8427
8428       event->crossing.time = time_;
8429       event->crossing.subwindow = subwindow;
8430       if (subwindow)
8431         g_object_ref (subwindow);
8432       convert_toplevel_coords_to_window ((GdkWindow *)window,
8433                                          toplevel_x, toplevel_y,
8434                                          &event->crossing.x, &event->crossing.y);
8435       event->crossing.x_root = toplevel_x + toplevel->x;
8436       event->crossing.y_root = toplevel_y + toplevel->y;
8437       event->crossing.mode = mode;
8438       event->crossing.detail = notify_type;
8439       event->crossing.focus = FALSE;
8440       event->crossing.state = mask;
8441     }
8442 }
8443
8444
8445 /* The coordinates are in the toplevel window that src/dest are in.
8446  * src and dest are always (if != NULL) in the same toplevel, as
8447  * we get a leave-notify and set the window_under_pointer to null
8448  * before crossing to another toplevel.
8449  */
8450 void
8451 _gdk_synthesize_crossing_events (GdkDisplay                 *display,
8452                                  GdkWindow                  *src,
8453                                  GdkWindow                  *dest,
8454                                  GdkDevice                  *device,
8455                                  GdkDevice                  *source_device,
8456                                  GdkCrossingMode             mode,
8457                                  gint                        toplevel_x,
8458                                  gint                        toplevel_y,
8459                                  GdkModifierType             mask,
8460                                  guint32                     time_,
8461                                  GdkEvent                   *event_in_queue,
8462                                  gulong                      serial,
8463                                  gboolean                    non_linear)
8464 {
8465   GdkWindow *c;
8466   GdkWindow *win, *last, *next;
8467   GList *path, *list;
8468   GdkWindow *a;
8469   GdkWindow *b;
8470   GdkWindow *toplevel;
8471   GdkNotifyType notify_type;
8472
8473   /* TODO: Don't send events to toplevel, as we get those from the windowing system */
8474
8475   a = src;
8476   b = dest;
8477   if (src == dest)
8478     return; /* No crossings generated between src and dest */
8479
8480   if (gdk_device_get_device_type (device) != GDK_DEVICE_TYPE_MASTER)
8481     {
8482       if (a && gdk_window_get_device_events (src, device) == 0)
8483         a = NULL;
8484
8485       if (b && gdk_window_get_device_events (dest, device) == 0)
8486         b = NULL;
8487     }
8488
8489   if (!a && !b)
8490     return;
8491
8492   c = find_common_ancestor (a, b);
8493
8494   non_linear |= (c != a) && (c != b);
8495
8496   if (a) /* There might not be a source (i.e. if no previous pointer_in_window) */
8497     {
8498       toplevel = gdk_window_get_toplevel (a);
8499
8500       /* Traverse up from a to (excluding) c sending leave events */
8501       if (non_linear)
8502         notify_type = GDK_NOTIFY_NONLINEAR;
8503       else if (c == a)
8504         notify_type = GDK_NOTIFY_INFERIOR;
8505       else
8506         notify_type = GDK_NOTIFY_ANCESTOR;
8507       send_crossing_event (display, toplevel,
8508                            a, GDK_LEAVE_NOTIFY,
8509                            mode,
8510                            notify_type,
8511                            NULL, device, source_device,
8512                            toplevel_x, toplevel_y,
8513                            mask, time_,
8514                            event_in_queue,
8515                            serial);
8516
8517       if (c != a)
8518         {
8519           if (non_linear)
8520             notify_type = GDK_NOTIFY_NONLINEAR_VIRTUAL;
8521           else
8522             notify_type = GDK_NOTIFY_VIRTUAL;
8523
8524           last = a;
8525           win = get_event_parent (a);
8526           while (win != c && win->window_type != GDK_WINDOW_ROOT)
8527             {
8528               send_crossing_event (display, toplevel,
8529                                    win, GDK_LEAVE_NOTIFY,
8530                                    mode,
8531                                    notify_type,
8532                                    (GdkWindow *)last,
8533                                    device, source_device,
8534                                    toplevel_x, toplevel_y,
8535                                    mask, time_,
8536                                    event_in_queue,
8537                                    serial);
8538
8539               last = win;
8540               win = get_event_parent (win);
8541             }
8542         }
8543     }
8544
8545   if (b) /* Might not be a dest, e.g. if we're moving out of the window */
8546     {
8547       toplevel = gdk_window_get_toplevel ((GdkWindow *)b);
8548
8549       /* Traverse down from c to b */
8550       if (c != b)
8551         {
8552           path = NULL;
8553           win = get_event_parent (b);
8554           while (win != c && win->window_type != GDK_WINDOW_ROOT)
8555             {
8556               path = g_list_prepend (path, win);
8557               win = get_event_parent (win);
8558             }
8559
8560           if (non_linear)
8561             notify_type = GDK_NOTIFY_NONLINEAR_VIRTUAL;
8562           else
8563             notify_type = GDK_NOTIFY_VIRTUAL;
8564
8565           list = path;
8566           while (list)
8567             {
8568               win = list->data;
8569               list = g_list_next (list);
8570               if (list)
8571                 next = list->data;
8572               else
8573                 next = b;
8574
8575               send_crossing_event (display, toplevel,
8576                                    win, GDK_ENTER_NOTIFY,
8577                                    mode,
8578                                    notify_type,
8579                                    (GdkWindow *)next,
8580                                    device, source_device,
8581                                    toplevel_x, toplevel_y,
8582                                    mask, time_,
8583                                    event_in_queue,
8584                                    serial);
8585             }
8586           g_list_free (path);
8587         }
8588
8589
8590       if (non_linear)
8591         notify_type = GDK_NOTIFY_NONLINEAR;
8592       else if (c == a)
8593         notify_type = GDK_NOTIFY_ANCESTOR;
8594       else
8595         notify_type = GDK_NOTIFY_INFERIOR;
8596
8597       send_crossing_event (display, toplevel,
8598                            b, GDK_ENTER_NOTIFY,
8599                            mode,
8600                            notify_type,
8601                            NULL,
8602                            device, source_device,
8603                            toplevel_x, toplevel_y,
8604                            mask, time_,
8605                            event_in_queue,
8606                            serial);
8607     }
8608 }
8609
8610 /* Returns the window inside the event window with the pointer in it
8611  * at the specified coordinates, or NULL if its not in any child of
8612  * the toplevel. It also takes into account !owner_events grabs.
8613  */
8614 static GdkWindow *
8615 get_pointer_window (GdkDisplay *display,
8616                     GdkWindow *event_window,
8617                     GdkDevice *device,
8618                     gdouble toplevel_x,
8619                     gdouble toplevel_y,
8620                     gulong serial)
8621 {
8622   GdkWindow *pointer_window;
8623   GdkDeviceGrabInfo *grab;
8624   GdkPointerWindowInfo *pointer_info;
8625
8626   pointer_info = _gdk_display_get_pointer_info (display, device);
8627
8628   if (event_window == pointer_info->toplevel_under_pointer)
8629     pointer_window =
8630       _gdk_window_find_descendant_at (event_window,
8631                                       toplevel_x, toplevel_y,
8632                                       NULL, NULL);
8633   else
8634     pointer_window = NULL;
8635
8636   grab = _gdk_display_has_device_grab (display, device, serial);
8637   if (grab != NULL &&
8638       !grab->owner_events &&
8639       pointer_window != grab->window)
8640     pointer_window = NULL;
8641
8642   return pointer_window;
8643 }
8644
8645 void
8646 _gdk_display_set_window_under_pointer (GdkDisplay *display,
8647                                        GdkDevice  *device,
8648                                        GdkWindow  *window)
8649 {
8650   GdkPointerWindowInfo *device_info;
8651
8652   device_info = _gdk_display_get_pointer_info (display, device);
8653
8654   if (device_info->window_under_pointer)
8655     g_object_unref (device_info->window_under_pointer);
8656   device_info->window_under_pointer = window;
8657
8658   if (window)
8659     {
8660       g_object_ref (window);
8661       update_cursor (display, device);
8662     }
8663
8664   _gdk_display_enable_motion_hints (display, device);
8665 }
8666
8667 /**
8668  * gdk_pointer_grab:
8669  * @window: the #GdkWindow which will own the grab (the grab window).
8670  * @owner_events: if %FALSE then all pointer events are reported with respect to
8671  *                @window and are only reported if selected by @event_mask. If %TRUE then pointer
8672  *                events for this application are reported as normal, but pointer events outside
8673  *                this application are reported with respect to @window and only if selected by
8674  *                @event_mask. In either mode, unreported events are discarded.
8675  * @event_mask: specifies the event mask, which is used in accordance with
8676  *              @owner_events. Note that only pointer events (i.e. button and motion events)
8677  *              may be selected.
8678  * @confine_to: (allow-none): If non-%NULL, the pointer will be confined to this
8679  *              window during the grab. If the pointer is outside @confine_to, it will
8680  *              automatically be moved to the closest edge of @confine_to and enter
8681  *              and leave events will be generated as necessary.
8682  * @cursor: (allow-none): the cursor to display while the grab is active. If this is %NULL then
8683  *          the normal cursors are used for @window and its descendants, and the cursor
8684  *          for @window is used for all other windows.
8685  * @time_: the timestamp of the event which led to this pointer grab. This usually
8686  *         comes from a #GdkEventButton struct, though %GDK_CURRENT_TIME can be used if
8687  *         the time isn't known.
8688  *
8689  * Grabs the pointer (usually a mouse) so that all events are passed to this
8690  * application until the pointer is ungrabbed with gdk_pointer_ungrab(), or
8691  * the grab window becomes unviewable.
8692  * This overrides any previous pointer grab by this client.
8693  *
8694  * Pointer grabs are used for operations which need complete control over mouse
8695  * events, even if the mouse leaves the application.
8696  * For example in GTK+ it is used for Drag and Drop, for dragging the handle in
8697  * the #GtkHPaned and #GtkVPaned widgets.
8698  *
8699  * Note that if the event mask of an X window has selected both button press and
8700  * button release events, then a button press event will cause an automatic
8701  * pointer grab until the button is released.
8702  * X does this automatically since most applications expect to receive button
8703  * press and release events in pairs.
8704  * It is equivalent to a pointer grab on the window with @owner_events set to
8705  * %TRUE.
8706  *
8707  * If you set up anything at the time you take the grab that needs to be cleaned
8708  * up when the grab ends, you should handle the #GdkEventGrabBroken events that
8709  * are emitted when the grab ends unvoluntarily.
8710  *
8711  * Returns: %GDK_GRAB_SUCCESS if the grab was successful.
8712  *
8713  * Deprecated: 3.0: Use gdk_device_grab() instead.
8714  **/
8715 GdkGrabStatus
8716 gdk_pointer_grab (GdkWindow *     window,
8717                   gboolean        owner_events,
8718                   GdkEventMask    event_mask,
8719                   GdkWindow *     confine_to,
8720                   GdkCursor *     cursor,
8721                   guint32         time)
8722 {
8723   GdkWindow *native;
8724   GdkDisplay *display;
8725   GdkDeviceManager *device_manager;
8726   GdkDevice *device;
8727   GdkGrabStatus res = 0;
8728   gulong serial;
8729   GList *devices, *dev;
8730
8731   g_return_val_if_fail (window != NULL, 0);
8732   g_return_val_if_fail (GDK_IS_WINDOW (window), 0);
8733   g_return_val_if_fail (confine_to == NULL || GDK_IS_WINDOW (confine_to), 0);
8734
8735   /* We need a native window for confine to to work, ensure we have one */
8736   if (confine_to)
8737     {
8738       if (!gdk_window_ensure_native (confine_to))
8739         {
8740           g_warning ("Can't confine to grabbed window, not native");
8741           confine_to = NULL;
8742         }
8743     }
8744
8745   /* Non-viewable client side window => fail */
8746   if (!_gdk_window_has_impl (window) &&
8747       !gdk_window_is_viewable (window))
8748     return GDK_GRAB_NOT_VIEWABLE;
8749
8750   native = gdk_window_get_toplevel (window);
8751   while (gdk_window_is_offscreen (native))
8752     {
8753       native = gdk_offscreen_window_get_embedder (native);
8754
8755       if (native == NULL ||
8756           (!_gdk_window_has_impl (native) &&
8757            !gdk_window_is_viewable (native)))
8758         return GDK_GRAB_NOT_VIEWABLE;
8759
8760       native = gdk_window_get_toplevel (native);
8761     }
8762
8763   display = gdk_window_get_display (window);
8764
8765   serial = _gdk_display_get_next_serial (display);
8766   device_manager = gdk_display_get_device_manager (display);
8767   devices = gdk_device_manager_list_devices (device_manager, GDK_DEVICE_TYPE_MASTER);
8768
8769   /* FIXME: Should this be generic to all backends? */
8770   /* FIXME: What happens with extended devices? */
8771   for (dev = devices; dev; dev = dev->next)
8772     {
8773       device = dev->data;
8774
8775       if (gdk_device_get_source (device) != GDK_SOURCE_MOUSE)
8776         continue;
8777
8778       res = GDK_DEVICE_GET_CLASS (device)->grab (device,
8779                                                  native,
8780                                                  owner_events,
8781                                                  get_native_grab_event_mask (event_mask),
8782                                                  confine_to,
8783                                                  cursor,
8784                                                  time);
8785
8786       if (res == GDK_GRAB_SUCCESS)
8787         _gdk_display_add_device_grab (display,
8788                                       device,
8789                                       window,
8790                                       native,
8791                                       GDK_OWNERSHIP_NONE,
8792                                       owner_events,
8793                                       event_mask,
8794                                       serial,
8795                                       time,
8796                                       FALSE);
8797     }
8798
8799   /* FIXME: handle errors when grabbing */
8800
8801   g_list_free (devices);
8802
8803   return res;
8804 }
8805
8806 /**
8807  * gdk_keyboard_grab:
8808  * @window: the #GdkWindow which will own the grab (the grab window).
8809  * @owner_events: if %FALSE then all keyboard events are reported with respect to
8810  *   @window. If %TRUE then keyboard events for this application are
8811  *   reported as normal, but keyboard events outside this application
8812  *   are reported with respect to @window. Both key press and key
8813  *   release events are always reported, independant of the event mask
8814  *   set by the application.
8815  * @time_: a timestamp from a #GdkEvent, or %GDK_CURRENT_TIME if no timestamp is
8816  *   available.
8817  *
8818  * Grabs the keyboard so that all events are passed to this
8819  * application until the keyboard is ungrabbed with gdk_keyboard_ungrab().
8820  * This overrides any previous keyboard grab by this client.
8821  *
8822  * If you set up anything at the time you take the grab that needs to be cleaned
8823  * up when the grab ends, you should handle the #GdkEventGrabBroken events that
8824  * are emitted when the grab ends unvoluntarily.
8825  *
8826  * Returns: %GDK_GRAB_SUCCESS if the grab was successful.
8827  *
8828  * Deprecated: 3.0: Use gdk_device_grab() instead.
8829  **/
8830 GdkGrabStatus
8831 gdk_keyboard_grab (GdkWindow *window,
8832                    gboolean   owner_events,
8833                    guint32    time)
8834 {
8835   GdkWindow *native;
8836   GdkDisplay *display;
8837   GdkDeviceManager *device_manager;
8838   GdkDevice *device;
8839   GdkGrabStatus res = 0;
8840   gulong serial;
8841   GList *devices, *dev;
8842
8843   g_return_val_if_fail (GDK_IS_WINDOW (window), 0);
8844
8845   /* Non-viewable client side window => fail */
8846   if (!_gdk_window_has_impl (window) &&
8847       !gdk_window_is_viewable (window))
8848     return GDK_GRAB_NOT_VIEWABLE;
8849
8850   native = gdk_window_get_toplevel (window);
8851
8852   while (gdk_window_is_offscreen (native))
8853     {
8854       native = gdk_offscreen_window_get_embedder (native);
8855
8856       if (native == NULL ||
8857           (!_gdk_window_has_impl (native) &&
8858            !gdk_window_is_viewable (native)))
8859         return GDK_GRAB_NOT_VIEWABLE;
8860
8861       native = gdk_window_get_toplevel (native);
8862     }
8863
8864   display = gdk_window_get_display (window);
8865   serial = _gdk_display_get_next_serial (display);
8866   device_manager = gdk_display_get_device_manager (display);
8867   devices = gdk_device_manager_list_devices (device_manager, GDK_DEVICE_TYPE_MASTER);
8868
8869   /* FIXME: Should this be generic to all backends? */
8870   /* FIXME: What happens with extended devices? */
8871   for (dev = devices; dev; dev = dev->next)
8872     {
8873       device = dev->data;
8874
8875       if (gdk_device_get_source (device) != GDK_SOURCE_KEYBOARD)
8876         continue;
8877
8878       res = GDK_DEVICE_GET_CLASS (device)->grab (device,
8879                                                  native,
8880                                                  owner_events,
8881                                                  GDK_KEY_PRESS_MASK | GDK_KEY_RELEASE_MASK,
8882                                                  NULL,
8883                                                  NULL,
8884                                                  time);
8885
8886       if (res == GDK_GRAB_SUCCESS)
8887         _gdk_display_add_device_grab (display,
8888                                       device,
8889                                       window,
8890                                       native,
8891                                       GDK_OWNERSHIP_NONE,
8892                                       owner_events, 0,
8893                                       serial,
8894                                       time,
8895                                       FALSE);
8896     }
8897
8898   /* FIXME: handle errors when grabbing */
8899
8900   g_list_free (devices);
8901
8902   return res;
8903 }
8904
8905 /**
8906  * gdk_window_geometry_changed:
8907  * @window: an embedded offscreen #GdkWindow
8908  *
8909  * This function informs GDK that the geometry of an embedded
8910  * offscreen window has changed. This is necessary for GDK to keep
8911  * track of which offscreen window the pointer is in.
8912  *
8913  * Since: 2.18
8914  */
8915 void
8916 gdk_window_geometry_changed (GdkWindow *window)
8917 {
8918   _gdk_synthesize_crossing_events_for_geometry_change (window);
8919 }
8920
8921 static void
8922 source_events_device_added (GdkDeviceManager *device_manager,
8923                             GdkDevice        *device,
8924                             gpointer          user_data)
8925 {
8926   GdkWindow *window;
8927   GdkEventMask event_mask;
8928   GdkInputSource source;
8929
8930   if (gdk_device_get_device_type (device) != GDK_DEVICE_TYPE_FLOATING)
8931     return;
8932
8933   window = user_data;
8934   source = gdk_device_get_source (device);
8935
8936   event_mask = GPOINTER_TO_INT (g_hash_table_lookup (window->source_event_masks,
8937                                                      GINT_TO_POINTER (source)));
8938   if (event_mask)
8939     gdk_window_set_device_events (window, device, event_mask);
8940 }
8941
8942 static void
8943 source_events_device_changed (GdkDeviceManager *device_manager,
8944                               GdkDevice        *device,
8945                               gpointer          user_data)
8946 {
8947   GdkDeviceType type;
8948   GdkInputSource source;
8949   GdkEventMask event_mask;
8950   GdkWindow *window;
8951
8952   window = user_data;
8953   type = gdk_device_get_device_type (device);
8954   source = gdk_device_get_source (device);
8955
8956   event_mask = GPOINTER_TO_INT (g_hash_table_lookup (window->source_event_masks,
8957                                                      GINT_TO_POINTER (source)));
8958
8959   if (!event_mask)
8960     return;
8961
8962   if (type == GDK_DEVICE_TYPE_FLOATING)
8963     {
8964       /* The device was just floated, enable its event mask */
8965       gdk_window_set_device_events (window, device, event_mask);
8966     }
8967   else if (type == GDK_DEVICE_TYPE_SLAVE)
8968     gdk_window_set_device_events (window, device, 0);
8969 }
8970
8971 /**
8972  * gdk_window_set_source_events:
8973  * @window: a #GdkWindow
8974  * @source: a #GdkInputSource to define the source class.
8975  * @event_mask: event mask for @window
8976  *
8977  * Sets the event mask for any floating device (i.e. not attached to any
8978  * visible pointer) that has the source defined as @source. This event
8979  * mask will be applied both to currently existing, newly added devices
8980  * after this call, and devices being attached/detached.
8981  *
8982  * Since: 3.0
8983  **/
8984 void
8985 gdk_window_set_source_events (GdkWindow      *window,
8986                               GdkInputSource  source,
8987                               GdkEventMask    event_mask)
8988 {
8989   GdkDeviceManager *device_manager;
8990   GdkDisplay *display;
8991   GList *devices, *d;
8992   guint size;
8993
8994   g_return_if_fail (GDK_IS_WINDOW (window));
8995
8996   display = gdk_window_get_display (window);
8997   device_manager = gdk_display_get_device_manager (display);
8998
8999   devices = gdk_device_manager_list_devices (device_manager, GDK_DEVICE_TYPE_FLOATING);
9000
9001   /* Set event mask for existing devices */
9002   for (d = devices; d; d = d->next)
9003     {
9004       GdkDevice *device = d->data;
9005
9006       if (source == gdk_device_get_source (device))
9007         gdk_window_set_device_events (window, device, event_mask);
9008     }
9009
9010   g_list_free (devices);
9011
9012   /* Update accounting */
9013   if (G_UNLIKELY (!window->source_event_masks))
9014     window->source_event_masks = g_hash_table_new (NULL, NULL);
9015
9016   if (event_mask)
9017     g_hash_table_insert (window->source_event_masks,
9018                          GUINT_TO_POINTER (source),
9019                          GUINT_TO_POINTER (event_mask));
9020   else
9021     g_hash_table_remove (window->source_event_masks,
9022                          GUINT_TO_POINTER (source));
9023
9024   size = g_hash_table_size (window->source_event_masks);
9025
9026   /* Update handler if needed */
9027   if (!window->device_added_handler_id && size > 0)
9028     {
9029       window->device_added_handler_id =
9030         g_signal_connect (device_manager, "device-added",
9031                           G_CALLBACK (source_events_device_added), window);
9032       window->device_changed_handler_id =
9033         g_signal_connect (device_manager, "device-changed",
9034                           G_CALLBACK (source_events_device_changed), window);
9035     }
9036   else if (window->device_added_handler_id && size == 0)
9037     g_signal_handler_disconnect (device_manager, window->device_added_handler_id);
9038 }
9039
9040 /**
9041  * gdk_window_get_source_events:
9042  * @window: a #GdkWindow
9043  * @source: a #GdkInputSource to define the source class.
9044  *
9045  * Returns the event mask for @window corresponding to the device class specified
9046  * by @source.
9047  *
9048  * Returns: source event mask for @window
9049  **/
9050 GdkEventMask
9051 gdk_window_get_source_events (GdkWindow      *window,
9052                               GdkInputSource  source)
9053 {
9054   g_return_val_if_fail (GDK_IS_WINDOW (window), 0);
9055
9056   return GPOINTER_TO_UINT (g_hash_table_lookup (window->source_event_masks,
9057                                                 GUINT_TO_POINTER (source)));
9058 }
9059
9060 static gboolean
9061 do_synthesize_crossing_event (gpointer data)
9062 {
9063   GdkDisplay *display;
9064   GdkWindow *changed_toplevel;
9065   GHashTableIter iter;
9066   gpointer key, value;
9067   gulong serial;
9068
9069   changed_toplevel = data;
9070
9071   changed_toplevel->synthesize_crossing_event_queued = FALSE;
9072
9073   if (GDK_WINDOW_DESTROYED (changed_toplevel))
9074     return FALSE;
9075
9076   display = gdk_window_get_display (changed_toplevel);
9077   serial = _gdk_display_get_next_serial (display);
9078   g_hash_table_iter_init (&iter, display->pointers_info);
9079
9080   while (g_hash_table_iter_next (&iter, &key, &value))
9081     {
9082       GdkWindow *new_window_under_pointer;
9083       GdkPointerWindowInfo *pointer_info = value;
9084       GdkDevice *device = key;
9085
9086       if (changed_toplevel == pointer_info->toplevel_under_pointer)
9087         {
9088           new_window_under_pointer =
9089             get_pointer_window (display, changed_toplevel,
9090                                 device,
9091                                 pointer_info->toplevel_x,
9092                                 pointer_info->toplevel_y,
9093                                 serial);
9094           if (new_window_under_pointer != pointer_info->window_under_pointer)
9095             {
9096               _gdk_synthesize_crossing_events (display,
9097                                                pointer_info->window_under_pointer,
9098                                                new_window_under_pointer,
9099                                                device, pointer_info->last_slave,
9100                                                GDK_CROSSING_NORMAL,
9101                                                pointer_info->toplevel_x,
9102                                                pointer_info->toplevel_y,
9103                                                pointer_info->state,
9104                                                GDK_CURRENT_TIME,
9105                                                NULL,
9106                                                serial,
9107                                                FALSE);
9108               _gdk_display_set_window_under_pointer (display, device, new_window_under_pointer);
9109             }
9110         }
9111     }
9112
9113   return FALSE;
9114 }
9115
9116 void
9117 _gdk_synthesize_crossing_events_for_geometry_change (GdkWindow *changed_window)
9118 {
9119   GdkWindow *toplevel;
9120
9121   toplevel = get_event_toplevel (changed_window);
9122
9123   if (!toplevel->synthesize_crossing_event_queued)
9124     {
9125       toplevel->synthesize_crossing_event_queued = TRUE;
9126
9127       gdk_threads_add_idle_full (GDK_PRIORITY_EVENTS - 1,
9128                                  do_synthesize_crossing_event,
9129                                  g_object_ref (toplevel),
9130                                  g_object_unref);
9131     }
9132 }
9133
9134 /* Don't use for crossing events */
9135 static GdkWindow *
9136 get_event_window (GdkDisplay                 *display,
9137                   GdkDevice                  *device,
9138                   GdkEventSequence           *sequence,
9139                   GdkWindow                  *pointer_window,
9140                   GdkEventType                type,
9141                   GdkModifierType             mask,
9142                   guint                      *evmask_out,
9143                   gboolean                    pointer_emulated,
9144                   gulong                      serial)
9145 {
9146   guint evmask, emulated_mask = 0;
9147   GdkWindow *grab_window;
9148   GdkDeviceGrabInfo *grab;
9149   GdkTouchGrabInfo *touch_grab;
9150
9151   touch_grab = _gdk_display_has_touch_grab (display, device, sequence, serial);
9152   grab = _gdk_display_get_last_device_grab (display, device);
9153
9154   if (is_touch_type (type) && pointer_emulated)
9155     {
9156       switch (type)
9157         {
9158         case GDK_TOUCH_BEGIN:
9159           emulated_mask |= GDK_BUTTON_PRESS_MASK;
9160           break;
9161         case GDK_TOUCH_UPDATE:
9162           emulated_mask |= GDK_POINTER_MOTION_MASK;
9163           break;
9164         case GDK_TOUCH_END:
9165           emulated_mask |= GDK_BUTTON_RELEASE_MASK;
9166         default:
9167           break;
9168         }
9169     }
9170
9171   if (touch_grab != NULL &&
9172       (!grab || grab->implicit || touch_grab->serial >= grab->serial_start))
9173     {
9174       evmask = touch_grab->event_mask;
9175       evmask = update_evmask_for_button_motion (evmask, mask);
9176
9177       if (evmask & (type_masks[type] | emulated_mask))
9178         {
9179           if (evmask_out)
9180             *evmask_out = evmask;
9181           return touch_grab->window;
9182         }
9183       else
9184         return NULL;
9185     }
9186
9187   if (grab != NULL && !grab->owner_events)
9188     {
9189       evmask = grab->event_mask;
9190       evmask = update_evmask_for_button_motion (evmask, mask);
9191
9192       grab_window = grab->window;
9193
9194       if (evmask & (type_masks[type] | emulated_mask))
9195         {
9196           if (evmask_out)
9197             *evmask_out = evmask;
9198           return grab_window;
9199         }
9200       else
9201         return NULL;
9202     }
9203
9204   while (pointer_window != NULL)
9205     {
9206       evmask = pointer_window->event_mask;
9207       evmask = update_evmask_for_button_motion (evmask, mask);
9208
9209       if (evmask & (type_masks[type] | emulated_mask))
9210         {
9211           if (evmask_out)
9212             *evmask_out = evmask;
9213           return pointer_window;
9214         }
9215
9216       pointer_window = get_event_parent (pointer_window);
9217     }
9218
9219   if (grab != NULL &&
9220       grab->owner_events)
9221     {
9222       evmask = grab->event_mask;
9223       evmask = update_evmask_for_button_motion (evmask, mask);
9224
9225       if (evmask & (type_masks[type] | emulated_mask))
9226         {
9227           if (evmask_out)
9228             *evmask_out = evmask;
9229           return grab->window;
9230         }
9231       else
9232         return NULL;
9233     }
9234
9235   return NULL;
9236 }
9237
9238 static gboolean
9239 proxy_pointer_event (GdkDisplay                 *display,
9240                      GdkEvent                   *source_event,
9241                      gulong                      serial)
9242 {
9243   GdkWindow *toplevel_window, *event_window;
9244   GdkWindow *pointer_window;
9245   GdkPointerWindowInfo *pointer_info;
9246   GdkDevice *device, *source_device;
9247   GdkEvent *event;
9248   guint state;
9249   gdouble toplevel_x, toplevel_y;
9250   guint32 time_;
9251   gboolean non_linear, need_synthetic_enter = FALSE;
9252   gint event_type;
9253
9254   event_type = source_event->type;
9255   event_window = source_event->any.window;
9256   gdk_event_get_coords (source_event, &toplevel_x, &toplevel_y);
9257   gdk_event_get_state (source_event, &state);
9258   time_ = gdk_event_get_time (source_event);
9259   device = gdk_event_get_device (source_event);
9260   source_device = gdk_event_get_source_device (source_event);
9261   pointer_info = _gdk_display_get_pointer_info (display, device);
9262   toplevel_window = convert_native_coords_to_toplevel (event_window,
9263                                                        toplevel_x, toplevel_y,
9264                                                        &toplevel_x, &toplevel_y);
9265
9266   non_linear = FALSE;
9267   if ((source_event->type == GDK_LEAVE_NOTIFY ||
9268        source_event->type == GDK_ENTER_NOTIFY) &&
9269       (source_event->crossing.detail == GDK_NOTIFY_NONLINEAR ||
9270        source_event->crossing.detail == GDK_NOTIFY_NONLINEAR_VIRTUAL))
9271     non_linear = TRUE;
9272
9273   if (pointer_info->need_touch_press_enter &&
9274       gdk_device_get_source (pointer_info->last_slave) != GDK_SOURCE_TOUCHSCREEN &&
9275       (source_event->type != GDK_TOUCH_UPDATE ||
9276        _gdk_event_get_pointer_emulated (source_event)))
9277     {
9278       pointer_info->need_touch_press_enter = FALSE;
9279       need_synthetic_enter = TRUE;
9280     }
9281
9282   /* If we get crossing events with subwindow unexpectedly being NULL
9283      that means there is a native subwindow that gdk doesn't know about.
9284      We track these and forward them, with the correct virtual window
9285      events inbetween.
9286      This is important to get right, as metacity uses gdk for the frame
9287      windows, but gdk doesn't know about the client windows reparented
9288      into the frame. */
9289   if (((source_event->type == GDK_LEAVE_NOTIFY &&
9290         source_event->crossing.detail == GDK_NOTIFY_INFERIOR) ||
9291        (source_event->type == GDK_ENTER_NOTIFY &&
9292         (source_event->crossing.detail == GDK_NOTIFY_VIRTUAL ||
9293          source_event->crossing.detail == GDK_NOTIFY_NONLINEAR_VIRTUAL))) &&
9294       source_event->crossing.subwindow == NULL)
9295     {
9296       /* Left for an unknown (to gdk) subwindow */
9297
9298       /* Send leave events from window under pointer to event window
9299          that will get the subwindow == NULL window */
9300       _gdk_synthesize_crossing_events (display,
9301                                        pointer_info->window_under_pointer,
9302                                        event_window,
9303                                        device, source_device,
9304                                        source_event->crossing.mode,
9305                                        toplevel_x, toplevel_y,
9306                                        state, time_,
9307                                        source_event,
9308                                        serial,
9309                                        non_linear);
9310
9311       /* Send subwindow == NULL event */
9312       send_crossing_event (display,
9313                            toplevel_window,
9314                            event_window,
9315                            source_event->type,
9316                            source_event->crossing.mode,
9317                            source_event->crossing.detail,
9318                            NULL,
9319                            device, source_device,
9320                            toplevel_x, toplevel_y,
9321                            state, time_,
9322                            source_event,
9323                            serial);
9324
9325       _gdk_display_set_window_under_pointer (display, device, NULL);
9326       return TRUE;
9327     }
9328
9329   pointer_window = get_pointer_window (display, toplevel_window, device,
9330                                        toplevel_x, toplevel_y, serial);
9331
9332   if (((source_event->type == GDK_ENTER_NOTIFY &&
9333         source_event->crossing.detail == GDK_NOTIFY_INFERIOR) ||
9334        (source_event->type == GDK_LEAVE_NOTIFY &&
9335         (source_event->crossing.detail == GDK_NOTIFY_VIRTUAL ||
9336          source_event->crossing.detail == GDK_NOTIFY_NONLINEAR_VIRTUAL))) &&
9337       source_event->crossing.subwindow == NULL)
9338     {
9339       /* Entered from an unknown (to gdk) subwindow */
9340
9341       /* Send subwindow == NULL event */
9342       send_crossing_event (display,
9343                            toplevel_window,
9344                            event_window,
9345                            source_event->type,
9346                            source_event->crossing.mode,
9347                            source_event->crossing.detail,
9348                            NULL,
9349                            device, source_device,
9350                            toplevel_x, toplevel_y,
9351                            state, time_,
9352                            source_event,
9353                            serial);
9354
9355       /* Send enter events from event window to pointer_window */
9356       _gdk_synthesize_crossing_events (display,
9357                                        event_window,
9358                                        pointer_window,
9359                                        device, source_device,
9360                                        source_event->crossing.mode,
9361                                        toplevel_x, toplevel_y,
9362                                        state, time_,
9363                                        source_event,
9364                                        serial, non_linear);
9365       _gdk_display_set_window_under_pointer (display, device, pointer_window);
9366       return TRUE;
9367     }
9368
9369   if ((source_event->type != GDK_TOUCH_UPDATE ||
9370        _gdk_event_get_pointer_emulated (source_event)) &&
9371       pointer_info->window_under_pointer != pointer_window)
9372     {
9373       /* Either a toplevel crossing notify that ended up inside a child window,
9374          or a motion notify that got into another child window  */
9375
9376       /* Different than last time, send crossing events */
9377       _gdk_synthesize_crossing_events (display,
9378                                        pointer_info->window_under_pointer,
9379                                        pointer_window,
9380                                        device, source_device,
9381                                        GDK_CROSSING_NORMAL,
9382                                        toplevel_x, toplevel_y,
9383                                        state, time_,
9384                                        source_event,
9385                                        serial, non_linear);
9386       _gdk_display_set_window_under_pointer (display, device, pointer_window);
9387     }
9388   else if (source_event->type == GDK_MOTION_NOTIFY ||
9389            source_event->type == GDK_TOUCH_UPDATE)
9390     {
9391       GdkWindow *event_win;
9392       guint evmask;
9393       gboolean is_hint;
9394       GdkEventSequence *sequence;
9395
9396       sequence = gdk_event_get_event_sequence (source_event);
9397
9398       event_win = get_event_window (display,
9399                                     device,
9400                                     sequence,
9401                                     pointer_window,
9402                                     source_event->type,
9403                                     state,
9404                                     &evmask,
9405                                     _gdk_event_get_pointer_emulated (source_event),
9406                                     serial);
9407
9408       if (event_type == GDK_TOUCH_UPDATE)
9409         {
9410           if (_gdk_event_get_pointer_emulated (source_event))
9411             {
9412               /* Touch events emulating pointer events are transformed back
9413                * to pointer events if:
9414                * 1 - The event window doesn't select for touch events
9415                * 2 - There's no touch grab for this sequence, which means
9416                *     it was started as a pointer sequence, but a device
9417                *     grab added touch events afterwards, the sequence must
9418                *     not mutate in this case.
9419                */
9420               if ((evmask & GDK_TOUCH_MASK) == 0 ||
9421                   !_gdk_display_has_touch_grab (display, device, sequence, serial))
9422                 event_type = GDK_MOTION_NOTIFY;
9423             }
9424           else if ((evmask & GDK_TOUCH_MASK) == 0)
9425             return TRUE;
9426         }
9427
9428       if (is_touch_type (source_event->type) && !is_touch_type (event_type))
9429         state |= GDK_BUTTON1_MASK;
9430
9431       if (event_win &&
9432           gdk_device_get_device_type (device) != GDK_DEVICE_TYPE_MASTER &&
9433           gdk_window_get_device_events (event_win, device) == 0)
9434         return TRUE;
9435
9436       /* The last device to interact with the window was a touch device,
9437        * which synthesized a leave notify event, so synthesize another enter
9438        * notify to tell the pointer is on the window.
9439        */
9440       if (need_synthetic_enter)
9441         _gdk_synthesize_crossing_events (display,
9442                                          NULL, pointer_window,
9443                                          device, source_device,
9444                                          GDK_CROSSING_DEVICE_SWITCH,
9445                                          toplevel_x, toplevel_y,
9446                                          state, time_, NULL,
9447                                          serial, FALSE);
9448
9449       is_hint = FALSE;
9450
9451       if (event_win &&
9452           event_type == GDK_MOTION_NOTIFY &&
9453           (evmask & GDK_POINTER_MOTION_HINT_MASK))
9454         {
9455           gulong *device_serial;
9456
9457           device_serial = g_hash_table_lookup (display->motion_hint_info, device);
9458
9459           if (!device_serial ||
9460               (*device_serial != 0 &&
9461                serial < *device_serial))
9462             event_win = NULL; /* Ignore event */
9463           else
9464             {
9465               is_hint = TRUE;
9466               *device_serial = G_MAXULONG;
9467             }
9468         }
9469
9470       if (!event_win)
9471         return TRUE;
9472
9473       event = gdk_event_new (event_type);
9474       event->any.window = g_object_ref (event_win);
9475       event->any.send_event = source_event->any.send_event;
9476
9477       gdk_event_set_device (event, gdk_event_get_device (source_event));
9478       gdk_event_set_source_device (event, source_device);
9479
9480       if (event_type == GDK_TOUCH_UPDATE)
9481         {
9482           event->touch.time = time_;
9483           event->touch.state = state | GDK_BUTTON1_MASK;
9484           event->touch.sequence = source_event->touch.sequence;
9485           event->touch.emulating_pointer = source_event->touch.emulating_pointer;
9486           convert_toplevel_coords_to_window (event_win,
9487                                              toplevel_x, toplevel_y,
9488                                              &event->touch.x, &event->touch.y);
9489           gdk_event_get_root_coords (source_event,
9490                                      &event->touch.x_root,
9491                                      &event->touch.y_root);
9492
9493           event->touch.axes = g_memdup (source_event->touch.axes,
9494                                         sizeof (gdouble) * gdk_device_get_n_axes (source_event->touch.device));
9495         }
9496       else
9497         {
9498           event->motion.time = time_;
9499           event->motion.state = state;
9500           event->motion.is_hint = is_hint;
9501
9502           convert_toplevel_coords_to_window (event_win,
9503                                              toplevel_x, toplevel_y,
9504                                              &event->motion.x, &event->motion.y);
9505           gdk_event_get_root_coords (source_event,
9506                                      &event->motion.x_root,
9507                                      &event->motion.y_root);
9508
9509           if (is_touch_type (source_event->type))
9510             event->motion.axes = g_memdup (source_event->touch.axes,
9511                                            sizeof (gdouble) * gdk_device_get_n_axes (source_event->touch.device));
9512           else
9513             event->motion.axes = g_memdup (source_event->motion.axes,
9514                                            sizeof (gdouble) * gdk_device_get_n_axes (source_event->motion.device));
9515         }
9516
9517       /* Just insert the event */
9518       _gdk_event_queue_insert_after (gdk_window_get_display (event_win),
9519                                      source_event, event);
9520     }
9521
9522   /* unlink all move events from queue.
9523      We handle our own, including our emulated masks. */
9524   return TRUE;
9525 }
9526
9527 #define GDK_ANY_BUTTON_MASK (GDK_BUTTON1_MASK | \
9528                              GDK_BUTTON2_MASK | \
9529                              GDK_BUTTON3_MASK | \
9530                              GDK_BUTTON4_MASK | \
9531                              GDK_BUTTON5_MASK)
9532
9533 static gboolean
9534 proxy_button_event (GdkEvent *source_event,
9535                     gulong serial)
9536 {
9537   GdkWindow *toplevel_window, *event_window;
9538   GdkWindow *event_win;
9539   GdkWindow *pointer_window;
9540   GdkWindow *parent;
9541   GdkEvent *event;
9542   GdkPointerWindowInfo *pointer_info;
9543   GdkDeviceGrabInfo *pointer_grab;
9544   guint state;
9545   guint32 time_;
9546   GdkEventType type;
9547   gdouble toplevel_x, toplevel_y;
9548   GdkDisplay *display;
9549   GdkWindow *w;
9550   GdkDevice *device, *source_device;
9551   GdkEventMask evmask;
9552   GdkEventSequence *sequence;
9553
9554   type = source_event->any.type;
9555   event_window = source_event->any.window;
9556   gdk_event_get_coords (source_event, &toplevel_x, &toplevel_y);
9557   gdk_event_get_state (source_event, &state);
9558   time_ = gdk_event_get_time (source_event);
9559   device = gdk_event_get_device (source_event);
9560   source_device = gdk_event_get_source_device (source_event);
9561   display = gdk_window_get_display (source_event->any.window);
9562   toplevel_window = convert_native_coords_to_toplevel (event_window,
9563                                                        toplevel_x, toplevel_y,
9564                                                        &toplevel_x, &toplevel_y);
9565
9566   sequence = gdk_event_get_event_sequence (source_event);
9567
9568   pointer_info = _gdk_display_get_pointer_info (display, device);
9569   pointer_grab = _gdk_display_has_device_grab (display, device, serial);
9570
9571   if ((type == GDK_BUTTON_PRESS ||
9572        type == GDK_TOUCH_BEGIN) &&
9573       !source_event->any.send_event &&
9574       (!pointer_grab ||
9575        (type == GDK_TOUCH_BEGIN && pointer_grab->implicit &&
9576         !_gdk_event_get_pointer_emulated (source_event))))
9577     {
9578       pointer_window =
9579         _gdk_window_find_descendant_at (toplevel_window,
9580                                         toplevel_x, toplevel_y,
9581                                         NULL, NULL);
9582
9583       /* Find the event window, that gets the grab */
9584       w = pointer_window;
9585       while (w != NULL &&
9586              (parent = get_event_parent (w)) != NULL &&
9587              parent->window_type != GDK_WINDOW_ROOT)
9588         {
9589           if (w->event_mask & GDK_BUTTON_PRESS_MASK &&
9590               (type == GDK_BUTTON_PRESS ||
9591                _gdk_event_get_pointer_emulated (source_event)))
9592             break;
9593
9594           if (type == GDK_TOUCH_BEGIN &&
9595               w->event_mask & GDK_TOUCH_MASK)
9596             break;
9597
9598           w = parent;
9599         }
9600       pointer_window = w;
9601
9602       if (pointer_window)
9603         {
9604           if (type == GDK_TOUCH_BEGIN &&
9605               pointer_window->event_mask & GDK_TOUCH_MASK)
9606             {
9607               _gdk_display_add_touch_grab (display, device, sequence,
9608                                            pointer_window, event_window,
9609                                            gdk_window_get_events (pointer_window),
9610                                            serial, time_);
9611             }
9612           else if (type == GDK_BUTTON_PRESS ||
9613                    _gdk_event_get_pointer_emulated (source_event))
9614             {
9615               _gdk_display_add_device_grab  (display,
9616                                              device,
9617                                              pointer_window,
9618                                              event_window,
9619                                              GDK_OWNERSHIP_NONE,
9620                                              FALSE,
9621                                              gdk_window_get_events (pointer_window),
9622                                              serial,
9623                                              time_,
9624                                              TRUE);
9625               _gdk_display_device_grab_update (display, device,
9626                                                source_device, serial);
9627             }
9628         }
9629     }
9630
9631   pointer_window = get_pointer_window (display, toplevel_window, device,
9632                                        toplevel_x, toplevel_y,
9633                                        serial);
9634
9635   event_win = get_event_window (display,
9636                                 device,
9637                                 sequence,
9638                                 pointer_window,
9639                                 type, state,
9640                                 &evmask,
9641                                 _gdk_event_get_pointer_emulated (source_event),
9642                                 serial);
9643
9644   if (type == GDK_TOUCH_BEGIN || type == GDK_TOUCH_END)
9645     {
9646       if (_gdk_event_get_pointer_emulated (source_event))
9647         {
9648           if ((evmask & GDK_TOUCH_MASK) == 0 ||
9649               !_gdk_display_has_touch_grab (display, device, sequence, serial))
9650             {
9651               if (type == GDK_TOUCH_BEGIN)
9652                 type = GDK_BUTTON_PRESS;
9653               else if (type == GDK_TOUCH_END)
9654                 type = GDK_BUTTON_RELEASE;
9655             }
9656         }
9657       else if ((evmask & GDK_TOUCH_MASK) == 0)
9658         return TRUE;
9659     }
9660
9661   if (source_event->type == GDK_TOUCH_END && !is_touch_type (type))
9662     state |= GDK_BUTTON1_MASK;
9663
9664   if (event_win == NULL)
9665     return TRUE;
9666
9667   if (gdk_device_get_device_type (device) != GDK_DEVICE_TYPE_MASTER &&
9668       gdk_window_get_device_events (event_win, device) == 0)
9669     return TRUE;
9670
9671   if ((type == GDK_BUTTON_PRESS ||
9672        (type == GDK_TOUCH_BEGIN &&
9673         _gdk_event_get_pointer_emulated (source_event))) &&
9674       pointer_info->need_touch_press_enter)
9675     {
9676       GdkCrossingMode mode;
9677
9678       /* The last device to interact with the window was a touch device,
9679        * which synthesized a leave notify event, so synthesize another enter
9680        * notify to tell the pointer is on the window.
9681        */
9682       if (gdk_device_get_source (source_device) == GDK_SOURCE_TOUCHSCREEN)
9683         mode = GDK_CROSSING_TOUCH_BEGIN;
9684       else
9685         mode = GDK_CROSSING_DEVICE_SWITCH;
9686
9687       pointer_info->need_touch_press_enter = FALSE;
9688       _gdk_synthesize_crossing_events (display,
9689                                        NULL,
9690                                        pointer_info->window_under_pointer,
9691                                        device, source_device, mode,
9692                                        toplevel_x, toplevel_y,
9693                                        state, time_, source_event,
9694                                        serial, FALSE);
9695     }
9696   else if (type == GDK_SCROLL &&
9697            (((evmask & GDK_SMOOTH_SCROLL_MASK) == 0 &&
9698              source_event->scroll.direction == GDK_SCROLL_SMOOTH) ||
9699             ((evmask & GDK_SMOOTH_SCROLL_MASK) != 0 &&
9700              source_event->scroll.direction != GDK_SCROLL_SMOOTH &&
9701              _gdk_event_get_pointer_emulated (source_event))))
9702     return FALSE;
9703
9704   event = _gdk_make_event (event_win, type, source_event, FALSE);
9705
9706   switch (type)
9707     {
9708     case GDK_BUTTON_PRESS:
9709     case GDK_BUTTON_RELEASE:
9710       event->button.button = source_event->button.button;
9711       convert_toplevel_coords_to_window (event_win,
9712                                          toplevel_x, toplevel_y,
9713                                          &event->button.x, &event->button.y);
9714       gdk_event_get_root_coords (source_event,
9715                                  &event->button.x_root,
9716                                  &event->button.y_root);
9717       gdk_event_set_device (event, gdk_event_get_device (source_event));
9718       gdk_event_set_source_device (event, source_device);
9719
9720       if (is_touch_type (source_event->type))
9721         {
9722           if (type == GDK_BUTTON_RELEASE)
9723             event->button.state |= GDK_BUTTON1_MASK;
9724           event->button.button = 1;
9725           event->button.axes = g_memdup (source_event->touch.axes,
9726                                          sizeof (gdouble) * gdk_device_get_n_axes (source_event->touch.device));
9727         }
9728       else
9729         {
9730           event->button.button = source_event->button.button;
9731           event->button.axes = g_memdup (source_event->button.axes,
9732                                          sizeof (gdouble) * gdk_device_get_n_axes (source_event->button.device));
9733         }
9734
9735       if (type == GDK_BUTTON_PRESS)
9736         _gdk_event_button_generate (display, event);
9737       else if ((type == GDK_BUTTON_RELEASE ||
9738                 (type == GDK_TOUCH_END &&
9739                  _gdk_event_get_pointer_emulated (source_event))) &&
9740                pointer_window == pointer_info->window_under_pointer &&
9741                gdk_device_get_source (source_device) == GDK_SOURCE_TOUCHSCREEN)
9742         {
9743           /* Synthesize a leave notify event
9744            * whenever a touch device is released
9745            */
9746           pointer_info->need_touch_press_enter = TRUE;
9747           _gdk_synthesize_crossing_events (display,
9748                                            pointer_window, NULL,
9749                                            device, source_device,
9750                                            GDK_CROSSING_TOUCH_END,
9751                                            toplevel_x, toplevel_y,
9752                                            state, time_, NULL,
9753                                            serial, FALSE);
9754         }
9755       return TRUE;
9756
9757     case GDK_TOUCH_BEGIN:
9758     case GDK_TOUCH_END:
9759       convert_toplevel_coords_to_window (event_win,
9760                                          toplevel_x, toplevel_y,
9761                                          &event->button.x, &event->button.y);
9762       gdk_event_get_root_coords (source_event,
9763                                  &event->touch.x_root,
9764                                  &event->touch.y_root);
9765       event->touch.state = state;
9766       event->touch.device = source_event->touch.device;
9767       event->touch.axes = g_memdup (source_event->touch.axes,
9768                                      sizeof (gdouble) * gdk_device_get_n_axes (source_event->touch.device));
9769       event->touch.sequence = source_event->touch.sequence;
9770       event->touch.emulating_pointer = source_event->touch.emulating_pointer;
9771
9772       gdk_event_set_source_device (event, source_device);
9773
9774       if ((type == GDK_TOUCH_END &&
9775            _gdk_event_get_pointer_emulated (source_event)) &&
9776            pointer_window == pointer_info->window_under_pointer &&
9777            gdk_device_get_source (source_device) == GDK_SOURCE_TOUCHSCREEN)
9778         {
9779           /* Synthesize a leave notify event
9780            * whenever a touch device is released
9781            */
9782           pointer_info->need_touch_press_enter = TRUE;
9783           _gdk_synthesize_crossing_events (display,
9784                                            pointer_window, NULL,
9785                                            device, source_device,
9786                                            GDK_CROSSING_TOUCH_END,
9787                                            toplevel_x, toplevel_y,
9788                                            state, time_, NULL,
9789                                            serial, FALSE);
9790         }
9791       return TRUE;
9792
9793     case GDK_SCROLL:
9794       event->scroll.direction = source_event->scroll.direction;
9795       convert_toplevel_coords_to_window (event_win,
9796                                          toplevel_x, toplevel_y,
9797                                          &event->scroll.x, &event->scroll.y);
9798       event->scroll.x_root = source_event->scroll.x_root;
9799       event->scroll.y_root = source_event->scroll.y_root;
9800       event->scroll.state = state;
9801       event->scroll.device = source_event->scroll.device;
9802       event->scroll.delta_x = source_event->scroll.delta_x;
9803       event->scroll.delta_y = source_event->scroll.delta_y;
9804       gdk_event_set_source_device (event, source_device);
9805       return TRUE;
9806
9807     default:
9808       return FALSE;
9809     }
9810
9811   return TRUE; /* Always unlink original, we want to obey the emulated event mask */
9812 }
9813
9814 #ifdef DEBUG_WINDOW_PRINTING
9815 static void
9816 gdk_window_print (GdkWindow *window,
9817                   int indent)
9818 {
9819   GdkRectangle r;
9820   const char *window_types[] = {
9821     "root",
9822     "toplevel",
9823     "child",
9824     "dialog",
9825     "temp",
9826     "foreign",
9827     "offscreen"
9828   };
9829
9830   g_print ("%*s%p: [%s] %d,%d %dx%d", indent, "", window,
9831            window->user_data ? g_type_name_from_instance (window->user_data) : "no widget",
9832            window->x, window->y,
9833            window->width, window->height
9834            );
9835
9836   if (gdk_window_has_impl (window))
9837     {
9838 #ifdef GDK_WINDOWING_X11
9839       g_print (" impl(0x%lx)", gdk_x11_window_get_xid (window));
9840 #endif
9841     }
9842
9843   if (window->window_type != GDK_WINDOW_CHILD)
9844     g_print (" %s", window_types[window->window_type]);
9845
9846   if (window->input_only)
9847     g_print (" input-only");
9848
9849   if (window->shaped)
9850     g_print (" shaped");
9851
9852   if (!gdk_window_is_visible ((GdkWindow *)window))
9853     g_print (" hidden");
9854
9855   g_print (" abs[%d,%d]",
9856            window->abs_x, window->abs_y);
9857
9858   cairo_region_get_extents (window->clip_region, &r);
9859   if (cairo_region_is_empty (window->clip_region))
9860     g_print (" clipbox[empty]");
9861   else
9862     g_print (" clipbox[%d,%d %dx%d]", r.x, r.y, r.width, r.height);
9863
9864   g_print ("\n");
9865 }
9866
9867
9868 static void
9869 gdk_window_print_tree (GdkWindow *window,
9870                        int indent,
9871                        gboolean include_input_only)
9872 {
9873   GList *l;
9874
9875   if (window->input_only && !include_input_only)
9876     return;
9877
9878   gdk_window_print (window, indent);
9879
9880   for (l = window->children; l != NULL; l = l->next)
9881     gdk_window_print_tree (l->data, indent + 4, include_input_only);
9882 }
9883
9884 #endif /* DEBUG_WINDOW_PRINTING */
9885
9886 void
9887 _gdk_windowing_got_event (GdkDisplay *display,
9888                           GList      *event_link,
9889                           GdkEvent   *event,
9890                           gulong      serial)
9891 {
9892   GdkWindow *event_window;
9893   gdouble x, y;
9894   gboolean unlink_event;
9895   GdkDeviceGrabInfo *button_release_grab;
9896   GdkPointerWindowInfo *pointer_info = NULL;
9897   GdkDevice *device, *source_device;
9898   gboolean is_toplevel;
9899
9900   if (gdk_event_get_time (event) != GDK_CURRENT_TIME)
9901     display->last_event_time = gdk_event_get_time (event);
9902
9903   device = gdk_event_get_device (event);
9904   source_device = gdk_event_get_source_device (event);
9905
9906   if (device)
9907     {
9908       GdkInputMode mode;
9909
9910       if (gdk_device_get_source (device) != GDK_SOURCE_KEYBOARD)
9911         {
9912           pointer_info = _gdk_display_get_pointer_info (display, device);
9913
9914           if (source_device != pointer_info->last_slave &&
9915               gdk_device_get_device_type (source_device) == GDK_DEVICE_TYPE_SLAVE)
9916             pointer_info->last_slave = source_device;
9917           else
9918             source_device = pointer_info->last_slave;
9919         }
9920
9921       g_object_get (device, "input-mode", &mode, NULL);
9922       _gdk_display_device_grab_update (display, device, source_device, serial);
9923
9924       if (mode == GDK_MODE_DISABLED ||
9925           !_gdk_display_check_grab_ownership (display, device, serial))
9926         {
9927           /* Device events are blocked by another
9928            * device grab, or the device is disabled
9929            */
9930           unlink_event = TRUE;
9931           goto out;
9932         }
9933     }
9934
9935   event_window = event->any.window;
9936   if (!event_window)
9937     return;
9938
9939 #ifdef DEBUG_WINDOW_PRINTING
9940   if (event->type == GDK_KEY_PRESS &&
9941       (event->key.keyval == 0xa7 ||
9942        event->key.keyval == 0xbd))
9943     {
9944       gdk_window_print_tree (event_window, 0, event->key.keyval == 0xbd);
9945     }
9946 #endif
9947
9948   if (event->type == GDK_VISIBILITY_NOTIFY)
9949     {
9950       event_window->native_visibility = event->visibility.state;
9951       gdk_window_update_visibility_recursively (event_window, event_window);
9952       return;
9953     }
9954
9955   if (!(is_button_type (event->type) ||
9956         is_motion_type (event->type)) ||
9957       event_window->window_type == GDK_WINDOW_ROOT)
9958     return;
9959
9960   is_toplevel = gdk_window_is_toplevel (event_window);
9961
9962   if ((event->type == GDK_ENTER_NOTIFY ||
9963        event->type == GDK_LEAVE_NOTIFY) &&
9964       (event->crossing.mode == GDK_CROSSING_GRAB ||
9965        event->crossing.mode == GDK_CROSSING_UNGRAB) &&
9966       (_gdk_display_has_device_grab (display, device, serial) ||
9967        event->crossing.detail == GDK_NOTIFY_INFERIOR))
9968     {
9969       /* We synthesize all crossing events due to grabs ourselves,
9970        * so we ignore the native ones caused by our native pointer_grab
9971        * calls. Otherwise we would proxy these crossing event and cause
9972        * multiple copies of crossing events for grabs.
9973        *
9974        * We do want to handle grabs from other clients though, as for
9975        * instance alt-tab in metacity causes grabs like these and
9976        * we want to handle those. Thus the has_pointer_grab check.
9977        *
9978        * Implicit grabs on child windows create some grabbing events
9979        * that are sent before the button press. This means we can't
9980        * detect these with the has_pointer_grab check (as the implicit
9981        * grab is only noticed when we get button press event), so we
9982        * detect these events by checking for INFERIOR enter or leave
9983        * events. These should never be a problem to filter out.
9984        */
9985
9986       /* We ended up in this window after some (perhaps other clients)
9987        * grab, so update the toplevel_under_window state
9988        */
9989       if (is_toplevel &&
9990           event->type == GDK_ENTER_NOTIFY &&
9991           event->crossing.mode == GDK_CROSSING_UNGRAB)
9992         {
9993           if (pointer_info->toplevel_under_pointer)
9994             g_object_unref (pointer_info->toplevel_under_pointer);
9995           pointer_info->toplevel_under_pointer = g_object_ref (event_window);
9996         }
9997
9998       unlink_event = TRUE;
9999       goto out;
10000     }
10001
10002   /* Track toplevel_under_pointer */
10003   if (is_toplevel)
10004     {
10005       if (event->type == GDK_ENTER_NOTIFY &&
10006           event->crossing.detail != GDK_NOTIFY_INFERIOR)
10007         {
10008           if (pointer_info->toplevel_under_pointer)
10009             g_object_unref (pointer_info->toplevel_under_pointer);
10010           pointer_info->toplevel_under_pointer = g_object_ref (event_window);
10011         }
10012       else if (event->type == GDK_LEAVE_NOTIFY &&
10013                event->crossing.detail != GDK_NOTIFY_INFERIOR &&
10014                pointer_info->toplevel_under_pointer == event_window)
10015         {
10016           if (pointer_info->toplevel_under_pointer)
10017             g_object_unref (pointer_info->toplevel_under_pointer);
10018           pointer_info->toplevel_under_pointer = NULL;
10019         }
10020     }
10021
10022   if (pointer_info &&
10023       (!is_touch_type (event->type) ||
10024        _gdk_event_get_pointer_emulated (event)))
10025     {
10026       guint old_state, old_button;
10027
10028       /* Store last pointer window and position/state */
10029       old_state = pointer_info->state;
10030       old_button = pointer_info->button;
10031
10032       gdk_event_get_coords (event, &x, &y);
10033       convert_native_coords_to_toplevel (event_window, x, y,  &x, &y);
10034       pointer_info->toplevel_x = x;
10035       pointer_info->toplevel_y = y;
10036       gdk_event_get_state (event, &pointer_info->state);
10037
10038       if (event->type == GDK_BUTTON_PRESS ||
10039           event->type == GDK_BUTTON_RELEASE)
10040         pointer_info->button = event->button.button;
10041       else if (event->type == GDK_TOUCH_BEGIN ||
10042                event->type == GDK_TOUCH_END)
10043         pointer_info->button = 1;
10044
10045       if (device &&
10046           (pointer_info->state != old_state ||
10047            pointer_info->button != old_button))
10048         _gdk_display_enable_motion_hints (display, device);
10049     }
10050
10051   unlink_event = FALSE;
10052   if (is_motion_type (event->type))
10053     unlink_event = proxy_pointer_event (display, event, serial);
10054   else if (is_button_type (event->type))
10055     unlink_event = proxy_button_event (event, serial);
10056
10057   if ((event->type == GDK_BUTTON_RELEASE ||
10058        event->type == GDK_TOUCH_END) &&
10059       !event->any.send_event)
10060     {
10061       GdkEventSequence *sequence;
10062
10063       sequence = gdk_event_get_event_sequence (event);
10064       if (event->type == GDK_TOUCH_END && sequence)
10065         {
10066           _gdk_display_end_touch_grab (display, device, sequence);
10067         }
10068
10069       if (event->type == GDK_BUTTON_RELEASE ||
10070           _gdk_event_get_pointer_emulated (event))
10071         {
10072           button_release_grab =
10073             _gdk_display_has_device_grab (display, device, serial);
10074
10075           if (button_release_grab &&
10076               button_release_grab->implicit &&
10077               (event->button.state & GDK_ANY_BUTTON_MASK & ~(GDK_BUTTON1_MASK << (event->button.button - 1))) == 0)
10078             {
10079               button_release_grab->serial_end = serial;
10080               button_release_grab->implicit_ungrab = FALSE;
10081               _gdk_display_device_grab_update (display, device, source_device, serial);
10082             }
10083         }
10084     }
10085
10086  out:
10087   if (unlink_event)
10088     {
10089       _gdk_event_queue_remove_link (display, event_link);
10090       g_list_free_1 (event_link);
10091       gdk_event_free (event);
10092     }
10093 }
10094
10095 /**
10096  * gdk_window_create_similar_surface:
10097  * @window: window to make new surface similar to
10098  * @content: the content for the new surface
10099  * @width: width of the new surface
10100  * @height: height of the new surface
10101  *
10102  * Create a new surface that is as compatible as possible with the
10103  * given @window. For example the new surface will have the same
10104  * fallback resolution and font options as @window. Generally, the new
10105  * surface will also use the same backend as @window, unless that is
10106  * not possible for some reason. The type of the returned surface may
10107  * be examined with cairo_surface_get_type().
10108  *
10109  * Initially the surface contents are all 0 (transparent if contents
10110  * have transparency, black otherwise.)
10111  *
10112  * Returns: a pointer to the newly allocated surface. The caller
10113  * owns the surface and should call cairo_surface_destroy() when done
10114  * with it.
10115  *
10116  * This function always returns a valid pointer, but it will return a
10117  * pointer to a "nil" surface if @other is already in an error state
10118  * or any other error occurs.
10119  *
10120  * Since: 2.22
10121  **/
10122 cairo_surface_t *
10123 gdk_window_create_similar_surface (GdkWindow *     window,
10124                                    cairo_content_t content,
10125                                    int             width,
10126                                    int             height)
10127 {
10128   cairo_surface_t *window_surface, *surface;
10129
10130   g_return_val_if_fail (GDK_IS_WINDOW (window), NULL);
10131   
10132   window_surface = _gdk_window_ref_cairo_surface (window);
10133
10134   switch (_gdk_rendering_mode)
10135   {
10136     case GDK_RENDERING_MODE_RECORDING:
10137       {
10138         cairo_rectangle_t rect = { 0, 0, width, height };
10139         surface = cairo_recording_surface_create (content, &rect);
10140       }
10141       break;
10142     case GDK_RENDERING_MODE_IMAGE:
10143       surface = cairo_image_surface_create (content == CAIRO_CONTENT_COLOR ? CAIRO_FORMAT_RGB24 :
10144                                             content == CAIRO_CONTENT_ALPHA ? CAIRO_FORMAT_A8 : CAIRO_FORMAT_ARGB32,
10145                                             width, height);
10146       break;
10147     case GDK_RENDERING_MODE_SIMILAR:
10148     default:
10149       surface = cairo_surface_create_similar (window_surface,
10150                                               content,
10151                                               width, height);
10152       break;
10153   }
10154
10155   cairo_surface_destroy (window_surface);
10156
10157   return surface;
10158 }
10159
10160 /**
10161  * gdk_window_focus:
10162  * @window: a #GdkWindow
10163  * @timestamp: timestamp of the event triggering the window focus
10164  *
10165  * Sets keyboard focus to @window. In most cases, gtk_window_present()
10166  * should be used on a #GtkWindow, rather than calling this function.
10167  *
10168  **/
10169 void
10170 gdk_window_focus (GdkWindow *window,
10171                   guint32    timestamp)
10172 {
10173   GDK_WINDOW_IMPL_GET_CLASS (window->impl)->focus (window, timestamp);
10174 }
10175
10176 /**
10177  * gdk_window_set_type_hint:
10178  * @window: A toplevel #GdkWindow
10179  * @hint: A hint of the function this window will have
10180  *
10181  * The application can use this call to provide a hint to the window
10182  * manager about the functionality of a window. The window manager
10183  * can use this information when determining the decoration and behaviour
10184  * of the window.
10185  *
10186  * The hint must be set before the window is mapped.
10187  **/
10188 void
10189 gdk_window_set_type_hint (GdkWindow        *window,
10190                           GdkWindowTypeHint hint)
10191 {
10192   GDK_WINDOW_IMPL_GET_CLASS (window->impl)->set_type_hint (window, hint);
10193 }
10194
10195 /**
10196  * gdk_window_get_type_hint:
10197  * @window: A toplevel #GdkWindow
10198  *
10199  * This function returns the type hint set for a window.
10200  *
10201  * Return value: The type hint set for @window
10202  *
10203  * Since: 2.10
10204  **/
10205 GdkWindowTypeHint
10206 gdk_window_get_type_hint (GdkWindow *window)
10207 {
10208   return GDK_WINDOW_IMPL_GET_CLASS (window->impl)->get_type_hint (window);
10209 }
10210
10211 /**
10212  * gdk_window_set_modal_hint:
10213  * @window: A toplevel #GdkWindow
10214  * @modal: %TRUE if the window is modal, %FALSE otherwise.
10215  *
10216  * The application can use this hint to tell the window manager
10217  * that a certain window has modal behaviour. The window manager
10218  * can use this information to handle modal windows in a special
10219  * way.
10220  *
10221  * You should only use this on windows for which you have
10222  * previously called gdk_window_set_transient_for()
10223  **/
10224 void
10225 gdk_window_set_modal_hint (GdkWindow *window,
10226                            gboolean   modal)
10227 {
10228   GDK_WINDOW_IMPL_GET_CLASS (window->impl)->set_modal_hint (window, modal);
10229 }
10230
10231 /**
10232  * gdk_window_set_skip_taskbar_hint:
10233  * @window: a toplevel #GdkWindow
10234  * @skips_taskbar: %TRUE to skip the taskbar
10235  *
10236  * Toggles whether a window should appear in a task list or window
10237  * list. If a window's semantic type as specified with
10238  * gdk_window_set_type_hint() already fully describes the window, this
10239  * function should <emphasis>not</emphasis> be called in addition,
10240  * instead you should allow the window to be treated according to
10241  * standard policy for its semantic type.
10242  *
10243  * Since: 2.2
10244  **/
10245 void
10246 gdk_window_set_skip_taskbar_hint (GdkWindow *window,
10247                                   gboolean   skips_taskbar)
10248 {
10249   GDK_WINDOW_IMPL_GET_CLASS (window->impl)->set_skip_taskbar_hint (window, skips_taskbar);
10250 }
10251
10252 /**
10253  * gdk_window_set_skip_pager_hint:
10254  * @window: a toplevel #GdkWindow
10255  * @skips_pager: %TRUE to skip the pager
10256  *
10257  * Toggles whether a window should appear in a pager (workspace
10258  * switcher, or other desktop utility program that displays a small
10259  * thumbnail representation of the windows on the desktop). If a
10260  * window's semantic type as specified with gdk_window_set_type_hint()
10261  * already fully describes the window, this function should
10262  * <emphasis>not</emphasis> be called in addition, instead you should
10263  * allow the window to be treated according to standard policy for
10264  * its semantic type.
10265  *
10266  * Since: 2.2
10267  **/
10268 void
10269 gdk_window_set_skip_pager_hint (GdkWindow *window,
10270                                 gboolean   skips_pager)
10271 {
10272   GDK_WINDOW_IMPL_GET_CLASS (window->impl)->set_skip_pager_hint (window, skips_pager);
10273 }
10274
10275 /**
10276  * gdk_window_set_urgency_hint:
10277  * @window: a toplevel #GdkWindow
10278  * @urgent: %TRUE if the window is urgent
10279  *
10280  * Toggles whether a window needs the user's
10281  * urgent attention.
10282  *
10283  * Since: 2.8
10284  **/
10285 void
10286 gdk_window_set_urgency_hint (GdkWindow *window,
10287                              gboolean   urgent)
10288 {
10289   GDK_WINDOW_IMPL_GET_CLASS (window->impl)->set_urgency_hint (window, urgent);
10290 }
10291
10292 /**
10293  * gdk_window_set_geometry_hints:
10294  * @window: a toplevel #GdkWindow
10295  * @geometry: geometry hints
10296  * @geom_mask: bitmask indicating fields of @geometry to pay attention to
10297  *
10298  * Sets the geometry hints for @window. Hints flagged in @geom_mask
10299  * are set, hints not flagged in @geom_mask are unset.
10300  * To unset all hints, use a @geom_mask of 0 and a @geometry of %NULL.
10301  *
10302  * This function provides hints to the windowing system about
10303  * acceptable sizes for a toplevel window. The purpose of
10304  * this is to constrain user resizing, but the windowing system
10305  * will typically  (but is not required to) also constrain the
10306  * current size of the window to the provided values and
10307  * constrain programatic resizing via gdk_window_resize() or
10308  * gdk_window_move_resize().
10309  *
10310  * Note that on X11, this effect has no effect on windows
10311  * of type %GDK_WINDOW_TEMP or windows where override redirect
10312  * has been turned on via gdk_window_set_override_redirect()
10313  * since these windows are not resizable by the user.
10314  *
10315  * Since you can't count on the windowing system doing the
10316  * constraints for programmatic resizes, you should generally
10317  * call gdk_window_constrain_size() yourself to determine
10318  * appropriate sizes.
10319  *
10320  **/
10321 void
10322 gdk_window_set_geometry_hints (GdkWindow         *window,
10323                                const GdkGeometry *geometry,
10324                                GdkWindowHints     geom_mask)
10325 {
10326   GDK_WINDOW_IMPL_GET_CLASS (window->impl)->set_geometry_hints (window, geometry, geom_mask);
10327 }
10328
10329 /**
10330  * gdk_window_set_title:
10331  * @window: a toplevel #GdkWindow
10332  * @title: title of @window
10333  *
10334  * Sets the title of a toplevel window, to be displayed in the titlebar.
10335  * If you haven't explicitly set the icon name for the window
10336  * (using gdk_window_set_icon_name()), the icon name will be set to
10337  * @title as well. @title must be in UTF-8 encoding (as with all
10338  * user-readable strings in GDK/GTK+). @title may not be %NULL.
10339  **/
10340 void
10341 gdk_window_set_title (GdkWindow   *window,
10342                       const gchar *title)
10343 {
10344   GDK_WINDOW_IMPL_GET_CLASS (window->impl)->set_title (window, title);
10345 }
10346
10347 /**
10348  * gdk_window_set_role:
10349  * @window: a toplevel #GdkWindow
10350  * @role: a string indicating its role
10351  *
10352  * When using GTK+, typically you should use gtk_window_set_role() instead
10353  * of this low-level function.
10354  *
10355  * The window manager and session manager use a window's role to
10356  * distinguish it from other kinds of window in the same application.
10357  * When an application is restarted after being saved in a previous
10358  * session, all windows with the same title and role are treated as
10359  * interchangeable.  So if you have two windows with the same title
10360  * that should be distinguished for session management purposes, you
10361  * should set the role on those windows. It doesn't matter what string
10362  * you use for the role, as long as you have a different role for each
10363  * non-interchangeable kind of window.
10364  *
10365  **/
10366 void
10367 gdk_window_set_role (GdkWindow   *window,
10368                      const gchar *role)
10369 {
10370   GDK_WINDOW_IMPL_GET_CLASS (window->impl)->set_role (window, role);
10371 }
10372
10373 /**
10374  * gdk_window_set_startup_id:
10375  * @window: a toplevel #GdkWindow
10376  * @startup_id: a string with startup-notification identifier
10377  *
10378  * When using GTK+, typically you should use gtk_window_set_startup_id()
10379  * instead of this low-level function.
10380  *
10381  * Since: 2.12
10382  *
10383  **/
10384 void
10385 gdk_window_set_startup_id (GdkWindow   *window,
10386                            const gchar *startup_id)
10387 {
10388   GDK_WINDOW_IMPL_GET_CLASS (window->impl)->set_startup_id (window, startup_id);
10389 }
10390
10391 /**
10392  * gdk_window_set_transient_for:
10393  * @window: a toplevel #GdkWindow
10394  * @parent: another toplevel #GdkWindow
10395  *
10396  * Indicates to the window manager that @window is a transient dialog
10397  * associated with the application window @parent. This allows the
10398  * window manager to do things like center @window on @parent and
10399  * keep @window above @parent.
10400  *
10401  * See gtk_window_set_transient_for() if you're using #GtkWindow or
10402  * #GtkDialog.
10403  **/
10404 void
10405 gdk_window_set_transient_for (GdkWindow *window,
10406                               GdkWindow *parent)
10407 {
10408   GDK_WINDOW_IMPL_GET_CLASS (window->impl)->set_transient_for (window, parent);
10409 }
10410
10411 /**
10412  * gdk_window_get_root_origin:
10413  * @window: a toplevel #GdkWindow
10414  * @x: (out): return location for X position of window frame
10415  * @y: (out): return location for Y position of window frame
10416  *
10417  * Obtains the top-left corner of the window manager frame in root
10418  * window coordinates.
10419  *
10420  **/
10421 void
10422 gdk_window_get_root_origin (GdkWindow *window,
10423                             gint      *x,
10424                             gint      *y)
10425 {
10426   GDK_WINDOW_IMPL_GET_CLASS (window->impl)->get_root_origin (window, x, y);
10427 }
10428
10429 /**
10430  * gdk_window_get_frame_extents:
10431  * @window: a toplevel #GdkWindow
10432  * @rect: (out): rectangle to fill with bounding box of the window frame
10433  *
10434  * Obtains the bounding box of the window, including window manager
10435  * titlebar/borders if any. The frame position is given in root window
10436  * coordinates. To get the position of the window itself (rather than
10437  * the frame) in root window coordinates, use gdk_window_get_origin().
10438  *
10439  **/
10440 void
10441 gdk_window_get_frame_extents (GdkWindow    *window,
10442                               GdkRectangle *rect)
10443 {
10444   GDK_WINDOW_IMPL_GET_CLASS (window->impl)->get_frame_extents (window, rect);
10445 }
10446
10447 /**
10448  * gdk_window_set_override_redirect:
10449  * @window: a toplevel #GdkWindow
10450  * @override_redirect: %TRUE if window should be override redirect
10451  *
10452  * An override redirect window is not under the control of the window manager.
10453  * This means it won't have a titlebar, won't be minimizable, etc. - it will
10454  * be entirely under the control of the application. The window manager
10455  * can't see the override redirect window at all.
10456  *
10457  * Override redirect should only be used for short-lived temporary
10458  * windows, such as popup menus. #GtkMenu uses an override redirect
10459  * window in its implementation, for example.
10460  *
10461  **/
10462 void
10463 gdk_window_set_override_redirect (GdkWindow *window,
10464                                   gboolean override_redirect)
10465 {
10466   GDK_WINDOW_IMPL_GET_CLASS (window->impl)->set_override_redirect (window, override_redirect);
10467 }
10468
10469 /**
10470  * gdk_window_set_accept_focus:
10471  * @window: a toplevel #GdkWindow
10472  * @accept_focus: %TRUE if the window should receive input focus
10473  *
10474  * Setting @accept_focus to %FALSE hints the desktop environment that the
10475  * window doesn't want to receive input focus.
10476  *
10477  * On X, it is the responsibility of the window manager to interpret this
10478  * hint. ICCCM-compliant window manager usually respect it.
10479  *
10480  * Since: 2.4
10481  **/
10482 void
10483 gdk_window_set_accept_focus (GdkWindow *window,
10484                              gboolean accept_focus)
10485 {
10486   GDK_WINDOW_IMPL_GET_CLASS (window->impl)->set_accept_focus (window, accept_focus);
10487 }
10488
10489 /**
10490  * gdk_window_set_focus_on_map:
10491  * @window: a toplevel #GdkWindow
10492  * @focus_on_map: %TRUE if the window should receive input focus when mapped
10493  *
10494  * Setting @focus_on_map to %FALSE hints the desktop environment that the
10495  * window doesn't want to receive input focus when it is mapped.
10496  * focus_on_map should be turned off for windows that aren't triggered
10497  * interactively (such as popups from network activity).
10498  *
10499  * On X, it is the responsibility of the window manager to interpret
10500  * this hint. Window managers following the freedesktop.org window
10501  * manager extension specification should respect it.
10502  *
10503  * Since: 2.6
10504  **/
10505 void
10506 gdk_window_set_focus_on_map (GdkWindow *window,
10507                              gboolean focus_on_map)
10508 {
10509   GDK_WINDOW_IMPL_GET_CLASS (window->impl)->set_focus_on_map (window, focus_on_map);
10510 }
10511
10512 /**
10513  * gdk_window_set_icon_list:
10514  * @window: The #GdkWindow toplevel window to set the icon of.
10515  * @pixbufs: (transfer none) (element-type GdkPixbuf):
10516  *     A list of pixbufs, of different sizes.
10517  *
10518  * Sets a list of icons for the window. One of these will be used
10519  * to represent the window when it has been iconified. The icon is
10520  * usually shown in an icon box or some sort of task bar. Which icon
10521  * size is shown depends on the window manager. The window manager
10522  * can scale the icon  but setting several size icons can give better
10523  * image quality since the window manager may only need to scale the
10524  * icon by a small amount or not at all.
10525  *
10526  **/
10527 void
10528 gdk_window_set_icon_list (GdkWindow *window,
10529                           GList     *pixbufs)
10530 {
10531   GDK_WINDOW_IMPL_GET_CLASS (window->impl)->set_icon_list (window, pixbufs);
10532 }
10533
10534 /**
10535  * gdk_window_set_icon_name:
10536  * @window: a toplevel #GdkWindow
10537  * @name: (allow-none): name of window while iconified (minimized)
10538  *
10539  * Windows may have a name used while minimized, distinct from the
10540  * name they display in their titlebar. Most of the time this is a bad
10541  * idea from a user interface standpoint. But you can set such a name
10542  * with this function, if you like.
10543  *
10544  * After calling this with a non-%NULL @name, calls to gdk_window_set_title()
10545  * will not update the icon title.
10546  *
10547  * Using %NULL for @name unsets the icon title; further calls to
10548  * gdk_window_set_title() will again update the icon title as well.
10549  **/
10550 void
10551 gdk_window_set_icon_name (GdkWindow   *window,
10552                           const gchar *name)
10553 {
10554   GDK_WINDOW_IMPL_GET_CLASS (window->impl)->set_icon_name (window, name);
10555 }
10556
10557 /**
10558  * gdk_window_iconify:
10559  * @window: a toplevel #GdkWindow
10560  *
10561  * Asks to iconify (minimize) @window. The window manager may choose
10562  * to ignore the request, but normally will honor it. Using
10563  * gtk_window_iconify() is preferred, if you have a #GtkWindow widget.
10564  *
10565  * This function only makes sense when @window is a toplevel window.
10566  *
10567  **/
10568 void
10569 gdk_window_iconify (GdkWindow *window)
10570 {
10571   GDK_WINDOW_IMPL_GET_CLASS (window->impl)->iconify (window);
10572 }
10573
10574 /**
10575  * gdk_window_deiconify:
10576  * @window: a toplevel #GdkWindow
10577  *
10578  * Attempt to deiconify (unminimize) @window. On X11 the window manager may
10579  * choose to ignore the request to deiconify. When using GTK+,
10580  * use gtk_window_deiconify() instead of the #GdkWindow variant. Or better yet,
10581  * you probably want to use gtk_window_present(), which raises the window, focuses it,
10582  * unminimizes it, and puts it on the current desktop.
10583  *
10584  **/
10585 void
10586 gdk_window_deiconify (GdkWindow *window)
10587 {
10588   GDK_WINDOW_IMPL_GET_CLASS (window->impl)->deiconify (window);
10589 }
10590
10591 /**
10592  * gdk_window_stick:
10593  * @window: a toplevel #GdkWindow
10594  *
10595  * "Pins" a window such that it's on all workspaces and does not scroll
10596  * with viewports, for window managers that have scrollable viewports.
10597  * (When using #GtkWindow, gtk_window_stick() may be more useful.)
10598  *
10599  * On the X11 platform, this function depends on window manager
10600  * support, so may have no effect with many window managers. However,
10601  * GDK will do the best it can to convince the window manager to stick
10602  * the window. For window managers that don't support this operation,
10603  * there's nothing you can do to force it to happen.
10604  *
10605  **/
10606 void
10607 gdk_window_stick (GdkWindow *window)
10608 {
10609   GDK_WINDOW_IMPL_GET_CLASS (window->impl)->stick (window);
10610 }
10611
10612 /**
10613  * gdk_window_unstick:
10614  * @window: a toplevel #GdkWindow
10615  *
10616  * Reverse operation for gdk_window_stick(); see gdk_window_stick(),
10617  * and gtk_window_unstick().
10618  *
10619  **/
10620 void
10621 gdk_window_unstick (GdkWindow *window)
10622 {
10623   GDK_WINDOW_IMPL_GET_CLASS (window->impl)->unstick (window);
10624 }
10625
10626 /**
10627  * gdk_window_maximize:
10628  * @window: a toplevel #GdkWindow
10629  *
10630  * Maximizes the window. If the window was already maximized, then
10631  * this function does nothing.
10632  *
10633  * On X11, asks the window manager to maximize @window, if the window
10634  * manager supports this operation. Not all window managers support
10635  * this, and some deliberately ignore it or don't have a concept of
10636  * "maximized"; so you can't rely on the maximization actually
10637  * happening. But it will happen with most standard window managers,
10638  * and GDK makes a best effort to get it to happen.
10639  *
10640  * On Windows, reliably maximizes the window.
10641  *
10642  **/
10643 void
10644 gdk_window_maximize (GdkWindow *window)
10645 {
10646   GDK_WINDOW_IMPL_GET_CLASS (window->impl)->maximize (window);
10647 }
10648
10649 /**
10650  * gdk_window_unmaximize:
10651  * @window: a toplevel #GdkWindow
10652  *
10653  * Unmaximizes the window. If the window wasn't maximized, then this
10654  * function does nothing.
10655  *
10656  * On X11, asks the window manager to unmaximize @window, if the
10657  * window manager supports this operation. Not all window managers
10658  * support this, and some deliberately ignore it or don't have a
10659  * concept of "maximized"; so you can't rely on the unmaximization
10660  * actually happening. But it will happen with most standard window
10661  * managers, and GDK makes a best effort to get it to happen.
10662  *
10663  * On Windows, reliably unmaximizes the window.
10664  *
10665  **/
10666 void
10667 gdk_window_unmaximize (GdkWindow *window)
10668 {
10669   GDK_WINDOW_IMPL_GET_CLASS (window->impl)->unmaximize (window);
10670 }
10671
10672 /**
10673  * gdk_window_fullscreen:
10674  * @window: a toplevel #GdkWindow
10675  *
10676  * Moves the window into fullscreen mode. This means the
10677  * window covers the entire screen and is above any panels
10678  * or task bars.
10679  *
10680  * If the window was already fullscreen, then this function does nothing.
10681  *
10682  * On X11, asks the window manager to put @window in a fullscreen
10683  * state, if the window manager supports this operation. Not all
10684  * window managers support this, and some deliberately ignore it or
10685  * don't have a concept of "fullscreen"; so you can't rely on the
10686  * fullscreenification actually happening. But it will happen with
10687  * most standard window managers, and GDK makes a best effort to get
10688  * it to happen.
10689  *
10690  * Since: 2.2
10691  **/
10692 void
10693 gdk_window_fullscreen (GdkWindow *window)
10694 {
10695   GDK_WINDOW_IMPL_GET_CLASS (window->impl)->fullscreen (window);
10696 }
10697
10698 /**
10699  * gdk_window_unfullscreen:
10700  * @window: a toplevel #GdkWindow
10701  *
10702  * Moves the window out of fullscreen mode. If the window was not
10703  * fullscreen, does nothing.
10704  *
10705  * On X11, asks the window manager to move @window out of the fullscreen
10706  * state, if the window manager supports this operation. Not all
10707  * window managers support this, and some deliberately ignore it or
10708  * don't have a concept of "fullscreen"; so you can't rely on the
10709  * unfullscreenification actually happening. But it will happen with
10710  * most standard window managers, and GDK makes a best effort to get
10711  * it to happen.
10712  *
10713  * Since: 2.2
10714  **/
10715 void
10716 gdk_window_unfullscreen (GdkWindow *window)
10717 {
10718   GDK_WINDOW_IMPL_GET_CLASS (window->impl)->unfullscreen (window);
10719 }
10720
10721 /**
10722  * gdk_window_set_keep_above:
10723  * @window: a toplevel #GdkWindow
10724  * @setting: whether to keep @window above other windows
10725  *
10726  * Set if @window must be kept above other windows. If the
10727  * window was already above, then this function does nothing.
10728  *
10729  * On X11, asks the window manager to keep @window above, if the window
10730  * manager supports this operation. Not all window managers support
10731  * this, and some deliberately ignore it or don't have a concept of
10732  * "keep above"; so you can't rely on the window being kept above.
10733  * But it will happen with most standard window managers,
10734  * and GDK makes a best effort to get it to happen.
10735  *
10736  * Since: 2.4
10737  **/
10738 void
10739 gdk_window_set_keep_above (GdkWindow *window,
10740                            gboolean   setting)
10741 {
10742   GDK_WINDOW_IMPL_GET_CLASS (window->impl)->set_keep_above (window, setting);
10743 }
10744
10745 /**
10746  * gdk_window_set_keep_below:
10747  * @window: a toplevel #GdkWindow
10748  * @setting: whether to keep @window below other windows
10749  *
10750  * Set if @window must be kept below other windows. If the
10751  * window was already below, then this function does nothing.
10752  *
10753  * On X11, asks the window manager to keep @window below, if the window
10754  * manager supports this operation. Not all window managers support
10755  * this, and some deliberately ignore it or don't have a concept of
10756  * "keep below"; so you can't rely on the window being kept below.
10757  * But it will happen with most standard window managers,
10758  * and GDK makes a best effort to get it to happen.
10759  *
10760  * Since: 2.4
10761  **/
10762 void
10763 gdk_window_set_keep_below (GdkWindow *window, gboolean setting)
10764 {
10765   GDK_WINDOW_IMPL_GET_CLASS (window->impl)->set_keep_below (window, setting);
10766 }
10767
10768 /**
10769  * gdk_window_get_group:
10770  * @window: a toplevel #GdkWindow
10771  *
10772  * Returns the group leader window for @window. See gdk_window_set_group().
10773  *
10774  * Return value: (transfer none): the group leader window for @window
10775  *
10776  * Since: 2.4
10777  **/
10778 GdkWindow *
10779 gdk_window_get_group (GdkWindow *window)
10780 {
10781   return GDK_WINDOW_IMPL_GET_CLASS (window->impl)->get_group (window);
10782 }
10783
10784 /**
10785  * gdk_window_set_group:
10786  * @window: a toplevel #GdkWindow
10787  * @leader: (allow-none): group leader window, or %NULL to restore the default group leader window
10788  *
10789  * Sets the group leader window for @window. By default,
10790  * GDK sets the group leader for all toplevel windows
10791  * to a global window implicitly created by GDK. With this function
10792  * you can override this default.
10793  *
10794  * The group leader window allows the window manager to distinguish
10795  * all windows that belong to a single application. It may for example
10796  * allow users to minimize/unminimize all windows belonging to an
10797  * application at once. You should only set a non-default group window
10798  * if your application pretends to be multiple applications.
10799  **/
10800 void
10801 gdk_window_set_group (GdkWindow *window,
10802                       GdkWindow *leader)
10803 {
10804   GDK_WINDOW_IMPL_GET_CLASS (window->impl)->set_group (window, leader);
10805 }
10806
10807 /**
10808  * gdk_window_set_decorations:
10809  * @window: a toplevel #GdkWindow
10810  * @decorations: decoration hint mask
10811  *
10812  * "Decorations" are the features the window manager adds to a toplevel #GdkWindow.
10813  * This function sets the traditional Motif window manager hints that tell the
10814  * window manager which decorations you would like your window to have.
10815  * Usually you should use gtk_window_set_decorated() on a #GtkWindow instead of
10816  * using the GDK function directly.
10817  *
10818  * The @decorations argument is the logical OR of the fields in
10819  * the #GdkWMDecoration enumeration. If #GDK_DECOR_ALL is included in the
10820  * mask, the other bits indicate which decorations should be turned off.
10821  * If #GDK_DECOR_ALL is not included, then the other bits indicate
10822  * which decorations should be turned on.
10823  *
10824  * Most window managers honor a decorations hint of 0 to disable all decorations,
10825  * but very few honor all possible combinations of bits.
10826  *
10827  **/
10828 void
10829 gdk_window_set_decorations (GdkWindow      *window,
10830                             GdkWMDecoration decorations)
10831 {
10832   GDK_WINDOW_IMPL_GET_CLASS (window->impl)->set_decorations (window, decorations);
10833 }
10834
10835 /**
10836  * gdk_window_get_decorations:
10837  * @window: The toplevel #GdkWindow to get the decorations from
10838  * @decorations: (out): The window decorations will be written here
10839  *
10840  * Returns the decorations set on the GdkWindow with
10841  * gdk_window_set_decorations().
10842  *
10843  * Returns: %TRUE if the window has decorations set, %FALSE otherwise.
10844  **/
10845 gboolean
10846 gdk_window_get_decorations(GdkWindow       *window,
10847                            GdkWMDecoration *decorations)
10848 {
10849   return GDK_WINDOW_IMPL_GET_CLASS (window->impl)->get_decorations (window, decorations);
10850 }
10851
10852 /**
10853  * gdk_window_set_functions:
10854  * @window: a toplevel #GdkWindow
10855  * @functions: bitmask of operations to allow on @window
10856  *
10857  * Sets hints about the window management functions to make available
10858  * via buttons on the window frame.
10859  *
10860  * On the X backend, this function sets the traditional Motif window
10861  * manager hint for this purpose. However, few window managers do
10862  * anything reliable or interesting with this hint. Many ignore it
10863  * entirely.
10864  *
10865  * The @functions argument is the logical OR of values from the
10866  * #GdkWMFunction enumeration. If the bitmask includes #GDK_FUNC_ALL,
10867  * then the other bits indicate which functions to disable; if
10868  * it doesn't include #GDK_FUNC_ALL, it indicates which functions to
10869  * enable.
10870  *
10871  **/
10872 void
10873 gdk_window_set_functions (GdkWindow    *window,
10874                           GdkWMFunction functions)
10875 {
10876   GDK_WINDOW_IMPL_GET_CLASS (window->impl)->set_functions (window, functions);
10877 }
10878
10879 /**
10880  * gdk_window_begin_resize_drag_for_device:
10881  * @window: a toplevel #GdkWindow
10882  * @edge: the edge or corner from which the drag is started
10883  * @device: the device used for the operation
10884  * @button: the button being used to drag
10885  * @root_x: root window X coordinate of mouse click that began the drag
10886  * @root_y: root window Y coordinate of mouse click that began the drag
10887  * @timestamp: timestamp of mouse click that began the drag (use gdk_event_get_time())
10888  *
10889  * Begins a window resize operation (for a toplevel window).
10890  * You might use this function to implement a "window resize grip," for
10891  * example; in fact #GtkStatusbar uses it. The function works best
10892  * with window managers that support the <ulink url="http://www.freedesktop.org/Standards/wm-spec">Extended Window Manager Hints</ulink>, but has a
10893  * fallback implementation for other window managers.
10894  *
10895  * Since: 3.4
10896  */
10897 void
10898 gdk_window_begin_resize_drag_for_device (GdkWindow     *window,
10899                                          GdkWindowEdge  edge,
10900                                          GdkDevice     *device,
10901                                          gint           button,
10902                                          gint           root_x,
10903                                          gint           root_y,
10904                                          guint32        timestamp)
10905 {
10906   GDK_WINDOW_IMPL_GET_CLASS (window->impl)->begin_resize_drag (window, edge, device, button, root_x, root_y, timestamp);
10907 }
10908
10909 /**
10910  * gdk_window_begin_resize_drag:
10911  * @window: a toplevel #GdkWindow
10912  * @edge: the edge or corner from which the drag is started
10913  * @button: the button being used to drag
10914  * @root_x: root window X coordinate of mouse click that began the drag
10915  * @root_y: root window Y coordinate of mouse click that began the drag
10916  * @timestamp: timestamp of mouse click that began the drag (use gdk_event_get_time())
10917  *
10918  * Begins a window resize operation (for a toplevel window).
10919  *
10920  * This function assumes that the drag is controlled by the
10921  * client pointer device, use gdk_window_begin_resize_drag_for_device()
10922  * to begin a drag with a different device.
10923  */
10924 void
10925 gdk_window_begin_resize_drag (GdkWindow     *window,
10926                               GdkWindowEdge  edge,
10927                               gint           button,
10928                               gint           root_x,
10929                               gint           root_y,
10930                               guint32        timestamp)
10931 {
10932   GdkDeviceManager *device_manager;
10933   GdkDevice *device;
10934
10935   device_manager = gdk_display_get_device_manager (gdk_window_get_display (window));
10936   device = gdk_device_manager_get_client_pointer (device_manager);
10937   gdk_window_begin_resize_drag_for_device (window, edge,
10938                                            device, button, root_x, root_y, timestamp);
10939 }
10940
10941 /**
10942  * gdk_window_begin_move_drag_for_device:
10943  * @window: a toplevel #GdkWindow
10944  * @device: the device used for the operation
10945  * @button: the button being used to drag
10946  * @root_x: root window X coordinate of mouse click that began the drag
10947  * @root_y: root window Y coordinate of mouse click that began the drag
10948  * @timestamp: timestamp of mouse click that began the drag
10949  *
10950  * Begins a window move operation (for a toplevel window).
10951  * You might use this function to implement a "window move grip," for
10952  * example. The function works best with window managers that support
10953  * the <ulink url="http://www.freedesktop.org/Standards/wm-spec">Extended
10954  * Window Manager Hints</ulink>, but has a fallback implementation for
10955  * other window managers.
10956  *
10957  * Since: 3.4
10958  */
10959 void
10960 gdk_window_begin_move_drag_for_device (GdkWindow *window,
10961                                        GdkDevice *device,
10962                                        gint       button,
10963                                        gint       root_x,
10964                                        gint       root_y,
10965                                        guint32    timestamp)
10966 {
10967   GDK_WINDOW_IMPL_GET_CLASS (window->impl)->begin_move_drag (window,
10968                                                              device, button, root_x, root_y, timestamp);
10969 }
10970
10971 /**
10972  * gdk_window_begin_move_drag:
10973  * @window: a toplevel #GdkWindow
10974  * @button: the button being used to drag
10975  * @root_x: root window X coordinate of mouse click that began the drag
10976  * @root_y: root window Y coordinate of mouse click that began the drag
10977  * @timestamp: timestamp of mouse click that began the drag
10978  *
10979  * Begins a window move operation (for a toplevel window).
10980  *
10981  * This function assumes that the drag is controlled by the
10982  * client pointer device, use gdk_window_begin_move_drag_for_device()
10983  * to begin a drag with a different device.
10984  */
10985 void
10986 gdk_window_begin_move_drag (GdkWindow *window,
10987                             gint       button,
10988                             gint       root_x,
10989                             gint       root_y,
10990                             guint32    timestamp)
10991 {
10992   GdkDeviceManager *device_manager;
10993   GdkDevice *device;
10994
10995   device_manager = gdk_display_get_device_manager (gdk_window_get_display (window));
10996   device = gdk_device_manager_get_client_pointer (device_manager);
10997   gdk_window_begin_move_drag_for_device (window, device, button, root_x, root_y, timestamp);
10998 }
10999
11000 /**
11001  * gdk_window_enable_synchronized_configure:
11002  * @window: a toplevel #GdkWindow
11003  *
11004  * Indicates that the application will cooperate with the window
11005  * system in synchronizing the window repaint with the window
11006  * manager during resizing operations. After an application calls
11007  * this function, it must call gdk_window_configure_finished() every
11008  * time it has finished all processing associated with a set of
11009  * Configure events. Toplevel GTK+ windows automatically use this
11010  * protocol.
11011  *
11012  * On X, calling this function makes @window participate in the
11013  * _NET_WM_SYNC_REQUEST window manager protocol.
11014  *
11015  * Since: 2.6
11016  **/
11017 void
11018 gdk_window_enable_synchronized_configure (GdkWindow *window)
11019 {
11020   GDK_WINDOW_IMPL_GET_CLASS (window->impl)->enable_synchronized_configure (window);
11021 }
11022
11023 /**
11024  * gdk_window_configure_finished:
11025  * @window: a toplevel #GdkWindow
11026  * 
11027  * Signal to the window system that the application has finished
11028  * handling Configure events it has received. Window Managers can
11029  * use this to better synchronize the frame repaint with the
11030  * application. GTK+ applications will automatically call this
11031  * function when appropriate.
11032  *
11033  * This function can only be called if gdk_window_enable_synchronized_configure()
11034  * was called previously.
11035  *
11036  * Since: 2.6
11037  **/
11038 void
11039 gdk_window_configure_finished (GdkWindow *window)
11040 {
11041   GDK_WINDOW_IMPL_GET_CLASS (window->impl)->configure_finished (window);
11042 }
11043
11044 /**
11045  * gdk_window_set_opacity:
11046  * @window: a top-level #GdkWindow
11047  * @opacity: opacity
11048  *
11049  * Request the windowing system to make @window partially transparent,
11050  * with opacity 0 being fully transparent and 1 fully opaque. (Values
11051  * of the opacity parameter are clamped to the [0,1] range.) 
11052  *
11053  * On X11, this works only on X screens with a compositing manager 
11054  * running.
11055  *
11056  * For setting up per-pixel alpha, see gdk_screen_get_rgba_visual().
11057  * For making non-toplevel windows translucent, see 
11058  * gdk_window_set_composited().
11059  *
11060  * Since: 2.12
11061  */
11062 void
11063 gdk_window_set_opacity (GdkWindow *window,
11064                         gdouble    opacity)
11065 {
11066   GDK_WINDOW_IMPL_GET_CLASS (window->impl)->set_opacity (window, opacity);
11067 }
11068
11069 /* This function is called when the XWindow is really gone.
11070  */
11071 void
11072 gdk_window_destroy_notify (GdkWindow *window)
11073 {
11074   GDK_WINDOW_IMPL_GET_CLASS (window->impl)->destroy_notify (window);
11075 }
11076
11077 /**
11078  * gdk_window_register_dnd:
11079  * @window: a #GdkWindow.
11080  *
11081  * Registers a window as a potential drop destination.
11082  */
11083 void
11084 gdk_window_register_dnd (GdkWindow *window)
11085 {
11086   GDK_WINDOW_IMPL_GET_CLASS (window->impl)->register_dnd (window);
11087 }
11088
11089 /**
11090  * gdk_window_get_drag_protocol:
11091  * @window: the destination window
11092  * @target: (out) (allow-none) (transfer full): location of the window
11093  *    where the drop should happen. This may be @window or a proxy window,
11094  *    or %NULL if @window does not support Drag and Drop.
11095  *
11096  * Finds out the DND protocol supported by a window.
11097  *
11098  * Returns: the supported DND protocol.
11099  *
11100  * Since: 3.0
11101  */
11102 GdkDragProtocol
11103 gdk_window_get_drag_protocol (GdkWindow  *window,
11104                               GdkWindow **target)
11105 {
11106   g_return_val_if_fail (GDK_IS_WINDOW (window), GDK_DRAG_PROTO_NONE);
11107
11108   return GDK_WINDOW_IMPL_GET_CLASS (window->impl)->get_drag_protocol (window, target);
11109 }
11110
11111 /**
11112  * gdk_drag_begin:
11113  * @window: the source window for this drag.
11114  * @targets: (transfer none) (element-type GdkAtom): the offered targets,
11115  *     as list of #GdkAtoms
11116  *
11117  * Starts a drag and creates a new drag context for it.
11118  * This function assumes that the drag is controlled by the
11119  * client pointer device, use gdk_drag_begin_for_device() to
11120  * begin a drag with a different device.
11121  *
11122  * This function is called by the drag source.
11123  *
11124  * Return value: (transfer full): a newly created #GdkDragContext
11125  */
11126 GdkDragContext *
11127 gdk_drag_begin (GdkWindow     *window,
11128                 GList         *targets)
11129 {
11130   GdkDeviceManager *device_manager;
11131   GdkDevice *device;
11132
11133   device_manager = gdk_display_get_device_manager (gdk_window_get_display (window));
11134   device = gdk_device_manager_get_client_pointer (device_manager);
11135
11136   return gdk_drag_begin_for_device (window, device, targets);
11137 }
11138
11139 /**
11140  * gdk_drag_begin_for_device:
11141  * @window: the source window for this drag
11142  * @device: the device that controls this drag
11143  * @targets: (transfer none) (element-type GdkAtom): the offered targets,
11144  *     as list of #GdkAtoms
11145  *
11146  * Starts a drag and creates a new drag context for it.
11147  *
11148  * This function is called by the drag source.
11149  *
11150  * Return value: (transfer full): a newly created #GdkDragContext
11151  */
11152 GdkDragContext *
11153 gdk_drag_begin_for_device (GdkWindow     *window,
11154                            GdkDevice     *device,
11155                            GList         *targets)
11156 {
11157   return GDK_WINDOW_IMPL_GET_CLASS (window->impl)->drag_begin (window, device, targets);
11158 }
11159
11160 /**
11161  * gdk_test_render_sync:
11162  * @window: a mapped #GdkWindow
11163  *
11164  * Retrieves a pixel from @window to force the windowing
11165  * system to carry out any pending rendering commands.
11166  *
11167  * This function is intended to be used to synchronize with rendering
11168  * pipelines, to benchmark windowing system rendering operations.
11169  *
11170  * Since: 2.14
11171  **/
11172 void
11173 gdk_test_render_sync (GdkWindow *window)
11174 {
11175   GDK_WINDOW_IMPL_GET_CLASS (window->impl)->sync_rendering (window);
11176 }
11177
11178 /**
11179  * gdk_test_simulate_key:
11180  * @window: a #GdkWindow to simulate a key event for
11181  * @x:      x coordinate within @window for the key event
11182  * @y:      y coordinate within @window for the key event
11183  * @keyval: A GDK keyboard value
11184  * @modifiers: Keyboard modifiers the event is setup with
11185  * @key_pressrelease: either %GDK_KEY_PRESS or %GDK_KEY_RELEASE
11186  *
11187  * This function is intended to be used in GTK+ test programs.
11188  * If (@x,@y) are > (-1,-1), it will warp the mouse pointer to
11189  * the given (@x,@y) coordinates within @window and simulate a
11190  * key press or release event.
11191  *
11192  * When the mouse pointer is warped to the target location, use
11193  * of this function outside of test programs that run in their
11194  * own virtual windowing system (e.g. Xvfb) is not recommended.
11195  * If (@x,@y) are passed as (-1,-1), the mouse pointer will not
11196  * be warped and @window origin will be used as mouse pointer
11197  * location for the event.
11198  *
11199  * Also, gdk_test_simulate_key() is a fairly low level function,
11200  * for most testing purposes, gtk_test_widget_send_key() is the
11201  * right function to call which will generate a key press event
11202  * followed by its accompanying key release event.
11203  *
11204  * Returns: whether all actions necessary for a key event simulation
11205  *     were carried out successfully
11206  *
11207  * Since: 2.14
11208  */
11209 gboolean
11210 gdk_test_simulate_key (GdkWindow      *window,
11211                        gint            x,
11212                        gint            y,
11213                        guint           keyval,
11214                        GdkModifierType modifiers,
11215                        GdkEventType    key_pressrelease)
11216 {
11217   return GDK_WINDOW_IMPL_GET_CLASS (window->impl)
11218     ->simulate_key (window, x, y, keyval, modifiers, key_pressrelease);
11219 }
11220
11221 /**
11222  * gdk_test_simulate_button:
11223  * @window: a #GdkWindow to simulate a button event for
11224  * @x:      x coordinate within @window for the button event
11225  * @y:      y coordinate within @window for the button event
11226  * @button: Number of the pointer button for the event, usually 1, 2 or 3
11227  * @modifiers: Keyboard modifiers the event is setup with
11228  * @button_pressrelease: either %GDK_BUTTON_PRESS or %GDK_BUTTON_RELEASE
11229  *
11230  * This function is intended to be used in GTK+ test programs.
11231  * It will warp the mouse pointer to the given (@x,@y) coordinates
11232  * within @window and simulate a button press or release event.
11233  * Because the mouse pointer needs to be warped to the target
11234  * location, use of this function outside of test programs that
11235  * run in their own virtual windowing system (e.g. Xvfb) is not
11236  * recommended.
11237  *
11238 * Also, gdk_test_simulate_button() is a fairly low level function,
11239  * for most testing purposes, gtk_test_widget_click() is the right
11240  * function to call which will generate a button press event followed
11241  * by its accompanying button release event.
11242  *
11243  * Returns: whether all actions necessary for a button event simulation
11244  *     were carried out successfully
11245  *
11246  * Since: 2.14
11247  */
11248 gboolean
11249 gdk_test_simulate_button (GdkWindow      *window,
11250                           gint            x,
11251                           gint            y,
11252                           guint           button, /*1..3*/
11253                           GdkModifierType modifiers,
11254                           GdkEventType    button_pressrelease)
11255 {
11256   return GDK_WINDOW_IMPL_GET_CLASS (window->impl)
11257     ->simulate_button (window, x, y, button, modifiers, button_pressrelease);
11258 }
11259
11260 /**
11261  * gdk_property_get:
11262  * @window: a #GdkWindow
11263  * @property: the property to retrieve
11264  * @type: the desired property type, or %GDK_NONE, if any type of data
11265  *   is acceptable. If this does not match the actual
11266  *   type, then @actual_format and @actual_length will
11267  *   be filled in, a warning will be printed to stderr
11268  *   and no data will be returned.
11269  * @offset: the offset into the property at which to begin
11270  *   retrieving data, in 4 byte units.
11271  * @length: the length of the data to retrieve in bytes.  Data is
11272  *   considered to be retrieved in 4 byte chunks, so @length
11273  *   will be rounded up to the next highest 4 byte boundary
11274  *   (so be careful not to pass a value that might overflow
11275  *   when rounded up).
11276  * @pdelete: if %TRUE, delete the property after retrieving the
11277  *   data.
11278  * @actual_property_type: (out) (transfer none): location to store the
11279  *   actual type of the property.
11280  * @actual_format: (out): location to store the actual return format of the
11281  *   data; either 8, 16 or 32 bits.
11282  * @actual_length: location to store the length of the retrieved data, in
11283  *   bytes.  Data returned in the 32 bit format is stored
11284  *   in a long variable, so the actual number of 32 bit
11285  *   elements should be be calculated via
11286  *   @actual_length / sizeof(glong) to ensure portability to
11287  *   64 bit systems.
11288  * @data: (out) (array length=actual_length) (transfer full): location
11289  *   to store a pointer to the data. The retrieved data should be
11290  *   freed with g_free() when you are finished using it.
11291  *
11292  * Retrieves a portion of the contents of a property. If the
11293  * property does not exist, then the function returns %FALSE,
11294  * and %GDK_NONE will be stored in @actual_property_type.
11295  *
11296  * <note>
11297  * <para>
11298  * The XGetWindowProperty() function that gdk_property_get()
11299  * uses has a very confusing and complicated set of semantics.
11300  * Unfortunately, gdk_property_get() makes the situation
11301  * worse instead of better (the semantics should be considered
11302  * undefined), and also prints warnings to stderr in cases where it
11303  * should return a useful error to the program. You are advised to use
11304  * XGetWindowProperty() directly until a replacement function for
11305  * gdk_property_get()
11306  * is provided.
11307  * </para>
11308  * </note>
11309  *
11310  * Returns: %TRUE if data was successfully received and stored
11311  *   in @data, otherwise %FALSE.
11312  */
11313 gboolean
11314 gdk_property_get (GdkWindow  *window,
11315                   GdkAtom     property,
11316                   GdkAtom     type,
11317                   gulong      offset,
11318                   gulong      length,
11319                   gint        pdelete,
11320                   GdkAtom    *actual_property_type,
11321                   gint       *actual_format_type,
11322                   gint       *actual_length,
11323                   guchar    **data)
11324 {
11325   return GDK_WINDOW_IMPL_GET_CLASS (window->impl)
11326     ->get_property (window, property, type, offset, length, pdelete,
11327                     actual_property_type, actual_format_type,
11328                     actual_length, data);
11329 }
11330
11331 /**
11332  * gdk_property_change: (skip)
11333  * @window: a #GdkWindow
11334  * @property: the property to change
11335  * @type: the new type for the property. If @mode is
11336  *   %GDK_PROP_MODE_PREPEND or %GDK_PROP_MODE_APPEND, then this
11337  *   must match the existing type or an error will occur.
11338  * @format: the new format for the property. If @mode is
11339  *   %GDK_PROP_MODE_PREPEND or %GDK_PROP_MODE_APPEND, then this
11340  *   must match the existing format or an error will occur.
11341  * @mode: a value describing how the new data is to be combined
11342  *   with the current data.
11343  * @data: the data (a <literal>guchar *</literal>
11344  *   <literal>gushort *</literal>, or <literal>gulong *</literal>,
11345  *   depending on @format), cast to a <literal>guchar *</literal>.
11346  * @nelements: the number of elements of size determined by the format,
11347  *   contained in @data.
11348  *
11349  * Changes the contents of a property on a window.
11350  */
11351 void
11352 gdk_property_change (GdkWindow    *window,
11353                      GdkAtom       property,
11354                      GdkAtom       type,
11355                      gint          format,
11356                      GdkPropMode   mode,
11357                      const guchar *data,
11358                      gint          nelements)
11359 {
11360   GDK_WINDOW_IMPL_GET_CLASS (window->impl)
11361     ->change_property (window, property, type, format, mode, data, nelements);
11362 }
11363
11364 /**
11365  * gdk_property_delete:
11366  * @window: a #GdkWindow
11367  * @property: the property to delete
11368  *
11369  * Deletes a property from a window.
11370  */
11371 void
11372 gdk_property_delete (GdkWindow *window,
11373                      GdkAtom    property)
11374 {
11375   GDK_WINDOW_IMPL_GET_CLASS (window->impl)->delete_property (window, property);
11376 }