gdk.c 22.4 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 <string.h>
30
#include <stdlib.h>
Elliot Lee's avatar
Elliot Lee committed
31

Owen Taylor's avatar
Started  
Owen Taylor committed
32
#include "gdk.h"
33
#include "gdkinternals.h"
34
#include "gdkintl.h"
Elliot Lee's avatar
Elliot Lee committed
35

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

Elliot Lee's avatar
Elliot Lee committed
41 42 43 44 45 46 47 48
typedef struct _GdkPredicate  GdkPredicate;

struct _GdkPredicate
{
  GdkEventFunc func;
  gpointer data;
};

49 50 51 52 53 54 55 56 57 58
typedef struct _GdkThreadsDispatch GdkThreadsDispatch;

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


Elliot Lee's avatar
Elliot Lee committed
59 60
/* Private variable declarations
 */
61
static int gdk_initialized = 0;			    /* 1 if the library is initialized,
Elliot Lee's avatar
Elliot Lee committed
62 63 64
						     * 0 otherwise.
						     */

65 66
static gchar  *gdk_progclass = NULL;

67
#ifdef G_ENABLE_DEBUG
68
static const GDebugKey gdk_debug_keys[] = {
69 70 71
  {"events",	    GDK_DEBUG_EVENTS},
  {"misc",	    GDK_DEBUG_MISC},
  {"dnd",	    GDK_DEBUG_DND},
Jacob Berkman's avatar
Jacob Berkman committed
72 73
  {"xim",	    GDK_DEBUG_XIM},
  {"nograbs",       GDK_DEBUG_NOGRABS},
74 75 76 77 78 79 80
  {"colormap",	    GDK_DEBUG_COLORMAP},
  {"gdkrgb",	    GDK_DEBUG_GDKRGB},
  {"gc",	    GDK_DEBUG_GC},
  {"pixmap",	    GDK_DEBUG_PIXMAP},
  {"image",	    GDK_DEBUG_IMAGE},
  {"input",	    GDK_DEBUG_INPUT},
  {"cursor",	    GDK_DEBUG_CURSOR},
81
  {"multihead",	    GDK_DEBUG_MULTIHEAD},
82
  {"xinerama",	    GDK_DEBUG_XINERAMA},
83 84
  {"draw",	    GDK_DEBUG_DRAW},
  {"eventloop",	    GDK_DEBUG_EVENTLOOP}
85
};
86

87
static const int gdk_ndebug_keys = G_N_ELEMENTS (gdk_debug_keys);
88

89
#endif /* G_ENABLE_DEBUG */
Elliot Lee's avatar
Elliot Lee committed
90

91
#ifdef G_ENABLE_DEBUG
92 93
static gboolean
gdk_arg_debug_cb (const char *key, const char *value, gpointer user_data, GError **error)
94
{
95
  guint debug_value = g_parse_debug_string (value,
96 97
					    (GDebugKey *) gdk_debug_keys,
					    gdk_ndebug_keys);
98 99 100 101 102 103 104 105 106 107 108 109

  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;
110 111
}

112 113
static gboolean
gdk_arg_no_debug_cb (const char *key, const char *value, gpointer user_data, GError **error)
114
{
115 116 117 118 119 120 121 122 123 124 125 126 127 128 129
  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;
130
}
131
#endif /* G_ENABLE_DEBUG */
132

133 134
static gboolean
gdk_arg_class_cb (const char *key, const char *value, gpointer user_data, GError **error)
135 136
{
  gdk_set_program_class (value);
137 138

  return TRUE;
139 140
}

141 142
static gboolean
gdk_arg_name_cb (const char *key, const char *value, gpointer user_data, GError **error)
143 144 145
{
  g_set_prgname (value);

146 147
  return TRUE;
}
148

Matthias Clasen's avatar
Matthias Clasen committed
149
static const GOptionEntry gdk_args[] = {
150 151 152 153 154 155 156 157 158 159 160 161
  { "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") },
162
#ifdef G_ENABLE_DEBUG
163 164 165 166 167 168 169
  { "gdk-debug",    0, 0, G_OPTION_ARG_CALLBACK, gdk_arg_debug_cb,  
    /* Description of --gdk-debug=FLAGS in --help output */    N_("Gdk debugging flags to set"),
    /* Placeholder in --gdk-debug=FLAGS in --help output */    N_("FLAGS") },
  { "gdk-no-debug", 0, 0, G_OPTION_ARG_CALLBACK, gdk_arg_no_debug_cb, 
    /* Description of --gdk-no-debug=FLAGS in --help output */ N_("Gdk debugging flags to unset"), 
    /* Placeholder in --gdk-no-debug=FLAGS in --help output */ N_("FLAGS") },
#endif 
170 171 172
  { NULL }
};

173
/**
174 175
 * gdk_add_option_entries_libgtk_only:
 * @group: An option group.
176
 * 
177 178
 * Appends gdk option entries to the passed in option group. This is
 * not public API and must not be used by applications.
179 180
 **/
void
181
gdk_add_option_entries_libgtk_only (GOptionGroup *group)
182
{
183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208
  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 */

209 210 211 212 213 214 215
  if (getenv ("GDK_NATIVE_WINDOWS"))
    {
      _gdk_native_windows = TRUE;
      /* Ensure that this is not propagated
	 to spawned applications */
      g_unsetenv ("GDK_NATIVE_WINDOWS");
    }
216

217 218 219 220 221
  g_type_init ();

  /* Do any setup particular to the windowing system
   */
  _gdk_windowing_init ();  
222 223
}

224
  
225 226 227 228 229 230
/**
 * 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
231
 * use by calls to gdk_display_open().
Elliot Lee's avatar
Elliot Lee committed
232
 *
233 234
 * Any arguments used by GDK are removed from the array and @argc and @argv are
 * updated accordingly.
Elliot Lee's avatar
Elliot Lee committed
235
 *
236 237
 * 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
238 239
 *
 * Since: 2.2
240 241 242
 **/
void
gdk_parse_args (int    *argc,
243
		char ***argv)
Elliot Lee's avatar
Elliot Lee committed
244
{
245 246
  GOptionContext *option_context;
  GOptionGroup *option_group;
247
  GError *error = NULL;
248

249
  if (gdk_initialized)
250
    return;
251

252
  gdk_pre_parse_libgtk_only ();
253
  
254 255 256 257 258
  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);
259
  
260 261 262
  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
263
  if (!g_option_context_parse (option_context, argc, argv, &error))
264 265 266 267
    {
      g_warning ("%s", error->message);
      g_error_free (error);
    }
268
  g_option_context_free (option_context);
269 270 271 272

  if (_gdk_debug_flags && GDK_DEBUG_GDKRGB)
    gdk_rgb_set_verbose (TRUE);

273
  GDK_NOTE (MISC, g_message ("progname: \"%s\"", g_get_prgname ()));
274
}
275

276 277 278 279 280 281 282
/** 
 * 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
283
 *   this string is owned by GTK+ and must not be modified or freed.
Matthias Clasen's avatar
Matthias Clasen committed
284 285
 *
 * Since: 2.2
286
 */
287
G_CONST_RETURN gchar *
288 289
gdk_get_display_arg_name (void)
{
290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317
  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.
 * 
 * Return value: the default display, if it could be opened,
 *   otherwise %NULL.
 **/
GdkDisplay *
gdk_display_open_default_libgtk_only (void)
{
  GdkDisplay *display;

318
  g_return_val_if_fail (gdk_initialized, NULL);
319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338
  
  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;
339 340
}

341 342 343 344
/**
 * gdk_init_check:
 * @argc: (inout):
 * @argv: (array length=argc) (inout):
345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367
 *
 *   Initialize the library for use.
 *
 * Arguments:
 *   "argc" is the number of arguments.
 *   "argv" is an array of strings.
 *
 * Results:
 *   "argc" and "argv" are modified to reflect any arguments
 *   which were not handled. (Such arguments should either
 *   be handled by the application or dismissed). If initialization
 *   fails, returns FALSE, otherwise TRUE.
 *
 * Side effects:
 *   The library is initialized.
 *
 *--------------------------------------------------------------
 */
gboolean
gdk_init_check (int    *argc,
		char ***argv)
{
  gdk_parse_args (argc, argv);
368

369
  return gdk_display_open_default_libgtk_only () != NULL;
370 371
}

372 373 374 375 376 377

/**
 * gdk_init:
 * @argc: (inout):
 * @argv: (array length=argc) (inout):
 */
378 379 380 381 382
void
gdk_init (int *argc, char ***argv)
{
  if (!gdk_init_check (argc, argv))
    {
383 384
      const char *display_name = gdk_get_display_arg_name ();
      g_warning ("cannot open display: %s", display_name ? display_name : "");
385 386
      exit(1);
    }
Elliot Lee's avatar
Elliot Lee committed
387 388
}

389
void
Matthias Clasen's avatar
Matthias Clasen committed
390
gdk_threads_enter (void)
391 392 393 394 395
{
  GDK_THREADS_ENTER ();
}

void
Matthias Clasen's avatar
Matthias Clasen committed
396
gdk_threads_leave (void)
397 398 399 400
{
  GDK_THREADS_LEAVE ();
}

401 402 403 404 405 406 407 408 409 410 411 412 413 414
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);
}

415 416 417 418 419
/**
 * gdk_threads_init:
 * 
 * Initializes GDK so that it can be used from multiple threads
 * in conjunction with gdk_threads_enter() and gdk_threads_leave().
420
 * g_thread_init() must be called previous to this function.
421 422 423 424 425
 *
 * 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
426
gdk_threads_init (void)
427 428
{
  if (!g_thread_supported ())
429
    g_error ("g_thread_init() must be called before gdk_threads_init()");
430 431

  gdk_threads_mutex = g_mutex_new ();
432 433 434 435 436 437 438 439
  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
440
 * @enter_fn:   function called to guard GDK
441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461
 * @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
462
 * This method must be called before gdk_threads_init(), and cannot
463
 * be called multiple times.
Matthias Clasen's avatar
Matthias Clasen committed
464 465
 *
 * Since: 2.4
466 467 468 469 470 471 472 473 474 475
 **/
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;
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
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
512
 * @notify: (allow-none):   function to call when the idle is removed, or %NULL
513 514 515 516 517 518 519 520 521 522 523
 *
 * 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
524
 * |[
Tim Janik's avatar
Tim Janik committed
525 526
 * static gboolean
 * idle_callback (gpointer data)
527
 * {
Matthias Clasen's avatar
Matthias Clasen committed
528
 *    /&ast; gdk_threads_enter(); would be needed for g_idle_add() &ast;/
Tim Janik's avatar
Tim Janik committed
529
 *
530
 *    SomeWidget *self = data;
Matthias Clasen's avatar
Matthias Clasen committed
531
 *    /&ast; do stuff with self &ast;/
Tim Janik's avatar
Tim Janik committed
532
 *
533
 *    self->idle_id = 0;
Tim Janik's avatar
Tim Janik committed
534
 *
Matthias Clasen's avatar
Matthias Clasen committed
535
 *    /&ast; gdk_threads_leave(); would be needed for g_idle_add() &ast;/
536 537
 *    return FALSE;
 * }
Tim Janik's avatar
Tim Janik committed
538 539 540
 *
 * static void
 * some_widget_do_stuff_later (SomeWidget *self)
541
 * {
Tim Janik's avatar
Tim Janik committed
542
 *    self->idle_id = gdk_threads_add_idle (idle_callback, self)
Matthias Clasen's avatar
Matthias Clasen committed
543
 *    /&ast; using g_idle_add() here would require thread protection in the callback &ast;/
544
 * }
Tim Janik's avatar
Tim Janik committed
545 546 547
 *
 * static void
 * some_widget_finalize (GObject *object)
548
 * {
Tim Janik's avatar
Tim Janik committed
549
 *    SomeWidget *self = SOME_WIDGET (object);
550 551 552 553
 *    if (self->idle_id)
 *      g_source_remove (self->idle_id);
 *    G_OBJECT_CLASS (parent_class)->finalize (object);
 * }
Matthias Clasen's avatar
Matthias Clasen committed
554
 * ]|
Tim Janik's avatar
Tim Janik committed
555
 *
556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575
 * 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
576 577
                          gdk_threads_dispatch,
                          dispatch,
578 579 580 581 582 583 584 585 586 587 588 589
                          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
590 591
 *
 * Return value: the ID (greater than 0) of the event source.
592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611
 * 
 * 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
612
 * @notify: (allow-none):   function to call when the timeout is removed, or %NULL
613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629
 *
 * 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
630
 * |[
631 632 633
 * static gboolean timeout_callback (gpointer data)
 * {
 *    SomeWidget *self = data;
634
 *    
Matthias Clasen's avatar
Matthias Clasen committed
635
 *    /&ast; do stuff with self &ast;/
636
 *    
637
 *    self->timeout_id = 0;
638
 *    
639 640
 *    return FALSE;
 * }
641
 *  
642 643 644 645
 * static void some_widget_do_stuff_later (SomeWidget *self)
 * {
 *    self->timeout_id = g_timeout_add (timeout_callback, self)
 * }
646
 *  
647 648
 * static void some_widget_finalize (GObject *object)
 * {
Matthias Clasen's avatar
Matthias Clasen committed
649
 *    SomeWidget *self = SOME_WIDGET (object);
650
 *    
651 652
 *    if (self->timeout_id)
 *      g_source_remove (self->timeout_id);
653
 *    
654 655
 *    G_OBJECT_CLASS (parent_class)->finalize (object);
 * }
Matthias Clasen's avatar
Matthias Clasen committed
656
 * ]|
657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695
 *
 * 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
696 697
 * 
 * Return value: the ID (greater than 0) of the event source.
698 699 700 701 702 703 704 705 706 707 708 709 710
 *
 * 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);
}


711 712 713 714 715 716 717
/**
 * 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
718
 * @notify: (allow-none):   function to call when the timeout is removed, or %NULL
719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775
 *
 * 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);
}


776 777 778 779 780 781 782 783 784
G_CONST_RETURN char *
gdk_get_program_class (void)
{
  return gdk_progclass;
}

void
gdk_set_program_class (const char *program_class)
{
785
  g_free (gdk_progclass);
786 787 788

  gdk_progclass = g_strdup (program_class);
}
789 790 791

#define __GDK_C__
#include "gdkaliasdef.c"