/* GDK - The GIMP Drawing Kit * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public * 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 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * Lesser General Public License for more details. * * You should have received a copy of the GNU Lesser General Public * License along with this library; if not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Boston, MA 02111-1307, USA. */ /* * Modified by the GTK+ Team and others 1997-2000. See the AUTHORS * 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/. */ #include "config.h" #include #include #include "gdk.h" #include "gdkinternals.h" #include "gdkintl.h" #ifndef HAVE_XCONVERTCASE #include "gdkkeysyms.h" #endif #include "gdkalias.h" typedef struct _GdkPredicate GdkPredicate; struct _GdkPredicate { GdkEventFunc func; gpointer data; }; typedef struct _GdkThreadsDispatch GdkThreadsDispatch; struct _GdkThreadsDispatch { GSourceFunc func; gpointer data; GDestroyNotify destroy; }; /* Private variable declarations */ static int gdk_initialized = 0; /* 1 if the library is initialized, * 0 otherwise. */ static gchar *gdk_progclass = NULL; #ifdef G_ENABLE_DEBUG static const GDebugKey gdk_debug_keys[] = { {"events", GDK_DEBUG_EVENTS}, {"misc", GDK_DEBUG_MISC}, {"dnd", GDK_DEBUG_DND}, {"xim", GDK_DEBUG_XIM}, {"nograbs", GDK_DEBUG_NOGRABS}, {"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}, {"multihead", GDK_DEBUG_MULTIHEAD}, {"xinerama", GDK_DEBUG_XINERAMA}, {"draw", GDK_DEBUG_DRAW}, {"eventloop", GDK_DEBUG_EVENTLOOP} }; static const int gdk_ndebug_keys = G_N_ELEMENTS (gdk_debug_keys); #endif /* G_ENABLE_DEBUG */ #ifdef G_ENABLE_DEBUG static gboolean gdk_arg_debug_cb (const char *key, const char *value, gpointer user_data, GError **error) { 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-debug")); return FALSE; } _gdk_debug_flags |= debug_value; return TRUE; } static gboolean gdk_arg_no_debug_cb (const char *key, const char *value, gpointer user_data, GError **error) { 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; } #endif /* G_ENABLE_DEBUG */ static gboolean gdk_arg_class_cb (const char *key, const char *value, gpointer user_data, GError **error) { gdk_set_program_class (value); return TRUE; } static gboolean gdk_arg_name_cb (const char *key, const char *value, gpointer user_data, GError **error) { g_set_prgname (value); return TRUE; } static const GOptionEntry gdk_args[] = { { "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") }, #ifdef G_ENABLE_DEBUG { "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 { NULL } }; /** * gdk_add_option_entries_libgtk_only: * @group: An option group. * * Appends gdk option entries to the passed in option group. This is * not public API and must not be used by applications. **/ void gdk_add_option_entries_libgtk_only (GOptionGroup *group) { 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 */ if (getenv ("GDK_NATIVE_WINDOWS")) { _gdk_native_windows = TRUE; /* Ensure that this is not propagated to spawned applications */ g_unsetenv ("GDK_NATIVE_WINDOWS"); } g_type_init (); /* Do any setup particular to the windowing system */ _gdk_windowing_init (); } /** * gdk_parse_args: * @argc: the number of command line arguments. * @argv: (inout) (array length=argc): the array of command line arguments. * * Parse command line arguments, and store for future * use by calls to gdk_display_open(). * * Any arguments used by GDK are removed from the array and @argc and @argv are * updated accordingly. * * You shouldn't call this function explicitely if you are using * gtk_init(), gtk_init_check(), gdk_init(), or gdk_init_check(). * * Since: 2.2 **/ void gdk_parse_args (int *argc, char ***argv) { GOptionContext *option_context; GOptionGroup *option_group; GError *error = NULL; if (gdk_initialized) return; gdk_pre_parse_libgtk_only (); 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); g_option_group_add_entries (option_group, gdk_args); g_option_group_add_entries (option_group, _gdk_windowing_args); if (!g_option_context_parse (option_context, argc, argv, &error)) { g_warning ("%s", error->message); g_error_free (error); } g_option_context_free (option_context); if (_gdk_debug_flags && GDK_DEBUG_GDKRGB) gdk_rgb_set_verbose (TRUE); GDK_NOTE (MISC, g_message ("progname: \"%s\"", g_get_prgname ())); } /** * 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 * this string is owned by GTK+ and must not be modified or freed. * * Since: 2.2 */ const gchar * gdk_get_display_arg_name (void) { 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; g_return_val_if_fail (gdk_initialized, NULL); 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; } /** * gdk_init_check: * @argc: (inout): * @argv: (array length=argc) (inout): * * 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); return gdk_display_open_default_libgtk_only () != NULL; } /** * gdk_init: * @argc: (inout): * @argv: (array length=argc) (inout): */ void gdk_init (int *argc, char ***argv) { if (!gdk_init_check (argc, argv)) { const char *display_name = gdk_get_display_arg_name (); g_warning ("cannot open display: %s", display_name ? display_name : ""); exit(1); } } /* *-------------------------------------------------------------- * gdk_exit * * Restores the library to an un-itialized state and exits * the program using the "exit" system call. * * Arguments: * "errorcode" is the error value to pass to "exit". * * Results: * Allocated structures are freed and the program exits * cleanly. * * Side effects: * *-------------------------------------------------------------- */ void gdk_exit (gint errorcode) { exit (errorcode); } void gdk_threads_enter (void) { GDK_THREADS_ENTER (); } void gdk_threads_leave (void) { GDK_THREADS_LEAVE (); } 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) { /* 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); g_mutex_unlock (gdk_threads_mutex); } } /** * gdk_threads_init: * * Initializes GDK so that it can be used from multiple threads * in conjunction with gdk_threads_enter() and gdk_threads_leave(). * g_thread_init() must be called previous to this function. * * This call must be made before any use of the main loop from * GTK+; to be safe, call it before gtk_init(). **/ void gdk_threads_init (void) { if (!g_thread_supported ()) g_error ("g_thread_init() must be called before gdk_threads_init()"); gdk_threads_mutex = g_mutex_new (); 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: * @enter_fn: function called to guard GDK * @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. * * This method must be called before gdk_threads_init(), and cannot * be called multiple times. * * Since: 2.4 **/ 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; } 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 * @notify: (allow-none): function to call when the idle is removed, or %NULL * * 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: * * |[ * static gboolean * idle_callback (gpointer data) * { * /* gdk_threads_enter(); would be needed for g_idle_add() */ * * SomeWidget *self = data; * /* do stuff with self */ * * self->idle_id = 0; * * /* gdk_threads_leave(); would be needed for g_idle_add() */ * return FALSE; * } * * static void * some_widget_do_stuff_later (SomeWidget *self) * { * self->idle_id = gdk_threads_add_idle (idle_callback, self) * /* using g_idle_add() here would require thread protection in the callback */ * } * * static void * some_widget_finalize (GObject *object) * { * SomeWidget *self = SOME_WIDGET (object); * if (self->idle_id) * g_source_remove (self->idle_id); * G_OBJECT_CLASS (parent_class)->finalize (object); * } * ]| * * 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, gdk_threads_dispatch, dispatch, 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(). * * Return value: the ID (greater than 0) of the event source. * * 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 * @notify: (allow-none): function to call when the timeout is removed, or %NULL * * 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: * * |[ * static gboolean timeout_callback (gpointer data) * { * SomeWidget *self = data; * * /* do stuff with self */ * * self->timeout_id = 0; * * return FALSE; * } * * static void some_widget_do_stuff_later (SomeWidget *self) * { * self->timeout_id = g_timeout_add (timeout_callback, self) * } * * static void some_widget_finalize (GObject *object) * { * SomeWidget *self = SOME_WIDGET (object); * * if (self->timeout_id) * g_source_remove (self->timeout_id); * * G_OBJECT_CLASS (parent_class)->finalize (object); * } * ]| * * 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(). * * Return value: the ID (greater than 0) of the event source. * * 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); } /** * 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 * @notify: (allow-none): function to call when the timeout is removed, or %NULL * * 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); } const char * gdk_get_program_class (void) { return gdk_progclass; } void gdk_set_program_class (const char *program_class) { g_free (gdk_progclass); gdk_progclass = g_strdup (program_class); } #define __GDK_C__ #include "gdkaliasdef.c"