gdk.c 32.1 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
Javier Jardón's avatar
Javier Jardón committed
15
 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
Elliot Lee's avatar
Elliot Lee committed
16
 */
17 18

/*
19
 * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
20 21 22 23 24
 * 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/. 
 */

25
#include "config.h"
Elliot Lee's avatar
Elliot Lee committed
26

27
#include "gdkversionmacros.h"
28
#include "gdkmain.h"
Elliot Lee's avatar
Elliot Lee committed
29

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

33 34
#include "gdkresources.h"

35 36
#include "gdk-private.h"

37 38 39 40
#ifndef HAVE_XCONVERTCASE
#include "gdkkeysyms.h"
#endif

41 42 43
#include <string.h>
#include <stdlib.h>

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
51 52 53 54 55 56 57 58 59 60 61 62 63
 * utility functions, as well as deprecation facilities.
 *
 * The GDK and GTK+ headers annotate deprecated APIs in a way that produces
 * compiler warnings if these deprecated APIs are used. The warnings
 * can be turned off by defining the macro %GDK_DISABLE_DEPRECATION_WARNINGS
 * before including the glib.h header.
 *
 * GDK and GTK+ also provide support for building applications against
 * defined subsets of deprecated or new APIs. Define the macro
 * %GDK_VERSION_MIN_REQUIRED to specify up to what version
 * you want to receive warnings about deprecated APIs. Define the
 * macro %GDK_VERSION_MAX_ALLOWED to specify the newest version
 * whose API you want to use.
64 65
 */

66 67 68 69 70 71
/**
 * GDK_WINDOWING_X11:
 *
 * The #GDK_WINDOWING_X11 macro is defined if the X11 backend
 * is supported.
 *
72
 * Use this macro to guard code that is specific to the X11 backend.
73 74 75 76 77 78 79
 */

/**
 * GDK_WINDOWING_WIN32:
 *
 * The #GDK_WINDOWING_WIN32 macro is defined if the Win32 backend
 * is supported.
80 81
 *
 * Use this macro to guard code that is specific to the Win32 backend.
82 83 84 85 86 87 88
 */

/**
 * GDK_WINDOWING_QUARTZ:
 *
 * The #GDK_WINDOWING_QUARTZ macro is defined if the Quartz backend
 * is supported.
89 90
 *
 * Use this macro to guard code that is specific to the Quartz backend.
91
 */
92

93 94 95 96 97 98 99 100 101
/**
 * GDK_WINDOWING_WAYLAND:
 *
 * The #GDK_WINDOWING_WAYLAND macro is defined if the Wayland backend
 * is supported.
 *
 * Use this macro to guard code that is specific to the Wayland backend.
 */

102 103 104 105 106 107 108 109
/**
 * GDK_DISABLE_DEPRECATION_WARNINGS:
 *
 * A macro that should be defined before including the gdk.h header.
 * If it is defined, no compiler warnings will be produced for uses
 * of deprecated GDK APIs.
 */

Elliot Lee's avatar
Elliot Lee committed
110 111 112 113 114 115 116 117
typedef struct _GdkPredicate  GdkPredicate;

struct _GdkPredicate
{
  GdkEventFunc func;
  gpointer data;
};

118 119 120 121 122 123 124 125 126 127
typedef struct _GdkThreadsDispatch GdkThreadsDispatch;

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


Elliot Lee's avatar
Elliot Lee committed
128 129
/* Private variable declarations
 */
130 131 132
static int gdk_initialized = 0;                     /* 1 if the library is initialized,
                                                     * 0 otherwise.
                                                     */
Elliot Lee's avatar
Elliot Lee committed
133

134
static gchar  *gdk_progclass = NULL;
135
static gboolean gdk_progclass_overridden;
136

137
static GMutex gdk_threads_mutex;
138 139 140 141

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

142
static const GDebugKey gdk_gl_keys[] = {
Matthias Clasen's avatar
Matthias Clasen committed
143 144 145 146 147 148
  { "disable",               GDK_GL_DISABLE },
  { "always",                GDK_GL_ALWAYS },
  { "software-draw",         GDK_GL_SOFTWARE_DRAW_GL | GDK_GL_SOFTWARE_DRAW_SURFACE} ,
  { "software-draw-gl",      GDK_GL_SOFTWARE_DRAW_GL },
  { "software-draw-surface", GDK_GL_SOFTWARE_DRAW_SURFACE },
  { "texture-rectangle",     GDK_GL_TEXTURE_RECTANGLE },
149 150
  { "legacy",                GDK_GL_LEGACY },
  { "gles",                  GDK_GL_GLES },
151 152
};

153
#ifdef G_ENABLE_DEBUG
154
static const GDebugKey gdk_debug_keys[] = {
Matthias Clasen's avatar
Matthias Clasen committed
155 156 157 158 159 160 161 162 163 164 165 166 167 168
  { "events",        GDK_DEBUG_EVENTS },
  { "misc",          GDK_DEBUG_MISC },
  { "dnd",           GDK_DEBUG_DND },
  { "xim",           GDK_DEBUG_XIM },
  { "nograbs",       GDK_DEBUG_NOGRABS },
  { "input",         GDK_DEBUG_INPUT },
  { "cursor",        GDK_DEBUG_CURSOR },
  { "multihead",     GDK_DEBUG_MULTIHEAD },
  { "xinerama",      GDK_DEBUG_XINERAMA },
  { "draw",          GDK_DEBUG_DRAW },
  { "eventloop",     GDK_DEBUG_EVENTLOOP },
  { "frames",        GDK_DEBUG_FRAMES },
  { "settings",      GDK_DEBUG_SETTINGS },
  { "opengl",        GDK_DEBUG_OPENGL }
169
};
170

171 172
static gboolean
gdk_arg_debug_cb (const char *key, const char *value, gpointer user_data, GError **error)
173
{
174
  guint debug_value = g_parse_debug_string (value,
175 176
                                            (GDebugKey *) gdk_debug_keys,
                                            G_N_ELEMENTS (gdk_debug_keys));
177 178 179

  if (debug_value == 0 && value != NULL && strcmp (value, "") != 0)
    {
180 181 182
      g_set_error (error,
                   G_OPTION_ERROR, G_OPTION_ERROR_FAILED,
                   _("Error parsing option --gdk-debug"));
183 184 185 186 187 188
      return FALSE;
    }

  _gdk_debug_flags |= debug_value;

  return TRUE;
189 190
}

191 192
static gboolean
gdk_arg_no_debug_cb (const char *key, const char *value, gpointer user_data, GError **error)
193
{
194
  guint debug_value = g_parse_debug_string (value,
195 196
                                            (GDebugKey *) gdk_debug_keys,
                                            G_N_ELEMENTS (gdk_debug_keys));
197 198 199

  if (debug_value == 0 && value != NULL && strcmp (value, "") != 0)
    {
200 201 202
      g_set_error (error,
                   G_OPTION_ERROR, G_OPTION_ERROR_FAILED,
                   _("Error parsing option --gdk-no-debug"));
203 204 205 206 207 208
      return FALSE;
    }

  _gdk_debug_flags &= ~debug_value;

  return TRUE;
209
}
210
#endif /* G_ENABLE_DEBUG */
211

212 213
static gboolean
gdk_arg_class_cb (const char *key, const char *value, gpointer user_data, GError **error)
214 215
{
  gdk_set_program_class (value);
216
  gdk_progclass_overridden = TRUE;
217 218

  return TRUE;
219 220
}

221 222
static gboolean
gdk_arg_name_cb (const char *key, const char *value, gpointer user_data, GError **error)
223 224 225
{
  g_set_prgname (value);

226 227
  return TRUE;
}
228

Matthias Clasen's avatar
Matthias Clasen committed
229
static const GOptionEntry gdk_args[] = {
230 231 232 233 234 235
  { "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") },
236
#ifndef G_OS_WIN32
237 238 239
  { "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") },
240
#endif
241
#ifdef G_ENABLE_DEBUG
242
  { "gdk-debug",    0, 0, G_OPTION_ARG_CALLBACK, gdk_arg_debug_cb,  
243
    /* Description of --gdk-debug=FLAGS in --help output */    N_("GDK debugging flags to set"),
244 245
    /* Placeholder in --gdk-debug=FLAGS in --help output */    N_("FLAGS") },
  { "gdk-no-debug", 0, 0, G_OPTION_ARG_CALLBACK, gdk_arg_no_debug_cb, 
246
    /* Description of --gdk-no-debug=FLAGS in --help output */ N_("GDK debugging flags to unset"),
247 248
    /* Placeholder in --gdk-no-debug=FLAGS in --help output */ N_("FLAGS") },
#endif 
249 250 251
  { NULL }
};

252 253 254 255 256 257
void
gdk_add_option_entries (GOptionGroup *group)
{
  g_option_group_add_entries (group, gdk_args);
}

258
/**
259 260
 * gdk_add_option_entries_libgtk_only:
 * @group: An option group.
261
 *
262 263
 * Appends gdk option entries to the passed in option group. This is
 * not public API and must not be used by applications.
264 265 266
 *
 * Deprecated: 3.16: This symbol was never meant to be used outside
 *   of GTK+
267
 */
268
void
269
gdk_add_option_entries_libgtk_only (GOptionGroup *group)
270
{
271
  gdk_add_option_entries (group);
272 273
}

274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289
static gpointer
register_resources (gpointer dummy G_GNUC_UNUSED)
{
  _gdk_register_resource ();

  return NULL;
}

static void
gdk_ensure_resources (void)
{
  static GOnce register_resources_once = G_ONCE_INIT;

  g_once (&register_resources_once, register_resources, NULL);
}

290
void
291
gdk_pre_parse (void)
292
{
293
  const char *rendering_mode;
294
  const gchar *gl_string;
295

296 297
  gdk_initialized = TRUE;

298
  gdk_ensure_resources ();
299

300 301 302 303 304 305 306 307 308 309 310 311
  /* 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,
312 313
                                              (GDebugKey *) gdk_debug_keys,
                                              G_N_ELEMENTS (gdk_debug_keys));
314
  }
315
#endif  /* G_ENABLE_DEBUG */
316

317 318 319 320 321 322
  gl_string = getenv("GDK_GL");
  if (gl_string != NULL)
    _gdk_gl_flags = g_parse_debug_string (gl_string,
                                          (GDebugKey *) gdk_gl_keys,
                                          G_N_ELEMENTS (gdk_gl_keys));

323 324
  if (getenv ("GDK_NATIVE_WINDOWS"))
    {
325 326
      g_warning ("The GDK_NATIVE_WINDOWS environment variable is not supported in GTK3.\n"
                 "See the documentation for gdk_window_ensure_native() on how to get native windows.");
327 328
      g_unsetenv ("GDK_NATIVE_WINDOWS");
    }
329

330 331 332 333 334 335 336 337 338 339
  rendering_mode = g_getenv ("GDK_RENDERING");
  if (rendering_mode)
    {
      if (g_str_equal (rendering_mode, "similar"))
        _gdk_rendering_mode = GDK_RENDERING_MODE_SIMILAR;
      else if (g_str_equal (rendering_mode, "image"))
        _gdk_rendering_mode = GDK_RENDERING_MODE_IMAGE;
      else if (g_str_equal (rendering_mode, "recording"))
        _gdk_rendering_mode = GDK_RENDERING_MODE_RECORDING;
    }
340 341
}

342 343 344 345 346 347 348 349 350 351 352 353 354 355
/**
 * gdk_pre_parse_libgtk_only:
 *
 * Prepare for parsing command line arguments for GDK. This is not
 * public API and should not be used in application code.
 *
 * Deprecated: 3.16: This symbol was never meant to be used outside
 *   of GTK+
 */
void
gdk_pre_parse_libgtk_only (void)
{
  gdk_pre_parse ();
}
356
  
357 358 359
/**
 * gdk_parse_args:
 * @argc: the number of command line arguments.
360
 * @argv: (inout) (array length=argc): the array of command line arguments.
361 362
 * 
 * Parse command line arguments, and store for future
Owen Taylor's avatar
Owen Taylor committed
363
 * use by calls to gdk_display_open().
Elliot Lee's avatar
Elliot Lee committed
364
 *
365 366
 * Any arguments used by GDK are removed from the array and @argc and @argv are
 * updated accordingly.
Elliot Lee's avatar
Elliot Lee committed
367
 *
368
 * You shouldn’t call this function explicitly if you are using
369
 * gtk_init(), gtk_init_check(), gdk_init(), or gdk_init_check().
370 371
 *
 * Since: 2.2
372 373 374
 **/
void
gdk_parse_args (int    *argc,
375
                char ***argv)
Elliot Lee's avatar
Elliot Lee committed
376
{
377 378
  GOptionContext *option_context;
  GOptionGroup *option_group;
379
  GError *error = NULL;
380

381
  if (gdk_initialized)
382
    return;
383

384
  gdk_pre_parse ();
385

386 387 388 389 390
  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);
391

392 393
  g_option_group_add_entries (option_group, gdk_args);

Matthias Clasen's avatar
Matthias Clasen committed
394
  if (!g_option_context_parse (option_context, argc, argv, &error))
395 396 397 398
    {
      g_warning ("%s", error->message);
      g_error_free (error);
    }
399
  g_option_context_free (option_context);
400

401
  GDK_NOTE (MISC, g_message ("progname: \"%s\"", g_get_prgname ()));
402
}
403

Benjamin Otte's avatar
Benjamin Otte committed
404 405 406 407
/**
 * gdk_get_display:
 *
 * Gets the name of the display, which usually comes from the
408
 * `DISPLAY` environment variable or the
409
 * `--display` command line option.
Benjamin Otte's avatar
Benjamin Otte committed
410 411
 *
 * Returns: the name of the display.
412 413 414
 *
 * Deprecated: 3.8: Call gdk_display_get_name (gdk_display_get_default ()))
 *    instead.
Benjamin Otte's avatar
Benjamin Otte committed
415 416 417 418 419 420 421
 */
gchar *
gdk_get_display (void)
{
  return g_strdup (gdk_display_get_name (gdk_display_get_default ()));
}

422
/**
423 424 425 426 427
 * 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.
 *
428 429 430
 * Returns: (nullable): the display name, if specified explicitly,
 *   otherwise %NULL this string is owned by GTK+ and must not be
 *   modified or freed.
431 432
 *
 * Since: 2.2
433
 */
434
const gchar *
435 436
gdk_get_display_arg_name (void)
{
437
  if (!_gdk_display_arg_name)
438
    _gdk_display_arg_name = g_strdup (_gdk_display_name);
439 440 441 442

   return _gdk_display_arg_name;
}

443 444
/*< private >
 * gdk_display_open_default:
445
 *
446 447
 * Opens the default display specified by command line arguments or
 * environment variables, sets it as the default display, and returns
448
 * it. gdk_parse_args() must have been called first. If the default
449 450
 * display has previously been set, simply returns that. An internal
 * function that should not be used by applications.
451
 *
452 453
 * Returns: (nullable) (transfer none): the default display, if it
 *   could be opened, otherwise %NULL.
454
 */
455
GdkDisplay *
456
gdk_display_open_default (void)
457 458 459
{
  GdkDisplay *display;

460
  g_return_val_if_fail (gdk_initialized, NULL);
461

462 463 464 465 466 467 468
  display = gdk_display_get_default ();
  if (display)
    return display;

  display = gdk_display_open (gdk_get_display_arg_name ());

  return display;
469 470
}

471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491
/**
 * 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.
 *
 * Returns: (nullable) (transfer none): the default display, if it
 *   could be opened, otherwise %NULL.
 *
 * Deprecated: 3.16: This symbol was never meant to be used outside
 *   of GTK+
 */
GdkDisplay *
gdk_display_open_default_libgtk_only (void)
{
  return gdk_display_open_default ();
}

492 493
/**
 * gdk_init_check:
494 495
 * @argc: (inout): the number of command line arguments.
 * @argv: (array length=argc) (inout): the array of command line arguments.
496
 *
497 498
 * Initializes the GDK library and connects to the windowing system,
 * returning %TRUE on success.
499
 *
500 501
 * Any arguments used by GDK are removed from the array and @argc and @argv
 * are updated accordingly.
502
 *
503 504
 * GTK+ initializes GDK in gtk_init() and so this function is not usually
 * needed by GTK+ applications.
505
 *
506
 * Returns: %TRUE if initialization succeeded.
507 508 509
 */
gboolean
gdk_init_check (int    *argc,
510
                char ***argv)
511 512
{
  gdk_parse_args (argc, argv);
513

514
  return gdk_display_open_default () != NULL;
515 516
}

517 518 519

/**
 * gdk_init:
520 521 522
 * @argc: (inout): the number of command line arguments.
 * @argv: (array length=argc) (inout): the array of command line arguments.
 *
523
 * Initializes the GDK library and connects to the windowing system.
524
 * If initialization fails, a warning message is output and the application
525
 * terminates with a call to `exit(1)`.
526
 *
527 528
 * Any arguments used by GDK are removed from the array and @argc and @argv
 * are updated accordingly.
529
 *
530 531
 * GTK+ initializes GDK in gtk_init() and so this function is not usually
 * needed by GTK+ applications.
532
 */
533 534 535 536 537
void
gdk_init (int *argc, char ***argv)
{
  if (!gdk_init_check (argc, argv))
    {
538 539
      const char *display_name = gdk_get_display_arg_name ();
      g_warning ("cannot open display: %s", display_name ? display_name : "");
540 541
      exit(1);
    }
Elliot Lee's avatar
Elliot Lee committed
542 543
}

544 545 546 547 548 549 550 551 552 553 554 555 556 557 558


/**
 * 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.
 *
559 560 561
 * GTK+, however, is not thread safe. You should only use GTK+ and GDK
 * from the thread gtk_init() and gtk_main() were called on.
 * This is usually referred to as the “main thread”.
562
 *
563 564
 * Signals on GTK+ and GDK types, as well as non-signal callbacks, are
 * emitted in the main thread.
565
 *
566 567
 * You can schedule work in the main thread safely from other threads
 * by using gdk_threads_add_idle() and gdk_threads_add_timeout():
568
 *
569
 * |[<!-- language="C" -->
570 571
 * static void
 * worker_thread (void)
572
 * {
573
 *   ExpensiveData *expensive_data = do_expensive_computation ();
574
 *
575
 *   gdk_threads_add_idle (got_value, expensive_data);
576 577
 * }
 *
578 579
 * static gboolean
 * got_value (gpointer user_data)
580
 * {
581
 *   ExpensiveData *expensive_data = user_data;
582
 *
583 584 585
 *   my_app->expensive_data = expensive_data;
 *   gtk_button_set_sensitive (my_app->button, TRUE);
 *   gtk_button_set_label (my_app->button, expensive_data->result_label);
586
 *
587
 *   return G_SOURCE_REMOVE;
588
 * }
589
 * ]|
590
 *
591 592 593 594 595 596 597 598 599 600 601
 * You should use gdk_threads_add_idle() and gdk_threads_add_timeout()
 * instead of g_idle_add() and g_timeout_add() since libraries not under
 * your control might be using the deprecated GDK locking mechanism.
 * If you are sure that none of the code in your application and libraries
 * use the deprecated gdk_threads_enter() or gdk_threads_leave() methods,
 * then you can safely use g_idle_add() and g_timeout_add().
 *
 * For more information on this "worker thread" pattern, you should
 * also look at #GTask, which gives you high-level tools to perform
 * expensive tasks from worker threads, and will handle thread
 * management for you.
602 603 604 605 606 607
 */


/**
 * gdk_threads_enter:
 *
608 609 610
 * This function 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
611
 * section.
612 613 614
 *
 * Deprecated:3.6: All GDK and GTK+ calls should be made from the main
 *     thread
615
 */
616
void
617
gdk_threads_enter (void)
618
{
619 620
  if (gdk_threads_lock)
    (*gdk_threads_lock) ();
621 622
}

623 624 625 626
/**
 * gdk_threads_leave:
 *
 * Leaves a critical region begun with gdk_threads_enter().
627 628 629
 *
 * Deprecated:3.6: All GDK and GTK+ calls should be made from the main
 *     thread
630
 */
631
void
632
gdk_threads_leave (void)
633
{
634 635
  if (gdk_threads_unlock)
    (*gdk_threads_unlock) ();
636 637
}

638 639 640
static void
gdk_threads_impl_lock (void)
{
641
  g_mutex_lock (&gdk_threads_mutex);
642 643 644 645 646
}

static void
gdk_threads_impl_unlock (void)
{
647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666
  /* we need a trylock() here because trying to unlock a mutex
   * that hasn't been locked yet is:
   *
   *  a) not portable
   *  b) fail on GLib ≥ 2.41
   *
   * trylock() will either succeed because nothing is holding the
   * GDK mutex, and will be unlocked right afterwards; or it's
   * going to fail because the mutex is locked already, in which
   * case we unlock it as expected.
   *
   * this is needed in the case somebody called gdk_threads_init()
   * without calling gdk_threads_enter() before calling gtk_main().
   * in theory, we could just say that this is undefined behaviour,
   * but our documentation has always been *less* than explicit as
   * to what the behaviour should actually be.
   *
   * see bug: https://bugzilla.gnome.org/show_bug.cgi?id=735428
   */
  g_mutex_trylock (&gdk_threads_mutex);
667
  g_mutex_unlock (&gdk_threads_mutex);
668 669
}

670 671
/**
 * gdk_threads_init:
672
 *
673 674 675 676 677
 * Initializes GDK so that it can be used from multiple threads
 * in conjunction with gdk_threads_enter() and gdk_threads_leave().
 *
 * This call must be made before any use of the main loop from
 * GTK+; to be safe, call it before gtk_init().
678 679 680
 *
 * Deprecated:3.6: All GDK and GTK+ calls should be made from the main
 *     thread
681
 */
682
void
683
gdk_threads_init (void)
684
{
685 686 687 688 689 690 691
  if (!gdk_threads_lock)
    gdk_threads_lock = gdk_threads_impl_lock;
  if (!gdk_threads_unlock)
    gdk_threads_unlock = gdk_threads_impl_unlock;
}

/**
692
 * gdk_threads_set_lock_functions: (skip)
Matthias Clasen's avatar
Matthias Clasen committed
693
 * @enter_fn:   function called to guard GDK
694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712
 * @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.
 *
713
 * Most threaded GTK+ apps won’t need to use this method.
714
 *
Matthias Clasen's avatar
Matthias Clasen committed
715
 * This method must be called before gdk_threads_init(), and cannot
716
 * be called multiple times.
Matthias Clasen's avatar
Matthias Clasen committed
717
 *
718 719 720
 * Deprecated:3.6: All GDK and GTK+ calls should be made from the main
 *     thread
 *
Matthias Clasen's avatar
Matthias Clasen committed
721
 * Since: 2.4
722 723 724
 **/
void
gdk_threads_set_lock_functions (GCallback enter_fn,
725
                                GCallback leave_fn)
726 727
{
  g_return_if_fail (gdk_threads_lock == NULL &&
728
                    gdk_threads_unlock == NULL);
729 730 731

  gdk_threads_lock = enter_fn;
  gdk_threads_unlock = leave_fn;
732 733
}

734 735 736 737 738 739
static gboolean
gdk_threads_dispatch (gpointer data)
{
  GdkThreadsDispatch *dispatch = data;
  gboolean ret = FALSE;

740
  gdk_threads_enter ();
741 742 743 744

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

745
  gdk_threads_leave ();
746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762

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


/**
Jasper St. Pierre's avatar
Jasper St. Pierre committed
763
 * gdk_threads_add_idle_full: (rename-to gdk_threads_add_idle)
764
 * @priority: the priority of the idle source. Typically this will be in the
765
 *            range between #G_PRIORITY_DEFAULT_IDLE and #G_PRIORITY_HIGH_IDLE
766 767
 * @function: function to call
 * @data:     data to pass to @function
768
 * @notify: (allow-none):   function to call when the idle is removed, or %NULL
769 770 771 772 773 774
 *
 * 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
775
 * held. It can be thought of a MT-safe version for GTK+ widgets for the
776 777 778 779
 * 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:
 *
780
 * |[<!-- language="C" -->
781 782
 * static gboolean
 * idle_callback (gpointer data)
783
 * {
784
 *    // gdk_threads_enter(); would be needed for g_idle_add()
785
 *
786
 *    SomeWidget *self = data;
787
 *    // do stuff with self
788
 *
789
 *    self->idle_id = 0;
790
 *
791
 *    // gdk_threads_leave(); would be needed for g_idle_add()
792 793
 *    return FALSE;
 * }
794 795 796
 *
 * static void
 * some_widget_do_stuff_later (SomeWidget *self)
797
 * {
798
 *    self->idle_id = gdk_threads_add_idle (idle_callback, self)
799
 *    // using g_idle_add() here would require thread protection in the callback
800
 * }
801 802 803
 *
 * static void
 * some_widget_finalize (GObject *object)
804
 * {
805
 *    SomeWidget *self = SOME_WIDGET (object);
806 807 808 809
 *    if (self->idle_id)
 *      g_source_remove (self->idle_id);
 *    G_OBJECT_CLASS (parent_class)->finalize (object);
 * }
Matthias Clasen's avatar
Matthias Clasen committed
810
 * ]|
811
 *
812
 * Returns: the ID (greater than 0) of the event source.
813 814 815 816 817
 *
 * Since: 2.12
 */
guint
gdk_threads_add_idle_full (gint           priority,
818 819 820
                           GSourceFunc    function,
                           gpointer       data,
                           GDestroyNotify notify)
821 822 823 824 825 826 827 828 829 830 831
{
  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,
832 833
                          gdk_threads_dispatch,
                          dispatch,
834 835 836 837
                          gdk_threads_dispatch_free);
}

/**
838
 * gdk_threads_add_idle: (skip)
839 840 841 842 843 844 845
 * @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
846
 *
847
 * Returns: the ID (greater than 0) of the event source.
848 849 850 851 852
 * 
 * Since: 2.12
 */
guint
gdk_threads_add_idle (GSourceFunc    function,
853
                      gpointer       data)
854 855 856 857 858 859 860
{
  return gdk_threads_add_idle_full (G_PRIORITY_DEFAULT_IDLE,
                                    function, data, NULL);
}


/**
Jasper St. Pierre's avatar
Jasper St. Pierre committed
861
 * gdk_threads_add_timeout_full: (rename-to gdk_threads_add_timeout)
862 863 864 865 866 867
 * @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
868
 * @notify: (allow-none):   function to call when the timeout is removed, or %NULL
869 870 871 872 873 874 875 876 877 878 879 880
 *
 * 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
881
 * (it does not try to “catch up” time lost in delays).
882 883 884 885
 *
 * This variant of g_timeout_add_full() can be thought of a MT-safe version 
 * for GTK+ widgets for the following use case:
 *
886
 * |[<!-- language="C" -->
887 888 889
 * static gboolean timeout_callback (gpointer data)
 * {
 *    SomeWidget *self = data;
890
 *    
891
 *    // do stuff with self
892
 *    
893
 *    self->timeout_id = 0;
894
 *    
895
 *    return G_SOURCE_REMOVE;
896
 * }
897
 *  
898 899 900 901
 * static void some_widget_do_stuff_later (SomeWidget *self)
 * {
 *    self->timeout_id = g_timeout_add (timeout_callback, self)
 * }
902
 *  
903 904
 * static void some_widget_finalize (GObject *object)
 * {
Matthias Clasen's avatar
Matthias Clasen committed
905
 *    SomeWidget *self = SOME_WIDGET (object);
906
 *    
907 908
 *    if (self->timeout_id)
 *      g_source_remove (self->timeout_id);
909
 *    
910 911
 *    G_OBJECT_CLASS (parent_class)->finalize (object);
 * }
Matthias Clasen's avatar
Matthias Clasen committed
912
 * ]|
913
 *
914
 * Returns: the ID (greater than 0) of the event source.
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
 * 
 * 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);
}

/**
942
 * gdk_threads_add_timeout: (skip)
943 944 945 946 947 948 949 950 951
 * @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
952
 * 
953
 * Returns: the ID (greater than 0) of the event source.
954 955 956 957 958 959 960 961 962 963 964 965 966
 *
 * 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);
}


967
/**
Jasper St. Pierre's avatar
Jasper St. Pierre committed
968
 * gdk_threads_add_timeout_seconds_full: (rename-to gdk_threads_add_timeout_seconds)
969 970 971 972 973
 * @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
Matthias Clasen's avatar
Matthias Clasen committed
974
 * @notify: (allow-none): function to call when the timeout is removed, or %NULL
975
 *
Matthias Clasen's avatar
Matthias Clasen committed
976
 * A variant of gdk_threads_add_timeout_full() with second-granularity.
977
 * See g_timeout_add_seconds_full() for a discussion of why it is
978
 * a good idea to use this function if you don’t need finer granularity.
979
 *
980
 * Returns: the ID (greater than 0) of the event source.
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
 * 
 * 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);
}

/**
1008
 * gdk_threads_add_timeout_seconds: (skip)
1009 1010 1011 1012 1013 1014 1015 1016 1017
 * @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().
 * 
1018
 * Returns: the ID (greater than 0) of the event source.
1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030
 *
 * 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);
}

1031 1032 1033 1034
/**
 * gdk_get_program_class:
 *
 * Gets the program class. Unless the program class has explicitly
1035
 * been set with gdk_set_program_class() or with the `--class`
1036 1037 1038 1039 1040
 * 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.
 */
1041
const char *
1042 1043 1044 1045 1046
gdk_get_program_class (void)
{
  return gdk_progclass;
}

1047 1048 1049 1050 1051
/**
 * gdk_set_program_class:
 * @program_class: a string.
 *
 * Sets the program class. The X11 backend uses the program class to set
1052
 * the class name part of the `WM_CLASS` property on
1053
 * toplevel windows; see the ICCCM.
1054 1055 1056
 *
 * The program class can still be overridden with the --class command
 * line option.
1057
 */
1058 1059 1060
void
gdk_set_program_class (const char *program_class)
{
1061 1062 1063
  if (gdk_progclass_overridden)
    return;

1064
  g_free (gdk_progclass);
1065 1066 1067

  gdk_progclass = g_strdup (program_class);
}
1068

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

Carlos Garnacho's avatar
Carlos Garnacho committed
1089
  _gdk_disable_multidevice = TRUE;
1090
}