1 /* GLIB - Library of useful routines for C programming
2 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
4 * gmain.c: Main loop abstraction, timeouts, and idle functions
5 * Copyright 1998 Owen Taylor
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2 of the License, or (at your option) any later version.
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this library; if not, write to the
19 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 * Boston, MA 02111-1307, USA.
24 * Modified by the GLib Team and others 1997-2000. See the AUTHORS
25 * file for a list of people on the GLib Team. See the ChangeLog
26 * files for a list of changes. These files are distributed with
27 * GLib at ftp://ftp.gtk.org/pub/gtk/.
35 #include "glibconfig.h"
37 /* Uncomment the next line (and the corresponding line in gpoll.c) to
38 * enable debugging printouts if the environment variable
39 * G_MAIN_POLL_DEBUG is set to some value.
41 /* #define G_MAIN_POLL_DEBUG */
44 /* Always enable debugging printout on Windows, as it is more often
47 #define G_MAIN_POLL_DEBUG
51 #include "glib-unix.h"
53 #include <sys/eventfd.h>
58 #include <sys/types.h>
61 #ifdef HAVE_SYS_TIME_H
63 #endif /* HAVE_SYS_TIME_H */
66 #endif /* HAVE_UNISTD_H */
73 #endif /* G_OS_WIN32 */
76 #include <sys/socket.h>
78 #endif /* G_OS_BEOS */
83 #include "giochannel.h"
87 #include "gstrfuncs.h"
88 #include "gtestutils.h"
89 #include "gthreadprivate.h"
95 #ifdef G_MAIN_POLL_DEBUG
101 #include "glib-private.h"
105 * @title: The Main Event Loop
106 * @short_description: manages all available sources of events
108 * The main event loop manages all the available sources of events for
109 * GLib and GTK+ applications. These events can come from any number of
110 * different types of sources such as file descriptors (plain files,
111 * pipes or sockets) and timeouts. New types of event sources can also
112 * be added using g_source_attach().
114 * To allow multiple independent sets of sources to be handled in
115 * different threads, each source is associated with a #GMainContext.
116 * A GMainContext can only be running in a single thread, but
117 * sources can be added to it and removed from it from other threads.
119 * Each event source is assigned a priority. The default priority,
120 * #G_PRIORITY_DEFAULT, is 0. Values less than 0 denote higher priorities.
121 * Values greater than 0 denote lower priorities. Events from high priority
122 * sources are always processed before events from lower priority sources.
124 * Idle functions can also be added, and assigned a priority. These will
125 * be run whenever no events with a higher priority are ready to be processed.
127 * The #GMainLoop data type represents a main event loop. A GMainLoop is
128 * created with g_main_loop_new(). After adding the initial event sources,
129 * g_main_loop_run() is called. This continuously checks for new events from
130 * each of the event sources and dispatches them. Finally, the processing of
131 * an event from one of the sources leads to a call to g_main_loop_quit() to
132 * exit the main loop, and g_main_loop_run() returns.
134 * It is possible to create new instances of #GMainLoop recursively.
135 * This is often used in GTK+ applications when showing modal dialog
136 * boxes. Note that event sources are associated with a particular
137 * #GMainContext, and will be checked and dispatched for all main
138 * loops associated with that GMainContext.
140 * GTK+ contains wrappers of some of these functions, e.g. gtk_main(),
141 * gtk_main_quit() and gtk_events_pending().
143 * <refsect2><title>Creating new source types</title>
144 * <para>One of the unusual features of the #GMainLoop functionality
145 * is that new types of event source can be created and used in
146 * addition to the builtin type of event source. A new event source
147 * type is used for handling GDK events. A new source type is created
148 * by <firstterm>deriving</firstterm> from the #GSource structure.
149 * The derived type of source is represented by a structure that has
150 * the #GSource structure as a first element, and other elements specific
151 * to the new source type. To create an instance of the new source type,
152 * call g_source_new() passing in the size of the derived structure and
153 * a table of functions. These #GSourceFuncs determine the behavior of
154 * the new source type.</para>
155 * <para>New source types basically interact with the main context
156 * in two ways. Their prepare function in #GSourceFuncs can set a timeout
157 * to determine the maximum amount of time that the main loop will sleep
158 * before checking the source again. In addition, or as well, the source
159 * can add file descriptors to the set that the main context checks using
160 * g_source_add_poll().</para>
162 * <refsect2><title>Customizing the main loop iteration</title>
163 * <para>Single iterations of a #GMainContext can be run with
164 * g_main_context_iteration(). In some cases, more detailed control
165 * of exactly how the details of the main loop work is desired, for
166 * instance, when integrating the #GMainLoop with an external main loop.
167 * In such cases, you can call the component functions of
168 * g_main_context_iteration() directly. These functions are
169 * g_main_context_prepare(), g_main_context_query(),
170 * g_main_context_check() and g_main_context_dispatch().</para>
171 * <para>The operation of these functions can best be seen in terms
172 * of a state diagram, as shown in <xref linkend="mainloop-states"/>.</para>
173 * <figure id="mainloop-states"><title>States of a Main Context</title>
174 * <graphic fileref="mainloop-states.gif" format="GIF"></graphic>
181 typedef struct _GTimeoutSource GTimeoutSource;
182 typedef struct _GChildWatchSource GChildWatchSource;
183 typedef struct _GUnixSignalWatchSource GUnixSignalWatchSource;
184 typedef struct _GPollRec GPollRec;
185 typedef struct _GSourceCallback GSourceCallback;
189 G_SOURCE_READY = 1 << G_HOOK_FLAG_USER_SHIFT,
190 G_SOURCE_CAN_RECURSE = 1 << (G_HOOK_FLAG_USER_SHIFT + 1)
193 typedef struct _GMainWaiter GMainWaiter;
201 typedef struct _GMainDispatch GMainDispatch;
203 struct _GMainDispatch
206 GSList *dispatching_sources; /* stack of current sources */
209 #ifdef G_MAIN_POLL_DEBUG
210 gboolean _g_main_poll_debug = FALSE;
215 /* The following lock is used for both the list of sources
216 * and the list of poll records
226 GPtrArray *pending_dispatches;
227 gint timeout; /* Timeout for current iteration */
230 GSource *source_list;
231 gint in_check_or_prepare;
233 GPollRec *poll_records, *poll_records_tail;
234 guint n_poll_records;
235 GPollFD *cached_poll_array;
236 guint cached_poll_array_size;
242 /* Flag indicating whether the set of fd's changed during a poll */
243 gboolean poll_changed;
248 gboolean time_is_fresh;
251 struct _GSourceCallback
256 GDestroyNotify notify;
261 GMainContext *context;
266 struct _GTimeoutSource
274 struct _GChildWatchSource
281 #else /* G_OS_WIN32 */
282 gboolean child_exited;
283 #endif /* G_OS_WIN32 */
286 struct _GUnixSignalWatchSource
301 struct _GSourcePrivate
303 GSList *child_sources;
304 GSource *parent_source;
307 #define LOCK_CONTEXT(context) g_static_mutex_lock (&context->mutex)
308 #define UNLOCK_CONTEXT(context) g_static_mutex_unlock (&context->mutex)
309 #define G_THREAD_SELF g_thread_self ()
311 #define SOURCE_DESTROYED(source) (((source)->flags & G_HOOK_FLAG_ACTIVE) == 0)
312 #define SOURCE_BLOCKED(source) (((source)->flags & G_HOOK_FLAG_IN_CALL) != 0 && \
313 ((source)->flags & G_SOURCE_CAN_RECURSE) == 0)
315 #define SOURCE_UNREF(source, context) \
317 if ((source)->ref_count > 1) \
318 (source)->ref_count--; \
320 g_source_unref_internal ((source), (context), TRUE); \
324 /* Forward declarations */
326 static void g_source_unref_internal (GSource *source,
327 GMainContext *context,
329 static void g_source_destroy_internal (GSource *source,
330 GMainContext *context,
332 static void g_source_set_priority_unlocked (GSource *source,
333 GMainContext *context,
335 static void g_main_context_poll (GMainContext *context,
340 static void g_main_context_add_poll_unlocked (GMainContext *context,
343 static void g_main_context_remove_poll_unlocked (GMainContext *context,
346 static gboolean g_timeout_prepare (GSource *source,
348 static gboolean g_timeout_check (GSource *source);
349 static gboolean g_timeout_dispatch (GSource *source,
350 GSourceFunc callback,
352 static gboolean g_child_watch_prepare (GSource *source,
354 static gboolean g_child_watch_check (GSource *source);
355 static gboolean g_child_watch_dispatch (GSource *source,
356 GSourceFunc callback,
358 static void g_child_watch_finalize (GSource *source);
360 static void g_unix_signal_handler (int signum);
361 static gboolean g_unix_signal_watch_prepare (GSource *source,
363 static gboolean g_unix_signal_watch_check (GSource *source);
364 static gboolean g_unix_signal_watch_dispatch (GSource *source,
365 GSourceFunc callback,
367 static void g_unix_signal_watch_finalize (GSource *source);
369 static gboolean g_idle_prepare (GSource *source,
371 static gboolean g_idle_check (GSource *source);
372 static gboolean g_idle_dispatch (GSource *source,
373 GSourceFunc callback,
376 static GMainContext *glib_worker_context;
378 G_LOCK_DEFINE_STATIC (main_loop);
379 static GMainContext *default_main_context;
384 /* UNIX signals work by marking one of these variables then waking the
385 * worker context to check on them and dispatch accordingly.
387 static volatile gchar unix_signal_pending[NSIG];
388 static volatile gboolean any_unix_signal_pending;
390 /* Guards all the data below */
391 G_LOCK_DEFINE_STATIC (unix_signal_lock);
392 static GSList *unix_signal_watches;
393 static GSList *unix_child_watches;
395 static GSourceFuncs g_unix_signal_funcs =
397 g_unix_signal_watch_prepare,
398 g_unix_signal_watch_check,
399 g_unix_signal_watch_dispatch,
400 g_unix_signal_watch_finalize
402 #endif /* !G_OS_WIN32 */
403 G_LOCK_DEFINE_STATIC (main_context_list);
404 static GSList *main_context_list = NULL;
406 GSourceFuncs g_timeout_funcs =
414 GSourceFuncs g_child_watch_funcs =
416 g_child_watch_prepare,
418 g_child_watch_dispatch,
419 g_child_watch_finalize
422 GSourceFuncs g_idle_funcs =
431 * g_main_context_ref:
432 * @context: a #GMainContext
434 * Increases the reference count on a #GMainContext object by one.
436 * Returns: the @context that was passed in (since 2.6)
439 g_main_context_ref (GMainContext *context)
441 g_return_val_if_fail (context != NULL, NULL);
442 g_return_val_if_fail (g_atomic_int_get (&context->ref_count) > 0, NULL);
444 g_atomic_int_inc (&context->ref_count);
450 poll_rec_list_free (GMainContext *context,
453 g_slice_free_chain (GPollRec, list, next);
457 * g_main_context_unref:
458 * @context: a #GMainContext
460 * Decreases the reference count on a #GMainContext object by one. If
461 * the result is zero, free the context and free all associated memory.
464 g_main_context_unref (GMainContext *context)
467 g_return_if_fail (context != NULL);
468 g_return_if_fail (g_atomic_int_get (&context->ref_count) > 0);
470 if (!g_atomic_int_dec_and_test (&context->ref_count))
473 G_LOCK (main_context_list);
474 main_context_list = g_slist_remove (main_context_list, context);
475 G_UNLOCK (main_context_list);
477 source = context->source_list;
480 GSource *next = source->next;
481 g_source_destroy_internal (source, context, FALSE);
485 g_static_mutex_free (&context->mutex);
487 g_ptr_array_free (context->pending_dispatches, TRUE);
488 g_free (context->cached_poll_array);
490 poll_rec_list_free (context, context->poll_records);
492 g_wakeup_free (context->wakeup);
494 if (context->cond != NULL)
495 g_cond_free (context->cond);
501 g_main_context_init_pipe (GMainContext *context)
503 context->wakeup = g_wakeup_new ();
504 g_wakeup_get_pollfd (context->wakeup, &context->wake_up_rec);
505 g_main_context_add_poll_unlocked (context, 0, &context->wake_up_rec);
509 * g_main_context_new:
511 * Creates a new #GMainContext structure.
513 * Return value: the new #GMainContext
516 g_main_context_new (void)
518 GMainContext *context;
520 g_thread_init_glib ();
522 context = g_new0 (GMainContext, 1);
524 #ifdef G_MAIN_POLL_DEBUG
526 static gboolean beenhere = FALSE;
530 if (getenv ("G_MAIN_POLL_DEBUG") != NULL)
531 _g_main_poll_debug = TRUE;
537 g_static_mutex_init (&context->mutex);
539 context->owner = NULL;
540 context->waiters = NULL;
542 context->ref_count = 1;
544 context->next_id = 1;
546 context->source_list = NULL;
548 context->poll_func = g_poll;
550 context->cached_poll_array = NULL;
551 context->cached_poll_array_size = 0;
553 context->pending_dispatches = g_ptr_array_new ();
555 context->time_is_fresh = FALSE;
557 g_main_context_init_pipe (context);
559 G_LOCK (main_context_list);
560 main_context_list = g_slist_append (main_context_list, context);
562 #ifdef G_MAIN_POLL_DEBUG
563 if (_g_main_poll_debug)
564 g_print ("created context=%p\n", context);
567 G_UNLOCK (main_context_list);
573 * g_main_context_default:
575 * Returns the global default main context. This is the main context
576 * used for main loop functions when a main loop is not explicitly
577 * specified, and corresponds to the "main" main loop. See also
578 * g_main_context_get_thread_default().
580 * Return value: (transfer none): the global default main context.
583 g_main_context_default (void)
589 if (!default_main_context)
591 default_main_context = g_main_context_new ();
592 #ifdef G_MAIN_POLL_DEBUG
593 if (_g_main_poll_debug)
594 g_print ("default context=%p\n", default_main_context);
598 G_UNLOCK (main_loop);
600 return default_main_context;
603 static GStaticPrivate thread_context_stack = G_STATIC_PRIVATE_INIT;
606 free_context_stack (gpointer data)
608 GQueue *stack = data;
609 GMainContext *context;
611 while (!g_queue_is_empty (stack))
613 context = g_queue_pop_head (stack);
614 g_main_context_release (context);
616 g_main_context_unref (context);
618 g_queue_free (stack);
622 * g_main_context_push_thread_default:
623 * @context: a #GMainContext, or %NULL for the global default context
625 * Acquires @context and sets it as the thread-default context for the
626 * current thread. This will cause certain asynchronous operations
627 * (such as most <link linkend="gio">gio</link>-based I/O) which are
628 * started in this thread to run under @context and deliver their
629 * results to its main loop, rather than running under the global
630 * default context in the main thread. Note that calling this function
631 * changes the context returned by
632 * g_main_context_get_thread_default(), <emphasis>not</emphasis> the
633 * one returned by g_main_context_default(), so it does not affect the
634 * context used by functions like g_idle_add().
636 * Normally you would call this function shortly after creating a new
637 * thread, passing it a #GMainContext which will be run by a
638 * #GMainLoop in that thread, to set a new default context for all
639 * async operations in that thread. (In this case, you don't need to
640 * ever call g_main_context_pop_thread_default().) In some cases
641 * however, you may want to schedule a single operation in a
642 * non-default context, or temporarily use a non-default context in
643 * the main thread. In that case, you can wrap the call to the
644 * asynchronous operation inside a
645 * g_main_context_push_thread_default() /
646 * g_main_context_pop_thread_default() pair, but it is up to you to
647 * ensure that no other asynchronous operations accidentally get
648 * started while the non-default context is active.
650 * Beware that libraries that predate this function may not correctly
651 * handle being used from a thread with a thread-default context. Eg,
652 * see g_file_supports_thread_contexts().
657 g_main_context_push_thread_default (GMainContext *context)
660 gboolean acquired_context;
662 acquired_context = g_main_context_acquire (context);
663 g_return_if_fail (acquired_context);
665 if (context == g_main_context_default ())
668 g_main_context_ref (context);
670 stack = g_static_private_get (&thread_context_stack);
673 stack = g_queue_new ();
674 g_static_private_set (&thread_context_stack, stack,
678 g_queue_push_head (stack, context);
682 * g_main_context_pop_thread_default:
683 * @context: a #GMainContext object, or %NULL
685 * Pops @context off the thread-default context stack (verifying that
686 * it was on the top of the stack).
691 g_main_context_pop_thread_default (GMainContext *context)
695 if (context == g_main_context_default ())
698 stack = g_static_private_get (&thread_context_stack);
700 g_return_if_fail (stack != NULL);
701 g_return_if_fail (g_queue_peek_head (stack) == context);
703 g_queue_pop_head (stack);
705 g_main_context_release (context);
707 g_main_context_unref (context);
711 * g_main_context_get_thread_default:
713 * Gets the thread-default #GMainContext for this thread. Asynchronous
714 * operations that want to be able to be run in contexts other than
715 * the default one should call this method to get a #GMainContext to
716 * add their #GSource<!-- -->s to. (Note that even in single-threaded
717 * programs applications may sometimes want to temporarily push a
718 * non-default context, so it is not safe to assume that this will
719 * always return %NULL if threads are not initialized.)
721 * Returns: (transfer none): the thread-default #GMainContext, or
722 * %NULL if the thread-default context is the global default context.
727 g_main_context_get_thread_default (void)
731 stack = g_static_private_get (&thread_context_stack);
733 return g_queue_peek_head (stack);
738 /* Hooks for adding to the main loop */
742 * @source_funcs: structure containing functions that implement
743 * the sources behavior.
744 * @struct_size: size of the #GSource structure to create.
746 * Creates a new #GSource structure. The size is specified to
747 * allow creating structures derived from #GSource that contain
748 * additional data. The size passed in must be at least
749 * <literal>sizeof (GSource)</literal>.
751 * The source will not initially be associated with any #GMainContext
752 * and must be added to one with g_source_attach() before it will be
755 * Return value: the newly-created #GSource.
758 g_source_new (GSourceFuncs *source_funcs,
763 g_return_val_if_fail (source_funcs != NULL, NULL);
764 g_return_val_if_fail (struct_size >= sizeof (GSource), NULL);
766 source = (GSource*) g_malloc0 (struct_size);
768 source->source_funcs = source_funcs;
769 source->ref_count = 1;
771 source->priority = G_PRIORITY_DEFAULT;
773 source->flags = G_HOOK_FLAG_ACTIVE;
775 /* NULL/0 initialization for all other fields */
780 /* Holds context's lock
783 g_source_list_add (GSource *source,
784 GMainContext *context)
786 GSource *tmp_source, *last_source;
788 if (source->priv && source->priv->parent_source)
790 /* Put the source immediately before its parent */
791 tmp_source = source->priv->parent_source;
792 last_source = source->priv->parent_source->prev;
797 tmp_source = context->source_list;
798 while (tmp_source && tmp_source->priority <= source->priority)
800 last_source = tmp_source;
801 tmp_source = tmp_source->next;
805 source->next = tmp_source;
807 tmp_source->prev = source;
809 source->prev = last_source;
811 last_source->next = source;
813 context->source_list = source;
816 /* Holds context's lock
819 g_source_list_remove (GSource *source,
820 GMainContext *context)
823 source->prev->next = source->next;
825 context->source_list = source->next;
828 source->next->prev = source->prev;
835 g_source_attach_unlocked (GSource *source,
836 GMainContext *context)
841 source->context = context;
842 result = source->source_id = context->next_id++;
845 g_source_list_add (source, context);
847 tmp_list = source->poll_fds;
850 g_main_context_add_poll_unlocked (context, source->priority, tmp_list->data);
851 tmp_list = tmp_list->next;
856 tmp_list = source->priv->child_sources;
859 g_source_attach_unlocked (tmp_list->data, context);
860 tmp_list = tmp_list->next;
869 * @source: a #GSource
870 * @context: a #GMainContext (if %NULL, the default context will be used)
872 * Adds a #GSource to a @context so that it will be executed within
873 * that context. Remove it by calling g_source_destroy().
875 * Return value: the ID (greater than 0) for the source within the
879 g_source_attach (GSource *source,
880 GMainContext *context)
884 g_return_val_if_fail (source->context == NULL, 0);
885 g_return_val_if_fail (!SOURCE_DESTROYED (source), 0);
888 context = g_main_context_default ();
890 LOCK_CONTEXT (context);
892 result = g_source_attach_unlocked (source, context);
894 /* If another thread has acquired the context, wake it up since it
895 * might be in poll() right now.
897 if (context->owner && context->owner != G_THREAD_SELF)
898 g_wakeup_signal (context->wakeup);
900 UNLOCK_CONTEXT (context);
906 g_source_destroy_internal (GSource *source,
907 GMainContext *context,
911 LOCK_CONTEXT (context);
913 if (!SOURCE_DESTROYED (source))
916 gpointer old_cb_data;
917 GSourceCallbackFuncs *old_cb_funcs;
919 source->flags &= ~G_HOOK_FLAG_ACTIVE;
921 old_cb_data = source->callback_data;
922 old_cb_funcs = source->callback_funcs;
924 source->callback_data = NULL;
925 source->callback_funcs = NULL;
929 UNLOCK_CONTEXT (context);
930 old_cb_funcs->unref (old_cb_data);
931 LOCK_CONTEXT (context);
934 if (!SOURCE_BLOCKED (source))
936 tmp_list = source->poll_fds;
939 g_main_context_remove_poll_unlocked (context, tmp_list->data);
940 tmp_list = tmp_list->next;
944 if (source->priv && source->priv->child_sources)
946 /* This is safe because even if a child_source finalizer or
947 * closure notify tried to modify source->priv->child_sources
948 * from outside the lock, it would fail since
949 * SOURCE_DESTROYED(source) is now TRUE.
951 tmp_list = source->priv->child_sources;
954 g_source_destroy_internal (tmp_list->data, context, TRUE);
955 g_source_unref_internal (tmp_list->data, context, TRUE);
956 tmp_list = tmp_list->next;
958 g_slist_free (source->priv->child_sources);
959 source->priv->child_sources = NULL;
962 g_source_unref_internal (source, context, TRUE);
966 UNLOCK_CONTEXT (context);
971 * @source: a #GSource
973 * Removes a source from its #GMainContext, if any, and mark it as
974 * destroyed. The source cannot be subsequently added to another
978 g_source_destroy (GSource *source)
980 GMainContext *context;
982 g_return_if_fail (source != NULL);
984 context = source->context;
987 g_source_destroy_internal (source, context, FALSE);
989 source->flags &= ~G_HOOK_FLAG_ACTIVE;
994 * @source: a #GSource
996 * Returns the numeric ID for a particular source. The ID of a source
997 * is a positive integer which is unique within a particular main loop
998 * context. The reverse
999 * mapping from ID to source is done by g_main_context_find_source_by_id().
1001 * Return value: the ID (greater than 0) for the source
1004 g_source_get_id (GSource *source)
1008 g_return_val_if_fail (source != NULL, 0);
1009 g_return_val_if_fail (source->context != NULL, 0);
1011 LOCK_CONTEXT (source->context);
1012 result = source->source_id;
1013 UNLOCK_CONTEXT (source->context);
1019 * g_source_get_context:
1020 * @source: a #GSource
1022 * Gets the #GMainContext with which the source is associated.
1023 * Calling this function on a destroyed source is an error.
1025 * Return value: (transfer none): the #GMainContext with which the
1026 * source is associated, or %NULL if the context has not
1027 * yet been added to a source.
1030 g_source_get_context (GSource *source)
1032 g_return_val_if_fail (!SOURCE_DESTROYED (source), NULL);
1034 return source->context;
1038 * g_source_add_poll:
1039 * @source:a #GSource
1040 * @fd: a #GPollFD structure holding information about a file
1041 * descriptor to watch.
1043 * Adds a file descriptor to the set of file descriptors polled for
1044 * this source. This is usually combined with g_source_new() to add an
1045 * event source. The event source's check function will typically test
1046 * the @revents field in the #GPollFD struct and return %TRUE if events need
1050 g_source_add_poll (GSource *source,
1053 GMainContext *context;
1055 g_return_if_fail (source != NULL);
1056 g_return_if_fail (fd != NULL);
1057 g_return_if_fail (!SOURCE_DESTROYED (source));
1059 context = source->context;
1062 LOCK_CONTEXT (context);
1064 source->poll_fds = g_slist_prepend (source->poll_fds, fd);
1068 if (!SOURCE_BLOCKED (source))
1069 g_main_context_add_poll_unlocked (context, source->priority, fd);
1070 UNLOCK_CONTEXT (context);
1075 * g_source_remove_poll:
1076 * @source:a #GSource
1077 * @fd: a #GPollFD structure previously passed to g_source_add_poll().
1079 * Removes a file descriptor from the set of file descriptors polled for
1083 g_source_remove_poll (GSource *source,
1086 GMainContext *context;
1088 g_return_if_fail (source != NULL);
1089 g_return_if_fail (fd != NULL);
1090 g_return_if_fail (!SOURCE_DESTROYED (source));
1092 context = source->context;
1095 LOCK_CONTEXT (context);
1097 source->poll_fds = g_slist_remove (source->poll_fds, fd);
1101 if (!SOURCE_BLOCKED (source))
1102 g_main_context_remove_poll_unlocked (context, fd);
1103 UNLOCK_CONTEXT (context);
1108 * g_source_add_child_source:
1109 * @source:a #GSource
1110 * @child_source: a second #GSource that @source should "poll"
1112 * Adds @child_source to @source as a "polled" source; when @source is
1113 * added to a #GMainContext, @child_source will be automatically added
1114 * with the same priority, when @child_source is triggered, it will
1115 * cause @source to dispatch (in addition to calling its own
1116 * callback), and when @source is destroyed, it will destroy
1117 * @child_source as well. (@source will also still be dispatched if
1118 * its own prepare/check functions indicate that it is ready.)
1120 * If you don't need @child_source to do anything on its own when it
1121 * triggers, you can call g_source_set_dummy_callback() on it to set a
1122 * callback that does nothing (except return %TRUE if appropriate).
1124 * @source will hold a reference on @child_source while @child_source
1125 * is attached to it.
1130 g_source_add_child_source (GSource *source,
1131 GSource *child_source)
1133 GMainContext *context;
1135 g_return_if_fail (source != NULL);
1136 g_return_if_fail (child_source != NULL);
1137 g_return_if_fail (!SOURCE_DESTROYED (source));
1138 g_return_if_fail (!SOURCE_DESTROYED (child_source));
1139 g_return_if_fail (child_source->context == NULL);
1140 g_return_if_fail (child_source->priv == NULL || child_source->priv->parent_source == NULL);
1142 context = source->context;
1145 LOCK_CONTEXT (context);
1148 source->priv = g_slice_new0 (GSourcePrivate);
1149 if (!child_source->priv)
1150 child_source->priv = g_slice_new0 (GSourcePrivate);
1152 source->priv->child_sources = g_slist_prepend (source->priv->child_sources,
1153 g_source_ref (child_source));
1154 child_source->priv->parent_source = source;
1155 g_source_set_priority_unlocked (child_source, context, source->priority);
1159 UNLOCK_CONTEXT (context);
1160 g_source_attach (child_source, context);
1165 * g_source_remove_child_source:
1166 * @source:a #GSource
1167 * @child_source: a #GSource previously passed to
1168 * g_source_add_child_source().
1170 * Detaches @child_source from @source and destroys it.
1175 g_source_remove_child_source (GSource *source,
1176 GSource *child_source)
1178 GMainContext *context;
1180 g_return_if_fail (source != NULL);
1181 g_return_if_fail (child_source != NULL);
1182 g_return_if_fail (child_source->priv != NULL && child_source->priv->parent_source == source);
1183 g_return_if_fail (!SOURCE_DESTROYED (source));
1184 g_return_if_fail (!SOURCE_DESTROYED (child_source));
1186 context = source->context;
1189 LOCK_CONTEXT (context);
1191 source->priv->child_sources = g_slist_remove (source->priv->child_sources, child_source);
1192 g_source_destroy_internal (child_source, context, TRUE);
1193 g_source_unref_internal (child_source, context, TRUE);
1196 UNLOCK_CONTEXT (context);
1200 * g_source_set_callback_indirect:
1201 * @source: the source
1202 * @callback_data: pointer to callback data "object"
1203 * @callback_funcs: functions for reference counting @callback_data
1204 * and getting the callback and data
1206 * Sets the callback function storing the data as a refcounted callback
1207 * "object". This is used internally. Note that calling
1208 * g_source_set_callback_indirect() assumes
1209 * an initial reference count on @callback_data, and thus
1210 * @callback_funcs->unref will eventually be called once more
1211 * than @callback_funcs->ref.
1214 g_source_set_callback_indirect (GSource *source,
1215 gpointer callback_data,
1216 GSourceCallbackFuncs *callback_funcs)
1218 GMainContext *context;
1219 gpointer old_cb_data;
1220 GSourceCallbackFuncs *old_cb_funcs;
1222 g_return_if_fail (source != NULL);
1223 g_return_if_fail (callback_funcs != NULL || callback_data == NULL);
1225 context = source->context;
1228 LOCK_CONTEXT (context);
1230 old_cb_data = source->callback_data;
1231 old_cb_funcs = source->callback_funcs;
1233 source->callback_data = callback_data;
1234 source->callback_funcs = callback_funcs;
1237 UNLOCK_CONTEXT (context);
1240 old_cb_funcs->unref (old_cb_data);
1244 g_source_callback_ref (gpointer cb_data)
1246 GSourceCallback *callback = cb_data;
1248 callback->ref_count++;
1253 g_source_callback_unref (gpointer cb_data)
1255 GSourceCallback *callback = cb_data;
1257 callback->ref_count--;
1258 if (callback->ref_count == 0)
1260 if (callback->notify)
1261 callback->notify (callback->data);
1267 g_source_callback_get (gpointer cb_data,
1272 GSourceCallback *callback = cb_data;
1274 *func = callback->func;
1275 *data = callback->data;
1278 static GSourceCallbackFuncs g_source_callback_funcs = {
1279 g_source_callback_ref,
1280 g_source_callback_unref,
1281 g_source_callback_get,
1285 * g_source_set_callback:
1286 * @source: the source
1287 * @func: a callback function
1288 * @data: the data to pass to callback function
1289 * @notify: a function to call when @data is no longer in use, or %NULL.
1291 * Sets the callback function for a source. The callback for a source is
1292 * called from the source's dispatch function.
1294 * The exact type of @func depends on the type of source; ie. you
1295 * should not count on @func being called with @data as its first
1298 * Typically, you won't use this function. Instead use functions specific
1299 * to the type of source you are using.
1302 g_source_set_callback (GSource *source,
1305 GDestroyNotify notify)
1307 GSourceCallback *new_callback;
1309 g_return_if_fail (source != NULL);
1311 new_callback = g_new (GSourceCallback, 1);
1313 new_callback->ref_count = 1;
1314 new_callback->func = func;
1315 new_callback->data = data;
1316 new_callback->notify = notify;
1318 g_source_set_callback_indirect (source, new_callback, &g_source_callback_funcs);
1323 * g_source_set_funcs:
1324 * @source: a #GSource
1325 * @funcs: the new #GSourceFuncs
1327 * Sets the source functions (can be used to override
1328 * default implementations) of an unattached source.
1333 g_source_set_funcs (GSource *source,
1334 GSourceFuncs *funcs)
1336 g_return_if_fail (source != NULL);
1337 g_return_if_fail (source->context == NULL);
1338 g_return_if_fail (source->ref_count > 0);
1339 g_return_if_fail (funcs != NULL);
1341 source->source_funcs = funcs;
1345 g_source_set_priority_unlocked (GSource *source,
1346 GMainContext *context,
1351 source->priority = priority;
1355 /* Remove the source from the context's source and then
1356 * add it back so it is sorted in the correct place
1358 g_source_list_remove (source, source->context);
1359 g_source_list_add (source, source->context);
1361 if (!SOURCE_BLOCKED (source))
1363 tmp_list = source->poll_fds;
1366 g_main_context_remove_poll_unlocked (context, tmp_list->data);
1367 g_main_context_add_poll_unlocked (context, priority, tmp_list->data);
1369 tmp_list = tmp_list->next;
1374 if (source->priv && source->priv->child_sources)
1376 tmp_list = source->priv->child_sources;
1379 g_source_set_priority_unlocked (tmp_list->data, context, priority);
1380 tmp_list = tmp_list->next;
1386 * g_source_set_priority:
1387 * @source: a #GSource
1388 * @priority: the new priority.
1390 * Sets the priority of a source. While the main loop is being run, a
1391 * source will be dispatched if it is ready to be dispatched and no
1392 * sources at a higher (numerically smaller) priority are ready to be
1396 g_source_set_priority (GSource *source,
1399 GMainContext *context;
1401 g_return_if_fail (source != NULL);
1403 context = source->context;
1406 LOCK_CONTEXT (context);
1407 g_source_set_priority_unlocked (source, context, priority);
1409 UNLOCK_CONTEXT (source->context);
1413 * g_source_get_priority:
1414 * @source: a #GSource
1416 * Gets the priority of a source.
1418 * Return value: the priority of the source
1421 g_source_get_priority (GSource *source)
1423 g_return_val_if_fail (source != NULL, 0);
1425 return source->priority;
1429 * g_source_set_can_recurse:
1430 * @source: a #GSource
1431 * @can_recurse: whether recursion is allowed for this source
1433 * Sets whether a source can be called recursively. If @can_recurse is
1434 * %TRUE, then while the source is being dispatched then this source
1435 * will be processed normally. Otherwise, all processing of this
1436 * source is blocked until the dispatch function returns.
1439 g_source_set_can_recurse (GSource *source,
1440 gboolean can_recurse)
1442 GMainContext *context;
1444 g_return_if_fail (source != NULL);
1446 context = source->context;
1449 LOCK_CONTEXT (context);
1452 source->flags |= G_SOURCE_CAN_RECURSE;
1454 source->flags &= ~G_SOURCE_CAN_RECURSE;
1457 UNLOCK_CONTEXT (context);
1461 * g_source_get_can_recurse:
1462 * @source: a #GSource
1464 * Checks whether a source is allowed to be called recursively.
1465 * see g_source_set_can_recurse().
1467 * Return value: whether recursion is allowed.
1470 g_source_get_can_recurse (GSource *source)
1472 g_return_val_if_fail (source != NULL, FALSE);
1474 return (source->flags & G_SOURCE_CAN_RECURSE) != 0;
1479 * g_source_set_name:
1480 * @source: a #GSource
1481 * @name: debug name for the source
1483 * Sets a name for the source, used in debugging and profiling.
1484 * The name defaults to #NULL.
1486 * The source name should describe in a human-readable way
1487 * what the source does. For example, "X11 event queue"
1488 * or "GTK+ repaint idle handler" or whatever it is.
1490 * It is permitted to call this function multiple times, but is not
1491 * recommended due to the potential performance impact. For example,
1492 * one could change the name in the "check" function of a #GSourceFuncs
1493 * to include details like the event type in the source name.
1498 g_source_set_name (GSource *source,
1501 g_return_if_fail (source != NULL);
1503 /* setting back to NULL is allowed, just because it's
1504 * weird if get_name can return NULL but you can't
1508 g_free (source->name);
1509 source->name = g_strdup (name);
1513 * g_source_get_name:
1514 * @source: a #GSource
1516 * Gets a name for the source, used in debugging and profiling.
1517 * The name may be #NULL if it has never been set with
1518 * g_source_set_name().
1520 * Return value: the name of the source
1524 g_source_get_name (GSource *source)
1526 g_return_val_if_fail (source != NULL, NULL);
1528 return source->name;
1532 * g_source_set_name_by_id:
1533 * @tag: a #GSource ID
1534 * @name: debug name for the source
1536 * Sets the name of a source using its ID.
1538 * This is a convenience utility to set source names from the return
1539 * value of g_idle_add(), g_timeout_add(), etc.
1544 g_source_set_name_by_id (guint tag,
1549 g_return_if_fail (tag > 0);
1551 source = g_main_context_find_source_by_id (NULL, tag);
1555 g_source_set_name (source, name);
1561 * @source: a #GSource
1563 * Increases the reference count on a source by one.
1565 * Return value: @source
1568 g_source_ref (GSource *source)
1570 GMainContext *context;
1572 g_return_val_if_fail (source != NULL, NULL);
1574 context = source->context;
1577 LOCK_CONTEXT (context);
1579 source->ref_count++;
1582 UNLOCK_CONTEXT (context);
1587 /* g_source_unref() but possible to call within context lock
1590 g_source_unref_internal (GSource *source,
1591 GMainContext *context,
1594 gpointer old_cb_data = NULL;
1595 GSourceCallbackFuncs *old_cb_funcs = NULL;
1597 g_return_if_fail (source != NULL);
1599 if (!have_lock && context)
1600 LOCK_CONTEXT (context);
1602 source->ref_count--;
1603 if (source->ref_count == 0)
1605 old_cb_data = source->callback_data;
1606 old_cb_funcs = source->callback_funcs;
1608 source->callback_data = NULL;
1609 source->callback_funcs = NULL;
1613 if (!SOURCE_DESTROYED (source))
1614 g_warning (G_STRLOC ": ref_count == 0, but source was still attached to a context!");
1615 g_source_list_remove (source, context);
1618 if (source->source_funcs->finalize)
1621 UNLOCK_CONTEXT (context);
1622 source->source_funcs->finalize (source);
1624 LOCK_CONTEXT (context);
1627 g_free (source->name);
1628 source->name = NULL;
1630 g_slist_free (source->poll_fds);
1631 source->poll_fds = NULL;
1635 g_slice_free (GSourcePrivate, source->priv);
1636 source->priv = NULL;
1642 if (!have_lock && context)
1643 UNLOCK_CONTEXT (context);
1648 UNLOCK_CONTEXT (context);
1650 old_cb_funcs->unref (old_cb_data);
1653 LOCK_CONTEXT (context);
1659 * @source: a #GSource
1661 * Decreases the reference count of a source by one. If the
1662 * resulting reference count is zero the source and associated
1663 * memory will be destroyed.
1666 g_source_unref (GSource *source)
1668 g_return_if_fail (source != NULL);
1670 g_source_unref_internal (source, source->context, FALSE);
1674 * g_main_context_find_source_by_id:
1675 * @context: a #GMainContext (if %NULL, the default context will be used)
1676 * @source_id: the source ID, as returned by g_source_get_id().
1678 * Finds a #GSource given a pair of context and ID.
1680 * Return value: (transfer none): the #GSource if found, otherwise, %NULL
1683 g_main_context_find_source_by_id (GMainContext *context,
1688 g_return_val_if_fail (source_id > 0, NULL);
1690 if (context == NULL)
1691 context = g_main_context_default ();
1693 LOCK_CONTEXT (context);
1695 source = context->source_list;
1698 if (!SOURCE_DESTROYED (source) &&
1699 source->source_id == source_id)
1701 source = source->next;
1704 UNLOCK_CONTEXT (context);
1710 * g_main_context_find_source_by_funcs_user_data:
1711 * @context: a #GMainContext (if %NULL, the default context will be used).
1712 * @funcs: the @source_funcs passed to g_source_new().
1713 * @user_data: the user data from the callback.
1715 * Finds a source with the given source functions and user data. If
1716 * multiple sources exist with the same source function and user data,
1717 * the first one found will be returned.
1719 * Return value: (transfer none): the source, if one was found, otherwise %NULL
1722 g_main_context_find_source_by_funcs_user_data (GMainContext *context,
1723 GSourceFuncs *funcs,
1728 g_return_val_if_fail (funcs != NULL, NULL);
1730 if (context == NULL)
1731 context = g_main_context_default ();
1733 LOCK_CONTEXT (context);
1735 source = context->source_list;
1738 if (!SOURCE_DESTROYED (source) &&
1739 source->source_funcs == funcs &&
1740 source->callback_funcs)
1742 GSourceFunc callback;
1743 gpointer callback_data;
1745 source->callback_funcs->get (source->callback_data, source, &callback, &callback_data);
1747 if (callback_data == user_data)
1750 source = source->next;
1753 UNLOCK_CONTEXT (context);
1759 * g_main_context_find_source_by_user_data:
1760 * @context: a #GMainContext
1761 * @user_data: the user_data for the callback.
1763 * Finds a source with the given user data for the callback. If
1764 * multiple sources exist with the same user data, the first
1765 * one found will be returned.
1767 * Return value: (transfer none): the source, if one was found, otherwise %NULL
1770 g_main_context_find_source_by_user_data (GMainContext *context,
1775 if (context == NULL)
1776 context = g_main_context_default ();
1778 LOCK_CONTEXT (context);
1780 source = context->source_list;
1783 if (!SOURCE_DESTROYED (source) &&
1784 source->callback_funcs)
1786 GSourceFunc callback;
1787 gpointer callback_data = NULL;
1789 source->callback_funcs->get (source->callback_data, source, &callback, &callback_data);
1791 if (callback_data == user_data)
1794 source = source->next;
1797 UNLOCK_CONTEXT (context);
1804 * @tag: the ID of the source to remove.
1806 * Removes the source with the given id from the default main context.
1808 * a #GSource is given by g_source_get_id(), or will be returned by the
1809 * functions g_source_attach(), g_idle_add(), g_idle_add_full(),
1810 * g_timeout_add(), g_timeout_add_full(), g_child_watch_add(),
1811 * g_child_watch_add_full(), g_io_add_watch(), and g_io_add_watch_full().
1813 * See also g_source_destroy(). You must use g_source_destroy() for sources
1814 * added to a non-default main context.
1816 * Return value: %TRUE if the source was found and removed.
1819 g_source_remove (guint tag)
1823 g_return_val_if_fail (tag > 0, FALSE);
1825 source = g_main_context_find_source_by_id (NULL, tag);
1827 g_source_destroy (source);
1829 return source != NULL;
1833 * g_source_remove_by_user_data:
1834 * @user_data: the user_data for the callback.
1836 * Removes a source from the default main loop context given the user
1837 * data for the callback. If multiple sources exist with the same user
1838 * data, only one will be destroyed.
1840 * Return value: %TRUE if a source was found and removed.
1843 g_source_remove_by_user_data (gpointer user_data)
1847 source = g_main_context_find_source_by_user_data (NULL, user_data);
1850 g_source_destroy (source);
1858 * g_source_remove_by_funcs_user_data:
1859 * @funcs: The @source_funcs passed to g_source_new()
1860 * @user_data: the user data for the callback
1862 * Removes a source from the default main loop context given the
1863 * source functions and user data. If multiple sources exist with the
1864 * same source functions and user data, only one will be destroyed.
1866 * Return value: %TRUE if a source was found and removed.
1869 g_source_remove_by_funcs_user_data (GSourceFuncs *funcs,
1874 g_return_val_if_fail (funcs != NULL, FALSE);
1876 source = g_main_context_find_source_by_funcs_user_data (NULL, funcs, user_data);
1879 g_source_destroy (source);
1887 * g_get_current_time:
1888 * @result: #GTimeVal structure in which to store current time.
1890 * Equivalent to the UNIX gettimeofday() function, but portable.
1892 * You may find g_get_real_time() to be more convenient.
1895 g_get_current_time (GTimeVal *result)
1900 g_return_if_fail (result != NULL);
1902 /*this is required on alpha, there the timeval structs are int's
1903 not longs and a cast only would fail horribly*/
1904 gettimeofday (&r, NULL);
1905 result->tv_sec = r.tv_sec;
1906 result->tv_usec = r.tv_usec;
1911 g_return_if_fail (result != NULL);
1913 GetSystemTimeAsFileTime (&ft);
1914 memmove (&time64, &ft, sizeof (FILETIME));
1916 /* Convert from 100s of nanoseconds since 1601-01-01
1917 * to Unix epoch. Yes, this is Y2038 unsafe.
1919 time64 -= G_GINT64_CONSTANT (116444736000000000);
1922 result->tv_sec = time64 / 1000000;
1923 result->tv_usec = time64 % 1000000;
1930 * Queries the system wall-clock time.
1932 * This call is functionally equivalent to g_get_current_time() except
1933 * that the return value is often more convenient than dealing with a
1936 * You should only use this call if you are actually interested in the real
1937 * wall-clock time. g_get_monotonic_time() is probably more useful for
1938 * measuring intervals.
1940 * Returns: the number of microseconds since January 1, 1970 UTC.
1945 g_get_real_time (void)
1949 g_get_current_time (&tv);
1951 return (((gint64) tv.tv_sec) * 1000000) + tv.tv_usec;
1955 * g_get_monotonic_time:
1957 * Queries the system monotonic time, if available.
1959 * On POSIX systems with clock_gettime() and %CLOCK_MONOTONIC this call
1960 * is a very shallow wrapper for that. Otherwise, we make a best effort
1961 * that probably involves returning the wall clock time (with at least
1962 * microsecond accuracy, subject to the limitations of the OS kernel).
1964 * It's important to note that POSIX %CLOCK_MONOTONIC does not count
1965 * time spent while the machine is suspended.
1967 * On Windows, "limitations of the OS kernel" is a rather substantial
1968 * statement. Depending on the configuration of the system, the wall
1969 * clock time is updated as infrequently as 64 times a second (which
1970 * is approximately every 16ms).
1972 * Returns: the monotonic time, in microseconds
1977 g_get_monotonic_time (void)
1979 #ifdef HAVE_CLOCK_GETTIME
1980 /* librt clock_gettime() is our first choice */
1982 #ifdef HAVE_MONOTONIC_CLOCK
1983 static volatile gsize clockid = 0;
1985 static clockid_t clockid = CLOCK_REALTIME;
1989 #ifdef HAVE_MONOTONIC_CLOCK
1990 if (g_once_init_enter (&clockid))
1992 clockid_t best_clockid;
1994 if (sysconf (_SC_MONOTONIC_CLOCK) >= 0)
1995 best_clockid = CLOCK_MONOTONIC;
1997 best_clockid = CLOCK_REALTIME;
1998 g_once_init_leave (&clockid, (gsize)best_clockid);
2002 clock_gettime (clockid, &ts);
2004 /* In theory monotonic time can have any epoch.
2006 * glib presently assumes the following:
2008 * 1) The epoch comes some time after the birth of Jesus of Nazareth, but
2009 * not more than 10000 years later.
2011 * 2) The current time also falls sometime within this range.
2013 * These two reasonable assumptions leave us with a maximum deviation from
2014 * the epoch of 10000 years, or 315569520000000000 seconds.
2016 * If we restrict ourselves to this range then the number of microseconds
2017 * will always fit well inside the constraints of a int64 (by a factor of
2020 * If you actually hit the following assertion, probably you should file a
2021 * bug against your operating system for being excessively silly.
2023 g_assert (G_GINT64_CONSTANT (-315569520000000000) < ts.tv_sec &&
2024 ts.tv_sec < G_GINT64_CONSTANT (315569520000000000));
2026 return (((gint64) ts.tv_sec) * 1000000) + (ts.tv_nsec / 1000);
2029 /* It may look like we are discarding accuracy on Windows (since its
2030 * current time is expressed in 100s of nanoseconds) but according to
2031 * many sources, the time is only updated 64 times per second, so
2032 * microsecond accuracy is more than enough.
2037 g_get_current_time (&tv);
2039 return (((gint64) tv.tv_sec) * 1000000) + tv.tv_usec;
2045 g_main_dispatch_free (gpointer dispatch)
2047 g_slice_free (GMainDispatch, dispatch);
2050 /* Running the main loop */
2052 static GMainDispatch *
2055 static GStaticPrivate depth_private = G_STATIC_PRIVATE_INIT;
2056 GMainDispatch *dispatch = g_static_private_get (&depth_private);
2059 dispatch = g_slice_new0 (GMainDispatch);
2060 g_static_private_set (&depth_private, dispatch, g_main_dispatch_free);
2069 * Returns the depth of the stack of calls to
2070 * g_main_context_dispatch() on any #GMainContext in the current thread.
2071 * That is, when called from the toplevel, it gives 0. When
2072 * called from within a callback from g_main_context_iteration()
2073 * (or g_main_loop_run(), etc.) it returns 1. When called from within
2074 * a callback to a recursive call to g_main_context_iteration(),
2075 * it returns 2. And so forth.
2077 * This function is useful in a situation like the following:
2078 * Imagine an extremely simple "garbage collected" system.
2081 * static GList *free_list;
2084 * allocate_memory (gsize size)
2086 * gpointer result = g_malloc (size);
2087 * free_list = g_list_prepend (free_list, result);
2092 * free_allocated_memory (void)
2095 * for (l = free_list; l; l = l->next);
2097 * g_list_free (free_list);
2105 * g_main_context_iteration (NULL, TRUE);
2106 * free_allocated_memory();
2110 * This works from an application, however, if you want to do the same
2111 * thing from a library, it gets more difficult, since you no longer
2112 * control the main loop. You might think you can simply use an idle
2113 * function to make the call to free_allocated_memory(), but that
2114 * doesn't work, since the idle function could be called from a
2115 * recursive callback. This can be fixed by using g_main_depth()
2119 * allocate_memory (gsize size)
2121 * FreeListBlock *block = g_new (FreeListBlock, 1);
2122 * block->mem = g_malloc (size);
2123 * block->depth = g_main_depth ();
2124 * free_list = g_list_prepend (free_list, block);
2125 * return block->mem;
2129 * free_allocated_memory (void)
2133 * int depth = g_main_depth ();
2134 * for (l = free_list; l; );
2136 * GList *next = l->next;
2137 * FreeListBlock *block = l->data;
2138 * if (block->depth > depth)
2140 * g_free (block->mem);
2142 * free_list = g_list_delete_link (free_list, l);
2150 * There is a temptation to use g_main_depth() to solve
2151 * problems with reentrancy. For instance, while waiting for data
2152 * to be received from the network in response to a menu item,
2153 * the menu item might be selected again. It might seem that
2154 * one could make the menu item's callback return immediately
2155 * and do nothing if g_main_depth() returns a value greater than 1.
2156 * However, this should be avoided since the user then sees selecting
2157 * the menu item do nothing. Furthermore, you'll find yourself adding
2158 * these checks all over your code, since there are doubtless many,
2159 * many things that the user could do. Instead, you can use the
2160 * following techniques:
2165 * Use gtk_widget_set_sensitive() or modal dialogs to prevent
2166 * the user from interacting with elements while the main
2167 * loop is recursing.
2172 * Avoid main loop recursion in situations where you can't handle
2173 * arbitrary callbacks. Instead, structure your code so that you
2174 * simply return to the main loop and then get called again when
2175 * there is more work to do.
2180 * Return value: The main loop recursion level in the current thread
2185 GMainDispatch *dispatch = get_dispatch ();
2186 return dispatch->depth;
2190 * g_main_current_source:
2192 * Returns the currently firing source for this thread.
2194 * Return value: (transfer none): The currently firing source or %NULL.
2199 g_main_current_source (void)
2201 GMainDispatch *dispatch = get_dispatch ();
2202 return dispatch->dispatching_sources ? dispatch->dispatching_sources->data : NULL;
2206 * g_source_is_destroyed:
2207 * @source: a #GSource
2209 * Returns whether @source has been destroyed.
2211 * This is important when you operate upon your objects
2212 * from within idle handlers, but may have freed the object
2213 * before the dispatch of your idle handler.
2217 * idle_callback (gpointer data)
2219 * SomeWidget *self = data;
2221 * GDK_THREADS_ENTER (<!-- -->);
2222 * /<!-- -->* do stuff with self *<!-- -->/
2223 * self->idle_id = 0;
2224 * GDK_THREADS_LEAVE (<!-- -->);
2230 * some_widget_do_stuff_later (SomeWidget *self)
2232 * self->idle_id = g_idle_add (idle_callback, self);
2236 * some_widget_finalize (GObject *object)
2238 * SomeWidget *self = SOME_WIDGET (object);
2240 * if (self->idle_id)
2241 * g_source_remove (self->idle_id);
2243 * G_OBJECT_CLASS (parent_class)->finalize (object);
2247 * This will fail in a multi-threaded application if the
2248 * widget is destroyed before the idle handler fires due
2249 * to the use after free in the callback. A solution, to
2250 * this particular problem, is to check to if the source
2251 * has already been destroy within the callback.
2255 * idle_callback (gpointer data)
2257 * SomeWidget *self = data;
2259 * GDK_THREADS_ENTER ();
2260 * if (!g_source_is_destroyed (g_main_current_source ()))
2262 * /<!-- -->* do stuff with self *<!-- -->/
2264 * GDK_THREADS_LEAVE ();
2270 * Return value: %TRUE if the source has been destroyed
2275 g_source_is_destroyed (GSource *source)
2277 return SOURCE_DESTROYED (source);
2280 /* Temporarily remove all this source's file descriptors from the
2281 * poll(), so that if data comes available for one of the file descriptors
2282 * we don't continually spin in the poll()
2284 /* HOLDS: source->context's lock */
2286 block_source (GSource *source)
2290 g_return_if_fail (!SOURCE_BLOCKED (source));
2292 tmp_list = source->poll_fds;
2295 g_main_context_remove_poll_unlocked (source->context, tmp_list->data);
2296 tmp_list = tmp_list->next;
2300 /* HOLDS: source->context's lock */
2302 unblock_source (GSource *source)
2306 g_return_if_fail (!SOURCE_BLOCKED (source)); /* Source already unblocked */
2307 g_return_if_fail (!SOURCE_DESTROYED (source));
2309 tmp_list = source->poll_fds;
2312 g_main_context_add_poll_unlocked (source->context, source->priority, tmp_list->data);
2313 tmp_list = tmp_list->next;
2317 /* HOLDS: context's lock */
2319 g_main_dispatch (GMainContext *context)
2321 GMainDispatch *current = get_dispatch ();
2324 for (i = 0; i < context->pending_dispatches->len; i++)
2326 GSource *source = context->pending_dispatches->pdata[i];
2328 context->pending_dispatches->pdata[i] = NULL;
2331 source->flags &= ~G_SOURCE_READY;
2333 if (!SOURCE_DESTROYED (source))
2335 gboolean was_in_call;
2336 gpointer user_data = NULL;
2337 GSourceFunc callback = NULL;
2338 GSourceCallbackFuncs *cb_funcs;
2340 gboolean need_destroy;
2342 gboolean (*dispatch) (GSource *,
2345 GSList current_source_link;
2347 dispatch = source->source_funcs->dispatch;
2348 cb_funcs = source->callback_funcs;
2349 cb_data = source->callback_data;
2352 cb_funcs->ref (cb_data);
2354 if ((source->flags & G_SOURCE_CAN_RECURSE) == 0)
2355 block_source (source);
2357 was_in_call = source->flags & G_HOOK_FLAG_IN_CALL;
2358 source->flags |= G_HOOK_FLAG_IN_CALL;
2361 cb_funcs->get (cb_data, source, &callback, &user_data);
2363 UNLOCK_CONTEXT (context);
2366 /* The on-stack allocation of the GSList is unconventional, but
2367 * we know that the lifetime of the link is bounded to this
2368 * function as the link is kept in a thread specific list and
2369 * not manipulated outside of this function and its descendants.
2370 * Avoiding the overhead of a g_slist_alloc() is useful as many
2371 * applications do little more than dispatch events.
2373 * This is a performance hack - do not revert to g_slist_prepend()!
2375 current_source_link.data = source;
2376 current_source_link.next = current->dispatching_sources;
2377 current->dispatching_sources = ¤t_source_link;
2378 need_destroy = ! dispatch (source,
2381 g_assert (current->dispatching_sources == ¤t_source_link);
2382 current->dispatching_sources = current_source_link.next;
2386 cb_funcs->unref (cb_data);
2388 LOCK_CONTEXT (context);
2391 source->flags &= ~G_HOOK_FLAG_IN_CALL;
2393 if ((source->flags & G_SOURCE_CAN_RECURSE) == 0 &&
2394 !SOURCE_DESTROYED (source))
2395 unblock_source (source);
2397 /* Note: this depends on the fact that we can't switch
2398 * sources from one main context to another
2400 if (need_destroy && !SOURCE_DESTROYED (source))
2402 g_assert (source->context == context);
2403 g_source_destroy_internal (source, context, TRUE);
2407 SOURCE_UNREF (source, context);
2410 g_ptr_array_set_size (context->pending_dispatches, 0);
2413 /* Holds context's lock */
2414 static inline GSource *
2415 next_valid_source (GMainContext *context,
2418 GSource *new_source = source ? source->next : context->source_list;
2422 if (!SOURCE_DESTROYED (new_source))
2424 new_source->ref_count++;
2428 new_source = new_source->next;
2432 SOURCE_UNREF (source, context);
2438 * g_main_context_acquire:
2439 * @context: a #GMainContext
2441 * Tries to become the owner of the specified context.
2442 * If some other thread is the owner of the context,
2443 * returns %FALSE immediately. Ownership is properly
2444 * recursive: the owner can require ownership again
2445 * and will release ownership when g_main_context_release()
2446 * is called as many times as g_main_context_acquire().
2448 * You must be the owner of a context before you
2449 * can call g_main_context_prepare(), g_main_context_query(),
2450 * g_main_context_check(), g_main_context_dispatch().
2452 * Return value: %TRUE if the operation succeeded, and
2453 * this thread is now the owner of @context.
2456 g_main_context_acquire (GMainContext *context)
2458 gboolean result = FALSE;
2459 GThread *self = G_THREAD_SELF;
2461 if (context == NULL)
2462 context = g_main_context_default ();
2464 LOCK_CONTEXT (context);
2466 if (!context->owner)
2468 context->owner = self;
2469 g_assert (context->owner_count == 0);
2472 if (context->owner == self)
2474 context->owner_count++;
2478 UNLOCK_CONTEXT (context);
2484 * g_main_context_release:
2485 * @context: a #GMainContext
2487 * Releases ownership of a context previously acquired by this thread
2488 * with g_main_context_acquire(). If the context was acquired multiple
2489 * times, the ownership will be released only when g_main_context_release()
2490 * is called as many times as it was acquired.
2493 g_main_context_release (GMainContext *context)
2495 if (context == NULL)
2496 context = g_main_context_default ();
2498 LOCK_CONTEXT (context);
2500 context->owner_count--;
2501 if (context->owner_count == 0)
2503 context->owner = NULL;
2505 if (context->waiters)
2507 GMainWaiter *waiter = context->waiters->data;
2508 gboolean loop_internal_waiter =
2509 (waiter->mutex == g_static_mutex_get_mutex (&context->mutex));
2510 context->waiters = g_slist_delete_link (context->waiters,
2512 if (!loop_internal_waiter)
2513 g_mutex_lock (waiter->mutex);
2515 g_cond_signal (waiter->cond);
2517 if (!loop_internal_waiter)
2518 g_mutex_unlock (waiter->mutex);
2522 UNLOCK_CONTEXT (context);
2526 * g_main_context_wait:
2527 * @context: a #GMainContext
2528 * @cond: a condition variable
2529 * @mutex: a mutex, currently held
2531 * Tries to become the owner of the specified context,
2532 * as with g_main_context_acquire(). But if another thread
2533 * is the owner, atomically drop @mutex and wait on @cond until
2534 * that owner releases ownership or until @cond is signaled, then
2535 * try again (once) to become the owner.
2537 * Return value: %TRUE if the operation succeeded, and
2538 * this thread is now the owner of @context.
2541 g_main_context_wait (GMainContext *context,
2545 gboolean result = FALSE;
2546 GThread *self = G_THREAD_SELF;
2547 gboolean loop_internal_waiter;
2549 if (context == NULL)
2550 context = g_main_context_default ();
2552 loop_internal_waiter = (mutex == g_static_mutex_get_mutex (&context->mutex));
2554 if (!loop_internal_waiter)
2555 LOCK_CONTEXT (context);
2557 if (context->owner && context->owner != self)
2562 waiter.mutex = mutex;
2564 context->waiters = g_slist_append (context->waiters, &waiter);
2566 if (!loop_internal_waiter)
2567 UNLOCK_CONTEXT (context);
2568 g_cond_wait (cond, mutex);
2569 if (!loop_internal_waiter)
2570 LOCK_CONTEXT (context);
2572 context->waiters = g_slist_remove (context->waiters, &waiter);
2575 if (!context->owner)
2577 context->owner = self;
2578 g_assert (context->owner_count == 0);
2581 if (context->owner == self)
2583 context->owner_count++;
2587 if (!loop_internal_waiter)
2588 UNLOCK_CONTEXT (context);
2594 * g_main_context_prepare:
2595 * @context: a #GMainContext
2596 * @priority: location to store priority of highest priority
2597 * source already ready.
2599 * Prepares to poll sources within a main loop. The resulting information
2600 * for polling is determined by calling g_main_context_query ().
2602 * Return value: %TRUE if some source is ready to be dispatched
2606 g_main_context_prepare (GMainContext *context,
2611 gint current_priority = G_MAXINT;
2614 if (context == NULL)
2615 context = g_main_context_default ();
2617 LOCK_CONTEXT (context);
2619 context->time_is_fresh = FALSE;
2621 if (context->in_check_or_prepare)
2623 g_warning ("g_main_context_prepare() called recursively from within a source's check() or "
2624 "prepare() member.");
2625 UNLOCK_CONTEXT (context);
2630 /* If recursing, finish up current dispatch, before starting over */
2631 if (context->pending_dispatches)
2634 g_main_dispatch (context, ¤t_time);
2636 UNLOCK_CONTEXT (context);
2641 /* If recursing, clear list of pending dispatches */
2643 for (i = 0; i < context->pending_dispatches->len; i++)
2645 if (context->pending_dispatches->pdata[i])
2646 SOURCE_UNREF ((GSource *)context->pending_dispatches->pdata[i], context);
2648 g_ptr_array_set_size (context->pending_dispatches, 0);
2650 /* Prepare all sources */
2652 context->timeout = -1;
2654 source = next_valid_source (context, NULL);
2657 gint source_timeout = -1;
2659 if ((n_ready > 0) && (source->priority > current_priority))
2661 SOURCE_UNREF (source, context);
2664 if (SOURCE_BLOCKED (source))
2667 if (!(source->flags & G_SOURCE_READY))
2670 gboolean (*prepare) (GSource *source,
2673 prepare = source->source_funcs->prepare;
2674 context->in_check_or_prepare++;
2675 UNLOCK_CONTEXT (context);
2677 result = (*prepare) (source, &source_timeout);
2679 LOCK_CONTEXT (context);
2680 context->in_check_or_prepare--;
2684 GSource *ready_source = source;
2686 while (ready_source)
2688 ready_source->flags |= G_SOURCE_READY;
2689 ready_source = ready_source->priv ? ready_source->priv->parent_source : NULL;
2694 if (source->flags & G_SOURCE_READY)
2697 current_priority = source->priority;
2698 context->timeout = 0;
2701 if (source_timeout >= 0)
2703 if (context->timeout < 0)
2704 context->timeout = source_timeout;
2706 context->timeout = MIN (context->timeout, source_timeout);
2710 source = next_valid_source (context, source);
2713 UNLOCK_CONTEXT (context);
2716 *priority = current_priority;
2718 return (n_ready > 0);
2722 * g_main_context_query:
2723 * @context: a #GMainContext
2724 * @max_priority: maximum priority source to check
2725 * @timeout_: (out): location to store timeout to be used in polling
2726 * @fds: (out caller-allocates) (array length=n_fds): location to
2727 * store #GPollFD records that need to be polled.
2728 * @n_fds: length of @fds.
2730 * Determines information necessary to poll this main loop.
2732 * Return value: the number of records actually stored in @fds,
2733 * or, if more than @n_fds records need to be stored, the number
2734 * of records that need to be stored.
2737 g_main_context_query (GMainContext *context,
2746 LOCK_CONTEXT (context);
2748 pollrec = context->poll_records;
2750 while (pollrec && max_priority >= pollrec->priority)
2752 /* We need to include entries with fd->events == 0 in the array because
2753 * otherwise if the application changes fd->events behind our back and
2754 * makes it non-zero, we'll be out of sync when we check the fds[] array.
2755 * (Changing fd->events after adding an FD wasn't an anticipated use of
2756 * this API, but it occurs in practice.) */
2759 fds[n_poll].fd = pollrec->fd->fd;
2760 /* In direct contradiction to the Unix98 spec, IRIX runs into
2761 * difficulty if you pass in POLLERR, POLLHUP or POLLNVAL
2762 * flags in the events field of the pollfd while it should
2763 * just ignoring them. So we mask them out here.
2765 fds[n_poll].events = pollrec->fd->events & ~(G_IO_ERR|G_IO_HUP|G_IO_NVAL);
2766 fds[n_poll].revents = 0;
2769 pollrec = pollrec->next;
2773 context->poll_changed = FALSE;
2777 *timeout = context->timeout;
2779 context->time_is_fresh = FALSE;
2782 UNLOCK_CONTEXT (context);
2788 * g_main_context_check:
2789 * @context: a #GMainContext
2790 * @max_priority: the maximum numerical priority of sources to check
2791 * @fds: (array length=n_fds): array of #GPollFD's that was passed to
2792 * the last call to g_main_context_query()
2793 * @n_fds: return value of g_main_context_query()
2795 * Passes the results of polling back to the main loop.
2797 * Return value: %TRUE if some sources are ready to be dispatched.
2800 g_main_context_check (GMainContext *context,
2810 LOCK_CONTEXT (context);
2812 if (context->in_check_or_prepare)
2814 g_warning ("g_main_context_check() called recursively from within a source's check() or "
2815 "prepare() member.");
2816 UNLOCK_CONTEXT (context);
2820 if (context->wake_up_rec.events)
2821 g_wakeup_acknowledge (context->wakeup);
2823 /* If the set of poll file descriptors changed, bail out
2824 * and let the main loop rerun
2826 if (context->poll_changed)
2828 UNLOCK_CONTEXT (context);
2832 pollrec = context->poll_records;
2836 if (pollrec->fd->events)
2837 pollrec->fd->revents = fds[i].revents;
2839 pollrec = pollrec->next;
2843 source = next_valid_source (context, NULL);
2846 if ((n_ready > 0) && (source->priority > max_priority))
2848 SOURCE_UNREF (source, context);
2851 if (SOURCE_BLOCKED (source))
2854 if (!(source->flags & G_SOURCE_READY))
2857 gboolean (*check) (GSource *source);
2859 check = source->source_funcs->check;
2861 context->in_check_or_prepare++;
2862 UNLOCK_CONTEXT (context);
2864 result = (*check) (source);
2866 LOCK_CONTEXT (context);
2867 context->in_check_or_prepare--;
2871 GSource *ready_source = source;
2873 while (ready_source)
2875 ready_source->flags |= G_SOURCE_READY;
2876 ready_source = ready_source->priv ? ready_source->priv->parent_source : NULL;
2881 if (source->flags & G_SOURCE_READY)
2883 source->ref_count++;
2884 g_ptr_array_add (context->pending_dispatches, source);
2888 /* never dispatch sources with less priority than the first
2889 * one we choose to dispatch
2891 max_priority = source->priority;
2895 source = next_valid_source (context, source);
2898 UNLOCK_CONTEXT (context);
2904 * g_main_context_dispatch:
2905 * @context: a #GMainContext
2907 * Dispatches all pending sources.
2910 g_main_context_dispatch (GMainContext *context)
2912 LOCK_CONTEXT (context);
2914 if (context->pending_dispatches->len > 0)
2916 g_main_dispatch (context);
2919 UNLOCK_CONTEXT (context);
2922 /* HOLDS context lock */
2924 g_main_context_iterate (GMainContext *context,
2931 gboolean some_ready;
2932 gint nfds, allocated_nfds;
2933 GPollFD *fds = NULL;
2935 UNLOCK_CONTEXT (context);
2937 if (!g_main_context_acquire (context))
2939 gboolean got_ownership;
2941 LOCK_CONTEXT (context);
2947 context->cond = g_cond_new ();
2949 got_ownership = g_main_context_wait (context,
2951 g_static_mutex_get_mutex (&context->mutex));
2957 LOCK_CONTEXT (context);
2959 if (!context->cached_poll_array)
2961 context->cached_poll_array_size = context->n_poll_records;
2962 context->cached_poll_array = g_new (GPollFD, context->n_poll_records);
2965 allocated_nfds = context->cached_poll_array_size;
2966 fds = context->cached_poll_array;
2968 UNLOCK_CONTEXT (context);
2970 g_main_context_prepare (context, &max_priority);
2972 while ((nfds = g_main_context_query (context, max_priority, &timeout, fds,
2973 allocated_nfds)) > allocated_nfds)
2975 LOCK_CONTEXT (context);
2977 context->cached_poll_array_size = allocated_nfds = nfds;
2978 context->cached_poll_array = fds = g_new (GPollFD, nfds);
2979 UNLOCK_CONTEXT (context);
2985 g_main_context_poll (context, timeout, max_priority, fds, nfds);
2987 some_ready = g_main_context_check (context, max_priority, fds, nfds);
2990 g_main_context_dispatch (context);
2992 g_main_context_release (context);
2994 LOCK_CONTEXT (context);
3000 * g_main_context_pending:
3001 * @context: a #GMainContext (if %NULL, the default context will be used)
3003 * Checks if any sources have pending events for the given context.
3005 * Return value: %TRUE if events are pending.
3008 g_main_context_pending (GMainContext *context)
3013 context = g_main_context_default();
3015 LOCK_CONTEXT (context);
3016 retval = g_main_context_iterate (context, FALSE, FALSE, G_THREAD_SELF);
3017 UNLOCK_CONTEXT (context);
3023 * g_main_context_iteration:
3024 * @context: a #GMainContext (if %NULL, the default context will be used)
3025 * @may_block: whether the call may block.
3027 * Runs a single iteration for the given main loop. This involves
3028 * checking to see if any event sources are ready to be processed,
3029 * then if no events sources are ready and @may_block is %TRUE, waiting
3030 * for a source to become ready, then dispatching the highest priority
3031 * events sources that are ready. Otherwise, if @may_block is %FALSE
3032 * sources are not waited to become ready, only those highest priority
3033 * events sources will be dispatched (if any), that are ready at this
3034 * given moment without further waiting.
3036 * Note that even when @may_block is %TRUE, it is still possible for
3037 * g_main_context_iteration() to return %FALSE, since the the wait may
3038 * be interrupted for other reasons than an event source becoming ready.
3040 * Return value: %TRUE if events were dispatched.
3043 g_main_context_iteration (GMainContext *context, gboolean may_block)
3048 context = g_main_context_default();
3050 LOCK_CONTEXT (context);
3051 retval = g_main_context_iterate (context, may_block, TRUE, G_THREAD_SELF);
3052 UNLOCK_CONTEXT (context);
3059 * @context: (allow-none): a #GMainContext (if %NULL, the default context will be used).
3060 * @is_running: set to %TRUE to indicate that the loop is running. This
3061 * is not very important since calling g_main_loop_run() will set this to
3064 * Creates a new #GMainLoop structure.
3066 * Return value: a new #GMainLoop.
3069 g_main_loop_new (GMainContext *context,
3070 gboolean is_running)
3075 context = g_main_context_default();
3077 g_main_context_ref (context);
3079 loop = g_new0 (GMainLoop, 1);
3080 loop->context = context;
3081 loop->is_running = is_running != FALSE;
3082 loop->ref_count = 1;
3089 * @loop: a #GMainLoop
3091 * Increases the reference count on a #GMainLoop object by one.
3093 * Return value: @loop
3096 g_main_loop_ref (GMainLoop *loop)
3098 g_return_val_if_fail (loop != NULL, NULL);
3099 g_return_val_if_fail (g_atomic_int_get (&loop->ref_count) > 0, NULL);
3101 g_atomic_int_inc (&loop->ref_count);
3107 * g_main_loop_unref:
3108 * @loop: a #GMainLoop
3110 * Decreases the reference count on a #GMainLoop object by one. If
3111 * the result is zero, free the loop and free all associated memory.
3114 g_main_loop_unref (GMainLoop *loop)
3116 g_return_if_fail (loop != NULL);
3117 g_return_if_fail (g_atomic_int_get (&loop->ref_count) > 0);
3119 if (!g_atomic_int_dec_and_test (&loop->ref_count))
3122 g_main_context_unref (loop->context);
3128 * @loop: a #GMainLoop
3130 * Runs a main loop until g_main_loop_quit() is called on the loop.
3131 * If this is called for the thread of the loop's #GMainContext,
3132 * it will process events from the loop, otherwise it will
3136 g_main_loop_run (GMainLoop *loop)
3138 GThread *self = G_THREAD_SELF;
3140 g_return_if_fail (loop != NULL);
3141 g_return_if_fail (g_atomic_int_get (&loop->ref_count) > 0);
3143 if (!g_main_context_acquire (loop->context))
3145 gboolean got_ownership = FALSE;
3147 /* Another thread owns this context */
3148 LOCK_CONTEXT (loop->context);
3150 g_atomic_int_inc (&loop->ref_count);
3152 if (!loop->is_running)
3153 loop->is_running = TRUE;
3155 if (!loop->context->cond)
3156 loop->context->cond = g_cond_new ();
3158 while (loop->is_running && !got_ownership)
3159 got_ownership = g_main_context_wait (loop->context,
3160 loop->context->cond,
3161 g_static_mutex_get_mutex (&loop->context->mutex));
3163 if (!loop->is_running)
3165 UNLOCK_CONTEXT (loop->context);
3167 g_main_context_release (loop->context);
3168 g_main_loop_unref (loop);
3172 g_assert (got_ownership);
3175 LOCK_CONTEXT (loop->context);
3177 if (loop->context->in_check_or_prepare)
3179 g_warning ("g_main_loop_run(): called recursively from within a source's "
3180 "check() or prepare() member, iteration not possible.");
3184 g_atomic_int_inc (&loop->ref_count);
3185 loop->is_running = TRUE;
3186 while (loop->is_running)
3187 g_main_context_iterate (loop->context, TRUE, TRUE, self);
3189 UNLOCK_CONTEXT (loop->context);
3191 g_main_context_release (loop->context);
3193 g_main_loop_unref (loop);
3198 * @loop: a #GMainLoop
3200 * Stops a #GMainLoop from running. Any calls to g_main_loop_run()
3201 * for the loop will return.
3203 * Note that sources that have already been dispatched when
3204 * g_main_loop_quit() is called will still be executed.
3207 g_main_loop_quit (GMainLoop *loop)
3209 g_return_if_fail (loop != NULL);
3210 g_return_if_fail (g_atomic_int_get (&loop->ref_count) > 0);
3212 LOCK_CONTEXT (loop->context);
3213 loop->is_running = FALSE;
3214 g_wakeup_signal (loop->context->wakeup);
3216 if (loop->context->cond)
3217 g_cond_broadcast (loop->context->cond);
3219 UNLOCK_CONTEXT (loop->context);
3223 * g_main_loop_is_running:
3224 * @loop: a #GMainLoop.
3226 * Checks to see if the main loop is currently being run via g_main_loop_run().
3228 * Return value: %TRUE if the mainloop is currently being run.
3231 g_main_loop_is_running (GMainLoop *loop)
3233 g_return_val_if_fail (loop != NULL, FALSE);
3234 g_return_val_if_fail (g_atomic_int_get (&loop->ref_count) > 0, FALSE);
3236 return loop->is_running;
3240 * g_main_loop_get_context:
3241 * @loop: a #GMainLoop.
3243 * Returns the #GMainContext of @loop.
3245 * Return value: (transfer none): the #GMainContext of @loop
3248 g_main_loop_get_context (GMainLoop *loop)
3250 g_return_val_if_fail (loop != NULL, NULL);
3251 g_return_val_if_fail (g_atomic_int_get (&loop->ref_count) > 0, NULL);
3253 return loop->context;
3256 /* HOLDS: context's lock */
3258 g_main_context_poll (GMainContext *context,
3264 #ifdef G_MAIN_POLL_DEBUG
3270 GPollFunc poll_func;
3272 if (n_fds || timeout != 0)
3274 #ifdef G_MAIN_POLL_DEBUG
3275 if (_g_main_poll_debug)
3277 g_print ("polling context=%p n=%d timeout=%d\n",
3278 context, n_fds, timeout);
3279 poll_timer = g_timer_new ();
3283 LOCK_CONTEXT (context);
3285 poll_func = context->poll_func;
3287 UNLOCK_CONTEXT (context);
3288 if ((*poll_func) (fds, n_fds, timeout) < 0 && errno != EINTR)
3291 g_warning ("poll(2) failed due to: %s.",
3292 g_strerror (errno));
3294 /* If g_poll () returns -1, it has already called g_warning() */
3298 #ifdef G_MAIN_POLL_DEBUG
3299 if (_g_main_poll_debug)
3301 LOCK_CONTEXT (context);
3303 g_print ("g_main_poll(%d) timeout: %d - elapsed %12.10f seconds",
3306 g_timer_elapsed (poll_timer, NULL));
3307 g_timer_destroy (poll_timer);
3308 pollrec = context->poll_records;
3310 while (pollrec != NULL)
3315 if (fds[i].fd == pollrec->fd->fd &&
3316 pollrec->fd->events &&
3319 g_print (" [" G_POLLFD_FORMAT " :", fds[i].fd);
3320 if (fds[i].revents & G_IO_IN)
3322 if (fds[i].revents & G_IO_OUT)
3324 if (fds[i].revents & G_IO_PRI)
3326 if (fds[i].revents & G_IO_ERR)
3328 if (fds[i].revents & G_IO_HUP)
3330 if (fds[i].revents & G_IO_NVAL)
3336 pollrec = pollrec->next;
3340 UNLOCK_CONTEXT (context);
3343 } /* if (n_fds || timeout != 0) */
3347 * g_main_context_add_poll:
3348 * @context: a #GMainContext (or %NULL for the default context)
3349 * @fd: a #GPollFD structure holding information about a file
3350 * descriptor to watch.
3351 * @priority: the priority for this file descriptor which should be
3352 * the same as the priority used for g_source_attach() to ensure that the
3353 * file descriptor is polled whenever the results may be needed.
3355 * Adds a file descriptor to the set of file descriptors polled for
3356 * this context. This will very seldom be used directly. Instead
3357 * a typical event source will use g_source_add_poll() instead.
3360 g_main_context_add_poll (GMainContext *context,
3365 context = g_main_context_default ();
3367 g_return_if_fail (g_atomic_int_get (&context->ref_count) > 0);
3368 g_return_if_fail (fd);
3370 LOCK_CONTEXT (context);
3371 g_main_context_add_poll_unlocked (context, priority, fd);
3372 UNLOCK_CONTEXT (context);
3375 /* HOLDS: main_loop_lock */
3377 g_main_context_add_poll_unlocked (GMainContext *context,
3381 GPollRec *prevrec, *nextrec;
3382 GPollRec *newrec = g_slice_new (GPollRec);
3384 /* This file descriptor may be checked before we ever poll */
3387 newrec->priority = priority;
3389 prevrec = context->poll_records_tail;
3391 while (prevrec && priority < prevrec->priority)
3394 prevrec = prevrec->prev;
3398 prevrec->next = newrec;
3400 context->poll_records = newrec;
3402 newrec->prev = prevrec;
3403 newrec->next = nextrec;
3406 nextrec->prev = newrec;
3408 context->poll_records_tail = newrec;
3410 context->n_poll_records++;
3412 context->poll_changed = TRUE;
3414 /* Now wake up the main loop if it is waiting in the poll() */
3415 g_wakeup_signal (context->wakeup);
3419 * g_main_context_remove_poll:
3420 * @context:a #GMainContext
3421 * @fd: a #GPollFD descriptor previously added with g_main_context_add_poll()
3423 * Removes file descriptor from the set of file descriptors to be
3424 * polled for a particular context.
3427 g_main_context_remove_poll (GMainContext *context,
3431 context = g_main_context_default ();
3433 g_return_if_fail (g_atomic_int_get (&context->ref_count) > 0);
3434 g_return_if_fail (fd);
3436 LOCK_CONTEXT (context);
3437 g_main_context_remove_poll_unlocked (context, fd);
3438 UNLOCK_CONTEXT (context);
3442 g_main_context_remove_poll_unlocked (GMainContext *context,
3445 GPollRec *pollrec, *prevrec, *nextrec;
3448 pollrec = context->poll_records;
3452 nextrec = pollrec->next;
3453 if (pollrec->fd == fd)
3455 if (prevrec != NULL)
3456 prevrec->next = nextrec;
3458 context->poll_records = nextrec;
3460 if (nextrec != NULL)
3461 nextrec->prev = prevrec;
3463 context->poll_records_tail = prevrec;
3465 g_slice_free (GPollRec, pollrec);
3467 context->n_poll_records--;
3474 context->poll_changed = TRUE;
3476 /* Now wake up the main loop if it is waiting in the poll() */
3477 g_wakeup_signal (context->wakeup);
3481 * g_source_get_current_time:
3482 * @source: a #GSource
3483 * @timeval: #GTimeVal structure in which to store current time.
3485 * This function ignores @source and is otherwise the same as
3486 * g_get_current_time().
3488 * Deprecated: 2.28: use g_source_get_time() instead
3491 g_source_get_current_time (GSource *source,
3494 g_get_current_time (timeval);
3498 * g_source_get_time:
3499 * @source: a #GSource
3501 * Gets the time to be used when checking this source. The advantage of
3502 * calling this function over calling g_get_monotonic_time() directly is
3503 * that when checking multiple sources, GLib can cache a single value
3504 * instead of having to repeatedly get the system monotonic time.
3506 * The time here is the system monotonic time, if available, or some
3507 * other reasonable alternative otherwise. See g_get_monotonic_time().
3509 * Returns: the monotonic time in microseconds
3514 g_source_get_time (GSource *source)
3516 GMainContext *context;
3519 g_return_val_if_fail (source->context != NULL, 0);
3521 context = source->context;
3523 LOCK_CONTEXT (context);
3525 if (!context->time_is_fresh)
3527 context->time = g_get_monotonic_time ();
3528 context->time_is_fresh = TRUE;
3531 result = context->time;
3533 UNLOCK_CONTEXT (context);
3539 * g_main_context_set_poll_func:
3540 * @context: a #GMainContext
3541 * @func: the function to call to poll all file descriptors
3543 * Sets the function to use to handle polling of file descriptors. It
3544 * will be used instead of the poll() system call
3545 * (or GLib's replacement function, which is used where
3546 * poll() isn't available).
3548 * This function could possibly be used to integrate the GLib event
3549 * loop with an external event loop.
3552 g_main_context_set_poll_func (GMainContext *context,
3556 context = g_main_context_default ();
3558 g_return_if_fail (g_atomic_int_get (&context->ref_count) > 0);
3560 LOCK_CONTEXT (context);
3563 context->poll_func = func;
3565 context->poll_func = g_poll;
3567 UNLOCK_CONTEXT (context);
3571 * g_main_context_get_poll_func:
3572 * @context: a #GMainContext
3574 * Gets the poll function set by g_main_context_set_poll_func().
3576 * Return value: the poll function
3579 g_main_context_get_poll_func (GMainContext *context)
3584 context = g_main_context_default ();
3586 g_return_val_if_fail (g_atomic_int_get (&context->ref_count) > 0, NULL);
3588 LOCK_CONTEXT (context);
3589 result = context->poll_func;
3590 UNLOCK_CONTEXT (context);
3596 * g_main_context_wakeup:
3597 * @context: a #GMainContext
3599 * If @context is currently waiting in a poll(), interrupt
3600 * the poll(), and continue the iteration process.
3603 g_main_context_wakeup (GMainContext *context)
3606 context = g_main_context_default ();
3608 g_return_if_fail (g_atomic_int_get (&context->ref_count) > 0);
3610 g_wakeup_signal (context->wakeup);
3614 * g_main_context_is_owner:
3615 * @context: a #GMainContext
3617 * Determines whether this thread holds the (recursive)
3618 * ownership of this #GMainContext. This is useful to
3619 * know before waiting on another thread that may be
3620 * blocking to get ownership of @context.
3622 * Returns: %TRUE if current thread is owner of @context.
3627 g_main_context_is_owner (GMainContext *context)
3632 context = g_main_context_default ();
3634 LOCK_CONTEXT (context);
3635 is_owner = context->owner == G_THREAD_SELF;
3636 UNLOCK_CONTEXT (context);
3644 g_timeout_set_expiration (GTimeoutSource *timeout_source,
3645 gint64 current_time)
3647 timeout_source->expiration = current_time +
3648 (guint64) timeout_source->interval * 1000;
3650 if (timeout_source->seconds)
3653 static gint timer_perturb = -1;
3655 if (timer_perturb == -1)
3658 * we want a per machine/session unique 'random' value; try the dbus
3659 * address first, that has a UUID in it. If there is no dbus, use the
3660 * hostname for hashing.
3662 const char *session_bus_address = g_getenv ("DBUS_SESSION_BUS_ADDRESS");
3663 if (!session_bus_address)
3664 session_bus_address = g_getenv ("HOSTNAME");
3665 if (session_bus_address)
3666 timer_perturb = ABS ((gint) g_str_hash (session_bus_address)) % 1000000;
3671 /* We want the microseconds part of the timeout to land on the
3672 * 'timer_perturb' mark, but we need to make sure we don't try to
3673 * set the timeout in the past. We do this by ensuring that we
3674 * always only *increase* the expiration time by adding a full
3675 * second in the case that the microsecond portion decreases.
3677 timeout_source->expiration -= timer_perturb;
3679 remainder = timeout_source->expiration % 1000000;
3680 if (remainder >= 1000000/4)
3681 timeout_source->expiration += 1000000;
3683 timeout_source->expiration -= remainder;
3684 timeout_source->expiration += timer_perturb;
3689 g_timeout_prepare (GSource *source,
3692 GTimeoutSource *timeout_source = (GTimeoutSource *) source;
3693 gint64 now = g_source_get_time (source);
3695 if (now < timeout_source->expiration)
3697 /* Round up to ensure that we don't try again too early */
3698 *timeout = (timeout_source->expiration - now + 999) / 1000;
3707 g_timeout_check (GSource *source)
3709 GTimeoutSource *timeout_source = (GTimeoutSource *) source;
3710 gint64 now = g_source_get_time (source);
3712 return timeout_source->expiration <= now;
3716 g_timeout_dispatch (GSource *source,
3717 GSourceFunc callback,
3720 GTimeoutSource *timeout_source = (GTimeoutSource *)source;
3725 g_warning ("Timeout source dispatched without callback\n"
3726 "You must call g_source_set_callback().");
3730 again = callback (user_data);
3733 g_timeout_set_expiration (timeout_source, g_source_get_time (source));
3739 * g_timeout_source_new:
3740 * @interval: the timeout interval in milliseconds.
3742 * Creates a new timeout source.
3744 * The source will not initially be associated with any #GMainContext
3745 * and must be added to one with g_source_attach() before it will be
3748 * The interval given is in terms of monotonic time, not wall clock
3749 * time. See g_get_monotonic_time().
3751 * Return value: the newly-created timeout source
3754 g_timeout_source_new (guint interval)
3756 GSource *source = g_source_new (&g_timeout_funcs, sizeof (GTimeoutSource));
3757 GTimeoutSource *timeout_source = (GTimeoutSource *)source;
3759 timeout_source->interval = interval;
3760 g_timeout_set_expiration (timeout_source, g_get_monotonic_time ());
3766 * g_timeout_source_new_seconds:
3767 * @interval: the timeout interval in seconds
3769 * Creates a new timeout source.
3771 * The source will not initially be associated with any #GMainContext
3772 * and must be added to one with g_source_attach() before it will be
3775 * The scheduling granularity/accuracy of this timeout source will be
3778 * The interval given in terms of monotonic time, not wall clock time.
3779 * See g_get_monotonic_time().
3781 * Return value: the newly-created timeout source
3786 g_timeout_source_new_seconds (guint interval)
3788 GSource *source = g_source_new (&g_timeout_funcs, sizeof (GTimeoutSource));
3789 GTimeoutSource *timeout_source = (GTimeoutSource *)source;
3791 timeout_source->interval = 1000 * interval;
3792 timeout_source->seconds = TRUE;
3794 g_timeout_set_expiration (timeout_source, g_get_monotonic_time ());
3801 * g_timeout_add_full:
3802 * @priority: the priority of the timeout source. Typically this will be in
3803 * the range between #G_PRIORITY_DEFAULT and #G_PRIORITY_HIGH.
3804 * @interval: the time between calls to the function, in milliseconds
3805 * (1/1000ths of a second)
3806 * @function: function to call
3807 * @data: data to pass to @function
3808 * @notify: function to call when the timeout is removed, or %NULL
3810 * Sets a function to be called at regular intervals, with the given
3811 * priority. The function is called repeatedly until it returns
3812 * %FALSE, at which point the timeout is automatically destroyed and
3813 * the function will not be called again. The @notify function is
3814 * called when the timeout is destroyed. The first call to the
3815 * function will be at the end of the first @interval.
3817 * Note that timeout functions may be delayed, due to the processing of other
3818 * event sources. Thus they should not be relied on for precise timing.
3819 * After each call to the timeout function, the time of the next
3820 * timeout is recalculated based on the current time and the given interval
3821 * (it does not try to 'catch up' time lost in delays).
3823 * This internally creates a main loop source using g_timeout_source_new()
3824 * and attaches it to the main loop context using g_source_attach(). You can
3825 * do these steps manually if you need greater control.
3827 * The interval given in terms of monotonic time, not wall clock time.
3828 * See g_get_monotonic_time().
3830 * Return value: the ID (greater than 0) of the event source.
3831 * Rename to: g_timeout_add
3834 g_timeout_add_full (gint priority,
3836 GSourceFunc function,
3838 GDestroyNotify notify)
3843 g_return_val_if_fail (function != NULL, 0);
3845 source = g_timeout_source_new (interval);
3847 if (priority != G_PRIORITY_DEFAULT)
3848 g_source_set_priority (source, priority);
3850 g_source_set_callback (source, function, data, notify);
3851 id = g_source_attach (source, NULL);
3852 g_source_unref (source);
3859 * @interval: the time between calls to the function, in milliseconds
3860 * (1/1000ths of a second)
3861 * @function: function to call
3862 * @data: data to pass to @function
3864 * Sets a function to be called at regular intervals, with the default
3865 * priority, #G_PRIORITY_DEFAULT. The function is called repeatedly
3866 * until it returns %FALSE, at which point the timeout is automatically
3867 * destroyed and the function will not be called again. The first call
3868 * to the function will be at the end of the first @interval.
3870 * Note that timeout functions may be delayed, due to the processing of other
3871 * event sources. Thus they should not be relied on for precise timing.
3872 * After each call to the timeout function, the time of the next
3873 * timeout is recalculated based on the current time and the given interval
3874 * (it does not try to 'catch up' time lost in delays).
3876 * If you want to have a timer in the "seconds" range and do not care
3877 * about the exact time of the first call of the timer, use the
3878 * g_timeout_add_seconds() function; this function allows for more
3879 * optimizations and more efficient system power usage.
3881 * This internally creates a main loop source using g_timeout_source_new()
3882 * and attaches it to the main loop context using g_source_attach(). You can
3883 * do these steps manually if you need greater control.
3885 * The interval given is in terms of monotonic time, not wall clock
3886 * time. See g_get_monotonic_time().
3888 * Return value: the ID (greater than 0) of the event source.
3891 g_timeout_add (guint32 interval,
3892 GSourceFunc function,
3895 return g_timeout_add_full (G_PRIORITY_DEFAULT,
3896 interval, function, data, NULL);
3900 * g_timeout_add_seconds_full:
3901 * @priority: the priority of the timeout source. Typically this will be in
3902 * the range between #G_PRIORITY_DEFAULT and #G_PRIORITY_HIGH.
3903 * @interval: the time between calls to the function, in seconds
3904 * @function: function to call
3905 * @data: data to pass to @function
3906 * @notify: function to call when the timeout is removed, or %NULL
3908 * Sets a function to be called at regular intervals, with @priority.
3909 * The function is called repeatedly until it returns %FALSE, at which
3910 * point the timeout is automatically destroyed and the function will
3911 * not be called again.
3913 * Unlike g_timeout_add(), this function operates at whole second granularity.
3914 * The initial starting point of the timer is determined by the implementation
3915 * and the implementation is expected to group multiple timers together so that
3916 * they fire all at the same time.
3917 * To allow this grouping, the @interval to the first timer is rounded
3918 * and can deviate up to one second from the specified interval.
3919 * Subsequent timer iterations will generally run at the specified interval.
3921 * Note that timeout functions may be delayed, due to the processing of other
3922 * event sources. Thus they should not be relied on for precise timing.
3923 * After each call to the timeout function, the time of the next
3924 * timeout is recalculated based on the current time and the given @interval
3926 * If you want timing more precise than whole seconds, use g_timeout_add()
3929 * The grouping of timers to fire at the same time results in a more power
3930 * and CPU efficient behavior so if your timer is in multiples of seconds
3931 * and you don't require the first timer exactly one second from now, the
3932 * use of g_timeout_add_seconds() is preferred over g_timeout_add().
3934 * This internally creates a main loop source using
3935 * g_timeout_source_new_seconds() and attaches it to the main loop context
3936 * using g_source_attach(). You can do these steps manually if you need
3939 * The interval given is in terms of monotonic time, not wall clock
3940 * time. See g_get_monotonic_time().
3942 * Return value: the ID (greater than 0) of the event source.
3944 * Rename to: g_timeout_add_seconds
3948 g_timeout_add_seconds_full (gint priority,
3950 GSourceFunc function,
3952 GDestroyNotify notify)
3957 g_return_val_if_fail (function != NULL, 0);
3959 source = g_timeout_source_new_seconds (interval);
3961 if (priority != G_PRIORITY_DEFAULT)
3962 g_source_set_priority (source, priority);
3964 g_source_set_callback (source, function, data, notify);
3965 id = g_source_attach (source, NULL);
3966 g_source_unref (source);
3972 * g_timeout_add_seconds:
3973 * @interval: the time between calls to the function, in seconds
3974 * @function: function to call
3975 * @data: data to pass to @function
3977 * Sets a function to be called at regular intervals with the default
3978 * priority, #G_PRIORITY_DEFAULT. The function is called repeatedly until
3979 * it returns %FALSE, at which point the timeout is automatically destroyed
3980 * and the function will not be called again.
3982 * This internally creates a main loop source using
3983 * g_timeout_source_new_seconds() and attaches it to the main loop context
3984 * using g_source_attach(). You can do these steps manually if you need
3985 * greater control. Also see g_timeout_add_seconds_full().
3987 * Note that the first call of the timer may not be precise for timeouts
3988 * of one second. If you need finer precision and have such a timeout,
3989 * you may want to use g_timeout_add() instead.
3991 * The interval given is in terms of monotonic time, not wall clock
3992 * time. See g_get_monotonic_time().
3994 * Return value: the ID (greater than 0) of the event source.
3999 g_timeout_add_seconds (guint interval,
4000 GSourceFunc function,
4003 g_return_val_if_fail (function != NULL, 0);
4005 return g_timeout_add_seconds_full (G_PRIORITY_DEFAULT, interval, function, data, NULL);
4008 /* Child watch functions */
4013 g_child_watch_prepare (GSource *source,
4022 g_child_watch_check (GSource *source)
4024 GChildWatchSource *child_watch_source;
4025 gboolean child_exited;
4027 child_watch_source = (GChildWatchSource *) source;
4029 child_exited = child_watch_source->poll.revents & G_IO_IN;
4036 * Note: We do _not_ check for the special value of STILL_ACTIVE
4037 * since we know that the process has exited and doing so runs into
4038 * problems if the child process "happens to return STILL_ACTIVE(259)"
4039 * as Microsoft's Platform SDK puts it.
4041 if (!GetExitCodeProcess (child_watch_source->pid, &child_status))
4043 gchar *emsg = g_win32_error_message (GetLastError ());
4044 g_warning (G_STRLOC ": GetExitCodeProcess() failed: %s", emsg);
4047 child_watch_source->child_status = -1;
4050 child_watch_source->child_status = child_status;
4053 return child_exited;
4056 #else /* G_OS_WIN32 */
4059 wake_source (GSource *source)
4061 GMainContext *context;
4063 /* This should be thread-safe:
4065 * - if the source is currently being added to a context, that
4066 * context will be woken up anyway
4068 * - if the source is currently being destroyed, we simply need not
4071 * - the memory for the source will remain valid until after the
4072 * source finalize function was called (which would remove the
4073 * source from the global list which we are currently holding the
4076 * - the GMainContext will either be NULL or point to a live
4079 * - the GMainContext will remain valid since we hold the
4080 * main_context_list lock
4082 * Since we are holding a lot of locks here, don't try to enter any
4083 * more GMainContext functions for fear of dealock -- just hit the
4084 * GWakeup and run. Even if that's safe now, it could easily become
4085 * unsafe with some very minor changes in the future, and signal
4086 * handling is not the most well-tested codepath.
4088 G_LOCK(main_context_list);
4089 context = source->context;
4091 g_wakeup_signal (context->wakeup);
4092 G_UNLOCK(main_context_list);
4096 dispatch_unix_signals (void)
4100 /* clear this first incase another one arrives while we're processing */
4101 any_unix_signal_pending = FALSE;
4103 G_LOCK(unix_signal_lock);
4105 /* handle GChildWatchSource instances */
4106 if (unix_signal_pending[SIGCHLD])
4108 unix_signal_pending[SIGCHLD] = FALSE;
4110 /* The only way we can do this is to scan all of the children.
4112 * The docs promise that we will not reap children that we are not
4113 * explicitly watching, so that ties our hands from calling
4114 * waitpid(-1). We also can't use siginfo's si_pid field since if
4115 * multiple SIGCHLD arrive at the same time, one of them can be
4116 * dropped (since a given UNIX signal can only be pending once).
4118 for (node = unix_child_watches; node; node = node->next)
4120 GChildWatchSource *source = node->data;
4122 if (!source->child_exited)
4124 if (waitpid (source->pid, &source->child_status, WNOHANG) > 0)
4126 source->child_exited = TRUE;
4128 wake_source ((GSource *) source);
4134 /* handle GUnixSignalWatchSource instances */
4135 for (node = unix_signal_watches; node; node = node->next)
4137 GUnixSignalWatchSource *source = node->data;
4139 if (!source->pending)
4141 if (unix_signal_pending[source->signum])
4143 unix_signal_pending[source->signum] = FALSE;
4144 source->pending = TRUE;
4146 wake_source ((GSource *) source);
4151 G_UNLOCK(unix_signal_lock);
4155 g_child_watch_prepare (GSource *source,
4158 GChildWatchSource *child_watch_source;
4160 child_watch_source = (GChildWatchSource *) source;
4162 return child_watch_source->child_exited;
4166 g_child_watch_check (GSource *source)
4168 GChildWatchSource *child_watch_source;
4170 child_watch_source = (GChildWatchSource *) source;
4172 return child_watch_source->child_exited;
4176 g_unix_signal_watch_prepare (GSource *source,
4179 GUnixSignalWatchSource *unix_signal_source;
4181 unix_signal_source = (GUnixSignalWatchSource *) source;
4183 return unix_signal_source->pending;
4187 g_unix_signal_watch_check (GSource *source)
4189 GUnixSignalWatchSource *unix_signal_source;
4191 unix_signal_source = (GUnixSignalWatchSource *) source;
4193 return unix_signal_source->pending;
4197 g_unix_signal_watch_dispatch (GSource *source,
4198 GSourceFunc callback,
4201 GUnixSignalWatchSource *unix_signal_source;
4203 unix_signal_source = (GUnixSignalWatchSource *) source;
4207 g_warning ("Unix signal source dispatched without callback\n"
4208 "You must call g_source_set_callback().");
4212 (callback) (user_data);
4214 unix_signal_source->pending = FALSE;
4220 ensure_unix_signal_handler_installed_unlocked (int signum)
4222 static sigset_t installed_signal_mask;
4223 static gboolean initialized;
4224 struct sigaction action;
4228 sigemptyset (&installed_signal_mask);
4229 g_get_worker_context ();
4233 if (sigismember (&installed_signal_mask, signum))
4236 sigaddset (&installed_signal_mask, signum);
4238 action.sa_handler = g_unix_signal_handler;
4239 sigemptyset (&action.sa_mask);
4240 action.sa_flags = SA_RESTART | SA_NOCLDSTOP;
4241 sigaction (signum, &action, NULL);
4245 _g_main_create_unix_signal_watch (int signum)
4248 GUnixSignalWatchSource *unix_signal_source;
4250 source = g_source_new (&g_unix_signal_funcs, sizeof (GUnixSignalWatchSource));
4251 unix_signal_source = (GUnixSignalWatchSource *) source;
4253 unix_signal_source->signum = signum;
4254 unix_signal_source->pending = FALSE;
4256 G_LOCK (unix_signal_lock);
4257 ensure_unix_signal_handler_installed_unlocked (signum);
4258 unix_signal_watches = g_slist_prepend (unix_signal_watches, unix_signal_source);
4259 if (unix_signal_pending[signum])
4260 unix_signal_source->pending = TRUE;
4261 unix_signal_pending[signum] = FALSE;
4262 G_UNLOCK (unix_signal_lock);
4268 g_unix_signal_watch_finalize (GSource *source)
4270 G_LOCK (unix_signal_lock);
4271 unix_signal_watches = g_slist_remove (unix_signal_watches, source);
4272 G_UNLOCK (unix_signal_lock);
4275 #endif /* G_OS_WIN32 */
4278 g_child_watch_finalize (GSource *source)
4280 G_LOCK (unix_signal_lock);
4281 unix_child_watches = g_slist_remove (unix_child_watches, source);
4282 G_UNLOCK (unix_signal_lock);
4286 g_child_watch_dispatch (GSource *source,
4287 GSourceFunc callback,
4290 GChildWatchSource *child_watch_source;
4291 GChildWatchFunc child_watch_callback = (GChildWatchFunc) callback;
4293 child_watch_source = (GChildWatchSource *) source;
4297 g_warning ("Child watch source dispatched without callback\n"
4298 "You must call g_source_set_callback().");
4302 (child_watch_callback) (child_watch_source->pid, child_watch_source->child_status, user_data);
4304 /* We never keep a child watch source around as the child is gone */
4311 g_unix_signal_handler (int signum)
4313 unix_signal_pending[signum] = TRUE;
4314 any_unix_signal_pending = TRUE;
4316 g_wakeup_signal (glib_worker_context->wakeup);
4319 #endif /* !G_OS_WIN32 */
4322 * g_child_watch_source_new:
4323 * @pid: process to watch. On POSIX the pid of a child process. On
4324 * Windows a handle for a process (which doesn't have to be a child).
4326 * Creates a new child_watch source.
4328 * The source will not initially be associated with any #GMainContext
4329 * and must be added to one with g_source_attach() before it will be
4332 * Note that child watch sources can only be used in conjunction with
4333 * <literal>g_spawn...</literal> when the %G_SPAWN_DO_NOT_REAP_CHILD
4336 * Note that on platforms where #GPid must be explicitly closed
4337 * (see g_spawn_close_pid()) @pid must not be closed while the
4338 * source is still active. Typically, you will want to call
4339 * g_spawn_close_pid() in the callback function for the source.
4341 * Note further that using g_child_watch_source_new() is not
4342 * compatible with calling <literal>waitpid(-1)</literal> in
4343 * the application. Calling waitpid() for individual pids will
4346 * Return value: the newly-created child watch source
4351 g_child_watch_source_new (GPid pid)
4353 GSource *source = g_source_new (&g_child_watch_funcs, sizeof (GChildWatchSource));
4354 GChildWatchSource *child_watch_source = (GChildWatchSource *)source;
4356 child_watch_source->pid = pid;
4359 child_watch_source->poll.fd = (gintptr) pid;
4360 child_watch_source->poll.events = G_IO_IN;
4362 g_source_add_poll (source, &child_watch_source->poll);
4363 #else /* G_OS_WIN32 */
4364 G_LOCK (unix_signal_lock);
4365 ensure_unix_signal_handler_installed_unlocked (SIGCHLD);
4366 unix_child_watches = g_slist_prepend (unix_child_watches, child_watch_source);
4367 if (waitpid (pid, &child_watch_source->child_status, WNOHANG) > 0)
4368 child_watch_source->child_exited = TRUE;
4369 G_UNLOCK (unix_signal_lock);
4370 #endif /* G_OS_WIN32 */
4376 * g_child_watch_add_full:
4377 * @priority: the priority of the idle source. Typically this will be in the
4378 * range between #G_PRIORITY_DEFAULT_IDLE and #G_PRIORITY_HIGH_IDLE.
4379 * @pid: process to watch. On POSIX the pid of a child process. On
4380 * Windows a handle for a process (which doesn't have to be a child).
4381 * @function: function to call
4382 * @data: data to pass to @function
4383 * @notify: function to call when the idle is removed, or %NULL
4385 * Sets a function to be called when the child indicated by @pid
4386 * exits, at the priority @priority.
4388 * If you obtain @pid from g_spawn_async() or g_spawn_async_with_pipes()
4389 * you will need to pass #G_SPAWN_DO_NOT_REAP_CHILD as flag to
4390 * the spawn function for the child watching to work.
4392 * Note that on platforms where #GPid must be explicitly closed
4393 * (see g_spawn_close_pid()) @pid must not be closed while the
4394 * source is still active. Typically, you will want to call
4395 * g_spawn_close_pid() in the callback function for the source.
4397 * GLib supports only a single callback per process id.
4399 * This internally creates a main loop source using
4400 * g_child_watch_source_new() and attaches it to the main loop context
4401 * using g_source_attach(). You can do these steps manually if you
4402 * need greater control.
4404 * Return value: the ID (greater than 0) of the event source.
4406 * Rename to: g_child_watch_add
4410 g_child_watch_add_full (gint priority,
4412 GChildWatchFunc function,
4414 GDestroyNotify notify)
4419 g_return_val_if_fail (function != NULL, 0);
4421 source = g_child_watch_source_new (pid);
4423 if (priority != G_PRIORITY_DEFAULT)
4424 g_source_set_priority (source, priority);
4426 g_source_set_callback (source, (GSourceFunc) function, data, notify);
4427 id = g_source_attach (source, NULL);
4428 g_source_unref (source);
4434 * g_child_watch_add:
4435 * @pid: process id to watch. On POSIX the pid of a child process. On
4436 * Windows a handle for a process (which doesn't have to be a child).
4437 * @function: function to call
4438 * @data: data to pass to @function
4440 * Sets a function to be called when the child indicated by @pid
4441 * exits, at a default priority, #G_PRIORITY_DEFAULT.
4443 * If you obtain @pid from g_spawn_async() or g_spawn_async_with_pipes()
4444 * you will need to pass #G_SPAWN_DO_NOT_REAP_CHILD as flag to
4445 * the spawn function for the child watching to work.
4447 * Note that on platforms where #GPid must be explicitly closed
4448 * (see g_spawn_close_pid()) @pid must not be closed while the
4449 * source is still active. Typically, you will want to call
4450 * g_spawn_close_pid() in the callback function for the source.
4452 * GLib supports only a single callback per process id.
4454 * This internally creates a main loop source using
4455 * g_child_watch_source_new() and attaches it to the main loop context
4456 * using g_source_attach(). You can do these steps manually if you
4457 * need greater control.
4459 * Return value: the ID (greater than 0) of the event source.
4464 g_child_watch_add (GPid pid,
4465 GChildWatchFunc function,
4468 return g_child_watch_add_full (G_PRIORITY_DEFAULT, pid, function, data, NULL);
4472 /* Idle functions */
4475 g_idle_prepare (GSource *source,
4484 g_idle_check (GSource *source)
4490 g_idle_dispatch (GSource *source,
4491 GSourceFunc callback,
4496 g_warning ("Idle source dispatched without callback\n"
4497 "You must call g_source_set_callback().");
4501 return callback (user_data);
4505 * g_idle_source_new:
4507 * Creates a new idle source.
4509 * The source will not initially be associated with any #GMainContext
4510 * and must be added to one with g_source_attach() before it will be
4511 * executed. Note that the default priority for idle sources is
4512 * %G_PRIORITY_DEFAULT_IDLE, as compared to other sources which
4513 * have a default priority of %G_PRIORITY_DEFAULT.
4515 * Return value: the newly-created idle source
4518 g_idle_source_new (void)
4522 source = g_source_new (&g_idle_funcs, sizeof (GSource));
4523 g_source_set_priority (source, G_PRIORITY_DEFAULT_IDLE);
4530 * @priority: the priority of the idle source. Typically this will be in the
4531 * range between #G_PRIORITY_DEFAULT_IDLE and #G_PRIORITY_HIGH_IDLE.
4532 * @function: function to call
4533 * @data: data to pass to @function
4534 * @notify: function to call when the idle is removed, or %NULL
4536 * Adds a function to be called whenever there are no higher priority
4537 * events pending. If the function returns %FALSE it is automatically
4538 * removed from the list of event sources and will not be called again.
4540 * This internally creates a main loop source using g_idle_source_new()
4541 * and attaches it to the main loop context using g_source_attach().
4542 * You can do these steps manually if you need greater control.
4544 * Return value: the ID (greater than 0) of the event source.
4545 * Rename to: g_idle_add
4548 g_idle_add_full (gint priority,
4549 GSourceFunc function,
4551 GDestroyNotify notify)
4556 g_return_val_if_fail (function != NULL, 0);
4558 source = g_idle_source_new ();
4560 if (priority != G_PRIORITY_DEFAULT_IDLE)
4561 g_source_set_priority (source, priority);
4563 g_source_set_callback (source, function, data, notify);
4564 id = g_source_attach (source, NULL);
4565 g_source_unref (source);
4572 * @function: function to call
4573 * @data: data to pass to @function.
4575 * Adds a function to be called whenever there are no higher priority
4576 * events pending to the default main loop. The function is given the
4577 * default idle priority, #G_PRIORITY_DEFAULT_IDLE. If the function
4578 * returns %FALSE it is automatically removed from the list of event
4579 * sources and will not be called again.
4581 * This internally creates a main loop source using g_idle_source_new()
4582 * and attaches it to the main loop context using g_source_attach().
4583 * You can do these steps manually if you need greater control.
4585 * Return value: the ID (greater than 0) of the event source.
4588 g_idle_add (GSourceFunc function,
4591 return g_idle_add_full (G_PRIORITY_DEFAULT_IDLE, function, data, NULL);
4595 * g_idle_remove_by_data:
4596 * @data: the data for the idle source's callback.
4598 * Removes the idle function with the given data.
4600 * Return value: %TRUE if an idle source was found and removed.
4603 g_idle_remove_by_data (gpointer data)
4605 return g_source_remove_by_funcs_user_data (&g_idle_funcs, data);
4609 * g_main_context_invoke:
4610 * @context: (allow-none): a #GMainContext, or %NULL
4611 * @function: function to call
4612 * @data: data to pass to @function
4614 * Invokes a function in such a way that @context is owned during the
4615 * invocation of @function.
4617 * If @context is %NULL then the global default main context — as
4618 * returned by g_main_context_default() — is used.
4620 * If @context is owned by the current thread, @function is called
4621 * directly. Otherwise, if @context is the thread-default main context
4622 * of the current thread and g_main_context_acquire() succeeds, then
4623 * @function is called and g_main_context_release() is called
4626 * In any other case, an idle source is created to call @function and
4627 * that source is attached to @context (presumably to be run in another
4628 * thread). The idle source is attached with #G_PRIORITY_DEFAULT
4629 * priority. If you want a different priority, use
4630 * g_main_context_invoke_full().
4632 * Note that, as with normal idle functions, @function should probably
4633 * return %FALSE. If it returns %TRUE, it will be continuously run in a
4634 * loop (and may prevent this call from returning).
4639 g_main_context_invoke (GMainContext *context,
4640 GSourceFunc function,
4643 g_main_context_invoke_full (context,
4645 function, data, NULL);
4649 * g_main_context_invoke_full:
4650 * @context: (allow-none): a #GMainContext, or %NULL
4651 * @priority: the priority at which to run @function
4652 * @function: function to call
4653 * @data: data to pass to @function
4654 * @notify: a function to call when @data is no longer in use, or %NULL.
4656 * Invokes a function in such a way that @context is owned during the
4657 * invocation of @function.
4659 * This function is the same as g_main_context_invoke() except that it
4660 * lets you specify the priority incase @function ends up being
4661 * scheduled as an idle and also lets you give a #GDestroyNotify for @data.
4663 * @notify should not assume that it is called from any particular
4664 * thread or with any particular context acquired.
4669 g_main_context_invoke_full (GMainContext *context,
4671 GSourceFunc function,
4673 GDestroyNotify notify)
4675 g_return_if_fail (function != NULL);
4678 context = g_main_context_default ();
4680 if (g_main_context_is_owner (context))
4682 while (function (data));
4689 GMainContext *thread_default;
4691 thread_default = g_main_context_get_thread_default ();
4693 if (!thread_default)
4694 thread_default = g_main_context_default ();
4696 if (thread_default == context && g_main_context_acquire (context))
4698 while (function (data));
4700 g_main_context_release (context);
4709 source = g_idle_source_new ();
4710 g_source_set_priority (source, priority);
4711 g_source_set_callback (source, function, data, notify);
4712 g_source_attach (source, context);
4713 g_source_unref (source);
4719 glib_worker_main (gpointer data)
4723 g_main_context_iteration (glib_worker_context, TRUE);
4725 if (any_unix_signal_pending)
4726 dispatch_unix_signals ();
4729 return NULL; /* worst GCC warning message ever... */
4733 g_get_worker_context (void)
4735 static gsize initialised;
4737 g_thread_init_glib ();
4739 if (g_once_init_enter (&initialised))
4741 GError *error = NULL;
4743 glib_worker_context = g_main_context_new ();
4744 if (g_thread_create (glib_worker_main, NULL, FALSE, &error) == NULL)
4745 g_error ("Creating GLib worker thread failed: %s\n", error->message);
4747 g_once_init_leave (&initialised, TRUE);
4750 return glib_worker_context;