gdkdisplay.c 65.1 KB
Newer Older
Cody Russell's avatar
Cody Russell committed
1
/* GDK - The GIMP Drawing Kit
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
 * gdkdisplay.c
 * 
 * Copyright 2001 Sun Microsystems Inc. 
 *
 * Erwann Chenede <erwann.chenede@sun.com>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */

24
#include "config.h"
25

26
#include "gdkdisplay.h"
27 28

#include "gdkevents.h"
29
#include "gdkwindowimpl.h"
30
#include "gdkinternals.h"
31
#include "gdkmarshalers.h"
32
#include "gdkscreen.h"
33

34 35
#include <glib.h>
#include <math.h>
36

37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62

/**
 * SECTION:gdkdisplay
 * @Short_description: Controls the keyboard/mouse pointer grabs and a set of <type>GdkScreen</type>s
 * @Title: GdkDisplay
 *
 * #GdkDisplay objects purpose are two fold:
 * <itemizedlist>
 * <listitem><para>
 *   To grab/ungrab keyboard focus and mouse pointer
 * </para></listitem>
 * <listitem><para>
 *   To manage and provide information about the #GdkScreen(s)
 *   available for this #GdkDisplay
 * </para></listitem>
 * </itemizedlist>
 *
 * #GdkDisplay objects are the GDK representation of the X Display which can be
 * described as <emphasis>a workstation consisting of a keyboard a pointing
 * device (such as a mouse) and one or more screens</emphasis>.
 * It is used to open and keep track of various #GdkScreen objects currently
 * instanciated by the application. It is also used to grab and release the keyboard
 * and the mouse pointer.
 */


63
enum {
64
  OPENED,
65 66 67 68
  CLOSED,
  LAST_SIGNAL
};

69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101
static void gdk_display_dispose     (GObject         *object);
static void gdk_display_finalize    (GObject         *object);

static void        multihead_get_device_state           (GdkDisplay       *display,
                                                         GdkDevice        *device,
                                                         GdkScreen       **screen,
                                                         gint             *x,
                                                         gint             *y,
                                                         GdkModifierType  *mask);
static GdkWindow * multihead_window_get_device_position (GdkDisplay       *display,
                                                         GdkDevice        *device,
                                                         GdkWindow        *window,
                                                         gint             *x,
                                                         gint             *y,
                                                         GdkModifierType  *mask);
static GdkWindow * multihead_window_at_device_position  (GdkDisplay       *display,
                                                         GdkDevice        *device,
                                                         gint             *win_x,
                                                         gint             *win_y);

static void        multihead_default_get_pointer        (GdkDisplay       *display,
                                                         GdkScreen       **screen,
                                                         gint             *x,
                                                         gint             *y,
                                                         GdkModifierType  *mask);
static GdkWindow * multihead_default_window_get_pointer (GdkDisplay      *display,
                                                         GdkWindow       *window,
                                                         gint            *x,
                                                         gint            *y,
                                                         GdkModifierType *mask);
static GdkWindow * multihead_default_window_at_pointer  (GdkDisplay      *display,
                                                         gint            *win_x,
                                                         gint            *win_y);
102

103

Matthias Clasen's avatar
Matthias Clasen committed
104
static void       singlehead_get_pointer (GdkDisplay       *display,
105 106 107 108
					  GdkScreen       **screen,
					  gint             *x,
					  gint             *y,
					  GdkModifierType  *mask);
Matthias Clasen's avatar
Matthias Clasen committed
109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124
static GdkWindow* singlehead_window_get_pointer (GdkDisplay       *display,
						 GdkWindow        *window,
						 gint             *x,
						 gint             *y,
						 GdkModifierType  *mask);
static GdkWindow* singlehead_window_at_pointer  (GdkDisplay       *display,
						 gint             *win_x,
						 gint             *win_y);

static GdkWindow* singlehead_default_window_get_pointer (GdkWindow       *window,
							 gint            *x,
							 gint            *y,
							 GdkModifierType *mask);
static GdkWindow* singlehead_default_window_at_pointer  (GdkScreen       *screen,
							 gint            *win_x,
							 gint            *win_y);
125 126 127 128 129 130 131 132 133 134
static GdkWindow *gdk_window_real_window_get_device_position     (GdkDisplay       *display,
                                                                  GdkDevice        *device,
                                                                  GdkWindow        *window,
                                                                  gint             *x,
                                                                  gint             *y,
                                                                  GdkModifierType  *mask);
static GdkWindow *gdk_display_real_get_window_at_device_position (GdkDisplay       *display,
                                                                  GdkDevice        *device,
                                                                  gint             *win_x,
                                                                  gint             *win_y);
135

136 137
static guint signals[LAST_SIGNAL] = { 0 };

138
static char *gdk_sm_client_id;
139

140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155
static const GdkDisplayDeviceHooks default_device_hooks = {
  _gdk_windowing_get_device_state,
  gdk_window_real_window_get_device_position,
  gdk_display_real_get_window_at_device_position
};

static const GdkDisplayDeviceHooks multihead_pointer_hooks = {
  multihead_get_device_state,
  multihead_window_get_device_position,
  multihead_window_at_device_position
};

static const GdkDisplayPointerHooks multihead_default_pointer_hooks = {
  multihead_default_get_pointer,
  multihead_default_window_get_pointer,
  multihead_default_window_at_pointer
156 157 158 159 160 161 162 163 164 165 166 167 168 169
};

static const GdkDisplayPointerHooks singlehead_pointer_hooks = {
  singlehead_get_pointer,
  singlehead_window_get_pointer,
  singlehead_window_at_pointer
};

static const GdkPointerHooks singlehead_default_pointer_hooks = {
  singlehead_default_window_get_pointer,
  singlehead_default_window_at_pointer
};

static const GdkPointerHooks *singlehead_current_pointer_hooks = &singlehead_default_pointer_hooks;
170
static const GdkDisplayPointerHooks *multihead_current_pointer_hooks = &multihead_default_pointer_hooks;
171

Matthias Clasen's avatar
Matthias Clasen committed
172
G_DEFINE_TYPE (GdkDisplay, gdk_display, G_TYPE_OBJECT)
173 174 175 176 177

static void
gdk_display_class_init (GdkDisplayClass *class)
{
  GObjectClass *object_class = G_OBJECT_CLASS (class);
178

179
  object_class->finalize = gdk_display_finalize;
180
  object_class->dispose = gdk_display_dispose;
181

182
  /**
Matthias Clasen's avatar
Matthias Clasen committed
183
   * GdkDisplay::opened:
184 185
   * @display: the object on which the signal is emitted
   *
Matthias Clasen's avatar
Matthias Clasen committed
186 187
   * The ::opened signal is emitted when the connection to the windowing
   * system for @display is opened.
188 189 190 191 192 193 194 195 196
   */
  signals[OPENED] =
    g_signal_new (g_intern_static_string ("opened"),
		  G_OBJECT_CLASS_TYPE (object_class),
                  G_SIGNAL_RUN_LAST,
                  0, NULL, NULL,
                  g_cclosure_marshal_VOID__VOID,
                  G_TYPE_NONE, 0);

197 198 199 200 201 202 203 204 205 206
  /**
   * GdkDisplay::closed:
   * @display: the object on which the signal is emitted
   * @is_error: %TRUE if the display was closed due to an error
   *
   * The ::closed signal is emitted when the connection to the windowing
   * system for @display is closed.
   *
   * Since: 2.2
   */   
207
  signals[CLOSED] =
Matthias Clasen's avatar
Matthias Clasen committed
208
    g_signal_new (g_intern_static_string ("closed"),
209 210 211 212
		  G_OBJECT_CLASS_TYPE (object_class),
		  G_SIGNAL_RUN_LAST,
		  G_STRUCT_OFFSET (GdkDisplayClass, closed),
		  NULL, NULL,
Matthias Clasen's avatar
Matthias Clasen committed
213
		  _gdk_marshal_VOID__BOOLEAN,
214 215 216
		  G_TYPE_NONE,
		  1,
		  G_TYPE_BOOLEAN);
217 218
}

219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269
static void
free_pointer_info (GdkPointerWindowInfo *info)
{
  g_object_unref (info->toplevel_under_pointer);
  g_slice_free (GdkPointerWindowInfo, info);
}

static void
free_device_grab (GdkDeviceGrabInfo *info)
{
  g_object_unref (info->window);
  g_object_unref (info->native_window);
  g_free (info);
}

static gboolean
free_device_grabs_foreach (gpointer key,
                           gpointer value,
                           gpointer user_data)
{
  GList *list = value;

  g_list_foreach (list, (GFunc) free_device_grab, NULL);
  g_list_free (list);

  return TRUE;
}

static void
device_removed_cb (GdkDeviceManager *device_manager,
                   GdkDevice        *device,
                   GdkDisplay       *display)
{
  g_hash_table_remove (display->multiple_click_info, device);
  g_hash_table_remove (display->device_grabs, device);
  g_hash_table_remove (display->pointers_info, device);

  /* FIXME: change core pointer and remove from device list */
}

static void
gdk_display_opened (GdkDisplay *display)
{
  GdkDeviceManager *device_manager;

  device_manager = gdk_display_get_device_manager (display);

  g_signal_connect (device_manager, "device-removed",
                    G_CALLBACK (device_removed_cb), display);
}

270 271 272 273 274 275
static void
gdk_display_init (GdkDisplay *display)
{
  _gdk_displays = g_slist_prepend (_gdk_displays, display);

  display->double_click_time = 250;
276
  display->double_click_distance = 5;
277

278 279 280 281 282 283 284 285 286 287 288 289 290 291
  display->device_hooks = &default_device_hooks;

  display->device_grabs = g_hash_table_new (NULL, NULL);
  display->motion_hint_info = g_hash_table_new_full (NULL, NULL, NULL,
                                                     (GDestroyNotify) g_free);

  display->pointers_info = g_hash_table_new_full (NULL, NULL, NULL,
                                                  (GDestroyNotify) free_pointer_info);

  display->multiple_click_info = g_hash_table_new_full (NULL, NULL, NULL,
                                                        (GDestroyNotify) g_free);

  g_signal_connect (display, "opened",
                    G_CALLBACK (gdk_display_opened), NULL);
292 293
}

294 295 296 297
static void
gdk_display_dispose (GObject *object)
{
  GdkDisplay *display = GDK_DISPLAY_OBJECT (object);
298 299 300
  GdkDeviceManager *device_manager;

  device_manager = gdk_display_get_device_manager (GDK_DISPLAY_OBJECT (object));
301 302 303 304 305 306 307 308

  g_list_foreach (display->queued_events, (GFunc)gdk_event_free, NULL);
  g_list_free (display->queued_events);
  display->queued_events = NULL;
  display->queued_tail = NULL;

  _gdk_displays = g_slist_remove (_gdk_displays, object);

309
  if (gdk_display_get_default () == display)
310 311 312 313 314 315 316 317
    {
      if (_gdk_displays)
        gdk_display_manager_set_default_display (gdk_display_manager_get(),
                                                 _gdk_displays->data);
      else
        gdk_display_manager_set_default_display (gdk_display_manager_get(),
                                                 NULL);
    }
318

319
  if (device_manager)
320 321 322 323 324 325 326
    {
      /* this is to make it drop devices which may require using the X
       * display and therefore can't be cleaned up in finalize.
       * It will also disconnect device_removed_cb
       */
      g_object_run_dispose (G_OBJECT (display->device_manager));
    }
327

Matthias Clasen's avatar
Matthias Clasen committed
328
  G_OBJECT_CLASS (gdk_display_parent_class)->dispose (object);
329 330
}

331 332 333
static void
gdk_display_finalize (GObject *object)
{
334 335 336 337 338 339 340 341 342 343 344 345 346
  GdkDisplay *display = GDK_DISPLAY_OBJECT (object);

  g_hash_table_foreach_remove (display->device_grabs,
                               free_device_grabs_foreach,
                               NULL);
  g_hash_table_destroy (display->device_grabs);

  g_hash_table_destroy (display->pointers_info);
  g_hash_table_destroy (display->multiple_click_info);

  if (display->device_manager)
    g_object_unref (display->device_manager);

Matthias Clasen's avatar
Matthias Clasen committed
347
  G_OBJECT_CLASS (gdk_display_parent_class)->finalize (object);
348 349 350 351 352 353
}

/**
 * gdk_display_close:
 * @display: a #GdkDisplay
 *
354
 * Closes the connection to the windowing system for the given display,
355
 * and cleans up associated resources.
Matthias Clasen's avatar
Matthias Clasen committed
356 357
 *
 * Since: 2.2
358 359 360 361 362
 */
void
gdk_display_close (GdkDisplay *display)
{
  g_return_if_fail (GDK_IS_DISPLAY (display));
363 364 365 366

  if (!display->closed)
    {
      display->closed = TRUE;
367 368
      
      g_signal_emit (display, signals[CLOSED], 0, FALSE);
369 370
      g_object_run_dispose (G_OBJECT (display));
      
371
      g_object_unref (display);
372
    }
373 374
}

John Stowers's avatar
John Stowers committed
375 376 377 378
/**
 * gdk_display_is_closed:
 * @display: a #GdkDisplay
 *
379 380 381
 * Finds out if the display has been closed.
 *
 * Returns: %TRUE if the display is closed.
John Stowers's avatar
John Stowers committed
382 383 384 385 386 387 388 389 390 391 392
 *
 * Since: 2.22
 */
gboolean
gdk_display_is_closed  (GdkDisplay  *display)
{
  g_return_val_if_fail (GDK_IS_DISPLAY (display), FALSE);

  return display->closed;
}

393 394 395 396 397 398 399 400 401
/**
 * gdk_display_get_event:
 * @display: a #GdkDisplay
 * 
 * Gets the next #GdkEvent to be processed for @display, fetching events from the
 * windowing system if necessary.
 * 
 * Return value: the next #GdkEvent to be processed, or %NULL if no events
 * are pending. The returned #GdkEvent should be freed with gdk_event_free().
Matthias Clasen's avatar
Matthias Clasen committed
402 403
 *
 * Since: 2.2
404 405 406 407 408 409 410 411 412 413 414 415
 **/
GdkEvent*
gdk_display_get_event (GdkDisplay *display)
{
  g_return_val_if_fail (GDK_IS_DISPLAY (display), NULL);
  
  _gdk_events_queue (display);
  return _gdk_event_unqueue (display);
}

/**
 * gdk_display_peek_event:
Alex Larsson's avatar
Alex Larsson committed
416
 * @display: a #GdkDisplay 
417 418 419 420 421 422
 * 
 * Gets a copy of the first #GdkEvent in the @display's event queue, without
 * removing the event from the queue.  (Note that this function will
 * not get more events from the windowing system.  It only checks the events
 * that have already been moved to the GDK event queue.)
 * 
Matthias Clasen's avatar
Matthias Clasen committed
423 424
 * Return value: a copy of the first #GdkEvent on the event queue, or %NULL 
 * if no events are in the queue. The returned #GdkEvent should be freed with
425
 * gdk_event_free().
Matthias Clasen's avatar
Matthias Clasen committed
426 427
 *
 * Since: 2.2
428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450
 **/
GdkEvent*
gdk_display_peek_event (GdkDisplay *display)
{
  GList *tmp_list;

  g_return_val_if_fail (GDK_IS_DISPLAY (display), NULL);

  tmp_list = _gdk_event_queue_find_first (display);
  
  if (tmp_list)
    return gdk_event_copy (tmp_list->data);
  else
    return NULL;
}

/**
 * gdk_display_put_event:
 * @display: a #GdkDisplay
 * @event: a #GdkEvent.
 *
 * Appends a copy of the given event onto the front of the event
 * queue for @display.
Matthias Clasen's avatar
Matthias Clasen committed
451 452
 *
 * Since: 2.2
453 454
 **/
void
455 456
gdk_display_put_event (GdkDisplay     *display,
		       const GdkEvent *event)
457 458 459 460 461
{
  g_return_if_fail (GDK_IS_DISPLAY (display));
  g_return_if_fail (event != NULL);

  _gdk_event_queue_append (display, gdk_event_copy (event));
462 463
  /* If the main loop is blocking in a different thread, wake it up */
  g_main_context_wakeup (NULL); 
464
}
465

466 467 468 469 470 471 472 473 474
/**
 * gdk_display_pointer_ungrab:
 * @display: a #GdkDisplay.
 * @time_: a timestap (e.g. %GDK_CURRENT_TIME).
 *
 * Release any pointer grab.
 *
 * Since: 2.2
 *
475
 * Deprecated: 3.0: Use gdk_device_ungrab(), together with gdk_device_grab()
476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496
 *             instead.
 */
void
gdk_display_pointer_ungrab (GdkDisplay *display,
			    guint32     time_)
{
  GdkDeviceManager *device_manager;
  GList *devices, *dev;
  GdkDevice *device;

  g_return_if_fail (GDK_IS_DISPLAY (display));

  device_manager = gdk_display_get_device_manager (display);
  devices = gdk_device_manager_list_devices (device_manager, GDK_DEVICE_TYPE_MASTER);

  /* FIXME: Should this be generic to all backends? */
  /* FIXME: What happens with extended devices? */
  for (dev = devices; dev; dev = dev->next)
    {
      device = dev->data;

497
      if (gdk_device_get_source (device) != GDK_SOURCE_MOUSE)
498 499 500 501 502 503 504 505
        continue;

      gdk_device_ungrab (device, time_);
    }

  g_list_free (devices);
}

506 507
/**
 * gdk_pointer_ungrab:
Matthias Clasen's avatar
Matthias Clasen committed
508 509
 * @time_: a timestamp from a #GdkEvent, or %GDK_CURRENT_TIME if no 
 *  timestamp is available.
510
 *
511 512
 * Ungrabs the pointer on the default display, if it is grabbed by this 
 * application.
513
 *
514
 * Deprecated: 3.0: Use gdk_device_ungrab(), together with gdk_device_grab()
515
 *             instead.
516 517 518 519
 **/
void
gdk_pointer_ungrab (guint32 time)
{
Owen Taylor's avatar
Owen Taylor committed
520
  gdk_display_pointer_ungrab (gdk_display_get_default (), time);
521 522 523 524 525
}

/**
 * gdk_pointer_is_grabbed:
 * 
526 527
 * Returns %TRUE if the pointer on the default display is currently 
 * grabbed by this application.
528 529 530
 *
 * Note that this does not take the inmplicit pointer grab on button
 * presses into account.
531 532 533
 *
 * Return value: %TRUE if the pointer is currently grabbed by this application.
 *
534
 * Deprecated: 3.0: Use gdk_display_device_is_grabbed() instead.
535 536 537 538
 **/
gboolean
gdk_pointer_is_grabbed (void)
{
Owen Taylor's avatar
Owen Taylor committed
539
  return gdk_display_pointer_is_grabbed (gdk_display_get_default ());
540 541
}

542 543 544 545 546 547 548 549 550
/**
 * gdk_display_keyboard_ungrab:
 * @display: a #GdkDisplay.
 * @time_: a timestap (e.g #GDK_CURRENT_TIME).
 *
 * Release any keyboard grab
 *
 * Since: 2.2
 *
551
 * Deprecated: 3.0: Use gdk_device_ungrab(), together with gdk_device_grab()
552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572
 *             instead.
 */
void
gdk_display_keyboard_ungrab (GdkDisplay *display,
			     guint32     time)
{
  GdkDeviceManager *device_manager;
  GList *devices, *dev;
  GdkDevice *device;

  g_return_if_fail (GDK_IS_DISPLAY (display));

  device_manager = gdk_display_get_device_manager (display);
  devices = gdk_device_manager_list_devices (device_manager, GDK_DEVICE_TYPE_MASTER);

  /* FIXME: Should this be generic to all backends? */
  /* FIXME: What happens with extended devices? */
  for (dev = devices; dev; dev = dev->next)
    {
      device = dev->data;

573
      if (gdk_device_get_source (device) != GDK_SOURCE_KEYBOARD)
574 575 576 577 578 579 580 581
        continue;

      gdk_device_ungrab (device, time);
    }

  g_list_free (devices);
}

582 583
/**
 * gdk_keyboard_ungrab:
584
 * @time_: a timestamp from a #GdkEvent, or %GDK_CURRENT_TIME if no
585 586
 *        timestamp is available.
 * 
587 588
 * Ungrabs the keyboard on the default display, if it is grabbed by this 
 * application.
589
 *
590
 * Deprecated: 3.0: Use gdk_device_ungrab(), together with gdk_device_grab()
591
 *             instead.
592 593 594 595
 **/
void
gdk_keyboard_ungrab (guint32 time)
{
Owen Taylor's avatar
Owen Taylor committed
596
  gdk_display_keyboard_ungrab (gdk_display_get_default (), time);
597 598 599 600 601
}

/**
 * gdk_beep:
 * 
602
 * Emits a short beep on the default display.
603 604 605 606
 **/
void
gdk_beep (void)
{
Owen Taylor's avatar
Owen Taylor committed
607
  gdk_display_beep (gdk_display_get_default ());
608 609 610 611 612
}

/**
 * gdk_event_send_client_message:
 * @event: the #GdkEvent to send, which should be a #GdkEventClient.
Owen Taylor's avatar
Owen Taylor committed
613
 * @winid:  the window to send the X ClientMessage event to.
614 615 616 617 618 619 620 621 622
 * 
 * Sends an X ClientMessage event to a given window (which must be
 * on the default #GdkDisplay.)
 * This could be used for communicating between different applications,
 * though the amount of data is limited to 20 bytes.
 * 
 * Return value: non-zero on success.
 **/
gboolean
Owen Taylor's avatar
Owen Taylor committed
623 624
gdk_event_send_client_message (GdkEvent        *event,
			       GdkNativeWindow  winid)
625 626 627
{
  g_return_val_if_fail (event != NULL, FALSE);

Owen Taylor's avatar
Owen Taylor committed
628
  return gdk_event_send_client_message_for_display (gdk_display_get_default (),
Owen Taylor's avatar
Owen Taylor committed
629
						    event, winid);
630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648
}

/**
 * gdk_event_send_clientmessage_toall:
 * @event: the #GdkEvent to send, which should be a #GdkEventClient.
 *
 * Sends an X ClientMessage event to all toplevel windows on the default
 * #GdkScreen.
 *
 * Toplevel windows are determined by checking for the WM_STATE property, as
 * described in the Inter-Client Communication Conventions Manual (ICCCM).
 * If no windows are found with the WM_STATE property set, the message is sent
 * to all children of the root window.
 **/
void
gdk_event_send_clientmessage_toall (GdkEvent *event)
{
  g_return_if_fail (event != NULL);

Owen Taylor's avatar
Owen Taylor committed
649
  gdk_screen_broadcast_client_message (gdk_screen_get_default (), event);
650 651
}

652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668
/**
 * gdk_set_sm_client_id:
 * @sm_client_id: the client id assigned by the session manager when the
 *    connection was opened, or %NULL to remove the property.
 * 
 * Sets the <literal>SM_CLIENT_ID</literal> property on the application's leader window so that
 * the window manager can save the application's state using the X11R6 ICCCM
 * session management protocol.
 *
 * See the X Session Management Library documentation for more information on
 * session management and the Inter-Client Communication Conventions Manual
 * (ICCCM) for information on the <literal>WM_CLIENT_LEADER</literal> property. 
 * (Both documents are part of the X Window System distribution.)
 **/
void
gdk_set_sm_client_id (const gchar* sm_client_id)
{
669 670 671 672 673 674 675 676 677 678
  GSList *displays, *tmp_list;
  
  g_free (gdk_sm_client_id);
  gdk_sm_client_id = g_strdup (sm_client_id);

  displays = gdk_display_manager_list_displays (gdk_display_manager_get ());
  for (tmp_list = displays; tmp_list; tmp_list = tmp_list->next)
    _gdk_windowing_display_set_sm_client_id (tmp_list->data, sm_client_id);

  g_slist_free (displays);
679 680
}

681 682 683 684 685 686 687 688 689 690 691 692 693
/**
 * _gdk_get_sm_client_id:
 * 
 * Gets the client ID set with gdk_set_sm_client_id(), if any.
 * 
 * Return value: Session ID, or %NULL if gdk_set_sm_client_id()
 *               has never been called.
 **/
const char *
_gdk_get_sm_client_id (void)
{
  return gdk_sm_client_id;
}
694

695
void
696 697
_gdk_display_enable_motion_hints (GdkDisplay *display,
                                  GdkDevice  *device)
698
{
699 700 701 702 703 704 705 706 707 708 709 710
  gulong *device_serial, serial;

  device_serial = g_hash_table_lookup (display->motion_hint_info, device);

  if (!device_serial)
    {
      device_serial = g_new0 (gulong, 1);
      *device_serial = G_MAXULONG;
      g_hash_table_insert (display->motion_hint_info, device, device_serial);
    }

  if (*device_serial != 0)
711
    {
712 713 714
      serial = _gdk_windowing_window_get_next_serial (display);
      /* We might not actually generate the next request, so
	 make sure this triggers always, this may cause it to
Matthias Clasen's avatar
Matthias Clasen committed
715
	 trigger slightly too early, but this is just a hint
716 717 718
	 anyway. */
      if (serial > 0)
	serial--;
719 720
      if (serial < *device_serial)
	*device_serial = serial;
721 722 723
    }
}

724 725 726
/**
 * gdk_display_get_device_state:
 * @display: a #GdkDisplay.
727
 * @device: pointer device to query status about.
728 729 730 731 732
 * @screen: (out) (transfer none) (allow-none): location to store the #GdkScreen
 *          the @device is on, or %NULL.
 * @x: (out) (allow-none): location to store root window X coordinate of @device, or %NULL.
 * @y: (out) (allow-none): location to store root window Y coordinate of @device, or %NULL.
 * @mask: (out) (allow-none): location to store current modifier mask for @device, or %NULL.
733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751
 *
 * Gets the current location and state of @device for a given display.
 *
 * Since: 3.0
 **/
void
gdk_display_get_device_state (GdkDisplay       *display,
                              GdkDevice        *device,
                              GdkScreen       **screen,
                              gint             *x,
                              gint             *y,
                              GdkModifierType  *mask)
{
  GdkScreen *tmp_screen;
  gint tmp_x, tmp_y;
  GdkModifierType tmp_mask;

  g_return_if_fail (GDK_IS_DISPLAY (display));
  g_return_if_fail (GDK_IS_DEVICE (device));
752
  g_return_if_fail (gdk_device_get_source (device) != GDK_SOURCE_KEYBOARD);
753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768

  display->device_hooks->get_device_state (display, device, &tmp_screen, &tmp_x, &tmp_y, &tmp_mask);

  if (screen)
    *screen = tmp_screen;
  if (x)
    *x = tmp_x;
  if (y)
    *y = tmp_y;
  if (mask)
    *mask = tmp_mask;
}

/**
 * gdk_display_get_window_at_device_position:
 * @display: a #GdkDisplay.
769
 * @device: pointer #GdkDevice to query info to.
770 771 772 773
 * @win_x: (out) (allow-none): return location for the X coordinate of the device location,
 *         relative to the window origin, or %NULL.
 * @win_y: (out) (allow-none): return location for the Y coordinate of the device location,
 *         relative to the window origin, or %NULL.
774 775 776 777
 *
 * Obtains the window underneath @device, returning the location of the device in @win_x and @win_y. Returns
 * %NULL if the window tree under @device is not known to GDK (for example, belongs to another application).
 *
778
 * Returns: (transfer none): the #GdkWindow under the device position, or %NULL.
779 780 781 782 783 784 785 786 787 788 789 790 791 792
 *
 * Since: 3.0
 **/
GdkWindow *
gdk_display_get_window_at_device_position (GdkDisplay *display,
                                           GdkDevice  *device,
                                           gint       *win_x,
                                           gint       *win_y)
{
  gint tmp_x, tmp_y;
  GdkWindow *window;

  g_return_val_if_fail (GDK_IS_DISPLAY (display), NULL);
  g_return_val_if_fail (GDK_IS_DEVICE (device), NULL);
793
  g_return_val_if_fail (gdk_device_get_source (device) != GDK_SOURCE_KEYBOARD, NULL);
794 795 796 797 798 799 800 801 802 803 804 805 806 807

  window = display->device_hooks->window_at_device_position (display, device, &tmp_x, &tmp_y);

  if (win_x)
    *win_x = tmp_x;
  if (win_y)
    *win_y = tmp_y;

  return window;
}

/**
 * gdk_display_set_device_hooks:
 * @display: a #GdkDisplay.
808 809
 * @new_hooks: (allow-none): a table of pointers to functions for getting quantities related
 *             to all devices position, or %NULL to restore the default table.
810 811 812 813 814
 *
 * This function allows for hooking into the operation of getting the current location of any
 * #GdkDevice on a particular #GdkDisplay. This is only useful for such low-level tools as
 * an event recorder. Applications should never have any reason to use this facility.
 *
815
 * Returns: (transfer none): The previous device hook table.
816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835
 *
 * Since: 3.0
 **/
GdkDisplayDeviceHooks *
gdk_display_set_device_hooks (GdkDisplay                  *display,
                              const GdkDisplayDeviceHooks *new_hooks)
{
  const GdkDisplayDeviceHooks *result;

  g_return_val_if_fail (GDK_IS_DISPLAY (display), NULL);
  result = display->device_hooks;

  if (new_hooks)
    display->device_hooks = new_hooks;
  else
    display->device_hooks = &default_device_hooks;

  return (GdkDisplayDeviceHooks *) result;
}

836 837 838
/**
 * gdk_display_get_pointer:
 * @display: a #GdkDisplay
839
 * @screen: (allow-none): location to store the screen that the
840
 *          cursor is on, or %NULL.
841 842 843
 * @x: (out) (allow-none): location to store root window X coordinate of pointer, or %NULL.
 * @y: (out) (allow-none): location to store root window Y coordinate of pointer, or %NULL.
 * @mask: (out) (allow-none): location to store current modifier mask, or %NULL
844
 *
845 846
 * Gets the current location of the pointer and the current modifier
 * mask for a given display.
Matthias Clasen's avatar
Matthias Clasen committed
847 848
 *
 * Since: 2.2
849
 *
850
 * Deprecated: 3.0: Use gdk_display_get_device_state() instead.
851 852 853 854 855 856 857 858 859 860
 **/
void
gdk_display_get_pointer (GdkDisplay      *display,
			 GdkScreen      **screen,
			 gint            *x,
			 gint            *y,
			 GdkModifierType *mask)
{
  g_return_if_fail (GDK_IS_DISPLAY (display));

861
  gdk_display_get_device_state (display, display->core_pointer, screen, x, y, mask);
862 863
}

864
static GdkWindow *
865 866 867 868
gdk_display_real_get_window_at_device_position (GdkDisplay *display,
                                                GdkDevice  *device,
                                                gint       *win_x,
                                                gint       *win_y)
869 870 871 872
{
  GdkWindow *window;
  gint x, y;

873
  window = _gdk_windowing_window_at_device_position (display, device, &x, &y, NULL, FALSE);
874 875 876 877 878 879

  /* This might need corrections, as the native window returned
     may contain client side children */
  if (window)
    {
      double xx, yy;
880

881
      window = _gdk_window_find_descendant_at (window,
882
					       x, y,
883 884 885 886
					       &xx, &yy);
      x = floor (xx + 0.5);
      y = floor (yy + 0.5);
    }
887

888 889
  *win_x = x;
  *win_y = y;
890

891 892 893 894
  return window;
}

static GdkWindow *
895 896 897 898 899 900
gdk_window_real_window_get_device_position (GdkDisplay       *display,
                                            GdkDevice        *device,
                                            GdkWindow        *window,
                                            gint             *x,
                                            gint             *y,
                                            GdkModifierType  *mask)
901 902
{
  gint tmpx, tmpy;
903
  GdkModifierType tmp_mask;
904
  gboolean normal_child;
905

906
  normal_child = GDK_WINDOW_IMPL_GET_CLASS (window->impl)->get_device_state (window,
907 908 909
                                                                              device,
                                                                              &tmpx, &tmpy,
                                                                              &tmp_mask);
Matthias Clasen's avatar
Matthias Clasen committed
910
  /* We got the coords on the impl, convert to the window */
911 912
  tmpx -= window->abs_x;
  tmpy -= window->abs_y;
913

914 915 916 917
  if (x)
    *x = tmpx;
  if (y)
    *y = tmpy;
918 919
  if (mask)
    *mask = tmp_mask;
920

921 922 923
  if (normal_child)
    return _gdk_window_find_child_at (window, tmpx, tmpy);
  return NULL;
924 925
}

926 927 928
/**
 * gdk_display_get_window_at_pointer:
 * @display: a #GdkDisplay
929
 * @win_x: (out) (allow-none): return location for x coordinate of the pointer location relative
930
 *    to the window origin, or %NULL
931
 * @win_y: (out) (allow-none): return location for y coordinate of the pointer location relative
932
 &    to the window origin, or %NULL
933
 *
934
 * Obtains the window underneath the mouse pointer, returning the location
935
 * of the pointer in that window in @win_x, @win_y for @screen. Returns %NULL
936 937
 * if the window under the mouse pointer is not known to GDK (for example, 
 * belongs to another application).
938 939
 *
 * Returns: (transfer none): the window under the mouse pointer, or %NULL
Matthias Clasen's avatar
Matthias Clasen committed
940 941
 *
 * Since: 2.2
942
 *
943
 * Deprecated: 3.0: Use gdk_display_get_window_at_device_position() instead.
944 945 946 947 948 949 950
 **/
GdkWindow *
gdk_display_get_window_at_pointer (GdkDisplay *display,
				   gint       *win_x,
				   gint       *win_y)
{
  g_return_val_if_fail (GDK_IS_DISPLAY (display), NULL);
Kristian Rietveld's avatar
Kristian Rietveld committed
951

952 953
  return gdk_display_get_window_at_device_position (display, display->core_pointer, win_x, win_y);
}
954

955 956 957 958 959 960 961 962 963 964
static void
multihead_get_device_state (GdkDisplay       *display,
                            GdkDevice        *device,
                            GdkScreen       **screen,
                            gint             *x,
                            gint             *y,
                            GdkModifierType  *mask)
{
  multihead_current_pointer_hooks->get_pointer (display, screen, x, y, mask);
}
Kristian Rietveld's avatar
Kristian Rietveld committed
965

966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017
static GdkWindow *
multihead_window_get_device_position (GdkDisplay      *display,
                                      GdkDevice       *device,
                                      GdkWindow       *window,
                                      gint            *x,
                                      gint            *y,
                                      GdkModifierType *mask)
{
  return multihead_current_pointer_hooks->window_get_pointer (display, window, x, y, mask);
}

static GdkWindow *
multihead_window_at_device_position (GdkDisplay *display,
                                     GdkDevice  *device,
                                     gint       *win_x,
                                     gint       *win_y)
{
  return multihead_current_pointer_hooks->window_at_pointer (display, win_x, win_y);
}

static void
multihead_default_get_pointer (GdkDisplay       *display,
                               GdkScreen       **screen,
                               gint             *x,
                               gint             *y,
                               GdkModifierType  *mask)
{
  return _gdk_windowing_get_device_state (display,
                                          display->core_pointer,
                                          screen, x, y, mask);
}

static GdkWindow *
multihead_default_window_get_pointer (GdkDisplay      *display,
                                      GdkWindow       *window,
                                      gint            *x,
                                      gint            *y,
                                      GdkModifierType *mask)
{
  return gdk_window_real_window_get_device_position (display,
                                                     display->core_pointer,
                                                     window, x, y, mask);
}

static GdkWindow *
multihead_default_window_at_pointer (GdkDisplay *display,
                                     gint       *win_x,
                                     gint       *win_y)
{
  return gdk_display_real_get_window_at_device_position (display,
                                                         display->core_pointer,
                                                         win_x, win_y);
1018 1019 1020 1021
}

/**
 * gdk_display_set_pointer_hooks:
Matthias Clasen's avatar
Matthias Clasen committed
1022
 * @display: a #GdkDisplay
1023
 * @new_hooks: (allow-none): a table of pointers to functions for getting
1024 1025 1026 1027 1028 1029 1030 1031 1032
 *   quantities related to the current pointer position,
 *   or %NULL to restore the default table.
 * 
 * This function allows for hooking into the operation
 * of getting the current location of the pointer on a particular
 * display. This is only useful for such low-level tools as an
 * event recorder. Applications should never have any
 * reason to use this facility.
 *
1033
 * Return value: (transfer none): the previous pointer hook table
Matthias Clasen's avatar
Matthias Clasen committed
1034 1035
 *
 * Since: 2.2
1036
 *
1037
 * Deprecated: 3.0: Use gdk_display_set_device_hooks() instead.
1038 1039 1040 1041 1042
 **/
GdkDisplayPointerHooks *
gdk_display_set_pointer_hooks (GdkDisplay                   *display,
			       const GdkDisplayPointerHooks *new_hooks)
{
1043
  const GdkDisplayPointerHooks *result = multihead_current_pointer_hooks;
1044 1045 1046 1047

  g_return_val_if_fail (GDK_IS_DISPLAY (display), NULL);

  if (new_hooks)
1048
    multihead_current_pointer_hooks = new_hooks;
1049
  else
1050 1051 1052
    multihead_current_pointer_hooks = &multihead_default_pointer_hooks;

  gdk_display_set_device_hooks (display, &multihead_pointer_hooks);
1053 1054 1055 1056

  return (GdkDisplayPointerHooks *)result;
}

Matthias Clasen's avatar
Matthias Clasen committed
1057
static void
1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071
singlehead_get_pointer (GdkDisplay       *display,
			GdkScreen       **screen,
			gint             *x,
			gint             *y,
			GdkModifierType  *mask)
{
  GdkScreen *default_screen = gdk_display_get_default_screen (display);
  GdkWindow *root_window = gdk_screen_get_root_window (default_screen);

  *screen = default_screen;

  singlehead_current_pointer_hooks->get_pointer (root_window, x, y, mask);
}

Matthias Clasen's avatar
Matthias Clasen committed
1072
static GdkWindow*
1073 1074 1075 1076 1077 1078 1079 1080 1081
singlehead_window_get_pointer (GdkDisplay       *display,
			       GdkWindow        *window,
			       gint             *x,
			       gint             *y,
			       GdkModifierType  *mask)
{
  return singlehead_current_pointer_hooks->get_pointer (window, x, y, mask);
}

Matthias Clasen's avatar
Matthias Clasen committed
1082
static GdkWindow*
1083 1084 1085 1086 1087 1088 1089 1090 1091 1092
singlehead_window_at_pointer   (GdkDisplay *display,
				gint       *win_x,
				gint       *win_y)
{
  GdkScreen *default_screen = gdk_display_get_default_screen (display);

  return singlehead_current_pointer_hooks->window_at_pointer (default_screen,
							      win_x, win_y);
}

Matthias Clasen's avatar
Matthias Clasen committed
1093
static GdkWindow*
1094 1095 1096 1097 1098
singlehead_default_window_get_pointer (GdkWindow       *window,
				       gint            *x,
				       gint            *y,
				       GdkModifierType *mask)
{
1099 1100
  GdkDisplay *display;

1101
  display = gdk_window_get_display (window);
1102 1103 1104 1105

  return gdk_window_real_window_get_device_position (display,
                                                     display->core_pointer,
                                                     window, x, y, mask);
1106 1107
}

Matthias Clasen's avatar
Matthias Clasen committed
1108
static GdkWindow*
1109 1110 1111 1112
singlehead_default_window_at_pointer  (GdkScreen       *screen,
				       gint            *win_x,
				       gint            *win_y)
{
1113 1114 1115 1116 1117 1118 1119
  GdkDisplay *display;

  display = gdk_screen_get_display (screen);

  return gdk_display_real_get_window_at_device_position (display,
                                                         display->core_pointer,
                                                         win_x, win_y);
1120 1121 1122 1123
}

/**
 * gdk_set_pointer_hooks:
1124
 * @new_hooks: (allow-none): a table of pointers to functions for getting
1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137
 *   quantities related to the current pointer position,
 *   or %NULL to restore the default table.
 * 
 * This function allows for hooking into the operation
 * of getting the current location of the pointer. This
 * is only useful for such low-level tools as an
 * event recorder. Applications should never have any
 * reason to use this facility.
 *
 * This function is not multihead safe. For multihead operation,
 * see gdk_display_set_pointer_hooks().
 * 
 * Return value: the previous pointer hook table
1138
 *
1139
 * Deprecated: 3.0: Use gdk_display_set_device_hooks() instead.
1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156
 **/
GdkPointerHooks *
gdk_set_pointer_hooks (const GdkPointerHooks *new_hooks)
{
  const GdkPointerHooks *result = singlehead_current_pointer_hooks;

  if (new_hooks)
    singlehead_current_pointer_hooks = new_hooks;
  else
    singlehead_current_pointer_hooks = &singlehead_default_pointer_hooks;

  gdk_display_set_pointer_hooks (gdk_display_get_default (),
				 &singlehead_pointer_hooks);
  
  return (GdkPointerHooks *)result;
}

1157 1158
static void
generate_grab_broken_event (GdkWindow *window,
1159
                            GdkDevice *device,
1160 1161 1162 1163 1164 1165 1166
			    gboolean   implicit,
			    GdkWindow *grab_window)
{
  g_return_if_fail (window != NULL);

  if (!GDK_WINDOW_DESTROYED (window))
    {
1167 1168 1169 1170 1171 1172 1173 1174
      GdkEvent *event;

      event = gdk_event_new (GDK_GRAB_BROKEN);
      event->grab_broken.window = g_object_ref (window);
      event->grab_broken.send_event = FALSE;
      event->grab_broken.implicit = implicit;
      event->grab_broken.grab_window = grab_window;
      gdk_event_set_device (event, device);
1175
      event->grab_broken.keyboard = (gdk_device_get_source (device) == GDK_SOURCE_KEYBOARD) ? TRUE : FALSE;
1176 1177 1178

      gdk_event_put (event);
      gdk_event_free (event);
1179 1180 1181
    }
}

1182 1183 1184
GdkDeviceGrabInfo *
_gdk_display_get_last_device_grab (GdkDisplay *display,
                                   GdkDevice  *device)
1185 1186 1187
{
  GList *l;

1188
  l = g_hash_table_lookup (display->device_grabs, device);
1189

1190 1191 1192 1193 1194
  if (l)
    {
      l = g_list_last (l);
      return l->data;
    }
1195

1196 1197
  return NULL;
}
1198

1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209
GdkDeviceGrabInfo *
_gdk_display_add_device_grab (GdkDisplay       *display,
                              GdkDevice        *device,
                              GdkWindow        *window,
                              GdkWindow        *native_window,
                              GdkGrabOwnership  grab_ownership,
                              gboolean          owner_events,
                              GdkEventMask      event_mask,
                              unsigned long     serial_start,
                              guint32           time,
                              gboolean          implicit)
1210
{
1211 1212
  GdkDeviceGrabInfo *info, *other_info;
  GList *grabs, *l;
1213

1214
  info = g_new0 (GdkDeviceGrabInfo, 1);
1215 1216 1217 1218 1219 1220 1221 1222 1223

  info->window = g_object_ref (window);
  info->native_window = g_object_ref (native_window);
  info->serial_start = serial_start;
  info->serial_end = G_MAXULONG;
  info->owner_events = owner_events;
  info->event_mask = event_mask;
  info->time = time;
  info->implicit = implicit;
1224 1225 1226
  info->ownership = grab_ownership;

  grabs = g_hash_table_lookup (display->device_grabs, device);
1227 1228 1229 1230

  /* Find the first grab that has a larger start time (if any) and insert
   * before that. I.E we insert after already existing grabs with same
   * start time */