gdkdisplay.c 34.8 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
#include <math.h>
26
#include <glib.h>
27
#include "gdk.h"		/* gdk_event_send_client_message() */
28
#include "gdkdisplay.h"
29
#include "gdkwindowimpl.h"
30
#include "gdkinternals.h"
31
#include "gdkmarshalers.h"
32
#include "gdkscreen.h"
33
#include "gdkalias.h"
34

35 36 37 38 39
enum {
  CLOSED,
  LAST_SIGNAL
};

40
static void gdk_display_dispose    (GObject         *object);
41 42
static void gdk_display_finalize   (GObject         *object);

43

Matthias Clasen's avatar
Matthias Clasen committed
44
static void       singlehead_get_pointer (GdkDisplay       *display,
45 46 47 48
					  GdkScreen       **screen,
					  gint             *x,
					  gint             *y,
					  GdkModifierType  *mask);
Matthias Clasen's avatar
Matthias Clasen committed
49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64
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);
65 66 67 68 69 70 71 72
static GdkWindow *gdk_window_real_window_get_pointer     (GdkDisplay       *display,
                                                          GdkWindow        *window,
                                                          gint             *x,
                                                          gint             *y,
                                                          GdkModifierType  *mask);
static GdkWindow *gdk_display_real_get_window_at_pointer (GdkDisplay       *display,
                                                          gint             *win_x,
                                                          gint             *win_y);
73

74 75
static guint signals[LAST_SIGNAL] = { 0 };

76
static char *gdk_sm_client_id;
77

78 79
static const GdkDisplayPointerHooks default_pointer_hooks = {
  _gdk_windowing_get_pointer,
80 81
  gdk_window_real_window_get_pointer,
  gdk_display_real_get_window_at_pointer
82 83 84 85 86 87 88 89 90 91 92 93 94 95 96
};

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;

Matthias Clasen's avatar
Matthias Clasen committed
97
G_DEFINE_TYPE (GdkDisplay, gdk_display, G_TYPE_OBJECT)
98 99 100 101 102 103 104

static void
gdk_display_class_init (GdkDisplayClass *class)
{
  GObjectClass *object_class = G_OBJECT_CLASS (class);
  
  object_class->finalize = gdk_display_finalize;
105
  object_class->dispose = gdk_display_dispose;
106

107 108 109 110 111 112 113 114 115 116
  /**
   * 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
   */   
117
  signals[CLOSED] =
118
    g_signal_new (g_intern_static_string ("closed"),
119 120 121 122
		  G_OBJECT_CLASS_TYPE (object_class),
		  G_SIGNAL_RUN_LAST,
		  G_STRUCT_OFFSET (GdkDisplayClass, closed),
		  NULL, NULL,
Matthias Clasen's avatar
Matthias Clasen committed
123
		  _gdk_marshal_VOID__BOOLEAN,
124 125 126
		  G_TYPE_NONE,
		  1,
		  G_TYPE_BOOLEAN);
127 128 129 130 131 132 133 134 135 136
}

static void
gdk_display_init (GdkDisplay *display)
{
  _gdk_displays = g_slist_prepend (_gdk_displays, display);

  display->button_click_time[0] = display->button_click_time[1] = 0;
  display->button_window[0] = display->button_window[1] = NULL;
  display->button_number[0] = display->button_number[1] = -1;
137 138
  display->button_x[0] = display->button_x[1] = 0;
  display->button_y[0] = display->button_y[1] = 0;
139 140

  display->double_click_time = 250;
141
  display->double_click_distance = 5;
142 143

  display->pointer_hooks = &default_pointer_hooks;
144 145
}

146 147 148 149
static void
gdk_display_dispose (GObject *object)
{
  GdkDisplay *display = GDK_DISPLAY_OBJECT (object);
150 151 152 153 154 155 156 157 158

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

  if (gdk_display_get_default() == display)
159 160 161 162 163 164 165 166
    {
      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);
    }
167

Matthias Clasen's avatar
Matthias Clasen committed
168
  G_OBJECT_CLASS (gdk_display_parent_class)->dispose (object);
169 170
}

171 172 173
static void
gdk_display_finalize (GObject *object)
{
Matthias Clasen's avatar
Matthias Clasen committed
174
  G_OBJECT_CLASS (gdk_display_parent_class)->finalize (object);
175 176 177 178 179 180
}

/**
 * gdk_display_close:
 * @display: a #GdkDisplay
 *
181
 * Closes the connection to the windowing system for the given display,
182
 * and cleans up associated resources.
183 184
 *
 * Since: 2.2
185 186 187 188 189
 */
void
gdk_display_close (GdkDisplay *display)
{
  g_return_if_fail (GDK_IS_DISPLAY (display));
190 191 192 193

  if (!display->closed)
    {
      display->closed = TRUE;
194 195
      
      g_signal_emit (display, signals[CLOSED], 0, FALSE);
196 197
      g_object_run_dispose (G_OBJECT (display));
      
198
      g_object_unref (display);
199
    }
200 201 202 203 204 205 206 207 208 209 210
}

/**
 * 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().
211 212
 *
 * Since: 2.2
213 214 215 216 217 218 219 220 221 222 223 224
 **/
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:
Alexander Larsson's avatar
Alexander Larsson committed
225
 * @display: a #GdkDisplay 
226 227 228 229 230 231
 * 
 * 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.)
 * 
232 233
 * 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
234
 * gdk_event_free().
235 236
 *
 * Since: 2.2
237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259
 **/
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.
260 261
 *
 * Since: 2.2
262 263
 **/
void
264 265
gdk_display_put_event (GdkDisplay     *display,
		       const GdkEvent *event)
266 267 268 269 270
{
  g_return_if_fail (GDK_IS_DISPLAY (display));
  g_return_if_fail (event != NULL);

  _gdk_event_queue_append (display, gdk_event_copy (event));
271 272
  /* If the main loop is blocking in a different thread, wake it up */
  g_main_context_wakeup (NULL); 
273
}
274 275 276

/**
 * gdk_pointer_ungrab:
277 278
 * @time_: a timestamp from a #GdkEvent, or %GDK_CURRENT_TIME if no 
 *  timestamp is available.
279
 *
280 281
 * Ungrabs the pointer on the default display, if it is grabbed by this 
 * application.
282 283 284 285
 **/
void
gdk_pointer_ungrab (guint32 time)
{
Owen Taylor's avatar
Owen Taylor committed
286
  gdk_display_pointer_ungrab (gdk_display_get_default (), time);
287 288 289 290 291
}

/**
 * gdk_pointer_is_grabbed:
 * 
292 293
 * Returns %TRUE if the pointer on the default display is currently 
 * grabbed by this application.
294 295 296 297 298 299 300 301 302
 *
 * Note that this does not take the inmplicit pointer grab on button
 * presses into account.

 * Return value: %TRUE if the pointer is currently grabbed by this application.* 
 **/
gboolean
gdk_pointer_is_grabbed (void)
{
Owen Taylor's avatar
Owen Taylor committed
303
  return gdk_display_pointer_is_grabbed (gdk_display_get_default ());
304 305 306 307
}

/**
 * gdk_keyboard_ungrab:
308
 * @time_: a timestamp from a #GdkEvent, or %GDK_CURRENT_TIME if no
309 310
 *        timestamp is available.
 * 
311 312
 * Ungrabs the keyboard on the default display, if it is grabbed by this 
 * application.
313 314 315 316
 **/
void
gdk_keyboard_ungrab (guint32 time)
{
Owen Taylor's avatar
Owen Taylor committed
317
  gdk_display_keyboard_ungrab (gdk_display_get_default (), time);
318 319 320 321 322
}

/**
 * gdk_beep:
 * 
323
 * Emits a short beep on the default display.
324 325 326 327
 **/
void
gdk_beep (void)
{
Owen Taylor's avatar
Owen Taylor committed
328
  gdk_display_beep (gdk_display_get_default ());
329 330 331 332 333
}

/**
 * gdk_event_send_client_message:
 * @event: the #GdkEvent to send, which should be a #GdkEventClient.
334
 * @winid:  the window to send the X ClientMessage event to.
335 336 337 338 339 340 341 342 343
 * 
 * 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
344 345
gdk_event_send_client_message (GdkEvent        *event,
			       GdkNativeWindow  winid)
346 347 348
{
  g_return_val_if_fail (event != NULL, FALSE);

Owen Taylor's avatar
Owen Taylor committed
349
  return gdk_event_send_client_message_for_display (gdk_display_get_default (),
350
						    event, winid);
351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369
}

/**
 * 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
370
  gdk_screen_broadcast_client_message (gdk_screen_get_default (), event);
371 372
}

373 374 375 376 377 378 379 380 381 382 383
/**
 * 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.
 **/
GdkDevice *
gdk_device_get_core_pointer (void)
{
Owen Taylor's avatar
Owen Taylor committed
384
  return gdk_display_get_core_pointer (gdk_display_get_default ());
385 386 387 388 389 390 391 392 393 394
}

/**
 * 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.
395 396
 *
 * Since: 2.2
397 398 399 400 401 402
 **/
GdkDevice *
gdk_display_get_core_pointer (GdkDisplay *display)
{
  return display->core_pointer;
}
403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420

/**
 * 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)
{
421 422 423 424 425 426 427 428 429 430
  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);
431 432
}

433 434 435 436 437 438 439 440 441 442 443 444 445
/**
 * _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;
}
446

447 448 449
void
_gdk_display_enable_motion_hints (GdkDisplay *display)
{
450
  gulong serial;
451 452 453
  
  if (display->pointer_info.motion_hint_serial != 0)
    {
454 455 456
      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
457
	 trigger slightly too early, but this is just a hint
458 459 460 461 462
	 anyway. */
      if (serial > 0)
	serial--;
      if (serial < display->pointer_info.motion_hint_serial)
	display->pointer_info.motion_hint_serial = serial;
463 464 465
    }
}

466 467 468 469 470 471 472 473 474 475 476
/**
 * gdk_display_get_pointer:
 * @display: a #GdkDisplay
 * @screen: location to store the screen that the
 *          cursor is on, or %NULL.
 * @x: location to store root window X coordinate of pointer, or %NULL.
 * @y: location to store root window Y coordinate of pointer, or %NULL.
 * @mask: location to store current modifier mask, or %NULL
 * 
 * Gets the current location of the pointer and the current modifier
 * mask for a given display.
477 478
 *
 * Since: 2.2
479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504
 **/
void
gdk_display_get_pointer (GdkDisplay      *display,
			 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));

  display->pointer_hooks->get_pointer (display, &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;
}

505 506 507 508 509 510 511 512
static GdkWindow *
gdk_display_real_get_window_at_pointer (GdkDisplay *display,
                                        gint       *win_x,
                                        gint       *win_y)
{
  GdkWindow *window;
  gint x, y;

513
  window = _gdk_windowing_window_at_pointer (display, &x, &y, NULL);
514 515 516 517 518 519

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

521
      window = _gdk_window_find_descendant_at (window,
522
					       x, y,
523 524 525 526
					       &xx, &yy);
      x = floor (xx + 0.5);
      y = floor (yy + 0.5);
    }
527

528 529
  *win_x = x;
  *win_y = y;
530

531 532 533 534 535 536 537 538 539 540 541 542
  return window;
}

static GdkWindow *
gdk_window_real_window_get_pointer (GdkDisplay       *display,
                                    GdkWindow        *window,
                                    gint             *x,
                                    gint             *y,
                                    GdkModifierType  *mask)
{
  GdkWindowObject *private;
  gint tmpx, tmpy;
543
  GdkModifierType tmp_mask;
544
  gboolean normal_child;
545 546 547

  private = (GdkWindowObject *) window;

548 549 550
  normal_child = GDK_WINDOW_IMPL_GET_IFACE (private->impl)->get_pointer (window,
									 &tmpx, &tmpy,
									 &tmp_mask);
551
  /* We got the coords on the impl, convert to the window */
552 553
  tmpx -= private->abs_x;
  tmpy -= private->abs_y;
554

555 556 557 558
  if (x)
    *x = tmpx;
  if (y)
    *y = tmpy;
559 560
  if (mask)
    *mask = tmp_mask;
561

562 563 564
  if (normal_child)
    return _gdk_window_find_child_at (window, tmpx, tmpy);
  return NULL;
565 566
}

567 568 569
/**
 * gdk_display_get_window_at_pointer:
 * @display: a #GdkDisplay
570 571 572 573
 * @win_x: return location for x coordinate of the pointer location relative 
 *    to the window origin, or %NULL
 * @win_y: return location for y coordinate of the pointer location relative
 &    to the window origin, or %NULL
574 575
 * 
 * Obtains the window underneath the mouse pointer, returning the location
576 577 578
 * of the pointer in that window in @win_x, @win_y for @screen. Returns %NULL 
 * if the window under the mouse pointer is not known to GDK (for example, 
 * belongs to another application).
579 580
 * 
 * Returns: the window under the mouse pointer, or %NULL
581 582
 *
 * Since: 2.2
583 584 585 586 587 588 589
 **/
GdkWindow *
gdk_display_get_window_at_pointer (GdkDisplay *display,
				   gint       *win_x,
				   gint       *win_y)
{
  gint tmp_x, tmp_y;
Kristian Rietveld's avatar
Kristian Rietveld committed
590
  GdkWindow *window;
591 592

  g_return_val_if_fail (GDK_IS_DISPLAY (display), NULL);
Kristian Rietveld's avatar
Kristian Rietveld committed
593 594

  window = display->pointer_hooks->window_at_pointer (display, &tmp_x, &tmp_y);
595 596 597 598 599

  if (win_x)
    *win_x = tmp_x;
  if (win_y)
    *win_y = tmp_y;
Kristian Rietveld's avatar
Kristian Rietveld committed
600 601

  return window;
602 603 604 605
}

/**
 * gdk_display_set_pointer_hooks:
Matthias Clasen's avatar
Matthias Clasen committed
606
 * @display: a #GdkDisplay
607 608 609 610 611 612 613 614 615 616 617
 * @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
618 619
 *
 * Since: 2.2
620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637
 **/
GdkDisplayPointerHooks *
gdk_display_set_pointer_hooks (GdkDisplay                   *display,
			       const GdkDisplayPointerHooks *new_hooks)
{
  const GdkDisplayPointerHooks *result;

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

  if (new_hooks)
    display->pointer_hooks = new_hooks;
  else
    display->pointer_hooks = &default_pointer_hooks;

  return (GdkDisplayPointerHooks *)result;
}

Matthias Clasen's avatar
Matthias Clasen committed
638
static void
639 640 641 642 643 644 645 646 647 648 649 650 651 652
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
653
static GdkWindow*
654 655 656 657 658 659 660 661 662
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
663
static GdkWindow*
664 665 666 667 668 669 670 671 672 673
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
674
static GdkWindow*
675 676 677 678 679
singlehead_default_window_get_pointer (GdkWindow       *window,
				       gint            *x,
				       gint            *y,
				       GdkModifierType *mask)
{
680 681
  return gdk_window_real_window_get_pointer (gdk_drawable_get_display (window),
                                             window, x, y, mask);
682 683
}

Matthias Clasen's avatar
Matthias Clasen committed
684
static GdkWindow*
685 686 687 688
singlehead_default_window_at_pointer  (GdkScreen       *screen,
				       gint            *win_x,
				       gint            *win_y)
{
689 690
  return gdk_display_real_get_window_at_pointer (gdk_screen_get_display (screen),
                                                 win_x, win_y);
691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725
}

/**
 * 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
 **/
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;
}

726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746
static void
generate_grab_broken_event (GdkWindow *window,
			    gboolean   keyboard,
			    gboolean   implicit,
			    GdkWindow *grab_window)
{
  g_return_if_fail (window != NULL);

  if (!GDK_WINDOW_DESTROYED (window))
    {
      GdkEvent event;
      event.type = GDK_GRAB_BROKEN;
      event.grab_broken.window = window;
      event.grab_broken.send_event = 0;
      event.grab_broken.keyboard = keyboard;
      event.grab_broken.implicit = implicit;
      event.grab_broken.grab_window = grab_window;
      gdk_event_put (&event);
    }
}

747 748 749 750 751
GdkPointerGrabInfo *
_gdk_display_get_last_pointer_grab (GdkDisplay *display)
{
  GList *l;

752
  l = g_list_last (display->pointer_grabs);
753 754 755

  if (l == NULL)
    return NULL;
756 757
  else
    return (GdkPointerGrabInfo *)l->data;
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
}


GdkPointerGrabInfo *
_gdk_display_add_pointer_grab (GdkDisplay *display,
			       GdkWindow *window,
			       GdkWindow *native_window,
			       gboolean owner_events,
			       GdkEventMask event_mask,
			       unsigned long serial_start,
			       guint32 time,
			       gboolean implicit)
{
  GdkPointerGrabInfo *info, *other_info;
  GList *l;

  info = g_new0 (GdkPointerGrabInfo, 1);

  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;

  /* 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 */
  for (l = display->pointer_grabs; l != NULL; l = l->next)
789
    {
790 791 792 793 794 795 796 797 798 799 800 801 802
      other_info = l->data;
      
      if (info->serial_start < other_info->serial_start)
	break;
    }
  display->pointer_grabs =
    g_list_insert_before (display->pointer_grabs, l, info);

  /* Make sure the new grab end before next grab */
  if (l)
    {
      other_info = l->data;
      info->serial_end = other_info->serial_start;
803
    }
804
  
805 806 807 808
  /* Find any previous grab and update its end time */
  l = g_list_find  (display->pointer_grabs, info);
  l = l->prev;
  if (l)
809
    {
810 811 812 813 814 815 816 817 818 819 820 821 822 823 824
      other_info = l->data;
      other_info->serial_end = serial_start;
    }

  return info;
}

static void
free_pointer_grab (GdkPointerGrabInfo *info)
{
  g_object_unref (info->window);
  g_object_unref (info->native_window);
  g_free (info);
}

825
/* _gdk_synthesize_crossing_events only works inside one toplevel.
826 827 828 829 830 831 832 833 834 835 836 837 838
   This function splits things into two calls if needed, converting the
   coordinates to the right toplevel */
static void
synthesize_crossing_events (GdkDisplay *display,
			    GdkWindow *src_window,
			    GdkWindow *dest_window,
			    GdkCrossingMode crossing_mode,
			    guint32 time,
			    gulong serial)
{
  GdkWindow *src_toplevel, *dest_toplevel;
  GdkModifierType state;
  int x, y;
839 840 841 842

  /* We use the native crossing events if all native */
  if (_gdk_native_windows)
    return;
843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859
  
  if (src_window)
    src_toplevel = gdk_window_get_toplevel (src_window);
  else
    src_toplevel = NULL;
  if (dest_window)
    dest_toplevel = gdk_window_get_toplevel (dest_window);
  else
    dest_toplevel = NULL;

  if (src_toplevel == NULL && dest_toplevel == NULL)
    return;
  
  if (src_toplevel == NULL ||
      src_toplevel == dest_toplevel)
    {
      /* Same toplevels */
860 861
      gdk_window_get_pointer (dest_toplevel,
			      &x, &y, &state);
862
      _gdk_synthesize_crossing_events (display,
863 864 865 866 867 868 869
				       src_window,
				       dest_window,
				       crossing_mode,
				       x, y, state,
				       time,
				       NULL,
				       serial, FALSE);
870 871 872
    }
  else if (dest_toplevel == NULL)
    {
873 874
      gdk_window_get_pointer (src_toplevel,
			      &x, &y, &state);
875
      _gdk_synthesize_crossing_events (display,
876 877 878 879 880 881 882
				       src_window,
				       NULL,
				       crossing_mode,
				       x, y, state,
				       time,
				       NULL,
				       serial, FALSE);
883 884 885 886
    }
  else
    {
      /* Different toplevels */
887 888
      gdk_window_get_pointer (src_toplevel,
			      &x, &y, &state);
889
      _gdk_synthesize_crossing_events (display,
890 891 892 893 894 895 896
				       src_window,
				       NULL,
				       crossing_mode,
				       x, y, state,
				       time,
				       NULL,
				       serial, FALSE);
897 898
      gdk_window_get_pointer (dest_toplevel,
			      &x, &y, &state);
899
      _gdk_synthesize_crossing_events (display,
900 901 902 903 904 905 906
				       NULL,
				       dest_window,
				       crossing_mode,
				       x, y, state,
				       time,
				       NULL,
				       serial, FALSE);
907 908
    }
}
909

910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945
static GdkWindow *
get_current_toplevel (GdkDisplay *display,
		      int *x_out, int *y_out,
		      GdkModifierType *state_out)
{
  GdkWindow *pointer_window;
  GdkWindowObject *w;
  int x, y;
  GdkModifierType state;

  pointer_window = _gdk_windowing_window_at_pointer (display,  &x, &y, &state);
  if (pointer_window != NULL &&
      (GDK_WINDOW_DESTROYED (pointer_window) ||
       GDK_WINDOW_TYPE (pointer_window) == GDK_WINDOW_ROOT ||
       GDK_WINDOW_TYPE (pointer_window) == GDK_WINDOW_FOREIGN))
    pointer_window = NULL;

  w = (GdkWindowObject *)pointer_window;
  if (w)
    {
      /* Convert to toplevel */
      while (w->parent != NULL &&
	     w->parent->window_type != GDK_WINDOW_ROOT)
	{
	  x += w->x;
	  y += w->y;
	  w = w->parent;
	}
    }

  *x_out = x;
  *y_out = y;
  *state_out = state;
  return (GdkWindow *)w;
}

946 947 948 949 950 951 952
static void
switch_to_pointer_grab (GdkDisplay *display,
			GdkPointerGrabInfo *grab,
			GdkPointerGrabInfo *last_grab,
			guint32 time,
			gulong serial)
{
953
  GdkWindow *src_window, *pointer_window, *new_toplevel;
954 955 956 957 958 959 960 961 962 963 964
  GList *old_grabs;
  GdkModifierType state;
  int x, y;

  /* Temporarily unset pointer to make sure we send the crossing events below */
  old_grabs = display->pointer_grabs;
  display->pointer_grabs = NULL;
  
  if (grab)
    {
      /* New grab is in effect */
965
      
966 967 968 969 970 971
      /* We need to generate crossing events for the grab.
       * However, there are never any crossing events for implicit grabs
       * TODO: ... Actually, this could happen if the pointer window
       *           doesn't have button mask so a parent gets the event... 
       */
      if (!grab->implicit)
972
	{
973 974 975 976
	  /* We send GRAB crossing events from the window under the pointer to the
	     grab window. Except if there is an old grab then we start from that */
	  if (last_grab)
	    src_window = last_grab->window;
977
	  else
978
	    src_window = display->pointer_info.window_under_pointer;
979
	  
980
	  if (src_window != grab->window)
981
	    {
982 983 984
	      synthesize_crossing_events (display,
					  src_window, grab->window,
					  GDK_CROSSING_GRAB, time, serial);
985
	    }
986

987 988 989 990 991
	  /* !owner_event Grabbing a window that we're not inside, current status is
	     now NULL (i.e. outside grabbed window) */
	  if (!grab->owner_events && display->pointer_info.window_under_pointer != grab->window)
	    _gdk_display_set_window_under_pointer (display, NULL);
	}
992

993 994
      grab->activated = TRUE;
    }
995 996

  if (last_grab)
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
      new_toplevel = NULL;

      if (grab == NULL /* ungrab */ ||
	  (!last_grab->owner_events && grab->owner_events) /* switched to owner_events */ )
	{
	  /* We force check what window we're in, and update the toplevel_under_pointer info,
	   * as that won't get told of this change with toplevel enter events.
	   */
	  if (display->pointer_info.toplevel_under_pointer)
	    g_object_unref (display->pointer_info.toplevel_under_pointer);
	  display->pointer_info.toplevel_under_pointer = NULL;

	  new_toplevel = get_current_toplevel (display, &x, &y, &state);
	  if (new_toplevel)
	    {
	      /* w is now toplevel and x,y in toplevel coords */
	      display->pointer_info.toplevel_under_pointer = g_object_ref (new_toplevel);
	      display->pointer_info.toplevel_x = x;
	      display->pointer_info.toplevel_y = y;
	      display->pointer_info.state = state;
	    }
	}

      if (grab == NULL) /* Ungrabbed, send events */
1022
	{
1023 1024
	  pointer_window = NULL;
	  if (new_toplevel)
1025
	    {
1026 1027 1028 1029 1030
	      /* Find (possibly virtual) child window */
	      pointer_window =
		_gdk_window_find_descendant_at (new_toplevel,
						x, y,
						NULL, NULL);
1031
	    }
1032
	  
1033 1034 1035 1036
	  if (pointer_window != last_grab->window)
	    synthesize_crossing_events (display,
					last_grab->window, pointer_window,
					GDK_CROSSING_UNGRAB, time, serial);
1037
	  
1038 1039
	  /* We're now ungrabbed, update the window_under_pointer */
	  _gdk_display_set_window_under_pointer (display, pointer_window);
1040

1041 1042 1043 1044 1045
	  if (last_grab->implicit_ungrab)
	    generate_grab_broken_event (last_grab->window,
					FALSE, TRUE,
					NULL);
	}
1046
    }
1047 1048
  
  display->pointer_grabs = old_grabs;
1049 1050 1051 1052

}

void
1053 1054
_gdk_display_pointer_grab_update (GdkDisplay *display,
				  gulong current_serial)
1055
{
1056 1057 1058 1059
  GdkPointerGrabInfo *current_grab, *next_grab;
  guint32 time;
  
  time = display->last_event_time;
1060

1061 1062 1063
  while (display->pointer_grabs != NULL)
    {
      current_grab = display->pointer_grabs->data;
1064

1065 1066 1067 1068 1069 1070 1071 1072 1073
      if (current_grab->serial_start > current_serial)
	return; /* Hasn't started yet */
      
      if (current_grab->serial_end > current_serial ||
	  (current_grab->serial_end == current_serial &&
	   current_grab->grab_one_pointer_release_event))
	{
	  /* This one hasn't ended yet.
	     its the currently active one or scheduled to be active */
1074

1075 1076
	  if (!current_grab->activated)
	    switch_to_pointer_grab (display, current_grab, NULL, time, current_serial);
1077
	  
1078 1079 1080 1081 1082 1083
	  break;
	}


      next_grab = NULL;
      if (display->pointer_grabs->next)
1084
	{
1085 1086 1087 1088 1089
	  /* This is the next active grab */
	  next_grab = display->pointer_grabs->next->data;
	  
	  if (next_grab->serial_start > current_serial)
	    next_grab = NULL; /* Actually its not yet active */
1090 1091
	}

1092 1093 1094 1095 1096
      if (next_grab == NULL ||
	  current_grab->window != next_grab->window)
	generate_grab_broken_event (GDK_WINDOW (current_grab->window),
				    FALSE, current_grab->implicit,
				    next_grab? next_grab->window : NULL);
1097

1098 1099 1100 1101 1102 1103 1104 1105 1106

      /* Remove old grab */
      display->pointer_grabs =
	g_list_delete_link (display->pointer_grabs,
			    display->pointer_grabs);
      
      switch_to_pointer_grab (display,
			      next_grab, current_grab,
			      time, current_serial);
1107
      
1108
      free_pointer_grab (current_grab);
1109
    }
1110 1111 1112 1113 1114 1115 1116 1117 1118 1119
}

static GList *
find_pointer_grab (GdkDisplay *display,
		   gulong serial)
{
  GdkPointerGrabInfo *grab;
  GList *l;

  for (l = display->pointer_grabs; l != NULL; l = l->next)
1120
    {
1121
      grab = l->data;
1122

1123 1124
      if (serial >= grab->serial_start && serial < grab->serial_end)
	return l;
1125
    }
1126 1127 1128 1129
  
  return NULL;
}

1130

1131 1132 1133 1134 1135 1136 1137 1138 1139 1140

GdkPointerGrabInfo *
_gdk_display_has_pointer_grab (GdkDisplay *display,
			       gulong serial)
{
  GList *l;

  l = find_pointer_grab (display, serial);
  if (l)
    return l->data;
1141
  
1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162
  return NULL;
}

/* Returns true if last grab was ended */
gboolean
_gdk_display_end_pointer_grab (GdkDisplay *display,
			       gulong serial,
			       GdkWindow *if_child,
			       gboolean implicit)
{
  GdkPointerGrabInfo *grab;
  GList *l;

  l = find_pointer_grab (display, serial);
  
  if (l == NULL)
    return FALSE;

  grab = l->data;
  if (grab &&
      (if_child == NULL ||
Matthias Clasen's avatar
Matthias Clasen committed
1163
       _gdk_window_event_parent_of (grab->window, if_child)))
1164 1165 1166 1167 1168 1169 1170
    {
      grab->serial_end = serial;
      grab->implicit_ungrab = implicit;
      return l->next == NULL;
    }
  
  return FALSE;
1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184
}

void
_gdk_display_set_has_keyboard_grab (GdkDisplay *display,
				    GdkWindow *window,
				    GdkWindow *native_window,
				    gboolean owner_events,
				    unsigned long serial,
				    guint32 time)
{
  if (display->keyboard_grab.window != NULL &&
      display->keyboard_grab.window != window)
    generate_grab_broken_event (display->keyboard_grab.window,
				TRUE, FALSE, window);
1185
  
1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200
  display->keyboard_grab.window = window;
  display->keyboard_grab.native_window = native_window;
  display->keyboard_grab.owner_events = owner_events;
  display->keyboard_grab.serial = serial;
  display->keyboard_grab.time = time;      
}

void
_gdk_display_unset_has_keyboard_grab (GdkDisplay *display,
				      gboolean implicit)
{
  if (implicit)
    generate_grab_broken_event (display->keyboard_grab.window,
				TRUE, FALSE, NULL);
  display->keyboard_grab.window = NULL;  
1201 1202
}

1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234
/**
 * gdk_keyboard_grab_info_libgtk_only:
 * @display: the display for which to get the grab information
 * @grab_window: location to store current grab window
 * @owner_events: location to store boolean indicating whether
 *   the @owner_events flag to gdk_keyboard_grab() was %TRUE.
 * 
 * Determines information about the current keyboard grab.
 * This is not public API and must not be used by applications.
 * 
 * Return value: %TRUE if this application currently has the
 *  keyboard grabbed.
 **/
gboolean
gdk_keyboard_grab_info_libgtk_only (GdkDisplay *display,
				    GdkWindow **grab_window,
				    gboolean   *owner_events)
{
  g_return_val_if_fail (GDK_IS_DISPLAY (display), FALSE);

  if (display->keyboard_grab.window)
    {
      if (grab_window)
        *grab_window = display->keyboard_grab.window;
      if (owner_events)
        *owner_events = display->keyboard_grab.owner_events;

      return TRUE;
    }
  else
    return FALSE;
}
1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253

/**
 * gdk_pointer_grab_info_libgtk_only:
 * @display: the #GdkDisplay for which to get the grab information
 * @grab_window: location to store current grab window
 * @owner_events: location to store boolean indicating whether
 *   the @owner_events flag to gdk_pointer_grab() was %TRUE.
 * 
 * Determines information about the current pointer grab.
 * This is not public API and must not be used by applications.
 * 
 * Return value: %TRUE if this application currently has the
 *  pointer grabbed.
 **/
gboolean
gdk_pointer_grab_info_libgtk_only (GdkDisplay *display,
				   GdkWindow **grab_window,
				   gboolean   *owner_events)
{
1254 1255
  GdkPointerGrabInfo *info;
  
1256 1257
  g_return_val_if_fail (GDK_IS_DISPLAY (display), FALSE);

1258 1259 1260 1261
  /* What we're interested in is the steady state (ie last grab),
     because we're interested e.g. if we grabbed so that we
     can ungrab, even if our grab is not active just yet. */
  info = _gdk_display_get_last_pointer_grab (display);
1262 1263
  
  if (info)
1264 1265
    {
      if (grab_window)
1266
        *grab_window = info->window;
1267
      if (owner_events)
1268
        *owner_events = info->owner_events;
1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289

      return TRUE;
    }
  else
    return FALSE;
}


/**
 * gdk_display_pointer_is_grabbed:
 * @display: a #GdkDisplay
 *
 * Test if the pointer is grabbed.
 *
 * Returns: %TRUE if an active X pointer grab is in effect
 *
 * Since: 2.2
 */
gboolean
gdk_display_pointer_is_grabbed (GdkDisplay *display)
{
1290 1291
  GdkPointerGrabInfo *info;
  
1292
  g_return_val_if_fail (GDK_IS_DISPLAY (display), TRUE);
1293

1294 1295 1296 1297
  /* What we're interested in is the steady state (ie last grab),
     because we're interested e.g. if we grabbed so that we
     can ungrab, even if our grab is not active just yet. */
  info = _gdk_display_get_last_pointer_grab (display);
1298
  
1299
  return (info && !info->implicit);
1300 1301
}

1302 1303
#define __GDK_DISPLAY_C__
#include "gdkaliasdef.c"