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 /* for pipe2; need to define it first to avoid
36 * other headers pulling in unistd.h
38 /* The meaning of_GNU_SOURCE that is intended here is present only on
39 * Linux; avoid the possibility that some misguided header in MinGW
40 * looks at it. Ideally we should define _GNU_SOURCE only on platforms
41 * where we know what it means and that is what we want here
42 * (i.e. Linux with glibc). After all, there might be some other POSIX
43 * platform even where _GNU_SOURCE is used for some unrelated change
44 * in semantics that isn't wanted. Sigh.
50 #include "glibconfig.h"
52 /* Uncomment the next line (and the corresponding line in gpoll.c) to
53 * enable debugging printouts if the environment variable
54 * G_MAIN_POLL_DEBUG is set to some value.
56 /* #define G_MAIN_POLL_DEBUG */
59 /* Always enable debugging printout on Windows, as it is more often
62 #define G_MAIN_POLL_DEBUG
66 #include <sys/types.h>
69 #ifdef HAVE_SYS_TIME_H
71 #endif /* HAVE_SYS_TIME_H */
74 #endif /* HAVE_UNISTD_H */
80 #endif /* G_OS_WIN32 */
83 #include <sys/socket.h>
85 #endif /* G_OS_BEOS */
95 #include "giochannel.h"
99 #include "gstrfuncs.h"
100 #include "gtestutils.h"
101 #include "gthreadprivate.h"
107 #ifdef G_MAIN_POLL_DEBUG
113 * @title: The Main Event Loop
114 * @short_description: manages all available sources of events
116 * The main event loop manages all the available sources of events for
117 * GLib and GTK+ applications. These events can come from any number of
118 * different types of sources such as file descriptors (plain files,
119 * pipes or sockets) and timeouts. New types of event sources can also
120 * be added using g_source_attach().
122 * To allow multiple independent sets of sources to be handled in
123 * different threads, each source is associated with a #GMainContext.
124 * A GMainContext can only be running in a single thread, but
125 * sources can be added to it and removed from it from other threads.
127 * Each event source is assigned a priority. The default priority,
128 * #G_PRIORITY_DEFAULT, is 0. Values less than 0 denote higher priorities.
129 * Values greater than 0 denote lower priorities. Events from high priority
130 * sources are always processed before events from lower priority sources.
132 * Idle functions can also be added, and assigned a priority. These will
133 * be run whenever no events with a higher priority are ready to be processed.
135 * The #GMainLoop data type represents a main event loop. A GMainLoop is
136 * created with g_main_loop_new(). After adding the initial event sources,
137 * g_main_loop_run() is called. This continuously checks for new events from
138 * each of the event sources and dispatches them. Finally, the processing of
139 * an event from one of the sources leads to a call to g_main_loop_quit() to
140 * exit the main loop, and g_main_loop_run() returns.
142 * It is possible to create new instances of #GMainLoop recursively.
143 * This is often used in GTK+ applications when showing modal dialog
144 * boxes. Note that event sources are associated with a particular
145 * #GMainContext, and will be checked and dispatched for all main
146 * loops associated with that GMainContext.
148 * GTK+ contains wrappers of some of these functions, e.g. gtk_main(),
149 * gtk_main_quit() and gtk_events_pending().
151 * <refsect2><title>Creating new source types</title>
152 * <para>One of the unusual features of the #GMainLoop functionality
153 * is that new types of event source can be created and used in
154 * addition to the builtin type of event source. A new event source
155 * type is used for handling GDK events. A new source type is created
156 * by <firstterm>deriving</firstterm> from the #GSource structure.
157 * The derived type of source is represented by a structure that has
158 * the #GSource structure as a first element, and other elements specific
159 * to the new source type. To create an instance of the new source type,
160 * call g_source_new() passing in the size of the derived structure and
161 * a table of functions. These #GSourceFuncs determine the behavior of
162 * the new source type.</para>
163 * <para>New source types basically interact with the main context
164 * in two ways. Their prepare function in #GSourceFuncs can set a timeout
165 * to determine the maximum amount of time that the main loop will sleep
166 * before checking the source again. In addition, or as well, the source
167 * can add file descriptors to the set that the main context checks using
168 * g_source_add_poll().</para>
170 * <refsect2><title>Customizing the main loop iteration</title>
171 * <para>Single iterations of a #GMainContext can be run with
172 * g_main_context_iteration(). In some cases, more detailed control
173 * of exactly how the details of the main loop work is desired, for
174 * instance, when integrating the #GMainLoop with an external main loop.
175 * In such cases, you can call the component functions of
176 * g_main_context_iteration() directly. These functions are
177 * g_main_context_prepare(), g_main_context_query(),
178 * g_main_context_check() and g_main_context_dispatch().</para>
179 * <para>The operation of these functions can best be seen in terms
180 * of a state diagram, as shown in <xref linkend="mainloop-states"/>.</para>
181 * <figure id="mainloop-states"><title>States of a Main Context</title>
182 * <graphic fileref="mainloop-states.gif" format="GIF"></graphic>
189 typedef struct _GTimeoutSource GTimeoutSource;
190 typedef struct _GChildWatchSource GChildWatchSource;
191 typedef struct _GPollRec GPollRec;
192 typedef struct _GSourceCallback GSourceCallback;
196 G_SOURCE_READY = 1 << G_HOOK_FLAG_USER_SHIFT,
197 G_SOURCE_CAN_RECURSE = 1 << (G_HOOK_FLAG_USER_SHIFT + 1)
200 #ifdef G_THREADS_ENABLED
201 typedef struct _GMainWaiter GMainWaiter;
210 typedef struct _GMainDispatch GMainDispatch;
212 struct _GMainDispatch
215 GSList *dispatching_sources; /* stack of current sources */
218 #ifdef G_MAIN_POLL_DEBUG
219 gboolean _g_main_poll_debug = FALSE;
224 #ifdef G_THREADS_ENABLED
225 /* The following lock is used for both the list of sources
226 * and the list of poll records
237 GPtrArray *pending_dispatches;
238 gint timeout; /* Timeout for current iteration */
241 GSource *source_list;
242 gint in_check_or_prepare;
244 GPollRec *poll_records;
245 guint n_poll_records;
246 GPollFD *cached_poll_array;
247 guint cached_poll_array_size;
249 #ifdef G_THREADS_ENABLED
251 /* this pipe is used to wake up the main loop when a source is added.
253 gint wake_up_pipe[2];
254 #else /* G_OS_WIN32 */
255 HANDLE wake_up_semaphore;
256 #endif /* G_OS_WIN32 */
259 gboolean poll_waiting;
261 /* Flag indicating whether the set of fd's changed during a poll */
262 gboolean poll_changed;
263 #endif /* G_THREADS_ENABLED */
268 gboolean time_is_fresh;
270 gboolean real_time_is_fresh;
273 struct _GSourceCallback
278 GDestroyNotify notify;
283 GMainContext *context;
288 struct _GTimeoutSource
296 struct _GChildWatchSource
303 #else /* G_OS_WIN32 */
305 gboolean child_exited;
306 #endif /* G_OS_WIN32 */
316 #ifdef G_THREADS_ENABLED
317 #define LOCK_CONTEXT(context) g_static_mutex_lock (&context->mutex)
318 #define UNLOCK_CONTEXT(context) g_static_mutex_unlock (&context->mutex)
319 #define G_THREAD_SELF g_thread_self ()
321 #define LOCK_CONTEXT(context) (void)0
322 #define UNLOCK_CONTEXT(context) (void)0
323 #define G_THREAD_SELF NULL
326 #define SOURCE_DESTROYED(source) (((source)->flags & G_HOOK_FLAG_ACTIVE) == 0)
327 #define SOURCE_BLOCKED(source) (((source)->flags & G_HOOK_FLAG_IN_CALL) != 0 && \
328 ((source)->flags & G_SOURCE_CAN_RECURSE) == 0)
330 #define SOURCE_UNREF(source, context) \
332 if ((source)->ref_count > 1) \
333 (source)->ref_count--; \
335 g_source_unref_internal ((source), (context), TRUE); \
339 /* Forward declarations */
341 static void g_source_unref_internal (GSource *source,
342 GMainContext *context,
344 static void g_source_destroy_internal (GSource *source,
345 GMainContext *context,
347 static void g_main_context_poll (GMainContext *context,
352 static void g_main_context_add_poll_unlocked (GMainContext *context,
355 static void g_main_context_remove_poll_unlocked (GMainContext *context,
357 static void g_main_context_wakeup_unlocked (GMainContext *context);
359 static gboolean g_timeout_prepare (GSource *source,
361 static gboolean g_timeout_check (GSource *source);
362 static gboolean g_timeout_dispatch (GSource *source,
363 GSourceFunc callback,
365 static gboolean g_child_watch_prepare (GSource *source,
367 static gboolean g_child_watch_check (GSource *source);
368 static gboolean g_child_watch_dispatch (GSource *source,
369 GSourceFunc callback,
371 static gboolean g_idle_prepare (GSource *source,
373 static gboolean g_idle_check (GSource *source);
374 static gboolean g_idle_dispatch (GSource *source,
375 GSourceFunc callback,
378 G_LOCK_DEFINE_STATIC (main_loop);
379 static GMainContext *default_main_context;
380 static GSList *main_contexts_without_pipe = NULL;
383 /* Child status monitoring code */
385 CHILD_WATCH_UNINITIALIZED,
386 CHILD_WATCH_INITIALIZED_SINGLE,
387 CHILD_WATCH_INITIALIZED_THREADED
389 static gint child_watch_init_state = CHILD_WATCH_UNINITIALIZED;
390 static gint child_watch_count = 1;
391 static gint child_watch_wake_up_pipe[2] = {0, 0};
392 #endif /* !G_OS_WIN32 */
393 G_LOCK_DEFINE_STATIC (main_context_list);
394 static GSList *main_context_list = NULL;
396 GSourceFuncs g_timeout_funcs =
404 GSourceFuncs g_child_watch_funcs =
406 g_child_watch_prepare,
408 g_child_watch_dispatch,
412 GSourceFuncs g_idle_funcs =
421 * g_main_context_ref:
422 * @context: a #GMainContext
424 * Increases the reference count on a #GMainContext object by one.
426 * Returns: the @context that was passed in (since 2.6)
429 g_main_context_ref (GMainContext *context)
431 g_return_val_if_fail (context != NULL, NULL);
432 g_return_val_if_fail (g_atomic_int_get (&context->ref_count) > 0, NULL);
434 g_atomic_int_inc (&context->ref_count);
440 poll_rec_list_free (GMainContext *context,
443 g_slice_free_chain (GPollRec, list, next);
447 * g_main_context_unref:
448 * @context: a #GMainContext
450 * Decreases the reference count on a #GMainContext object by one. If
451 * the result is zero, free the context and free all associated memory.
454 g_main_context_unref (GMainContext *context)
457 g_return_if_fail (context != NULL);
458 g_return_if_fail (g_atomic_int_get (&context->ref_count) > 0);
460 if (!g_atomic_int_dec_and_test (&context->ref_count))
463 G_LOCK (main_context_list);
464 main_context_list = g_slist_remove (main_context_list, context);
465 G_UNLOCK (main_context_list);
467 source = context->source_list;
470 GSource *next = source->next;
471 g_source_destroy_internal (source, context, FALSE);
475 #ifdef G_THREADS_ENABLED
476 g_static_mutex_free (&context->mutex);
479 g_ptr_array_free (context->pending_dispatches, TRUE);
480 g_free (context->cached_poll_array);
482 poll_rec_list_free (context, context->poll_records);
484 #ifdef G_THREADS_ENABLED
485 if (g_thread_supported())
488 close (context->wake_up_pipe[0]);
489 close (context->wake_up_pipe[1]);
491 CloseHandle (context->wake_up_semaphore);
495 main_contexts_without_pipe = g_slist_remove (main_contexts_without_pipe,
498 if (context->cond != NULL)
499 g_cond_free (context->cond);
505 #ifdef G_THREADS_ENABLED
507 g_main_context_init_pipe (GMainContext *context)
510 if (context->wake_up_pipe[0] != -1)
514 /* if this fails, we fall through and try pipe */
515 pipe2 (context->wake_up_pipe, O_CLOEXEC);
517 if (context->wake_up_pipe[0] == -1)
519 if (pipe (context->wake_up_pipe) < 0)
520 g_error ("Cannot create pipe main loop wake-up: %s\n",
523 fcntl (context->wake_up_pipe[0], F_SETFD, FD_CLOEXEC);
524 fcntl (context->wake_up_pipe[1], F_SETFD, FD_CLOEXEC);
527 context->wake_up_rec.fd = context->wake_up_pipe[0];
528 context->wake_up_rec.events = G_IO_IN;
530 if (context->wake_up_semaphore != NULL)
532 context->wake_up_semaphore = CreateSemaphore (NULL, 0, 100, NULL);
533 if (context->wake_up_semaphore == NULL)
534 g_error ("Cannot create wake-up semaphore: %s",
535 g_win32_error_message (GetLastError ()));
536 context->wake_up_rec.fd = (gintptr) context->wake_up_semaphore;
537 context->wake_up_rec.events = G_IO_IN;
539 if (_g_main_poll_debug)
540 g_print ("wake-up semaphore: %p\n", context->wake_up_semaphore);
542 g_main_context_add_poll_unlocked (context, 0, &context->wake_up_rec);
546 _g_main_thread_init (void)
548 GSList *curr = main_contexts_without_pipe;
551 g_main_context_init_pipe ((GMainContext *)curr->data);
554 g_slist_free (main_contexts_without_pipe);
555 main_contexts_without_pipe = NULL;
557 #endif /* G_THREADS_ENABLED */
560 * g_main_context_new:
562 * Creates a new #GMainContext structure.
564 * Return value: the new #GMainContext
567 g_main_context_new (void)
569 GMainContext *context = g_new0 (GMainContext, 1);
571 #ifdef G_MAIN_POLL_DEBUG
573 static gboolean beenhere = FALSE;
577 if (getenv ("G_MAIN_POLL_DEBUG") != NULL)
578 _g_main_poll_debug = TRUE;
584 #ifdef G_THREADS_ENABLED
585 g_static_mutex_init (&context->mutex);
587 context->owner = NULL;
588 context->waiters = NULL;
591 context->wake_up_pipe[0] = -1;
592 context->wake_up_pipe[1] = -1;
594 context->wake_up_semaphore = NULL;
598 context->ref_count = 1;
600 context->next_id = 1;
602 context->source_list = NULL;
604 context->poll_func = g_poll;
606 context->cached_poll_array = NULL;
607 context->cached_poll_array_size = 0;
609 context->pending_dispatches = g_ptr_array_new ();
611 context->time_is_fresh = FALSE;
612 context->real_time_is_fresh = FALSE;
614 #ifdef G_THREADS_ENABLED
615 if (g_thread_supported ())
616 g_main_context_init_pipe (context);
618 main_contexts_without_pipe = g_slist_prepend (main_contexts_without_pipe,
622 G_LOCK (main_context_list);
623 main_context_list = g_slist_append (main_context_list, context);
625 #ifdef G_MAIN_POLL_DEBUG
626 if (_g_main_poll_debug)
627 g_print ("created context=%p\n", context);
630 G_UNLOCK (main_context_list);
636 * g_main_context_default:
638 * Returns the global default main context. This is the main context
639 * used for main loop functions when a main loop is not explicitly
640 * specified, and corresponds to the "main" main loop. See also
641 * g_main_context_get_thread_default().
643 * Return value: the global default main context.
646 g_main_context_default (void)
652 if (!default_main_context)
654 default_main_context = g_main_context_new ();
655 #ifdef G_MAIN_POLL_DEBUG
656 if (_g_main_poll_debug)
657 g_print ("default context=%p\n", default_main_context);
661 G_UNLOCK (main_loop);
663 return default_main_context;
666 static GStaticPrivate thread_context_stack = G_STATIC_PRIVATE_INIT;
669 free_context_stack (gpointer data)
671 GQueue *stack = data;
672 GMainContext *context;
674 while (!g_queue_is_empty (stack))
676 context = g_queue_pop_head (stack);
677 g_main_context_release (context);
679 g_main_context_unref (context);
681 g_queue_free (stack);
685 * g_main_context_push_thread_default:
686 * @context: a #GMainContext, or %NULL for the global default context
688 * Acquires @context and sets it as the thread-default context for the
689 * current thread. This will cause certain asynchronous operations
690 * (such as most <link linkend="gio">gio</link>-based I/O) which are
691 * started in this thread to run under @context and deliver their
692 * results to its main loop, rather than running under the global
693 * default context in the main thread. Note that calling this function
694 * changes the context returned by
695 * g_main_context_get_thread_default(), <emphasis>not</emphasis> the
696 * one returned by g_main_context_default(), so it does not affect the
697 * context used by functions like g_idle_add().
699 * Normally you would call this function shortly after creating a new
700 * thread, passing it a #GMainContext which will be run by a
701 * #GMainLoop in that thread, to set a new default context for all
702 * async operations in that thread. (In this case, you don't need to
703 * ever call g_main_context_pop_thread_default().) In some cases
704 * however, you may want to schedule a single operation in a
705 * non-default context, or temporarily use a non-default context in
706 * the main thread. In that case, you can wrap the call to the
707 * asynchronous operation inside a
708 * g_main_context_push_thread_default() /
709 * g_main_context_pop_thread_default() pair, but it is up to you to
710 * ensure that no other asynchronous operations accidentally get
711 * started while the non-default context is active.
713 * Beware that libraries that predate this function may not correctly
714 * handle being used from a thread with a thread-default context. Eg,
715 * see g_file_supports_thread_contexts().
720 g_main_context_push_thread_default (GMainContext *context)
723 gboolean acquired_context;
725 acquired_context = g_main_context_acquire (context);
726 g_return_if_fail (acquired_context);
728 if (context == g_main_context_default ())
731 g_main_context_ref (context);
733 stack = g_static_private_get (&thread_context_stack);
736 stack = g_queue_new ();
737 g_static_private_set (&thread_context_stack, stack,
741 g_queue_push_head (stack, context);
745 * g_main_context_pop_thread_default:
746 * @context: a #GMainContext object, or %NULL
748 * Pops @context off the thread-default context stack (verifying that
749 * it was on the top of the stack).
754 g_main_context_pop_thread_default (GMainContext *context)
758 if (context == g_main_context_default ())
761 stack = g_static_private_get (&thread_context_stack);
763 g_return_if_fail (stack != NULL);
764 g_return_if_fail (g_queue_peek_head (stack) == context);
766 g_queue_pop_head (stack);
768 g_main_context_release (context);
770 g_main_context_unref (context);
774 * g_main_context_get_thread_default:
776 * Gets the thread-default #GMainContext for this thread. Asynchronous
777 * operations that want to be able to be run in contexts other than
778 * the default one should call this method to get a #GMainContext to
779 * add their #GSource<!-- -->s to. (Note that even in single-threaded
780 * programs applications may sometimes want to temporarily push a
781 * non-default context, so it is not safe to assume that this will
782 * always return %NULL if threads are not initialized.)
784 * Returns: the thread-default #GMainContext, or %NULL if the
785 * thread-default context is the global default context.
790 g_main_context_get_thread_default (void)
794 stack = g_static_private_get (&thread_context_stack);
796 return g_queue_peek_head (stack);
801 /* Hooks for adding to the main loop */
805 * @source_funcs: structure containing functions that implement
806 * the sources behavior.
807 * @struct_size: size of the #GSource structure to create.
809 * Creates a new #GSource structure. The size is specified to
810 * allow creating structures derived from #GSource that contain
811 * additional data. The size passed in must be at least
812 * <literal>sizeof (GSource)</literal>.
814 * The source will not initially be associated with any #GMainContext
815 * and must be added to one with g_source_attach() before it will be
818 * Return value: the newly-created #GSource.
821 g_source_new (GSourceFuncs *source_funcs,
826 g_return_val_if_fail (source_funcs != NULL, NULL);
827 g_return_val_if_fail (struct_size >= sizeof (GSource), NULL);
829 source = (GSource*) g_malloc0 (struct_size);
831 source->source_funcs = source_funcs;
832 source->ref_count = 1;
834 source->priority = G_PRIORITY_DEFAULT;
836 source->flags = G_HOOK_FLAG_ACTIVE;
838 /* NULL/0 initialization for all other fields */
843 /* Holds context's lock
846 g_source_list_add (GSource *source,
847 GMainContext *context)
849 GSource *tmp_source, *last_source;
852 tmp_source = context->source_list;
853 while (tmp_source && tmp_source->priority <= source->priority)
855 last_source = tmp_source;
856 tmp_source = tmp_source->next;
859 source->next = tmp_source;
861 tmp_source->prev = source;
863 source->prev = last_source;
865 last_source->next = source;
867 context->source_list = source;
870 /* Holds context's lock
873 g_source_list_remove (GSource *source,
874 GMainContext *context)
877 source->prev->next = source->next;
879 context->source_list = source->next;
882 source->next->prev = source->prev;
890 * @source: a #GSource
891 * @context: a #GMainContext (if %NULL, the default context will be used)
893 * Adds a #GSource to a @context so that it will be executed within
894 * that context. Remove it by calling g_source_destroy().
896 * Return value: the ID (greater than 0) for the source within the
900 g_source_attach (GSource *source,
901 GMainContext *context)
906 g_return_val_if_fail (source->context == NULL, 0);
907 g_return_val_if_fail (!SOURCE_DESTROYED (source), 0);
910 context = g_main_context_default ();
912 LOCK_CONTEXT (context);
914 source->context = context;
915 result = source->source_id = context->next_id++;
918 g_source_list_add (source, context);
920 tmp_list = source->poll_fds;
923 g_main_context_add_poll_unlocked (context, source->priority, tmp_list->data);
924 tmp_list = tmp_list->next;
927 #ifdef G_THREADS_ENABLED
928 /* Now wake up the main loop if it is waiting in the poll() */
929 g_main_context_wakeup_unlocked (context);
932 UNLOCK_CONTEXT (context);
938 g_source_destroy_internal (GSource *source,
939 GMainContext *context,
943 LOCK_CONTEXT (context);
945 if (!SOURCE_DESTROYED (source))
948 gpointer old_cb_data;
949 GSourceCallbackFuncs *old_cb_funcs;
951 source->flags &= ~G_HOOK_FLAG_ACTIVE;
953 old_cb_data = source->callback_data;
954 old_cb_funcs = source->callback_funcs;
956 source->callback_data = NULL;
957 source->callback_funcs = NULL;
961 UNLOCK_CONTEXT (context);
962 old_cb_funcs->unref (old_cb_data);
963 LOCK_CONTEXT (context);
966 if (!SOURCE_BLOCKED (source))
968 tmp_list = source->poll_fds;
971 g_main_context_remove_poll_unlocked (context, tmp_list->data);
972 tmp_list = tmp_list->next;
976 g_source_unref_internal (source, context, TRUE);
980 UNLOCK_CONTEXT (context);
985 * @source: a #GSource
987 * Removes a source from its #GMainContext, if any, and mark it as
988 * destroyed. The source cannot be subsequently added to another
992 g_source_destroy (GSource *source)
994 GMainContext *context;
996 g_return_if_fail (source != NULL);
998 context = source->context;
1001 g_source_destroy_internal (source, context, FALSE);
1003 source->flags &= ~G_HOOK_FLAG_ACTIVE;
1008 * @source: a #GSource
1010 * Returns the numeric ID for a particular source. The ID of a source
1011 * is a positive integer which is unique within a particular main loop
1012 * context. The reverse
1013 * mapping from ID to source is done by g_main_context_find_source_by_id().
1015 * Return value: the ID (greater than 0) for the source
1018 g_source_get_id (GSource *source)
1022 g_return_val_if_fail (source != NULL, 0);
1023 g_return_val_if_fail (source->context != NULL, 0);
1025 LOCK_CONTEXT (source->context);
1026 result = source->source_id;
1027 UNLOCK_CONTEXT (source->context);
1033 * g_source_get_context:
1034 * @source: a #GSource
1036 * Gets the #GMainContext with which the source is associated.
1037 * Calling this function on a destroyed source is an error.
1039 * Return value: the #GMainContext with which the source is associated,
1040 * or %NULL if the context has not yet been added
1044 g_source_get_context (GSource *source)
1046 g_return_val_if_fail (!SOURCE_DESTROYED (source), NULL);
1048 return source->context;
1052 * g_source_add_poll:
1053 * @source:a #GSource
1054 * @fd: a #GPollFD structure holding information about a file
1055 * descriptor to watch.
1057 * Adds a file descriptor to the set of file descriptors polled for
1058 * this source. This is usually combined with g_source_new() to add an
1059 * event source. The event source's check function will typically test
1060 * the @revents field in the #GPollFD struct and return %TRUE if events need
1064 g_source_add_poll (GSource *source,
1067 GMainContext *context;
1069 g_return_if_fail (source != NULL);
1070 g_return_if_fail (fd != NULL);
1071 g_return_if_fail (!SOURCE_DESTROYED (source));
1073 context = source->context;
1076 LOCK_CONTEXT (context);
1078 source->poll_fds = g_slist_prepend (source->poll_fds, fd);
1082 if (!SOURCE_BLOCKED (source))
1083 g_main_context_add_poll_unlocked (context, source->priority, fd);
1084 UNLOCK_CONTEXT (context);
1089 * g_source_remove_poll:
1090 * @source:a #GSource
1091 * @fd: a #GPollFD structure previously passed to g_source_add_poll().
1093 * Removes a file descriptor from the set of file descriptors polled for
1097 g_source_remove_poll (GSource *source,
1100 GMainContext *context;
1102 g_return_if_fail (source != NULL);
1103 g_return_if_fail (fd != NULL);
1104 g_return_if_fail (!SOURCE_DESTROYED (source));
1106 context = source->context;
1109 LOCK_CONTEXT (context);
1111 source->poll_fds = g_slist_remove (source->poll_fds, fd);
1115 if (!SOURCE_BLOCKED (source))
1116 g_main_context_remove_poll_unlocked (context, fd);
1117 UNLOCK_CONTEXT (context);
1122 * g_source_set_callback_indirect:
1123 * @source: the source
1124 * @callback_data: pointer to callback data "object"
1125 * @callback_funcs: functions for reference counting @callback_data
1126 * and getting the callback and data
1128 * Sets the callback function storing the data as a refcounted callback
1129 * "object". This is used internally. Note that calling
1130 * g_source_set_callback_indirect() assumes
1131 * an initial reference count on @callback_data, and thus
1132 * @callback_funcs->unref will eventually be called once more
1133 * than @callback_funcs->ref.
1136 g_source_set_callback_indirect (GSource *source,
1137 gpointer callback_data,
1138 GSourceCallbackFuncs *callback_funcs)
1140 GMainContext *context;
1141 gpointer old_cb_data;
1142 GSourceCallbackFuncs *old_cb_funcs;
1144 g_return_if_fail (source != NULL);
1145 g_return_if_fail (callback_funcs != NULL || callback_data == NULL);
1147 context = source->context;
1150 LOCK_CONTEXT (context);
1152 old_cb_data = source->callback_data;
1153 old_cb_funcs = source->callback_funcs;
1155 source->callback_data = callback_data;
1156 source->callback_funcs = callback_funcs;
1159 UNLOCK_CONTEXT (context);
1162 old_cb_funcs->unref (old_cb_data);
1166 g_source_callback_ref (gpointer cb_data)
1168 GSourceCallback *callback = cb_data;
1170 callback->ref_count++;
1175 g_source_callback_unref (gpointer cb_data)
1177 GSourceCallback *callback = cb_data;
1179 callback->ref_count--;
1180 if (callback->ref_count == 0)
1182 if (callback->notify)
1183 callback->notify (callback->data);
1189 g_source_callback_get (gpointer cb_data,
1194 GSourceCallback *callback = cb_data;
1196 *func = callback->func;
1197 *data = callback->data;
1200 static GSourceCallbackFuncs g_source_callback_funcs = {
1201 g_source_callback_ref,
1202 g_source_callback_unref,
1203 g_source_callback_get,
1207 * g_source_set_callback:
1208 * @source: the source
1209 * @func: a callback function
1210 * @data: the data to pass to callback function
1211 * @notify: a function to call when @data is no longer in use, or %NULL.
1213 * Sets the callback function for a source. The callback for a source is
1214 * called from the source's dispatch function.
1216 * The exact type of @func depends on the type of source; ie. you
1217 * should not count on @func being called with @data as its first
1220 * Typically, you won't use this function. Instead use functions specific
1221 * to the type of source you are using.
1224 g_source_set_callback (GSource *source,
1227 GDestroyNotify notify)
1229 GSourceCallback *new_callback;
1231 g_return_if_fail (source != NULL);
1233 new_callback = g_new (GSourceCallback, 1);
1235 new_callback->ref_count = 1;
1236 new_callback->func = func;
1237 new_callback->data = data;
1238 new_callback->notify = notify;
1240 g_source_set_callback_indirect (source, new_callback, &g_source_callback_funcs);
1245 * g_source_set_funcs:
1246 * @source: a #GSource
1247 * @funcs: the new #GSourceFuncs
1249 * Sets the source functions (can be used to override
1250 * default implementations) of an unattached source.
1255 g_source_set_funcs (GSource *source,
1256 GSourceFuncs *funcs)
1258 g_return_if_fail (source != NULL);
1259 g_return_if_fail (source->context == NULL);
1260 g_return_if_fail (source->ref_count > 0);
1261 g_return_if_fail (funcs != NULL);
1263 source->source_funcs = funcs;
1267 * g_source_set_priority:
1268 * @source: a #GSource
1269 * @priority: the new priority.
1271 * Sets the priority of a source. While the main loop is being
1272 * run, a source will be dispatched if it is ready to be dispatched and no sources
1273 * at a higher (numerically smaller) priority are ready to be dispatched.
1276 g_source_set_priority (GSource *source,
1280 GMainContext *context;
1282 g_return_if_fail (source != NULL);
1284 context = source->context;
1287 LOCK_CONTEXT (context);
1289 source->priority = priority;
1293 /* Remove the source from the context's source and then
1294 * add it back so it is sorted in the correct plcae
1296 g_source_list_remove (source, source->context);
1297 g_source_list_add (source, source->context);
1299 if (!SOURCE_BLOCKED (source))
1301 tmp_list = source->poll_fds;
1304 g_main_context_remove_poll_unlocked (context, tmp_list->data);
1305 g_main_context_add_poll_unlocked (context, priority, tmp_list->data);
1307 tmp_list = tmp_list->next;
1311 UNLOCK_CONTEXT (source->context);
1316 * g_source_get_priority:
1317 * @source: a #GSource
1319 * Gets the priority of a source.
1321 * Return value: the priority of the source
1324 g_source_get_priority (GSource *source)
1326 g_return_val_if_fail (source != NULL, 0);
1328 return source->priority;
1332 * g_source_set_can_recurse:
1333 * @source: a #GSource
1334 * @can_recurse: whether recursion is allowed for this source
1336 * Sets whether a source can be called recursively. If @can_recurse is
1337 * %TRUE, then while the source is being dispatched then this source
1338 * will be processed normally. Otherwise, all processing of this
1339 * source is blocked until the dispatch function returns.
1342 g_source_set_can_recurse (GSource *source,
1343 gboolean can_recurse)
1345 GMainContext *context;
1347 g_return_if_fail (source != NULL);
1349 context = source->context;
1352 LOCK_CONTEXT (context);
1355 source->flags |= G_SOURCE_CAN_RECURSE;
1357 source->flags &= ~G_SOURCE_CAN_RECURSE;
1360 UNLOCK_CONTEXT (context);
1364 * g_source_get_can_recurse:
1365 * @source: a #GSource
1367 * Checks whether a source is allowed to be called recursively.
1368 * see g_source_set_can_recurse().
1370 * Return value: whether recursion is allowed.
1373 g_source_get_can_recurse (GSource *source)
1375 g_return_val_if_fail (source != NULL, FALSE);
1377 return (source->flags & G_SOURCE_CAN_RECURSE) != 0;
1382 * g_source_set_name:
1383 * @source: a #GSource
1384 * @name: debug name for the source
1386 * Sets a name for the source, used in debugging and profiling.
1387 * The name defaults to #NULL.
1389 * The source name should describe in a human-readable way
1390 * what the source does. For example, "X11 event queue"
1391 * or "GTK+ repaint idle handler" or whatever it is.
1393 * It is permitted to call this function multiple times, but is not
1394 * recommended due to the potential performance impact. For example,
1395 * one could change the name in the "check" function of a #GSourceFuncs
1396 * to include details like the event type in the source name.
1401 g_source_set_name (GSource *source,
1404 g_return_if_fail (source != NULL);
1406 /* setting back to NULL is allowed, just because it's
1407 * weird if get_name can return NULL but you can't
1411 g_free (source->name);
1412 source->name = g_strdup (name);
1416 * g_source_get_name:
1417 * @source: a #GSource
1419 * Gets a name for the source, used in debugging and profiling.
1420 * The name may be #NULL if it has never been set with
1421 * g_source_set_name().
1423 * Return value: the name of the source
1426 G_CONST_RETURN char*
1427 g_source_get_name (GSource *source)
1429 g_return_val_if_fail (source != NULL, NULL);
1431 return source->name;
1435 * g_source_set_name_by_id:
1436 * @tag: a #GSource ID
1437 * @name: debug name for the source
1439 * Sets the name of a source using its ID.
1441 * This is a convenience utility to set source names from the return
1442 * value of g_idle_add(), g_timeout_add(), etc.
1447 g_source_set_name_by_id (guint tag,
1452 g_return_if_fail (tag > 0);
1454 source = g_main_context_find_source_by_id (NULL, tag);
1458 g_source_set_name (source, name);
1464 * @source: a #GSource
1466 * Increases the reference count on a source by one.
1468 * Return value: @source
1471 g_source_ref (GSource *source)
1473 GMainContext *context;
1475 g_return_val_if_fail (source != NULL, NULL);
1477 context = source->context;
1480 LOCK_CONTEXT (context);
1482 source->ref_count++;
1485 UNLOCK_CONTEXT (context);
1490 /* g_source_unref() but possible to call within context lock
1493 g_source_unref_internal (GSource *source,
1494 GMainContext *context,
1497 gpointer old_cb_data = NULL;
1498 GSourceCallbackFuncs *old_cb_funcs = NULL;
1500 g_return_if_fail (source != NULL);
1502 if (!have_lock && context)
1503 LOCK_CONTEXT (context);
1505 source->ref_count--;
1506 if (source->ref_count == 0)
1508 old_cb_data = source->callback_data;
1509 old_cb_funcs = source->callback_funcs;
1511 source->callback_data = NULL;
1512 source->callback_funcs = NULL;
1516 if (!SOURCE_DESTROYED (source))
1517 g_warning (G_STRLOC ": ref_count == 0, but source was still attached to a context!");
1518 g_source_list_remove (source, context);
1521 if (source->source_funcs->finalize)
1524 UNLOCK_CONTEXT (context);
1525 source->source_funcs->finalize (source);
1527 LOCK_CONTEXT (context);
1530 g_free (source->name);
1531 source->name = NULL;
1533 g_slist_free (source->poll_fds);
1534 source->poll_fds = NULL;
1538 if (!have_lock && context)
1539 UNLOCK_CONTEXT (context);
1544 UNLOCK_CONTEXT (context);
1546 old_cb_funcs->unref (old_cb_data);
1549 LOCK_CONTEXT (context);
1555 * @source: a #GSource
1557 * Decreases the reference count of a source by one. If the
1558 * resulting reference count is zero the source and associated
1559 * memory will be destroyed.
1562 g_source_unref (GSource *source)
1564 g_return_if_fail (source != NULL);
1566 g_source_unref_internal (source, source->context, FALSE);
1570 * g_main_context_find_source_by_id:
1571 * @context: a #GMainContext (if %NULL, the default context will be used)
1572 * @source_id: the source ID, as returned by g_source_get_id().
1574 * Finds a #GSource given a pair of context and ID.
1576 * Return value: the #GSource if found, otherwise, %NULL
1579 g_main_context_find_source_by_id (GMainContext *context,
1584 g_return_val_if_fail (source_id > 0, NULL);
1586 if (context == NULL)
1587 context = g_main_context_default ();
1589 LOCK_CONTEXT (context);
1591 source = context->source_list;
1594 if (!SOURCE_DESTROYED (source) &&
1595 source->source_id == source_id)
1597 source = source->next;
1600 UNLOCK_CONTEXT (context);
1606 * g_main_context_find_source_by_funcs_user_data:
1607 * @context: a #GMainContext (if %NULL, the default context will be used).
1608 * @funcs: the @source_funcs passed to g_source_new().
1609 * @user_data: the user data from the callback.
1611 * Finds a source with the given source functions and user data. If
1612 * multiple sources exist with the same source function and user data,
1613 * the first one found will be returned.
1615 * Return value: the source, if one was found, otherwise %NULL
1618 g_main_context_find_source_by_funcs_user_data (GMainContext *context,
1619 GSourceFuncs *funcs,
1624 g_return_val_if_fail (funcs != NULL, NULL);
1626 if (context == NULL)
1627 context = g_main_context_default ();
1629 LOCK_CONTEXT (context);
1631 source = context->source_list;
1634 if (!SOURCE_DESTROYED (source) &&
1635 source->source_funcs == funcs &&
1636 source->callback_funcs)
1638 GSourceFunc callback;
1639 gpointer callback_data;
1641 source->callback_funcs->get (source->callback_data, source, &callback, &callback_data);
1643 if (callback_data == user_data)
1646 source = source->next;
1649 UNLOCK_CONTEXT (context);
1655 * g_main_context_find_source_by_user_data:
1656 * @context: a #GMainContext
1657 * @user_data: the user_data for the callback.
1659 * Finds a source with the given user data for the callback. If
1660 * multiple sources exist with the same user data, the first
1661 * one found will be returned.
1663 * Return value: the source, if one was found, otherwise %NULL
1666 g_main_context_find_source_by_user_data (GMainContext *context,
1671 if (context == NULL)
1672 context = g_main_context_default ();
1674 LOCK_CONTEXT (context);
1676 source = context->source_list;
1679 if (!SOURCE_DESTROYED (source) &&
1680 source->callback_funcs)
1682 GSourceFunc callback;
1683 gpointer callback_data = NULL;
1685 source->callback_funcs->get (source->callback_data, source, &callback, &callback_data);
1687 if (callback_data == user_data)
1690 source = source->next;
1693 UNLOCK_CONTEXT (context);
1700 * @tag: the ID of the source to remove.
1702 * Removes the source with the given id from the default main context.
1704 * a #GSource is given by g_source_get_id(), or will be returned by the
1705 * functions g_source_attach(), g_idle_add(), g_idle_add_full(),
1706 * g_timeout_add(), g_timeout_add_full(), g_child_watch_add(),
1707 * g_child_watch_add_full(), g_io_add_watch(), and g_io_add_watch_full().
1709 * See also g_source_destroy(). You must use g_source_destroy() for sources
1710 * added to a non-default main context.
1712 * Return value: %TRUE if the source was found and removed.
1715 g_source_remove (guint tag)
1719 g_return_val_if_fail (tag > 0, FALSE);
1721 source = g_main_context_find_source_by_id (NULL, tag);
1723 g_source_destroy (source);
1725 return source != NULL;
1729 * g_source_remove_by_user_data:
1730 * @user_data: the user_data for the callback.
1732 * Removes a source from the default main loop context given the user
1733 * data for the callback. If multiple sources exist with the same user
1734 * data, only one will be destroyed.
1736 * Return value: %TRUE if a source was found and removed.
1739 g_source_remove_by_user_data (gpointer user_data)
1743 source = g_main_context_find_source_by_user_data (NULL, user_data);
1746 g_source_destroy (source);
1754 * g_source_remove_by_funcs_user_data:
1755 * @funcs: The @source_funcs passed to g_source_new()
1756 * @user_data: the user data for the callback
1758 * Removes a source from the default main loop context given the
1759 * source functions and user data. If multiple sources exist with the
1760 * same source functions and user data, only one will be destroyed.
1762 * Return value: %TRUE if a source was found and removed.
1765 g_source_remove_by_funcs_user_data (GSourceFuncs *funcs,
1770 g_return_val_if_fail (funcs != NULL, FALSE);
1772 source = g_main_context_find_source_by_funcs_user_data (NULL, funcs, user_data);
1775 g_source_destroy (source);
1783 * g_get_current_time:
1784 * @result: #GTimeVal structure in which to store current time.
1786 * Equivalent to the UNIX gettimeofday() function, but portable.
1788 * You may find g_get_real_time() to be more convenient.
1791 g_get_current_time (GTimeVal *result)
1796 g_return_if_fail (result != NULL);
1798 /*this is required on alpha, there the timeval structs are int's
1799 not longs and a cast only would fail horribly*/
1800 gettimeofday (&r, NULL);
1801 result->tv_sec = r.tv_sec;
1802 result->tv_usec = r.tv_usec;
1807 g_return_if_fail (result != NULL);
1809 GetSystemTimeAsFileTime (&ft);
1810 memmove (&time64, &ft, sizeof (FILETIME));
1812 /* Convert from 100s of nanoseconds since 1601-01-01
1813 * to Unix epoch. Yes, this is Y2038 unsafe.
1815 time64 -= G_GINT64_CONSTANT (116444736000000000);
1818 result->tv_sec = time64 / 1000000;
1819 result->tv_usec = time64 % 1000000;
1826 * Queries the system wall-clock time.
1828 * This call is functionally equivalent to g_get_current_time() except
1829 * that the return value is often more convenient than dealing with a
1832 * You should only use this call if you are actually interested in the real
1833 * wall-clock time. g_get_monotonic_time() is probably more useful for
1834 * measuring intervals.
1836 * Returns: the number of microseconds since January 1, 1970 UTC.
1841 g_get_real_time (void)
1845 g_get_current_time (&tv);
1847 return (((gint64) tv.tv_sec) * 1000000) + tv.tv_usec;
1851 * g_get_monotonic_time:
1853 * Queries the system monotonic time, if available.
1855 * On POSIX systems with clock_gettime() and %CLOCK_MONOTONIC this call
1856 * is a very shallow wrapper for that. Otherwise, we make a best effort
1857 * that probably involves returning the wall clock time (with at least
1858 * microsecond accuracy, subject to the limitations of the OS kernel).
1860 * Note that, on Windows, "limitations of the OS kernel" is a rather
1861 * substantial statement. Depending on the configuration of the system,
1862 * the wall clock time is updated as infrequently as 64 times a second
1863 * (which is approximately every 16ms).
1865 * Returns: the monotonic time, in microseconds
1870 g_get_monotonic_time (void)
1872 #ifdef HAVE_CLOCK_GETTIME
1873 /* librt clock_gettime() is our first choice */
1875 static int clockid = CLOCK_REALTIME;
1878 #ifdef HAVE_MONOTONIC_CLOCK
1879 /* We have to check if we actually have monotonic clock support.
1881 * There is no thread safety issue here since there is no harm if we
1885 static gboolean checked;
1887 if G_UNLIKELY (!checked)
1889 if (sysconf (_SC_MONOTONIC_CLOCK) >= 0)
1890 clockid = CLOCK_MONOTONIC;
1896 clock_gettime (clockid, &ts);
1898 /* In theory monotonic time can have any epoch.
1900 * glib presently assumes the following:
1902 * 1) The epoch comes some time after the birth of Jesus of Nazareth, but
1903 * not more than 10000 years later.
1905 * 2) The current time also falls sometime within this range.
1907 * These two reasonable assumptions leave us with a maximum deviation from
1908 * the epoch of 10000 years, or 315569520000000000 seconds.
1910 * If we restrict ourselves to this range then the number of microseconds
1911 * will always fit well inside the constraints of a int64 (by a factor of
1914 * If you actually hit the following assertion, probably you should file a
1915 * bug against your operating system for being excessively silly.
1917 g_assert (G_GINT64_CONSTANT (-315569520000000000) < ts.tv_sec &&
1918 ts.tv_sec < G_GINT64_CONSTANT (315569520000000000));
1920 return (((gint64) ts.tv_sec) * 1000000) + (ts.tv_nsec / 1000);
1923 /* It may look like we are discarding accuracy on Windows (since its
1924 * current time is expressed in 100s of nanoseconds) but according to
1925 * many sources, the time is only updated 64 times per second, so
1926 * microsecond accuracy is more than enough.
1931 g_get_current_time (&tv);
1933 return (((gint64) tv.tv_sec) * 1000000) + tv.tv_usec;
1939 g_main_dispatch_free (gpointer dispatch)
1941 g_slice_free (GMainDispatch, dispatch);
1944 /* Running the main loop */
1946 static GMainDispatch *
1949 static GStaticPrivate depth_private = G_STATIC_PRIVATE_INIT;
1950 GMainDispatch *dispatch = g_static_private_get (&depth_private);
1953 dispatch = g_slice_new0 (GMainDispatch);
1954 g_static_private_set (&depth_private, dispatch, g_main_dispatch_free);
1963 * Returns the depth of the stack of calls to
1964 * g_main_context_dispatch() on any #GMainContext in the current thread.
1965 * That is, when called from the toplevel, it gives 0. When
1966 * called from within a callback from g_main_context_iteration()
1967 * (or g_main_loop_run(), etc.) it returns 1. When called from within
1968 * a callback to a recursive call to g_main_context_iterate(),
1969 * it returns 2. And so forth.
1971 * This function is useful in a situation like the following:
1972 * Imagine an extremely simple "garbage collected" system.
1975 * static GList *free_list;
1978 * allocate_memory (gsize size)
1980 * gpointer result = g_malloc (size);
1981 * free_list = g_list_prepend (free_list, result);
1986 * free_allocated_memory (void)
1989 * for (l = free_list; l; l = l->next);
1991 * g_list_free (free_list);
1999 * g_main_context_iteration (NULL, TRUE);
2000 * free_allocated_memory();
2004 * This works from an application, however, if you want to do the same
2005 * thing from a library, it gets more difficult, since you no longer
2006 * control the main loop. You might think you can simply use an idle
2007 * function to make the call to free_allocated_memory(), but that
2008 * doesn't work, since the idle function could be called from a
2009 * recursive callback. This can be fixed by using g_main_depth()
2013 * allocate_memory (gsize size)
2015 * FreeListBlock *block = g_new (FreeListBlock, 1);
2016 * block->mem = g_malloc (size);
2017 * block->depth = g_main_depth ();
2018 * free_list = g_list_prepend (free_list, block);
2019 * return block->mem;
2023 * free_allocated_memory (void)
2027 * int depth = g_main_depth ();
2028 * for (l = free_list; l; );
2030 * GList *next = l->next;
2031 * FreeListBlock *block = l->data;
2032 * if (block->depth > depth)
2034 * g_free (block->mem);
2036 * free_list = g_list_delete_link (free_list, l);
2044 * There is a temptation to use g_main_depth() to solve
2045 * problems with reentrancy. For instance, while waiting for data
2046 * to be received from the network in response to a menu item,
2047 * the menu item might be selected again. It might seem that
2048 * one could make the menu item's callback return immediately
2049 * and do nothing if g_main_depth() returns a value greater than 1.
2050 * However, this should be avoided since the user then sees selecting
2051 * the menu item do nothing. Furthermore, you'll find yourself adding
2052 * these checks all over your code, since there are doubtless many,
2053 * many things that the user could do. Instead, you can use the
2054 * following techniques:
2059 * Use gtk_widget_set_sensitive() or modal dialogs to prevent
2060 * the user from interacting with elements while the main
2061 * loop is recursing.
2066 * Avoid main loop recursion in situations where you can't handle
2067 * arbitrary callbacks. Instead, structure your code so that you
2068 * simply return to the main loop and then get called again when
2069 * there is more work to do.
2074 * Return value: The main loop recursion level in the current thread
2079 GMainDispatch *dispatch = get_dispatch ();
2080 return dispatch->depth;
2084 * g_main_current_source:
2086 * Returns the currently firing source for this thread.
2088 * Return value: The currently firing source or %NULL.
2093 g_main_current_source (void)
2095 GMainDispatch *dispatch = get_dispatch ();
2096 return dispatch->dispatching_sources ? dispatch->dispatching_sources->data : NULL;
2100 * g_source_is_destroyed:
2101 * @source: a #GSource
2103 * Returns whether @source has been destroyed.
2105 * This is important when you operate upon your objects
2106 * from within idle handlers, but may have freed the object
2107 * before the dispatch of your idle handler.
2111 * idle_callback (gpointer data)
2113 * SomeWidget *self = data;
2115 * GDK_THREADS_ENTER (<!-- -->);
2116 * /<!-- -->* do stuff with self *<!-- -->/
2117 * self->idle_id = 0;
2118 * GDK_THREADS_LEAVE (<!-- -->);
2124 * some_widget_do_stuff_later (SomeWidget *self)
2126 * self->idle_id = g_idle_add (idle_callback, self);
2130 * some_widget_finalize (GObject *object)
2132 * SomeWidget *self = SOME_WIDGET (object);
2134 * if (self->idle_id)
2135 * g_source_remove (self->idle_id);
2137 * G_OBJECT_CLASS (parent_class)->finalize (object);
2141 * This will fail in a multi-threaded application if the
2142 * widget is destroyed before the idle handler fires due
2143 * to the use after free in the callback. A solution, to
2144 * this particular problem, is to check to if the source
2145 * has already been destroy within the callback.
2149 * idle_callback (gpointer data)
2151 * SomeWidget *self = data;
2153 * GDK_THREADS_ENTER ();
2154 * if (!g_source_is_destroyed (g_main_current_source ()))
2156 * /<!-- -->* do stuff with self *<!-- -->/
2158 * GDK_THREADS_LEAVE ();
2164 * Return value: %TRUE if the source has been destroyed
2169 g_source_is_destroyed (GSource *source)
2171 return SOURCE_DESTROYED (source);
2174 /* Temporarily remove all this source's file descriptors from the
2175 * poll(), so that if data comes available for one of the file descriptors
2176 * we don't continually spin in the poll()
2178 /* HOLDS: source->context's lock */
2180 block_source (GSource *source)
2184 g_return_if_fail (!SOURCE_BLOCKED (source));
2186 tmp_list = source->poll_fds;
2189 g_main_context_remove_poll_unlocked (source->context, tmp_list->data);
2190 tmp_list = tmp_list->next;
2194 /* HOLDS: source->context's lock */
2196 unblock_source (GSource *source)
2200 g_return_if_fail (!SOURCE_BLOCKED (source)); /* Source already unblocked */
2201 g_return_if_fail (!SOURCE_DESTROYED (source));
2203 tmp_list = source->poll_fds;
2206 g_main_context_add_poll_unlocked (source->context, source->priority, tmp_list->data);
2207 tmp_list = tmp_list->next;
2211 /* HOLDS: context's lock */
2213 g_main_dispatch (GMainContext *context)
2215 GMainDispatch *current = get_dispatch ();
2218 for (i = 0; i < context->pending_dispatches->len; i++)
2220 GSource *source = context->pending_dispatches->pdata[i];
2222 context->pending_dispatches->pdata[i] = NULL;
2225 source->flags &= ~G_SOURCE_READY;
2227 if (!SOURCE_DESTROYED (source))
2229 gboolean was_in_call;
2230 gpointer user_data = NULL;
2231 GSourceFunc callback = NULL;
2232 GSourceCallbackFuncs *cb_funcs;
2234 gboolean need_destroy;
2236 gboolean (*dispatch) (GSource *,
2239 GSList current_source_link;
2241 dispatch = source->source_funcs->dispatch;
2242 cb_funcs = source->callback_funcs;
2243 cb_data = source->callback_data;
2246 cb_funcs->ref (cb_data);
2248 if ((source->flags & G_SOURCE_CAN_RECURSE) == 0)
2249 block_source (source);
2251 was_in_call = source->flags & G_HOOK_FLAG_IN_CALL;
2252 source->flags |= G_HOOK_FLAG_IN_CALL;
2255 cb_funcs->get (cb_data, source, &callback, &user_data);
2257 UNLOCK_CONTEXT (context);
2260 /* The on-stack allocation of the GSList is unconventional, but
2261 * we know that the lifetime of the link is bounded to this
2262 * function as the link is kept in a thread specific list and
2263 * not manipulated outside of this function and its descendants.
2264 * Avoiding the overhead of a g_slist_alloc() is useful as many
2265 * applications do little more than dispatch events.
2267 * This is a performance hack - do not revert to g_slist_prepend()!
2269 current_source_link.data = source;
2270 current_source_link.next = current->dispatching_sources;
2271 current->dispatching_sources = ¤t_source_link;
2272 need_destroy = ! dispatch (source,
2275 g_assert (current->dispatching_sources == ¤t_source_link);
2276 current->dispatching_sources = current_source_link.next;
2280 cb_funcs->unref (cb_data);
2282 LOCK_CONTEXT (context);
2285 source->flags &= ~G_HOOK_FLAG_IN_CALL;
2287 if ((source->flags & G_SOURCE_CAN_RECURSE) == 0 &&
2288 !SOURCE_DESTROYED (source))
2289 unblock_source (source);
2291 /* Note: this depends on the fact that we can't switch
2292 * sources from one main context to another
2294 if (need_destroy && !SOURCE_DESTROYED (source))
2296 g_assert (source->context == context);
2297 g_source_destroy_internal (source, context, TRUE);
2301 SOURCE_UNREF (source, context);
2304 g_ptr_array_set_size (context->pending_dispatches, 0);
2307 /* Holds context's lock */
2308 static inline GSource *
2309 next_valid_source (GMainContext *context,
2312 GSource *new_source = source ? source->next : context->source_list;
2316 if (!SOURCE_DESTROYED (new_source))
2318 new_source->ref_count++;
2322 new_source = new_source->next;
2326 SOURCE_UNREF (source, context);
2332 * g_main_context_acquire:
2333 * @context: a #GMainContext
2335 * Tries to become the owner of the specified context.
2336 * If some other thread is the owner of the context,
2337 * returns %FALSE immediately. Ownership is properly
2338 * recursive: the owner can require ownership again
2339 * and will release ownership when g_main_context_release()
2340 * is called as many times as g_main_context_acquire().
2342 * You must be the owner of a context before you
2343 * can call g_main_context_prepare(), g_main_context_query(),
2344 * g_main_context_check(), g_main_context_dispatch().
2346 * Return value: %TRUE if the operation succeeded, and
2347 * this thread is now the owner of @context.
2350 g_main_context_acquire (GMainContext *context)
2352 #ifdef G_THREADS_ENABLED
2353 gboolean result = FALSE;
2354 GThread *self = G_THREAD_SELF;
2356 if (context == NULL)
2357 context = g_main_context_default ();
2359 LOCK_CONTEXT (context);
2361 if (!context->owner)
2363 context->owner = self;
2364 g_assert (context->owner_count == 0);
2367 if (context->owner == self)
2369 context->owner_count++;
2373 UNLOCK_CONTEXT (context);
2376 #else /* !G_THREADS_ENABLED */
2378 #endif /* G_THREADS_ENABLED */
2382 * g_main_context_release:
2383 * @context: a #GMainContext
2385 * Releases ownership of a context previously acquired by this thread
2386 * with g_main_context_acquire(). If the context was acquired multiple
2387 * times, the ownership will be released only when g_main_context_release()
2388 * is called as many times as it was acquired.
2391 g_main_context_release (GMainContext *context)
2393 #ifdef G_THREADS_ENABLED
2394 if (context == NULL)
2395 context = g_main_context_default ();
2397 LOCK_CONTEXT (context);
2399 context->owner_count--;
2400 if (context->owner_count == 0)
2402 context->owner = NULL;
2404 if (context->waiters)
2406 GMainWaiter *waiter = context->waiters->data;
2407 gboolean loop_internal_waiter =
2408 (waiter->mutex == g_static_mutex_get_mutex (&context->mutex));
2409 context->waiters = g_slist_delete_link (context->waiters,
2411 if (!loop_internal_waiter)
2412 g_mutex_lock (waiter->mutex);
2414 g_cond_signal (waiter->cond);
2416 if (!loop_internal_waiter)
2417 g_mutex_unlock (waiter->mutex);
2421 UNLOCK_CONTEXT (context);
2422 #endif /* G_THREADS_ENABLED */
2426 * g_main_context_wait:
2427 * @context: a #GMainContext
2428 * @cond: a condition variable
2429 * @mutex: a mutex, currently held
2431 * Tries to become the owner of the specified context,
2432 * as with g_main_context_acquire(). But if another thread
2433 * is the owner, atomically drop @mutex and wait on @cond until
2434 * that owner releases ownership or until @cond is signaled, then
2435 * try again (once) to become the owner.
2437 * Return value: %TRUE if the operation succeeded, and
2438 * this thread is now the owner of @context.
2441 g_main_context_wait (GMainContext *context,
2445 #ifdef G_THREADS_ENABLED
2446 gboolean result = FALSE;
2447 GThread *self = G_THREAD_SELF;
2448 gboolean loop_internal_waiter;
2450 if (context == NULL)
2451 context = g_main_context_default ();
2453 loop_internal_waiter = (mutex == g_static_mutex_get_mutex (&context->mutex));
2455 if (!loop_internal_waiter)
2456 LOCK_CONTEXT (context);
2458 if (context->owner && context->owner != self)
2463 waiter.mutex = mutex;
2465 context->waiters = g_slist_append (context->waiters, &waiter);
2467 if (!loop_internal_waiter)
2468 UNLOCK_CONTEXT (context);
2469 g_cond_wait (cond, mutex);
2470 if (!loop_internal_waiter)
2471 LOCK_CONTEXT (context);
2473 context->waiters = g_slist_remove (context->waiters, &waiter);
2476 if (!context->owner)
2478 context->owner = self;
2479 g_assert (context->owner_count == 0);
2482 if (context->owner == self)
2484 context->owner_count++;
2488 if (!loop_internal_waiter)
2489 UNLOCK_CONTEXT (context);
2492 #else /* !G_THREADS_ENABLED */
2494 #endif /* G_THREADS_ENABLED */
2498 * g_main_context_prepare:
2499 * @context: a #GMainContext
2500 * @priority: location to store priority of highest priority
2501 * source already ready.
2503 * Prepares to poll sources within a main loop. The resulting information
2504 * for polling is determined by calling g_main_context_query ().
2506 * Return value: %TRUE if some source is ready to be dispatched
2510 g_main_context_prepare (GMainContext *context,
2515 gint current_priority = G_MAXINT;
2518 if (context == NULL)
2519 context = g_main_context_default ();
2521 LOCK_CONTEXT (context);
2523 context->time_is_fresh = FALSE;
2524 context->real_time_is_fresh = FALSE;
2526 if (context->in_check_or_prepare)
2528 g_warning ("g_main_context_prepare() called recursively from within a source's check() or "
2529 "prepare() member.");
2530 UNLOCK_CONTEXT (context);
2534 #ifdef G_THREADS_ENABLED
2535 if (context->poll_waiting)
2537 g_warning("g_main_context_prepare(): main loop already active in another thread");
2538 UNLOCK_CONTEXT (context);
2542 context->poll_waiting = TRUE;
2543 #endif /* G_THREADS_ENABLED */
2546 /* If recursing, finish up current dispatch, before starting over */
2547 if (context->pending_dispatches)
2550 g_main_dispatch (context, ¤t_time);
2552 UNLOCK_CONTEXT (context);
2557 /* If recursing, clear list of pending dispatches */
2559 for (i = 0; i < context->pending_dispatches->len; i++)
2561 if (context->pending_dispatches->pdata[i])
2562 SOURCE_UNREF ((GSource *)context->pending_dispatches->pdata[i], context);
2564 g_ptr_array_set_size (context->pending_dispatches, 0);
2566 /* Prepare all sources */
2568 context->timeout = -1;
2570 source = next_valid_source (context, NULL);
2573 gint source_timeout = -1;
2575 if ((n_ready > 0) && (source->priority > current_priority))
2577 SOURCE_UNREF (source, context);
2580 if (SOURCE_BLOCKED (source))
2583 if (!(source->flags & G_SOURCE_READY))
2586 gboolean (*prepare) (GSource *source,
2589 prepare = source->source_funcs->prepare;
2590 context->in_check_or_prepare++;
2591 UNLOCK_CONTEXT (context);
2593 result = (*prepare) (source, &source_timeout);
2595 LOCK_CONTEXT (context);
2596 context->in_check_or_prepare--;
2599 source->flags |= G_SOURCE_READY;
2602 if (source->flags & G_SOURCE_READY)
2605 current_priority = source->priority;
2606 context->timeout = 0;
2609 if (source_timeout >= 0)
2611 if (context->timeout < 0)
2612 context->timeout = source_timeout;
2614 context->timeout = MIN (context->timeout, source_timeout);
2618 source = next_valid_source (context, source);
2621 UNLOCK_CONTEXT (context);
2624 *priority = current_priority;
2626 return (n_ready > 0);
2630 * g_main_context_query:
2631 * @context: a #GMainContext
2632 * @max_priority: maximum priority source to check
2633 * @timeout_: location to store timeout to be used in polling
2634 * @fds: location to store #GPollFD records that need to be polled.
2635 * @n_fds: length of @fds.
2637 * Determines information necessary to poll this main loop.
2639 * Return value: the number of records actually stored in @fds,
2640 * or, if more than @n_fds records need to be stored, the number
2641 * of records that need to be stored.
2644 g_main_context_query (GMainContext *context,
2653 LOCK_CONTEXT (context);
2655 pollrec = context->poll_records;
2657 while (pollrec && max_priority >= pollrec->priority)
2659 /* We need to include entries with fd->events == 0 in the array because
2660 * otherwise if the application changes fd->events behind our back and
2661 * makes it non-zero, we'll be out of sync when we check the fds[] array.
2662 * (Changing fd->events after adding an FD wasn't an anticipated use of
2663 * this API, but it occurs in practice.) */
2666 fds[n_poll].fd = pollrec->fd->fd;
2667 /* In direct contradiction to the Unix98 spec, IRIX runs into
2668 * difficulty if you pass in POLLERR, POLLHUP or POLLNVAL
2669 * flags in the events field of the pollfd while it should
2670 * just ignoring them. So we mask them out here.
2672 fds[n_poll].events = pollrec->fd->events & ~(G_IO_ERR|G_IO_HUP|G_IO_NVAL);
2673 fds[n_poll].revents = 0;
2676 pollrec = pollrec->next;
2680 #ifdef G_THREADS_ENABLED
2681 context->poll_changed = FALSE;
2686 *timeout = context->timeout;
2689 context->time_is_fresh = FALSE;
2690 context->real_time_is_fresh = FALSE;
2694 UNLOCK_CONTEXT (context);
2700 * g_main_context_check:
2701 * @context: a #GMainContext
2702 * @max_priority: the maximum numerical priority of sources to check
2703 * @fds: array of #GPollFD's that was passed to the last call to
2704 * g_main_context_query()
2705 * @n_fds: return value of g_main_context_query()
2707 * Passes the results of polling back to the main loop.
2709 * Return value: %TRUE if some sources are ready to be dispatched.
2712 g_main_context_check (GMainContext *context,
2722 LOCK_CONTEXT (context);
2724 if (context->in_check_or_prepare)
2726 g_warning ("g_main_context_check() called recursively from within a source's check() or "
2727 "prepare() member.");
2728 UNLOCK_CONTEXT (context);
2732 #ifdef G_THREADS_ENABLED
2733 if (!context->poll_waiting)
2737 read (context->wake_up_pipe[0], &a, 1);
2741 context->poll_waiting = FALSE;
2743 /* If the set of poll file descriptors changed, bail out
2744 * and let the main loop rerun
2746 if (context->poll_changed)
2748 UNLOCK_CONTEXT (context);
2751 #endif /* G_THREADS_ENABLED */
2753 pollrec = context->poll_records;
2757 if (pollrec->fd->events)
2758 pollrec->fd->revents = fds[i].revents;
2760 pollrec = pollrec->next;
2764 source = next_valid_source (context, NULL);
2767 if ((n_ready > 0) && (source->priority > max_priority))
2769 SOURCE_UNREF (source, context);
2772 if (SOURCE_BLOCKED (source))
2775 if (!(source->flags & G_SOURCE_READY))
2778 gboolean (*check) (GSource *source);
2780 check = source->source_funcs->check;
2782 context->in_check_or_prepare++;
2783 UNLOCK_CONTEXT (context);
2785 result = (*check) (source);
2787 LOCK_CONTEXT (context);
2788 context->in_check_or_prepare--;
2791 source->flags |= G_SOURCE_READY;
2794 if (source->flags & G_SOURCE_READY)
2796 source->ref_count++;
2797 g_ptr_array_add (context->pending_dispatches, source);
2801 /* never dispatch sources with less priority than the first
2802 * one we choose to dispatch
2804 max_priority = source->priority;
2808 source = next_valid_source (context, source);
2811 UNLOCK_CONTEXT (context);
2817 * g_main_context_dispatch:
2818 * @context: a #GMainContext
2820 * Dispatches all pending sources.
2823 g_main_context_dispatch (GMainContext *context)
2825 LOCK_CONTEXT (context);
2827 if (context->pending_dispatches->len > 0)
2829 g_main_dispatch (context);
2832 UNLOCK_CONTEXT (context);
2835 /* HOLDS context lock */
2837 g_main_context_iterate (GMainContext *context,
2844 gboolean some_ready;
2845 gint nfds, allocated_nfds;
2846 GPollFD *fds = NULL;
2848 UNLOCK_CONTEXT (context);
2850 #ifdef G_THREADS_ENABLED
2851 if (!g_main_context_acquire (context))
2853 gboolean got_ownership;
2855 LOCK_CONTEXT (context);
2857 g_return_val_if_fail (g_thread_supported (), FALSE);
2863 context->cond = g_cond_new ();
2865 got_ownership = g_main_context_wait (context,
2867 g_static_mutex_get_mutex (&context->mutex));
2873 LOCK_CONTEXT (context);
2874 #endif /* G_THREADS_ENABLED */
2876 if (!context->cached_poll_array)
2878 context->cached_poll_array_size = context->n_poll_records;
2879 context->cached_poll_array = g_new (GPollFD, context->n_poll_records);
2882 allocated_nfds = context->cached_poll_array_size;
2883 fds = context->cached_poll_array;
2885 UNLOCK_CONTEXT (context);
2887 g_main_context_prepare (context, &max_priority);
2889 while ((nfds = g_main_context_query (context, max_priority, &timeout, fds,
2890 allocated_nfds)) > allocated_nfds)
2892 LOCK_CONTEXT (context);
2894 context->cached_poll_array_size = allocated_nfds = nfds;
2895 context->cached_poll_array = fds = g_new (GPollFD, nfds);
2896 UNLOCK_CONTEXT (context);
2902 g_main_context_poll (context, timeout, max_priority, fds, nfds);
2904 some_ready = g_main_context_check (context, max_priority, fds, nfds);
2907 g_main_context_dispatch (context);
2909 #ifdef G_THREADS_ENABLED
2910 g_main_context_release (context);
2911 #endif /* G_THREADS_ENABLED */
2913 LOCK_CONTEXT (context);
2919 * g_main_context_pending:
2920 * @context: a #GMainContext (if %NULL, the default context will be used)
2922 * Checks if any sources have pending events for the given context.
2924 * Return value: %TRUE if events are pending.
2927 g_main_context_pending (GMainContext *context)
2932 context = g_main_context_default();
2934 LOCK_CONTEXT (context);
2935 retval = g_main_context_iterate (context, FALSE, FALSE, G_THREAD_SELF);
2936 UNLOCK_CONTEXT (context);
2942 * g_main_context_iteration:
2943 * @context: a #GMainContext (if %NULL, the default context will be used)
2944 * @may_block: whether the call may block.
2946 * Runs a single iteration for the given main loop. This involves
2947 * checking to see if any event sources are ready to be processed,
2948 * then if no events sources are ready and @may_block is %TRUE, waiting
2949 * for a source to become ready, then dispatching the highest priority
2950 * events sources that are ready. Otherwise, if @may_block is %FALSE
2951 * sources are not waited to become ready, only those highest priority
2952 * events sources will be dispatched (if any), that are ready at this
2953 * given moment without further waiting.
2955 * Note that even when @may_block is %TRUE, it is still possible for
2956 * g_main_context_iteration() to return %FALSE, since the the wait may
2957 * be interrupted for other reasons than an event source becoming ready.
2959 * Return value: %TRUE if events were dispatched.
2962 g_main_context_iteration (GMainContext *context, gboolean may_block)
2967 context = g_main_context_default();
2969 LOCK_CONTEXT (context);
2970 retval = g_main_context_iterate (context, may_block, TRUE, G_THREAD_SELF);
2971 UNLOCK_CONTEXT (context);
2978 * @context: a #GMainContext (if %NULL, the default context will be used).
2979 * @is_running: set to %TRUE to indicate that the loop is running. This
2980 * is not very important since calling g_main_loop_run() will set this to
2983 * Creates a new #GMainLoop structure.
2985 * Return value: a new #GMainLoop.
2988 g_main_loop_new (GMainContext *context,
2989 gboolean is_running)
2994 context = g_main_context_default();
2996 g_main_context_ref (context);
2998 loop = g_new0 (GMainLoop, 1);
2999 loop->context = context;
3000 loop->is_running = is_running != FALSE;
3001 loop->ref_count = 1;
3008 * @loop: a #GMainLoop
3010 * Increases the reference count on a #GMainLoop object by one.
3012 * Return value: @loop
3015 g_main_loop_ref (GMainLoop *loop)
3017 g_return_val_if_fail (loop != NULL, NULL);
3018 g_return_val_if_fail (g_atomic_int_get (&loop->ref_count) > 0, NULL);
3020 g_atomic_int_inc (&loop->ref_count);
3026 * g_main_loop_unref:
3027 * @loop: a #GMainLoop
3029 * Decreases the reference count on a #GMainLoop object by one. If
3030 * the result is zero, free the loop and free all associated memory.
3033 g_main_loop_unref (GMainLoop *loop)
3035 g_return_if_fail (loop != NULL);
3036 g_return_if_fail (g_atomic_int_get (&loop->ref_count) > 0);
3038 if (!g_atomic_int_dec_and_test (&loop->ref_count))
3041 g_main_context_unref (loop->context);
3047 * @loop: a #GMainLoop
3049 * Runs a main loop until g_main_loop_quit() is called on the loop.
3050 * If this is called for the thread of the loop's #GMainContext,
3051 * it will process events from the loop, otherwise it will
3055 g_main_loop_run (GMainLoop *loop)
3057 GThread *self = G_THREAD_SELF;
3059 g_return_if_fail (loop != NULL);
3060 g_return_if_fail (g_atomic_int_get (&loop->ref_count) > 0);
3062 #ifdef G_THREADS_ENABLED
3063 if (!g_main_context_acquire (loop->context))
3065 gboolean got_ownership = FALSE;
3067 /* Another thread owns this context */
3068 if (!g_thread_supported ())
3070 g_warning ("g_main_loop_run() was called from second thread but "
3071 "g_thread_init() was never called.");
3075 LOCK_CONTEXT (loop->context);
3077 g_atomic_int_inc (&loop->ref_count);
3079 if (!loop->is_running)
3080 loop->is_running = TRUE;
3082 if (!loop->context->cond)
3083 loop->context->cond = g_cond_new ();
3085 while (loop->is_running && !got_ownership)
3086 got_ownership = g_main_context_wait (loop->context,
3087 loop->context->cond,
3088 g_static_mutex_get_mutex (&loop->context->mutex));
3090 if (!loop->is_running)
3092 UNLOCK_CONTEXT (loop->context);
3094 g_main_context_release (loop->context);
3095 g_main_loop_unref (loop);
3099 g_assert (got_ownership);
3102 LOCK_CONTEXT (loop->context);
3103 #endif /* G_THREADS_ENABLED */
3105 if (loop->context->in_check_or_prepare)
3107 g_warning ("g_main_loop_run(): called recursively from within a source's "
3108 "check() or prepare() member, iteration not possible.");
3112 g_atomic_int_inc (&loop->ref_count);
3113 loop->is_running = TRUE;
3114 while (loop->is_running)
3115 g_main_context_iterate (loop->context, TRUE, TRUE, self);
3117 UNLOCK_CONTEXT (loop->context);
3119 #ifdef G_THREADS_ENABLED
3120 g_main_context_release (loop->context);
3121 #endif /* G_THREADS_ENABLED */
3123 g_main_loop_unref (loop);
3128 * @loop: a #GMainLoop
3130 * Stops a #GMainLoop from running. Any calls to g_main_loop_run()
3131 * for the loop will return.
3133 * Note that sources that have already been dispatched when
3134 * g_main_loop_quit() is called will still be executed.
3137 g_main_loop_quit (GMainLoop *loop)
3139 g_return_if_fail (loop != NULL);
3140 g_return_if_fail (g_atomic_int_get (&loop->ref_count) > 0);
3142 LOCK_CONTEXT (loop->context);
3143 loop->is_running = FALSE;
3144 g_main_context_wakeup_unlocked (loop->context);
3146 #ifdef G_THREADS_ENABLED
3147 if (loop->context->cond)
3148 g_cond_broadcast (loop->context->cond);
3149 #endif /* G_THREADS_ENABLED */
3151 UNLOCK_CONTEXT (loop->context);
3155 * g_main_loop_is_running:
3156 * @loop: a #GMainLoop.
3158 * Checks to see if the main loop is currently being run via g_main_loop_run().
3160 * Return value: %TRUE if the mainloop is currently being run.
3163 g_main_loop_is_running (GMainLoop *loop)
3165 g_return_val_if_fail (loop != NULL, FALSE);
3166 g_return_val_if_fail (g_atomic_int_get (&loop->ref_count) > 0, FALSE);
3168 return loop->is_running;
3172 * g_main_loop_get_context:
3173 * @loop: a #GMainLoop.
3175 * Returns the #GMainContext of @loop.
3177 * Return value: the #GMainContext of @loop
3180 g_main_loop_get_context (GMainLoop *loop)
3182 g_return_val_if_fail (loop != NULL, NULL);
3183 g_return_val_if_fail (g_atomic_int_get (&loop->ref_count) > 0, NULL);
3185 return loop->context;
3188 /* HOLDS: context's lock */
3190 g_main_context_poll (GMainContext *context,
3196 #ifdef G_MAIN_POLL_DEBUG
3202 GPollFunc poll_func;
3204 if (n_fds || timeout != 0)
3206 #ifdef G_MAIN_POLL_DEBUG
3207 if (_g_main_poll_debug)
3209 g_print ("polling context=%p n=%d timeout=%d\n",
3210 context, n_fds, timeout);
3211 poll_timer = g_timer_new ();
3215 LOCK_CONTEXT (context);
3217 poll_func = context->poll_func;
3219 UNLOCK_CONTEXT (context);
3220 if ((*poll_func) (fds, n_fds, timeout) < 0 && errno != EINTR)
3223 g_warning ("poll(2) failed due to: %s.",
3224 g_strerror (errno));
3226 /* If g_poll () returns -1, it has already called g_warning() */
3230 #ifdef G_MAIN_POLL_DEBUG
3231 if (_g_main_poll_debug)
3233 LOCK_CONTEXT (context);
3235 g_print ("g_main_poll(%d) timeout: %d - elapsed %12.10f seconds",
3238 g_timer_elapsed (poll_timer, NULL));
3239 g_timer_destroy (poll_timer);
3240 pollrec = context->poll_records;
3242 while (pollrec != NULL)
3247 if (fds[i].fd == pollrec->fd->fd &&
3248 pollrec->fd->events &&
3251 g_print (" [" G_POLLFD_FORMAT " :", fds[i].fd);
3252 if (fds[i].revents & G_IO_IN)
3254 if (fds[i].revents & G_IO_OUT)
3256 if (fds[i].revents & G_IO_PRI)
3258 if (fds[i].revents & G_IO_ERR)
3260 if (fds[i].revents & G_IO_HUP)
3262 if (fds[i].revents & G_IO_NVAL)
3268 pollrec = pollrec->next;
3272 UNLOCK_CONTEXT (context);
3275 } /* if (n_fds || timeout != 0) */
3279 * g_main_context_add_poll:
3280 * @context: a #GMainContext (or %NULL for the default context)
3281 * @fd: a #GPollFD structure holding information about a file
3282 * descriptor to watch.
3283 * @priority: the priority for this file descriptor which should be
3284 * the same as the priority used for g_source_attach() to ensure that the
3285 * file descriptor is polled whenever the results may be needed.
3287 * Adds a file descriptor to the set of file descriptors polled for
3288 * this context. This will very seldomly be used directly. Instead
3289 * a typical event source will use g_source_add_poll() instead.
3292 g_main_context_add_poll (GMainContext *context,
3297 context = g_main_context_default ();
3299 g_return_if_fail (g_atomic_int_get (&context->ref_count) > 0);
3300 g_return_if_fail (fd);
3302 LOCK_CONTEXT (context);
3303 g_main_context_add_poll_unlocked (context, priority, fd);
3304 UNLOCK_CONTEXT (context);
3307 /* HOLDS: main_loop_lock */
3309 g_main_context_add_poll_unlocked (GMainContext *context,
3313 GPollRec *lastrec, *pollrec;
3314 GPollRec *newrec = g_slice_new (GPollRec);
3316 /* This file descriptor may be checked before we ever poll */
3319 newrec->priority = priority;
3322 pollrec = context->poll_records;
3323 while (pollrec && priority >= pollrec->priority)
3326 pollrec = pollrec->next;
3330 lastrec->next = newrec;
3332 context->poll_records = newrec;
3334 newrec->next = pollrec;
3336 context->n_poll_records++;
3338 #ifdef G_THREADS_ENABLED
3339 context->poll_changed = TRUE;
3341 /* Now wake up the main loop if it is waiting in the poll() */
3342 g_main_context_wakeup_unlocked (context);
3347 * g_main_context_remove_poll:
3348 * @context:a #GMainContext
3349 * @fd: a #GPollFD descriptor previously added with g_main_context_add_poll()
3351 * Removes file descriptor from the set of file descriptors to be
3352 * polled for a particular context.
3355 g_main_context_remove_poll (GMainContext *context,
3359 context = g_main_context_default ();
3361 g_return_if_fail (g_atomic_int_get (&context->ref_count) > 0);
3362 g_return_if_fail (fd);
3364 LOCK_CONTEXT (context);
3365 g_main_context_remove_poll_unlocked (context, fd);
3366 UNLOCK_CONTEXT (context);
3370 g_main_context_remove_poll_unlocked (GMainContext *context,
3373 GPollRec *pollrec, *lastrec;
3376 pollrec = context->poll_records;
3380 if (pollrec->fd == fd)
3382 if (lastrec != NULL)
3383 lastrec->next = pollrec->next;
3385 context->poll_records = pollrec->next;
3387 g_slice_free (GPollRec, pollrec);
3389 context->n_poll_records--;
3393 pollrec = pollrec->next;
3396 #ifdef G_THREADS_ENABLED
3397 context->poll_changed = TRUE;
3399 /* Now wake up the main loop if it is waiting in the poll() */
3400 g_main_context_wakeup_unlocked (context);
3405 * g_source_get_current_time:
3406 * @source: a #GSource
3407 * @timeval: #GTimeVal structure in which to store current time.
3409 * Gets the "current time" to be used when checking
3410 * this source. The advantage of calling this function over
3411 * calling g_get_current_time() directly is that when
3412 * checking multiple sources, GLib can cache a single value
3413 * instead of having to repeatedly get the system time.
3415 * Deprecated: 2.28: use g_source_get_time() instead
3418 g_source_get_current_time (GSource *source,
3421 GMainContext *context;
3423 g_return_if_fail (source->context != NULL);
3425 context = source->context;
3427 LOCK_CONTEXT (context);
3429 if (!context->real_time_is_fresh)
3431 context->real_time = g_get_real_time ();
3432 context->real_time_is_fresh = TRUE;
3435 timeval->tv_sec = context->real_time / 1000000;
3436 timeval->tv_usec = context->real_time % 1000000;
3438 UNLOCK_CONTEXT (context);
3442 * g_source_get_time:
3443 * @source: a #GSource
3445 * Gets the time to be used when checking this source. The advantage of
3446 * calling this function over calling g_get_monotonic_time() directly is
3447 * that when checking multiple sources, GLib can cache a single value
3448 * instead of having to repeatedly get the system monotonic time.
3450 * The time here is the system monotonic time, if available, or some
3451 * other reasonable alternative otherwise. See g_get_monotonic_time().
3453 * Returns: the monotonic time in microseconds
3458 g_source_get_time (GSource *source)
3460 GMainContext *context;
3463 g_return_val_if_fail (source->context != NULL, 0);
3465 context = source->context;
3467 LOCK_CONTEXT (context);
3469 if (!context->time_is_fresh)
3471 context->time = g_get_monotonic_time ();
3472 context->time_is_fresh = TRUE;
3475 result = context->time;
3477 UNLOCK_CONTEXT (context);
3483 * g_main_context_set_poll_func:
3484 * @context: a #GMainContext
3485 * @func: the function to call to poll all file descriptors
3487 * Sets the function to use to handle polling of file descriptors. It
3488 * will be used instead of the poll() system call
3489 * (or GLib's replacement function, which is used where
3490 * poll() isn't available).
3492 * This function could possibly be used to integrate the GLib event
3493 * loop with an external event loop.
3496 g_main_context_set_poll_func (GMainContext *context,
3500 context = g_main_context_default ();
3502 g_return_if_fail (g_atomic_int_get (&context->ref_count) > 0);
3504 LOCK_CONTEXT (context);
3507 context->poll_func = func;
3509 context->poll_func = g_poll;
3511 UNLOCK_CONTEXT (context);
3515 * g_main_context_get_poll_func:
3516 * @context: a #GMainContext
3518 * Gets the poll function set by g_main_context_set_poll_func().
3520 * Return value: the poll function
3523 g_main_context_get_poll_func (GMainContext *context)
3528 context = g_main_context_default ();
3530 g_return_val_if_fail (g_atomic_int_get (&context->ref_count) > 0, NULL);
3532 LOCK_CONTEXT (context);
3533 result = context->poll_func;
3534 UNLOCK_CONTEXT (context);
3539 /* HOLDS: context's lock */
3540 /* Wake the main loop up from a poll() */
3542 g_main_context_wakeup_unlocked (GMainContext *context)
3544 #ifdef G_THREADS_ENABLED
3545 if (g_thread_supported() && context->poll_waiting)
3547 context->poll_waiting = FALSE;
3549 write (context->wake_up_pipe[1], "A", 1);
3551 ReleaseSemaphore (context->wake_up_semaphore, 1, NULL);
3558 * g_main_context_wakeup:
3559 * @context: a #GMainContext
3561 * If @context is currently waiting in a poll(), interrupt
3562 * the poll(), and continue the iteration process.
3565 g_main_context_wakeup (GMainContext *context)
3568 context = g_main_context_default ();
3570 g_return_if_fail (g_atomic_int_get (&context->ref_count) > 0);
3572 LOCK_CONTEXT (context);
3573 g_main_context_wakeup_unlocked (context);
3574 UNLOCK_CONTEXT (context);
3578 * g_main_context_is_owner:
3579 * @context: a #GMainContext
3581 * Determines whether this thread holds the (recursive)
3582 * ownership of this #GMaincontext. This is useful to
3583 * know before waiting on another thread that may be
3584 * blocking to get ownership of @context.
3586 * Returns: %TRUE if current thread is owner of @context.
3591 g_main_context_is_owner (GMainContext *context)
3596 context = g_main_context_default ();
3598 #ifdef G_THREADS_ENABLED
3599 LOCK_CONTEXT (context);
3600 is_owner = context->owner == G_THREAD_SELF;
3601 UNLOCK_CONTEXT (context);
3612 g_timeout_set_expiration (GTimeoutSource *timeout_source,
3613 gint64 current_time)
3615 timeout_source->expiration = current_time + timeout_source->interval * 1000;
3617 if (timeout_source->seconds)
3619 static gint timer_perturb = -1;
3621 if (timer_perturb == -1)
3624 * we want a per machine/session unique 'random' value; try the dbus
3625 * address first, that has a UUID in it. If there is no dbus, use the
3626 * hostname for hashing.
3628 const char *session_bus_address = g_getenv ("DBUS_SESSION_BUS_ADDRESS");
3629 if (!session_bus_address)
3630 session_bus_address = g_getenv ("HOSTNAME");
3631 if (session_bus_address)
3632 timer_perturb = ABS ((gint) g_str_hash (session_bus_address)) % 1000000;
3637 /* We want the microseconds part of the timeout to land on the
3638 * 'timer_perturb' mark, but we need to make sure we don't try to
3639 * set the timeout in the past. We do this by ensuring that we
3640 * always only *increase* the expiration time by adding a full
3641 * second in the case that the microsecond portion decreases.
3643 if (timer_perturb < timeout_source->expiration % 1000000)
3644 timeout_source->expiration += 1000000;
3646 timeout_source->expiration =
3647 ((timeout_source->expiration / 1000000) * 1000000) + timer_perturb;
3652 g_timeout_prepare (GSource *source,
3655 GTimeoutSource *timeout_source = (GTimeoutSource *) source;
3656 gint64 now = g_source_get_time (source);
3658 if (now < timeout_source->expiration)
3660 /* Round up to ensure that we don't try again too early */
3661 *timeout = (timeout_source->expiration - now + 999) / 1000;
3670 g_timeout_check (GSource *source)
3672 GTimeoutSource *timeout_source = (GTimeoutSource *) source;
3673 gint64 now = g_source_get_time (source);
3675 return timeout_source->expiration <= now;
3679 g_timeout_dispatch (GSource *source,
3680 GSourceFunc callback,
3683 GTimeoutSource *timeout_source = (GTimeoutSource *)source;
3688 g_warning ("Timeout source dispatched without callback\n"
3689 "You must call g_source_set_callback().");
3693 again = callback (user_data);
3696 g_timeout_set_expiration (timeout_source, g_source_get_time (source));
3702 * g_timeout_source_new:
3703 * @interval: the timeout interval in milliseconds.
3705 * Creates a new timeout source.
3707 * The source will not initially be associated with any #GMainContext
3708 * and must be added to one with g_source_attach() before it will be
3711 * Return value: the newly-created timeout source
3714 g_timeout_source_new (guint interval)
3716 GSource *source = g_source_new (&g_timeout_funcs, sizeof (GTimeoutSource));
3717 GTimeoutSource *timeout_source = (GTimeoutSource *)source;
3719 timeout_source->interval = interval;
3720 g_timeout_set_expiration (timeout_source, g_get_monotonic_time ());
3726 * g_timeout_source_new_seconds:
3727 * @interval: the timeout interval in seconds
3729 * Creates a new timeout source.
3731 * The source will not initially be associated with any #GMainContext
3732 * and must be added to one with g_source_attach() before it will be
3735 * The scheduling granularity/accuracy of this timeout source will be
3738 * Return value: the newly-created timeout source
3743 g_timeout_source_new_seconds (guint interval)
3745 GSource *source = g_source_new (&g_timeout_funcs, sizeof (GTimeoutSource));
3746 GTimeoutSource *timeout_source = (GTimeoutSource *)source;
3748 timeout_source->interval = 1000 * interval;
3749 timeout_source->seconds = TRUE;
3751 g_timeout_set_expiration (timeout_source, g_get_monotonic_time ());
3758 * g_timeout_add_full:
3759 * @priority: the priority of the timeout source. Typically this will be in
3760 * the range between #G_PRIORITY_DEFAULT and #G_PRIORITY_HIGH.
3761 * @interval: the time between calls to the function, in milliseconds
3762 * (1/1000ths of a second)
3763 * @function: function to call
3764 * @data: data to pass to @function
3765 * @notify: function to call when the timeout is removed, or %NULL
3767 * Sets a function to be called at regular intervals, with the given
3768 * priority. The function is called repeatedly until it returns
3769 * %FALSE, at which point the timeout is automatically destroyed and
3770 * the function will not be called again. The @notify function is
3771 * called when the timeout is destroyed. The first call to the
3772 * function will be at the end of the first @interval.
3774 * Note that timeout functions may be delayed, due to the processing of other
3775 * event sources. Thus they should not be relied on for precise timing.
3776 * After each call to the timeout function, the time of the next
3777 * timeout is recalculated based on the current time and the given interval
3778 * (it does not try to 'catch up' time lost in delays).
3780 * This internally creates a main loop source using g_timeout_source_new()
3781 * and attaches it to the main loop context using g_source_attach(). You can
3782 * do these steps manually if you need greater control.
3784 * Return value: the ID (greater than 0) of the event source.
3787 g_timeout_add_full (gint priority,
3789 GSourceFunc function,
3791 GDestroyNotify notify)
3796 g_return_val_if_fail (function != NULL, 0);
3798 source = g_timeout_source_new (interval);
3800 if (priority != G_PRIORITY_DEFAULT)
3801 g_source_set_priority (source, priority);
3803 g_source_set_callback (source, function, data, notify);
3804 id = g_source_attach (source, NULL);
3805 g_source_unref (source);
3812 * @interval: the time between calls to the function, in milliseconds
3813 * (1/1000ths of a second)
3814 * @function: function to call
3815 * @data: data to pass to @function
3817 * Sets a function to be called at regular intervals, with the default
3818 * priority, #G_PRIORITY_DEFAULT. The function is called repeatedly
3819 * until it returns %FALSE, at which point the timeout is automatically
3820 * destroyed and the function will not be called again. The first call
3821 * to the function will be at the end of the first @interval.
3823 * Note that timeout functions may be delayed, due to the processing of other
3824 * event sources. Thus they should not be relied on for precise timing.
3825 * After each call to the timeout function, the time of the next
3826 * timeout is recalculated based on the current time and the given interval
3827 * (it does not try to 'catch up' time lost in delays).
3829 * If you want to have a timer in the "seconds" range and do not care
3830 * about the exact time of the first call of the timer, use the
3831 * g_timeout_add_seconds() function; this function allows for more
3832 * optimizations and more efficient system power usage.
3834 * This internally creates a main loop source using g_timeout_source_new()
3835 * and attaches it to the main loop context using g_source_attach(). You can
3836 * do these steps manually if you need greater control.
3838 * Return value: the ID (greater than 0) of the event source.
3841 g_timeout_add (guint32 interval,
3842 GSourceFunc function,
3845 return g_timeout_add_full (G_PRIORITY_DEFAULT,
3846 interval, function, data, NULL);
3850 * g_timeout_add_seconds_full:
3851 * @priority: the priority of the timeout source. Typically this will be in
3852 * the range between #G_PRIORITY_DEFAULT and #G_PRIORITY_HIGH.
3853 * @interval: the time between calls to the function, in seconds
3854 * @function: function to call
3855 * @data: data to pass to @function
3856 * @notify: function to call when the timeout is removed, or %NULL
3858 * Sets a function to be called at regular intervals, with @priority.
3859 * The function is called repeatedly until it returns %FALSE, at which
3860 * point the timeout is automatically destroyed and the function will
3861 * not be called again.
3863 * Unlike g_timeout_add(), this function operates at whole second granularity.
3864 * The initial starting point of the timer is determined by the implementation
3865 * and the implementation is expected to group multiple timers together so that
3866 * they fire all at the same time.
3867 * To allow this grouping, the @interval to the first timer is rounded
3868 * and can deviate up to one second from the specified interval.
3869 * Subsequent timer iterations will generally run at the specified interval.
3871 * Note that timeout functions may be delayed, due to the processing of other
3872 * event sources. Thus they should not be relied on for precise timing.
3873 * After each call to the timeout function, the time of the next
3874 * timeout is recalculated based on the current time and the given @interval
3876 * If you want timing more precise than whole seconds, use g_timeout_add()
3879 * The grouping of timers to fire at the same time results in a more power
3880 * and CPU efficient behavior so if your timer is in multiples of seconds
3881 * and you don't require the first timer exactly one second from now, the
3882 * use of g_timeout_add_seconds() is preferred over g_timeout_add().
3884 * This internally creates a main loop source using
3885 * g_timeout_source_new_seconds() and attaches it to the main loop context
3886 * using g_source_attach(). You can do these steps manually if you need
3889 * Return value: the ID (greater than 0) of the event source.
3894 g_timeout_add_seconds_full (gint priority,
3896 GSourceFunc function,
3898 GDestroyNotify notify)
3903 g_return_val_if_fail (function != NULL, 0);
3905 source = g_timeout_source_new_seconds (interval);
3907 if (priority != G_PRIORITY_DEFAULT)
3908 g_source_set_priority (source, priority);
3910 g_source_set_callback (source, function, data, notify);
3911 id = g_source_attach (source, NULL);
3912 g_source_unref (source);
3918 * g_timeout_add_seconds:
3919 * @interval: the time between calls to the function, in seconds
3920 * @function: function to call
3921 * @data: data to pass to @function
3923 * Sets a function to be called at regular intervals with the default
3924 * priority, #G_PRIORITY_DEFAULT. The function is called repeatedly until
3925 * it returns %FALSE, at which point the timeout is automatically destroyed
3926 * and the function will not be called again.
3928 * This internally creates a main loop source using
3929 * g_timeout_source_new_seconds() and attaches it to the main loop context
3930 * using g_source_attach(). You can do these steps manually if you need
3931 * greater control. Also see g_timout_add_seconds_full().
3933 * Return value: the ID (greater than 0) of the event source.
3938 g_timeout_add_seconds (guint interval,
3939 GSourceFunc function,
3942 g_return_val_if_fail (function != NULL, 0);
3944 return g_timeout_add_seconds_full (G_PRIORITY_DEFAULT, interval, function, data, NULL);
3947 /* Child watch functions */
3952 g_child_watch_prepare (GSource *source,
3961 g_child_watch_check (GSource *source)
3963 GChildWatchSource *child_watch_source;
3964 gboolean child_exited;
3966 child_watch_source = (GChildWatchSource *) source;
3968 child_exited = child_watch_source->poll.revents & G_IO_IN;
3975 * Note: We do _not_ check for the special value of STILL_ACTIVE
3976 * since we know that the process has exited and doing so runs into
3977 * problems if the child process "happens to return STILL_ACTIVE(259)"
3978 * as Microsoft's Platform SDK puts it.
3980 if (!GetExitCodeProcess (child_watch_source->pid, &child_status))
3982 gchar *emsg = g_win32_error_message (GetLastError ());
3983 g_warning (G_STRLOC ": GetExitCodeProcess() failed: %s", emsg);
3986 child_watch_source->child_status = -1;
3989 child_watch_source->child_status = child_status;
3992 return child_exited;
3995 #else /* G_OS_WIN32 */
3998 check_for_child_exited (GSource *source)
4000 GChildWatchSource *child_watch_source;
4003 /* protect against another SIGCHLD in the middle of this call */
4004 count = child_watch_count;
4006 child_watch_source = (GChildWatchSource *) source;
4008 if (child_watch_source->child_exited)
4011 if (child_watch_source->count < count)
4015 if (waitpid (child_watch_source->pid, &child_status, WNOHANG) > 0)
4017 child_watch_source->child_status = child_status;
4018 child_watch_source->child_exited = TRUE;
4020 child_watch_source->count = count;
4023 return child_watch_source->child_exited;
4027 g_child_watch_prepare (GSource *source,
4032 return check_for_child_exited (source);
4037 g_child_watch_check (GSource *source)
4039 return check_for_child_exited (source);
4042 #endif /* G_OS_WIN32 */
4045 g_child_watch_dispatch (GSource *source,
4046 GSourceFunc callback,
4049 GChildWatchSource *child_watch_source;
4050 GChildWatchFunc child_watch_callback = (GChildWatchFunc) callback;
4052 child_watch_source = (GChildWatchSource *) source;
4056 g_warning ("Child watch source dispatched without callback\n"
4057 "You must call g_source_set_callback().");
4061 (child_watch_callback) (child_watch_source->pid, child_watch_source->child_status, user_data);
4063 /* We never keep a child watch source around as the child is gone */
4070 g_child_watch_signal_handler (int signum)
4072 child_watch_count ++;
4074 if (child_watch_init_state == CHILD_WATCH_INITIALIZED_THREADED)
4076 write (child_watch_wake_up_pipe[1], "B", 1);
4080 /* We count on the signal interrupting the poll in the same thread.
4086 g_child_watch_source_init_single (void)
4088 struct sigaction action;
4090 g_assert (! g_thread_supported());
4091 g_assert (child_watch_init_state == CHILD_WATCH_UNINITIALIZED);
4093 child_watch_init_state = CHILD_WATCH_INITIALIZED_SINGLE;
4095 action.sa_handler = g_child_watch_signal_handler;
4096 sigemptyset (&action.sa_mask);
4097 action.sa_flags = SA_NOCLDSTOP;
4098 sigaction (SIGCHLD, &action, NULL);
4101 G_GNUC_NORETURN static gpointer
4102 child_watch_helper_thread (gpointer data)
4109 read (child_watch_wake_up_pipe[0], b, 20);
4111 /* We were woken up. Wake up all other contexts in all other threads */
4112 G_LOCK (main_context_list);
4113 for (list = main_context_list; list; list = list->next)
4115 GMainContext *context;
4117 context = list->data;
4118 if (g_atomic_int_get (&context->ref_count) > 0)
4119 /* Due to racing conditions we can find ref_count == 0, in
4120 * that case, however, the context is still not destroyed
4121 * and no poll can be active, otherwise the ref_count
4123 g_main_context_wakeup (context);
4125 G_UNLOCK (main_context_list);
4130 g_child_watch_source_init_multi_threaded (void)
4132 GError *error = NULL;
4133 struct sigaction action;
4135 g_assert (g_thread_supported());
4137 if (pipe (child_watch_wake_up_pipe) < 0)
4138 g_error ("Cannot create wake up pipe: %s\n", g_strerror (errno));
4139 fcntl (child_watch_wake_up_pipe[1], F_SETFL, O_NONBLOCK | fcntl (child_watch_wake_up_pipe[1], F_GETFL));
4141 /* We create a helper thread that polls on the wakeup pipe indefinitely */
4142 /* FIXME: Think this through for races */
4143 if (g_thread_create (child_watch_helper_thread, NULL, FALSE, &error) == NULL)
4144 g_error ("Cannot create a thread to monitor child exit status: %s\n", error->message);
4145 child_watch_init_state = CHILD_WATCH_INITIALIZED_THREADED;
4147 action.sa_handler = g_child_watch_signal_handler;
4148 sigemptyset (&action.sa_mask);
4149 action.sa_flags = SA_RESTART | SA_NOCLDSTOP;
4150 sigaction (SIGCHLD, &action, NULL);
4154 g_child_watch_source_init_promote_single_to_threaded (void)
4156 g_child_watch_source_init_multi_threaded ();
4160 g_child_watch_source_init (void)
4162 if (g_thread_supported())
4164 if (child_watch_init_state == CHILD_WATCH_UNINITIALIZED)
4165 g_child_watch_source_init_multi_threaded ();
4166 else if (child_watch_init_state == CHILD_WATCH_INITIALIZED_SINGLE)
4167 g_child_watch_source_init_promote_single_to_threaded ();
4171 if (child_watch_init_state == CHILD_WATCH_UNINITIALIZED)
4172 g_child_watch_source_init_single ();
4176 #endif /* !G_OS_WIN32 */
4179 * g_child_watch_source_new:
4180 * @pid: process to watch. On POSIX the pid of a child process. On
4181 * Windows a handle for a process (which doesn't have to be a child).
4183 * Creates a new child_watch source.
4185 * The source will not initially be associated with any #GMainContext
4186 * and must be added to one with g_source_attach() before it will be
4189 * Note that child watch sources can only be used in conjunction with
4190 * <literal>g_spawn...</literal> when the %G_SPAWN_DO_NOT_REAP_CHILD
4193 * Note that on platforms where #GPid must be explicitly closed
4194 * (see g_spawn_close_pid()) @pid must not be closed while the
4195 * source is still active. Typically, you will want to call
4196 * g_spawn_close_pid() in the callback function for the source.
4198 * Note further that using g_child_watch_source_new() is not
4199 * compatible with calling <literal>waitpid(-1)</literal> in
4200 * the application. Calling waitpid() for individual pids will
4203 * Return value: the newly-created child watch source
4208 g_child_watch_source_new (GPid pid)
4210 GSource *source = g_source_new (&g_child_watch_funcs, sizeof (GChildWatchSource));
4211 GChildWatchSource *child_watch_source = (GChildWatchSource *)source;
4214 child_watch_source->poll.fd = (gintptr) pid;
4215 child_watch_source->poll.events = G_IO_IN;
4217 g_source_add_poll (source, &child_watch_source->poll);
4218 #else /* G_OS_WIN32 */
4219 g_child_watch_source_init ();
4220 #endif /* G_OS_WIN32 */
4222 child_watch_source->pid = pid;
4228 * g_child_watch_add_full:
4229 * @priority: the priority of the idle source. Typically this will be in the
4230 * range between #G_PRIORITY_DEFAULT_IDLE and #G_PRIORITY_HIGH_IDLE.
4231 * @pid: process to watch. On POSIX the pid of a child process. On
4232 * Windows a handle for a process (which doesn't have to be a child).
4233 * @function: function to call
4234 * @data: data to pass to @function
4235 * @notify: function to call when the idle is removed, or %NULL
4237 * Sets a function to be called when the child indicated by @pid
4238 * exits, at the priority @priority.
4240 * If you obtain @pid from g_spawn_async() or g_spawn_async_with_pipes()
4241 * you will need to pass #G_SPAWN_DO_NOT_REAP_CHILD as flag to
4242 * the spawn function for the child watching to work.
4244 * Note that on platforms where #GPid must be explicitly closed
4245 * (see g_spawn_close_pid()) @pid must not be closed while the
4246 * source is still active. Typically, you will want to call
4247 * g_spawn_close_pid() in the callback function for the source.
4249 * GLib supports only a single callback per process id.
4251 * This internally creates a main loop source using
4252 * g_child_watch_source_new() and attaches it to the main loop context
4253 * using g_source_attach(). You can do these steps manually if you
4254 * need greater control.
4256 * Return value: the ID (greater than 0) of the event source.
4261 g_child_watch_add_full (gint priority,
4263 GChildWatchFunc function,
4265 GDestroyNotify notify)
4270 g_return_val_if_fail (function != NULL, 0);
4272 source = g_child_watch_source_new (pid);
4274 if (priority != G_PRIORITY_DEFAULT)
4275 g_source_set_priority (source, priority);
4277 g_source_set_callback (source, (GSourceFunc) function, data, notify);
4278 id = g_source_attach (source, NULL);
4279 g_source_unref (source);
4285 * g_child_watch_add:
4286 * @pid: process id to watch. On POSIX the pid of a child process. On
4287 * Windows a handle for a process (which doesn't have to be a child).
4288 * @function: function to call
4289 * @data: data to pass to @function
4291 * Sets a function to be called when the child indicated by @pid
4292 * exits, at a default priority, #G_PRIORITY_DEFAULT.
4294 * If you obtain @pid from g_spawn_async() or g_spawn_async_with_pipes()
4295 * you will need to pass #G_SPAWN_DO_NOT_REAP_CHILD as flag to
4296 * the spawn function for the child watching to work.
4298 * Note that on platforms where #GPid must be explicitly closed
4299 * (see g_spawn_close_pid()) @pid must not be closed while the
4300 * source is still active. Typically, you will want to call
4301 * g_spawn_close_pid() in the callback function for the source.
4303 * GLib supports only a single callback per process id.
4305 * This internally creates a main loop source using
4306 * g_child_watch_source_new() and attaches it to the main loop context
4307 * using g_source_attach(). You can do these steps manually if you
4308 * need greater control.
4310 * Return value: the ID (greater than 0) of the event source.
4315 g_child_watch_add (GPid pid,
4316 GChildWatchFunc function,
4319 return g_child_watch_add_full (G_PRIORITY_DEFAULT, pid, function, data, NULL);
4323 /* Idle functions */
4326 g_idle_prepare (GSource *source,
4335 g_idle_check (GSource *source)
4341 g_idle_dispatch (GSource *source,
4342 GSourceFunc callback,
4347 g_warning ("Idle source dispatched without callback\n"
4348 "You must call g_source_set_callback().");
4352 return callback (user_data);
4356 * g_idle_source_new:
4358 * Creates a new idle source.
4360 * The source will not initially be associated with any #GMainContext
4361 * and must be added to one with g_source_attach() before it will be
4362 * executed. Note that the default priority for idle sources is
4363 * %G_PRIORITY_DEFAULT_IDLE, as compared to other sources which
4364 * have a default priority of %G_PRIORITY_DEFAULT.
4366 * Return value: the newly-created idle source
4369 g_idle_source_new (void)
4373 source = g_source_new (&g_idle_funcs, sizeof (GSource));
4374 g_source_set_priority (source, G_PRIORITY_DEFAULT_IDLE);
4381 * @priority: the priority of the idle source. Typically this will be in the
4382 * range between #G_PRIORITY_DEFAULT_IDLE and #G_PRIORITY_HIGH_IDLE.
4383 * @function: function to call
4384 * @data: data to pass to @function
4385 * @notify: function to call when the idle is removed, or %NULL
4387 * Adds a function to be called whenever there are no higher priority
4388 * events pending. If the function returns %FALSE it is automatically
4389 * removed from the list of event sources and will not be called again.
4391 * This internally creates a main loop source using g_idle_source_new()
4392 * and attaches it to the main loop context using g_source_attach().
4393 * You can do these steps manually if you need greater control.
4395 * Return value: the ID (greater than 0) of the event source.
4398 g_idle_add_full (gint priority,
4399 GSourceFunc function,
4401 GDestroyNotify notify)
4406 g_return_val_if_fail (function != NULL, 0);
4408 source = g_idle_source_new ();
4410 if (priority != G_PRIORITY_DEFAULT_IDLE)
4411 g_source_set_priority (source, priority);
4413 g_source_set_callback (source, function, data, notify);
4414 id = g_source_attach (source, NULL);
4415 g_source_unref (source);
4422 * @function: function to call
4423 * @data: data to pass to @function.
4425 * Adds a function to be called whenever there are no higher priority
4426 * events pending to the default main loop. The function is given the
4427 * default idle priority, #G_PRIORITY_DEFAULT_IDLE. If the function
4428 * returns %FALSE it is automatically removed from the list of event
4429 * sources and will not be called again.
4431 * This internally creates a main loop source using g_idle_source_new()
4432 * and attaches it to the main loop context using g_source_attach().
4433 * You can do these steps manually if you need greater control.
4435 * Return value: the ID (greater than 0) of the event source.
4438 g_idle_add (GSourceFunc function,
4441 return g_idle_add_full (G_PRIORITY_DEFAULT_IDLE, function, data, NULL);
4445 * g_idle_remove_by_data:
4446 * @data: the data for the idle source's callback.
4448 * Removes the idle function with the given data.
4450 * Return value: %TRUE if an idle source was found and removed.
4453 g_idle_remove_by_data (gpointer data)
4455 return g_source_remove_by_funcs_user_data (&g_idle_funcs, data);
4459 * g_main_context_invoke:
4460 * @context: a #GMainContext, or %NULL
4461 * @function: function to call
4462 * @data: data to pass to @function
4464 * Invokes a function in such a way that @context is owned during the
4465 * invocation of @function.
4467 * If @context is %NULL then the global default main context — as
4468 * returned by g_main_context_default() — is used.
4470 * If @context is owned by the current thread, @function is called
4471 * directly. Otherwise, if @context is the thread-default main context
4472 * of the current thread and g_main_context_acquire() succeeds, then
4473 * @function is called and g_main_context_release() is called
4476 * In any other case, an idle source is created to call @function and
4477 * that source is attached to @context (presumably to be run in another
4478 * thread). The idle source is attached with #G_PRIORITY_DEFAULT
4479 * priority. If you want a different priority, use
4480 * g_main_context_invoke_full().
4482 * Note that, as with normal idle functions, @function should probably
4483 * return %FALSE. If it returns %TRUE, it will be continuously run in a
4484 * loop (and may prevent this call from returning).
4489 g_main_context_invoke (GMainContext *context,
4490 GSourceFunc function,
4493 g_main_context_invoke_full (context,
4495 function, data, NULL);
4499 * g_main_context_invoke_full:
4500 * @context: a #GMainContext, or %NULL
4501 * @priority: the priority at which to run @function
4502 * @function: function to call
4503 * @data: data to pass to @function
4504 * @notify: a function to call when @data is no longer in use, or %NULL.
4506 * Invokes a function in such a way that @context is owned during the
4507 * invocation of @function.
4509 * This function is the same as g_main_context_invoke() except that it
4510 * lets you specify the priority incase @function ends up being
4511 * scheduled as an idle and also lets you give a #GDestroyNotify for @data.
4513 * @notify should not assume that it is called from any particular
4514 * thread or with any particular context acquired.
4519 g_main_context_invoke_full (GMainContext *context,
4521 GSourceFunc function,
4523 GDestroyNotify notify)
4525 g_return_if_fail (function != NULL);
4528 context = g_main_context_default ();
4530 if (g_main_context_is_owner (context))
4532 while (function (data));
4539 GMainContext *thread_default;
4541 thread_default = g_main_context_get_thread_default ();
4543 if (!thread_default)
4544 thread_default = g_main_context_default ();
4546 if (thread_default == context && g_main_context_acquire (context))
4548 while (function (data));
4550 g_main_context_release (context);
4559 source = g_idle_source_new ();
4560 g_source_set_priority (source, priority);
4561 g_source_set_callback (source, function, data, notify);
4562 g_source_attach (source, context);
4563 g_source_unref (source);