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"
54 #include <sys/eventfd.h>
59 #include <sys/types.h>
62 #ifdef HAVE_SYS_TIME_H
64 #endif /* HAVE_SYS_TIME_H */
67 #endif /* HAVE_UNISTD_H */
74 #endif /* G_OS_WIN32 */
77 #include <sys/socket.h>
79 #endif /* G_OS_BEOS */
84 #include "giochannel.h"
88 #include "gstrfuncs.h"
89 #include "gtestutils.h"
95 #ifdef G_MAIN_POLL_DEBUG
100 #include "gmain-internal.h"
101 #include "glib-init.h"
102 #include "glib-private.h"
106 * @title: The Main Event Loop
107 * @short_description: manages all available sources of events
109 * The main event loop manages all the available sources of events for
110 * GLib and GTK+ applications. These events can come from any number of
111 * different types of sources such as file descriptors (plain files,
112 * pipes or sockets) and timeouts. New types of event sources can also
113 * be added using g_source_attach().
115 * To allow multiple independent sets of sources to be handled in
116 * different threads, each source is associated with a #GMainContext.
117 * A GMainContext can only be running in a single thread, but
118 * sources can be added to it and removed from it from other threads.
120 * Each event source is assigned a priority. The default priority,
121 * #G_PRIORITY_DEFAULT, is 0. Values less than 0 denote higher priorities.
122 * Values greater than 0 denote lower priorities. Events from high priority
123 * sources are always processed before events from lower priority sources.
125 * Idle functions can also be added, and assigned a priority. These will
126 * be run whenever no events with a higher priority are ready to be processed.
128 * The #GMainLoop data type represents a main event loop. A GMainLoop is
129 * created with g_main_loop_new(). After adding the initial event sources,
130 * g_main_loop_run() is called. This continuously checks for new events from
131 * each of the event sources and dispatches them. Finally, the processing of
132 * an event from one of the sources leads to a call to g_main_loop_quit() to
133 * exit the main loop, and g_main_loop_run() returns.
135 * It is possible to create new instances of #GMainLoop recursively.
136 * This is often used in GTK+ applications when showing modal dialog
137 * boxes. Note that event sources are associated with a particular
138 * #GMainContext, and will be checked and dispatched for all main
139 * loops associated with that GMainContext.
141 * GTK+ contains wrappers of some of these functions, e.g. gtk_main(),
142 * gtk_main_quit() and gtk_events_pending().
144 * <refsect2><title>Creating new source types</title>
145 * <para>One of the unusual features of the #GMainLoop functionality
146 * is that new types of event source can be created and used in
147 * addition to the builtin type of event source. A new event source
148 * type is used for handling GDK events. A new source type is created
149 * by <firstterm>deriving</firstterm> from the #GSource structure.
150 * The derived type of source is represented by a structure that has
151 * the #GSource structure as a first element, and other elements specific
152 * to the new source type. To create an instance of the new source type,
153 * call g_source_new() passing in the size of the derived structure and
154 * a table of functions. These #GSourceFuncs determine the behavior of
155 * the new source type.</para>
156 * <para>New source types basically interact with the main context
157 * in two ways. Their prepare function in #GSourceFuncs can set a timeout
158 * to determine the maximum amount of time that the main loop will sleep
159 * before checking the source again. In addition, or as well, the source
160 * can add file descriptors to the set that the main context checks using
161 * g_source_add_poll().</para>
163 * <refsect2><title>Customizing the main loop iteration</title>
164 * <para>Single iterations of a #GMainContext can be run with
165 * g_main_context_iteration(). In some cases, more detailed control
166 * of exactly how the details of the main loop work is desired, for
167 * instance, when integrating the #GMainLoop with an external main loop.
168 * In such cases, you can call the component functions of
169 * g_main_context_iteration() directly. These functions are
170 * g_main_context_prepare(), g_main_context_query(),
171 * g_main_context_check() and g_main_context_dispatch().</para>
172 * <para>The operation of these functions can best be seen in terms
173 * of a state diagram, as shown in <xref linkend="mainloop-states"/>.</para>
174 * <figure id="mainloop-states"><title>States of a Main Context</title>
175 * <graphic fileref="mainloop-states.gif" format="GIF"></graphic>
179 * On Unix, the GLib mainloop is incompatible with fork(). Any program
180 * using the mainloop must either exec() or exit() from the child
181 * without returning to the mainloop.
186 typedef struct _GTimeoutSource GTimeoutSource;
187 typedef struct _GChildWatchSource GChildWatchSource;
188 typedef struct _GUnixSignalWatchSource GUnixSignalWatchSource;
189 typedef struct _GPollRec GPollRec;
190 typedef struct _GSourceCallback GSourceCallback;
194 G_SOURCE_READY = 1 << G_HOOK_FLAG_USER_SHIFT,
195 G_SOURCE_CAN_RECURSE = 1 << (G_HOOK_FLAG_USER_SHIFT + 1),
196 G_SOURCE_BLOCKED = 1 << (G_HOOK_FLAG_USER_SHIFT + 2)
199 typedef struct _GSourceList GSourceList;
203 GSource *head, *tail;
207 typedef struct _GMainWaiter GMainWaiter;
215 typedef struct _GMainDispatch GMainDispatch;
217 struct _GMainDispatch
220 GSList *dispatching_sources; /* stack of current sources */
223 #ifdef G_MAIN_POLL_DEBUG
224 gboolean _g_main_poll_debug = FALSE;
229 /* The following lock is used for both the list of sources
230 * and the list of poll records
240 GPtrArray *pending_dispatches;
241 gint timeout; /* Timeout for current iteration */
244 GHashTable *overflow_used_source_ids; /* set<guint> */
246 gint in_check_or_prepare;
248 GPollRec *poll_records, *poll_records_tail;
249 guint n_poll_records;
250 GPollFD *cached_poll_array;
251 guint cached_poll_array_size;
257 /* Flag indicating whether the set of fd's changed during a poll */
258 gboolean poll_changed;
263 gboolean time_is_fresh;
266 struct _GSourceCallback
271 GDestroyNotify notify;
276 GMainContext *context;
281 struct _GTimeoutSource
288 struct _GChildWatchSource
295 #else /* G_OS_WIN32 */
296 gboolean child_exited;
297 #endif /* G_OS_WIN32 */
300 struct _GUnixSignalWatchSource
315 struct _GSourcePrivate
317 GSList *child_sources;
318 GSource *parent_source;
322 /* This is currently only used on UNIX, but we always declare it (and
323 * let it remain empty on Windows) to avoid #ifdef all over the place.
328 typedef struct _GSourceIter
330 GMainContext *context;
336 #define LOCK_CONTEXT(context) g_mutex_lock (&context->mutex)
337 #define UNLOCK_CONTEXT(context) g_mutex_unlock (&context->mutex)
338 #define G_THREAD_SELF g_thread_self ()
340 #define SOURCE_DESTROYED(source) (((source)->flags & G_HOOK_FLAG_ACTIVE) == 0)
341 #define SOURCE_BLOCKED(source) (((source)->flags & G_SOURCE_BLOCKED) != 0)
343 #define SOURCE_UNREF(source, context) \
345 if ((source)->ref_count > 1) \
346 (source)->ref_count--; \
348 g_source_unref_internal ((source), (context), TRUE); \
352 /* Forward declarations */
354 static void g_source_unref_internal (GSource *source,
355 GMainContext *context,
357 static void g_source_destroy_internal (GSource *source,
358 GMainContext *context,
360 static void g_source_set_priority_unlocked (GSource *source,
361 GMainContext *context,
363 static void g_child_source_remove_internal (GSource *child_source,
364 GMainContext *context);
366 static void g_main_context_poll (GMainContext *context,
371 static void g_main_context_add_poll_unlocked (GMainContext *context,
374 static void g_main_context_remove_poll_unlocked (GMainContext *context,
377 static void g_source_iter_init (GSourceIter *iter,
378 GMainContext *context,
379 gboolean may_modify);
380 static gboolean g_source_iter_next (GSourceIter *iter,
382 static void g_source_iter_clear (GSourceIter *iter);
384 static gboolean g_timeout_dispatch (GSource *source,
385 GSourceFunc callback,
387 static gboolean g_child_watch_prepare (GSource *source,
389 static gboolean g_child_watch_check (GSource *source);
390 static gboolean g_child_watch_dispatch (GSource *source,
391 GSourceFunc callback,
393 static void g_child_watch_finalize (GSource *source);
395 static void g_unix_signal_handler (int signum);
396 static gboolean g_unix_signal_watch_prepare (GSource *source,
398 static gboolean g_unix_signal_watch_check (GSource *source);
399 static gboolean g_unix_signal_watch_dispatch (GSource *source,
400 GSourceFunc callback,
402 static void g_unix_signal_watch_finalize (GSource *source);
404 static gboolean g_idle_prepare (GSource *source,
406 static gboolean g_idle_check (GSource *source);
407 static gboolean g_idle_dispatch (GSource *source,
408 GSourceFunc callback,
411 static void block_source (GSource *source);
413 static GMainContext *glib_worker_context;
415 G_LOCK_DEFINE_STATIC (main_loop);
416 static GMainContext *default_main_context;
421 /* UNIX signals work by marking one of these variables then waking the
422 * worker context to check on them and dispatch accordingly.
424 #ifdef HAVE_SIG_ATOMIC_T
425 static volatile sig_atomic_t unix_signal_pending[NSIG];
426 static volatile sig_atomic_t any_unix_signal_pending;
428 static volatile int unix_signal_pending[NSIG];
429 static volatile int any_unix_signal_pending;
432 /* Guards all the data below */
433 G_LOCK_DEFINE_STATIC (unix_signal_lock);
434 static GSList *unix_signal_watches;
435 static GSList *unix_child_watches;
437 static GSourceFuncs g_unix_signal_funcs =
439 g_unix_signal_watch_prepare,
440 g_unix_signal_watch_check,
441 g_unix_signal_watch_dispatch,
442 g_unix_signal_watch_finalize
444 #endif /* !G_OS_WIN32 */
445 G_LOCK_DEFINE_STATIC (main_context_list);
446 static GSList *main_context_list = NULL;
448 GSourceFuncs g_timeout_funcs =
456 GSourceFuncs g_child_watch_funcs =
458 g_child_watch_prepare,
460 g_child_watch_dispatch,
461 g_child_watch_finalize
464 GSourceFuncs g_idle_funcs =
473 * g_main_context_ref:
474 * @context: a #GMainContext
476 * Increases the reference count on a #GMainContext object by one.
478 * Returns: the @context that was passed in (since 2.6)
481 g_main_context_ref (GMainContext *context)
483 g_return_val_if_fail (context != NULL, NULL);
484 g_return_val_if_fail (g_atomic_int_get (&context->ref_count) > 0, NULL);
486 g_atomic_int_inc (&context->ref_count);
492 poll_rec_list_free (GMainContext *context,
495 g_slice_free_chain (GPollRec, list, next);
499 * g_main_context_unref:
500 * @context: a #GMainContext
502 * Decreases the reference count on a #GMainContext object by one. If
503 * the result is zero, free the context and free all associated memory.
506 g_main_context_unref (GMainContext *context)
513 g_return_if_fail (context != NULL);
514 g_return_if_fail (g_atomic_int_get (&context->ref_count) > 0);
516 if (!g_atomic_int_dec_and_test (&context->ref_count))
519 G_LOCK (main_context_list);
520 main_context_list = g_slist_remove (main_context_list, context);
521 G_UNLOCK (main_context_list);
523 g_source_iter_init (&iter, context, TRUE);
524 while (g_source_iter_next (&iter, &source))
526 source->context = NULL;
527 g_source_destroy_internal (source, context, FALSE);
529 for (sl_iter = context->source_lists; sl_iter; sl_iter = sl_iter->next)
531 list = sl_iter->data;
532 g_slice_free (GSourceList, list);
534 g_list_free (context->source_lists);
536 if (context->overflow_used_source_ids)
537 g_hash_table_destroy (context->overflow_used_source_ids);
539 g_mutex_clear (&context->mutex);
541 g_ptr_array_free (context->pending_dispatches, TRUE);
542 g_free (context->cached_poll_array);
544 poll_rec_list_free (context, context->poll_records);
546 g_wakeup_free (context->wakeup);
547 g_cond_clear (&context->cond);
552 /* Helper function used by mainloop/overflow test.
555 g_main_context_new_with_next_id (guint next_id)
557 GMainContext *ret = g_main_context_new ();
559 ret->next_id = next_id;
565 * g_main_context_new:
567 * Creates a new #GMainContext structure.
569 * Return value: the new #GMainContext
572 g_main_context_new (void)
574 static gsize initialised;
575 GMainContext *context;
577 if (g_once_init_enter (&initialised))
579 #ifdef G_MAIN_POLL_DEBUG
580 if (getenv ("G_MAIN_POLL_DEBUG") != NULL)
581 _g_main_poll_debug = TRUE;
584 g_once_init_leave (&initialised, TRUE);
587 context = g_new0 (GMainContext, 1);
589 g_mutex_init (&context->mutex);
590 g_cond_init (&context->cond);
592 context->owner = NULL;
593 context->waiters = NULL;
595 context->ref_count = 1;
597 context->next_id = 1;
599 context->source_lists = NULL;
601 context->poll_func = g_poll;
603 context->cached_poll_array = NULL;
604 context->cached_poll_array_size = 0;
606 context->pending_dispatches = g_ptr_array_new ();
608 context->time_is_fresh = FALSE;
610 context->wakeup = g_wakeup_new ();
611 g_wakeup_get_pollfd (context->wakeup, &context->wake_up_rec);
612 g_main_context_add_poll_unlocked (context, 0, &context->wake_up_rec);
614 G_LOCK (main_context_list);
615 main_context_list = g_slist_append (main_context_list, context);
617 #ifdef G_MAIN_POLL_DEBUG
618 if (_g_main_poll_debug)
619 g_print ("created context=%p\n", context);
622 G_UNLOCK (main_context_list);
628 * g_main_context_default:
630 * Returns the global default main context. This is the main context
631 * used for main loop functions when a main loop is not explicitly
632 * specified, and corresponds to the "main" main loop. See also
633 * g_main_context_get_thread_default().
635 * Return value: (transfer none): the global default main context.
638 g_main_context_default (void)
644 if (!default_main_context)
646 default_main_context = g_main_context_new ();
647 #ifdef G_MAIN_POLL_DEBUG
648 if (_g_main_poll_debug)
649 g_print ("default context=%p\n", default_main_context);
653 G_UNLOCK (main_loop);
655 return default_main_context;
659 free_context (gpointer data)
661 GMainContext *context = data;
663 g_main_context_release (context);
665 g_main_context_unref (context);
669 free_context_stack (gpointer data)
671 g_queue_free_full((GQueue *) data, (GDestroyNotify) free_context);
674 static GPrivate thread_context_stack = G_PRIVATE_INIT (free_context_stack);
677 * g_main_context_push_thread_default:
678 * @context: (allow-none): a #GMainContext, or %NULL for the global default context
680 * Acquires @context and sets it as the thread-default context for the
681 * current thread. This will cause certain asynchronous operations
682 * (such as most <link linkend="gio">gio</link>-based I/O) which are
683 * started in this thread to run under @context and deliver their
684 * results to its main loop, rather than running under the global
685 * default context in the main thread. Note that calling this function
686 * changes the context returned by
687 * g_main_context_get_thread_default(), <emphasis>not</emphasis> the
688 * one returned by g_main_context_default(), so it does not affect the
689 * context used by functions like g_idle_add().
691 * Normally you would call this function shortly after creating a new
692 * thread, passing it a #GMainContext which will be run by a
693 * #GMainLoop in that thread, to set a new default context for all
694 * async operations in that thread. (In this case, you don't need to
695 * ever call g_main_context_pop_thread_default().) In some cases
696 * however, you may want to schedule a single operation in a
697 * non-default context, or temporarily use a non-default context in
698 * the main thread. In that case, you can wrap the call to the
699 * asynchronous operation inside a
700 * g_main_context_push_thread_default() /
701 * g_main_context_pop_thread_default() pair, but it is up to you to
702 * ensure that no other asynchronous operations accidentally get
703 * started while the non-default context is active.
705 * Beware that libraries that predate this function may not correctly
706 * handle being used from a thread with a thread-default context. Eg,
707 * see g_file_supports_thread_contexts().
712 g_main_context_push_thread_default (GMainContext *context)
715 gboolean acquired_context;
717 acquired_context = g_main_context_acquire (context);
718 g_return_if_fail (acquired_context);
720 if (context == g_main_context_default ())
723 g_main_context_ref (context);
725 stack = g_private_get (&thread_context_stack);
728 stack = g_queue_new ();
729 g_private_set (&thread_context_stack, stack);
732 g_queue_push_head (stack, context);
736 * g_main_context_pop_thread_default:
737 * @context: (allow-none): a #GMainContext object, or %NULL
739 * Pops @context off the thread-default context stack (verifying that
740 * it was on the top of the stack).
745 g_main_context_pop_thread_default (GMainContext *context)
749 if (context == g_main_context_default ())
752 stack = g_private_get (&thread_context_stack);
754 g_return_if_fail (stack != NULL);
755 g_return_if_fail (g_queue_peek_head (stack) == context);
757 g_queue_pop_head (stack);
759 g_main_context_release (context);
761 g_main_context_unref (context);
765 * g_main_context_get_thread_default:
767 * Gets the thread-default #GMainContext for this thread. Asynchronous
768 * operations that want to be able to be run in contexts other than
769 * the default one should call this method or
770 * g_main_context_ref_thread_default() to get a #GMainContext to add
771 * their #GSource<!-- -->s to. (Note that even in single-threaded
772 * programs applications may sometimes want to temporarily push a
773 * non-default context, so it is not safe to assume that this will
774 * always return %NULL if you are running in the default thread.)
776 * If you need to hold a reference on the context, use
777 * g_main_context_ref_thread_default() instead.
779 * Returns: (transfer none): the thread-default #GMainContext, or
780 * %NULL if the thread-default context is the global default context.
785 g_main_context_get_thread_default (void)
789 stack = g_private_get (&thread_context_stack);
791 return g_queue_peek_head (stack);
797 * g_main_context_ref_thread_default:
799 * Gets the thread-default #GMainContext for this thread, as with
800 * g_main_context_get_thread_default(), but also adds a reference to
801 * it with g_main_context_ref(). In addition, unlike
802 * g_main_context_get_thread_default(), if the thread-default context
803 * is the global default context, this will return that #GMainContext
804 * (with a ref added to it) rather than returning %NULL.
806 * Returns: (transfer full): the thread-default #GMainContext. Unref
807 * with g_main_context_unref() when you are done with it.
812 g_main_context_ref_thread_default (void)
814 GMainContext *context;
816 context = g_main_context_get_thread_default ();
818 context = g_main_context_default ();
819 return g_main_context_ref (context);
822 /* Hooks for adding to the main loop */
826 * @source_funcs: structure containing functions that implement
827 * the sources behavior.
828 * @struct_size: size of the #GSource structure to create.
830 * Creates a new #GSource structure. The size is specified to
831 * allow creating structures derived from #GSource that contain
832 * additional data. The size passed in must be at least
833 * <literal>sizeof (GSource)</literal>.
835 * The source will not initially be associated with any #GMainContext
836 * and must be added to one with g_source_attach() before it will be
839 * Return value: the newly-created #GSource.
842 g_source_new (GSourceFuncs *source_funcs,
847 g_return_val_if_fail (source_funcs != NULL, NULL);
848 g_return_val_if_fail (struct_size >= sizeof (GSource), NULL);
850 source = (GSource*) g_malloc0 (struct_size);
851 source->priv = g_slice_new0 (GSourcePrivate);
852 source->source_funcs = source_funcs;
853 source->ref_count = 1;
855 source->priority = G_PRIORITY_DEFAULT;
857 source->flags = G_HOOK_FLAG_ACTIVE;
859 source->priv->ready_time = -1;
861 /* NULL/0 initialization for all other fields */
866 /* Holds context's lock */
868 g_source_iter_init (GSourceIter *iter,
869 GMainContext *context,
872 iter->context = context;
873 iter->current_list = NULL;
875 iter->may_modify = may_modify;
878 /* Holds context's lock */
880 g_source_iter_next (GSourceIter *iter, GSource **source)
882 GSource *next_source;
885 next_source = iter->source->next;
891 if (iter->current_list)
892 iter->current_list = iter->current_list->next;
894 iter->current_list = iter->context->source_lists;
896 if (iter->current_list)
898 GSourceList *source_list = iter->current_list->data;
900 next_source = source_list->head;
904 /* Note: unreffing iter->source could potentially cause its
905 * GSourceList to be removed from source_lists (if iter->source is
906 * the only source in its list, and it is destroyed), so we have to
907 * keep it reffed until after we advance iter->current_list, above.
910 if (iter->source && iter->may_modify)
911 SOURCE_UNREF (iter->source, iter->context);
912 iter->source = next_source;
913 if (iter->source && iter->may_modify)
914 iter->source->ref_count++;
916 *source = iter->source;
917 return *source != NULL;
920 /* Holds context's lock. Only necessary to call if you broke out of
921 * the g_source_iter_next() loop early.
924 g_source_iter_clear (GSourceIter *iter)
926 if (iter->source && iter->may_modify)
928 SOURCE_UNREF (iter->source, iter->context);
933 /* Holds context's lock
936 find_source_list_for_priority (GMainContext *context,
941 GSourceList *source_list;
944 for (iter = context->source_lists; iter != NULL; last = iter, iter = iter->next)
946 source_list = iter->data;
948 if (source_list->priority == priority)
951 if (source_list->priority > priority)
956 source_list = g_slice_new0 (GSourceList);
957 source_list->priority = priority;
958 context->source_lists = g_list_insert_before (context->source_lists,
968 source_list = g_slice_new0 (GSourceList);
969 source_list->priority = priority;
972 context->source_lists = g_list_append (NULL, source_list);
975 /* This just appends source_list to the end of
976 * context->source_lists without having to walk the list again.
978 last = g_list_append (last, source_list);
983 /* Holds context's lock
986 source_add_to_context (GSource *source,
987 GMainContext *context)
989 GSourceList *source_list;
990 GSource *prev, *next;
992 source_list = find_source_list_for_priority (context, source->priority, TRUE);
994 if (source->priv->parent_source)
996 g_assert (source_list->head != NULL);
998 /* Put the source immediately before its parent */
999 prev = source->priv->parent_source->prev;
1000 next = source->priv->parent_source;
1004 prev = source_list->tail;
1008 source->next = next;
1010 next->prev = source;
1012 source_list->tail = source;
1014 source->prev = prev;
1016 prev->next = source;
1018 source_list->head = source;
1021 /* Holds context's lock
1024 source_remove_from_context (GSource *source,
1025 GMainContext *context)
1027 GSourceList *source_list;
1029 source_list = find_source_list_for_priority (context, source->priority, FALSE);
1030 g_return_if_fail (source_list != NULL);
1033 source->prev->next = source->next;
1035 source_list->head = source->next;
1038 source->next->prev = source->prev;
1040 source_list->tail = source->prev;
1042 source->prev = NULL;
1043 source->next = NULL;
1045 if (source_list->head == NULL)
1047 context->source_lists = g_list_remove (context->source_lists, source_list);
1048 g_slice_free (GSourceList, source_list);
1051 if (context->overflow_used_source_ids)
1052 g_hash_table_remove (context->overflow_used_source_ids,
1053 GUINT_TO_POINTER (source->source_id));
1058 assign_source_id_unlocked (GMainContext *context,
1063 /* Are we about to overflow back to 0?
1064 * See https://bugzilla.gnome.org/show_bug.cgi?id=687098
1066 if (G_UNLIKELY (context->next_id == G_MAXUINT &&
1067 context->overflow_used_source_ids == NULL))
1072 context->overflow_used_source_ids = g_hash_table_new (NULL, NULL);
1074 g_source_iter_init (&iter, context, FALSE);
1075 while (g_source_iter_next (&iter, &source))
1077 g_hash_table_add (context->overflow_used_source_ids,
1078 GUINT_TO_POINTER (source->source_id));
1082 else if (context->overflow_used_source_ids == NULL)
1084 id = context->next_id++;
1089 * If we overran G_MAXUINT, we fall back to randomly probing the
1090 * source ids for the current context. This will be slower the more
1091 * sources there are, but we're mainly concerned right now about
1092 * correctness and code size. There's time for a more clever solution
1096 id = g_random_int ();
1098 g_hash_table_contains (context->overflow_used_source_ids,
1099 GUINT_TO_POINTER (id)));
1100 g_hash_table_add (context->overflow_used_source_ids, GUINT_TO_POINTER (id));
1103 source->source_id = id;
1107 g_source_attach_unlocked (GSource *source,
1108 GMainContext *context)
1112 source->context = context;
1113 assign_source_id_unlocked (context, source);
1114 source->ref_count++;
1115 source_add_to_context (source, context);
1117 tmp_list = source->poll_fds;
1120 g_main_context_add_poll_unlocked (context, source->priority, tmp_list->data);
1121 tmp_list = tmp_list->next;
1124 for (tmp_list = source->priv->fds; tmp_list; tmp_list = tmp_list->next)
1125 g_main_context_add_poll_unlocked (context, source->priority, tmp_list->data);
1127 tmp_list = source->priv->child_sources;
1130 g_source_attach_unlocked (tmp_list->data, context);
1131 tmp_list = tmp_list->next;
1134 return source->source_id;
1139 * @source: a #GSource
1140 * @context: (allow-none): a #GMainContext (if %NULL, the default context will be used)
1142 * Adds a #GSource to a @context so that it will be executed within
1143 * that context. Remove it by calling g_source_destroy().
1145 * Return value: the ID (greater than 0) for the source within the
1149 g_source_attach (GSource *source,
1150 GMainContext *context)
1154 g_return_val_if_fail (source->context == NULL, 0);
1155 g_return_val_if_fail (!SOURCE_DESTROYED (source), 0);
1158 context = g_main_context_default ();
1160 LOCK_CONTEXT (context);
1162 result = g_source_attach_unlocked (source, context);
1164 /* If another thread has acquired the context, wake it up since it
1165 * might be in poll() right now.
1167 if (context->owner && context->owner != G_THREAD_SELF)
1168 g_wakeup_signal (context->wakeup);
1170 UNLOCK_CONTEXT (context);
1176 g_source_destroy_internal (GSource *source,
1177 GMainContext *context,
1181 LOCK_CONTEXT (context);
1183 if (!SOURCE_DESTROYED (source))
1186 gpointer old_cb_data;
1187 GSourceCallbackFuncs *old_cb_funcs;
1189 source->flags &= ~G_HOOK_FLAG_ACTIVE;
1191 old_cb_data = source->callback_data;
1192 old_cb_funcs = source->callback_funcs;
1194 source->callback_data = NULL;
1195 source->callback_funcs = NULL;
1199 UNLOCK_CONTEXT (context);
1200 old_cb_funcs->unref (old_cb_data);
1201 LOCK_CONTEXT (context);
1204 if (!SOURCE_BLOCKED (source))
1206 tmp_list = source->poll_fds;
1209 g_main_context_remove_poll_unlocked (context, tmp_list->data);
1210 tmp_list = tmp_list->next;
1213 for (tmp_list = source->priv->fds; tmp_list; tmp_list = tmp_list->next)
1214 g_main_context_remove_poll_unlocked (context, tmp_list->data);
1217 while (source->priv->child_sources)
1218 g_child_source_remove_internal (source->priv->child_sources->data, context);
1220 if (source->priv->parent_source)
1221 g_child_source_remove_internal (source, context);
1223 g_source_unref_internal (source, context, TRUE);
1227 UNLOCK_CONTEXT (context);
1232 * @source: a #GSource
1234 * Removes a source from its #GMainContext, if any, and mark it as
1235 * destroyed. The source cannot be subsequently added to another
1239 g_source_destroy (GSource *source)
1241 GMainContext *context;
1243 g_return_if_fail (source != NULL);
1245 context = source->context;
1248 g_source_destroy_internal (source, context, FALSE);
1250 source->flags &= ~G_HOOK_FLAG_ACTIVE;
1255 * @source: a #GSource
1257 * Returns the numeric ID for a particular source. The ID of a source
1258 * is a positive integer which is unique within a particular main loop
1259 * context. The reverse
1260 * mapping from ID to source is done by g_main_context_find_source_by_id().
1262 * Return value: the ID (greater than 0) for the source
1265 g_source_get_id (GSource *source)
1269 g_return_val_if_fail (source != NULL, 0);
1270 g_return_val_if_fail (source->context != NULL, 0);
1272 LOCK_CONTEXT (source->context);
1273 result = source->source_id;
1274 UNLOCK_CONTEXT (source->context);
1280 * g_source_get_context:
1281 * @source: a #GSource
1283 * Gets the #GMainContext with which the source is associated.
1285 * You can call this on a source that has been destroyed, provided
1286 * that the #GMainContext it was attached to still exists (in which
1287 * case it will return that #GMainContext). In particular, you can
1288 * always call this function on the source returned from
1289 * g_main_current_source(). But calling this function on a source
1290 * whose #GMainContext has been destroyed is an error.
1292 * Return value: (transfer none) (allow-none): the #GMainContext with which the
1293 * source is associated, or %NULL if the context has not
1294 * yet been added to a source.
1297 g_source_get_context (GSource *source)
1299 g_return_val_if_fail (source->context != NULL || !SOURCE_DESTROYED (source), NULL);
1301 return source->context;
1305 * g_source_add_poll:
1306 * @source:a #GSource
1307 * @fd: a #GPollFD structure holding information about a file
1308 * descriptor to watch.
1310 * Adds a file descriptor to the set of file descriptors polled for
1311 * this source. This is usually combined with g_source_new() to add an
1312 * event source. The event source's check function will typically test
1313 * the @revents field in the #GPollFD struct and return %TRUE if events need
1316 * Using this API forces the linear scanning of event sources on each
1317 * main loop iteration. Newly-written event sources should try to use
1318 * g_source_add_unix_fd() instead of this API.
1321 g_source_add_poll (GSource *source,
1324 GMainContext *context;
1326 g_return_if_fail (source != NULL);
1327 g_return_if_fail (fd != NULL);
1328 g_return_if_fail (!SOURCE_DESTROYED (source));
1330 context = source->context;
1333 LOCK_CONTEXT (context);
1335 source->poll_fds = g_slist_prepend (source->poll_fds, fd);
1339 if (!SOURCE_BLOCKED (source))
1340 g_main_context_add_poll_unlocked (context, source->priority, fd);
1341 UNLOCK_CONTEXT (context);
1346 * g_source_remove_poll:
1347 * @source:a #GSource
1348 * @fd: a #GPollFD structure previously passed to g_source_add_poll().
1350 * Removes a file descriptor from the set of file descriptors polled for
1354 g_source_remove_poll (GSource *source,
1357 GMainContext *context;
1359 g_return_if_fail (source != NULL);
1360 g_return_if_fail (fd != NULL);
1361 g_return_if_fail (!SOURCE_DESTROYED (source));
1363 context = source->context;
1366 LOCK_CONTEXT (context);
1368 source->poll_fds = g_slist_remove (source->poll_fds, fd);
1372 if (!SOURCE_BLOCKED (source))
1373 g_main_context_remove_poll_unlocked (context, fd);
1374 UNLOCK_CONTEXT (context);
1379 * g_source_add_child_source:
1380 * @source:a #GSource
1381 * @child_source: a second #GSource that @source should "poll"
1383 * Adds @child_source to @source as a "polled" source; when @source is
1384 * added to a #GMainContext, @child_source will be automatically added
1385 * with the same priority, when @child_source is triggered, it will
1386 * cause @source to dispatch (in addition to calling its own
1387 * callback), and when @source is destroyed, it will destroy
1388 * @child_source as well. (@source will also still be dispatched if
1389 * its own prepare/check functions indicate that it is ready.)
1391 * If you don't need @child_source to do anything on its own when it
1392 * triggers, you can call g_source_set_dummy_callback() on it to set a
1393 * callback that does nothing (except return %TRUE if appropriate).
1395 * @source will hold a reference on @child_source while @child_source
1396 * is attached to it.
1401 g_source_add_child_source (GSource *source,
1402 GSource *child_source)
1404 GMainContext *context;
1406 g_return_if_fail (source != NULL);
1407 g_return_if_fail (child_source != NULL);
1408 g_return_if_fail (!SOURCE_DESTROYED (source));
1409 g_return_if_fail (!SOURCE_DESTROYED (child_source));
1410 g_return_if_fail (child_source->context == NULL);
1411 g_return_if_fail (child_source->priv->parent_source == NULL);
1413 context = source->context;
1416 LOCK_CONTEXT (context);
1418 source->priv->child_sources = g_slist_prepend (source->priv->child_sources,
1419 g_source_ref (child_source));
1420 child_source->priv->parent_source = source;
1421 g_source_set_priority_unlocked (child_source, NULL, source->priority);
1422 if (SOURCE_BLOCKED (source))
1423 block_source (child_source);
1427 UNLOCK_CONTEXT (context);
1428 g_source_attach (child_source, context);
1433 g_child_source_remove_internal (GSource *child_source,
1434 GMainContext *context)
1436 GSource *parent_source = child_source->priv->parent_source;
1438 parent_source->priv->child_sources =
1439 g_slist_remove (parent_source->priv->child_sources, child_source);
1440 child_source->priv->parent_source = NULL;
1442 g_source_destroy_internal (child_source, context, TRUE);
1443 g_source_unref_internal (child_source, context, TRUE);
1447 * g_source_remove_child_source:
1448 * @source:a #GSource
1449 * @child_source: a #GSource previously passed to
1450 * g_source_add_child_source().
1452 * Detaches @child_source from @source and destroys it.
1457 g_source_remove_child_source (GSource *source,
1458 GSource *child_source)
1460 GMainContext *context;
1462 g_return_if_fail (source != NULL);
1463 g_return_if_fail (child_source != NULL);
1464 g_return_if_fail (child_source->priv->parent_source == source);
1465 g_return_if_fail (!SOURCE_DESTROYED (source));
1466 g_return_if_fail (!SOURCE_DESTROYED (child_source));
1468 context = source->context;
1471 LOCK_CONTEXT (context);
1473 g_child_source_remove_internal (child_source, context);
1476 UNLOCK_CONTEXT (context);
1480 * g_source_set_callback_indirect:
1481 * @source: the source
1482 * @callback_data: pointer to callback data "object"
1483 * @callback_funcs: functions for reference counting @callback_data
1484 * and getting the callback and data
1486 * Sets the callback function storing the data as a refcounted callback
1487 * "object". This is used internally. Note that calling
1488 * g_source_set_callback_indirect() assumes
1489 * an initial reference count on @callback_data, and thus
1490 * @callback_funcs->unref will eventually be called once more
1491 * than @callback_funcs->ref.
1494 g_source_set_callback_indirect (GSource *source,
1495 gpointer callback_data,
1496 GSourceCallbackFuncs *callback_funcs)
1498 GMainContext *context;
1499 gpointer old_cb_data;
1500 GSourceCallbackFuncs *old_cb_funcs;
1502 g_return_if_fail (source != NULL);
1503 g_return_if_fail (callback_funcs != NULL || callback_data == NULL);
1505 context = source->context;
1508 LOCK_CONTEXT (context);
1510 old_cb_data = source->callback_data;
1511 old_cb_funcs = source->callback_funcs;
1513 source->callback_data = callback_data;
1514 source->callback_funcs = callback_funcs;
1517 UNLOCK_CONTEXT (context);
1520 old_cb_funcs->unref (old_cb_data);
1524 g_source_callback_ref (gpointer cb_data)
1526 GSourceCallback *callback = cb_data;
1528 callback->ref_count++;
1533 g_source_callback_unref (gpointer cb_data)
1535 GSourceCallback *callback = cb_data;
1537 callback->ref_count--;
1538 if (callback->ref_count == 0)
1540 if (callback->notify)
1541 callback->notify (callback->data);
1547 g_source_callback_get (gpointer cb_data,
1552 GSourceCallback *callback = cb_data;
1554 *func = callback->func;
1555 *data = callback->data;
1558 static GSourceCallbackFuncs g_source_callback_funcs = {
1559 g_source_callback_ref,
1560 g_source_callback_unref,
1561 g_source_callback_get,
1565 * g_source_set_callback:
1566 * @source: the source
1567 * @func: a callback function
1568 * @data: the data to pass to callback function
1569 * @notify: (allow-none): a function to call when @data is no longer in use, or %NULL.
1571 * Sets the callback function for a source. The callback for a source is
1572 * called from the source's dispatch function.
1574 * The exact type of @func depends on the type of source; ie. you
1575 * should not count on @func being called with @data as its first
1578 * Typically, you won't use this function. Instead use functions specific
1579 * to the type of source you are using.
1582 g_source_set_callback (GSource *source,
1585 GDestroyNotify notify)
1587 GSourceCallback *new_callback;
1589 g_return_if_fail (source != NULL);
1591 new_callback = g_new (GSourceCallback, 1);
1593 new_callback->ref_count = 1;
1594 new_callback->func = func;
1595 new_callback->data = data;
1596 new_callback->notify = notify;
1598 g_source_set_callback_indirect (source, new_callback, &g_source_callback_funcs);
1603 * g_source_set_funcs:
1604 * @source: a #GSource
1605 * @funcs: the new #GSourceFuncs
1607 * Sets the source functions (can be used to override
1608 * default implementations) of an unattached source.
1613 g_source_set_funcs (GSource *source,
1614 GSourceFuncs *funcs)
1616 g_return_if_fail (source != NULL);
1617 g_return_if_fail (source->context == NULL);
1618 g_return_if_fail (source->ref_count > 0);
1619 g_return_if_fail (funcs != NULL);
1621 source->source_funcs = funcs;
1625 g_source_set_priority_unlocked (GSource *source,
1626 GMainContext *context,
1631 g_return_if_fail (source->priv->parent_source == NULL ||
1632 source->priv->parent_source->priority == priority);
1636 /* Remove the source from the context's source and then
1637 * add it back after so it is sorted in the correct place
1639 source_remove_from_context (source, source->context);
1642 source->priority = priority;
1646 source_add_to_context (source, source->context);
1648 if (!SOURCE_BLOCKED (source))
1650 tmp_list = source->poll_fds;
1653 g_main_context_remove_poll_unlocked (context, tmp_list->data);
1654 g_main_context_add_poll_unlocked (context, priority, tmp_list->data);
1656 tmp_list = tmp_list->next;
1659 for (tmp_list = source->priv->fds; tmp_list; tmp_list = tmp_list->next)
1661 g_main_context_remove_poll_unlocked (context, tmp_list->data);
1662 g_main_context_add_poll_unlocked (context, priority, tmp_list->data);
1667 if (source->priv->child_sources)
1669 tmp_list = source->priv->child_sources;
1672 g_source_set_priority_unlocked (tmp_list->data, context, priority);
1673 tmp_list = tmp_list->next;
1679 * g_source_set_priority:
1680 * @source: a #GSource
1681 * @priority: the new priority.
1683 * Sets the priority of a source. While the main loop is being run, a
1684 * source will be dispatched if it is ready to be dispatched and no
1685 * sources at a higher (numerically smaller) priority are ready to be
1689 g_source_set_priority (GSource *source,
1692 GMainContext *context;
1694 g_return_if_fail (source != NULL);
1696 context = source->context;
1699 LOCK_CONTEXT (context);
1700 g_source_set_priority_unlocked (source, context, priority);
1702 UNLOCK_CONTEXT (source->context);
1706 * g_source_get_priority:
1707 * @source: a #GSource
1709 * Gets the priority of a source.
1711 * Return value: the priority of the source
1714 g_source_get_priority (GSource *source)
1716 g_return_val_if_fail (source != NULL, 0);
1718 return source->priority;
1722 * g_source_set_ready_time:
1723 * @source: a #GSource
1724 * @ready_time: the monotonic time at which the source will be ready,
1725 * 0 for "immediately", -1 for "never"
1727 * Sets a #GSource to be dispatched when the given monotonic time is
1728 * reached (or passed). If the monotonic time is in the past (as it
1729 * always will be if @ready_time is 0) then the source will be
1730 * dispatched immediately.
1732 * If @ready_time is -1 then the source is never woken up on the basis
1733 * of the passage of time.
1735 * Dispatching the source does not reset the ready time. You should do
1736 * so yourself, from the source dispatch function.
1738 * Note that if you have a pair of sources where the ready time of one
1739 * suggests that it will be delivered first but the priority for the
1740 * other suggests that it would be delivered first, and the ready time
1741 * for both sources is reached during the same main context iteration
1742 * then the order of dispatch is undefined.
1747 g_source_set_ready_time (GSource *source,
1750 GMainContext *context;
1752 g_return_if_fail (source != NULL);
1753 g_return_if_fail (source->ref_count > 0);
1755 if (source->priv->ready_time == ready_time)
1758 context = source->context;
1761 LOCK_CONTEXT (context);
1763 source->priv->ready_time = ready_time;
1767 /* Quite likely that we need to change the timeout on the poll */
1768 if (!SOURCE_BLOCKED (source))
1769 g_wakeup_signal (context->wakeup);
1770 UNLOCK_CONTEXT (context);
1775 * g_source_get_ready_time:
1776 * @source: a #GSource
1778 * Gets the "ready time" of @source, as set by
1779 * g_source_set_ready_time().
1781 * Any time before the current monotonic time (including 0) is an
1782 * indication that the source will fire immediately.
1784 * Returns: the monotonic ready time, -1 for "never"
1787 g_source_get_ready_time (GSource *source)
1789 g_return_val_if_fail (source != NULL, -1);
1791 return source->priv->ready_time;
1795 * g_source_set_can_recurse:
1796 * @source: a #GSource
1797 * @can_recurse: whether recursion is allowed for this source
1799 * Sets whether a source can be called recursively. If @can_recurse is
1800 * %TRUE, then while the source is being dispatched then this source
1801 * will be processed normally. Otherwise, all processing of this
1802 * source is blocked until the dispatch function returns.
1805 g_source_set_can_recurse (GSource *source,
1806 gboolean can_recurse)
1808 GMainContext *context;
1810 g_return_if_fail (source != NULL);
1812 context = source->context;
1815 LOCK_CONTEXT (context);
1818 source->flags |= G_SOURCE_CAN_RECURSE;
1820 source->flags &= ~G_SOURCE_CAN_RECURSE;
1823 UNLOCK_CONTEXT (context);
1827 * g_source_get_can_recurse:
1828 * @source: a #GSource
1830 * Checks whether a source is allowed to be called recursively.
1831 * see g_source_set_can_recurse().
1833 * Return value: whether recursion is allowed.
1836 g_source_get_can_recurse (GSource *source)
1838 g_return_val_if_fail (source != NULL, FALSE);
1840 return (source->flags & G_SOURCE_CAN_RECURSE) != 0;
1845 * g_source_set_name:
1846 * @source: a #GSource
1847 * @name: debug name for the source
1849 * Sets a name for the source, used in debugging and profiling.
1850 * The name defaults to #NULL.
1852 * The source name should describe in a human-readable way
1853 * what the source does. For example, "X11 event queue"
1854 * or "GTK+ repaint idle handler" or whatever it is.
1856 * It is permitted to call this function multiple times, but is not
1857 * recommended due to the potential performance impact. For example,
1858 * one could change the name in the "check" function of a #GSourceFuncs
1859 * to include details like the event type in the source name.
1864 g_source_set_name (GSource *source,
1867 g_return_if_fail (source != NULL);
1869 /* setting back to NULL is allowed, just because it's
1870 * weird if get_name can return NULL but you can't
1874 g_free (source->name);
1875 source->name = g_strdup (name);
1879 * g_source_get_name:
1880 * @source: a #GSource
1882 * Gets a name for the source, used in debugging and profiling.
1883 * The name may be #NULL if it has never been set with
1884 * g_source_set_name().
1886 * Return value: the name of the source
1890 g_source_get_name (GSource *source)
1892 g_return_val_if_fail (source != NULL, NULL);
1894 return source->name;
1898 * g_source_set_name_by_id:
1899 * @tag: a #GSource ID
1900 * @name: debug name for the source
1902 * Sets the name of a source using its ID.
1904 * This is a convenience utility to set source names from the return
1905 * value of g_idle_add(), g_timeout_add(), etc.
1910 g_source_set_name_by_id (guint tag,
1915 g_return_if_fail (tag > 0);
1917 source = g_main_context_find_source_by_id (NULL, tag);
1921 g_source_set_name (source, name);
1927 * @source: a #GSource
1929 * Increases the reference count on a source by one.
1931 * Return value: @source
1934 g_source_ref (GSource *source)
1936 GMainContext *context;
1938 g_return_val_if_fail (source != NULL, NULL);
1940 context = source->context;
1943 LOCK_CONTEXT (context);
1945 source->ref_count++;
1948 UNLOCK_CONTEXT (context);
1953 /* g_source_unref() but possible to call within context lock
1956 g_source_unref_internal (GSource *source,
1957 GMainContext *context,
1960 gpointer old_cb_data = NULL;
1961 GSourceCallbackFuncs *old_cb_funcs = NULL;
1963 g_return_if_fail (source != NULL);
1965 if (!have_lock && context)
1966 LOCK_CONTEXT (context);
1968 source->ref_count--;
1969 if (source->ref_count == 0)
1971 old_cb_data = source->callback_data;
1972 old_cb_funcs = source->callback_funcs;
1974 source->callback_data = NULL;
1975 source->callback_funcs = NULL;
1979 if (!SOURCE_DESTROYED (source))
1980 g_warning (G_STRLOC ": ref_count == 0, but source was still attached to a context!");
1981 source_remove_from_context (source, context);
1984 if (source->source_funcs->finalize)
1987 UNLOCK_CONTEXT (context);
1988 source->source_funcs->finalize (source);
1990 LOCK_CONTEXT (context);
1993 g_free (source->name);
1994 source->name = NULL;
1996 g_slist_free (source->poll_fds);
1997 source->poll_fds = NULL;
1999 g_slist_free_full (source->priv->fds, g_free);
2001 g_slice_free (GSourcePrivate, source->priv);
2002 source->priv = NULL;
2007 if (!have_lock && context)
2008 UNLOCK_CONTEXT (context);
2013 UNLOCK_CONTEXT (context);
2015 old_cb_funcs->unref (old_cb_data);
2018 LOCK_CONTEXT (context);
2024 * @source: a #GSource
2026 * Decreases the reference count of a source by one. If the
2027 * resulting reference count is zero the source and associated
2028 * memory will be destroyed.
2031 g_source_unref (GSource *source)
2033 g_return_if_fail (source != NULL);
2035 g_source_unref_internal (source, source->context, FALSE);
2039 * g_main_context_find_source_by_id:
2040 * @context: (allow-none): a #GMainContext (if %NULL, the default context will be used)
2041 * @source_id: the source ID, as returned by g_source_get_id().
2043 * Finds a #GSource given a pair of context and ID.
2045 * Return value: (transfer none): the #GSource if found, otherwise, %NULL
2048 g_main_context_find_source_by_id (GMainContext *context,
2054 g_return_val_if_fail (source_id > 0, NULL);
2056 if (context == NULL)
2057 context = g_main_context_default ();
2059 LOCK_CONTEXT (context);
2061 g_source_iter_init (&iter, context, FALSE);
2062 while (g_source_iter_next (&iter, &source))
2064 if (!SOURCE_DESTROYED (source) &&
2065 source->source_id == source_id)
2068 g_source_iter_clear (&iter);
2070 UNLOCK_CONTEXT (context);
2076 * g_main_context_find_source_by_funcs_user_data:
2077 * @context: (allow-none): a #GMainContext (if %NULL, the default context will be used).
2078 * @funcs: the @source_funcs passed to g_source_new().
2079 * @user_data: the user data from the callback.
2081 * Finds a source with the given source functions and user data. If
2082 * multiple sources exist with the same source function and user data,
2083 * the first one found will be returned.
2085 * Return value: (transfer none): the source, if one was found, otherwise %NULL
2088 g_main_context_find_source_by_funcs_user_data (GMainContext *context,
2089 GSourceFuncs *funcs,
2095 g_return_val_if_fail (funcs != NULL, NULL);
2097 if (context == NULL)
2098 context = g_main_context_default ();
2100 LOCK_CONTEXT (context);
2102 g_source_iter_init (&iter, context, FALSE);
2103 while (g_source_iter_next (&iter, &source))
2105 if (!SOURCE_DESTROYED (source) &&
2106 source->source_funcs == funcs &&
2107 source->callback_funcs)
2109 GSourceFunc callback;
2110 gpointer callback_data;
2112 source->callback_funcs->get (source->callback_data, source, &callback, &callback_data);
2114 if (callback_data == user_data)
2118 g_source_iter_clear (&iter);
2120 UNLOCK_CONTEXT (context);
2126 * g_main_context_find_source_by_user_data:
2127 * @context: a #GMainContext
2128 * @user_data: the user_data for the callback.
2130 * Finds a source with the given user data for the callback. If
2131 * multiple sources exist with the same user data, the first
2132 * one found will be returned.
2134 * Return value: (transfer none): the source, if one was found, otherwise %NULL
2137 g_main_context_find_source_by_user_data (GMainContext *context,
2143 if (context == NULL)
2144 context = g_main_context_default ();
2146 LOCK_CONTEXT (context);
2148 g_source_iter_init (&iter, context, FALSE);
2149 while (g_source_iter_next (&iter, &source))
2151 if (!SOURCE_DESTROYED (source) &&
2152 source->callback_funcs)
2154 GSourceFunc callback;
2155 gpointer callback_data = NULL;
2157 source->callback_funcs->get (source->callback_data, source, &callback, &callback_data);
2159 if (callback_data == user_data)
2163 g_source_iter_clear (&iter);
2165 UNLOCK_CONTEXT (context);
2172 * @tag: the ID of the source to remove.
2174 * Removes the source with the given id from the default main context.
2176 * a #GSource is given by g_source_get_id(), or will be returned by the
2177 * functions g_source_attach(), g_idle_add(), g_idle_add_full(),
2178 * g_timeout_add(), g_timeout_add_full(), g_child_watch_add(),
2179 * g_child_watch_add_full(), g_io_add_watch(), and g_io_add_watch_full().
2181 * See also g_source_destroy(). You must use g_source_destroy() for sources
2182 * added to a non-default main context.
2184 * Return value: %TRUE if the source was found and removed.
2187 g_source_remove (guint tag)
2191 g_return_val_if_fail (tag > 0, FALSE);
2193 source = g_main_context_find_source_by_id (NULL, tag);
2195 g_source_destroy (source);
2197 return source != NULL;
2201 * g_source_remove_by_user_data:
2202 * @user_data: the user_data for the callback.
2204 * Removes a source from the default main loop context given the user
2205 * data for the callback. If multiple sources exist with the same user
2206 * data, only one will be destroyed.
2208 * Return value: %TRUE if a source was found and removed.
2211 g_source_remove_by_user_data (gpointer user_data)
2215 source = g_main_context_find_source_by_user_data (NULL, user_data);
2218 g_source_destroy (source);
2226 * g_source_remove_by_funcs_user_data:
2227 * @funcs: The @source_funcs passed to g_source_new()
2228 * @user_data: the user data for the callback
2230 * Removes a source from the default main loop context given the
2231 * source functions and user data. If multiple sources exist with the
2232 * same source functions and user data, only one will be destroyed.
2234 * Return value: %TRUE if a source was found and removed.
2237 g_source_remove_by_funcs_user_data (GSourceFuncs *funcs,
2242 g_return_val_if_fail (funcs != NULL, FALSE);
2244 source = g_main_context_find_source_by_funcs_user_data (NULL, funcs, user_data);
2247 g_source_destroy (source);
2256 * g_source_add_unix_fd:
2257 * @source: a #GSource
2258 * @fd: the fd to monitor
2259 * @events: an event mask
2261 * Monitors @fd for the IO events in @events.
2263 * The tag returned by this function can be used to remove or modify the
2264 * monitoring of the fd using g_source_remove_unix_fd() or
2265 * g_source_modify_unix_fd().
2267 * It is not necessary to remove the fd before destroying the source; it
2268 * will be cleaned up automatically.
2270 * As the name suggests, this function is not available on Windows.
2272 * Returns: an opaque tag
2277 g_source_add_unix_fd (GSource *source,
2279 GIOCondition events)
2281 GMainContext *context;
2284 g_return_val_if_fail (source != NULL, NULL);
2285 g_return_val_if_fail (!SOURCE_DESTROYED (source), NULL);
2287 poll_fd = g_new (GPollFD, 1);
2289 poll_fd->events = events;
2290 poll_fd->revents = 0;
2292 context = source->context;
2295 LOCK_CONTEXT (context);
2297 source->priv->fds = g_slist_prepend (source->priv->fds, poll_fd);
2301 if (!SOURCE_BLOCKED (source))
2302 g_main_context_add_poll_unlocked (context, source->priority, poll_fd);
2303 UNLOCK_CONTEXT (context);
2310 * g_source_modify_unix_fd:
2311 * @source: a #GSource
2312 * @tag: the tag from g_source_add_unix_fd()
2313 * @new_events: the new event mask to watch
2315 * Updates the event mask to watch for the fd identified by @tag.
2317 * @tag is the tag returned from g_source_add_unix_fd().
2319 * If you want to remove a fd, don't set its event mask to zero.
2320 * Instead, call g_source_remove_unix_fd().
2322 * As the name suggests, this function is not available on Windows.
2327 g_source_modify_unix_fd (GSource *source,
2329 GIOCondition new_events)
2331 GMainContext *context;
2334 g_return_if_fail (source != NULL);
2335 g_return_if_fail (g_slist_find (source->priv->fds, tag));
2337 context = source->context;
2340 poll_fd->events = new_events;
2343 g_main_context_wakeup (context);
2347 * g_source_remove_unix_fd:
2348 * @source: a #GSource
2349 * @tag: the tag from g_source_add_unix_fd()
2351 * Reverses the effect of a previous call to g_source_add_unix_fd().
2353 * You only need to call this if you want to remove an fd from being
2354 * watched while keeping the same source around. In the normal case you
2355 * will just want to destroy the source.
2357 * As the name suggests, this function is not available on Windows.
2362 g_source_remove_unix_fd (GSource *source,
2365 GMainContext *context;
2368 g_return_if_fail (source != NULL);
2369 g_return_if_fail (g_slist_find (source->priv->fds, tag));
2371 context = source->context;
2375 LOCK_CONTEXT (context);
2377 source->priv->fds = g_slist_remove (source->priv->fds, poll_fd);
2381 if (!SOURCE_BLOCKED (source))
2382 g_main_context_remove_poll_unlocked (context, poll_fd);
2384 UNLOCK_CONTEXT (context);
2391 * g_source_query_unix_fd:
2392 * @source: a #GSource
2393 * @tag: the tag from g_source_add_unix_fd()
2395 * Queries the events reported for the fd corresponding to @tag on
2396 * @source during the last poll.
2398 * The return value of this function is only defined when the function
2399 * is called from the check or dispatch functions for @source.
2401 * As the name suggests, this function is not available on Windows.
2403 * Returns: the conditions reported on the fd
2408 g_source_query_unix_fd (GSource *source,
2413 g_return_val_if_fail (source != NULL, 0);
2414 g_return_val_if_fail (g_slist_find (source->priv->fds, tag), 0);
2418 return poll_fd->revents;
2420 #endif /* G_OS_UNIX */
2423 * g_get_current_time:
2424 * @result: #GTimeVal structure in which to store current time.
2426 * Equivalent to the UNIX gettimeofday() function, but portable.
2428 * You may find g_get_real_time() to be more convenient.
2431 g_get_current_time (GTimeVal *result)
2436 g_return_if_fail (result != NULL);
2438 /*this is required on alpha, there the timeval structs are int's
2439 not longs and a cast only would fail horribly*/
2440 gettimeofday (&r, NULL);
2441 result->tv_sec = r.tv_sec;
2442 result->tv_usec = r.tv_usec;
2447 g_return_if_fail (result != NULL);
2449 GetSystemTimeAsFileTime (&ft);
2450 memmove (&time64, &ft, sizeof (FILETIME));
2452 /* Convert from 100s of nanoseconds since 1601-01-01
2453 * to Unix epoch. Yes, this is Y2038 unsafe.
2455 time64 -= G_GINT64_CONSTANT (116444736000000000);
2458 result->tv_sec = time64 / 1000000;
2459 result->tv_usec = time64 % 1000000;
2466 * Queries the system wall-clock time.
2468 * This call is functionally equivalent to g_get_current_time() except
2469 * that the return value is often more convenient than dealing with a
2472 * You should only use this call if you are actually interested in the real
2473 * wall-clock time. g_get_monotonic_time() is probably more useful for
2474 * measuring intervals.
2476 * Returns: the number of microseconds since January 1, 1970 UTC.
2481 g_get_real_time (void)
2485 g_get_current_time (&tv);
2487 return (((gint64) tv.tv_sec) * 1000000) + tv.tv_usec;
2491 static ULONGLONG (*g_GetTickCount64) (void) = NULL;
2492 static guint32 g_win32_tick_epoch = 0;
2495 g_clock_win32_init (void)
2499 g_GetTickCount64 = NULL;
2500 kernel32 = GetModuleHandle ("KERNEL32.DLL");
2501 if (kernel32 != NULL)
2502 g_GetTickCount64 = (void *) GetProcAddress (kernel32, "GetTickCount64");
2503 g_win32_tick_epoch = ((guint32)GetTickCount()) >> 31;
2508 * g_get_monotonic_time:
2510 * Queries the system monotonic time, if available.
2512 * On POSIX systems with clock_gettime() and <literal>CLOCK_MONOTONIC</literal> this call
2513 * is a very shallow wrapper for that. Otherwise, we make a best effort
2514 * that probably involves returning the wall clock time (with at least
2515 * microsecond accuracy, subject to the limitations of the OS kernel).
2517 * It's important to note that POSIX <literal>CLOCK_MONOTONIC</literal> does
2518 * not count time spent while the machine is suspended.
2520 * On Windows, "limitations of the OS kernel" is a rather substantial
2521 * statement. Depending on the configuration of the system, the wall
2522 * clock time is updated as infrequently as 64 times a second (which
2523 * is approximately every 16ms). Also, on XP (but not on Vista or later)
2524 * the monotonic clock is locally monotonic, but may differ in exact
2525 * value between processes due to timer wrap handling.
2527 * Returns: the monotonic time, in microseconds
2532 g_get_monotonic_time (void)
2534 #ifdef HAVE_CLOCK_GETTIME
2535 /* librt clock_gettime() is our first choice */
2538 #ifdef CLOCK_MONOTONIC
2539 clock_gettime (CLOCK_MONOTONIC, &ts);
2541 clock_gettime (CLOCK_REALTIME, &ts);
2544 /* In theory monotonic time can have any epoch.
2546 * glib presently assumes the following:
2548 * 1) The epoch comes some time after the birth of Jesus of Nazareth, but
2549 * not more than 10000 years later.
2551 * 2) The current time also falls sometime within this range.
2553 * These two reasonable assumptions leave us with a maximum deviation from
2554 * the epoch of 10000 years, or 315569520000000000 seconds.
2556 * If we restrict ourselves to this range then the number of microseconds
2557 * will always fit well inside the constraints of a int64 (by a factor of
2560 * If you actually hit the following assertion, probably you should file a
2561 * bug against your operating system for being excessively silly.
2563 g_assert (G_GINT64_CONSTANT (-315569520000000000) < ts.tv_sec &&
2564 ts.tv_sec < G_GINT64_CONSTANT (315569520000000000));
2566 return (((gint64) ts.tv_sec) * 1000000) + (ts.tv_nsec / 1000);
2568 #elif defined (G_OS_WIN32)
2572 /* There are four sources for the monotonic time on Windows:
2574 * Three are based on a (1 msec accuracy, but only read periodically) clock chip:
2575 * - GetTickCount (GTC)
2576 * 32bit msec counter, updated each ~15msec, wraps in ~50 days
2577 * - GetTickCount64 (GTC64)
2578 * Same as GetTickCount, but extended to 64bit, so no wrap
2579 * Only available in Vista or later
2580 * - timeGetTime (TGT)
2581 * similar to GetTickCount by default: 15msec, 50 day wrap.
2582 * available in winmm.dll (thus known as the multimedia timers)
2583 * However apps can raise the system timer clock frequency using timeBeginPeriod()
2584 * increasing the accuracy up to 1 msec, at a cost in general system performance
2587 * One is based on high precision clocks:
2588 * - QueryPrecisionCounter (QPC)
2589 * This has much higher accuracy, but is not guaranteed monotonic, and
2590 * has lots of complications like clock jumps and different times on different
2591 * CPUs. It also has lower long term accuracy (i.e. it will drift compared to
2592 * the low precision clocks.
2594 * Additionally, the precision available in the timer-based wakeup such as
2595 * MsgWaitForMultipleObjectsEx (which is what the mainloop is based on) is based
2596 * on the TGT resolution, so by default it is ~15msec, but can be increased by apps.
2598 * The QPC timer has too many issues to be used as is. The only way it could be used
2599 * is to use it to interpolate the lower precision clocks. Firefox does something like
2601 * https://bugzilla.mozilla.org/show_bug.cgi?id=363258
2603 * However this seems quite complicated, so we're not doing this right now.
2605 * The approach we take instead is to use the TGT timer, extending it to 64bit
2606 * either by using the GTC64 value, or if that is not available, a process local
2607 * time epoch that we increment when we detect a timer wrap (assumes that we read
2608 * the time at least once every 50 days).
2611 * - We have a globally consistent monotonic clock on Vista and later
2612 * - We have a locally monotonic clock on XP
2613 * - Apps that need higher precision in timeouts and clock reads can call
2614 * timeBeginPeriod() to increase it as much as they want
2617 if (g_GetTickCount64 != NULL)
2619 guint32 ticks_as_32bit;
2621 ticks = g_GetTickCount64 ();
2622 ticks32 = timeGetTime();
2624 /* GTC64 and TGT are sampled at different times, however they
2625 * have the same base and source (msecs since system boot).
2626 * They can differ by as much as -16 to +16 msecs.
2627 * We can't just inject the low bits into the 64bit counter
2628 * as one of the counters can have wrapped in 32bit space and
2629 * the other not. Instead we calculate the signed difference
2630 * in 32bit space and apply that difference to the 64bit counter.
2632 ticks_as_32bit = (guint32)ticks;
2634 /* We could do some 2's complement hack, but we play it safe */
2635 if (ticks32 - ticks_as_32bit <= G_MAXINT32)
2636 ticks += ticks32 - ticks_as_32bit;
2638 ticks -= ticks_as_32bit - ticks32;
2644 epoch = g_atomic_int_get (&g_win32_tick_epoch);
2646 /* Must read ticks after the epoch. Then we're guaranteed
2647 * that the ticks value we read is higher or equal to any
2648 * previous ones that lead to the writing of the epoch.
2650 ticks32 = timeGetTime();
2652 /* We store the MSB of the current time as the LSB
2653 * of the epoch. Comparing these bits lets us detect when
2654 * the 32bit counter has wrapped so we can increase the
2657 * This will work as long as this function is called at
2658 * least once every ~24 days, which is half the wrap time
2659 * of a 32bit msec counter. I think this is pretty likely.
2661 * Note that g_win32_tick_epoch is a process local state,
2662 * so the monotonic clock will not be the same between
2665 if ((ticks32 >> 31) != (epoch & 1))
2668 g_atomic_int_set (&g_win32_tick_epoch, epoch);
2672 ticks = (guint64)ticks32 | ((guint64)epoch) << 31;
2675 return ticks * 1000;
2677 #else /* !HAVE_CLOCK_GETTIME && ! G_OS_WIN32*/
2681 g_get_current_time (&tv);
2683 return (((gint64) tv.tv_sec) * 1000000) + tv.tv_usec;
2688 g_main_dispatch_free (gpointer dispatch)
2690 g_slice_free (GMainDispatch, dispatch);
2693 /* Running the main loop */
2695 static GMainDispatch *
2698 static GPrivate depth_private = G_PRIVATE_INIT (g_main_dispatch_free);
2699 GMainDispatch *dispatch;
2701 dispatch = g_private_get (&depth_private);
2705 dispatch = g_slice_new0 (GMainDispatch);
2706 g_private_set (&depth_private, dispatch);
2715 * Returns the depth of the stack of calls to
2716 * g_main_context_dispatch() on any #GMainContext in the current thread.
2717 * That is, when called from the toplevel, it gives 0. When
2718 * called from within a callback from g_main_context_iteration()
2719 * (or g_main_loop_run(), etc.) it returns 1. When called from within
2720 * a callback to a recursive call to g_main_context_iteration(),
2721 * it returns 2. And so forth.
2723 * This function is useful in a situation like the following:
2724 * Imagine an extremely simple "garbage collected" system.
2727 * static GList *free_list;
2730 * allocate_memory (gsize size)
2732 * gpointer result = g_malloc (size);
2733 * free_list = g_list_prepend (free_list, result);
2738 * free_allocated_memory (void)
2741 * for (l = free_list; l; l = l->next);
2743 * g_list_free (free_list);
2751 * g_main_context_iteration (NULL, TRUE);
2752 * free_allocated_memory();
2756 * This works from an application, however, if you want to do the same
2757 * thing from a library, it gets more difficult, since you no longer
2758 * control the main loop. You might think you can simply use an idle
2759 * function to make the call to free_allocated_memory(), but that
2760 * doesn't work, since the idle function could be called from a
2761 * recursive callback. This can be fixed by using g_main_depth()
2765 * allocate_memory (gsize size)
2767 * FreeListBlock *block = g_new (FreeListBlock, 1);
2768 * block->mem = g_malloc (size);
2769 * block->depth = g_main_depth ();
2770 * free_list = g_list_prepend (free_list, block);
2771 * return block->mem;
2775 * free_allocated_memory (void)
2779 * int depth = g_main_depth ();
2780 * for (l = free_list; l; );
2782 * GList *next = l->next;
2783 * FreeListBlock *block = l->data;
2784 * if (block->depth > depth)
2786 * g_free (block->mem);
2788 * free_list = g_list_delete_link (free_list, l);
2796 * There is a temptation to use g_main_depth() to solve
2797 * problems with reentrancy. For instance, while waiting for data
2798 * to be received from the network in response to a menu item,
2799 * the menu item might be selected again. It might seem that
2800 * one could make the menu item's callback return immediately
2801 * and do nothing if g_main_depth() returns a value greater than 1.
2802 * However, this should be avoided since the user then sees selecting
2803 * the menu item do nothing. Furthermore, you'll find yourself adding
2804 * these checks all over your code, since there are doubtless many,
2805 * many things that the user could do. Instead, you can use the
2806 * following techniques:
2811 * Use gtk_widget_set_sensitive() or modal dialogs to prevent
2812 * the user from interacting with elements while the main
2813 * loop is recursing.
2818 * Avoid main loop recursion in situations where you can't handle
2819 * arbitrary callbacks. Instead, structure your code so that you
2820 * simply return to the main loop and then get called again when
2821 * there is more work to do.
2826 * Return value: The main loop recursion level in the current thread
2831 GMainDispatch *dispatch = get_dispatch ();
2832 return dispatch->depth;
2836 * g_main_current_source:
2838 * Returns the currently firing source for this thread.
2840 * Return value: (transfer none): The currently firing source or %NULL.
2845 g_main_current_source (void)
2847 GMainDispatch *dispatch = get_dispatch ();
2848 return dispatch->dispatching_sources ? dispatch->dispatching_sources->data : NULL;
2852 * g_source_is_destroyed:
2853 * @source: a #GSource
2855 * Returns whether @source has been destroyed.
2857 * This is important when you operate upon your objects
2858 * from within idle handlers, but may have freed the object
2859 * before the dispatch of your idle handler.
2863 * idle_callback (gpointer data)
2865 * SomeWidget *self = data;
2867 * GDK_THREADS_ENTER (<!-- -->);
2868 * /<!-- -->* do stuff with self *<!-- -->/
2869 * self->idle_id = 0;
2870 * GDK_THREADS_LEAVE (<!-- -->);
2872 * return G_SOURCE_REMOVE;
2876 * some_widget_do_stuff_later (SomeWidget *self)
2878 * self->idle_id = g_idle_add (idle_callback, self);
2882 * some_widget_finalize (GObject *object)
2884 * SomeWidget *self = SOME_WIDGET (object);
2886 * if (self->idle_id)
2887 * g_source_remove (self->idle_id);
2889 * G_OBJECT_CLASS (parent_class)->finalize (object);
2893 * This will fail in a multi-threaded application if the
2894 * widget is destroyed before the idle handler fires due
2895 * to the use after free in the callback. A solution, to
2896 * this particular problem, is to check to if the source
2897 * has already been destroy within the callback.
2901 * idle_callback (gpointer data)
2903 * SomeWidget *self = data;
2905 * GDK_THREADS_ENTER ();
2906 * if (!g_source_is_destroyed (g_main_current_source ()))
2908 * /<!-- -->* do stuff with self *<!-- -->/
2910 * GDK_THREADS_LEAVE ();
2916 * Return value: %TRUE if the source has been destroyed
2921 g_source_is_destroyed (GSource *source)
2923 return SOURCE_DESTROYED (source);
2926 /* Temporarily remove all this source's file descriptors from the
2927 * poll(), so that if data comes available for one of the file descriptors
2928 * we don't continually spin in the poll()
2930 /* HOLDS: source->context's lock */
2932 block_source (GSource *source)
2936 g_return_if_fail (!SOURCE_BLOCKED (source));
2938 source->flags |= G_SOURCE_BLOCKED;
2940 tmp_list = source->poll_fds;
2943 g_main_context_remove_poll_unlocked (source->context, tmp_list->data);
2944 tmp_list = tmp_list->next;
2947 for (tmp_list = source->priv->fds; tmp_list; tmp_list = tmp_list->next)
2948 g_main_context_remove_poll_unlocked (source->context, tmp_list->data);
2950 if (source->priv && source->priv->child_sources)
2952 tmp_list = source->priv->child_sources;
2955 block_source (tmp_list->data);
2956 tmp_list = tmp_list->next;
2961 /* HOLDS: source->context's lock */
2963 unblock_source (GSource *source)
2967 g_return_if_fail (SOURCE_BLOCKED (source)); /* Source already unblocked */
2968 g_return_if_fail (!SOURCE_DESTROYED (source));
2970 source->flags &= ~G_SOURCE_BLOCKED;
2972 tmp_list = source->poll_fds;
2975 g_main_context_add_poll_unlocked (source->context, source->priority, tmp_list->data);
2976 tmp_list = tmp_list->next;
2979 for (tmp_list = source->priv->fds; tmp_list; tmp_list = tmp_list->next)
2980 g_main_context_add_poll_unlocked (source->context, source->priority, tmp_list->data);
2982 if (source->priv && source->priv->child_sources)
2984 tmp_list = source->priv->child_sources;
2987 unblock_source (tmp_list->data);
2988 tmp_list = tmp_list->next;
2993 /* HOLDS: context's lock */
2995 g_main_dispatch (GMainContext *context)
2997 GMainDispatch *current = get_dispatch ();
3000 for (i = 0; i < context->pending_dispatches->len; i++)
3002 GSource *source = context->pending_dispatches->pdata[i];
3004 context->pending_dispatches->pdata[i] = NULL;
3007 source->flags &= ~G_SOURCE_READY;
3009 if (!SOURCE_DESTROYED (source))
3011 gboolean was_in_call;
3012 gpointer user_data = NULL;
3013 GSourceFunc callback = NULL;
3014 GSourceCallbackFuncs *cb_funcs;
3016 gboolean need_destroy;
3018 gboolean (*dispatch) (GSource *,
3021 GSList current_source_link;
3023 dispatch = source->source_funcs->dispatch;
3024 cb_funcs = source->callback_funcs;
3025 cb_data = source->callback_data;
3028 cb_funcs->ref (cb_data);
3030 if ((source->flags & G_SOURCE_CAN_RECURSE) == 0)
3031 block_source (source);
3033 was_in_call = source->flags & G_HOOK_FLAG_IN_CALL;
3034 source->flags |= G_HOOK_FLAG_IN_CALL;
3037 cb_funcs->get (cb_data, source, &callback, &user_data);
3039 UNLOCK_CONTEXT (context);
3042 /* The on-stack allocation of the GSList is unconventional, but
3043 * we know that the lifetime of the link is bounded to this
3044 * function as the link is kept in a thread specific list and
3045 * not manipulated outside of this function and its descendants.
3046 * Avoiding the overhead of a g_slist_alloc() is useful as many
3047 * applications do little more than dispatch events.
3049 * This is a performance hack - do not revert to g_slist_prepend()!
3051 current_source_link.data = source;
3052 current_source_link.next = current->dispatching_sources;
3053 current->dispatching_sources = ¤t_source_link;
3054 need_destroy = ! dispatch (source,
3057 g_assert (current->dispatching_sources == ¤t_source_link);
3058 current->dispatching_sources = current_source_link.next;
3062 cb_funcs->unref (cb_data);
3064 LOCK_CONTEXT (context);
3067 source->flags &= ~G_HOOK_FLAG_IN_CALL;
3069 if (SOURCE_BLOCKED (source) && !SOURCE_DESTROYED (source))
3070 unblock_source (source);
3072 /* Note: this depends on the fact that we can't switch
3073 * sources from one main context to another
3075 if (need_destroy && !SOURCE_DESTROYED (source))
3077 g_assert (source->context == context);
3078 g_source_destroy_internal (source, context, TRUE);
3082 SOURCE_UNREF (source, context);
3085 g_ptr_array_set_size (context->pending_dispatches, 0);
3089 * g_main_context_acquire:
3090 * @context: a #GMainContext
3092 * Tries to become the owner of the specified context.
3093 * If some other thread is the owner of the context,
3094 * returns %FALSE immediately. Ownership is properly
3095 * recursive: the owner can require ownership again
3096 * and will release ownership when g_main_context_release()
3097 * is called as many times as g_main_context_acquire().
3099 * You must be the owner of a context before you
3100 * can call g_main_context_prepare(), g_main_context_query(),
3101 * g_main_context_check(), g_main_context_dispatch().
3103 * Return value: %TRUE if the operation succeeded, and
3104 * this thread is now the owner of @context.
3107 g_main_context_acquire (GMainContext *context)
3109 gboolean result = FALSE;
3110 GThread *self = G_THREAD_SELF;
3112 if (context == NULL)
3113 context = g_main_context_default ();
3115 LOCK_CONTEXT (context);
3117 if (!context->owner)
3119 context->owner = self;
3120 g_assert (context->owner_count == 0);
3123 if (context->owner == self)
3125 context->owner_count++;
3129 UNLOCK_CONTEXT (context);
3135 * g_main_context_release:
3136 * @context: a #GMainContext
3138 * Releases ownership of a context previously acquired by this thread
3139 * with g_main_context_acquire(). If the context was acquired multiple
3140 * times, the ownership will be released only when g_main_context_release()
3141 * is called as many times as it was acquired.
3144 g_main_context_release (GMainContext *context)
3146 if (context == NULL)
3147 context = g_main_context_default ();
3149 LOCK_CONTEXT (context);
3151 context->owner_count--;
3152 if (context->owner_count == 0)
3154 context->owner = NULL;
3156 if (context->waiters)
3158 GMainWaiter *waiter = context->waiters->data;
3159 gboolean loop_internal_waiter = (waiter->mutex == &context->mutex);
3160 context->waiters = g_slist_delete_link (context->waiters,
3162 if (!loop_internal_waiter)
3163 g_mutex_lock (waiter->mutex);
3165 g_cond_signal (waiter->cond);
3167 if (!loop_internal_waiter)
3168 g_mutex_unlock (waiter->mutex);
3172 UNLOCK_CONTEXT (context);
3176 * g_main_context_wait:
3177 * @context: a #GMainContext
3178 * @cond: a condition variable
3179 * @mutex: a mutex, currently held
3181 * Tries to become the owner of the specified context,
3182 * as with g_main_context_acquire(). But if another thread
3183 * is the owner, atomically drop @mutex and wait on @cond until
3184 * that owner releases ownership or until @cond is signaled, then
3185 * try again (once) to become the owner.
3187 * Return value: %TRUE if the operation succeeded, and
3188 * this thread is now the owner of @context.
3191 g_main_context_wait (GMainContext *context,
3195 gboolean result = FALSE;
3196 GThread *self = G_THREAD_SELF;
3197 gboolean loop_internal_waiter;
3199 if (context == NULL)
3200 context = g_main_context_default ();
3202 loop_internal_waiter = (mutex == &context->mutex);
3204 if (!loop_internal_waiter)
3205 LOCK_CONTEXT (context);
3207 if (context->owner && context->owner != self)
3212 waiter.mutex = mutex;
3214 context->waiters = g_slist_append (context->waiters, &waiter);
3216 if (!loop_internal_waiter)
3217 UNLOCK_CONTEXT (context);
3218 g_cond_wait (cond, mutex);
3219 if (!loop_internal_waiter)
3220 LOCK_CONTEXT (context);
3222 context->waiters = g_slist_remove (context->waiters, &waiter);
3225 if (!context->owner)
3227 context->owner = self;
3228 g_assert (context->owner_count == 0);
3231 if (context->owner == self)
3233 context->owner_count++;
3237 if (!loop_internal_waiter)
3238 UNLOCK_CONTEXT (context);
3244 * g_main_context_prepare:
3245 * @context: a #GMainContext
3246 * @priority: location to store priority of highest priority
3247 * source already ready.
3249 * Prepares to poll sources within a main loop. The resulting information
3250 * for polling is determined by calling g_main_context_query ().
3252 * Return value: %TRUE if some source is ready to be dispatched
3256 g_main_context_prepare (GMainContext *context,
3261 gint current_priority = G_MAXINT;
3265 if (context == NULL)
3266 context = g_main_context_default ();
3268 LOCK_CONTEXT (context);
3270 context->time_is_fresh = FALSE;
3272 if (context->in_check_or_prepare)
3274 g_warning ("g_main_context_prepare() called recursively from within a source's check() or "
3275 "prepare() member.");
3276 UNLOCK_CONTEXT (context);
3281 /* If recursing, finish up current dispatch, before starting over */
3282 if (context->pending_dispatches)
3285 g_main_dispatch (context, ¤t_time);
3287 UNLOCK_CONTEXT (context);
3292 /* If recursing, clear list of pending dispatches */
3294 for (i = 0; i < context->pending_dispatches->len; i++)
3296 if (context->pending_dispatches->pdata[i])
3297 SOURCE_UNREF ((GSource *)context->pending_dispatches->pdata[i], context);
3299 g_ptr_array_set_size (context->pending_dispatches, 0);
3301 /* Prepare all sources */
3303 context->timeout = -1;
3305 g_source_iter_init (&iter, context, TRUE);
3306 while (g_source_iter_next (&iter, &source))
3308 gint source_timeout = -1;
3310 if (SOURCE_DESTROYED (source) || SOURCE_BLOCKED (source))
3312 if ((n_ready > 0) && (source->priority > current_priority))
3315 if (!(source->flags & G_SOURCE_READY))
3318 gboolean (* prepare) (GSource *source,
3321 prepare = source->source_funcs->prepare;
3325 context->in_check_or_prepare++;
3326 UNLOCK_CONTEXT (context);
3328 result = (* prepare) (source, &source_timeout);
3330 LOCK_CONTEXT (context);
3331 context->in_check_or_prepare--;
3335 source_timeout = -1;
3339 if (result == FALSE && source->priv->ready_time != -1)
3341 if (!context->time_is_fresh)
3343 context->time = g_get_monotonic_time ();
3344 context->time_is_fresh = TRUE;
3347 if (source->priv->ready_time <= context->time)
3356 /* rounding down will lead to spinning, so always round up */
3357 timeout = (source->priv->ready_time - context->time + 999) / 1000;
3359 if (source_timeout < 0 || timeout < source_timeout)
3360 source_timeout = timeout;
3366 GSource *ready_source = source;
3368 while (ready_source)
3370 ready_source->flags |= G_SOURCE_READY;
3371 ready_source = ready_source->priv->parent_source;
3376 if (source->flags & G_SOURCE_READY)
3379 current_priority = source->priority;
3380 context->timeout = 0;
3383 if (source_timeout >= 0)
3385 if (context->timeout < 0)
3386 context->timeout = source_timeout;
3388 context->timeout = MIN (context->timeout, source_timeout);
3391 g_source_iter_clear (&iter);
3393 UNLOCK_CONTEXT (context);
3396 *priority = current_priority;
3398 return (n_ready > 0);
3402 * g_main_context_query:
3403 * @context: a #GMainContext
3404 * @max_priority: maximum priority source to check
3405 * @timeout_: (out): location to store timeout to be used in polling
3406 * @fds: (out caller-allocates) (array length=n_fds): location to
3407 * store #GPollFD records that need to be polled.
3408 * @n_fds: length of @fds.
3410 * Determines information necessary to poll this main loop.
3412 * Return value: the number of records actually stored in @fds,
3413 * or, if more than @n_fds records need to be stored, the number
3414 * of records that need to be stored.
3417 g_main_context_query (GMainContext *context,
3426 LOCK_CONTEXT (context);
3428 pollrec = context->poll_records;
3430 while (pollrec && max_priority >= pollrec->priority)
3432 /* We need to include entries with fd->events == 0 in the array because
3433 * otherwise if the application changes fd->events behind our back and
3434 * makes it non-zero, we'll be out of sync when we check the fds[] array.
3435 * (Changing fd->events after adding an FD wasn't an anticipated use of
3436 * this API, but it occurs in practice.) */
3439 fds[n_poll].fd = pollrec->fd->fd;
3440 /* In direct contradiction to the Unix98 spec, IRIX runs into
3441 * difficulty if you pass in POLLERR, POLLHUP or POLLNVAL
3442 * flags in the events field of the pollfd while it should
3443 * just ignoring them. So we mask them out here.
3445 fds[n_poll].events = pollrec->fd->events & ~(G_IO_ERR|G_IO_HUP|G_IO_NVAL);
3446 fds[n_poll].revents = 0;
3449 pollrec = pollrec->next;
3453 context->poll_changed = FALSE;
3457 *timeout = context->timeout;
3459 context->time_is_fresh = FALSE;
3462 UNLOCK_CONTEXT (context);
3468 * g_main_context_check:
3469 * @context: a #GMainContext
3470 * @max_priority: the maximum numerical priority of sources to check
3471 * @fds: (array length=n_fds): array of #GPollFD's that was passed to
3472 * the last call to g_main_context_query()
3473 * @n_fds: return value of g_main_context_query()
3475 * Passes the results of polling back to the main loop.
3477 * Return value: %TRUE if some sources are ready to be dispatched.
3480 g_main_context_check (GMainContext *context,
3491 LOCK_CONTEXT (context);
3493 if (context->in_check_or_prepare)
3495 g_warning ("g_main_context_check() called recursively from within a source's check() or "
3496 "prepare() member.");
3497 UNLOCK_CONTEXT (context);
3501 if (context->wake_up_rec.revents)
3502 g_wakeup_acknowledge (context->wakeup);
3504 /* If the set of poll file descriptors changed, bail out
3505 * and let the main loop rerun
3507 if (context->poll_changed)
3509 UNLOCK_CONTEXT (context);
3513 pollrec = context->poll_records;
3517 if (pollrec->fd->events)
3518 pollrec->fd->revents = fds[i].revents;
3520 pollrec = pollrec->next;
3524 g_source_iter_init (&iter, context, TRUE);
3525 while (g_source_iter_next (&iter, &source))
3527 if (SOURCE_DESTROYED (source) || SOURCE_BLOCKED (source))
3529 if ((n_ready > 0) && (source->priority > max_priority))
3532 if (!(source->flags & G_SOURCE_READY))
3535 gboolean (* check) (GSource *source);
3537 check = source->source_funcs->check;
3541 /* If the check function is set, call it. */
3542 context->in_check_or_prepare++;
3543 UNLOCK_CONTEXT (context);
3545 result = (* check) (source);
3547 LOCK_CONTEXT (context);
3548 context->in_check_or_prepare--;
3553 if (result == FALSE)
3557 /* If not already explicitly flagged ready by ->check()
3558 * (or if we have no check) then we can still be ready if
3559 * any of our fds poll as ready.
3561 for (tmp_list = source->priv->fds; tmp_list; tmp_list = tmp_list->next)
3563 GPollFD *pollfd = tmp_list->data;
3565 if (pollfd->revents)
3573 if (result == FALSE && source->priv->ready_time != -1)
3575 if (!context->time_is_fresh)
3577 context->time = g_get_monotonic_time ();
3578 context->time_is_fresh = TRUE;
3581 if (source->priv->ready_time <= context->time)
3587 GSource *ready_source = source;
3589 while (ready_source)
3591 ready_source->flags |= G_SOURCE_READY;
3592 ready_source = ready_source->priv->parent_source;
3597 if (source->flags & G_SOURCE_READY)
3599 source->ref_count++;
3600 g_ptr_array_add (context->pending_dispatches, source);
3604 /* never dispatch sources with less priority than the first
3605 * one we choose to dispatch
3607 max_priority = source->priority;
3610 g_source_iter_clear (&iter);
3612 UNLOCK_CONTEXT (context);
3618 * g_main_context_dispatch:
3619 * @context: a #GMainContext
3621 * Dispatches all pending sources.
3624 g_main_context_dispatch (GMainContext *context)
3626 LOCK_CONTEXT (context);
3628 if (context->pending_dispatches->len > 0)
3630 g_main_dispatch (context);
3633 UNLOCK_CONTEXT (context);
3636 /* HOLDS context lock */
3638 g_main_context_iterate (GMainContext *context,
3645 gboolean some_ready;
3646 gint nfds, allocated_nfds;
3647 GPollFD *fds = NULL;
3649 UNLOCK_CONTEXT (context);
3651 if (!g_main_context_acquire (context))
3653 gboolean got_ownership;
3655 LOCK_CONTEXT (context);
3660 got_ownership = g_main_context_wait (context,
3668 LOCK_CONTEXT (context);
3670 if (!context->cached_poll_array)
3672 context->cached_poll_array_size = context->n_poll_records;
3673 context->cached_poll_array = g_new (GPollFD, context->n_poll_records);
3676 allocated_nfds = context->cached_poll_array_size;
3677 fds = context->cached_poll_array;
3679 UNLOCK_CONTEXT (context);
3681 g_main_context_prepare (context, &max_priority);
3683 while ((nfds = g_main_context_query (context, max_priority, &timeout, fds,
3684 allocated_nfds)) > allocated_nfds)
3686 LOCK_CONTEXT (context);
3688 context->cached_poll_array_size = allocated_nfds = nfds;
3689 context->cached_poll_array = fds = g_new (GPollFD, nfds);
3690 UNLOCK_CONTEXT (context);
3696 g_main_context_poll (context, timeout, max_priority, fds, nfds);
3698 some_ready = g_main_context_check (context, max_priority, fds, nfds);
3701 g_main_context_dispatch (context);
3703 g_main_context_release (context);
3705 LOCK_CONTEXT (context);
3711 * g_main_context_pending:
3712 * @context: (allow-none): a #GMainContext (if %NULL, the default context will be used)
3714 * Checks if any sources have pending events for the given context.
3716 * Return value: %TRUE if events are pending.
3719 g_main_context_pending (GMainContext *context)
3724 context = g_main_context_default();
3726 LOCK_CONTEXT (context);
3727 retval = g_main_context_iterate (context, FALSE, FALSE, G_THREAD_SELF);
3728 UNLOCK_CONTEXT (context);
3734 * g_main_context_iteration:
3735 * @context: (allow-none): a #GMainContext (if %NULL, the default context will be used)
3736 * @may_block: whether the call may block.
3738 * Runs a single iteration for the given main loop. This involves
3739 * checking to see if any event sources are ready to be processed,
3740 * then if no events sources are ready and @may_block is %TRUE, waiting
3741 * for a source to become ready, then dispatching the highest priority
3742 * events sources that are ready. Otherwise, if @may_block is %FALSE
3743 * sources are not waited to become ready, only those highest priority
3744 * events sources will be dispatched (if any), that are ready at this
3745 * given moment without further waiting.
3747 * Note that even when @may_block is %TRUE, it is still possible for
3748 * g_main_context_iteration() to return %FALSE, since the wait may
3749 * be interrupted for other reasons than an event source becoming ready.
3751 * Return value: %TRUE if events were dispatched.
3754 g_main_context_iteration (GMainContext *context, gboolean may_block)
3759 context = g_main_context_default();
3761 LOCK_CONTEXT (context);
3762 retval = g_main_context_iterate (context, may_block, TRUE, G_THREAD_SELF);
3763 UNLOCK_CONTEXT (context);
3770 * @context: (allow-none): a #GMainContext (if %NULL, the default context will be used).
3771 * @is_running: set to %TRUE to indicate that the loop is running. This
3772 * is not very important since calling g_main_loop_run() will set this to
3775 * Creates a new #GMainLoop structure.
3777 * Return value: a new #GMainLoop.
3780 g_main_loop_new (GMainContext *context,
3781 gboolean is_running)
3786 context = g_main_context_default();
3788 g_main_context_ref (context);
3790 loop = g_new0 (GMainLoop, 1);
3791 loop->context = context;
3792 loop->is_running = is_running != FALSE;
3793 loop->ref_count = 1;
3800 * @loop: a #GMainLoop
3802 * Increases the reference count on a #GMainLoop object by one.
3804 * Return value: @loop
3807 g_main_loop_ref (GMainLoop *loop)
3809 g_return_val_if_fail (loop != NULL, NULL);
3810 g_return_val_if_fail (g_atomic_int_get (&loop->ref_count) > 0, NULL);
3812 g_atomic_int_inc (&loop->ref_count);
3818 * g_main_loop_unref:
3819 * @loop: a #GMainLoop
3821 * Decreases the reference count on a #GMainLoop object by one. If
3822 * the result is zero, free the loop and free all associated memory.
3825 g_main_loop_unref (GMainLoop *loop)
3827 g_return_if_fail (loop != NULL);
3828 g_return_if_fail (g_atomic_int_get (&loop->ref_count) > 0);
3830 if (!g_atomic_int_dec_and_test (&loop->ref_count))
3833 g_main_context_unref (loop->context);
3839 * @loop: a #GMainLoop
3841 * Runs a main loop until g_main_loop_quit() is called on the loop.
3842 * If this is called for the thread of the loop's #GMainContext,
3843 * it will process events from the loop, otherwise it will
3847 g_main_loop_run (GMainLoop *loop)
3849 GThread *self = G_THREAD_SELF;
3851 g_return_if_fail (loop != NULL);
3852 g_return_if_fail (g_atomic_int_get (&loop->ref_count) > 0);
3854 if (!g_main_context_acquire (loop->context))
3856 gboolean got_ownership = FALSE;
3858 /* Another thread owns this context */
3859 LOCK_CONTEXT (loop->context);
3861 g_atomic_int_inc (&loop->ref_count);
3863 if (!loop->is_running)
3864 loop->is_running = TRUE;
3866 while (loop->is_running && !got_ownership)
3867 got_ownership = g_main_context_wait (loop->context,
3868 &loop->context->cond,
3869 &loop->context->mutex);
3871 if (!loop->is_running)
3873 UNLOCK_CONTEXT (loop->context);
3875 g_main_context_release (loop->context);
3876 g_main_loop_unref (loop);
3880 g_assert (got_ownership);
3883 LOCK_CONTEXT (loop->context);
3885 if (loop->context->in_check_or_prepare)
3887 g_warning ("g_main_loop_run(): called recursively from within a source's "
3888 "check() or prepare() member, iteration not possible.");
3892 g_atomic_int_inc (&loop->ref_count);
3893 loop->is_running = TRUE;
3894 while (loop->is_running)
3895 g_main_context_iterate (loop->context, TRUE, TRUE, self);
3897 UNLOCK_CONTEXT (loop->context);
3899 g_main_context_release (loop->context);
3901 g_main_loop_unref (loop);
3906 * @loop: a #GMainLoop
3908 * Stops a #GMainLoop from running. Any calls to g_main_loop_run()
3909 * for the loop will return.
3911 * Note that sources that have already been dispatched when
3912 * g_main_loop_quit() is called will still be executed.
3915 g_main_loop_quit (GMainLoop *loop)
3917 g_return_if_fail (loop != NULL);
3918 g_return_if_fail (g_atomic_int_get (&loop->ref_count) > 0);
3920 LOCK_CONTEXT (loop->context);
3921 loop->is_running = FALSE;
3922 g_wakeup_signal (loop->context->wakeup);
3924 g_cond_broadcast (&loop->context->cond);
3926 UNLOCK_CONTEXT (loop->context);
3930 * g_main_loop_is_running:
3931 * @loop: a #GMainLoop.
3933 * Checks to see if the main loop is currently being run via g_main_loop_run().
3935 * Return value: %TRUE if the mainloop is currently being run.
3938 g_main_loop_is_running (GMainLoop *loop)
3940 g_return_val_if_fail (loop != NULL, FALSE);
3941 g_return_val_if_fail (g_atomic_int_get (&loop->ref_count) > 0, FALSE);
3943 return loop->is_running;
3947 * g_main_loop_get_context:
3948 * @loop: a #GMainLoop.
3950 * Returns the #GMainContext of @loop.
3952 * Return value: (transfer none): the #GMainContext of @loop
3955 g_main_loop_get_context (GMainLoop *loop)
3957 g_return_val_if_fail (loop != NULL, NULL);
3958 g_return_val_if_fail (g_atomic_int_get (&loop->ref_count) > 0, NULL);
3960 return loop->context;
3963 /* HOLDS: context's lock */
3965 g_main_context_poll (GMainContext *context,
3971 #ifdef G_MAIN_POLL_DEBUG
3977 GPollFunc poll_func;
3979 if (n_fds || timeout != 0)
3981 #ifdef G_MAIN_POLL_DEBUG
3982 if (_g_main_poll_debug)
3984 g_print ("polling context=%p n=%d timeout=%d\n",
3985 context, n_fds, timeout);
3986 poll_timer = g_timer_new ();
3990 LOCK_CONTEXT (context);
3992 poll_func = context->poll_func;
3994 UNLOCK_CONTEXT (context);
3995 if ((*poll_func) (fds, n_fds, timeout) < 0 && errno != EINTR)
3998 g_warning ("poll(2) failed due to: %s.",
3999 g_strerror (errno));
4001 /* If g_poll () returns -1, it has already called g_warning() */
4005 #ifdef G_MAIN_POLL_DEBUG
4006 if (_g_main_poll_debug)
4008 LOCK_CONTEXT (context);
4010 g_print ("g_main_poll(%d) timeout: %d - elapsed %12.10f seconds",
4013 g_timer_elapsed (poll_timer, NULL));
4014 g_timer_destroy (poll_timer);
4015 pollrec = context->poll_records;
4017 while (pollrec != NULL)
4022 if (fds[i].fd == pollrec->fd->fd &&
4023 pollrec->fd->events &&
4026 g_print (" [" G_POLLFD_FORMAT " :", fds[i].fd);
4027 if (fds[i].revents & G_IO_IN)
4029 if (fds[i].revents & G_IO_OUT)
4031 if (fds[i].revents & G_IO_PRI)
4033 if (fds[i].revents & G_IO_ERR)
4035 if (fds[i].revents & G_IO_HUP)
4037 if (fds[i].revents & G_IO_NVAL)
4043 pollrec = pollrec->next;
4047 UNLOCK_CONTEXT (context);
4050 } /* if (n_fds || timeout != 0) */
4054 * g_main_context_add_poll:
4055 * @context: (allow-none): a #GMainContext (or %NULL for the default context)
4056 * @fd: a #GPollFD structure holding information about a file
4057 * descriptor to watch.
4058 * @priority: the priority for this file descriptor which should be
4059 * the same as the priority used for g_source_attach() to ensure that the
4060 * file descriptor is polled whenever the results may be needed.
4062 * Adds a file descriptor to the set of file descriptors polled for
4063 * this context. This will very seldom be used directly. Instead
4064 * a typical event source will use g_source_add_unix_fd() instead.
4067 g_main_context_add_poll (GMainContext *context,
4072 context = g_main_context_default ();
4074 g_return_if_fail (g_atomic_int_get (&context->ref_count) > 0);
4075 g_return_if_fail (fd);
4077 LOCK_CONTEXT (context);
4078 g_main_context_add_poll_unlocked (context, priority, fd);
4079 UNLOCK_CONTEXT (context);
4082 /* HOLDS: main_loop_lock */
4084 g_main_context_add_poll_unlocked (GMainContext *context,
4088 GPollRec *prevrec, *nextrec;
4089 GPollRec *newrec = g_slice_new (GPollRec);
4091 /* This file descriptor may be checked before we ever poll */
4094 newrec->priority = priority;
4096 prevrec = context->poll_records_tail;
4098 while (prevrec && priority < prevrec->priority)
4101 prevrec = prevrec->prev;
4105 prevrec->next = newrec;
4107 context->poll_records = newrec;
4109 newrec->prev = prevrec;
4110 newrec->next = nextrec;
4113 nextrec->prev = newrec;
4115 context->poll_records_tail = newrec;
4117 context->n_poll_records++;
4119 context->poll_changed = TRUE;
4121 /* Now wake up the main loop if it is waiting in the poll() */
4122 g_wakeup_signal (context->wakeup);
4126 * g_main_context_remove_poll:
4127 * @context:a #GMainContext
4128 * @fd: a #GPollFD descriptor previously added with g_main_context_add_poll()
4130 * Removes file descriptor from the set of file descriptors to be
4131 * polled for a particular context.
4134 g_main_context_remove_poll (GMainContext *context,
4138 context = g_main_context_default ();
4140 g_return_if_fail (g_atomic_int_get (&context->ref_count) > 0);
4141 g_return_if_fail (fd);
4143 LOCK_CONTEXT (context);
4144 g_main_context_remove_poll_unlocked (context, fd);
4145 UNLOCK_CONTEXT (context);
4149 g_main_context_remove_poll_unlocked (GMainContext *context,
4152 GPollRec *pollrec, *prevrec, *nextrec;
4155 pollrec = context->poll_records;
4159 nextrec = pollrec->next;
4160 if (pollrec->fd == fd)
4162 if (prevrec != NULL)
4163 prevrec->next = nextrec;
4165 context->poll_records = nextrec;
4167 if (nextrec != NULL)
4168 nextrec->prev = prevrec;
4170 context->poll_records_tail = prevrec;
4172 g_slice_free (GPollRec, pollrec);
4174 context->n_poll_records--;
4181 context->poll_changed = TRUE;
4183 /* Now wake up the main loop if it is waiting in the poll() */
4184 g_wakeup_signal (context->wakeup);
4188 * g_source_get_current_time:
4189 * @source: a #GSource
4190 * @timeval: #GTimeVal structure in which to store current time.
4192 * This function ignores @source and is otherwise the same as
4193 * g_get_current_time().
4195 * Deprecated: 2.28: use g_source_get_time() instead
4198 g_source_get_current_time (GSource *source,
4201 g_get_current_time (timeval);
4205 * g_source_get_time:
4206 * @source: a #GSource
4208 * Gets the time to be used when checking this source. The advantage of
4209 * calling this function over calling g_get_monotonic_time() directly is
4210 * that when checking multiple sources, GLib can cache a single value
4211 * instead of having to repeatedly get the system monotonic time.
4213 * The time here is the system monotonic time, if available, or some
4214 * other reasonable alternative otherwise. See g_get_monotonic_time().
4216 * Returns: the monotonic time in microseconds
4221 g_source_get_time (GSource *source)
4223 GMainContext *context;
4226 g_return_val_if_fail (source->context != NULL, 0);
4228 context = source->context;
4230 LOCK_CONTEXT (context);
4232 if (!context->time_is_fresh)
4234 context->time = g_get_monotonic_time ();
4235 context->time_is_fresh = TRUE;
4238 result = context->time;
4240 UNLOCK_CONTEXT (context);
4246 * g_main_context_set_poll_func:
4247 * @context: a #GMainContext
4248 * @func: the function to call to poll all file descriptors
4250 * Sets the function to use to handle polling of file descriptors. It
4251 * will be used instead of the poll() system call
4252 * (or GLib's replacement function, which is used where
4253 * poll() isn't available).
4255 * This function could possibly be used to integrate the GLib event
4256 * loop with an external event loop.
4259 g_main_context_set_poll_func (GMainContext *context,
4263 context = g_main_context_default ();
4265 g_return_if_fail (g_atomic_int_get (&context->ref_count) > 0);
4267 LOCK_CONTEXT (context);
4270 context->poll_func = func;
4272 context->poll_func = g_poll;
4274 UNLOCK_CONTEXT (context);
4278 * g_main_context_get_poll_func:
4279 * @context: a #GMainContext
4281 * Gets the poll function set by g_main_context_set_poll_func().
4283 * Return value: the poll function
4286 g_main_context_get_poll_func (GMainContext *context)
4291 context = g_main_context_default ();
4293 g_return_val_if_fail (g_atomic_int_get (&context->ref_count) > 0, NULL);
4295 LOCK_CONTEXT (context);
4296 result = context->poll_func;
4297 UNLOCK_CONTEXT (context);
4303 * g_main_context_wakeup:
4304 * @context: a #GMainContext
4306 * If @context is currently waiting in a poll(), interrupt
4307 * the poll(), and continue the iteration process.
4310 g_main_context_wakeup (GMainContext *context)
4313 context = g_main_context_default ();
4315 g_return_if_fail (g_atomic_int_get (&context->ref_count) > 0);
4317 g_wakeup_signal (context->wakeup);
4321 * g_main_context_is_owner:
4322 * @context: a #GMainContext
4324 * Determines whether this thread holds the (recursive)
4325 * ownership of this #GMainContext. This is useful to
4326 * know before waiting on another thread that may be
4327 * blocking to get ownership of @context.
4329 * Returns: %TRUE if current thread is owner of @context.
4334 g_main_context_is_owner (GMainContext *context)
4339 context = g_main_context_default ();
4341 LOCK_CONTEXT (context);
4342 is_owner = context->owner == G_THREAD_SELF;
4343 UNLOCK_CONTEXT (context);
4351 g_timeout_set_expiration (GTimeoutSource *timeout_source,
4352 gint64 current_time)
4356 expiration = current_time + (guint64) timeout_source->interval * 1000;
4358 if (timeout_source->seconds)
4361 static gint timer_perturb = -1;
4363 if (timer_perturb == -1)
4366 * we want a per machine/session unique 'random' value; try the dbus
4367 * address first, that has a UUID in it. If there is no dbus, use the
4368 * hostname for hashing.
4370 const char *session_bus_address = g_getenv ("DBUS_SESSION_BUS_ADDRESS");
4371 if (!session_bus_address)
4372 session_bus_address = g_getenv ("HOSTNAME");
4373 if (session_bus_address)
4374 timer_perturb = ABS ((gint) g_str_hash (session_bus_address)) % 1000000;
4379 /* We want the microseconds part of the timeout to land on the
4380 * 'timer_perturb' mark, but we need to make sure we don't try to
4381 * set the timeout in the past. We do this by ensuring that we
4382 * always only *increase* the expiration time by adding a full
4383 * second in the case that the microsecond portion decreases.
4385 expiration -= timer_perturb;
4387 remainder = expiration % 1000000;
4388 if (remainder >= 1000000/4)
4389 expiration += 1000000;
4391 expiration -= remainder;
4392 expiration += timer_perturb;
4395 g_source_set_ready_time ((GSource *) timeout_source, expiration);
4399 g_timeout_dispatch (GSource *source,
4400 GSourceFunc callback,
4403 GTimeoutSource *timeout_source = (GTimeoutSource *)source;
4408 g_warning ("Timeout source dispatched without callback\n"
4409 "You must call g_source_set_callback().");
4413 again = callback (user_data);
4416 g_timeout_set_expiration (timeout_source, g_source_get_time (source));
4422 * g_timeout_source_new:
4423 * @interval: the timeout interval in milliseconds.
4425 * Creates a new timeout source.
4427 * The source will not initially be associated with any #GMainContext
4428 * and must be added to one with g_source_attach() before it will be
4431 * The interval given is in terms of monotonic time, not wall clock
4432 * time. See g_get_monotonic_time().
4434 * Return value: the newly-created timeout source
4437 g_timeout_source_new (guint interval)
4439 GSource *source = g_source_new (&g_timeout_funcs, sizeof (GTimeoutSource));
4440 GTimeoutSource *timeout_source = (GTimeoutSource *)source;
4442 timeout_source->interval = interval;
4443 g_timeout_set_expiration (timeout_source, g_get_monotonic_time ());
4449 * g_timeout_source_new_seconds:
4450 * @interval: the timeout interval in seconds
4452 * Creates a new timeout source.
4454 * The source will not initially be associated with any #GMainContext
4455 * and must be added to one with g_source_attach() before it will be
4458 * The scheduling granularity/accuracy of this timeout source will be
4461 * The interval given in terms of monotonic time, not wall clock time.
4462 * See g_get_monotonic_time().
4464 * Return value: the newly-created timeout source
4469 g_timeout_source_new_seconds (guint interval)
4471 GSource *source = g_source_new (&g_timeout_funcs, sizeof (GTimeoutSource));
4472 GTimeoutSource *timeout_source = (GTimeoutSource *)source;
4474 timeout_source->interval = 1000 * interval;
4475 timeout_source->seconds = TRUE;
4477 g_timeout_set_expiration (timeout_source, g_get_monotonic_time ());
4484 * g_timeout_add_full:
4485 * @priority: the priority of the timeout source. Typically this will be in
4486 * the range between #G_PRIORITY_DEFAULT and #G_PRIORITY_HIGH.
4487 * @interval: the time between calls to the function, in milliseconds
4488 * (1/1000ths of a second)
4489 * @function: function to call
4490 * @data: data to pass to @function
4491 * @notify: (allow-none): function to call when the timeout is removed, or %NULL
4493 * Sets a function to be called at regular intervals, with the given
4494 * priority. The function is called repeatedly until it returns
4495 * %FALSE, at which point the timeout is automatically destroyed and
4496 * the function will not be called again. The @notify function is
4497 * called when the timeout is destroyed. The first call to the
4498 * function will be at the end of the first @interval.
4500 * Note that timeout functions may be delayed, due to the processing of other
4501 * event sources. Thus they should not be relied on for precise timing.
4502 * After each call to the timeout function, the time of the next
4503 * timeout is recalculated based on the current time and the given interval
4504 * (it does not try to 'catch up' time lost in delays).
4506 * This internally creates a main loop source using g_timeout_source_new()
4507 * and attaches it to the main loop context using g_source_attach(). You can
4508 * do these steps manually if you need greater control.
4510 * The interval given in terms of monotonic time, not wall clock time.
4511 * See g_get_monotonic_time().
4513 * Return value: the ID (greater than 0) of the event source.
4514 * Rename to: g_timeout_add
4517 g_timeout_add_full (gint priority,
4519 GSourceFunc function,
4521 GDestroyNotify notify)
4526 g_return_val_if_fail (function != NULL, 0);
4528 source = g_timeout_source_new (interval);
4530 if (priority != G_PRIORITY_DEFAULT)
4531 g_source_set_priority (source, priority);
4533 g_source_set_callback (source, function, data, notify);
4534 id = g_source_attach (source, NULL);
4535 g_source_unref (source);
4542 * @interval: the time between calls to the function, in milliseconds
4543 * (1/1000ths of a second)
4544 * @function: function to call
4545 * @data: data to pass to @function
4547 * Sets a function to be called at regular intervals, with the default
4548 * priority, #G_PRIORITY_DEFAULT. The function is called repeatedly
4549 * until it returns %FALSE, at which point the timeout is automatically
4550 * destroyed and the function will not be called again. The first call
4551 * to the function will be at the end of the first @interval.
4553 * Note that timeout functions may be delayed, due to the processing of other
4554 * event sources. Thus they should not be relied on for precise timing.
4555 * After each call to the timeout function, the time of the next
4556 * timeout is recalculated based on the current time and the given interval
4557 * (it does not try to 'catch up' time lost in delays).
4559 * If you want to have a timer in the "seconds" range and do not care
4560 * about the exact time of the first call of the timer, use the
4561 * g_timeout_add_seconds() function; this function allows for more
4562 * optimizations and more efficient system power usage.
4564 * This internally creates a main loop source using g_timeout_source_new()
4565 * and attaches it to the main loop context using g_source_attach(). You can
4566 * do these steps manually if you need greater control.
4568 * The interval given is in terms of monotonic time, not wall clock
4569 * time. See g_get_monotonic_time().
4571 * Return value: the ID (greater than 0) of the event source.
4574 g_timeout_add (guint32 interval,
4575 GSourceFunc function,
4578 return g_timeout_add_full (G_PRIORITY_DEFAULT,
4579 interval, function, data, NULL);
4583 * g_timeout_add_seconds_full:
4584 * @priority: the priority of the timeout source. Typically this will be in
4585 * the range between #G_PRIORITY_DEFAULT and #G_PRIORITY_HIGH.
4586 * @interval: the time between calls to the function, in seconds
4587 * @function: function to call
4588 * @data: data to pass to @function
4589 * @notify: (allow-none): function to call when the timeout is removed, or %NULL
4591 * Sets a function to be called at regular intervals, with @priority.
4592 * The function is called repeatedly until it returns %FALSE, at which
4593 * point the timeout is automatically destroyed and the function will
4594 * not be called again.
4596 * Unlike g_timeout_add(), this function operates at whole second granularity.
4597 * The initial starting point of the timer is determined by the implementation
4598 * and the implementation is expected to group multiple timers together so that
4599 * they fire all at the same time.
4600 * To allow this grouping, the @interval to the first timer is rounded
4601 * and can deviate up to one second from the specified interval.
4602 * Subsequent timer iterations will generally run at the specified interval.
4604 * Note that timeout functions may be delayed, due to the processing of other
4605 * event sources. Thus they should not be relied on for precise timing.
4606 * After each call to the timeout function, the time of the next
4607 * timeout is recalculated based on the current time and the given @interval
4609 * If you want timing more precise than whole seconds, use g_timeout_add()
4612 * The grouping of timers to fire at the same time results in a more power
4613 * and CPU efficient behavior so if your timer is in multiples of seconds
4614 * and you don't require the first timer exactly one second from now, the
4615 * use of g_timeout_add_seconds() is preferred over g_timeout_add().
4617 * This internally creates a main loop source using
4618 * g_timeout_source_new_seconds() and attaches it to the main loop context
4619 * using g_source_attach(). You can do these steps manually if you need
4622 * The interval given is in terms of monotonic time, not wall clock
4623 * time. See g_get_monotonic_time().
4625 * Return value: the ID (greater than 0) of the event source.
4627 * Rename to: g_timeout_add_seconds
4631 g_timeout_add_seconds_full (gint priority,
4633 GSourceFunc function,
4635 GDestroyNotify notify)
4640 g_return_val_if_fail (function != NULL, 0);
4642 source = g_timeout_source_new_seconds (interval);
4644 if (priority != G_PRIORITY_DEFAULT)
4645 g_source_set_priority (source, priority);
4647 g_source_set_callback (source, function, data, notify);
4648 id = g_source_attach (source, NULL);
4649 g_source_unref (source);
4655 * g_timeout_add_seconds:
4656 * @interval: the time between calls to the function, in seconds
4657 * @function: function to call
4658 * @data: data to pass to @function
4660 * Sets a function to be called at regular intervals with the default
4661 * priority, #G_PRIORITY_DEFAULT. The function is called repeatedly until
4662 * it returns %FALSE, at which point the timeout is automatically destroyed
4663 * and the function will not be called again.
4665 * This internally creates a main loop source using
4666 * g_timeout_source_new_seconds() and attaches it to the main loop context
4667 * using g_source_attach(). You can do these steps manually if you need
4668 * greater control. Also see g_timeout_add_seconds_full().
4670 * Note that the first call of the timer may not be precise for timeouts
4671 * of one second. If you need finer precision and have such a timeout,
4672 * you may want to use g_timeout_add() instead.
4674 * The interval given is in terms of monotonic time, not wall clock
4675 * time. See g_get_monotonic_time().
4677 * Return value: the ID (greater than 0) of the event source.
4682 g_timeout_add_seconds (guint interval,
4683 GSourceFunc function,
4686 g_return_val_if_fail (function != NULL, 0);
4688 return g_timeout_add_seconds_full (G_PRIORITY_DEFAULT, interval, function, data, NULL);
4691 /* Child watch functions */
4696 g_child_watch_prepare (GSource *source,
4704 g_child_watch_check (GSource *source)
4706 GChildWatchSource *child_watch_source;
4707 gboolean child_exited;
4709 child_watch_source = (GChildWatchSource *) source;
4711 child_exited = child_watch_source->poll.revents & G_IO_IN;
4718 * Note: We do _not_ check for the special value of STILL_ACTIVE
4719 * since we know that the process has exited and doing so runs into
4720 * problems if the child process "happens to return STILL_ACTIVE(259)"
4721 * as Microsoft's Platform SDK puts it.
4723 if (!GetExitCodeProcess (child_watch_source->pid, &child_status))
4725 gchar *emsg = g_win32_error_message (GetLastError ());
4726 g_warning (G_STRLOC ": GetExitCodeProcess() failed: %s", emsg);
4729 child_watch_source->child_status = -1;
4732 child_watch_source->child_status = child_status;
4735 return child_exited;
4739 g_child_watch_finalize (GSource *source)
4743 #else /* G_OS_WIN32 */
4746 wake_source (GSource *source)
4748 GMainContext *context;
4750 /* This should be thread-safe:
4752 * - if the source is currently being added to a context, that
4753 * context will be woken up anyway
4755 * - if the source is currently being destroyed, we simply need not
4758 * - the memory for the source will remain valid until after the
4759 * source finalize function was called (which would remove the
4760 * source from the global list which we are currently holding the
4763 * - the GMainContext will either be NULL or point to a live
4766 * - the GMainContext will remain valid since we hold the
4767 * main_context_list lock
4769 * Since we are holding a lot of locks here, don't try to enter any
4770 * more GMainContext functions for fear of dealock -- just hit the
4771 * GWakeup and run. Even if that's safe now, it could easily become
4772 * unsafe with some very minor changes in the future, and signal
4773 * handling is not the most well-tested codepath.
4775 G_LOCK(main_context_list);
4776 context = source->context;
4778 g_wakeup_signal (context->wakeup);
4779 G_UNLOCK(main_context_list);
4783 dispatch_unix_signals (void)
4787 /* clear this first incase another one arrives while we're processing */
4788 any_unix_signal_pending = FALSE;
4790 G_LOCK(unix_signal_lock);
4792 /* handle GChildWatchSource instances */
4793 if (unix_signal_pending[SIGCHLD])
4795 unix_signal_pending[SIGCHLD] = FALSE;
4797 /* The only way we can do this is to scan all of the children.
4799 * The docs promise that we will not reap children that we are not
4800 * explicitly watching, so that ties our hands from calling
4801 * waitpid(-1). We also can't use siginfo's si_pid field since if
4802 * multiple SIGCHLD arrive at the same time, one of them can be
4803 * dropped (since a given UNIX signal can only be pending once).
4805 for (node = unix_child_watches; node; node = node->next)
4807 GChildWatchSource *source = node->data;
4809 if (!source->child_exited)
4814 pid = waitpid (source->pid, &source->child_status, WNOHANG);
4817 source->child_exited = TRUE;
4818 wake_source ((GSource *) source);
4820 else if (pid == -1 && errno == ECHILD)
4822 g_warning ("GChildWatchSource: Exit status of a child process was requested but ECHILD was received by waitpid(). Most likely the process is ignoring SIGCHLD, or some other thread is invoking waitpid() with a nonpositive first argument; either behavior can break applications that use g_child_watch_add()/g_spawn_sync() either directly or indirectly.");
4823 source->child_exited = TRUE;
4824 source->child_status = 0;
4825 wake_source ((GSource *) source);
4828 while (pid == -1 && errno == EINTR);
4833 /* handle GUnixSignalWatchSource instances */
4834 for (node = unix_signal_watches; node; node = node->next)
4836 GUnixSignalWatchSource *source = node->data;
4838 if (!source->pending)
4840 if (unix_signal_pending[source->signum])
4842 unix_signal_pending[source->signum] = FALSE;
4843 source->pending = TRUE;
4845 wake_source ((GSource *) source);
4850 G_UNLOCK(unix_signal_lock);
4854 g_child_watch_prepare (GSource *source,
4857 GChildWatchSource *child_watch_source;
4859 child_watch_source = (GChildWatchSource *) source;
4861 return child_watch_source->child_exited;
4865 g_child_watch_check (GSource *source)
4867 GChildWatchSource *child_watch_source;
4869 child_watch_source = (GChildWatchSource *) source;
4871 return child_watch_source->child_exited;
4875 g_unix_signal_watch_prepare (GSource *source,
4878 GUnixSignalWatchSource *unix_signal_source;
4880 unix_signal_source = (GUnixSignalWatchSource *) source;
4882 return unix_signal_source->pending;
4886 g_unix_signal_watch_check (GSource *source)
4888 GUnixSignalWatchSource *unix_signal_source;
4890 unix_signal_source = (GUnixSignalWatchSource *) source;
4892 return unix_signal_source->pending;
4896 g_unix_signal_watch_dispatch (GSource *source,
4897 GSourceFunc callback,
4900 GUnixSignalWatchSource *unix_signal_source;
4903 unix_signal_source = (GUnixSignalWatchSource *) source;
4907 g_warning ("Unix signal source dispatched without callback\n"
4908 "You must call g_source_set_callback().");
4912 again = (callback) (user_data);
4914 unix_signal_source->pending = FALSE;
4920 ensure_unix_signal_handler_installed_unlocked (int signum)
4922 static sigset_t installed_signal_mask;
4923 static gboolean initialized;
4924 struct sigaction action;
4928 sigemptyset (&installed_signal_mask);
4929 g_get_worker_context ();
4933 if (sigismember (&installed_signal_mask, signum))
4936 sigaddset (&installed_signal_mask, signum);
4938 action.sa_handler = g_unix_signal_handler;
4939 sigemptyset (&action.sa_mask);
4940 action.sa_flags = SA_RESTART | SA_NOCLDSTOP;
4941 sigaction (signum, &action, NULL);
4945 _g_main_create_unix_signal_watch (int signum)
4948 GUnixSignalWatchSource *unix_signal_source;
4950 source = g_source_new (&g_unix_signal_funcs, sizeof (GUnixSignalWatchSource));
4951 unix_signal_source = (GUnixSignalWatchSource *) source;
4953 unix_signal_source->signum = signum;
4954 unix_signal_source->pending = FALSE;
4956 G_LOCK (unix_signal_lock);
4957 ensure_unix_signal_handler_installed_unlocked (signum);
4958 unix_signal_watches = g_slist_prepend (unix_signal_watches, unix_signal_source);
4959 if (unix_signal_pending[signum])
4960 unix_signal_source->pending = TRUE;
4961 unix_signal_pending[signum] = FALSE;
4962 G_UNLOCK (unix_signal_lock);
4968 g_unix_signal_watch_finalize (GSource *source)
4970 G_LOCK (unix_signal_lock);
4971 unix_signal_watches = g_slist_remove (unix_signal_watches, source);
4972 G_UNLOCK (unix_signal_lock);
4976 g_child_watch_finalize (GSource *source)
4978 G_LOCK (unix_signal_lock);
4979 unix_child_watches = g_slist_remove (unix_child_watches, source);
4980 G_UNLOCK (unix_signal_lock);
4983 #endif /* G_OS_WIN32 */
4986 g_child_watch_dispatch (GSource *source,
4987 GSourceFunc callback,
4990 GChildWatchSource *child_watch_source;
4991 GChildWatchFunc child_watch_callback = (GChildWatchFunc) callback;
4993 child_watch_source = (GChildWatchSource *) source;
4997 g_warning ("Child watch source dispatched without callback\n"
4998 "You must call g_source_set_callback().");
5002 (child_watch_callback) (child_watch_source->pid, child_watch_source->child_status, user_data);
5004 /* We never keep a child watch source around as the child is gone */
5011 g_unix_signal_handler (int signum)
5013 unix_signal_pending[signum] = TRUE;
5014 any_unix_signal_pending = TRUE;
5016 g_wakeup_signal (glib_worker_context->wakeup);
5019 #endif /* !G_OS_WIN32 */
5022 * g_child_watch_source_new:
5023 * @pid: process to watch. On POSIX the pid of a child process. On
5024 * Windows a handle for a process (which doesn't have to be a child).
5026 * Creates a new child_watch source.
5028 * The source will not initially be associated with any #GMainContext
5029 * and must be added to one with g_source_attach() before it will be
5032 * Note that child watch sources can only be used in conjunction with
5033 * <literal>g_spawn...</literal> when the %G_SPAWN_DO_NOT_REAP_CHILD
5036 * Note that on platforms where #GPid must be explicitly closed
5037 * (see g_spawn_close_pid()) @pid must not be closed while the
5038 * source is still active. Typically, you will want to call
5039 * g_spawn_close_pid() in the callback function for the source.
5041 * Note further that using g_child_watch_source_new() is not
5042 * compatible with calling <literal>waitpid</literal> with a
5043 * nonpositive first argument in the application. Calling waitpid()
5044 * for individual pids will still work fine.
5046 * Return value: the newly-created child watch source
5051 g_child_watch_source_new (GPid pid)
5053 GSource *source = g_source_new (&g_child_watch_funcs, sizeof (GChildWatchSource));
5054 GChildWatchSource *child_watch_source = (GChildWatchSource *)source;
5056 child_watch_source->pid = pid;
5059 child_watch_source->poll.fd = (gintptr) pid;
5060 child_watch_source->poll.events = G_IO_IN;
5062 g_source_add_poll (source, &child_watch_source->poll);
5063 #else /* G_OS_WIN32 */
5064 G_LOCK (unix_signal_lock);
5065 ensure_unix_signal_handler_installed_unlocked (SIGCHLD);
5066 unix_child_watches = g_slist_prepend (unix_child_watches, child_watch_source);
5067 if (waitpid (pid, &child_watch_source->child_status, WNOHANG) > 0)
5068 child_watch_source->child_exited = TRUE;
5069 G_UNLOCK (unix_signal_lock);
5070 #endif /* G_OS_WIN32 */
5076 * g_child_watch_add_full:
5077 * @priority: the priority of the idle source. Typically this will be in the
5078 * range between #G_PRIORITY_DEFAULT_IDLE and #G_PRIORITY_HIGH_IDLE.
5079 * @pid: process to watch. On POSIX the pid of a child process. On
5080 * Windows a handle for a process (which doesn't have to be a child).
5081 * @function: function to call
5082 * @data: data to pass to @function
5083 * @notify: (allow-none): function to call when the idle is removed, or %NULL
5085 * Sets a function to be called when the child indicated by @pid
5086 * exits, at the priority @priority.
5088 * If you obtain @pid from g_spawn_async() or g_spawn_async_with_pipes()
5089 * you will need to pass #G_SPAWN_DO_NOT_REAP_CHILD as flag to
5090 * the spawn function for the child watching to work.
5092 * In many programs, you will want to call g_spawn_check_exit_status()
5093 * in the callback to determine whether or not the child exited
5096 * Also, note that on platforms where #GPid must be explicitly closed
5097 * (see g_spawn_close_pid()) @pid must not be closed while the source
5098 * is still active. Typically, you should invoke g_spawn_close_pid()
5099 * in the callback function for the source.
5101 * GLib supports only a single callback per process id.
5103 * This internally creates a main loop source using
5104 * g_child_watch_source_new() and attaches it to the main loop context
5105 * using g_source_attach(). You can do these steps manually if you
5106 * need greater control.
5108 * Return value: the ID (greater than 0) of the event source.
5110 * Rename to: g_child_watch_add
5114 g_child_watch_add_full (gint priority,
5116 GChildWatchFunc function,
5118 GDestroyNotify notify)
5123 g_return_val_if_fail (function != NULL, 0);
5125 source = g_child_watch_source_new (pid);
5127 if (priority != G_PRIORITY_DEFAULT)
5128 g_source_set_priority (source, priority);
5130 g_source_set_callback (source, (GSourceFunc) function, data, notify);
5131 id = g_source_attach (source, NULL);
5132 g_source_unref (source);
5138 * g_child_watch_add:
5139 * @pid: process id to watch. On POSIX the pid of a child process. On
5140 * Windows a handle for a process (which doesn't have to be a child).
5141 * @function: function to call
5142 * @data: data to pass to @function
5144 * Sets a function to be called when the child indicated by @pid
5145 * exits, at a default priority, #G_PRIORITY_DEFAULT.
5147 * If you obtain @pid from g_spawn_async() or g_spawn_async_with_pipes()
5148 * you will need to pass #G_SPAWN_DO_NOT_REAP_CHILD as flag to
5149 * the spawn function for the child watching to work.
5151 * Note that on platforms where #GPid must be explicitly closed
5152 * (see g_spawn_close_pid()) @pid must not be closed while the
5153 * source is still active. Typically, you will want to call
5154 * g_spawn_close_pid() in the callback function for the source.
5156 * GLib supports only a single callback per process id.
5158 * This internally creates a main loop source using
5159 * g_child_watch_source_new() and attaches it to the main loop context
5160 * using g_source_attach(). You can do these steps manually if you
5161 * need greater control.
5163 * Return value: the ID (greater than 0) of the event source.
5168 g_child_watch_add (GPid pid,
5169 GChildWatchFunc function,
5172 return g_child_watch_add_full (G_PRIORITY_DEFAULT, pid, function, data, NULL);
5176 /* Idle functions */
5179 g_idle_prepare (GSource *source,
5188 g_idle_check (GSource *source)
5194 g_idle_dispatch (GSource *source,
5195 GSourceFunc callback,
5200 g_warning ("Idle source dispatched without callback\n"
5201 "You must call g_source_set_callback().");
5205 return callback (user_data);
5209 * g_idle_source_new:
5211 * Creates a new idle source.
5213 * The source will not initially be associated with any #GMainContext
5214 * and must be added to one with g_source_attach() before it will be
5215 * executed. Note that the default priority for idle sources is
5216 * %G_PRIORITY_DEFAULT_IDLE, as compared to other sources which
5217 * have a default priority of %G_PRIORITY_DEFAULT.
5219 * Return value: the newly-created idle source
5222 g_idle_source_new (void)
5226 source = g_source_new (&g_idle_funcs, sizeof (GSource));
5227 g_source_set_priority (source, G_PRIORITY_DEFAULT_IDLE);
5234 * @priority: the priority of the idle source. Typically this will be in the
5235 * range between #G_PRIORITY_DEFAULT_IDLE and #G_PRIORITY_HIGH_IDLE.
5236 * @function: function to call
5237 * @data: data to pass to @function
5238 * @notify: (allow-none): function to call when the idle is removed, or %NULL
5240 * Adds a function to be called whenever there are no higher priority
5241 * events pending. If the function returns %FALSE it is automatically
5242 * removed from the list of event sources and will not be called again.
5244 * This internally creates a main loop source using g_idle_source_new()
5245 * and attaches it to the main loop context using g_source_attach().
5246 * You can do these steps manually if you need greater control.
5248 * Return value: the ID (greater than 0) of the event source.
5249 * Rename to: g_idle_add
5252 g_idle_add_full (gint priority,
5253 GSourceFunc function,
5255 GDestroyNotify notify)
5260 g_return_val_if_fail (function != NULL, 0);
5262 source = g_idle_source_new ();
5264 if (priority != G_PRIORITY_DEFAULT_IDLE)
5265 g_source_set_priority (source, priority);
5267 g_source_set_callback (source, function, data, notify);
5268 id = g_source_attach (source, NULL);
5269 g_source_unref (source);
5276 * @function: function to call
5277 * @data: data to pass to @function.
5279 * Adds a function to be called whenever there are no higher priority
5280 * events pending to the default main loop. The function is given the
5281 * default idle priority, #G_PRIORITY_DEFAULT_IDLE. If the function
5282 * returns %FALSE it is automatically removed from the list of event
5283 * sources and will not be called again.
5285 * This internally creates a main loop source using g_idle_source_new()
5286 * and attaches it to the main loop context using g_source_attach().
5287 * You can do these steps manually if you need greater control.
5289 * Return value: the ID (greater than 0) of the event source.
5292 g_idle_add (GSourceFunc function,
5295 return g_idle_add_full (G_PRIORITY_DEFAULT_IDLE, function, data, NULL);
5299 * g_idle_remove_by_data:
5300 * @data: the data for the idle source's callback.
5302 * Removes the idle function with the given data.
5304 * Return value: %TRUE if an idle source was found and removed.
5307 g_idle_remove_by_data (gpointer data)
5309 return g_source_remove_by_funcs_user_data (&g_idle_funcs, data);
5313 * g_main_context_invoke:
5314 * @context: (allow-none): a #GMainContext, or %NULL
5315 * @function: function to call
5316 * @data: data to pass to @function
5318 * Invokes a function in such a way that @context is owned during the
5319 * invocation of @function.
5321 * If @context is %NULL then the global default main context — as
5322 * returned by g_main_context_default() — is used.
5324 * If @context is owned by the current thread, @function is called
5325 * directly. Otherwise, if @context is the thread-default main context
5326 * of the current thread and g_main_context_acquire() succeeds, then
5327 * @function is called and g_main_context_release() is called
5330 * In any other case, an idle source is created to call @function and
5331 * that source is attached to @context (presumably to be run in another
5332 * thread). The idle source is attached with #G_PRIORITY_DEFAULT
5333 * priority. If you want a different priority, use
5334 * g_main_context_invoke_full().
5336 * Note that, as with normal idle functions, @function should probably
5337 * return %FALSE. If it returns %TRUE, it will be continuously run in a
5338 * loop (and may prevent this call from returning).
5343 g_main_context_invoke (GMainContext *context,
5344 GSourceFunc function,
5347 g_main_context_invoke_full (context,
5349 function, data, NULL);
5353 * g_main_context_invoke_full:
5354 * @context: (allow-none): a #GMainContext, or %NULL
5355 * @priority: the priority at which to run @function
5356 * @function: function to call
5357 * @data: data to pass to @function
5358 * @notify: (allow-none): a function to call when @data is no longer in use, or %NULL.
5360 * Invokes a function in such a way that @context is owned during the
5361 * invocation of @function.
5363 * This function is the same as g_main_context_invoke() except that it
5364 * lets you specify the priority incase @function ends up being
5365 * scheduled as an idle and also lets you give a #GDestroyNotify for @data.
5367 * @notify should not assume that it is called from any particular
5368 * thread or with any particular context acquired.
5373 g_main_context_invoke_full (GMainContext *context,
5375 GSourceFunc function,
5377 GDestroyNotify notify)
5379 g_return_if_fail (function != NULL);
5382 context = g_main_context_default ();
5384 if (g_main_context_is_owner (context))
5386 while (function (data));
5393 GMainContext *thread_default;
5395 thread_default = g_main_context_get_thread_default ();
5397 if (!thread_default)
5398 thread_default = g_main_context_default ();
5400 if (thread_default == context && g_main_context_acquire (context))
5402 while (function (data));
5404 g_main_context_release (context);
5413 source = g_idle_source_new ();
5414 g_source_set_priority (source, priority);
5415 g_source_set_callback (source, function, data, notify);
5416 g_source_attach (source, context);
5417 g_source_unref (source);
5423 glib_worker_main (gpointer data)
5427 g_main_context_iteration (glib_worker_context, TRUE);
5430 if (any_unix_signal_pending)
5431 dispatch_unix_signals ();
5435 return NULL; /* worst GCC warning message ever... */
5439 g_get_worker_context (void)
5441 static gsize initialised;
5443 if (g_once_init_enter (&initialised))
5445 /* mask all signals in the worker thread */
5451 pthread_sigmask (SIG_SETMASK, &all, &prev_mask);
5453 glib_worker_context = g_main_context_new ();
5454 g_thread_new ("gmain", glib_worker_main, NULL);
5456 pthread_sigmask (SIG_SETMASK, &prev_mask, NULL);
5458 g_once_init_leave (&initialised, TRUE);
5461 return glib_worker_context;