gdk.c 31.6 KB
Newer Older
Cody Russell's avatar
Cody Russell committed
1
/* GDK - The GIMP Drawing Kit
Elliot Lee's avatar
Elliot Lee committed
2 3 4
 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
 *
 * This library is free software; you can redistribute it and/or
5
 * modify it under the terms of the GNU Lesser General Public
Elliot Lee's avatar
Elliot Lee committed
6 7 8 9 10
 * 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
11
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.	 See the GNU
12
 * Lesser General Public License for more details.
Elliot Lee's avatar
Elliot Lee committed
13
 *
14
 * You should have received a copy of the GNU Lesser General Public
15 16 17
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
Elliot Lee's avatar
Elliot Lee committed
18
 */
19 20

/*
21
 * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
22 23 24 25 26
 * file for a list of people on the GTK+ Team.  See the ChangeLog
 * files for a list of changes.  These files are distributed with
 * GTK+ at ftp://ftp.gtk.org/pub/gtk/. 
 */

27
#include "config.h"
Elliot Lee's avatar
Elliot Lee committed
28

29
#include "gdkmain.h"
Elliot Lee's avatar
Elliot Lee committed
30

31
#include "gdkinternals.h"
32
#include "gdkintl.h"
Elliot Lee's avatar
Elliot Lee committed
33

34 35 36 37
#ifndef HAVE_XCONVERTCASE
#include "gdkkeysyms.h"
#endif

38 39 40
#include <string.h>
#include <stdlib.h>

41 42 43 44 45 46 47 48 49 50 51

/**
 * SECTION:general
 * @Short_description: Library initialization and miscellaneous functions
 * @Title: General
 *
 * This section describes the GDK initialization functions and miscellaneous
 * utility functions.
 */


Elliot Lee's avatar
Elliot Lee committed
52 53 54 55 56 57 58 59
typedef struct _GdkPredicate  GdkPredicate;

struct _GdkPredicate
{
  GdkEventFunc func;
  gpointer data;
};

60 61 62 63 64 65 66 67 68 69
typedef struct _GdkThreadsDispatch GdkThreadsDispatch;

struct _GdkThreadsDispatch
{
  GSourceFunc func;
  gpointer data;
  GDestroyNotify destroy;
};


Elliot Lee's avatar
Elliot Lee committed
70 71
/* Private variable declarations
 */
72
static int gdk_initialized = 0;			    /* 1 if the library is initialized,
Elliot Lee's avatar
Elliot Lee committed
73 74 75
						     * 0 otherwise.
						     */

76 77
static gchar  *gdk_progclass = NULL;

78 79 80 81 82
static GMutex *gdk_threads_mutex = NULL;            /* Global GDK lock */

static GCallback gdk_threads_lock = NULL;
static GCallback gdk_threads_unlock = NULL;

83
#ifdef G_ENABLE_DEBUG
84
static const GDebugKey gdk_debug_keys[] = {
85 86 87
  {"events",	    GDK_DEBUG_EVENTS},
  {"misc",	    GDK_DEBUG_MISC},
  {"dnd",	    GDK_DEBUG_DND},
Jacob Berkman's avatar
Jacob Berkman committed
88 89
  {"xim",	    GDK_DEBUG_XIM},
  {"nograbs",       GDK_DEBUG_NOGRABS},
90 91 92
  {"colormap",	    GDK_DEBUG_COLORMAP},
  {"input",	    GDK_DEBUG_INPUT},
  {"cursor",	    GDK_DEBUG_CURSOR},
93
  {"multihead",	    GDK_DEBUG_MULTIHEAD},
94
  {"xinerama",	    GDK_DEBUG_XINERAMA},
95 96
  {"draw",	    GDK_DEBUG_DRAW},
  {"eventloop",	    GDK_DEBUG_EVENTLOOP}
97
};
98

99
static const int gdk_ndebug_keys = G_N_ELEMENTS (gdk_debug_keys);
100

101
#endif /* G_ENABLE_DEBUG */
Elliot Lee's avatar
Elliot Lee committed
102

103
#ifdef G_ENABLE_DEBUG
104 105
static gboolean
gdk_arg_debug_cb (const char *key, const char *value, gpointer user_data, GError **error)
106
{
107
  guint debug_value = g_parse_debug_string (value,
108 109
					    (GDebugKey *) gdk_debug_keys,
					    gdk_ndebug_keys);
110 111 112 113 114 115 116 117 118 119 120 121

  if (debug_value == 0 && value != NULL && strcmp (value, "") != 0)
    {
      g_set_error (error, 
		   G_OPTION_ERROR, G_OPTION_ERROR_FAILED,
		   _("Error parsing option --gdk-debug"));
      return FALSE;
    }

  _gdk_debug_flags |= debug_value;

  return TRUE;
122 123
}

124 125
static gboolean
gdk_arg_no_debug_cb (const char *key, const char *value, gpointer user_data, GError **error)
126
{
127 128 129 130 131 132 133 134 135 136 137 138 139 140 141
  guint debug_value = g_parse_debug_string (value,
					    (GDebugKey *) gdk_debug_keys,
					    gdk_ndebug_keys);

  if (debug_value == 0 && value != NULL && strcmp (value, "") != 0)
    {
      g_set_error (error, 
		   G_OPTION_ERROR, G_OPTION_ERROR_FAILED,
		   _("Error parsing option --gdk-no-debug"));
      return FALSE;
    }

  _gdk_debug_flags &= ~debug_value;

  return TRUE;
142
}
143
#endif /* G_ENABLE_DEBUG */
144

145 146
static gboolean
gdk_arg_class_cb (const char *key, const char *value, gpointer user_data, GError **error)
147 148
{
  gdk_set_program_class (value);
149 150

  return TRUE;
151 152
}

153 154
static gboolean
gdk_arg_name_cb (const char *key, const char *value, gpointer user_data, GError **error)
155 156 157
{
  g_set_prgname (value);

158 159
  return TRUE;
}
160

Matthias Clasen's avatar
Matthias Clasen committed
161
static const GOptionEntry gdk_args[] = {
162 163 164 165 166 167 168 169 170 171 172 173
  { "class",        0, 0,                     G_OPTION_ARG_CALLBACK, gdk_arg_class_cb,
    /* Description of --class=CLASS in --help output */        N_("Program class as used by the window manager"),
    /* Placeholder in --class=CLASS in --help output */        N_("CLASS") },
  { "name",         0, 0,                     G_OPTION_ARG_CALLBACK, gdk_arg_name_cb,
    /* Description of --name=NAME in --help output */          N_("Program name as used by the window manager"),
    /* Placeholder in --name=NAME in --help output */          N_("NAME") },
  { "display",      0, G_OPTION_FLAG_IN_MAIN, G_OPTION_ARG_STRING,   &_gdk_display_name,
    /* Description of --display=DISPLAY in --help output */    N_("X display to use"),
    /* Placeholder in --display=DISPLAY in --help output */    N_("DISPLAY") },
  { "screen",       0, 0, G_OPTION_ARG_INT,      &_gdk_screen_number,
    /* Description of --screen=SCREEN in --help output */      N_("X screen to use"),
    /* Placeholder in --screen=SCREEN in --help output */      N_("SCREEN") },
174
#ifdef G_ENABLE_DEBUG
175
  { "gdk-debug",    0, 0, G_OPTION_ARG_CALLBACK, gdk_arg_debug_cb,  
Philip Withnall's avatar
Philip Withnall committed
176
    /* Description of --gdk-debug=FLAGS in --help output */    N_("GDK debugging flags to set"),
177 178
    /* Placeholder in --gdk-debug=FLAGS in --help output */    N_("FLAGS") },
  { "gdk-no-debug", 0, 0, G_OPTION_ARG_CALLBACK, gdk_arg_no_debug_cb, 
Philip Withnall's avatar
Philip Withnall committed
179
    /* Description of --gdk-no-debug=FLAGS in --help output */ N_("GDK debugging flags to unset"),
180 181
    /* Placeholder in --gdk-no-debug=FLAGS in --help output */ N_("FLAGS") },
#endif 
182 183 184
  { NULL }
};

185
/**
186 187
 * gdk_add_option_entries_libgtk_only:
 * @group: An option group.
188
 * 
189 190
 * Appends gdk option entries to the passed in option group. This is
 * not public API and must not be used by applications.
191 192
 **/
void
193
gdk_add_option_entries_libgtk_only (GOptionGroup *group)
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
  g_option_group_add_entries (group, gdk_args);
  g_option_group_add_entries (group, _gdk_windowing_args);
}

void
gdk_pre_parse_libgtk_only (void)
{
  gdk_initialized = TRUE;

  /* We set the fallback program class here, rather than lazily in
   * gdk_get_program_class, since we don't want -name to override it.
   */
  gdk_progclass = g_strdup (g_get_prgname ());
  if (gdk_progclass && gdk_progclass[0])
    gdk_progclass[0] = g_ascii_toupper (gdk_progclass[0]);
  
#ifdef G_ENABLE_DEBUG
  {
    gchar *debug_string = getenv("GDK_DEBUG");
    if (debug_string != NULL)
      _gdk_debug_flags = g_parse_debug_string (debug_string,
					      (GDebugKey *) gdk_debug_keys,
					      gdk_ndebug_keys);
  }
#endif	/* G_ENABLE_DEBUG */

221 222 223 224 225 226 227
  if (getenv ("GDK_NATIVE_WINDOWS"))
    {
      _gdk_native_windows = TRUE;
      /* Ensure that this is not propagated
	 to spawned applications */
      g_unsetenv ("GDK_NATIVE_WINDOWS");
    }
228

229 230 231 232 233
  g_type_init ();

  /* Do any setup particular to the windowing system
   */
  _gdk_windowing_init ();  
234 235
}

236
  
237 238 239 240 241 242
/**
 * gdk_parse_args:
 * @argc: the number of command line arguments.
 * @argv: the array of command line arguments.
 * 
 * Parse command line arguments, and store for future
Owen Taylor's avatar
Owen Taylor committed
243
 * use by calls to gdk_display_open().
Elliot Lee's avatar
Elliot Lee committed
244
 *
245 246
 * Any arguments used by GDK are removed from the array and @argc and @argv are
 * updated accordingly.
Elliot Lee's avatar
Elliot Lee committed
247
 *
248 249
 * You shouldn't call this function explicitely if you are using
 * gtk_init(), gtk_init_check(), gdk_init(), or gdk_init_check().
Matthias Clasen's avatar
Matthias Clasen committed
250 251
 *
 * Since: 2.2
252 253 254
 **/
void
gdk_parse_args (int    *argc,
255
		char ***argv)
Elliot Lee's avatar
Elliot Lee committed
256
{
257 258
  GOptionContext *option_context;
  GOptionGroup *option_group;
259
  GError *error = NULL;
260

261
  if (gdk_initialized)
262
    return;
263

264
  gdk_pre_parse_libgtk_only ();
265
  
266 267 268 269 270
  option_context = g_option_context_new (NULL);
  g_option_context_set_ignore_unknown_options (option_context, TRUE);
  g_option_context_set_help_enabled (option_context, FALSE);
  option_group = g_option_group_new (NULL, NULL, NULL, NULL, NULL);
  g_option_context_set_main_group (option_context, option_group);
271
  
272 273 274
  g_option_group_add_entries (option_group, gdk_args);
  g_option_group_add_entries (option_group, _gdk_windowing_args);

Matthias Clasen's avatar
Matthias Clasen committed
275
  if (!g_option_context_parse (option_context, argc, argv, &error))
276 277 278 279
    {
      g_warning ("%s", error->message);
      g_error_free (error);
    }
280
  g_option_context_free (option_context);
281

282
  GDK_NOTE (MISC, g_message ("progname: \"%s\"", g_get_prgname ()));
283
}
284

285 286 287 288 289 290 291
/** 
 * gdk_get_display_arg_name:
 *
 * Gets the display name specified in the command line arguments passed
 * to gdk_init() or gdk_parse_args(), if any.
 *
 * Returns: the display name, if specified explicitely, otherwise %NULL
292
 *   this string is owned by GTK+ and must not be modified or freed.
Matthias Clasen's avatar
Matthias Clasen committed
293 294
 *
 * Since: 2.2
295
 */
296
G_CONST_RETURN gchar *
297 298
gdk_get_display_arg_name (void)
{
299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318
  if (!_gdk_display_arg_name)
    {
      if (_gdk_screen_number >= 0)
	_gdk_display_arg_name = _gdk_windowing_substitute_screen_number (_gdk_display_name, _gdk_screen_number);
      else
	_gdk_display_arg_name = g_strdup (_gdk_display_name);
   }

   return _gdk_display_arg_name;
}

/**
 * gdk_display_open_default_libgtk_only:
 * 
 * Opens the default display specified by command line arguments or
 * environment variables, sets it as the default display, and returns
 * it.  gdk_parse_args must have been called first. If the default
 * display has previously been set, simply returns that. An internal
 * function that should not be used by applications.
 * 
319 320
 * Return value: (transfer none): the default display, if it could be
 *   opened, otherwise %NULL.
321 322 323 324 325 326
 **/
GdkDisplay *
gdk_display_open_default_libgtk_only (void)
{
  GdkDisplay *display;

327
  g_return_val_if_fail (gdk_initialized, NULL);
328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347
  
  display = gdk_display_get_default ();
  if (display)
    return display;

  display = gdk_display_open (gdk_get_display_arg_name ());

  if (!display && _gdk_screen_number >= 0)
    {
      g_free (_gdk_display_arg_name);
      _gdk_display_arg_name = g_strdup (_gdk_display_name);
      
      display = gdk_display_open (_gdk_display_name);
    }
  
  if (display)
    gdk_display_manager_set_default_display (gdk_display_manager_get (),
					     display);
  
  return display;
348 349
}

350 351
/**
 * gdk_init_check:
352 353
 * @argc: (inout): the number of command line arguments.
 * @argv: (array length=argc) (inout): the array of command line arguments.
354
 *
355 356
 * Initializes the GDK library and connects to the X server, returning %TRUE on
 * success.
357
 *
358 359
 * Any arguments used by GDK are removed from the array and @argc and @argv are
 * updated accordingly.
360
 *
361 362
 * GTK+ initializes GDK in gtk_init() and so this function is not usually needed
 * by GTK+ applications.
363
 *
364
 * Returns: %TRUE if initialization succeeded.
365 366 367 368 369 370
 */
gboolean
gdk_init_check (int    *argc,
		char ***argv)
{
  gdk_parse_args (argc, argv);
371

372
  return gdk_display_open_default_libgtk_only () != NULL;
373 374
}

375 376 377

/**
 * gdk_init:
378 379 380 381 382 383 384 385 386 387 388 389
 * @argc: (inout): the number of command line arguments.
 * @argv: (array length=argc) (inout): the array of command line arguments.
 *
 * Initializes the GDK library and connects to the X server.
 * If initialization fails, a warning message is output and the application
 * terminates with a call to <literal>exit(1)</literal>.
 *
 * Any arguments used by GDK are removed from the array and @argc and @argv are
 * updated accordingly.
 *
 * GTK+ initializes GDK in gtk_init() and so this function is not usually needed
 * by GTK+ applications.
390
 */
391 392 393 394 395
void
gdk_init (int *argc, char ***argv)
{
  if (!gdk_init_check (argc, argv))
    {
396 397
      const char *display_name = gdk_get_display_arg_name ();
      g_warning ("cannot open display: %s", display_name ? display_name : "");
398 399
      exit(1);
    }
Elliot Lee's avatar
Elliot Lee committed
400 401
}

402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 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 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 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 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 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639


/**
 * SECTION:threads
 * @Short_description: Functions for using GDK in multi-threaded programs
 * @Title: Threads
 *
 * For thread safety, GDK relies on the thread primitives in GLib,
 * and on the thread-safe GLib main loop.
 *
 * GLib is completely thread safe (all global data is automatically
 * locked), but individual data structure instances are not automatically
 * locked for performance reasons. So e.g. you must coordinate
 * accesses to the same #GHashTable from multiple threads.
 *
 * GTK+ is "thread aware" but not thread safe &mdash; it provides a
 * global lock controlled by gdk_threads_enter()/gdk_threads_leave()
 * which protects all use of GTK+. That is, only one thread can use GTK+
 * at any given time.
 *
 * Unfortunately the above holds with the X11 backend only. With the
 * Win32 backend, GDK calls should not be attempted from multiple threads
 * at all.
 *
 * You must call g_thread_init() and gdk_threads_init() before executing
 * any other GTK+ or GDK functions in a threaded GTK+ program.
 *
 * Idles, timeouts, and input functions from GLib, such as g_idle_add(), are
 * executed outside of the main GTK+ lock.
 * So, if you need to call GTK+ inside of such a callback, you must surround
 * the callback with a gdk_threads_enter()/gdk_threads_leave() pair or use
 * gdk_threads_add_idle_full() which does this for you.
 * However, event dispatching from the mainloop is still executed within
 * the main GTK+ lock, so callback functions connected to event signals
 * like #GtkWidget::button-press-event, do not need thread protection.
 *
 * In particular, this means, if you are writing widgets that might
 * be used in threaded programs, you <emphasis>must</emphasis> surround
 * timeouts and idle functions in this matter.
 *
 * As always, you must also surround any calls to GTK+ not made within
 * a signal handler with a gdk_threads_enter()/gdk_threads_leave() pair.
 *
 * Before calling gdk_threads_leave() from a thread other
 * than your main thread, you probably want to call gdk_flush()
 * to send all pending commands to the windowing system.
 * (The reason you don't need to do this from the main thread
 * is that GDK always automatically flushes pending commands
 * when it runs out of incoming events to process and has
 * to sleep while waiting for more events.)
 *
 * A minimal main program for a threaded GTK+ application
 * looks like:
 * <informalexample>
 * <programlisting role="C">
 * int
 * main (int argc, char *argv[])
 * {
 *   GtkWidget *window;
 *
 *   g_thread_init (NULL);
 *   gdk_threads_init (<!-- -->);
 *   gdk_threads_enter (<!-- -->);
 *
 *   gtk_init (&argc, &argv);
 *
 *   window = create_window (<!-- -->);
 *   gtk_widget_show (window);
 *
 *   gtk_main (<!-- -->);
 *   gdk_threads_leave (<!-- -->);
 *
 *   return 0;
 * }
 * </programlisting>
 * </informalexample>
 *
 * Callbacks require a bit of attention. Callbacks from GTK+ signals
 * are made within the GTK+ lock. However callbacks from GLib (timeouts,
 * IO callbacks, and idle functions) are made outside of the GTK+
 * lock. So, within a signal handler you do not need to call
 * gdk_threads_enter(), but within the other types of callbacks, you
 * do.
 *
 * Erik Mouw contributed the following code example to
 * illustrate how to use threads within GTK+ programs.
 * <informalexample>
 * <programlisting role="C">
 * /<!---->*-------------------------------------------------------------------------
 *  * Filename:      gtk-thread.c
 *  * Version:       0.99.1
 *  * Copyright:     Copyright (C) 1999, Erik Mouw
 *  * Author:        Erik Mouw &lt;J.A.K.Mouw@its.tudelft.nl&gt;
 *  * Description:   GTK threads example.
 *  * Created at:    Sun Oct 17 21:27:09 1999
 *  * Modified by:   Erik Mouw &lt;J.A.K.Mouw@its.tudelft.nl&gt;
 *  * Modified at:   Sun Oct 24 17:21:41 1999
 *  *-----------------------------------------------------------------------*<!---->/
 * /<!---->*
 *  * Compile with:
 *  *
 *  * cc -o gtk-thread gtk-thread.c `gtk-config --cflags --libs gthread`
 *  *
 *  * Thanks to Sebastian Wilhelmi and Owen Taylor for pointing out some
 *  * bugs.
 *  *
 *  *<!---->/
 *
 * #include <stdio.h>
 * #include <stdlib.h>
 * #include <unistd.h>
 * #include <time.h>
 * #include <gtk/gtk.h>
 * #include <glib.h>
 * #include <pthread.h>
 *
 * #define YES_IT_IS    (1)
 * #define NO_IT_IS_NOT (0)
 *
 * typedef struct
 * {
 *   GtkWidget *label;
 *   int what;
 * } yes_or_no_args;
 *
 * G_LOCK_DEFINE_STATIC (yes_or_no);
 * static volatile int yes_or_no = YES_IT_IS;
 *
 * void destroy (GtkWidget *widget, gpointer data)
 * {
 *   gtk_main_quit (<!-- -->);
 * }
 *
 * void *argument_thread (void *args)
 * {
 *   yes_or_no_args *data = (yes_or_no_args *)args;
 *   gboolean say_something;
 *
 *   for (;;)
 *     {
 *       /<!---->* sleep a while *<!---->/
 *       sleep(rand(<!-- -->) / (RAND_MAX / 3) + 1);
 *
 *       /<!---->* lock the yes_or_no_variable *<!---->/
 *       G_LOCK(yes_or_no);
 *
 *       /<!---->* do we have to say something? *<!---->/
 *       say_something = (yes_or_no != data->what);
 *
 *       if(say_something)
 * 	{
 * 	  /<!---->* set the variable *<!---->/
 * 	  yes_or_no = data->what;
 * 	}
 *
 *       /<!---->* Unlock the yes_or_no variable *<!---->/
 *       G_UNLOCK (yes_or_no);
 *
 *       if (say_something)
 * 	{
 * 	  /<!---->* get GTK thread lock *<!---->/
 * 	  gdk_threads_enter (<!-- -->);
 *
 *	  /<!---->* set label text *<!---->/
 * 	  if(data->what == YES_IT_IS)
 * 	    gtk_label_set_text (GTK_LABEL (data->label), "O yes, it is!");
 * 	  else
 * 	    gtk_label_set_text (GTK_LABEL (data->label), "O no, it isn't!");
 *
 * 	  /<!---->* release GTK thread lock *<!---->/
 * 	  gdk_threads_leave (<!-- -->);
 * 	}
 *     }
 *
 *   return NULL;
 * }
 *
 * int main (int argc, char *argv[])
 * {
 *   GtkWidget *window;
 *   GtkWidget *label;
 *   yes_or_no_args yes_args, no_args;
 *   pthread_t no_tid, yes_tid;
 *
 *   /<!---->* init threads *<!---->/
 *   g_thread_init (NULL);
 *   gdk_threads_init (<!-- -->);
 *   gdk_threads_enter (<!-- -->);
 *
 *   /<!---->* init gtk *<!---->/
 *   gtk_init(&argc, &argv);
 *
 *   /<!---->* init random number generator *<!---->/
 *   srand ((unsigned int) time (NULL));
 *
 *   /<!---->* create a window *<!---->/
 *   window = gtk_window_new (GTK_WINDOW_TOPLEVEL);
 *
 *   g_signal_connect (window, "destroy", G_CALLBACK (destroy), NULL);
 *
 *   gtk_container_set_border_width (GTK_CONTAINER (window), 10);
 *
 *   /<!---->* create a label *<!---->/
 *   label = gtk_label_new ("And now for something completely different ...");
 *   gtk_container_add (GTK_CONTAINER (window), label);
 *
 *   /<!---->* show everything *<!---->/
 *   gtk_widget_show (label);
 *   gtk_widget_show (window);
 *
 *   /<!---->* create the threads *<!---->/
 *   yes_args.label = label;
 *   yes_args.what = YES_IT_IS;
 *   pthread_create (&yes_tid, NULL, argument_thread, &yes_args);
 *
 *   no_args.label = label;
 *   no_args.what = NO_IT_IS_NOT;
 *   pthread_create (&no_tid, NULL, argument_thread, &no_args);
 *
 *   /<!---->* enter the GTK main loop *<!---->/
 *   gtk_main (<!-- -->);
 *   gdk_threads_leave (<!-- -->);
 *
 *   return 0;
 * }
 * </programlisting>
 * </informalexample>
 */


/**
 * gdk_threads_enter:
 *
 * This macro marks the beginning of a critical section in which GDK and
 * GTK+ functions can be called safely and without causing race
 * conditions.  Only one thread at a time can be in such a critial
 * section.
 */
640
void
Matthias Clasen's avatar
Matthias Clasen committed
641
gdk_threads_enter (void)
642
{
643 644
  if (gdk_threads_lock)
    (*gdk_threads_lock) ();
645 646
}

647 648 649 650 651
/**
 * gdk_threads_leave:
 *
 * Leaves a critical region begun with gdk_threads_enter().
 */
652
void
Matthias Clasen's avatar
Matthias Clasen committed
653
gdk_threads_leave (void)
654
{
655 656
  if (gdk_threads_unlock)
    (*gdk_threads_unlock) ();
657 658
}

659 660 661 662 663 664 665 666 667 668 669 670 671 672
static void
gdk_threads_impl_lock (void)
{
  if (gdk_threads_mutex)
    g_mutex_lock (gdk_threads_mutex);
}

static void
gdk_threads_impl_unlock (void)
{
  if (gdk_threads_mutex)
    g_mutex_unlock (gdk_threads_mutex);
}

673 674
/**
 * gdk_threads_init:
675
 *
676 677
 * Initializes GDK so that it can be used from multiple threads
 * in conjunction with gdk_threads_enter() and gdk_threads_leave().
678
 * g_thread_init() must be called previous to this function.
679 680 681 682 683
 *
 * This call must be made before any use of the main loop from
 * GTK+; to be safe, call it before gtk_init().
 **/
void
Matthias Clasen's avatar
Matthias Clasen committed
684
gdk_threads_init (void)
685 686
{
  if (!g_thread_supported ())
687
    g_error ("g_thread_init() must be called before gdk_threads_init()");
688 689

  gdk_threads_mutex = g_mutex_new ();
690 691 692 693 694 695 696 697
  if (!gdk_threads_lock)
    gdk_threads_lock = gdk_threads_impl_lock;
  if (!gdk_threads_unlock)
    gdk_threads_unlock = gdk_threads_impl_unlock;
}

/**
 * gdk_threads_set_lock_functions:
Matthias Clasen's avatar
Matthias Clasen committed
698
 * @enter_fn:   function called to guard GDK
699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719
 * @leave_fn: function called to release the guard
 *
 * Allows the application to replace the standard method that
 * GDK uses to protect its data structures. Normally, GDK
 * creates a single #GMutex that is locked by gdk_threads_enter(),
 * and released by gdk_threads_leave(); using this function an
 * application provides, instead, a function @enter_fn that is
 * called by gdk_threads_enter() and a function @leave_fn that is
 * called by gdk_threads_leave().
 *
 * The functions must provide at least same locking functionality
 * as the default implementation, but can also do extra application
 * specific processing.
 *
 * As an example, consider an application that has its own recursive
 * lock that when held, holds the GTK+ lock as well. When GTK+ unlocks
 * the GTK+ lock when entering a recursive main loop, the application
 * must temporarily release its lock as well.
 *
 * Most threaded GTK+ apps won't need to use this method.
 *
Matthias Clasen's avatar
Matthias Clasen committed
720
 * This method must be called before gdk_threads_init(), and cannot
721
 * be called multiple times.
Matthias Clasen's avatar
Matthias Clasen committed
722 723
 *
 * Since: 2.4
724 725 726 727 728 729 730 731 732 733
 **/
void
gdk_threads_set_lock_functions (GCallback enter_fn,
				GCallback leave_fn)
{
  g_return_if_fail (gdk_threads_lock == NULL &&
		    gdk_threads_unlock == NULL);

  gdk_threads_lock = enter_fn;
  gdk_threads_unlock = leave_fn;
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
static gboolean
gdk_threads_dispatch (gpointer data)
{
  GdkThreadsDispatch *dispatch = data;
  gboolean ret = FALSE;

  GDK_THREADS_ENTER ();

  if (!g_source_is_destroyed (g_main_current_source ()))
    ret = dispatch->func (dispatch->data);

  GDK_THREADS_LEAVE ();

  return ret;
}

static void
gdk_threads_dispatch_free (gpointer data)
{
  GdkThreadsDispatch *dispatch = data;

  if (dispatch->destroy && dispatch->data)
    dispatch->destroy (dispatch->data);

  g_slice_free (GdkThreadsDispatch, data);
}


/**
 * gdk_threads_add_idle_full:
 * @priority: the priority of the idle source. Typically this will be in the
 *            range btweeen #G_PRIORITY_DEFAULT_IDLE and #G_PRIORITY_HIGH_IDLE
 * @function: function to call
 * @data:     data to pass to @function
Johan Dahlin's avatar
Johan Dahlin committed
770
 * @notify: (allow-none):   function to call when the idle is removed, or %NULL
771 772 773 774 775 776 777 778 779 780 781
 *
 * Adds a function to be called whenever there are no higher priority
 * events pending.  If the function returns %FALSE it is automatically
 * removed from the list of event sources and will not be called again.
 *
 * This variant of g_idle_add_full() calls @function with the GDK lock
 * held. It can be thought of a MT-safe version for GTK+ widgets for the 
 * following use case, where you have to worry about idle_callback()
 * running in thread A and accessing @self after it has been finalized
 * in thread B:
 *
Matthias Clasen's avatar
Matthias Clasen committed
782
 * |[
Tim Janik's avatar
Tim Janik committed
783 784
 * static gboolean
 * idle_callback (gpointer data)
785
 * {
Matthias Clasen's avatar
Matthias Clasen committed
786
 *    /&ast; gdk_threads_enter(); would be needed for g_idle_add() &ast;/
Tim Janik's avatar
Tim Janik committed
787
 *
788
 *    SomeWidget *self = data;
Matthias Clasen's avatar
Matthias Clasen committed
789
 *    /&ast; do stuff with self &ast;/
Tim Janik's avatar
Tim Janik committed
790
 *
791
 *    self->idle_id = 0;
Tim Janik's avatar
Tim Janik committed
792
 *
Matthias Clasen's avatar
Matthias Clasen committed
793
 *    /&ast; gdk_threads_leave(); would be needed for g_idle_add() &ast;/
794 795
 *    return FALSE;
 * }
Tim Janik's avatar
Tim Janik committed
796 797 798
 *
 * static void
 * some_widget_do_stuff_later (SomeWidget *self)
799
 * {
Tim Janik's avatar
Tim Janik committed
800
 *    self->idle_id = gdk_threads_add_idle (idle_callback, self)
Matthias Clasen's avatar
Matthias Clasen committed
801
 *    /&ast; using g_idle_add() here would require thread protection in the callback &ast;/
802
 * }
Tim Janik's avatar
Tim Janik committed
803 804 805
 *
 * static void
 * some_widget_finalize (GObject *object)
806
 * {
Tim Janik's avatar
Tim Janik committed
807
 *    SomeWidget *self = SOME_WIDGET (object);
808 809 810 811
 *    if (self->idle_id)
 *      g_source_remove (self->idle_id);
 *    G_OBJECT_CLASS (parent_class)->finalize (object);
 * }
Matthias Clasen's avatar
Matthias Clasen committed
812
 * ]|
Tim Janik's avatar
Tim Janik committed
813
 *
814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833
 * Return value: the ID (greater than 0) of the event source.
 *
 * Since: 2.12
 */
guint
gdk_threads_add_idle_full (gint           priority,
		           GSourceFunc    function,
		           gpointer       data,
		           GDestroyNotify notify)
{
  GdkThreadsDispatch *dispatch;

  g_return_val_if_fail (function != NULL, 0);

  dispatch = g_slice_new (GdkThreadsDispatch);
  dispatch->func = function;
  dispatch->data = data;
  dispatch->destroy = notify;

  return g_idle_add_full (priority,
Tim Janik's avatar
Tim Janik committed
834 835
                          gdk_threads_dispatch,
                          dispatch,
836 837 838 839 840 841 842 843 844 845 846 847
                          gdk_threads_dispatch_free);
}

/**
 * gdk_threads_add_idle:
 * @function: function to call
 * @data:     data to pass to @function
 *
 * A wrapper for the common usage of gdk_threads_add_idle_full() 
 * assigning the default priority, #G_PRIORITY_DEFAULT_IDLE.
 *
 * See gdk_threads_add_idle_full().
Matthias Clasen's avatar
Matthias Clasen committed
848 849
 *
 * Return value: the ID (greater than 0) of the event source.
850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869
 * 
 * Since: 2.12
 */
guint
gdk_threads_add_idle (GSourceFunc    function,
		      gpointer       data)
{
  return gdk_threads_add_idle_full (G_PRIORITY_DEFAULT_IDLE,
                                    function, data, NULL);
}


/**
 * gdk_threads_add_timeout_full:
 * @priority: the priority of the timeout source. Typically this will be in the
 *            range between #G_PRIORITY_DEFAULT_IDLE and #G_PRIORITY_HIGH_IDLE.
 * @interval: the time between calls to the function, in milliseconds
 *             (1/1000ths of a second)
 * @function: function to call
 * @data:     data to pass to @function
Johan Dahlin's avatar
Johan Dahlin committed
870
 * @notify: (allow-none):   function to call when the timeout is removed, or %NULL
871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887
 *
 * Sets a function to be called at regular intervals holding the GDK lock,
 * with the given priority.  The function is called repeatedly until it 
 * returns %FALSE, at which point the timeout is automatically destroyed 
 * and the function will not be called again.  The @notify function is
 * called when the timeout is destroyed.  The first call to the
 * function will be at the end of the first @interval.
 *
 * Note that timeout functions may be delayed, due to the processing of other
 * event sources. Thus they should not be relied on for precise timing.
 * After each call to the timeout function, the time of the next
 * timeout is recalculated based on the current time and the given interval
 * (it does not try to 'catch up' time lost in delays).
 *
 * This variant of g_timeout_add_full() can be thought of a MT-safe version 
 * for GTK+ widgets for the following use case:
 *
Matthias Clasen's avatar
Matthias Clasen committed
888
 * |[
889 890 891
 * static gboolean timeout_callback (gpointer data)
 * {
 *    SomeWidget *self = data;
892
 *    
Matthias Clasen's avatar
Matthias Clasen committed
893
 *    /&ast; do stuff with self &ast;/
894
 *    
895
 *    self->timeout_id = 0;
896
 *    
897 898
 *    return FALSE;
 * }
899
 *  
900 901 902 903
 * static void some_widget_do_stuff_later (SomeWidget *self)
 * {
 *    self->timeout_id = g_timeout_add (timeout_callback, self)
 * }
904
 *  
905 906
 * static void some_widget_finalize (GObject *object)
 * {
Matthias Clasen's avatar
Matthias Clasen committed
907
 *    SomeWidget *self = SOME_WIDGET (object);
908
 *    
909 910
 *    if (self->timeout_id)
 *      g_source_remove (self->timeout_id);
911
 *    
912 913
 *    G_OBJECT_CLASS (parent_class)->finalize (object);
 * }
Matthias Clasen's avatar
Matthias Clasen committed
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 946 947 948 949 950 951 952 953
 *
 * Return value: the ID (greater than 0) of the event source.
 * 
 * Since: 2.12
 */
guint
gdk_threads_add_timeout_full (gint           priority,
                              guint          interval,
                              GSourceFunc    function,
                              gpointer       data,
                              GDestroyNotify notify)
{
  GdkThreadsDispatch *dispatch;

  g_return_val_if_fail (function != NULL, 0);

  dispatch = g_slice_new (GdkThreadsDispatch);
  dispatch->func = function;
  dispatch->data = data;
  dispatch->destroy = notify;

  return g_timeout_add_full (priority, 
                             interval,
                             gdk_threads_dispatch, 
                             dispatch, 
                             gdk_threads_dispatch_free);
}

/**
 * gdk_threads_add_timeout:
 * @interval: the time between calls to the function, in milliseconds
 *             (1/1000ths of a second)
 * @function: function to call
 * @data:     data to pass to @function
 *
 * A wrapper for the common usage of gdk_threads_add_timeout_full() 
 * assigning the default priority, #G_PRIORITY_DEFAULT.
 *
 * See gdk_threads_add_timeout_full().
Matthias Clasen's avatar
Matthias Clasen committed
954 955
 * 
 * Return value: the ID (greater than 0) of the event source.
956 957 958 959 960 961 962 963 964 965 966 967 968
 *
 * Since: 2.12
 */
guint
gdk_threads_add_timeout (guint       interval,
                         GSourceFunc function,
                         gpointer    data)
{
  return gdk_threads_add_timeout_full (G_PRIORITY_DEFAULT,
                                       interval, function, data, NULL);
}


969 970 971 972 973 974 975
/**
 * gdk_threads_add_timeout_seconds_full:
 * @priority: the priority of the timeout source. Typically this will be in the
 *            range between #G_PRIORITY_DEFAULT_IDLE and #G_PRIORITY_HIGH_IDLE.
 * @interval: the time between calls to the function, in seconds
 * @function: function to call
 * @data:     data to pass to @function
Johan Dahlin's avatar
Johan Dahlin committed
976
 * @notify: (allow-none):   function to call when the timeout is removed, or %NULL
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 1029 1030 1031 1032
 *
 * A variant of gdk_threads_add_timout_full() with second-granularity.
 * See g_timeout_add_seconds_full() for a discussion of why it is
 * a good idea to use this function if you don't need finer granularity.
 *
 *  Return value: the ID (greater than 0) of the event source.
 * 
 * Since: 2.14
 */
guint
gdk_threads_add_timeout_seconds_full (gint           priority,
                                      guint          interval,
                                      GSourceFunc    function,
                                      gpointer       data,
                                      GDestroyNotify notify)
{
  GdkThreadsDispatch *dispatch;

  g_return_val_if_fail (function != NULL, 0);

  dispatch = g_slice_new (GdkThreadsDispatch);
  dispatch->func = function;
  dispatch->data = data;
  dispatch->destroy = notify;

  return g_timeout_add_seconds_full (priority, 
                                     interval,
                                     gdk_threads_dispatch, 
                                     dispatch, 
                                     gdk_threads_dispatch_free);
}

/**
 * gdk_threads_add_timeout_seconds:
 * @interval: the time between calls to the function, in seconds
 * @function: function to call
 * @data:     data to pass to @function
 *
 * A wrapper for the common usage of gdk_threads_add_timeout_seconds_full() 
 * assigning the default priority, #G_PRIORITY_DEFAULT.
 *
 * For details, see gdk_threads_add_timeout_full().
 * 
 * Return value: the ID (greater than 0) of the event source.
 *
 * Since: 2.14
 */
guint
gdk_threads_add_timeout_seconds (guint       interval,
                                 GSourceFunc function,
                                 gpointer    data)
{
  return gdk_threads_add_timeout_seconds_full (G_PRIORITY_DEFAULT,
                                               interval, function, data, NULL);
}

1033 1034 1035 1036 1037 1038 1039 1040 1041 1042
/**
 * gdk_get_program_class:
 *
 * Gets the program class. Unless the program class has explicitly
 * been set with gdk_set_program_class() or with the <option>--class</option>
 * commandline option, the default value is the program name (determined
 * with g_get_prgname()) with the first character converted to uppercase.
 *
 * Returns: the program class.
 */
1043 1044 1045 1046 1047 1048
G_CONST_RETURN char *
gdk_get_program_class (void)
{
  return gdk_progclass;
}

1049 1050 1051 1052 1053 1054 1055 1056
/**
 * gdk_set_program_class:
 * @program_class: a string.
 *
 * Sets the program class. The X11 backend uses the program class to set
 * the class name part of the <literal>WM_CLASS</literal> property on
 * toplevel windows; see the ICCCM.
 */
1057 1058 1059
void
gdk_set_program_class (const char *program_class)
{
1060
  g_free (gdk_progclass);
1061 1062 1063

  gdk_progclass = g_strdup (program_class);
}
1064

1065
/**
Carlos Garnacho's avatar
Carlos Garnacho committed
1066
 * gdk_disable_multidevice:
1067
 *
Carlos Garnacho's avatar
Carlos Garnacho committed
1068
 * Disables multidevice support in GDK. This call must happen prior
1069 1070 1071
 * to gdk_display_open(), gtk_init(), gtk_init_with_args() or
 * gtk_init_check() in order to take effect.
 *
Carlos Garnacho's avatar
Carlos Garnacho committed
1072 1073 1074 1075
 * Most common GTK+ applications won't ever need to call this. Only
 * applications that do mixed GDK/Xlib calls could want to disable
 * multidevice support if such Xlib code deals with input devices in
 * any way and doesn't observe the presence of XInput 2.
1076 1077 1078 1079
 *
 * Since: 3.0
 **/
void
Carlos Garnacho's avatar
Carlos Garnacho committed
1080
gdk_disable_multidevice (void)
1081 1082 1083 1084
{
  if (gdk_initialized)
    return;

Carlos Garnacho's avatar
Carlos Garnacho committed
1085
  _gdk_disable_multidevice = TRUE;
1086
}