1 /* GDK - The GIMP Drawing Kit
2 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * 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.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
21 * Modified by the GTK+ Team and others 1997-2000. See the AUTHORS
22 * file for a list of people on the GTK+ Team. See the ChangeLog
23 * files for a list of changes. These files are distributed with
24 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
33 #include "gdkinternals.h"
36 #ifndef HAVE_XCONVERTCASE
37 #include "gdkkeysyms.h"
41 typedef struct _GdkPredicate GdkPredicate;
49 typedef struct _GdkThreadsDispatch GdkThreadsDispatch;
51 struct _GdkThreadsDispatch
55 GDestroyNotify destroy;
59 /* Private variable declarations
61 static int gdk_initialized = 0; /* 1 if the library is initialized,
65 static gchar *gdk_progclass = NULL;
68 static const GDebugKey gdk_debug_keys[] = {
69 {"events", GDK_DEBUG_EVENTS},
70 {"misc", GDK_DEBUG_MISC},
71 {"dnd", GDK_DEBUG_DND},
72 {"xim", GDK_DEBUG_XIM},
73 {"nograbs", GDK_DEBUG_NOGRABS},
74 {"colormap", GDK_DEBUG_COLORMAP},
75 {"gdkrgb", GDK_DEBUG_GDKRGB},
77 {"pixmap", GDK_DEBUG_PIXMAP},
78 {"image", GDK_DEBUG_IMAGE},
79 {"input", GDK_DEBUG_INPUT},
80 {"cursor", GDK_DEBUG_CURSOR},
81 {"multihead", GDK_DEBUG_MULTIHEAD},
82 {"xinerama", GDK_DEBUG_XINERAMA},
83 {"draw", GDK_DEBUG_DRAW},
84 {"eventloop", GDK_DEBUG_EVENTLOOP}
87 static const int gdk_ndebug_keys = G_N_ELEMENTS (gdk_debug_keys);
89 #endif /* G_ENABLE_DEBUG */
93 gdk_arg_debug_cb (const char *key, const char *value, gpointer user_data, GError **error)
95 guint debug_value = g_parse_debug_string (value,
96 (GDebugKey *) gdk_debug_keys,
99 if (debug_value == 0 && value != NULL && strcmp (value, "") != 0)
102 G_OPTION_ERROR, G_OPTION_ERROR_FAILED,
103 _("Error parsing option --gdk-debug"));
107 _gdk_debug_flags |= debug_value;
113 gdk_arg_no_debug_cb (const char *key, const char *value, gpointer user_data, GError **error)
115 guint debug_value = g_parse_debug_string (value,
116 (GDebugKey *) gdk_debug_keys,
119 if (debug_value == 0 && value != NULL && strcmp (value, "") != 0)
122 G_OPTION_ERROR, G_OPTION_ERROR_FAILED,
123 _("Error parsing option --gdk-no-debug"));
127 _gdk_debug_flags &= ~debug_value;
131 #endif /* G_ENABLE_DEBUG */
134 gdk_arg_class_cb (const char *key, const char *value, gpointer user_data, GError **error)
136 gdk_set_program_class (value);
142 gdk_arg_name_cb (const char *key, const char *value, gpointer user_data, GError **error)
144 g_set_prgname (value);
149 static const GOptionEntry gdk_args[] = {
150 { "class", 0, 0, G_OPTION_ARG_CALLBACK, gdk_arg_class_cb,
151 /* Description of --class=CLASS in --help output */ N_("Program class as used by the window manager"),
152 /* Placeholder in --class=CLASS in --help output */ N_("CLASS") },
153 { "name", 0, 0, G_OPTION_ARG_CALLBACK, gdk_arg_name_cb,
154 /* Description of --name=NAME in --help output */ N_("Program name as used by the window manager"),
155 /* Placeholder in --name=NAME in --help output */ N_("NAME") },
156 { "display", 0, G_OPTION_FLAG_IN_MAIN, G_OPTION_ARG_STRING, &_gdk_display_name,
157 /* Description of --display=DISPLAY in --help output */ N_("X display to use"),
158 /* Placeholder in --display=DISPLAY in --help output */ N_("DISPLAY") },
159 { "screen", 0, 0, G_OPTION_ARG_INT, &_gdk_screen_number,
160 /* Description of --screen=SCREEN in --help output */ N_("X screen to use"),
161 /* Placeholder in --screen=SCREEN in --help output */ N_("SCREEN") },
162 #ifdef G_ENABLE_DEBUG
163 { "gdk-debug", 0, 0, G_OPTION_ARG_CALLBACK, gdk_arg_debug_cb,
164 /* Description of --gdk-debug=FLAGS in --help output */ N_("Gdk debugging flags to set"),
165 /* Placeholder in --gdk-debug=FLAGS in --help output */ N_("FLAGS") },
166 { "gdk-no-debug", 0, 0, G_OPTION_ARG_CALLBACK, gdk_arg_no_debug_cb,
167 /* Description of --gdk-no-debug=FLAGS in --help output */ N_("Gdk debugging flags to unset"),
168 /* Placeholder in --gdk-no-debug=FLAGS in --help output */ N_("FLAGS") },
174 * gdk_add_option_entries_libgtk_only:
175 * @group: An option group.
177 * Appends gdk option entries to the passed in option group. This is
178 * not public API and must not be used by applications.
181 gdk_add_option_entries_libgtk_only (GOptionGroup *group)
183 g_option_group_add_entries (group, gdk_args);
184 g_option_group_add_entries (group, _gdk_windowing_args);
188 gdk_pre_parse_libgtk_only (void)
190 gdk_initialized = TRUE;
192 /* We set the fallback program class here, rather than lazily in
193 * gdk_get_program_class, since we don't want -name to override it.
195 gdk_progclass = g_strdup (g_get_prgname ());
196 if (gdk_progclass && gdk_progclass[0])
197 gdk_progclass[0] = g_ascii_toupper (gdk_progclass[0]);
199 #ifdef G_ENABLE_DEBUG
201 gchar *debug_string = getenv("GDK_DEBUG");
202 if (debug_string != NULL)
203 _gdk_debug_flags = g_parse_debug_string (debug_string,
204 (GDebugKey *) gdk_debug_keys,
207 #endif /* G_ENABLE_DEBUG */
209 if (getenv ("GDK_NATIVE_WINDOWS"))
211 _gdk_native_windows = TRUE;
212 /* Ensure that this is not propagated
213 to spawned applications */
214 g_unsetenv ("GDK_NATIVE_WINDOWS");
219 /* Do any setup particular to the windowing system
221 _gdk_windowing_init ();
227 * @argc: the number of command line arguments.
228 * @argv: the array of command line arguments.
230 * Parse command line arguments, and store for future
231 * use by calls to gdk_display_open().
233 * Any arguments used by GDK are removed from the array and @argc and @argv are
234 * updated accordingly.
236 * You shouldn't call this function explicitely if you are using
237 * gtk_init(), gtk_init_check(), gdk_init(), or gdk_init_check().
242 gdk_parse_args (int *argc,
245 GOptionContext *option_context;
246 GOptionGroup *option_group;
247 GError *error = NULL;
252 gdk_pre_parse_libgtk_only ();
254 option_context = g_option_context_new (NULL);
255 g_option_context_set_ignore_unknown_options (option_context, TRUE);
256 g_option_context_set_help_enabled (option_context, FALSE);
257 option_group = g_option_group_new (NULL, NULL, NULL, NULL, NULL);
258 g_option_context_set_main_group (option_context, option_group);
260 g_option_group_add_entries (option_group, gdk_args);
261 g_option_group_add_entries (option_group, _gdk_windowing_args);
263 if (!g_option_context_parse (option_context, argc, argv, &error))
265 g_warning ("%s", error->message);
266 g_error_free (error);
268 g_option_context_free (option_context);
270 if (_gdk_debug_flags && GDK_DEBUG_GDKRGB)
271 gdk_rgb_set_verbose (TRUE);
273 GDK_NOTE (MISC, g_message ("progname: \"%s\"", g_get_prgname ()));
277 * gdk_get_display_arg_name:
279 * Gets the display name specified in the command line arguments passed
280 * to gdk_init() or gdk_parse_args(), if any.
282 * Returns: the display name, if specified explicitely, otherwise %NULL
283 * this string is owned by GTK+ and must not be modified or freed.
287 G_CONST_RETURN gchar *
288 gdk_get_display_arg_name (void)
290 if (!_gdk_display_arg_name)
292 if (_gdk_screen_number >= 0)
293 _gdk_display_arg_name = _gdk_windowing_substitute_screen_number (_gdk_display_name, _gdk_screen_number);
295 _gdk_display_arg_name = g_strdup (_gdk_display_name);
298 return _gdk_display_arg_name;
302 * gdk_display_open_default_libgtk_only:
304 * Opens the default display specified by command line arguments or
305 * environment variables, sets it as the default display, and returns
306 * it. gdk_parse_args must have been called first. If the default
307 * display has previously been set, simply returns that. An internal
308 * function that should not be used by applications.
310 * Return value: the default display, if it could be opened,
314 gdk_display_open_default_libgtk_only (void)
318 g_return_val_if_fail (gdk_initialized, NULL);
320 display = gdk_display_get_default ();
324 display = gdk_display_open (gdk_get_display_arg_name ());
326 if (!display && _gdk_screen_number >= 0)
328 g_free (_gdk_display_arg_name);
329 _gdk_display_arg_name = g_strdup (_gdk_display_name);
331 display = gdk_display_open (_gdk_display_name);
335 gdk_display_manager_set_default_display (gdk_display_manager_get (),
342 *--------------------------------------------------------------
345 * Initialize the library for use.
348 * "argc" is the number of arguments.
349 * "argv" is an array of strings.
352 * "argc" and "argv" are modified to reflect any arguments
353 * which were not handled. (Such arguments should either
354 * be handled by the application or dismissed). If initialization
355 * fails, returns FALSE, otherwise TRUE.
358 * The library is initialized.
360 *--------------------------------------------------------------
364 gdk_init_check (int *argc,
367 gdk_parse_args (argc, argv);
369 return gdk_display_open_default_libgtk_only () != NULL;
373 gdk_init (int *argc, char ***argv)
375 if (!gdk_init_check (argc, argv))
377 const char *display_name = gdk_get_display_arg_name ();
378 g_warning ("cannot open display: %s", display_name ? display_name : "");
384 *--------------------------------------------------------------
387 * Restores the library to an un-itialized state and exits
388 * the program using the "exit" system call.
391 * "errorcode" is the error value to pass to "exit".
394 * Allocated structures are freed and the program exits
399 *--------------------------------------------------------------
403 gdk_exit (gint errorcode)
409 gdk_threads_enter (void)
411 GDK_THREADS_ENTER ();
415 gdk_threads_leave (void)
417 GDK_THREADS_LEAVE ();
421 gdk_threads_impl_lock (void)
423 if (gdk_threads_mutex)
424 g_mutex_lock (gdk_threads_mutex);
428 gdk_threads_impl_unlock (void)
430 if (gdk_threads_mutex)
431 g_mutex_unlock (gdk_threads_mutex);
437 * Initializes GDK so that it can be used from multiple threads
438 * in conjunction with gdk_threads_enter() and gdk_threads_leave().
439 * g_thread_init() must be called previous to this function.
441 * This call must be made before any use of the main loop from
442 * GTK+; to be safe, call it before gtk_init().
445 gdk_threads_init (void)
447 if (!g_thread_supported ())
448 g_error ("g_thread_init() must be called before gdk_threads_init()");
450 gdk_threads_mutex = g_mutex_new ();
451 if (!gdk_threads_lock)
452 gdk_threads_lock = gdk_threads_impl_lock;
453 if (!gdk_threads_unlock)
454 gdk_threads_unlock = gdk_threads_impl_unlock;
458 * gdk_threads_set_lock_functions:
459 * @enter_fn: function called to guard GDK
460 * @leave_fn: function called to release the guard
462 * Allows the application to replace the standard method that
463 * GDK uses to protect its data structures. Normally, GDK
464 * creates a single #GMutex that is locked by gdk_threads_enter(),
465 * and released by gdk_threads_leave(); using this function an
466 * application provides, instead, a function @enter_fn that is
467 * called by gdk_threads_enter() and a function @leave_fn that is
468 * called by gdk_threads_leave().
470 * The functions must provide at least same locking functionality
471 * as the default implementation, but can also do extra application
472 * specific processing.
474 * As an example, consider an application that has its own recursive
475 * lock that when held, holds the GTK+ lock as well. When GTK+ unlocks
476 * the GTK+ lock when entering a recursive main loop, the application
477 * must temporarily release its lock as well.
479 * Most threaded GTK+ apps won't need to use this method.
481 * This method must be called before gdk_threads_init(), and cannot
482 * be called multiple times.
487 gdk_threads_set_lock_functions (GCallback enter_fn,
490 g_return_if_fail (gdk_threads_lock == NULL &&
491 gdk_threads_unlock == NULL);
493 gdk_threads_lock = enter_fn;
494 gdk_threads_unlock = leave_fn;
498 gdk_threads_dispatch (gpointer data)
500 GdkThreadsDispatch *dispatch = data;
501 gboolean ret = FALSE;
503 GDK_THREADS_ENTER ();
505 if (!g_source_is_destroyed (g_main_current_source ()))
506 ret = dispatch->func (dispatch->data);
508 GDK_THREADS_LEAVE ();
514 gdk_threads_dispatch_free (gpointer data)
516 GdkThreadsDispatch *dispatch = data;
518 if (dispatch->destroy && dispatch->data)
519 dispatch->destroy (dispatch->data);
521 g_slice_free (GdkThreadsDispatch, data);
526 * gdk_threads_add_idle_full:
527 * @priority: the priority of the idle source. Typically this will be in the
528 * range btweeen #G_PRIORITY_DEFAULT_IDLE and #G_PRIORITY_HIGH_IDLE
529 * @function: function to call
530 * @data: data to pass to @function
531 * @notify: function to call when the idle is removed, or %NULL
533 * Adds a function to be called whenever there are no higher priority
534 * events pending. If the function returns %FALSE it is automatically
535 * removed from the list of event sources and will not be called again.
537 * This variant of g_idle_add_full() calls @function with the GDK lock
538 * held. It can be thought of a MT-safe version for GTK+ widgets for the
539 * following use case, where you have to worry about idle_callback()
540 * running in thread A and accessing @self after it has been finalized
545 * idle_callback (gpointer data)
547 * /* gdk_threads_enter(); would be needed for g_idle_add() */
549 * SomeWidget *self = data;
550 * /* do stuff with self */
554 * /* gdk_threads_leave(); would be needed for g_idle_add() */
559 * some_widget_do_stuff_later (SomeWidget *self)
561 * self->idle_id = gdk_threads_add_idle (idle_callback, self)
562 * /* using g_idle_add() here would require thread protection in the callback */
566 * some_widget_finalize (GObject *object)
568 * SomeWidget *self = SOME_WIDGET (object);
570 * g_source_remove (self->idle_id);
571 * G_OBJECT_CLASS (parent_class)->finalize (object);
575 * Return value: the ID (greater than 0) of the event source.
580 gdk_threads_add_idle_full (gint priority,
581 GSourceFunc function,
583 GDestroyNotify notify)
585 GdkThreadsDispatch *dispatch;
587 g_return_val_if_fail (function != NULL, 0);
589 dispatch = g_slice_new (GdkThreadsDispatch);
590 dispatch->func = function;
591 dispatch->data = data;
592 dispatch->destroy = notify;
594 return g_idle_add_full (priority,
595 gdk_threads_dispatch,
597 gdk_threads_dispatch_free);
601 * gdk_threads_add_idle:
602 * @function: function to call
603 * @data: data to pass to @function
605 * A wrapper for the common usage of gdk_threads_add_idle_full()
606 * assigning the default priority, #G_PRIORITY_DEFAULT_IDLE.
608 * See gdk_threads_add_idle_full().
610 * Return value: the ID (greater than 0) of the event source.
615 gdk_threads_add_idle (GSourceFunc function,
618 return gdk_threads_add_idle_full (G_PRIORITY_DEFAULT_IDLE,
619 function, data, NULL);
624 * gdk_threads_add_timeout_full:
625 * @priority: the priority of the timeout source. Typically this will be in the
626 * range between #G_PRIORITY_DEFAULT_IDLE and #G_PRIORITY_HIGH_IDLE.
627 * @interval: the time between calls to the function, in milliseconds
628 * (1/1000ths of a second)
629 * @function: function to call
630 * @data: data to pass to @function
631 * @notify: function to call when the timeout is removed, or %NULL
633 * Sets a function to be called at regular intervals holding the GDK lock,
634 * with the given priority. The function is called repeatedly until it
635 * returns %FALSE, at which point the timeout is automatically destroyed
636 * and the function will not be called again. The @notify function is
637 * called when the timeout is destroyed. The first call to the
638 * function will be at the end of the first @interval.
640 * Note that timeout functions may be delayed, due to the processing of other
641 * event sources. Thus they should not be relied on for precise timing.
642 * After each call to the timeout function, the time of the next
643 * timeout is recalculated based on the current time and the given interval
644 * (it does not try to 'catch up' time lost in delays).
646 * This variant of g_timeout_add_full() can be thought of a MT-safe version
647 * for GTK+ widgets for the following use case:
650 * static gboolean timeout_callback (gpointer data)
652 * SomeWidget *self = data;
654 * /* do stuff with self */
656 * self->timeout_id = 0;
661 * static void some_widget_do_stuff_later (SomeWidget *self)
663 * self->timeout_id = g_timeout_add (timeout_callback, self)
666 * static void some_widget_finalize (GObject *object)
668 * SomeWidget *self = SOME_WIDGET (object);
670 * if (self->timeout_id)
671 * g_source_remove (self->timeout_id);
673 * G_OBJECT_CLASS (parent_class)->finalize (object);
677 * Return value: the ID (greater than 0) of the event source.
682 gdk_threads_add_timeout_full (gint priority,
684 GSourceFunc function,
686 GDestroyNotify notify)
688 GdkThreadsDispatch *dispatch;
690 g_return_val_if_fail (function != NULL, 0);
692 dispatch = g_slice_new (GdkThreadsDispatch);
693 dispatch->func = function;
694 dispatch->data = data;
695 dispatch->destroy = notify;
697 return g_timeout_add_full (priority,
699 gdk_threads_dispatch,
701 gdk_threads_dispatch_free);
705 * gdk_threads_add_timeout:
706 * @interval: the time between calls to the function, in milliseconds
707 * (1/1000ths of a second)
708 * @function: function to call
709 * @data: data to pass to @function
711 * A wrapper for the common usage of gdk_threads_add_timeout_full()
712 * assigning the default priority, #G_PRIORITY_DEFAULT.
714 * See gdk_threads_add_timeout_full().
716 * Return value: the ID (greater than 0) of the event source.
721 gdk_threads_add_timeout (guint interval,
722 GSourceFunc function,
725 return gdk_threads_add_timeout_full (G_PRIORITY_DEFAULT,
726 interval, function, data, NULL);
731 * gdk_threads_add_timeout_seconds_full:
732 * @priority: the priority of the timeout source. Typically this will be in the
733 * range between #G_PRIORITY_DEFAULT_IDLE and #G_PRIORITY_HIGH_IDLE.
734 * @interval: the time between calls to the function, in seconds
735 * @function: function to call
736 * @data: data to pass to @function
737 * @notify: function to call when the timeout is removed, or %NULL
739 * A variant of gdk_threads_add_timout_full() with second-granularity.
740 * See g_timeout_add_seconds_full() for a discussion of why it is
741 * a good idea to use this function if you don't need finer granularity.
743 * Return value: the ID (greater than 0) of the event source.
748 gdk_threads_add_timeout_seconds_full (gint priority,
750 GSourceFunc function,
752 GDestroyNotify notify)
754 GdkThreadsDispatch *dispatch;
756 g_return_val_if_fail (function != NULL, 0);
758 dispatch = g_slice_new (GdkThreadsDispatch);
759 dispatch->func = function;
760 dispatch->data = data;
761 dispatch->destroy = notify;
763 return g_timeout_add_seconds_full (priority,
765 gdk_threads_dispatch,
767 gdk_threads_dispatch_free);
771 * gdk_threads_add_timeout_seconds:
772 * @interval: the time between calls to the function, in seconds
773 * @function: function to call
774 * @data: data to pass to @function
776 * A wrapper for the common usage of gdk_threads_add_timeout_seconds_full()
777 * assigning the default priority, #G_PRIORITY_DEFAULT.
779 * For details, see gdk_threads_add_timeout_full().
781 * Return value: the ID (greater than 0) of the event source.
786 gdk_threads_add_timeout_seconds (guint interval,
787 GSourceFunc function,
790 return gdk_threads_add_timeout_seconds_full (G_PRIORITY_DEFAULT,
791 interval, function, data, NULL);
795 G_CONST_RETURN char *
796 gdk_get_program_class (void)
798 return gdk_progclass;
802 gdk_set_program_class (const char *program_class)
804 g_free (gdk_progclass);
806 gdk_progclass = g_strdup (program_class);
810 #include "gdkaliasdef.c"