gdkdisplay.c 54.3 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
enum {
38
  OPENED,
39 40 41 42
  CLOSED,
  LAST_SIGNAL
};

43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75
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);
76

77

Matthias Clasen's avatar
Matthias Clasen committed
78
static void       singlehead_get_pointer (GdkDisplay       *display,
79 80 81 82
					  GdkScreen       **screen,
					  gint             *x,
					  gint             *y,
					  GdkModifierType  *mask);
Matthias Clasen's avatar
Matthias Clasen committed
83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98
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);
99 100 101 102 103 104 105 106 107 108
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);
109

110 111
static guint signals[LAST_SIGNAL] = { 0 };

112
static char *gdk_sm_client_id;
113

114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129
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
130 131 132 133 134 135 136 137 138 139 140 141 142 143
};

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;
144
static const GdkDisplayPointerHooks *multihead_current_pointer_hooks = &multihead_default_pointer_hooks;
145

Matthias Clasen's avatar
Matthias Clasen committed
146
G_DEFINE_TYPE (GdkDisplay, gdk_display, G_TYPE_OBJECT)
147 148 149 150 151

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

153
  object_class->finalize = gdk_display_finalize;
154
  object_class->dispose = gdk_display_dispose;
155

156
  /**
Matthias Clasen's avatar
Matthias Clasen committed
157
   * GdkDisplay::opened:
158 159
   * @display: the object on which the signal is emitted
   *
Matthias Clasen's avatar
Matthias Clasen committed
160 161
   * The ::opened signal is emitted when the connection to the windowing
   * system for @display is opened.
162 163 164 165 166 167 168 169 170
   */
  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);

171 172 173 174 175 176 177 178 179 180
  /**
   * 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
   */   
181
  signals[CLOSED] =
Matthias Clasen's avatar
Matthias Clasen committed
182
    g_signal_new (g_intern_static_string ("closed"),
183 184 185 186
		  G_OBJECT_CLASS_TYPE (object_class),
		  G_SIGNAL_RUN_LAST,
		  G_STRUCT_OFFSET (GdkDisplayClass, closed),
		  NULL, NULL,
Matthias Clasen's avatar
Matthias Clasen committed
187
		  _gdk_marshal_VOID__BOOLEAN,
188 189 190
		  G_TYPE_NONE,
		  1,
		  G_TYPE_BOOLEAN);
191 192
}

193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 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
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);
}

244 245 246 247 248 249
static void
gdk_display_init (GdkDisplay *display)
{
  _gdk_displays = g_slist_prepend (_gdk_displays, display);

  display->double_click_time = 250;
250
  display->double_click_distance = 5;
251

252 253 254 255 256 257 258 259 260 261 262 263 264 265
  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);
266 267
}

268 269 270 271
static void
gdk_display_dispose (GObject *object)
{
  GdkDisplay *display = GDK_DISPLAY_OBJECT (object);
272 273 274
  GdkDeviceManager *device_manager;

  device_manager = gdk_display_get_device_manager (GDK_DISPLAY_OBJECT (object));
275 276 277 278 279 280 281 282

  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);

283
  if (gdk_display_get_default () == display)
284 285 286 287 288 289 290 291
    {
      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);
    }
292

293
  if (device_manager)
294 295 296 297 298 299 300
    {
      /* 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));
    }
301

Matthias Clasen's avatar
Matthias Clasen committed
302
  G_OBJECT_CLASS (gdk_display_parent_class)->dispose (object);
303 304
}

305 306 307
static void
gdk_display_finalize (GObject *object)
{
308 309 310 311 312 313 314 315 316 317 318 319 320
  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
321
  G_OBJECT_CLASS (gdk_display_parent_class)->finalize (object);
322 323 324 325 326 327
}

/**
 * gdk_display_close:
 * @display: a #GdkDisplay
 *
328
 * Closes the connection to the windowing system for the given display,
329
 * and cleans up associated resources.
Matthias Clasen's avatar
Matthias Clasen committed
330 331
 *
 * Since: 2.2
332 333 334 335 336
 */
void
gdk_display_close (GdkDisplay *display)
{
  g_return_if_fail (GDK_IS_DISPLAY (display));
337 338 339 340

  if (!display->closed)
    {
      display->closed = TRUE;
341 342
      
      g_signal_emit (display, signals[CLOSED], 0, FALSE);
343 344
      g_object_run_dispose (G_OBJECT (display));
      
345
      g_object_unref (display);
346
    }
347 348
}

John Stowers's avatar
John Stowers committed
349 350 351 352
/**
 * gdk_display_is_closed:
 * @display: a #GdkDisplay
 *
353 354 355
 * Finds out if the display has been closed.
 *
 * Returns: %TRUE if the display is closed.
John Stowers's avatar
John Stowers committed
356 357 358 359 360 361 362 363 364 365 366
 *
 * Since: 2.22
 */
gboolean
gdk_display_is_closed  (GdkDisplay  *display)
{
  g_return_val_if_fail (GDK_IS_DISPLAY (display), FALSE);

  return display->closed;
}

367 368 369 370 371 372 373 374 375
/**
 * 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
376 377
 *
 * Since: 2.2
378 379 380 381 382 383 384 385 386 387 388 389
 **/
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
390
 * @display: a #GdkDisplay 
391 392 393 394 395 396
 * 
 * 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
397 398
 * 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
399
 * gdk_event_free().
Matthias Clasen's avatar
Matthias Clasen committed
400 401
 *
 * Since: 2.2
402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424
 **/
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
425 426
 *
 * Since: 2.2
427 428
 **/
void
429 430
gdk_display_put_event (GdkDisplay     *display,
		       const GdkEvent *event)
431 432 433 434 435
{
  g_return_if_fail (GDK_IS_DISPLAY (display));
  g_return_if_fail (event != NULL);

  _gdk_event_queue_append (display, gdk_event_copy (event));
436 437
  /* If the main loop is blocking in a different thread, wake it up */
  g_main_context_wakeup (NULL); 
438
}
439

440 441 442 443 444 445 446 447 448
/**
 * gdk_display_pointer_ungrab:
 * @display: a #GdkDisplay.
 * @time_: a timestap (e.g. %GDK_CURRENT_TIME).
 *
 * Release any pointer grab.
 *
 * Since: 2.2
 *
449
 * Deprecated: 3.0: Use gdk_device_ungrab(), together with gdk_device_grab()
450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479
 *             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;

      if (device->source != GDK_SOURCE_MOUSE)
        continue;

      gdk_device_ungrab (device, time_);
    }

  g_list_free (devices);
}

480 481
/**
 * gdk_pointer_ungrab:
Matthias Clasen's avatar
Matthias Clasen committed
482 483
 * @time_: a timestamp from a #GdkEvent, or %GDK_CURRENT_TIME if no 
 *  timestamp is available.
484
 *
485 486
 * Ungrabs the pointer on the default display, if it is grabbed by this 
 * application.
487
 *
488
 * Deprecated: 3.0: Use gdk_device_ungrab(), together with gdk_device_grab()
489
 *             instead.
490 491 492 493
 **/
void
gdk_pointer_ungrab (guint32 time)
{
Owen Taylor's avatar
Owen Taylor committed
494
  gdk_display_pointer_ungrab (gdk_display_get_default (), time);
495 496 497 498 499
}

/**
 * gdk_pointer_is_grabbed:
 * 
500 501
 * Returns %TRUE if the pointer on the default display is currently 
 * grabbed by this application.
502 503 504
 *
 * Note that this does not take the inmplicit pointer grab on button
 * presses into account.
505 506 507
 *
 * Return value: %TRUE if the pointer is currently grabbed by this application.
 *
508
 * Deprecated: 3.0: Use gdk_display_device_is_grabbed() instead.
509 510 511 512
 **/
gboolean
gdk_pointer_is_grabbed (void)
{
Owen Taylor's avatar
Owen Taylor committed
513
  return gdk_display_pointer_is_grabbed (gdk_display_get_default ());
514 515
}

516 517 518 519 520 521 522 523 524
/**
 * gdk_display_keyboard_ungrab:
 * @display: a #GdkDisplay.
 * @time_: a timestap (e.g #GDK_CURRENT_TIME).
 *
 * Release any keyboard grab
 *
 * Since: 2.2
 *
525
 * Deprecated: 3.0: Use gdk_device_ungrab(), together with gdk_device_grab()
526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555
 *             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;

      if (device->source != GDK_SOURCE_KEYBOARD)
        continue;

      gdk_device_ungrab (device, time);
    }

  g_list_free (devices);
}

556 557
/**
 * gdk_keyboard_ungrab:
558
 * @time_: a timestamp from a #GdkEvent, or %GDK_CURRENT_TIME if no
559 560
 *        timestamp is available.
 * 
561 562
 * Ungrabs the keyboard on the default display, if it is grabbed by this 
 * application.
563
 *
564
 * Deprecated: 3.0: Use gdk_device_ungrab(), together with gdk_device_grab()
565
 *             instead.
566 567 568 569
 **/
void
gdk_keyboard_ungrab (guint32 time)
{
Owen Taylor's avatar
Owen Taylor committed
570
  gdk_display_keyboard_ungrab (gdk_display_get_default (), time);
571 572 573 574 575
}

/**
 * gdk_beep:
 * 
576
 * Emits a short beep on the default display.
577 578 579 580
 **/
void
gdk_beep (void)
{
Owen Taylor's avatar
Owen Taylor committed
581
  gdk_display_beep (gdk_display_get_default ());
582 583 584 585 586
}

/**
 * gdk_event_send_client_message:
 * @event: the #GdkEvent to send, which should be a #GdkEventClient.
Owen Taylor's avatar
Owen Taylor committed
587
 * @winid:  the window to send the X ClientMessage event to.
588 589 590 591 592 593 594 595 596
 * 
 * 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
597 598
gdk_event_send_client_message (GdkEvent        *event,
			       GdkNativeWindow  winid)
599 600 601
{
  g_return_val_if_fail (event != NULL, FALSE);

Owen Taylor's avatar
Owen Taylor committed
602
  return gdk_event_send_client_message_for_display (gdk_display_get_default (),
Owen Taylor's avatar
Owen Taylor committed
603
						    event, winid);
604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622
}

/**
 * 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
623
  gdk_screen_broadcast_client_message (gdk_screen_get_default (), event);
624 625
}

626 627 628 629 630 631 632
/**
 * gdk_device_get_core_pointer:
 * 
 * Returns the core pointer device for the default display.
 * 
 * Return value: the core pointer device; this is owned by the
 *   display and should not be freed.
633
 *
634
 * Deprecated: 3.0: Use gdk_device_manager_get_client_pointer() instead, or
635 636
 *             gdk_event_get_device() if a #GdkEvent with pointer device
 *             information is available.
637 638 639 640
 **/
GdkDevice *
gdk_device_get_core_pointer (void)
{
Owen Taylor's avatar
Owen Taylor committed
641
  return gdk_display_get_core_pointer (gdk_display_get_default ());
642 643 644 645 646 647 648 649 650 651
}

/**
 * gdk_display_get_core_pointer:
 * @display: a #GdkDisplay
 * 
 * Returns the core pointer device for the given display
 * 
 * Return value: the core pointer device; this is owned by the
 *   display and should not be freed.
Matthias Clasen's avatar
Matthias Clasen committed
652 653
 *
 * Since: 2.2
654
 *
655
 * Deprecated: 3.0: Use gdk_device_manager_get_client_pointer() instead, or
656 657
 *             gdk_event_get_device() if a #GdkEvent with device
 *             information is available.
658 659 660 661 662 663
 **/
GdkDevice *
gdk_display_get_core_pointer (GdkDisplay *display)
{
  return display->core_pointer;
}
664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681

/**
 * 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)
{
682 683 684 685 686 687 688 689 690 691
  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);
692 693
}

694 695 696 697 698 699 700 701 702 703 704 705 706
/**
 * _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;
}
707

708
void
709 710
_gdk_display_enable_motion_hints (GdkDisplay *display,
                                  GdkDevice  *device)
711
{
712 713 714 715 716 717 718 719 720 721 722 723
  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)
724
    {
725 726 727
      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
728
	 trigger slightly too early, but this is just a hint
729 730 731
	 anyway. */
      if (serial > 0)
	serial--;
732 733
      if (serial < *device_serial)
	*device_serial = serial;
734 735 736
    }
}

737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843
/**
 * gdk_display_get_device_state:
 * @display: a #GdkDisplay.
 * @device: device to query status to.
 * @screen: location to store the #GdkScreen the @device is on, or %NULL.
 * @x: location to store root window X coordinate of @device, or %NULL.
 * @y: location to store root window Y coordinate of @device, or %NULL.
 * @mask: location to store current modifier mask for @device, or %NULL.
 *
 * 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));

  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.
 * @device: #GdkDevice to query info to.
 * @win_x: return location for the X coordinate of the device location, relative to the window origin, or %NULL.
 * @win_y: return location for the Y coordinate of the device location, relative to the window origin, or %NULL.
 *
 * 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).
 *
 * Returns: the #GdkWindow under the device position, or %NULL.
 *
 * 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);

  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.
 * @new_hooks: a table of pointers to functions for getting quantities related to all
 *             devices position, or %NULL to restore the default table.
 *
 * 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.
 *
 * Returns: The previous device hook table.
 *
 * 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;
}

844 845 846
/**
 * gdk_display_get_pointer:
 * @display: a #GdkDisplay
847
 * @screen: (allow-none): location to store the screen that the
848
 *          cursor is on, or %NULL.
849 850 851
 * @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
852
 *
853 854
 * Gets the current location of the pointer and the current modifier
 * mask for a given display.
Matthias Clasen's avatar
Matthias Clasen committed
855 856
 *
 * Since: 2.2
857
 *
858
 * Deprecated: 3.0: Use gdk_display_get_device_state() instead.
859 860 861 862 863 864 865 866 867 868
 **/
void
gdk_display_get_pointer (GdkDisplay      *display,
			 GdkScreen      **screen,
			 gint            *x,
			 gint            *y,
			 GdkModifierType *mask)
{
  g_return_if_fail (GDK_IS_DISPLAY (display));

869
  gdk_display_get_device_state (display, display->core_pointer, screen, x, y, mask);
870 871
}

872
static GdkWindow *
873 874 875 876
gdk_display_real_get_window_at_device_position (GdkDisplay *display,
                                                GdkDevice  *device,
                                                gint       *win_x,
                                                gint       *win_y)
877 878 879 880
{
  GdkWindow *window;
  gint x, y;

881
  window = _gdk_windowing_window_at_device_position (display, device, &x, &y, NULL, FALSE);
882 883 884 885 886 887

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

889
      window = _gdk_window_find_descendant_at (window,
890
					       x, y,
891 892 893 894
					       &xx, &yy);
      x = floor (xx + 0.5);
      y = floor (yy + 0.5);
    }
895

896 897
  *win_x = x;
  *win_y = y;
898

899 900 901 902
  return window;
}

static GdkWindow *
903 904 905 906 907 908
gdk_window_real_window_get_device_position (GdkDisplay       *display,
                                            GdkDevice        *device,
                                            GdkWindow        *window,
                                            gint             *x,
                                            gint             *y,
                                            GdkModifierType  *mask)
909 910 911
{
  GdkWindowObject *private;
  gint tmpx, tmpy;
912
  GdkModifierType tmp_mask;
913
  gboolean normal_child;
914 915 916

  private = (GdkWindowObject *) window;

917 918 919 920
  normal_child = GDK_WINDOW_IMPL_GET_IFACE (private->impl)->get_device_state (window,
                                                                              device,
                                                                              &tmpx, &tmpy,
                                                                              &tmp_mask);
Matthias Clasen's avatar
Matthias Clasen committed
921
  /* We got the coords on the impl, convert to the window */
922 923
  tmpx -= private->abs_x;
  tmpy -= private->abs_y;
924

925 926 927 928
  if (x)
    *x = tmpx;
  if (y)
    *y = tmpy;
929 930
  if (mask)
    *mask = tmp_mask;
931

932 933 934
  if (normal_child)
    return _gdk_window_find_child_at (window, tmpx, tmpy);
  return NULL;
935 936
}

937 938 939
/**
 * gdk_display_get_window_at_pointer:
 * @display: a #GdkDisplay
940
 * @win_x: (out) (allow-none): return location for x coordinate of the pointer location relative
941
 *    to the window origin, or %NULL
942
 * @win_y: (out) (allow-none): return location for y coordinate of the pointer location relative
943
 &    to the window origin, or %NULL
944
 *
945
 * Obtains the window underneath the mouse pointer, returning the location
946
 * of the pointer in that window in @win_x, @win_y for @screen. Returns %NULL
947 948
 * if the window under the mouse pointer is not known to GDK (for example, 
 * belongs to another application).
949 950
 *
 * Returns: (transfer none): the window under the mouse pointer, or %NULL
Matthias Clasen's avatar
Matthias Clasen committed
951 952
 *
 * Since: 2.2
953
 *
954
 * Deprecated: 3.0: Use gdk_display_get_window_at_device_position() instead.
955 956 957 958 959 960 961
 **/
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
962

963 964
  return gdk_display_get_window_at_device_position (display, display->core_pointer, win_x, win_y);
}
965

966 967 968 969 970 971 972 973 974 975
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
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 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028
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);
1029 1030 1031 1032
}

/**
 * gdk_display_set_pointer_hooks:
Matthias Clasen's avatar
Matthias Clasen committed
1033
 * @display: a #GdkDisplay
1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044
 * @new_hooks: a table of pointers to functions for getting
 *   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.
 *
 * Return value: the previous pointer hook table
Matthias Clasen's avatar
Matthias Clasen committed
1045 1046
 *
 * Since: 2.2
1047
 *
1048
 * Deprecated: 3.0: Use gdk_display_set_device_hooks() instead.
1049 1050 1051 1052 1053
 **/
GdkDisplayPointerHooks *
gdk_display_set_pointer_hooks (GdkDisplay                   *display,
			       const GdkDisplayPointerHooks *new_hooks)
{
1054
  const GdkDisplayPointerHooks *result = multihead_current_pointer_hooks;
1055 1056 1057 1058

  g_return_val_if_fail (GDK_IS_DISPLAY (display), NULL);

  if (new_hooks)
1059
    multihead_current_pointer_hooks = new_hooks;
1060
  else
1061 1062 1063
    multihead_current_pointer_hooks = &multihead_default_pointer_hooks;

  gdk_display_set_device_hooks (display, &multihead_pointer_hooks);
1064 1065 1066 1067

  return (GdkDisplayPointerHooks *)result;
}

Matthias Clasen's avatar
Matthias Clasen committed
1068
static void
1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082
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
1083
static GdkWindow*
1084 1085 1086 1087 1088 1089 1090 1091 1092
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
1093
static GdkWindow*
1094 1095 1096 1097 1098 1099 1100 1101 1102 1103
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
1104
static GdkWindow*
1105 1106 1107 1108 1109
singlehead_default_window_get_pointer (GdkWindow       *window,
				       gint            *x,
				       gint            *y,
				       GdkModifierType *mask)
{
1110 1111
  GdkDisplay *display;

1112
  display = gdk_window_get_display (window);
1113 1114 1115 1116

  return gdk_window_real_window_get_device_position (display,
                                                     display->core_pointer,
                                                     window, x, y, mask);
1117 1118
}

Matthias Clasen's avatar
Matthias Clasen committed
1119
static GdkWindow*
1120 1121 1122 1123
singlehead_default_window_at_pointer  (GdkScreen       *screen,
				       gint            *win_x,
				       gint            *win_y)
{
1124 1125 1126 1127 1128 1129 1130
  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);
1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148
}

/**
 * gdk_set_pointer_hooks:
 * @new_hooks: a table of pointers to functions for getting
 *   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
1149
 *
1150
 * Deprecated: 3.0: Use gdk_display_set_device_hooks() instead.
1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167
 **/
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;
}

1168 1169
static void
generate_grab_broken_event (GdkWindow *window,
1170
                            GdkDevice *device,
1171 1172 1173 1174 1175 1176 1177
			    gboolean   implicit,
			    GdkWindow *grab_window)
{
  g_return_if_fail (window != NULL);

  if (!GDK_WINDOW_DESTROYED (window))
    {
1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189
      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);
      event->grab_broken.keyboard = (device->source == GDK_SOURCE_KEYBOARD) ? TRUE : FALSE;

      gdk_event_put (event);
      gdk_event_free (event);
1190 1191 1192
    }
}

1193 1194 1195
GdkDeviceGrabInfo *
_gdk_display_get_last_device_grab (GdkDisplay *display,
                                   GdkDevice  *device)
1196 1197 1198
{
  GList *l;

1199
  l = g_hash_table_lookup (display->device_grabs, device);
1200

1201 1202 1203 1204 1205
  if (l)
    {
      l = g_list_last (l);
      return l->data;
    }
1206

1207 1208
  return NULL;
}
1209

1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220
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)
1221
{
1222 1223
  GdkDeviceGrabInfo *info, *other_info;
  GList *grabs, *l;
1224

1225
  info = g_new0 (GdkDeviceGrabInfo, 1);
1226 1227 1228 1229 1230 1231 1232 1233 1234

  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;
1235 1236 1237
  info->ownership = grab_ownership;

  grabs = g_hash_table_lookup (display->device_grabs, device);
1238 1239 1240 1241

  /* 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 */
1242
  for (l = grabs; l != NULL; l = l->next)
1243
    {
1244
      other_info = l->data;
1245

1246 1247 1248
      if (info->serial_start < other_info->serial_start)
	break;
    }
1249 1250

  grabs = g_list_insert_before (grabs, l, info);
1251 1252 1253 1254 1255 1256

  /* Make sure the new grab end before next grab */
  if (l)
    {
      other_info = l->data;
      info->serial_end = other_info->serial_start;
1257
    }