gdk.c 32.3 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

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

Matthias Clasen's avatar
Matthias Clasen committed
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 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95
/**
 * GDK_WINDOWING_X11:
 *
 * The #GDK_WINDOWING_X11 macro is defined if the X11 backend
 * is supported.
 *
 * Use this macro to guard code that is specific to the X11-backend.
 * Since GDK may be configured with multiple backends, an additional
 * runtime check for the used backend is recommended:
 * </para>
 * <example>
 * <title>Backend-specific code</title>
 * <programlisting>
 * #ifdef GDK_WINDOWING_X11
 *   if (GDK_IS_X11_DISPLAY (display))
 *     {
 *       /&ast; make X11-specific calls here &ast;/
 *     }
 *   else
 * #endif
 * #ifdef GDK_WINDOWING_QUARTZ
 *   if (GDK_IS_QUARTZ_DISPLAY (display))
 *     {
 *       /&ast; make Quartz-specific calls here &ast/
 *     }
 *   else
 * #endif
 *   g_error ("Unsupported GDK backend");
 * </programlisting>
 * </example>
 */

/**
 * GDK_WINDOWING_WIN32:
 *
 * The #GDK_WINDOWING_WIN32 macro is defined if the Win32 backend
 * is supported.
 */

/**
 * GDK_WINDOWING_QUARTZ:
 *
 * The #GDK_WINDOWING_QUARTZ macro is defined if the Quartz backend
 * is supported.
 */
96

Elliot Lee's avatar
Elliot Lee committed
97 98 99 100 101 102 103 104
typedef struct _GdkPredicate  GdkPredicate;

struct _GdkPredicate
{
  GdkEventFunc func;
  gpointer data;
};

105 106 107 108 109 110 111 112 113 114
typedef struct _GdkThreadsDispatch GdkThreadsDispatch;

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


Elliot Lee's avatar
Elliot Lee committed
115 116
/* Private variable declarations
 */
117 118 119
static int gdk_initialized = 0;                     /* 1 if the library is initialized,
                                                     * 0 otherwise.
                                                     */
Elliot Lee's avatar
Elliot Lee committed
120

121 122
static gchar  *gdk_progclass = NULL;

123 124 125 126 127
static GMutex *gdk_threads_mutex = NULL;            /* Global GDK lock */

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

128
#ifdef G_ENABLE_DEBUG
129
static const GDebugKey gdk_debug_keys[] = {
130 131 132 133
  {"events",        GDK_DEBUG_EVENTS},
  {"misc",          GDK_DEBUG_MISC},
  {"dnd",           GDK_DEBUG_DND},
  {"xim",           GDK_DEBUG_XIM},
Jacob Berkman's avatar
Jacob Berkman committed
134
  {"nograbs",       GDK_DEBUG_NOGRABS},
135 136 137 138 139 140 141
  {"colormap",      GDK_DEBUG_COLORMAP},
  {"input",         GDK_DEBUG_INPUT},
  {"cursor",        GDK_DEBUG_CURSOR},
  {"multihead",     GDK_DEBUG_MULTIHEAD},
  {"xinerama",      GDK_DEBUG_XINERAMA},
  {"draw",          GDK_DEBUG_DRAW},
  {"eventloop",     GDK_DEBUG_EVENTLOOP}
142
};
143

144 145
static gboolean
gdk_arg_debug_cb (const char *key, const char *value, gpointer user_data, GError **error)
146
{
147
  guint debug_value = g_parse_debug_string (value,
148 149
                                            (GDebugKey *) gdk_debug_keys,
                                            G_N_ELEMENTS (gdk_debug_keys));
150 151 152

  if (debug_value == 0 && value != NULL && strcmp (value, "") != 0)
    {
153 154 155
      g_set_error (error,
                   G_OPTION_ERROR, G_OPTION_ERROR_FAILED,
                   _("Error parsing option --gdk-debug"));
156 157 158 159 160 161
      return FALSE;
    }

  _gdk_debug_flags |= debug_value;

  return TRUE;
162 163
}

164 165
static gboolean
gdk_arg_no_debug_cb (const char *key, const char *value, gpointer user_data, GError **error)
166
{
167
  guint debug_value = g_parse_debug_string (value,
168 169
                                            (GDebugKey *) gdk_debug_keys,
                                            G_N_ELEMENTS (gdk_debug_keys));
170 171 172

  if (debug_value == 0 && value != NULL && strcmp (value, "") != 0)
    {
173 174 175
      g_set_error (error,
                   G_OPTION_ERROR, G_OPTION_ERROR_FAILED,
                   _("Error parsing option --gdk-no-debug"));
176 177 178 179 180 181
      return FALSE;
    }

  _gdk_debug_flags &= ~debug_value;

  return TRUE;
182
}
183
#endif /* G_ENABLE_DEBUG */
184

185 186
static gboolean
gdk_arg_class_cb (const char *key, const char *value, gpointer user_data, GError **error)
187 188
{
  gdk_set_program_class (value);
189 190

  return TRUE;
191 192
}

193 194
static gboolean
gdk_arg_name_cb (const char *key, const char *value, gpointer user_data, GError **error)
195 196 197
{
  g_set_prgname (value);

198 199
  return TRUE;
}
200

Matthias Clasen's avatar
Matthias Clasen committed
201
static const GOptionEntry gdk_args[] = {
202 203 204 205 206 207 208 209 210
  { "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") },
211
#ifdef G_ENABLE_DEBUG
212
  { "gdk-debug",    0, 0, G_OPTION_ARG_CALLBACK, gdk_arg_debug_cb,  
Philip Withnall's avatar
Philip Withnall committed
213
    /* Description of --gdk-debug=FLAGS in --help output */    N_("GDK debugging flags to set"),
214 215
    /* 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
216
    /* Description of --gdk-no-debug=FLAGS in --help output */ N_("GDK debugging flags to unset"),
217 218
    /* Placeholder in --gdk-no-debug=FLAGS in --help output */ N_("FLAGS") },
#endif 
219 220 221
  { NULL }
};

222
/**
223 224
 * gdk_add_option_entries_libgtk_only:
 * @group: An option group.
225
 *
226 227
 * Appends gdk option entries to the passed in option group. This is
 * not public API and must not be used by applications.
228
 */
229
void
230
gdk_add_option_entries_libgtk_only (GOptionGroup *group)
231
{
232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251
  g_option_group_add_entries (group, gdk_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,
252 253
                                              (GDebugKey *) gdk_debug_keys,
                                              G_N_ELEMENTS (gdk_debug_keys));
254
  }
255
#endif  /* G_ENABLE_DEBUG */
256

257 258 259
  if (getenv ("GDK_NATIVE_WINDOWS"))
    {
      _gdk_native_windows = TRUE;
Matthias Clasen's avatar
Matthias Clasen committed
260
      /* Ensure that this is not propagated to spawned applications */
261 262
      g_unsetenv ("GDK_NATIVE_WINDOWS");
    }
263

264 265
  g_type_init ();

266 267
  /* Do any setup particular to the windowing system */
  gdk_display_manager_get ();
268 269
}

270
  
271 272 273 274 275 276
/**
 * 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
277
 * use by calls to gdk_display_open().
Elliot Lee's avatar
Elliot Lee committed
278
 *
279 280
 * Any arguments used by GDK are removed from the array and @argc and @argv are
 * updated accordingly.
Elliot Lee's avatar
Elliot Lee committed
281
 *
282 283
 * 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
284 285
 *
 * Since: 2.2
286 287 288
 **/
void
gdk_parse_args (int    *argc,
289
                char ***argv)
Elliot Lee's avatar
Elliot Lee committed
290
{
291 292
  GOptionContext *option_context;
  GOptionGroup *option_group;
293
  GError *error = NULL;
294

295
  if (gdk_initialized)
296
    return;
297

298
  gdk_pre_parse_libgtk_only ();
299

300 301 302 303 304
  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);
305

306 307
  g_option_group_add_entries (option_group, gdk_args);

Matthias Clasen's avatar
Matthias Clasen committed
308
  if (!g_option_context_parse (option_context, argc, argv, &error))
309 310 311 312
    {
      g_warning ("%s", error->message);
      g_error_free (error);
    }
313
  g_option_context_free (option_context);
314

315
  GDK_NOTE (MISC, g_message ("progname: \"%s\"", g_get_prgname ()));
316
}
317

318
/**
319 320 321 322 323 324
 * 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
325
 *   this string is owned by GTK+ and must not be modified or freed.
Matthias Clasen's avatar
Matthias Clasen committed
326 327
 *
 * Since: 2.2
328
 */
329
G_CONST_RETURN gchar *
330 331
gdk_get_display_arg_name (void)
{
332
  if (!_gdk_display_arg_name)
333
    _gdk_display_arg_name = g_strdup (_gdk_display_name);
334 335 336 337 338 339

   return _gdk_display_arg_name;
}

/**
 * gdk_display_open_default_libgtk_only:
340
 *
341 342 343 344 345
 * 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.
346
 *
347 348
 * Return value: (transfer none): the default display, if it could be
 *   opened, otherwise %NULL.
349 350 351 352 353 354
 **/
GdkDisplay *
gdk_display_open_default_libgtk_only (void)
{
  GdkDisplay *display;

355
  g_return_val_if_fail (gdk_initialized, NULL);
356

357 358 359 360 361 362 363
  display = gdk_display_get_default ();
  if (display)
    return display;

  display = gdk_display_open (gdk_get_display_arg_name ());

  return display;
364 365
}

366 367
/**
 * gdk_init_check:
368 369
 * @argc: (inout): the number of command line arguments.
 * @argv: (array length=argc) (inout): the array of command line arguments.
370
 *
Matthias Clasen's avatar
Matthias Clasen committed
371 372
 * Initializes the GDK library and connects to the windowing system,
 * returning %TRUE on success.
373
 *
Matthias Clasen's avatar
Matthias Clasen committed
374 375
 * Any arguments used by GDK are removed from the array and @argc and @argv
 * are updated accordingly.
376
 *
Matthias Clasen's avatar
Matthias Clasen committed
377 378
 * GTK+ initializes GDK in gtk_init() and so this function is not usually
 * needed by GTK+ applications.
379
 *
380
 * Returns: %TRUE if initialization succeeded.
381 382 383
 */
gboolean
gdk_init_check (int    *argc,
384
                char ***argv)
385 386
{
  gdk_parse_args (argc, argv);
387

388
  return gdk_display_open_default_libgtk_only () != NULL;
389 390
}

391 392 393

/**
 * gdk_init:
394 395 396
 * @argc: (inout): the number of command line arguments.
 * @argv: (array length=argc) (inout): the array of command line arguments.
 *
Matthias Clasen's avatar
Matthias Clasen committed
397
 * Initializes the GDK library and connects to the windowing system.
398 399 400
 * If initialization fails, a warning message is output and the application
 * terminates with a call to <literal>exit(1)</literal>.
 *
Matthias Clasen's avatar
Matthias Clasen committed
401 402
 * Any arguments used by GDK are removed from the array and @argc and @argv
 * are updated accordingly.
403
 *
Matthias Clasen's avatar
Matthias Clasen committed
404 405
 * GTK+ initializes GDK in gtk_init() and so this function is not usually
 * needed by GTK+ applications.
406
 */
407 408 409 410 411
void
gdk_init (int *argc, char ***argv)
{
  if (!gdk_init_check (argc, argv))
    {
412 413
      const char *display_name = gdk_get_display_arg_name ();
      g_warning ("cannot open display: %s", display_name ? display_name : "");
414 415
      exit(1);
    }
Elliot Lee's avatar
Elliot Lee committed
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


/**
 * 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)
568 569 570 571
 *      {
 *        /<!---->* set the variable *<!---->/
 *        yes_or_no = data->what;
 *      }
572 573 574 575 576
 *
 *       /<!---->* Unlock the yes_or_no variable *<!---->/
 *       G_UNLOCK (yes_or_no);
 *
 *       if (say_something)
577 578 579 580 581 582 583 584 585 586 587 588 589
 *      {
 *        /<!---->* 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 (<!-- -->);
 *      }
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 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655
 *     }
 *
 *   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.
 */
656
void
Matthias Clasen's avatar
Matthias Clasen committed
657
gdk_threads_enter (void)
658
{
659 660
  if (gdk_threads_lock)
    (*gdk_threads_lock) ();
661 662
}

663 664 665 666 667
/**
 * gdk_threads_leave:
 *
 * Leaves a critical region begun with gdk_threads_enter().
 */
668
void
Matthias Clasen's avatar
Matthias Clasen committed
669
gdk_threads_leave (void)
670
{
671 672
  if (gdk_threads_unlock)
    (*gdk_threads_unlock) ();
673 674
}

675 676 677 678 679 680 681 682 683 684 685 686 687 688
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);
}

689 690
/**
 * gdk_threads_init:
691
 *
692 693
 * Initializes GDK so that it can be used from multiple threads
 * in conjunction with gdk_threads_enter() and gdk_threads_leave().
694
 * g_thread_init() must be called previous to this function.
695 696 697 698 699
 *
 * 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
700
gdk_threads_init (void)
701 702
{
  if (!g_thread_supported ())
703
    g_error ("g_thread_init() must be called before gdk_threads_init()");
704 705

  gdk_threads_mutex = g_mutex_new ();
706 707 708 709 710 711 712 713
  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
714
 * @enter_fn:   function called to guard GDK
715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735
 * @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
736
 * This method must be called before gdk_threads_init(), and cannot
737
 * be called multiple times.
Matthias Clasen's avatar
Matthias Clasen committed
738 739
 *
 * Since: 2.4
740 741 742
 **/
void
gdk_threads_set_lock_functions (GCallback enter_fn,
743
                                GCallback leave_fn)
744 745
{
  g_return_if_fail (gdk_threads_lock == NULL &&
746
                    gdk_threads_unlock == NULL);
747 748 749

  gdk_threads_lock = enter_fn;
  gdk_threads_unlock = leave_fn;
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
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
786
 * @notify: (allow-none):   function to call when the idle is removed, or %NULL
787 788 789 790 791 792 793 794 795 796 797
 *
 * 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
798
 * |[
Tim Janik's avatar
Tim Janik committed
799 800
 * static gboolean
 * idle_callback (gpointer data)
801
 * {
Matthias Clasen's avatar
Matthias Clasen committed
802
 *    /&ast; gdk_threads_enter(); would be needed for g_idle_add() &ast;/
Tim Janik's avatar
Tim Janik committed
803
 *
804
 *    SomeWidget *self = data;
Matthias Clasen's avatar
Matthias Clasen committed
805
 *    /&ast; do stuff with self &ast;/
Tim Janik's avatar
Tim Janik committed
806
 *
807
 *    self->idle_id = 0;
Tim Janik's avatar
Tim Janik committed
808
 *
Matthias Clasen's avatar
Matthias Clasen committed
809
 *    /&ast; gdk_threads_leave(); would be needed for g_idle_add() &ast;/
810 811
 *    return FALSE;
 * }
Tim Janik's avatar
Tim Janik committed
812 813 814
 *
 * static void
 * some_widget_do_stuff_later (SomeWidget *self)
815
 * {
Tim Janik's avatar
Tim Janik committed
816
 *    self->idle_id = gdk_threads_add_idle (idle_callback, self)
Matthias Clasen's avatar
Matthias Clasen committed
817
 *    /&ast; using g_idle_add() here would require thread protection in the callback &ast;/
818
 * }
Tim Janik's avatar
Tim Janik committed
819 820 821
 *
 * static void
 * some_widget_finalize (GObject *object)
822
 * {
Tim Janik's avatar
Tim Janik committed
823
 *    SomeWidget *self = SOME_WIDGET (object);
824 825 826 827
 *    if (self->idle_id)
 *      g_source_remove (self->idle_id);
 *    G_OBJECT_CLASS (parent_class)->finalize (object);
 * }
Matthias Clasen's avatar
Matthias Clasen committed
828
 * ]|
Tim Janik's avatar
Tim Janik committed
829
 *
830 831 832 833 834 835
 * Return value: the ID (greater than 0) of the event source.
 *
 * Since: 2.12
 */
guint
gdk_threads_add_idle_full (gint           priority,
836 837 838
                           GSourceFunc    function,
                           gpointer       data,
                           GDestroyNotify notify)
839 840 841 842 843 844 845 846 847 848 849
{
  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
850 851
                          gdk_threads_dispatch,
                          dispatch,
852 853 854 855 856 857 858 859 860 861 862 863
                          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
864 865
 *
 * Return value: the ID (greater than 0) of the event source.
866 867 868 869 870
 * 
 * Since: 2.12
 */
guint
gdk_threads_add_idle (GSourceFunc    function,
871
                      gpointer       data)
872 873 874 875 876 877 878 879 880 881 882 883 884 885
{
  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
886
 * @notify: (allow-none):   function to call when the timeout is removed, or %NULL
887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903
 *
 * 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
904
 * |[
905 906 907
 * static gboolean timeout_callback (gpointer data)
 * {
 *    SomeWidget *self = data;
908
 *    
Matthias Clasen's avatar
Matthias Clasen committed
909
 *    /&ast; do stuff with self &ast;/
910
 *    
911
 *    self->timeout_id = 0;
912
 *    
913 914
 *    return FALSE;
 * }
915
 *  
916 917 918 919
 * static void some_widget_do_stuff_later (SomeWidget *self)
 * {
 *    self->timeout_id = g_timeout_add (timeout_callback, self)
 * }
920
 *  
921 922
 * static void some_widget_finalize (GObject *object)
 * {
Matthias Clasen's avatar
Matthias Clasen committed
923
 *    SomeWidget *self = SOME_WIDGET (object);
924
 *    
925 926
 *    if (self->timeout_id)
 *      g_source_remove (self->timeout_id);
927
 *    
928 929
 *    G_OBJECT_CLASS (parent_class)->finalize (object);
 * }
Matthias Clasen's avatar
Matthias Clasen committed
930
 * ]|
931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969
 *
 * 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
970 971
 * 
 * Return value: the ID (greater than 0) of the event source.
972 973 974 975 976 977 978 979 980 981 982 983 984
 *
 * 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);
}


985 986 987 988 989 990 991
/**
 * 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
992
 * @notify: (allow-none):   function to call when the timeout is removed, or %NULL
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 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048
 *
 * 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);
}

1049 1050 1051 1052 1053 1054 1055 1056 1057 1058
/**
 * 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.
 */
1059 1060 1061 1062 1063 1064
G_CONST_RETURN char *
gdk_get_program_class (void)
{
  return gdk_progclass;
}

1065 1066 1067 1068 1069 1070 1071 1072
/**
 * 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.
 */
1073 1074 1075
void
gdk_set_program_class (const char *program_class)
{
1076
  g_free (gdk_progclass);
1077 1078 1079

  gdk_progclass = g_strdup (program_class);
}
1080

1081
/**
Carlos Garnacho's avatar
Carlos Garnacho committed
1082
 * gdk_disable_multidevice:
1083
 *
Carlos Garnacho's avatar
Carlos Garnacho committed
1084
 * Disables multidevice support in GDK. This call must happen prior
1085 1086 1087
 * 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
1088 1089 1090 1091
 * 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.
1092 1093 1094 1095
 *
 * Since: 3.0
 **/
void
Carlos Garnacho's avatar
Carlos Garnacho committed
1096
gdk_disable_multidevice (void)
1097 1098 1099 1100
{
  if (gdk_initialized)
    return;

Carlos Garnacho's avatar
Carlos Garnacho committed
1101
  _gdk_disable_multidevice = TRUE;
1102
}