Pileus Git - ~andy/gtk/blob - gdk/gdkinternals.h

   1 /* GDK - The GIMP Drawing Kit
   2  * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library; if not, write to the
  16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  17  * Boston, MA 02111-1307, USA.
  18  */
  19
  20 /*
  21  * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
  22  * file for a list of people on the GTK+ Team.  See the ChangeLog
  23  * files for a list of changes.  These files are distributed with
  24  * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
  25  */
  26
  27 /* Uninstalled header defining types and functions internal to GDK */
  28
  29 #ifndef __GDK_INTERNALS_H__
  30 #define __GDK_INTERNALS_H__
  31
  32 #include <gio/gio.h>
  33 #include <gdk/gdktypes.h>
  34 #include <gdk/gdkwindow.h>
  35 #include <gdk/gdkwindowimpl.h>
  36 #include <gdk/gdkprivate.h>
  37
  38 G_BEGIN_DECLS
  39
  40 /**********************
  41  * General Facilities *
  42  **********************/
  43
  44 /* Debugging support */
  45
  46 typedef struct _GdkColorInfo           GdkColorInfo;
  47 typedef struct _GdkEventFilter         GdkEventFilter;
  48 typedef struct _GdkClientFilter        GdkClientFilter;
  49
  50 typedef enum {
  51   GDK_COLOR_WRITEABLE = 1 << 0
  52 } GdkColorInfoFlags;
  53
  54 struct _GdkColorInfo
  55 {
  56   GdkColorInfoFlags flags;
  57   guint ref_count;
  58 };
  59
  60 typedef enum {
  61   GDK_EVENT_FILTER_REMOVED = 1 << 0
  62 } GdkEventFilterFlags;
  63
  64 struct _GdkEventFilter {
  65   GdkFilterFunc function;
  66   gpointer data;
  67   GdkEventFilterFlags flags;
  68   guint ref_count;
  69 };
  70
  71 struct _GdkClientFilter {
  72   GdkAtom       type;
  73   GdkFilterFunc function;
  74   gpointer      data;
  75 };
  76
  77 typedef enum {
  78   GDK_DEBUG_MISC          = 1 << 0,
  79   GDK_DEBUG_EVENTS        = 1 << 1,
  80   GDK_DEBUG_DND           = 1 << 2,
  81   GDK_DEBUG_XIM           = 1 << 3,
  82   GDK_DEBUG_NOGRABS       = 1 << 4,
  83   GDK_DEBUG_COLORMAP      = 1 << 5,
  84   GDK_DEBUG_INPUT         = 1 << 6,
  85   GDK_DEBUG_CURSOR        = 1 << 7,
  86   GDK_DEBUG_MULTIHEAD     = 1 << 8,
  87   GDK_DEBUG_XINERAMA      = 1 << 9,
  88   GDK_DEBUG_DRAW          = 1 <<10,
  89   GDK_DEBUG_EVENTLOOP     = 1 <<11
  90 } GdkDebugFlag;
  91
  92 extern GList            *_gdk_default_filters;
  93 extern GdkWindow        *_gdk_parent_root;
  94
  95 extern guint _gdk_debug_flags;
  96 extern gboolean _gdk_native_windows;
  97
  98 #ifdef G_ENABLE_DEBUG
  99
 100 #define GDK_NOTE(type,action)                G_STMT_START { \
 101     if (_gdk_debug_flags & GDK_DEBUG_##type)                \
 102        { action; };                          } G_STMT_END
 103
 104 #else /* !G_ENABLE_DEBUG */
 105
 106 #define GDK_NOTE(type,action)
 107
 108 #endif /* G_ENABLE_DEBUG */
 109
 110 /* Arg parsing */
 111
 112 typedef enum
 113 {
 114   GDK_ARG_STRING,
 115   GDK_ARG_INT,
 116   GDK_ARG_BOOL,
 117   GDK_ARG_NOBOOL,
 118   GDK_ARG_CALLBACK
 119 } GdkArgType;
 120
 121 typedef struct _GdkArgContext GdkArgContext;
 122 typedef struct _GdkArgDesc GdkArgDesc;
 123
 124 typedef void (*GdkArgFunc) (const char *name, const char *arg, gpointer data);
 125
 126 struct _GdkArgContext
 127 {
 128   GPtrArray *tables;
 129   gpointer cb_data;
 130 };
 131
 132 struct _GdkArgDesc
 133 {
 134   const char *name;
 135   GdkArgType type;
 136   gpointer location;
 137   GdkArgFunc callback;
 138 };
 139
 140 /* Event handling */
 141
 142 typedef struct _GdkEventPrivate GdkEventPrivate;
 143
 144 typedef enum
 145 {
 146   /* Following flag is set for events on the event queue during
 147    * translation and cleared afterwards.
 148    */
 149   GDK_EVENT_PENDING = 1 << 0
 150 } GdkEventFlags;
 151
 152 struct _GdkEventPrivate
 153 {
 154   GdkEvent   event;
 155   guint      flags;
 156   GdkScreen *screen;
 157   gpointer   windowing_data;
 158   GdkDevice *device;
 159   GdkDevice *source_device;
 160 };
 161
 162 /* Tracks information about the pointer grab on this display */
 163 typedef struct
 164 {
 165   GdkWindow *window;
 166   GdkWindow *native_window;
 167   gulong serial_start;
 168   gulong serial_end; /* exclusive, i.e. not active on serial_end */
 169   gboolean owner_events;
 170   guint event_mask;
 171   gboolean implicit;
 172   guint32 time;
 173   GdkGrabOwnership ownership;
 174
 175   guint activated : 1;
 176   guint implicit_ungrab : 1;
 177 } GdkDeviceGrabInfo;
 178
 179 typedef struct _GdkWindowPaint GdkWindowPaint;
 180
 181 typedef void (* GdkDisplayPointerInfoForeach) (GdkDisplay           *display,
 182                                                GdkDevice            *device,
 183                                                GdkPointerWindowInfo *device_info,
 184                                                gpointer              user_data);
 185
 186 struct _GdkWindow
 187 {
 188   GObject parent_instance;
 189
 190   GdkWindowImpl *impl; /* window-system-specific delegate object */
 191
 192   GdkWindow *parent;
 193   GdkVisual *visual;
 194
 195   gpointer user_data;
 196
 197   gint x;
 198   gint y;
 199
 200   gint extension_events;
 201
 202   GList *filters;
 203   GList *children;
 204
 205   cairo_pattern_t *background;
 206
 207   GSList *paint_stack;
 208
 209   cairo_region_t *update_area;
 210   guint update_freeze_count;
 211
 212   guint8 window_type;
 213   guint8 depth;
 214   guint8 resize_count;
 215
 216   GdkWindowState state;
 217
 218   guint guffaw_gravity : 1;
 219   guint input_only : 1;
 220   guint modal_hint : 1;
 221   guint composited : 1;
 222
 223   guint destroyed : 2;
 224
 225   guint accept_focus : 1;
 226   guint focus_on_map : 1;
 227   guint shaped : 1;
 228   guint support_multidevice : 1;
 229
 230   GdkEventMask event_mask;
 231
 232   guint update_and_descendants_freeze_count;
 233
 234   /* The GdkWindow that has the impl, ref:ed if another window.
 235    * This ref is required to keep the wrapper of the impl window alive
 236    * for as long as any GdkWindow references the impl. */
 237   GdkWindow *impl_window;
 238   int abs_x, abs_y; /* Absolute offset in impl */
 239   gint width, height;
 240   guint32 clip_tag;
 241   cairo_region_t *clip_region; /* Clip region (wrt toplevel) in window coords */
 242   cairo_region_t *clip_region_with_children; /* Clip region in window coords */
 243   GdkCursor *cursor;
 244   GHashTable *device_cursor;
 245   gint8 toplevel_window_type;
 246   guint synthesize_crossing_event_queued : 1;
 247   guint effective_visibility : 2;
 248   guint visibility : 2; /* The visibility wrt the toplevel (i.e. based on clip_region) */
 249   guint native_visibility : 2; /* the native visibility of a impl windows */
 250   guint viewable : 1; /* mapped and all parents mapped */
 251   guint applied_shape : 1;
 252
 253   guint num_offscreen_children;
 254   GdkWindowPaint *implicit_paint;
 255
 256   GList *outstanding_moves;
 257
 258   cairo_region_t *shape;
 259   cairo_region_t *input_shape;
 260
 261   cairo_surface_t *cairo_surface;
 262
 263   GList *devices_inside;
 264   GHashTable *device_events;
 265
 266   GHashTable *source_event_masks;
 267   gulong device_added_handler_id;
 268   gulong device_changed_handler_id;
 269 };
 270
 271 #define GDK_WINDOW_TYPE(d) (((GDK_WINDOW (d)))->window_type)
 272 #define GDK_WINDOW_DESTROYED(d) (GDK_WINDOW (d)->destroyed)
 273
 274 struct _GdkDisplayClass
 275 {
 276   GObjectClass parent_class;
 277
 278   G_CONST_RETURN gchar *     (*get_name)           (GdkDisplay *display);
 279   gint                       (*get_n_screens)      (GdkDisplay *display);
 280   GdkScreen *                (*get_screen)         (GdkDisplay *display,
 281                                                     gint        screen_num);
 282   GdkScreen *                (*get_default_screen) (GdkDisplay *display);
 283   void                       (*beep)               (GdkDisplay *display);
 284   void                       (*sync)               (GdkDisplay *display);
 285   void                       (*flush)              (GdkDisplay *display);
 286   GdkWindow *                (*get_default_group)  (GdkDisplay *display);
 287   gboolean                   (*supports_selection_notification) (GdkDisplay *display);
 288   gboolean                   (*request_selection_notification)  (GdkDisplay *display,
 289                                                                  GdkAtom     selection);
 290   gboolean                   (*supports_clipboard_persistence)  (GdkDisplay *display);
 291   void                       (*store_clipboard)    (GdkDisplay    *display,
 292                                                     GdkWindow     *clipboard_window,
 293                                                     guint32        time_,
 294                                                     const GdkAtom *targets,
 295                                                     gint           n_targets);
 296   gboolean                   (*supports_shapes)    (GdkDisplay *display);
 297   gboolean                   (*supports_input_shapes) (GdkDisplay *display);
 298   gboolean                   (*supports_composite) (GdkDisplay *display);
 299   GList *                    (*list_devices)       (GdkDisplay *display);
 300   gboolean                   (*send_client_message) (GdkDisplay     *display,
 301                                                      GdkEvent       *event,
 302                                                      GdkNativeWindow winid);
 303   void                       (*add_client_message_filter) (GdkDisplay   *display,
 304                                                            GdkAtom       message_type,
 305                                                            GdkFilterFunc func,
 306                                                            gpointer      data);
 307
 308
 309   /* Signals */
 310   void (*closed) (GdkDisplay *display,
 311                   gboolean    is_error);
 312 };
 313
 314 struct _GdkKeymapClass
 315 {
 316   GObjectClass parent_class;
 317
 318   void (*direction_changed) (GdkKeymap *keymap);
 319   void (*keys_changed)      (GdkKeymap *keymap);
 320   void (*state_changed)     (GdkKeymap *keymap);
 321 };
 322
 323 extern GSList    *_gdk_displays;
 324 extern gchar     *_gdk_display_name;
 325 extern gint       _gdk_screen_number;
 326 extern gchar     *_gdk_display_arg_name;
 327 extern gboolean   _gdk_disable_multidevice;
 328
 329 void      _gdk_events_queue  (GdkDisplay *display);
 330 GdkEvent* _gdk_event_unqueue (GdkDisplay *display);
 331
 332 void _gdk_event_filter_unref        (GdkWindow      *window,
 333                                      GdkEventFilter *filter);
 334
 335 void   _gdk_event_emit               (GdkEvent   *event);
 336 GList* _gdk_event_queue_find_first   (GdkDisplay *display);
 337 void   _gdk_event_queue_remove_link  (GdkDisplay *display,
 338                                       GList      *node);
 339 GList* _gdk_event_queue_prepend      (GdkDisplay *display,
 340                                       GdkEvent   *event);
 341 GList* _gdk_event_queue_append       (GdkDisplay *display,
 342                                       GdkEvent   *event);
 343 GList* _gdk_event_queue_insert_after (GdkDisplay *display,
 344                                       GdkEvent   *after_event,
 345                                       GdkEvent   *event);
 346 GList* _gdk_event_queue_insert_before(GdkDisplay *display,
 347                                       GdkEvent   *after_event,
 348                                       GdkEvent   *event);
 349 void   _gdk_event_button_generate    (GdkDisplay *display,
 350                                       GdkEvent   *event);
 351
 352 void _gdk_windowing_event_data_copy (const GdkEvent *src,
 353                                      GdkEvent       *dst);
 354 void _gdk_windowing_event_data_free (GdkEvent       *event);
 355
 356 void gdk_synthesize_window_state (GdkWindow     *window,
 357                                   GdkWindowState unset_flags,
 358                                   GdkWindowState set_flags);
 359
 360 GdkDeviceManager * _gdk_device_manager_new (GdkDisplay *display);
 361
 362 gboolean _gdk_cairo_surface_extents (cairo_surface_t *surface,
 363                                      GdkRectangle *extents);
 364
 365 /*************************************
 366  * Interfaces used by windowing code *
 367  *************************************/
 368
 369 cairo_surface_t *
 370            _gdk_window_ref_cairo_surface (GdkWindow *window);
 371
 372 void       _gdk_window_impl_new          (GdkWindow      *window,
 373                                           GdkWindow      *real_parent,
 374                                           GdkScreen      *screen,
 375                                           GdkEventMask    event_mask,
 376                                           GdkWindowAttr  *attributes,
 377                                           gint            attributes_mask);
 378 void       _gdk_window_destroy           (GdkWindow      *window,
 379                                           gboolean        foreign_destroy);
 380 void       _gdk_window_clear_update_area (GdkWindow      *window);
 381 void       _gdk_window_update_size       (GdkWindow      *window);
 382 gboolean   _gdk_window_update_viewable   (GdkWindow      *window);
 383
 384 void       _gdk_window_process_updates_recurse (GdkWindow *window,
 385                                                 cairo_region_t *expose_region);
 386
 387 void       _gdk_screen_close             (GdkScreen      *screen);
 388
 389 const char *_gdk_get_sm_client_id (void);
 390
 391 /*****************************************
 392  * Interfaces provided by windowing code *
 393  *****************************************/
 394
 395 /* Font/string functions implemented in module-specific code */
 396
 397 void _gdk_cursor_destroy (GdkCursor *cursor);
 398
 399 void     _gdk_windowing_init                    (void);
 400
 401 extern const GOptionEntry _gdk_windowing_args[];
 402 void     _gdk_windowing_set_default_display     (GdkDisplay *display);
 403
 404 gchar *_gdk_windowing_substitute_screen_number (const gchar *display_name,
 405                                                 gint         screen_number);
 406
 407 gulong   _gdk_windowing_window_get_next_serial  (GdkDisplay *display);
 408 void     _gdk_windowing_window_get_offsets      (GdkWindow  *window,
 409                                                  gint       *x_offset,
 410                                                  gint       *y_offset);
 411
 412
 413 void       _gdk_windowing_get_device_state   (GdkDisplay       *display,
 414                                               GdkDevice        *device,
 415                                               GdkScreen       **screen,
 416                                               gint             *x,
 417                                               gint             *y,
 418                                               GdkModifierType  *mask);
 419 GdkWindow* _gdk_windowing_window_at_device_position  (GdkDisplay       *display,
 420                                                       GdkDevice        *device,
 421                                                       gint             *win_x,
 422                                                       gint             *win_y,
 423                                                       GdkModifierType  *mask,
 424                                                       gboolean          get_toplevel);
 425 GdkGrabStatus _gdk_windowing_device_grab     (GdkDevice        *device,
 426                                               GdkWindow        *window,
 427                                               GdkWindow        *native,
 428                                               gboolean          owner_events,
 429                                               GdkEventMask      event_mask,
 430                                               GdkWindow        *confine_to,
 431                                               GdkCursor        *cursor,
 432                                               guint32           time);
 433 void _gdk_windowing_got_event                (GdkDisplay       *display,
 434                                               GList            *event_link,
 435                                               GdkEvent         *event,
 436                                               gulong            serial);
 437
 438 void _gdk_windowing_window_process_updates_recurse (GdkWindow *window,
 439                                                     cairo_region_t *expose_region);
 440 void _gdk_windowing_before_process_all_updates     (void);
 441 void _gdk_windowing_after_process_all_updates      (void);
 442
 443
 444 #define GDK_WINDOW_IS_MAPPED(window) (((window)->state & GDK_WINDOW_STATE_WITHDRAWN) == 0)
 445
 446
 447 /* Called when gdk_window_destroy() is called on a foreign window
 448  * or an ancestor of the foreign window. It should generally reparent
 449  * the window out of it's current heirarchy, hide it, and then
 450  * send a message to the owner requesting that the window be destroyed.
 451  */
 452 void _gdk_windowing_window_destroy_foreign (GdkWindow *window);
 453
 454 void _gdk_windowing_display_set_sm_client_id (GdkDisplay  *display,
 455                                               const gchar *sm_client_id);
 456
 457 void _gdk_windowing_window_set_composited (GdkWindow *window,
 458                                            gboolean composited);
 459
 460 #define GDK_TYPE_PAINTABLE            (_gdk_paintable_get_type ())
 461 #define GDK_PAINTABLE(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GDK_TYPE_PAINTABLE, GdkPaintable))
 462 #define GDK_IS_PAINTABLE(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GDK_TYPE_PAINTABLE))
 463 #define GDK_PAINTABLE_GET_IFACE(obj)  (G_TYPE_INSTANCE_GET_INTERFACE ((obj), GDK_TYPE_PAINTABLE, GdkPaintableIface))
 464
 465 typedef struct _GdkPaintable        GdkPaintable;
 466 typedef struct _GdkPaintableIface   GdkPaintableIface;
 467
 468 struct _GdkPaintableIface
 469 {
 470   GTypeInterface g_iface;
 471
 472   void (* begin_paint_region)       (GdkPaintable    *paintable,
 473                                      GdkWindow       *window,
 474                                      const cairo_region_t *region);
 475   void (* end_paint)                (GdkPaintable    *paintable);
 476 };
 477
 478 GType _gdk_paintable_get_type (void) G_GNUC_CONST;
 479
 480 struct GdkAppLaunchContextPrivate
 481 {
 482   GdkDisplay *display;
 483   GdkScreen *screen;
 484   gint workspace;
 485   guint32 timestamp;
 486   GIcon *icon;
 487   char *icon_name;
 488 };
 489
 490 char *_gdk_windowing_get_startup_notify_id (GAppLaunchContext *context,
 491                                             GAppInfo          *info,
 492                                             GList             *files);
 493 void  _gdk_windowing_launch_failed         (GAppLaunchContext *context,
 494                                             const char        *startup_notify_id);
 495
 496 void _gdk_display_device_grab_update                     (GdkDisplay *display,
 497                                                           GdkDevice  *device,
 498                                                           GdkDevice  *source_device,
 499                                                           gulong      current_serial);
 500 GdkDeviceGrabInfo  *_gdk_display_get_last_device_grab  (GdkDisplay *display,
 501                                                         GdkDevice  *device);
 502 GdkDeviceGrabInfo  *_gdk_display_add_device_grab   (GdkDisplay       *display,
 503                                                     GdkDevice        *device,
 504                                                     GdkWindow        *window,
 505                                                     GdkWindow        *native_window,
 506                                                     GdkGrabOwnership  grab_ownership,
 507                                                     gboolean          owner_events,
 508                                                     GdkEventMask      event_mask,
 509                                                     unsigned long     serial_start,
 510                                                     guint32           time,
 511                                                     gboolean          implicit);
 512 GdkDeviceGrabInfo  * _gdk_display_has_device_grab  (GdkDisplay *display,
 513                                                     GdkDevice  *device,
 514                                                     gulong      serial);
 515 gboolean _gdk_display_end_device_grab  (GdkDisplay *display,
 516                                         GdkDevice  *device,
 517                                         gulong      serial,
 518                                         GdkWindow  *if_child,
 519                                         gboolean    implicit);
 520 gboolean _gdk_display_check_grab_ownership (GdkDisplay *display,
 521                                             GdkDevice  *device,
 522                                             gulong      serial);
 523 void _gdk_display_enable_motion_hints     (GdkDisplay *display,
 524                                            GdkDevice  *device);
 525
 526 GdkPointerWindowInfo * _gdk_display_get_pointer_info (GdkDisplay *display,
 527                                                       GdkDevice  *device);
 528
 529 void _gdk_display_pointer_info_foreach (GdkDisplay                   *display,
 530                                         GdkDisplayPointerInfoForeach  func,
 531                                         gpointer                      user_data);
 532
 533 void _gdk_window_invalidate_for_expose (GdkWindow       *window,
 534                                         cairo_region_t       *region);
 535
 536 GdkWindow * _gdk_window_find_child_at (GdkWindow *window,
 537                                        int x, int y);
 538 GdkWindow * _gdk_window_find_descendant_at (GdkWindow *toplevel,
 539                                             double x, double y,
 540                                             double *found_x,
 541                                             double *found_y);
 542
 543 void _gdk_window_add_damage (GdkWindow *toplevel,
 544                              cairo_region_t *damaged_region);
 545
 546 GdkEvent * _gdk_make_event (GdkWindow    *window,
 547                             GdkEventType  type,
 548                             GdkEvent     *event_in_queue,
 549                             gboolean      before_event);
 550 gboolean _gdk_window_event_parent_of (GdkWindow *parent,
 551                                       GdkWindow *child);
 552
 553 void _gdk_synthesize_crossing_events (GdkDisplay                 *display,
 554                                       GdkWindow                  *src,
 555                                       GdkWindow                  *dest,
 556                                       GdkDevice                  *device,
 557                                       GdkDevice                  *source_device,
 558                                       GdkCrossingMode             mode,
 559                                       gint                        toplevel_x,
 560                                       gint                        toplevel_y,
 561                                       GdkModifierType             mask,
 562                                       guint32                     time_,
 563                                       GdkEvent                   *event_in_queue,
 564                                       gulong                      serial,
 565                                       gboolean                    non_linear);
 566 void _gdk_display_set_window_under_pointer (GdkDisplay *display,
 567                                             GdkDevice  *device,
 568                                             GdkWindow  *window);
 569
 570
 571 void _gdk_synthesize_crossing_events_for_geometry_change (GdkWindow *changed_window);
 572
 573 cairo_region_t *_gdk_window_calculate_full_clip_region    (GdkWindow     *window,
 574                                                       GdkWindow     *base_window,
 575                                                       gboolean       do_children,
 576                                                       gint          *base_x_offset,
 577                                                       gint          *base_y_offset);
 578 gboolean    _gdk_window_has_impl (GdkWindow *window);
 579 GdkWindow * _gdk_window_get_impl_window (GdkWindow *window);
 580
 581 /*****************************
 582  * offscreen window routines *
 583  *****************************/
 584 GType gdk_offscreen_window_get_type (void);
 585 void       _gdk_offscreen_window_new                 (GdkWindow     *window,
 586                                                       GdkWindowAttr *attributes,
 587                                                       gint           attributes_mask);
 588 cairo_surface_t * _gdk_offscreen_window_create_surface (GdkWindow *window,
 589                                                         gint       width,
 590                                                         gint       height);
 591
 592
 593 /************************************
 594  * Initialization and exit routines *
 595  ************************************/
 596
 597 void _gdk_windowing_exit (void);
 598
 599 G_END_DECLS
 600
 601 #endif /* __GDK_INTERNALS_H__ */