Modify child and signal sources to use worker
[platform/upstream/glib.git] / glib / gmain.c
1 /* GLIB - Library of useful routines for C programming
2  * Copyright (C) 1995-1997  Peter Mattis, Spencer Kimball and Josh MacDonald
3  *
4  * gmain.c: Main loop abstraction, timeouts, and idle functions
5  * Copyright 1998 Owen Taylor
6  *
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.
11  *
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.
16  *
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.
21  */
22
23 /*
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/.
28  */
29
30 /*
31  * MT safe
32  */
33
34 #include "config.h"
35 #include "glibconfig.h"
36
37 /* Uncomment the next line (and the corresponding line in gpoll.c) to
38  * enable debugging printouts if the environment variable
39  * G_MAIN_POLL_DEBUG is set to some value.
40  */
41 /* #define G_MAIN_POLL_DEBUG */
42
43 #ifdef _WIN32
44 /* Always enable debugging printout on Windows, as it is more often
45  * needed there...
46  */
47 #define G_MAIN_POLL_DEBUG
48 #endif
49
50 #ifdef G_OS_UNIX
51 #include "glib-unix.h"
52 #ifdef HAVE_EVENTFD
53 #include <sys/eventfd.h>
54 #endif
55 #endif
56
57 #include <signal.h>
58 #include <sys/types.h>
59 #include <time.h>
60 #include <stdlib.h>
61 #ifdef HAVE_SYS_TIME_H
62 #include <sys/time.h>
63 #endif /* HAVE_SYS_TIME_H */
64 #ifdef HAVE_UNISTD_H
65 #include <unistd.h>
66 #endif /* HAVE_UNISTD_H */
67 #include <errno.h>
68 #include <string.h>
69
70 #ifdef G_OS_WIN32
71 #define STRICT
72 #include <windows.h>
73 #endif /* G_OS_WIN32 */
74
75 #ifdef G_OS_BEOS
76 #include <sys/socket.h>
77 #include <sys/wait.h>
78 #endif /* G_OS_BEOS */
79
80 #include "gmain.h"
81
82 #include "garray.h"
83 #include "giochannel.h"
84 #include "ghash.h"
85 #include "ghook.h"
86 #include "gqueue.h"
87 #include "gstrfuncs.h"
88 #include "gtestutils.h"
89 #include "gthreadprivate.h"
90
91 #ifdef G_OS_WIN32
92 #include "gwin32.h"
93 #endif
94
95 #ifdef  G_MAIN_POLL_DEBUG
96 #include "gtimer.h"
97 #endif
98
99 #include "gwakeup.h"
100
101 #include "glibprivate.h"
102
103 /**
104  * SECTION:main
105  * @title: The Main Event Loop
106  * @short_description: manages all available sources of events
107  *
108  * The main event loop manages all the available sources of events for
109  * GLib and GTK+ applications. These events can come from any number of
110  * different types of sources such as file descriptors (plain files,
111  * pipes or sockets) and timeouts. New types of event sources can also
112  * be added using g_source_attach().
113  *
114  * To allow multiple independent sets of sources to be handled in
115  * different threads, each source is associated with a #GMainContext.
116  * A GMainContext can only be running in a single thread, but
117  * sources can be added to it and removed from it from other threads.
118  *
119  * Each event source is assigned a priority. The default priority,
120  * #G_PRIORITY_DEFAULT, is 0. Values less than 0 denote higher priorities.
121  * Values greater than 0 denote lower priorities. Events from high priority
122  * sources are always processed before events from lower priority sources.
123  *
124  * Idle functions can also be added, and assigned a priority. These will
125  * be run whenever no events with a higher priority are ready to be processed.
126  *
127  * The #GMainLoop data type represents a main event loop. A GMainLoop is
128  * created with g_main_loop_new(). After adding the initial event sources,
129  * g_main_loop_run() is called. This continuously checks for new events from
130  * each of the event sources and dispatches them. Finally, the processing of
131  * an event from one of the sources leads to a call to g_main_loop_quit() to
132  * exit the main loop, and g_main_loop_run() returns.
133  *
134  * It is possible to create new instances of #GMainLoop recursively.
135  * This is often used in GTK+ applications when showing modal dialog
136  * boxes. Note that event sources are associated with a particular
137  * #GMainContext, and will be checked and dispatched for all main
138  * loops associated with that GMainContext.
139  *
140  * GTK+ contains wrappers of some of these functions, e.g. gtk_main(),
141  * gtk_main_quit() and gtk_events_pending().
142  *
143  * <refsect2><title>Creating new source types</title>
144  * <para>One of the unusual features of the #GMainLoop functionality
145  * is that new types of event source can be created and used in
146  * addition to the builtin type of event source. A new event source
147  * type is used for handling GDK events. A new source type is created
148  * by <firstterm>deriving</firstterm> from the #GSource structure.
149  * The derived type of source is represented by a structure that has
150  * the #GSource structure as a first element, and other elements specific
151  * to the new source type. To create an instance of the new source type,
152  * call g_source_new() passing in the size of the derived structure and
153  * a table of functions. These #GSourceFuncs determine the behavior of
154  * the new source type.</para>
155  * <para>New source types basically interact with the main context
156  * in two ways. Their prepare function in #GSourceFuncs can set a timeout
157  * to determine the maximum amount of time that the main loop will sleep
158  * before checking the source again. In addition, or as well, the source
159  * can add file descriptors to the set that the main context checks using
160  * g_source_add_poll().</para>
161  * </refsect2>
162  * <refsect2><title>Customizing the main loop iteration</title>
163  * <para>Single iterations of a #GMainContext can be run with
164  * g_main_context_iteration(). In some cases, more detailed control
165  * of exactly how the details of the main loop work is desired, for
166  * instance, when integrating the #GMainLoop with an external main loop.
167  * In such cases, you can call the component functions of
168  * g_main_context_iteration() directly. These functions are
169  * g_main_context_prepare(), g_main_context_query(),
170  * g_main_context_check() and g_main_context_dispatch().</para>
171  * <para>The operation of these functions can best be seen in terms
172  * of a state diagram, as shown in <xref linkend="mainloop-states"/>.</para>
173  * <figure id="mainloop-states"><title>States of a Main Context</title>
174  * <graphic fileref="mainloop-states.gif" format="GIF"></graphic>
175  * </figure>
176  * </refsect2>
177  */
178
179 /* Types */
180
181 typedef struct _GTimeoutSource GTimeoutSource;
182 typedef struct _GChildWatchSource GChildWatchSource;
183 typedef struct _GUnixSignalWatchSource GUnixSignalWatchSource;
184 typedef struct _GPollRec GPollRec;
185 typedef struct _GSourceCallback GSourceCallback;
186
187 typedef enum
188 {
189   G_SOURCE_READY = 1 << G_HOOK_FLAG_USER_SHIFT,
190   G_SOURCE_CAN_RECURSE = 1 << (G_HOOK_FLAG_USER_SHIFT + 1)
191 } GSourceFlags;
192
193 typedef struct _GMainWaiter GMainWaiter;
194
195 struct _GMainWaiter
196 {
197   GCond *cond;
198   GMutex *mutex;
199 };
200
201 typedef struct _GMainDispatch GMainDispatch;
202
203 struct _GMainDispatch
204 {
205   gint depth;
206   GSList *dispatching_sources; /* stack of current sources */
207 };
208
209 #ifdef G_MAIN_POLL_DEBUG
210 gboolean _g_main_poll_debug = FALSE;
211 #endif
212
213 struct _GMainContext
214 {
215   /* The following lock is used for both the list of sources
216    * and the list of poll records
217    */
218   GStaticMutex mutex;
219   GCond *cond;
220   GThread *owner;
221   guint owner_count;
222   GSList *waiters;
223
224   gint ref_count;
225
226   GPtrArray *pending_dispatches;
227   gint timeout;                 /* Timeout for current iteration */
228
229   guint next_id;
230   GSource *source_list;
231   gint in_check_or_prepare;
232
233   GPollRec *poll_records, *poll_records_tail;
234   guint n_poll_records;
235   GPollFD *cached_poll_array;
236   guint cached_poll_array_size;
237
238   GWakeup *wakeup;
239
240   GPollFD wake_up_rec;
241   gboolean poll_waiting;
242
243 /* Flag indicating whether the set of fd's changed during a poll */
244   gboolean poll_changed;
245
246   GPollFunc poll_func;
247
248   gint64   time;
249   gboolean time_is_fresh;
250   gint64   real_time;
251   gboolean real_time_is_fresh;
252 };
253
254 struct _GSourceCallback
255 {
256   guint ref_count;
257   GSourceFunc func;
258   gpointer    data;
259   GDestroyNotify notify;
260 };
261
262 struct _GMainLoop
263 {
264   GMainContext *context;
265   gboolean is_running;
266   gint ref_count;
267 };
268
269 struct _GTimeoutSource
270 {
271   GSource     source;
272   gint64      expiration;
273   guint       interval;
274   gboolean    seconds;
275 };
276
277 struct _GChildWatchSource
278 {
279   GSource     source;
280   GPid        pid;
281   gint        child_status;
282 #ifdef G_OS_WIN32
283   GPollFD     poll;
284 #else /* G_OS_WIN32 */
285   gboolean    child_exited;
286 #endif /* G_OS_WIN32 */
287 };
288
289 struct _GUnixSignalWatchSource
290 {
291   GSource     source;
292   int         signum;
293   gboolean    pending;
294 };
295
296 struct _GPollRec
297 {
298   GPollFD *fd;
299   GPollRec *prev;
300   GPollRec *next;
301   gint priority;
302 };
303
304 struct _GSourcePrivate
305 {
306   GSList *child_sources;
307   GSource *parent_source;
308 };
309
310 #define LOCK_CONTEXT(context) g_static_mutex_lock (&context->mutex)
311 #define UNLOCK_CONTEXT(context) g_static_mutex_unlock (&context->mutex)
312 #define G_THREAD_SELF g_thread_self ()
313
314 #define SOURCE_DESTROYED(source) (((source)->flags & G_HOOK_FLAG_ACTIVE) == 0)
315 #define SOURCE_BLOCKED(source) (((source)->flags & G_HOOK_FLAG_IN_CALL) != 0 && \
316                                 ((source)->flags & G_SOURCE_CAN_RECURSE) == 0)
317
318 #define SOURCE_UNREF(source, context)                       \
319    G_STMT_START {                                           \
320     if ((source)->ref_count > 1)                            \
321       (source)->ref_count--;                                \
322     else                                                    \
323       g_source_unref_internal ((source), (context), TRUE);  \
324    } G_STMT_END
325
326
327 /* Forward declarations */
328
329 static void g_source_unref_internal             (GSource      *source,
330                                                  GMainContext *context,
331                                                  gboolean      have_lock);
332 static void g_source_destroy_internal           (GSource      *source,
333                                                  GMainContext *context,
334                                                  gboolean      have_lock);
335 static void g_source_set_priority_unlocked      (GSource      *source,
336                                                  GMainContext *context,
337                                                  gint          priority);
338 static void g_main_context_poll                 (GMainContext *context,
339                                                  gint          timeout,
340                                                  gint          priority,
341                                                  GPollFD      *fds,
342                                                  gint          n_fds);
343 static void g_main_context_add_poll_unlocked    (GMainContext *context,
344                                                  gint          priority,
345                                                  GPollFD      *fd);
346 static void g_main_context_remove_poll_unlocked (GMainContext *context,
347                                                  GPollFD      *fd);
348 static void g_main_context_wakeup_unlocked      (GMainContext *context);
349
350 static gboolean g_timeout_prepare  (GSource     *source,
351                                     gint        *timeout);
352 static gboolean g_timeout_check    (GSource     *source);
353 static gboolean g_timeout_dispatch (GSource     *source,
354                                     GSourceFunc  callback,
355                                     gpointer     user_data);
356 static gboolean g_child_watch_prepare  (GSource     *source,
357                                         gint        *timeout);
358 static gboolean g_child_watch_check    (GSource     *source);
359 static gboolean g_child_watch_dispatch (GSource     *source,
360                                         GSourceFunc  callback,
361                                         gpointer     user_data);
362 static void     g_child_watch_finalize (GSource     *source);
363 #ifdef G_OS_UNIX
364 static void g_unix_signal_handler (int signum);
365 static gboolean g_unix_signal_watch_prepare  (GSource     *source,
366                                               gint        *timeout);
367 static gboolean g_unix_signal_watch_check    (GSource     *source);
368 static gboolean g_unix_signal_watch_dispatch (GSource     *source,
369                                               GSourceFunc  callback,
370                                               gpointer     user_data);
371 static void     g_unix_signal_watch_finalize  (GSource     *source);
372 #endif
373 static gboolean g_idle_prepare     (GSource     *source,
374                                     gint        *timeout);
375 static gboolean g_idle_check       (GSource     *source);
376 static gboolean g_idle_dispatch    (GSource     *source,
377                                     GSourceFunc  callback,
378                                     gpointer     user_data);
379
380 static GMainContext *glib_worker_context;
381
382 G_LOCK_DEFINE_STATIC (main_loop);
383 static GMainContext *default_main_context;
384
385 #ifndef G_OS_WIN32
386
387
388 /* UNIX signals work by marking one of these variables then waking the
389  * worker context to check on them and dispatch accordingly.
390  */
391 static volatile gchar unix_signal_pending[NSIG];
392 static volatile gboolean any_unix_signal_pending;
393
394 /* Guards all the data below */
395 G_LOCK_DEFINE_STATIC (unix_signal_lock);
396 static GSList *unix_signal_watches;
397 static GSList *unix_child_watches;
398
399 static GSourceFuncs g_unix_signal_funcs =
400 {
401   g_unix_signal_watch_prepare,
402   g_unix_signal_watch_check,
403   g_unix_signal_watch_dispatch,
404   g_unix_signal_watch_finalize
405 };
406 #endif /* !G_OS_WIN32 */
407 G_LOCK_DEFINE_STATIC (main_context_list);
408 static GSList *main_context_list = NULL;
409
410 GSourceFuncs g_timeout_funcs =
411 {
412   g_timeout_prepare,
413   g_timeout_check,
414   g_timeout_dispatch,
415   NULL
416 };
417
418 GSourceFuncs g_child_watch_funcs =
419 {
420   g_child_watch_prepare,
421   g_child_watch_check,
422   g_child_watch_dispatch,
423   g_child_watch_finalize
424 };
425
426 GSourceFuncs g_idle_funcs =
427 {
428   g_idle_prepare,
429   g_idle_check,
430   g_idle_dispatch,
431   NULL
432 };
433
434 /**
435  * g_main_context_ref:
436  * @context: a #GMainContext
437  * 
438  * Increases the reference count on a #GMainContext object by one.
439  *
440  * Returns: the @context that was passed in (since 2.6)
441  **/
442 GMainContext *
443 g_main_context_ref (GMainContext *context)
444 {
445   g_return_val_if_fail (context != NULL, NULL);
446   g_return_val_if_fail (g_atomic_int_get (&context->ref_count) > 0, NULL); 
447
448   g_atomic_int_inc (&context->ref_count);
449
450   return context;
451 }
452
453 static inline void
454 poll_rec_list_free (GMainContext *context,
455                     GPollRec     *list)
456 {
457   g_slice_free_chain (GPollRec, list, next);
458 }
459
460 /**
461  * g_main_context_unref:
462  * @context: a #GMainContext
463  * 
464  * Decreases the reference count on a #GMainContext object by one. If
465  * the result is zero, free the context and free all associated memory.
466  **/
467 void
468 g_main_context_unref (GMainContext *context)
469 {
470   GSource *source;
471   g_return_if_fail (context != NULL);
472   g_return_if_fail (g_atomic_int_get (&context->ref_count) > 0); 
473
474   if (!g_atomic_int_dec_and_test (&context->ref_count))
475     return;
476
477   G_LOCK (main_context_list);
478   main_context_list = g_slist_remove (main_context_list, context);
479   G_UNLOCK (main_context_list);
480
481   source = context->source_list;
482   while (source)
483     {
484       GSource *next = source->next;
485       g_source_destroy_internal (source, context, FALSE);
486       source = next;
487     }
488
489   g_static_mutex_free (&context->mutex);
490
491   g_ptr_array_free (context->pending_dispatches, TRUE);
492   g_free (context->cached_poll_array);
493
494   poll_rec_list_free (context, context->poll_records);
495
496   g_wakeup_free (context->wakeup);
497
498   if (context->cond != NULL)
499     g_cond_free (context->cond);
500
501   g_free (context);
502 }
503
504 static void
505 g_main_context_init_pipe (GMainContext *context)
506 {
507   context->wakeup = g_wakeup_new ();
508   g_wakeup_get_pollfd (context->wakeup, &context->wake_up_rec);
509   g_main_context_add_poll_unlocked (context, 0, &context->wake_up_rec);
510 }
511
512 /**
513  * g_main_context_new:
514  * 
515  * Creates a new #GMainContext structure.
516  * 
517  * Return value: the new #GMainContext
518  **/
519 GMainContext *
520 g_main_context_new (void)
521 {
522   GMainContext *context;
523
524   g_thread_init_glib ();
525
526   context = g_new0 (GMainContext, 1);
527
528 #ifdef G_MAIN_POLL_DEBUG
529   {
530     static gboolean beenhere = FALSE;
531
532     if (!beenhere)
533       {
534         if (getenv ("G_MAIN_POLL_DEBUG") != NULL)
535           _g_main_poll_debug = TRUE;
536         beenhere = TRUE;
537       }
538   }
539 #endif
540
541   g_static_mutex_init (&context->mutex);
542
543   context->owner = NULL;
544   context->waiters = NULL;
545
546   context->ref_count = 1;
547
548   context->next_id = 1;
549   
550   context->source_list = NULL;
551   
552   context->poll_func = g_poll;
553   
554   context->cached_poll_array = NULL;
555   context->cached_poll_array_size = 0;
556   
557   context->pending_dispatches = g_ptr_array_new ();
558   
559   context->time_is_fresh = FALSE;
560   context->real_time_is_fresh = FALSE;
561   
562   g_main_context_init_pipe (context);
563
564   G_LOCK (main_context_list);
565   main_context_list = g_slist_append (main_context_list, context);
566
567 #ifdef G_MAIN_POLL_DEBUG
568   if (_g_main_poll_debug)
569     g_print ("created context=%p\n", context);
570 #endif
571
572   G_UNLOCK (main_context_list);
573
574   return context;
575 }
576
577 /**
578  * g_main_context_default:
579  * 
580  * Returns the global default main context. This is the main context
581  * used for main loop functions when a main loop is not explicitly
582  * specified, and corresponds to the "main" main loop. See also
583  * g_main_context_get_thread_default().
584  * 
585  * Return value: (transfer none): the global default main context.
586  **/
587 GMainContext *
588 g_main_context_default (void)
589 {
590   /* Slow, but safe */
591   
592   G_LOCK (main_loop);
593
594   if (!default_main_context)
595     {
596       default_main_context = g_main_context_new ();
597 #ifdef G_MAIN_POLL_DEBUG
598       if (_g_main_poll_debug)
599         g_print ("default context=%p\n", default_main_context);
600 #endif
601     }
602
603   G_UNLOCK (main_loop);
604
605   return default_main_context;
606 }
607
608 static GStaticPrivate thread_context_stack = G_STATIC_PRIVATE_INIT;
609
610 static void
611 free_context_stack (gpointer data)
612 {
613   GQueue *stack = data;
614   GMainContext *context;
615
616   while (!g_queue_is_empty (stack))
617     {
618       context = g_queue_pop_head (stack);
619       g_main_context_release (context);
620       if (context)
621         g_main_context_unref (context);
622     }
623   g_queue_free (stack);
624 }
625
626 /**
627  * g_main_context_push_thread_default:
628  * @context: a #GMainContext, or %NULL for the global default context
629  *
630  * Acquires @context and sets it as the thread-default context for the
631  * current thread. This will cause certain asynchronous operations
632  * (such as most <link linkend="gio">gio</link>-based I/O) which are
633  * started in this thread to run under @context and deliver their
634  * results to its main loop, rather than running under the global
635  * default context in the main thread. Note that calling this function
636  * changes the context returned by
637  * g_main_context_get_thread_default(), <emphasis>not</emphasis> the
638  * one returned by g_main_context_default(), so it does not affect the
639  * context used by functions like g_idle_add().
640  *
641  * Normally you would call this function shortly after creating a new
642  * thread, passing it a #GMainContext which will be run by a
643  * #GMainLoop in that thread, to set a new default context for all
644  * async operations in that thread. (In this case, you don't need to
645  * ever call g_main_context_pop_thread_default().) In some cases
646  * however, you may want to schedule a single operation in a
647  * non-default context, or temporarily use a non-default context in
648  * the main thread. In that case, you can wrap the call to the
649  * asynchronous operation inside a
650  * g_main_context_push_thread_default() /
651  * g_main_context_pop_thread_default() pair, but it is up to you to
652  * ensure that no other asynchronous operations accidentally get
653  * started while the non-default context is active.
654  *
655  * Beware that libraries that predate this function may not correctly
656  * handle being used from a thread with a thread-default context. Eg,
657  * see g_file_supports_thread_contexts().
658  *
659  * Since: 2.22
660  **/
661 void
662 g_main_context_push_thread_default (GMainContext *context)
663 {
664   GQueue *stack;
665   gboolean acquired_context;
666
667   acquired_context = g_main_context_acquire (context);
668   g_return_if_fail (acquired_context);
669
670   if (context == g_main_context_default ())
671     context = NULL;
672   else if (context)
673     g_main_context_ref (context);
674
675   stack = g_static_private_get (&thread_context_stack);
676   if (!stack)
677     {
678       stack = g_queue_new ();
679       g_static_private_set (&thread_context_stack, stack,
680                             free_context_stack);
681     }
682
683   g_queue_push_head (stack, context);
684 }
685
686 /**
687  * g_main_context_pop_thread_default:
688  * @context: a #GMainContext object, or %NULL
689  *
690  * Pops @context off the thread-default context stack (verifying that
691  * it was on the top of the stack).
692  *
693  * Since: 2.22
694  **/
695 void
696 g_main_context_pop_thread_default (GMainContext *context)
697 {
698   GQueue *stack;
699
700   if (context == g_main_context_default ())
701     context = NULL;
702
703   stack = g_static_private_get (&thread_context_stack);
704
705   g_return_if_fail (stack != NULL);
706   g_return_if_fail (g_queue_peek_head (stack) == context);
707
708   g_queue_pop_head (stack);
709
710   g_main_context_release (context);
711   if (context)
712     g_main_context_unref (context);
713 }
714
715 /**
716  * g_main_context_get_thread_default:
717  *
718  * Gets the thread-default #GMainContext for this thread. Asynchronous
719  * operations that want to be able to be run in contexts other than
720  * the default one should call this method to get a #GMainContext to
721  * add their #GSource<!-- -->s to. (Note that even in single-threaded
722  * programs applications may sometimes want to temporarily push a
723  * non-default context, so it is not safe to assume that this will
724  * always return %NULL if threads are not initialized.)
725  *
726  * Returns: (transfer none): the thread-default #GMainContext, or
727  * %NULL if the thread-default context is the global default context.
728  *
729  * Since: 2.22
730  **/
731 GMainContext *
732 g_main_context_get_thread_default (void)
733 {
734   GQueue *stack;
735
736   stack = g_static_private_get (&thread_context_stack);
737   if (stack)
738     return g_queue_peek_head (stack);
739   else
740     return NULL;
741 }
742
743 /* Hooks for adding to the main loop */
744
745 /**
746  * g_source_new:
747  * @source_funcs: structure containing functions that implement
748  *                the sources behavior.
749  * @struct_size: size of the #GSource structure to create.
750  * 
751  * Creates a new #GSource structure. The size is specified to
752  * allow creating structures derived from #GSource that contain
753  * additional data. The size passed in must be at least
754  * <literal>sizeof (GSource)</literal>.
755  * 
756  * The source will not initially be associated with any #GMainContext
757  * and must be added to one with g_source_attach() before it will be
758  * executed.
759  * 
760  * Return value: the newly-created #GSource.
761  **/
762 GSource *
763 g_source_new (GSourceFuncs *source_funcs,
764               guint         struct_size)
765 {
766   GSource *source;
767
768   g_return_val_if_fail (source_funcs != NULL, NULL);
769   g_return_val_if_fail (struct_size >= sizeof (GSource), NULL);
770   
771   source = (GSource*) g_malloc0 (struct_size);
772
773   source->source_funcs = source_funcs;
774   source->ref_count = 1;
775   
776   source->priority = G_PRIORITY_DEFAULT;
777
778   source->flags = G_HOOK_FLAG_ACTIVE;
779
780   /* NULL/0 initialization for all other fields */
781   
782   return source;
783 }
784
785 /* Holds context's lock
786  */
787 static void
788 g_source_list_add (GSource      *source,
789                    GMainContext *context)
790 {
791   GSource *tmp_source, *last_source;
792   
793   if (source->priv && source->priv->parent_source)
794     {
795       /* Put the source immediately before its parent */
796       tmp_source = source->priv->parent_source;
797       last_source = source->priv->parent_source->prev;
798     }
799   else
800     {
801       last_source = NULL;
802       tmp_source = context->source_list;
803       while (tmp_source && tmp_source->priority <= source->priority)
804         {
805           last_source = tmp_source;
806           tmp_source = tmp_source->next;
807         }
808     }
809
810   source->next = tmp_source;
811   if (tmp_source)
812     tmp_source->prev = source;
813   
814   source->prev = last_source;
815   if (last_source)
816     last_source->next = source;
817   else
818     context->source_list = source;
819 }
820
821 /* Holds context's lock
822  */
823 static void
824 g_source_list_remove (GSource      *source,
825                       GMainContext *context)
826 {
827   if (source->prev)
828     source->prev->next = source->next;
829   else
830     context->source_list = source->next;
831
832   if (source->next)
833     source->next->prev = source->prev;
834
835   source->prev = NULL;
836   source->next = NULL;
837 }
838
839 static guint
840 g_source_attach_unlocked (GSource      *source,
841                           GMainContext *context)
842 {
843   guint result = 0;
844   GSList *tmp_list;
845
846   source->context = context;
847   result = source->source_id = context->next_id++;
848
849   source->ref_count++;
850   g_source_list_add (source, context);
851
852   tmp_list = source->poll_fds;
853   while (tmp_list)
854     {
855       g_main_context_add_poll_unlocked (context, source->priority, tmp_list->data);
856       tmp_list = tmp_list->next;
857     }
858
859   if (source->priv)
860     {
861       tmp_list = source->priv->child_sources;
862       while (tmp_list)
863         {
864           g_source_attach_unlocked (tmp_list->data, context);
865           tmp_list = tmp_list->next;
866         }
867     }
868
869   return result;
870 }
871
872 /**
873  * g_source_attach:
874  * @source: a #GSource
875  * @context: a #GMainContext (if %NULL, the default context will be used)
876  * 
877  * Adds a #GSource to a @context so that it will be executed within
878  * that context. Remove it by calling g_source_destroy().
879  *
880  * Return value: the ID (greater than 0) for the source within the 
881  *   #GMainContext. 
882  **/
883 guint
884 g_source_attach (GSource      *source,
885                  GMainContext *context)
886 {
887   guint result = 0;
888
889   g_return_val_if_fail (source->context == NULL, 0);
890   g_return_val_if_fail (!SOURCE_DESTROYED (source), 0);
891   
892   if (!context)
893     context = g_main_context_default ();
894
895   LOCK_CONTEXT (context);
896
897   result = g_source_attach_unlocked (source, context);
898
899   /* Now wake up the main loop if it is waiting in the poll() */
900   g_main_context_wakeup_unlocked (context);
901
902   UNLOCK_CONTEXT (context);
903
904   return result;
905 }
906
907 static void
908 g_source_destroy_internal (GSource      *source,
909                            GMainContext *context,
910                            gboolean      have_lock)
911 {
912   if (!have_lock)
913     LOCK_CONTEXT (context);
914   
915   if (!SOURCE_DESTROYED (source))
916     {
917       GSList *tmp_list;
918       gpointer old_cb_data;
919       GSourceCallbackFuncs *old_cb_funcs;
920       
921       source->flags &= ~G_HOOK_FLAG_ACTIVE;
922
923       old_cb_data = source->callback_data;
924       old_cb_funcs = source->callback_funcs;
925
926       source->callback_data = NULL;
927       source->callback_funcs = NULL;
928
929       if (old_cb_funcs)
930         {
931           UNLOCK_CONTEXT (context);
932           old_cb_funcs->unref (old_cb_data);
933           LOCK_CONTEXT (context);
934         }
935
936       if (!SOURCE_BLOCKED (source))
937         {
938           tmp_list = source->poll_fds;
939           while (tmp_list)
940             {
941               g_main_context_remove_poll_unlocked (context, tmp_list->data);
942               tmp_list = tmp_list->next;
943             }
944         }
945
946       if (source->priv && source->priv->child_sources)
947         {
948           /* This is safe because even if a child_source finalizer or
949            * closure notify tried to modify source->priv->child_sources
950            * from outside the lock, it would fail since
951            * SOURCE_DESTROYED(source) is now TRUE.
952            */
953           tmp_list = source->priv->child_sources;
954           while (tmp_list)
955             {
956               g_source_destroy_internal (tmp_list->data, context, TRUE);
957               g_source_unref_internal (tmp_list->data, context, TRUE);
958               tmp_list = tmp_list->next;
959             }
960           g_slist_free (source->priv->child_sources);
961           source->priv->child_sources = NULL;
962         }
963           
964       g_source_unref_internal (source, context, TRUE);
965     }
966
967   if (!have_lock)
968     UNLOCK_CONTEXT (context);
969 }
970
971 /**
972  * g_source_destroy:
973  * @source: a #GSource
974  * 
975  * Removes a source from its #GMainContext, if any, and mark it as
976  * destroyed.  The source cannot be subsequently added to another
977  * context.
978  **/
979 void
980 g_source_destroy (GSource *source)
981 {
982   GMainContext *context;
983   
984   g_return_if_fail (source != NULL);
985   
986   context = source->context;
987   
988   if (context)
989     g_source_destroy_internal (source, context, FALSE);
990   else
991     source->flags &= ~G_HOOK_FLAG_ACTIVE;
992 }
993
994 /**
995  * g_source_get_id:
996  * @source: a #GSource
997  * 
998  * Returns the numeric ID for a particular source. The ID of a source
999  * is a positive integer which is unique within a particular main loop 
1000  * context. The reverse
1001  * mapping from ID to source is done by g_main_context_find_source_by_id().
1002  *
1003  * Return value: the ID (greater than 0) for the source
1004  **/
1005 guint
1006 g_source_get_id (GSource *source)
1007 {
1008   guint result;
1009   
1010   g_return_val_if_fail (source != NULL, 0);
1011   g_return_val_if_fail (source->context != NULL, 0);
1012
1013   LOCK_CONTEXT (source->context);
1014   result = source->source_id;
1015   UNLOCK_CONTEXT (source->context);
1016   
1017   return result;
1018 }
1019
1020 /**
1021  * g_source_get_context:
1022  * @source: a #GSource
1023  * 
1024  * Gets the #GMainContext with which the source is associated.
1025  * Calling this function on a destroyed source is an error.
1026  * 
1027  * Return value: (transfer none): the #GMainContext with which the
1028  *               source is associated, or %NULL if the context has not
1029  *               yet been added to a source.
1030  **/
1031 GMainContext *
1032 g_source_get_context (GSource *source)
1033 {
1034   g_return_val_if_fail (!SOURCE_DESTROYED (source), NULL);
1035
1036   return source->context;
1037 }
1038
1039 /**
1040  * g_source_add_poll:
1041  * @source:a #GSource 
1042  * @fd: a #GPollFD structure holding information about a file
1043  *      descriptor to watch.
1044  * 
1045  * Adds a file descriptor to the set of file descriptors polled for
1046  * this source. This is usually combined with g_source_new() to add an
1047  * event source. The event source's check function will typically test
1048  * the @revents field in the #GPollFD struct and return %TRUE if events need
1049  * to be processed.
1050  **/
1051 void
1052 g_source_add_poll (GSource *source,
1053                    GPollFD *fd)
1054 {
1055   GMainContext *context;
1056   
1057   g_return_if_fail (source != NULL);
1058   g_return_if_fail (fd != NULL);
1059   g_return_if_fail (!SOURCE_DESTROYED (source));
1060   
1061   context = source->context;
1062
1063   if (context)
1064     LOCK_CONTEXT (context);
1065   
1066   source->poll_fds = g_slist_prepend (source->poll_fds, fd);
1067
1068   if (context)
1069     {
1070       if (!SOURCE_BLOCKED (source))
1071         g_main_context_add_poll_unlocked (context, source->priority, fd);
1072       UNLOCK_CONTEXT (context);
1073     }
1074 }
1075
1076 /**
1077  * g_source_remove_poll:
1078  * @source:a #GSource 
1079  * @fd: a #GPollFD structure previously passed to g_source_add_poll().
1080  * 
1081  * Removes a file descriptor from the set of file descriptors polled for
1082  * this source. 
1083  **/
1084 void
1085 g_source_remove_poll (GSource *source,
1086                       GPollFD *fd)
1087 {
1088   GMainContext *context;
1089   
1090   g_return_if_fail (source != NULL);
1091   g_return_if_fail (fd != NULL);
1092   g_return_if_fail (!SOURCE_DESTROYED (source));
1093   
1094   context = source->context;
1095
1096   if (context)
1097     LOCK_CONTEXT (context);
1098   
1099   source->poll_fds = g_slist_remove (source->poll_fds, fd);
1100
1101   if (context)
1102     {
1103       if (!SOURCE_BLOCKED (source))
1104         g_main_context_remove_poll_unlocked (context, fd);
1105       UNLOCK_CONTEXT (context);
1106     }
1107 }
1108
1109 /**
1110  * g_source_add_child_source:
1111  * @source:a #GSource
1112  * @child_source: a second #GSource that @source should "poll"
1113  *
1114  * Adds @child_source to @source as a "polled" source; when @source is
1115  * added to a #GMainContext, @child_source will be automatically added
1116  * with the same priority, when @child_source is triggered, it will
1117  * cause @source to dispatch (in addition to calling its own
1118  * callback), and when @source is destroyed, it will destroy
1119  * @child_source as well. (@source will also still be dispatched if
1120  * its own prepare/check functions indicate that it is ready.)
1121  *
1122  * If you don't need @child_source to do anything on its own when it
1123  * triggers, you can call g_source_set_dummy_callback() on it to set a
1124  * callback that does nothing (except return %TRUE if appropriate).
1125  *
1126  * @source will hold a reference on @child_source while @child_source
1127  * is attached to it.
1128  *
1129  * Since: 2.28
1130  **/
1131 void
1132 g_source_add_child_source (GSource *source,
1133                            GSource *child_source)
1134 {
1135   GMainContext *context;
1136
1137   g_return_if_fail (source != NULL);
1138   g_return_if_fail (child_source != NULL);
1139   g_return_if_fail (!SOURCE_DESTROYED (source));
1140   g_return_if_fail (!SOURCE_DESTROYED (child_source));
1141   g_return_if_fail (child_source->context == NULL);
1142   g_return_if_fail (child_source->priv == NULL || child_source->priv->parent_source == NULL);
1143
1144   context = source->context;
1145
1146   if (context)
1147     LOCK_CONTEXT (context);
1148
1149   if (!source->priv)
1150     source->priv = g_slice_new0 (GSourcePrivate);
1151   if (!child_source->priv)
1152     child_source->priv = g_slice_new0 (GSourcePrivate);
1153
1154   source->priv->child_sources = g_slist_prepend (source->priv->child_sources,
1155                                                  g_source_ref (child_source));
1156   child_source->priv->parent_source = source;
1157   g_source_set_priority_unlocked (child_source, context, source->priority);
1158
1159   if (context)
1160     {
1161       UNLOCK_CONTEXT (context);
1162       g_source_attach (child_source, context);
1163     }
1164 }
1165
1166 /**
1167  * g_source_remove_child_source:
1168  * @source:a #GSource
1169  * @child_source: a #GSource previously passed to
1170  *     g_source_add_child_source().
1171  *
1172  * Detaches @child_source from @source and destroys it.
1173  *
1174  * Since: 2.28
1175  **/
1176 void
1177 g_source_remove_child_source (GSource *source,
1178                               GSource *child_source)
1179 {
1180   GMainContext *context;
1181
1182   g_return_if_fail (source != NULL);
1183   g_return_if_fail (child_source != NULL);
1184   g_return_if_fail (child_source->priv != NULL && child_source->priv->parent_source == source);
1185   g_return_if_fail (!SOURCE_DESTROYED (source));
1186   g_return_if_fail (!SOURCE_DESTROYED (child_source));
1187
1188   context = source->context;
1189
1190   if (context)
1191     LOCK_CONTEXT (context);
1192
1193   source->priv->child_sources = g_slist_remove (source->priv->child_sources, child_source);
1194   g_source_destroy_internal (child_source, context, TRUE);
1195   g_source_unref_internal (child_source, context, TRUE);
1196
1197   if (context)
1198     UNLOCK_CONTEXT (context);
1199 }
1200
1201 /**
1202  * g_source_set_callback_indirect:
1203  * @source: the source
1204  * @callback_data: pointer to callback data "object"
1205  * @callback_funcs: functions for reference counting @callback_data
1206  *                  and getting the callback and data
1207  * 
1208  * Sets the callback function storing the data as a refcounted callback
1209  * "object". This is used internally. Note that calling 
1210  * g_source_set_callback_indirect() assumes
1211  * an initial reference count on @callback_data, and thus
1212  * @callback_funcs->unref will eventually be called once more
1213  * than @callback_funcs->ref.
1214  **/
1215 void
1216 g_source_set_callback_indirect (GSource              *source,
1217                                 gpointer              callback_data,
1218                                 GSourceCallbackFuncs *callback_funcs)
1219 {
1220   GMainContext *context;
1221   gpointer old_cb_data;
1222   GSourceCallbackFuncs *old_cb_funcs;
1223   
1224   g_return_if_fail (source != NULL);
1225   g_return_if_fail (callback_funcs != NULL || callback_data == NULL);
1226
1227   context = source->context;
1228
1229   if (context)
1230     LOCK_CONTEXT (context);
1231
1232   old_cb_data = source->callback_data;
1233   old_cb_funcs = source->callback_funcs;
1234
1235   source->callback_data = callback_data;
1236   source->callback_funcs = callback_funcs;
1237   
1238   if (context)
1239     UNLOCK_CONTEXT (context);
1240   
1241   if (old_cb_funcs)
1242     old_cb_funcs->unref (old_cb_data);
1243 }
1244
1245 static void
1246 g_source_callback_ref (gpointer cb_data)
1247 {
1248   GSourceCallback *callback = cb_data;
1249
1250   callback->ref_count++;
1251 }
1252
1253
1254 static void
1255 g_source_callback_unref (gpointer cb_data)
1256 {
1257   GSourceCallback *callback = cb_data;
1258
1259   callback->ref_count--;
1260   if (callback->ref_count == 0)
1261     {
1262       if (callback->notify)
1263         callback->notify (callback->data);
1264       g_free (callback);
1265     }
1266 }
1267
1268 static void
1269 g_source_callback_get (gpointer     cb_data,
1270                        GSource     *source, 
1271                        GSourceFunc *func,
1272                        gpointer    *data)
1273 {
1274   GSourceCallback *callback = cb_data;
1275
1276   *func = callback->func;
1277   *data = callback->data;
1278 }
1279
1280 static GSourceCallbackFuncs g_source_callback_funcs = {
1281   g_source_callback_ref,
1282   g_source_callback_unref,
1283   g_source_callback_get,
1284 };
1285
1286 /**
1287  * g_source_set_callback:
1288  * @source: the source
1289  * @func: a callback function
1290  * @data: the data to pass to callback function
1291  * @notify: a function to call when @data is no longer in use, or %NULL.
1292  * 
1293  * Sets the callback function for a source. The callback for a source is
1294  * called from the source's dispatch function.
1295  *
1296  * The exact type of @func depends on the type of source; ie. you
1297  * should not count on @func being called with @data as its first
1298  * parameter.
1299  * 
1300  * Typically, you won't use this function. Instead use functions specific
1301  * to the type of source you are using.
1302  **/
1303 void
1304 g_source_set_callback (GSource        *source,
1305                        GSourceFunc     func,
1306                        gpointer        data,
1307                        GDestroyNotify  notify)
1308 {
1309   GSourceCallback *new_callback;
1310
1311   g_return_if_fail (source != NULL);
1312
1313   new_callback = g_new (GSourceCallback, 1);
1314
1315   new_callback->ref_count = 1;
1316   new_callback->func = func;
1317   new_callback->data = data;
1318   new_callback->notify = notify;
1319
1320   g_source_set_callback_indirect (source, new_callback, &g_source_callback_funcs);
1321 }
1322
1323
1324 /**
1325  * g_source_set_funcs:
1326  * @source: a #GSource
1327  * @funcs: the new #GSourceFuncs
1328  * 
1329  * Sets the source functions (can be used to override 
1330  * default implementations) of an unattached source.
1331  * 
1332  * Since: 2.12
1333  */
1334 void
1335 g_source_set_funcs (GSource     *source,
1336                    GSourceFuncs *funcs)
1337 {
1338   g_return_if_fail (source != NULL);
1339   g_return_if_fail (source->context == NULL);
1340   g_return_if_fail (source->ref_count > 0);
1341   g_return_if_fail (funcs != NULL);
1342
1343   source->source_funcs = funcs;
1344 }
1345
1346 static void
1347 g_source_set_priority_unlocked (GSource      *source,
1348                                 GMainContext *context,
1349                                 gint          priority)
1350 {
1351   GSList *tmp_list;
1352   
1353   source->priority = priority;
1354
1355   if (context)
1356     {
1357       /* Remove the source from the context's source and then
1358        * add it back so it is sorted in the correct place
1359        */
1360       g_source_list_remove (source, source->context);
1361       g_source_list_add (source, source->context);
1362
1363       if (!SOURCE_BLOCKED (source))
1364         {
1365           tmp_list = source->poll_fds;
1366           while (tmp_list)
1367             {
1368               g_main_context_remove_poll_unlocked (context, tmp_list->data);
1369               g_main_context_add_poll_unlocked (context, priority, tmp_list->data);
1370               
1371               tmp_list = tmp_list->next;
1372             }
1373         }
1374     }
1375
1376   if (source->priv && source->priv->child_sources)
1377     {
1378       tmp_list = source->priv->child_sources;
1379       while (tmp_list)
1380         {
1381           g_source_set_priority_unlocked (tmp_list->data, context, priority);
1382           tmp_list = tmp_list->next;
1383         }
1384     }
1385 }
1386
1387 /**
1388  * g_source_set_priority:
1389  * @source: a #GSource
1390  * @priority: the new priority.
1391  *
1392  * Sets the priority of a source. While the main loop is being run, a
1393  * source will be dispatched if it is ready to be dispatched and no
1394  * sources at a higher (numerically smaller) priority are ready to be
1395  * dispatched.
1396  **/
1397 void
1398 g_source_set_priority (GSource  *source,
1399                        gint      priority)
1400 {
1401   GMainContext *context;
1402
1403   g_return_if_fail (source != NULL);
1404
1405   context = source->context;
1406
1407   if (context)
1408     LOCK_CONTEXT (context);
1409   g_source_set_priority_unlocked (source, context, priority);
1410   if (context)
1411     UNLOCK_CONTEXT (source->context);
1412 }
1413
1414 /**
1415  * g_source_get_priority:
1416  * @source: a #GSource
1417  * 
1418  * Gets the priority of a source.
1419  * 
1420  * Return value: the priority of the source
1421  **/
1422 gint
1423 g_source_get_priority (GSource *source)
1424 {
1425   g_return_val_if_fail (source != NULL, 0);
1426
1427   return source->priority;
1428 }
1429
1430 /**
1431  * g_source_set_can_recurse:
1432  * @source: a #GSource
1433  * @can_recurse: whether recursion is allowed for this source
1434  * 
1435  * Sets whether a source can be called recursively. If @can_recurse is
1436  * %TRUE, then while the source is being dispatched then this source
1437  * will be processed normally. Otherwise, all processing of this
1438  * source is blocked until the dispatch function returns.
1439  **/
1440 void
1441 g_source_set_can_recurse (GSource  *source,
1442                           gboolean  can_recurse)
1443 {
1444   GMainContext *context;
1445   
1446   g_return_if_fail (source != NULL);
1447
1448   context = source->context;
1449
1450   if (context)
1451     LOCK_CONTEXT (context);
1452   
1453   if (can_recurse)
1454     source->flags |= G_SOURCE_CAN_RECURSE;
1455   else
1456     source->flags &= ~G_SOURCE_CAN_RECURSE;
1457
1458   if (context)
1459     UNLOCK_CONTEXT (context);
1460 }
1461
1462 /**
1463  * g_source_get_can_recurse:
1464  * @source: a #GSource
1465  * 
1466  * Checks whether a source is allowed to be called recursively.
1467  * see g_source_set_can_recurse().
1468  * 
1469  * Return value: whether recursion is allowed.
1470  **/
1471 gboolean
1472 g_source_get_can_recurse (GSource  *source)
1473 {
1474   g_return_val_if_fail (source != NULL, FALSE);
1475   
1476   return (source->flags & G_SOURCE_CAN_RECURSE) != 0;
1477 }
1478
1479
1480 /**
1481  * g_source_set_name:
1482  * @source: a #GSource
1483  * @name: debug name for the source
1484  *
1485  * Sets a name for the source, used in debugging and profiling.
1486  * The name defaults to #NULL.
1487  *
1488  * The source name should describe in a human-readable way
1489  * what the source does. For example, "X11 event queue"
1490  * or "GTK+ repaint idle handler" or whatever it is.
1491  *
1492  * It is permitted to call this function multiple times, but is not
1493  * recommended due to the potential performance impact.  For example,
1494  * one could change the name in the "check" function of a #GSourceFuncs 
1495  * to include details like the event type in the source name.
1496  *
1497  * Since: 2.26
1498  **/
1499 void
1500 g_source_set_name (GSource    *source,
1501                    const char *name)
1502 {
1503   g_return_if_fail (source != NULL);
1504
1505   /* setting back to NULL is allowed, just because it's
1506    * weird if get_name can return NULL but you can't
1507    * set that.
1508    */
1509
1510   g_free (source->name);
1511   source->name = g_strdup (name);
1512 }
1513
1514 /**
1515  * g_source_get_name:
1516  * @source: a #GSource
1517  *
1518  * Gets a name for the source, used in debugging and profiling.
1519  * The name may be #NULL if it has never been set with
1520  * g_source_set_name().
1521  *
1522  * Return value: the name of the source
1523  * Since: 2.26
1524  **/
1525 const char *
1526 g_source_get_name (GSource *source)
1527 {
1528   g_return_val_if_fail (source != NULL, NULL);
1529
1530   return source->name;
1531 }
1532
1533 /**
1534  * g_source_set_name_by_id:
1535  * @tag: a #GSource ID
1536  * @name: debug name for the source
1537  *
1538  * Sets the name of a source using its ID.
1539  *
1540  * This is a convenience utility to set source names from the return
1541  * value of g_idle_add(), g_timeout_add(), etc.
1542  *
1543  * Since: 2.26
1544  **/
1545 void
1546 g_source_set_name_by_id (guint           tag,
1547                          const char     *name)
1548 {
1549   GSource *source;
1550
1551   g_return_if_fail (tag > 0);
1552
1553   source = g_main_context_find_source_by_id (NULL, tag);
1554   if (source == NULL)
1555     return;
1556
1557   g_source_set_name (source, name);
1558 }
1559
1560
1561 /**
1562  * g_source_ref:
1563  * @source: a #GSource
1564  * 
1565  * Increases the reference count on a source by one.
1566  * 
1567  * Return value: @source
1568  **/
1569 GSource *
1570 g_source_ref (GSource *source)
1571 {
1572   GMainContext *context;
1573   
1574   g_return_val_if_fail (source != NULL, NULL);
1575
1576   context = source->context;
1577
1578   if (context)
1579     LOCK_CONTEXT (context);
1580
1581   source->ref_count++;
1582
1583   if (context)
1584     UNLOCK_CONTEXT (context);
1585
1586   return source;
1587 }
1588
1589 /* g_source_unref() but possible to call within context lock
1590  */
1591 static void
1592 g_source_unref_internal (GSource      *source,
1593                          GMainContext *context,
1594                          gboolean      have_lock)
1595 {
1596   gpointer old_cb_data = NULL;
1597   GSourceCallbackFuncs *old_cb_funcs = NULL;
1598
1599   g_return_if_fail (source != NULL);
1600   
1601   if (!have_lock && context)
1602     LOCK_CONTEXT (context);
1603
1604   source->ref_count--;
1605   if (source->ref_count == 0)
1606     {
1607       old_cb_data = source->callback_data;
1608       old_cb_funcs = source->callback_funcs;
1609
1610       source->callback_data = NULL;
1611       source->callback_funcs = NULL;
1612
1613       if (context)
1614         {
1615           if (!SOURCE_DESTROYED (source))
1616             g_warning (G_STRLOC ": ref_count == 0, but source was still attached to a context!");
1617           g_source_list_remove (source, context);
1618         }
1619
1620       if (source->source_funcs->finalize)
1621         {
1622           if (context)
1623             UNLOCK_CONTEXT (context);
1624           source->source_funcs->finalize (source);
1625           if (context)
1626             LOCK_CONTEXT (context);
1627         }
1628
1629       g_free (source->name);
1630       source->name = NULL;
1631
1632       g_slist_free (source->poll_fds);
1633       source->poll_fds = NULL;
1634
1635       if (source->priv)
1636         {
1637           g_slice_free (GSourcePrivate, source->priv);
1638           source->priv = NULL;
1639         }
1640
1641       g_free (source);
1642     }
1643   
1644   if (!have_lock && context)
1645     UNLOCK_CONTEXT (context);
1646
1647   if (old_cb_funcs)
1648     {
1649       if (have_lock)
1650         UNLOCK_CONTEXT (context);
1651       
1652       old_cb_funcs->unref (old_cb_data);
1653
1654       if (have_lock)
1655         LOCK_CONTEXT (context);
1656     }
1657 }
1658
1659 /**
1660  * g_source_unref:
1661  * @source: a #GSource
1662  * 
1663  * Decreases the reference count of a source by one. If the
1664  * resulting reference count is zero the source and associated
1665  * memory will be destroyed. 
1666  **/
1667 void
1668 g_source_unref (GSource *source)
1669 {
1670   g_return_if_fail (source != NULL);
1671
1672   g_source_unref_internal (source, source->context, FALSE);
1673 }
1674
1675 /**
1676  * g_main_context_find_source_by_id:
1677  * @context: a #GMainContext (if %NULL, the default context will be used)
1678  * @source_id: the source ID, as returned by g_source_get_id(). 
1679  * 
1680  * Finds a #GSource given a pair of context and ID.
1681  * 
1682  * Return value: (transfer none): the #GSource if found, otherwise, %NULL
1683  **/
1684 GSource *
1685 g_main_context_find_source_by_id (GMainContext *context,
1686                                   guint         source_id)
1687 {
1688   GSource *source;
1689   
1690   g_return_val_if_fail (source_id > 0, NULL);
1691
1692   if (context == NULL)
1693     context = g_main_context_default ();
1694   
1695   LOCK_CONTEXT (context);
1696   
1697   source = context->source_list;
1698   while (source)
1699     {
1700       if (!SOURCE_DESTROYED (source) &&
1701           source->source_id == source_id)
1702         break;
1703       source = source->next;
1704     }
1705
1706   UNLOCK_CONTEXT (context);
1707
1708   return source;
1709 }
1710
1711 /**
1712  * g_main_context_find_source_by_funcs_user_data:
1713  * @context: a #GMainContext (if %NULL, the default context will be used).
1714  * @funcs: the @source_funcs passed to g_source_new().
1715  * @user_data: the user data from the callback.
1716  * 
1717  * Finds a source with the given source functions and user data.  If
1718  * multiple sources exist with the same source function and user data,
1719  * the first one found will be returned.
1720  * 
1721  * Return value: (transfer none): the source, if one was found, otherwise %NULL
1722  **/
1723 GSource *
1724 g_main_context_find_source_by_funcs_user_data (GMainContext *context,
1725                                                GSourceFuncs *funcs,
1726                                                gpointer      user_data)
1727 {
1728   GSource *source;
1729   
1730   g_return_val_if_fail (funcs != NULL, NULL);
1731
1732   if (context == NULL)
1733     context = g_main_context_default ();
1734   
1735   LOCK_CONTEXT (context);
1736
1737   source = context->source_list;
1738   while (source)
1739     {
1740       if (!SOURCE_DESTROYED (source) &&
1741           source->source_funcs == funcs &&
1742           source->callback_funcs)
1743         {
1744           GSourceFunc callback;
1745           gpointer callback_data;
1746
1747           source->callback_funcs->get (source->callback_data, source, &callback, &callback_data);
1748           
1749           if (callback_data == user_data)
1750             break;
1751         }
1752       source = source->next;
1753     }
1754
1755   UNLOCK_CONTEXT (context);
1756
1757   return source;
1758 }
1759
1760 /**
1761  * g_main_context_find_source_by_user_data:
1762  * @context: a #GMainContext
1763  * @user_data: the user_data for the callback.
1764  * 
1765  * Finds a source with the given user data for the callback.  If
1766  * multiple sources exist with the same user data, the first
1767  * one found will be returned.
1768  * 
1769  * Return value: (transfer none): the source, if one was found, otherwise %NULL
1770  **/
1771 GSource *
1772 g_main_context_find_source_by_user_data (GMainContext *context,
1773                                          gpointer      user_data)
1774 {
1775   GSource *source;
1776   
1777   if (context == NULL)
1778     context = g_main_context_default ();
1779   
1780   LOCK_CONTEXT (context);
1781
1782   source = context->source_list;
1783   while (source)
1784     {
1785       if (!SOURCE_DESTROYED (source) &&
1786           source->callback_funcs)
1787         {
1788           GSourceFunc callback;
1789           gpointer callback_data = NULL;
1790
1791           source->callback_funcs->get (source->callback_data, source, &callback, &callback_data);
1792
1793           if (callback_data == user_data)
1794             break;
1795         }
1796       source = source->next;
1797     }
1798
1799   UNLOCK_CONTEXT (context);
1800
1801   return source;
1802 }
1803
1804 /**
1805  * g_source_remove:
1806  * @tag: the ID of the source to remove.
1807  * 
1808  * Removes the source with the given id from the default main context. 
1809  * The id of
1810  * a #GSource is given by g_source_get_id(), or will be returned by the
1811  * functions g_source_attach(), g_idle_add(), g_idle_add_full(),
1812  * g_timeout_add(), g_timeout_add_full(), g_child_watch_add(),
1813  * g_child_watch_add_full(), g_io_add_watch(), and g_io_add_watch_full().
1814  *
1815  * See also g_source_destroy(). You must use g_source_destroy() for sources
1816  * added to a non-default main context.
1817  *
1818  * Return value: %TRUE if the source was found and removed.
1819  **/
1820 gboolean
1821 g_source_remove (guint tag)
1822 {
1823   GSource *source;
1824   
1825   g_return_val_if_fail (tag > 0, FALSE);
1826
1827   source = g_main_context_find_source_by_id (NULL, tag);
1828   if (source)
1829     g_source_destroy (source);
1830
1831   return source != NULL;
1832 }
1833
1834 /**
1835  * g_source_remove_by_user_data:
1836  * @user_data: the user_data for the callback.
1837  * 
1838  * Removes a source from the default main loop context given the user
1839  * data for the callback. If multiple sources exist with the same user
1840  * data, only one will be destroyed.
1841  * 
1842  * Return value: %TRUE if a source was found and removed. 
1843  **/
1844 gboolean
1845 g_source_remove_by_user_data (gpointer user_data)
1846 {
1847   GSource *source;
1848   
1849   source = g_main_context_find_source_by_user_data (NULL, user_data);
1850   if (source)
1851     {
1852       g_source_destroy (source);
1853       return TRUE;
1854     }
1855   else
1856     return FALSE;
1857 }
1858
1859 /**
1860  * g_source_remove_by_funcs_user_data:
1861  * @funcs: The @source_funcs passed to g_source_new()
1862  * @user_data: the user data for the callback
1863  * 
1864  * Removes a source from the default main loop context given the
1865  * source functions and user data. If multiple sources exist with the
1866  * same source functions and user data, only one will be destroyed.
1867  * 
1868  * Return value: %TRUE if a source was found and removed. 
1869  **/
1870 gboolean
1871 g_source_remove_by_funcs_user_data (GSourceFuncs *funcs,
1872                                     gpointer      user_data)
1873 {
1874   GSource *source;
1875
1876   g_return_val_if_fail (funcs != NULL, FALSE);
1877
1878   source = g_main_context_find_source_by_funcs_user_data (NULL, funcs, user_data);
1879   if (source)
1880     {
1881       g_source_destroy (source);
1882       return TRUE;
1883     }
1884   else
1885     return FALSE;
1886 }
1887
1888 /**
1889  * g_get_current_time:
1890  * @result: #GTimeVal structure in which to store current time.
1891  *
1892  * Equivalent to the UNIX gettimeofday() function, but portable.
1893  *
1894  * You may find g_get_real_time() to be more convenient.
1895  **/
1896 void
1897 g_get_current_time (GTimeVal *result)
1898 {
1899 #ifndef G_OS_WIN32
1900   struct timeval r;
1901
1902   g_return_if_fail (result != NULL);
1903
1904   /*this is required on alpha, there the timeval structs are int's
1905     not longs and a cast only would fail horribly*/
1906   gettimeofday (&r, NULL);
1907   result->tv_sec = r.tv_sec;
1908   result->tv_usec = r.tv_usec;
1909 #else
1910   FILETIME ft;
1911   guint64 time64;
1912
1913   g_return_if_fail (result != NULL);
1914
1915   GetSystemTimeAsFileTime (&ft);
1916   memmove (&time64, &ft, sizeof (FILETIME));
1917
1918   /* Convert from 100s of nanoseconds since 1601-01-01
1919    * to Unix epoch. Yes, this is Y2038 unsafe.
1920    */
1921   time64 -= G_GINT64_CONSTANT (116444736000000000);
1922   time64 /= 10;
1923
1924   result->tv_sec = time64 / 1000000;
1925   result->tv_usec = time64 % 1000000;
1926 #endif
1927 }
1928
1929 /**
1930  * g_get_real_time:
1931  *
1932  * Queries the system wall-clock time.
1933  *
1934  * This call is functionally equivalent to g_get_current_time() except
1935  * that the return value is often more convenient than dealing with a
1936  * #GTimeVal.
1937  *
1938  * You should only use this call if you are actually interested in the real
1939  * wall-clock time.  g_get_monotonic_time() is probably more useful for
1940  * measuring intervals.
1941  *
1942  * Returns: the number of microseconds since January 1, 1970 UTC.
1943  *
1944  * Since: 2.28
1945  **/
1946 gint64
1947 g_get_real_time (void)
1948 {
1949   GTimeVal tv;
1950
1951   g_get_current_time (&tv);
1952
1953   return (((gint64) tv.tv_sec) * 1000000) + tv.tv_usec;
1954 }
1955
1956 /**
1957  * g_get_monotonic_time:
1958  *
1959  * Queries the system monotonic time, if available.
1960  *
1961  * On POSIX systems with clock_gettime() and %CLOCK_MONOTONIC this call
1962  * is a very shallow wrapper for that.  Otherwise, we make a best effort
1963  * that probably involves returning the wall clock time (with at least
1964  * microsecond accuracy, subject to the limitations of the OS kernel).
1965  *
1966  * It's important to note that POSIX %CLOCK_MONOTONIC does not count
1967  * time spent while the machine is suspended.
1968  *
1969  * On Windows, "limitations of the OS kernel" is a rather substantial
1970  * statement.  Depending on the configuration of the system, the wall
1971  * clock time is updated as infrequently as 64 times a second (which
1972  * is approximately every 16ms).
1973  *
1974  * Returns: the monotonic time, in microseconds
1975  *
1976  * Since: 2.28
1977  **/
1978 gint64
1979 g_get_monotonic_time (void)
1980 {
1981 #ifdef HAVE_CLOCK_GETTIME
1982   /* librt clock_gettime() is our first choice */
1983   {
1984 #ifdef HAVE_MONOTONIC_CLOCK
1985     static volatile gsize clockid = 0;
1986 #else
1987     static clockid_t clockid = CLOCK_REALTIME;
1988 #endif
1989     struct timespec ts;
1990
1991 #ifdef HAVE_MONOTONIC_CLOCK
1992     if (g_once_init_enter (&clockid))
1993       {
1994         clockid_t best_clockid;
1995
1996         if (sysconf (_SC_MONOTONIC_CLOCK) >= 0)
1997           best_clockid = CLOCK_MONOTONIC;
1998         else
1999           best_clockid = CLOCK_REALTIME;
2000         g_once_init_leave (&clockid, (gsize)best_clockid);
2001       }
2002 #endif
2003
2004     clock_gettime (clockid, &ts);
2005
2006     /* In theory monotonic time can have any epoch.
2007      *
2008      * glib presently assumes the following:
2009      *
2010      *   1) The epoch comes some time after the birth of Jesus of Nazareth, but
2011      *      not more than 10000 years later.
2012      *
2013      *   2) The current time also falls sometime within this range.
2014      *
2015      * These two reasonable assumptions leave us with a maximum deviation from
2016      * the epoch of 10000 years, or 315569520000000000 seconds.
2017      *
2018      * If we restrict ourselves to this range then the number of microseconds
2019      * will always fit well inside the constraints of a int64 (by a factor of
2020      * about 29).
2021      *
2022      * If you actually hit the following assertion, probably you should file a
2023      * bug against your operating system for being excessively silly.
2024      **/
2025     g_assert (G_GINT64_CONSTANT (-315569520000000000) < ts.tv_sec &&
2026               ts.tv_sec < G_GINT64_CONSTANT (315569520000000000));
2027
2028     return (((gint64) ts.tv_sec) * 1000000) + (ts.tv_nsec / 1000);
2029   }
2030 #else
2031   /* It may look like we are discarding accuracy on Windows (since its
2032    * current time is expressed in 100s of nanoseconds) but according to
2033    * many sources, the time is only updated 64 times per second, so
2034    * microsecond accuracy is more than enough.
2035    */
2036   {
2037     GTimeVal tv;
2038
2039     g_get_current_time (&tv);
2040
2041     return (((gint64) tv.tv_sec) * 1000000) + tv.tv_usec;
2042   }
2043 #endif
2044 }
2045
2046 static void
2047 g_main_dispatch_free (gpointer dispatch)
2048 {
2049   g_slice_free (GMainDispatch, dispatch);
2050 }
2051
2052 /* Running the main loop */
2053
2054 static GMainDispatch *
2055 get_dispatch (void)
2056 {
2057   static GStaticPrivate depth_private = G_STATIC_PRIVATE_INIT;
2058   GMainDispatch *dispatch = g_static_private_get (&depth_private);
2059   if (!dispatch)
2060     {
2061       dispatch = g_slice_new0 (GMainDispatch);
2062       g_static_private_set (&depth_private, dispatch, g_main_dispatch_free);
2063     }
2064
2065   return dispatch;
2066 }
2067
2068 /**
2069  * g_main_depth:
2070  *
2071  * Returns the depth of the stack of calls to
2072  * g_main_context_dispatch() on any #GMainContext in the current thread.
2073  *  That is, when called from the toplevel, it gives 0. When
2074  * called from within a callback from g_main_context_iteration()
2075  * (or g_main_loop_run(), etc.) it returns 1. When called from within 
2076  * a callback to a recursive call to g_main_context_iteration(),
2077  * it returns 2. And so forth.
2078  *
2079  * This function is useful in a situation like the following:
2080  * Imagine an extremely simple "garbage collected" system.
2081  *
2082  * |[
2083  * static GList *free_list;
2084  * 
2085  * gpointer
2086  * allocate_memory (gsize size)
2087  * { 
2088  *   gpointer result = g_malloc (size);
2089  *   free_list = g_list_prepend (free_list, result);
2090  *   return result;
2091  * }
2092  * 
2093  * void
2094  * free_allocated_memory (void)
2095  * {
2096  *   GList *l;
2097  *   for (l = free_list; l; l = l->next);
2098  *     g_free (l->data);
2099  *   g_list_free (free_list);
2100  *   free_list = NULL;
2101  *  }
2102  * 
2103  * [...]
2104  * 
2105  * while (TRUE); 
2106  *  {
2107  *    g_main_context_iteration (NULL, TRUE);
2108  *    free_allocated_memory();
2109  *   }
2110  * ]|
2111  *
2112  * This works from an application, however, if you want to do the same
2113  * thing from a library, it gets more difficult, since you no longer
2114  * control the main loop. You might think you can simply use an idle
2115  * function to make the call to free_allocated_memory(), but that
2116  * doesn't work, since the idle function could be called from a
2117  * recursive callback. This can be fixed by using g_main_depth()
2118  *
2119  * |[
2120  * gpointer
2121  * allocate_memory (gsize size)
2122  * { 
2123  *   FreeListBlock *block = g_new (FreeListBlock, 1);
2124  *   block->mem = g_malloc (size);
2125  *   block->depth = g_main_depth ();   
2126  *   free_list = g_list_prepend (free_list, block);
2127  *   return block->mem;
2128  * }
2129  * 
2130  * void
2131  * free_allocated_memory (void)
2132  * {
2133  *   GList *l;
2134  *   
2135  *   int depth = g_main_depth ();
2136  *   for (l = free_list; l; );
2137  *     {
2138  *       GList *next = l->next;
2139  *       FreeListBlock *block = l->data;
2140  *       if (block->depth > depth)
2141  *         {
2142  *           g_free (block->mem);
2143  *           g_free (block);
2144  *           free_list = g_list_delete_link (free_list, l);
2145  *         }
2146  *               
2147  *       l = next;
2148  *     }
2149  *   }
2150  * ]|
2151  *
2152  * There is a temptation to use g_main_depth() to solve
2153  * problems with reentrancy. For instance, while waiting for data
2154  * to be received from the network in response to a menu item,
2155  * the menu item might be selected again. It might seem that
2156  * one could make the menu item's callback return immediately
2157  * and do nothing if g_main_depth() returns a value greater than 1.
2158  * However, this should be avoided since the user then sees selecting
2159  * the menu item do nothing. Furthermore, you'll find yourself adding
2160  * these checks all over your code, since there are doubtless many,
2161  * many things that the user could do. Instead, you can use the
2162  * following techniques:
2163  *
2164  * <orderedlist>
2165  *  <listitem>
2166  *   <para>
2167  *     Use gtk_widget_set_sensitive() or modal dialogs to prevent
2168  *     the user from interacting with elements while the main
2169  *     loop is recursing.
2170  *   </para>
2171  *  </listitem>
2172  *  <listitem>
2173  *   <para>
2174  *     Avoid main loop recursion in situations where you can't handle
2175  *     arbitrary  callbacks. Instead, structure your code so that you
2176  *     simply return to the main loop and then get called again when
2177  *     there is more work to do.
2178  *   </para>
2179  *  </listitem>
2180  * </orderedlist>
2181  * 
2182  * Return value: The main loop recursion level in the current thread
2183  **/
2184 int
2185 g_main_depth (void)
2186 {
2187   GMainDispatch *dispatch = get_dispatch ();
2188   return dispatch->depth;
2189 }
2190
2191 /**
2192  * g_main_current_source:
2193  *
2194  * Returns the currently firing source for this thread.
2195  * 
2196  * Return value: (transfer none): The currently firing source or %NULL.
2197  *
2198  * Since: 2.12
2199  */
2200 GSource *
2201 g_main_current_source (void)
2202 {
2203   GMainDispatch *dispatch = get_dispatch ();
2204   return dispatch->dispatching_sources ? dispatch->dispatching_sources->data : NULL;
2205 }
2206
2207 /**
2208  * g_source_is_destroyed:
2209  * @source: a #GSource
2210  *
2211  * Returns whether @source has been destroyed.
2212  *
2213  * This is important when you operate upon your objects 
2214  * from within idle handlers, but may have freed the object 
2215  * before the dispatch of your idle handler.
2216  *
2217  * |[
2218  * static gboolean 
2219  * idle_callback (gpointer data)
2220  * {
2221  *   SomeWidget *self = data;
2222  *    
2223  *   GDK_THREADS_ENTER (<!-- -->);
2224  *   /<!-- -->* do stuff with self *<!-- -->/
2225  *   self->idle_id = 0;
2226  *   GDK_THREADS_LEAVE (<!-- -->);
2227  *    
2228  *   return FALSE;
2229  * }
2230  *  
2231  * static void 
2232  * some_widget_do_stuff_later (SomeWidget *self)
2233  * {
2234  *   self->idle_id = g_idle_add (idle_callback, self);
2235  * }
2236  *  
2237  * static void 
2238  * some_widget_finalize (GObject *object)
2239  * {
2240  *   SomeWidget *self = SOME_WIDGET (object);
2241  *    
2242  *   if (self->idle_id)
2243  *     g_source_remove (self->idle_id);
2244  *    
2245  *   G_OBJECT_CLASS (parent_class)->finalize (object);
2246  * }
2247  * ]|
2248  *
2249  * This will fail in a multi-threaded application if the 
2250  * widget is destroyed before the idle handler fires due 
2251  * to the use after free in the callback. A solution, to 
2252  * this particular problem, is to check to if the source
2253  * has already been destroy within the callback.
2254  *
2255  * |[
2256  * static gboolean 
2257  * idle_callback (gpointer data)
2258  * {
2259  *   SomeWidget *self = data;
2260  *   
2261  *   GDK_THREADS_ENTER ();
2262  *   if (!g_source_is_destroyed (g_main_current_source ()))
2263  *     {
2264  *       /<!-- -->* do stuff with self *<!-- -->/
2265  *     }
2266  *   GDK_THREADS_LEAVE ();
2267  *   
2268  *   return FALSE;
2269  * }
2270  * ]|
2271  *
2272  * Return value: %TRUE if the source has been destroyed
2273  *
2274  * Since: 2.12
2275  */
2276 gboolean
2277 g_source_is_destroyed (GSource *source)
2278 {
2279   return SOURCE_DESTROYED (source);
2280 }
2281
2282 /* Temporarily remove all this source's file descriptors from the
2283  * poll(), so that if data comes available for one of the file descriptors
2284  * we don't continually spin in the poll()
2285  */
2286 /* HOLDS: source->context's lock */
2287 static void
2288 block_source (GSource *source)
2289 {
2290   GSList *tmp_list;
2291
2292   g_return_if_fail (!SOURCE_BLOCKED (source));
2293
2294   tmp_list = source->poll_fds;
2295   while (tmp_list)
2296     {
2297       g_main_context_remove_poll_unlocked (source->context, tmp_list->data);
2298       tmp_list = tmp_list->next;
2299     }
2300 }
2301
2302 /* HOLDS: source->context's lock */
2303 static void
2304 unblock_source (GSource *source)
2305 {
2306   GSList *tmp_list;
2307   
2308   g_return_if_fail (!SOURCE_BLOCKED (source)); /* Source already unblocked */
2309   g_return_if_fail (!SOURCE_DESTROYED (source));
2310   
2311   tmp_list = source->poll_fds;
2312   while (tmp_list)
2313     {
2314       g_main_context_add_poll_unlocked (source->context, source->priority, tmp_list->data);
2315       tmp_list = tmp_list->next;
2316     }
2317 }
2318
2319 /* HOLDS: context's lock */
2320 static void
2321 g_main_dispatch (GMainContext *context)
2322 {
2323   GMainDispatch *current = get_dispatch ();
2324   guint i;
2325
2326   for (i = 0; i < context->pending_dispatches->len; i++)
2327     {
2328       GSource *source = context->pending_dispatches->pdata[i];
2329
2330       context->pending_dispatches->pdata[i] = NULL;
2331       g_assert (source);
2332
2333       source->flags &= ~G_SOURCE_READY;
2334
2335       if (!SOURCE_DESTROYED (source))
2336         {
2337           gboolean was_in_call;
2338           gpointer user_data = NULL;
2339           GSourceFunc callback = NULL;
2340           GSourceCallbackFuncs *cb_funcs;
2341           gpointer cb_data;
2342           gboolean need_destroy;
2343
2344           gboolean (*dispatch) (GSource *,
2345                                 GSourceFunc,
2346                                 gpointer);
2347           GSList current_source_link;
2348
2349           dispatch = source->source_funcs->dispatch;
2350           cb_funcs = source->callback_funcs;
2351           cb_data = source->callback_data;
2352
2353           if (cb_funcs)
2354             cb_funcs->ref (cb_data);
2355           
2356           if ((source->flags & G_SOURCE_CAN_RECURSE) == 0)
2357             block_source (source);
2358           
2359           was_in_call = source->flags & G_HOOK_FLAG_IN_CALL;
2360           source->flags |= G_HOOK_FLAG_IN_CALL;
2361
2362           if (cb_funcs)
2363             cb_funcs->get (cb_data, source, &callback, &user_data);
2364
2365           UNLOCK_CONTEXT (context);
2366
2367           current->depth++;
2368           /* The on-stack allocation of the GSList is unconventional, but
2369            * we know that the lifetime of the link is bounded to this
2370            * function as the link is kept in a thread specific list and
2371            * not manipulated outside of this function and its descendants.
2372            * Avoiding the overhead of a g_slist_alloc() is useful as many
2373            * applications do little more than dispatch events.
2374            *
2375            * This is a performance hack - do not revert to g_slist_prepend()!
2376            */
2377           current_source_link.data = source;
2378           current_source_link.next = current->dispatching_sources;
2379           current->dispatching_sources = &current_source_link;
2380           need_destroy = ! dispatch (source,
2381                                      callback,
2382                                      user_data);
2383           g_assert (current->dispatching_sources == &current_source_link);
2384           current->dispatching_sources = current_source_link.next;
2385           current->depth--;
2386           
2387           if (cb_funcs)
2388             cb_funcs->unref (cb_data);
2389
2390           LOCK_CONTEXT (context);
2391           
2392           if (!was_in_call)
2393             source->flags &= ~G_HOOK_FLAG_IN_CALL;
2394
2395           if ((source->flags & G_SOURCE_CAN_RECURSE) == 0 &&
2396               !SOURCE_DESTROYED (source))
2397             unblock_source (source);
2398           
2399           /* Note: this depends on the fact that we can't switch
2400            * sources from one main context to another
2401            */
2402           if (need_destroy && !SOURCE_DESTROYED (source))
2403             {
2404               g_assert (source->context == context);
2405               g_source_destroy_internal (source, context, TRUE);
2406             }
2407         }
2408       
2409       SOURCE_UNREF (source, context);
2410     }
2411
2412   g_ptr_array_set_size (context->pending_dispatches, 0);
2413 }
2414
2415 /* Holds context's lock */
2416 static inline GSource *
2417 next_valid_source (GMainContext *context,
2418                    GSource      *source)
2419 {
2420   GSource *new_source = source ? source->next : context->source_list;
2421
2422   while (new_source)
2423     {
2424       if (!SOURCE_DESTROYED (new_source))
2425         {
2426           new_source->ref_count++;
2427           break;
2428         }
2429       
2430       new_source = new_source->next;
2431     }
2432
2433   if (source)
2434     SOURCE_UNREF (source, context);
2435           
2436   return new_source;
2437 }
2438
2439 /**
2440  * g_main_context_acquire:
2441  * @context: a #GMainContext
2442  * 
2443  * Tries to become the owner of the specified context.
2444  * If some other thread is the owner of the context,
2445  * returns %FALSE immediately. Ownership is properly
2446  * recursive: the owner can require ownership again
2447  * and will release ownership when g_main_context_release()
2448  * is called as many times as g_main_context_acquire().
2449  *
2450  * You must be the owner of a context before you
2451  * can call g_main_context_prepare(), g_main_context_query(),
2452  * g_main_context_check(), g_main_context_dispatch().
2453  * 
2454  * Return value: %TRUE if the operation succeeded, and
2455  *   this thread is now the owner of @context.
2456  **/
2457 gboolean 
2458 g_main_context_acquire (GMainContext *context)
2459 {
2460   gboolean result = FALSE;
2461   GThread *self = G_THREAD_SELF;
2462
2463   if (context == NULL)
2464     context = g_main_context_default ();
2465   
2466   LOCK_CONTEXT (context);
2467
2468   if (!context->owner)
2469     {
2470       context->owner = self;
2471       g_assert (context->owner_count == 0);
2472     }
2473
2474   if (context->owner == self)
2475     {
2476       context->owner_count++;
2477       result = TRUE;
2478     }
2479
2480   UNLOCK_CONTEXT (context); 
2481   
2482   return result;
2483 }
2484
2485 /**
2486  * g_main_context_release:
2487  * @context: a #GMainContext
2488  * 
2489  * Releases ownership of a context previously acquired by this thread
2490  * with g_main_context_acquire(). If the context was acquired multiple
2491  * times, the ownership will be released only when g_main_context_release()
2492  * is called as many times as it was acquired.
2493  **/
2494 void
2495 g_main_context_release (GMainContext *context)
2496 {
2497   if (context == NULL)
2498     context = g_main_context_default ();
2499   
2500   LOCK_CONTEXT (context);
2501
2502   context->owner_count--;
2503   if (context->owner_count == 0)
2504     {
2505       context->owner = NULL;
2506
2507       if (context->waiters)
2508         {
2509           GMainWaiter *waiter = context->waiters->data;
2510           gboolean loop_internal_waiter =
2511             (waiter->mutex == g_static_mutex_get_mutex (&context->mutex));
2512           context->waiters = g_slist_delete_link (context->waiters,
2513                                                   context->waiters);
2514           if (!loop_internal_waiter)
2515             g_mutex_lock (waiter->mutex);
2516           
2517           g_cond_signal (waiter->cond);
2518           
2519           if (!loop_internal_waiter)
2520             g_mutex_unlock (waiter->mutex);
2521         }
2522     }
2523
2524   UNLOCK_CONTEXT (context); 
2525 }
2526
2527 /**
2528  * g_main_context_wait:
2529  * @context: a #GMainContext
2530  * @cond: a condition variable
2531  * @mutex: a mutex, currently held
2532  * 
2533  * Tries to become the owner of the specified context,
2534  * as with g_main_context_acquire(). But if another thread
2535  * is the owner, atomically drop @mutex and wait on @cond until 
2536  * that owner releases ownership or until @cond is signaled, then
2537  * try again (once) to become the owner.
2538  * 
2539  * Return value: %TRUE if the operation succeeded, and
2540  *   this thread is now the owner of @context.
2541  **/
2542 gboolean
2543 g_main_context_wait (GMainContext *context,
2544                      GCond        *cond,
2545                      GMutex       *mutex)
2546 {
2547   gboolean result = FALSE;
2548   GThread *self = G_THREAD_SELF;
2549   gboolean loop_internal_waiter;
2550   
2551   if (context == NULL)
2552     context = g_main_context_default ();
2553
2554   loop_internal_waiter = (mutex == g_static_mutex_get_mutex (&context->mutex));
2555   
2556   if (!loop_internal_waiter)
2557     LOCK_CONTEXT (context);
2558
2559   if (context->owner && context->owner != self)
2560     {
2561       GMainWaiter waiter;
2562
2563       waiter.cond = cond;
2564       waiter.mutex = mutex;
2565
2566       context->waiters = g_slist_append (context->waiters, &waiter);
2567       
2568       if (!loop_internal_waiter)
2569         UNLOCK_CONTEXT (context);
2570       g_cond_wait (cond, mutex);
2571       if (!loop_internal_waiter)      
2572         LOCK_CONTEXT (context);
2573
2574       context->waiters = g_slist_remove (context->waiters, &waiter);
2575     }
2576
2577   if (!context->owner)
2578     {
2579       context->owner = self;
2580       g_assert (context->owner_count == 0);
2581     }
2582
2583   if (context->owner == self)
2584     {
2585       context->owner_count++;
2586       result = TRUE;
2587     }
2588
2589   if (!loop_internal_waiter)
2590     UNLOCK_CONTEXT (context); 
2591   
2592   return result;
2593 }
2594
2595 /**
2596  * g_main_context_prepare:
2597  * @context: a #GMainContext
2598  * @priority: location to store priority of highest priority
2599  *            source already ready.
2600  * 
2601  * Prepares to poll sources within a main loop. The resulting information
2602  * for polling is determined by calling g_main_context_query ().
2603  * 
2604  * Return value: %TRUE if some source is ready to be dispatched
2605  *               prior to polling.
2606  **/
2607 gboolean
2608 g_main_context_prepare (GMainContext *context,
2609                         gint         *priority)
2610 {
2611   gint i;
2612   gint n_ready = 0;
2613   gint current_priority = G_MAXINT;
2614   GSource *source;
2615
2616   if (context == NULL)
2617     context = g_main_context_default ();
2618   
2619   LOCK_CONTEXT (context);
2620
2621   context->time_is_fresh = FALSE;
2622   context->real_time_is_fresh = FALSE;
2623
2624   if (context->in_check_or_prepare)
2625     {
2626       g_warning ("g_main_context_prepare() called recursively from within a source's check() or "
2627                  "prepare() member.");
2628       UNLOCK_CONTEXT (context);
2629       return FALSE;
2630     }
2631
2632   if (context->poll_waiting)
2633     {
2634       g_warning("g_main_context_prepare(): main loop already active in another thread");
2635       UNLOCK_CONTEXT (context);
2636       return FALSE;
2637     }
2638   
2639   context->poll_waiting = TRUE;
2640
2641 #if 0
2642   /* If recursing, finish up current dispatch, before starting over */
2643   if (context->pending_dispatches)
2644     {
2645       if (dispatch)
2646         g_main_dispatch (context, &current_time);
2647       
2648       UNLOCK_CONTEXT (context);
2649       return TRUE;
2650     }
2651 #endif
2652
2653   /* If recursing, clear list of pending dispatches */
2654
2655   for (i = 0; i < context->pending_dispatches->len; i++)
2656     {
2657       if (context->pending_dispatches->pdata[i])
2658         SOURCE_UNREF ((GSource *)context->pending_dispatches->pdata[i], context);
2659     }
2660   g_ptr_array_set_size (context->pending_dispatches, 0);
2661   
2662   /* Prepare all sources */
2663
2664   context->timeout = -1;
2665   
2666   source = next_valid_source (context, NULL);
2667   while (source)
2668     {
2669       gint source_timeout = -1;
2670
2671       if ((n_ready > 0) && (source->priority > current_priority))
2672         {
2673           SOURCE_UNREF (source, context);
2674           break;
2675         }
2676       if (SOURCE_BLOCKED (source))
2677         goto next;
2678
2679       if (!(source->flags & G_SOURCE_READY))
2680         {
2681           gboolean result;
2682           gboolean (*prepare)  (GSource  *source, 
2683                                 gint     *timeout);
2684
2685           prepare = source->source_funcs->prepare;
2686           context->in_check_or_prepare++;
2687           UNLOCK_CONTEXT (context);
2688
2689           result = (*prepare) (source, &source_timeout);
2690
2691           LOCK_CONTEXT (context);
2692           context->in_check_or_prepare--;
2693
2694           if (result)
2695             {
2696               GSource *ready_source = source;
2697
2698               while (ready_source)
2699                 {
2700                   ready_source->flags |= G_SOURCE_READY;
2701                   ready_source = ready_source->priv ? ready_source->priv->parent_source : NULL;
2702                 }
2703             }
2704         }
2705
2706       if (source->flags & G_SOURCE_READY)
2707         {
2708           n_ready++;
2709           current_priority = source->priority;
2710           context->timeout = 0;
2711         }
2712       
2713       if (source_timeout >= 0)
2714         {
2715           if (context->timeout < 0)
2716             context->timeout = source_timeout;
2717           else
2718             context->timeout = MIN (context->timeout, source_timeout);
2719         }
2720
2721     next:
2722       source = next_valid_source (context, source);
2723     }
2724
2725   UNLOCK_CONTEXT (context);
2726   
2727   if (priority)
2728     *priority = current_priority;
2729   
2730   return (n_ready > 0);
2731 }
2732
2733 /**
2734  * g_main_context_query:
2735  * @context: a #GMainContext
2736  * @max_priority: maximum priority source to check
2737  * @timeout_: (out): location to store timeout to be used in polling
2738  * @fds: (out caller-allocates) (array length=n_fds): location to
2739  *       store #GPollFD records that need to be polled.
2740  * @n_fds: length of @fds.
2741  * 
2742  * Determines information necessary to poll this main loop.
2743  * 
2744  * Return value: the number of records actually stored in @fds,
2745  *   or, if more than @n_fds records need to be stored, the number
2746  *   of records that need to be stored.
2747  **/
2748 gint
2749 g_main_context_query (GMainContext *context,
2750                       gint          max_priority,
2751                       gint         *timeout,
2752                       GPollFD      *fds,
2753                       gint          n_fds)
2754 {
2755   gint n_poll;
2756   GPollRec *pollrec;
2757   
2758   LOCK_CONTEXT (context);
2759
2760   pollrec = context->poll_records;
2761   n_poll = 0;
2762   while (pollrec && max_priority >= pollrec->priority)
2763     {
2764       /* We need to include entries with fd->events == 0 in the array because
2765        * otherwise if the application changes fd->events behind our back and 
2766        * makes it non-zero, we'll be out of sync when we check the fds[] array.
2767        * (Changing fd->events after adding an FD wasn't an anticipated use of 
2768        * this API, but it occurs in practice.) */
2769       if (n_poll < n_fds)
2770         {
2771           fds[n_poll].fd = pollrec->fd->fd;
2772           /* In direct contradiction to the Unix98 spec, IRIX runs into
2773            * difficulty if you pass in POLLERR, POLLHUP or POLLNVAL
2774            * flags in the events field of the pollfd while it should
2775            * just ignoring them. So we mask them out here.
2776            */
2777           fds[n_poll].events = pollrec->fd->events & ~(G_IO_ERR|G_IO_HUP|G_IO_NVAL);
2778           fds[n_poll].revents = 0;
2779         }
2780
2781       pollrec = pollrec->next;
2782       n_poll++;
2783     }
2784
2785   context->poll_changed = FALSE;
2786   
2787   if (timeout)
2788     {
2789       *timeout = context->timeout;
2790       if (*timeout != 0)
2791         {
2792           context->time_is_fresh = FALSE;
2793           context->real_time_is_fresh = FALSE;
2794         }
2795     }
2796   
2797   UNLOCK_CONTEXT (context);
2798
2799   return n_poll;
2800 }
2801
2802 /**
2803  * g_main_context_check:
2804  * @context: a #GMainContext
2805  * @max_priority: the maximum numerical priority of sources to check
2806  * @fds: (array length=n_fds): array of #GPollFD's that was passed to
2807  *       the last call to g_main_context_query()
2808  * @n_fds: return value of g_main_context_query()
2809  * 
2810  * Passes the results of polling back to the main loop.
2811  * 
2812  * Return value: %TRUE if some sources are ready to be dispatched.
2813  **/
2814 gboolean
2815 g_main_context_check (GMainContext *context,
2816                       gint          max_priority,
2817                       GPollFD      *fds,
2818                       gint          n_fds)
2819 {
2820   GSource *source;
2821   GPollRec *pollrec;
2822   gint n_ready = 0;
2823   gint i;
2824    
2825   LOCK_CONTEXT (context);
2826
2827   if (context->in_check_or_prepare)
2828     {
2829       g_warning ("g_main_context_check() called recursively from within a source's check() or "
2830                  "prepare() member.");
2831       UNLOCK_CONTEXT (context);
2832       return FALSE;
2833     }
2834
2835   if (context->wake_up_rec.events)
2836     g_wakeup_acknowledge (context->wakeup);
2837
2838   context->poll_waiting = FALSE;
2839
2840   /* If the set of poll file descriptors changed, bail out
2841    * and let the main loop rerun
2842    */
2843   if (context->poll_changed)
2844     {
2845       UNLOCK_CONTEXT (context);
2846       return FALSE;
2847     }
2848   
2849   pollrec = context->poll_records;
2850   i = 0;
2851   while (i < n_fds)
2852     {
2853       if (pollrec->fd->events)
2854         pollrec->fd->revents = fds[i].revents;
2855
2856       pollrec = pollrec->next;
2857       i++;
2858     }
2859
2860   source = next_valid_source (context, NULL);
2861   while (source)
2862     {
2863       if ((n_ready > 0) && (source->priority > max_priority))
2864         {
2865           SOURCE_UNREF (source, context);
2866           break;
2867         }
2868       if (SOURCE_BLOCKED (source))
2869         goto next;
2870
2871       if (!(source->flags & G_SOURCE_READY))
2872         {
2873           gboolean result;
2874           gboolean (*check) (GSource  *source);
2875
2876           check = source->source_funcs->check;
2877           
2878           context->in_check_or_prepare++;
2879           UNLOCK_CONTEXT (context);
2880           
2881           result = (*check) (source);
2882           
2883           LOCK_CONTEXT (context);
2884           context->in_check_or_prepare--;
2885           
2886           if (result)
2887             {
2888               GSource *ready_source = source;
2889
2890               while (ready_source)
2891                 {
2892                   ready_source->flags |= G_SOURCE_READY;
2893                   ready_source = ready_source->priv ? ready_source->priv->parent_source : NULL;
2894                 }
2895             }
2896         }
2897
2898       if (source->flags & G_SOURCE_READY)
2899         {
2900           source->ref_count++;
2901           g_ptr_array_add (context->pending_dispatches, source);
2902
2903           n_ready++;
2904
2905           /* never dispatch sources with less priority than the first
2906            * one we choose to dispatch
2907            */
2908           max_priority = source->priority;
2909         }
2910
2911     next:
2912       source = next_valid_source (context, source);
2913     }
2914
2915   UNLOCK_CONTEXT (context);
2916
2917   return n_ready > 0;
2918 }
2919
2920 /**
2921  * g_main_context_dispatch:
2922  * @context: a #GMainContext
2923  * 
2924  * Dispatches all pending sources.
2925  **/
2926 void
2927 g_main_context_dispatch (GMainContext *context)
2928 {
2929   LOCK_CONTEXT (context);
2930
2931   if (context->pending_dispatches->len > 0)
2932     {
2933       g_main_dispatch (context);
2934     }
2935
2936   UNLOCK_CONTEXT (context);
2937 }
2938
2939 /* HOLDS context lock */
2940 static gboolean
2941 g_main_context_iterate (GMainContext *context,
2942                         gboolean      block,
2943                         gboolean      dispatch,
2944                         GThread      *self)
2945 {
2946   gint max_priority;
2947   gint timeout;
2948   gboolean some_ready;
2949   gint nfds, allocated_nfds;
2950   GPollFD *fds = NULL;
2951
2952   UNLOCK_CONTEXT (context);
2953
2954   if (!g_main_context_acquire (context))
2955     {
2956       gboolean got_ownership;
2957
2958       LOCK_CONTEXT (context);
2959
2960       if (!block)
2961         return FALSE;
2962
2963       if (!context->cond)
2964         context->cond = g_cond_new ();
2965
2966       got_ownership = g_main_context_wait (context,
2967                                            context->cond,
2968                                            g_static_mutex_get_mutex (&context->mutex));
2969
2970       if (!got_ownership)
2971         return FALSE;
2972     }
2973   else
2974     LOCK_CONTEXT (context);
2975   
2976   if (!context->cached_poll_array)
2977     {
2978       context->cached_poll_array_size = context->n_poll_records;
2979       context->cached_poll_array = g_new (GPollFD, context->n_poll_records);
2980     }
2981
2982   allocated_nfds = context->cached_poll_array_size;
2983   fds = context->cached_poll_array;
2984   
2985   UNLOCK_CONTEXT (context);
2986
2987   g_main_context_prepare (context, &max_priority); 
2988   
2989   while ((nfds = g_main_context_query (context, max_priority, &timeout, fds, 
2990                                        allocated_nfds)) > allocated_nfds)
2991     {
2992       LOCK_CONTEXT (context);
2993       g_free (fds);
2994       context->cached_poll_array_size = allocated_nfds = nfds;
2995       context->cached_poll_array = fds = g_new (GPollFD, nfds);
2996       UNLOCK_CONTEXT (context);
2997     }
2998
2999   if (!block)
3000     timeout = 0;
3001   
3002   g_main_context_poll (context, timeout, max_priority, fds, nfds);
3003   
3004   some_ready = g_main_context_check (context, max_priority, fds, nfds);
3005   
3006   if (dispatch)
3007     g_main_context_dispatch (context);
3008   
3009   g_main_context_release (context);
3010
3011   LOCK_CONTEXT (context);
3012
3013   return some_ready;
3014 }
3015
3016 /**
3017  * g_main_context_pending:
3018  * @context: a #GMainContext (if %NULL, the default context will be used)
3019  *
3020  * Checks if any sources have pending events for the given context.
3021  * 
3022  * Return value: %TRUE if events are pending.
3023  **/
3024 gboolean 
3025 g_main_context_pending (GMainContext *context)
3026 {
3027   gboolean retval;
3028
3029   if (!context)
3030     context = g_main_context_default();
3031
3032   LOCK_CONTEXT (context);
3033   retval = g_main_context_iterate (context, FALSE, FALSE, G_THREAD_SELF);
3034   UNLOCK_CONTEXT (context);
3035   
3036   return retval;
3037 }
3038
3039 /**
3040  * g_main_context_iteration:
3041  * @context: a #GMainContext (if %NULL, the default context will be used) 
3042  * @may_block: whether the call may block.
3043  * 
3044  * Runs a single iteration for the given main loop. This involves
3045  * checking to see if any event sources are ready to be processed,
3046  * then if no events sources are ready and @may_block is %TRUE, waiting
3047  * for a source to become ready, then dispatching the highest priority
3048  * events sources that are ready. Otherwise, if @may_block is %FALSE 
3049  * sources are not waited to become ready, only those highest priority 
3050  * events sources will be dispatched (if any), that are ready at this 
3051  * given moment without further waiting.
3052  *
3053  * Note that even when @may_block is %TRUE, it is still possible for 
3054  * g_main_context_iteration() to return %FALSE, since the the wait may 
3055  * be interrupted for other reasons than an event source becoming ready.
3056  * 
3057  * Return value: %TRUE if events were dispatched.
3058  **/
3059 gboolean
3060 g_main_context_iteration (GMainContext *context, gboolean may_block)
3061 {
3062   gboolean retval;
3063
3064   if (!context)
3065     context = g_main_context_default();
3066   
3067   LOCK_CONTEXT (context);
3068   retval = g_main_context_iterate (context, may_block, TRUE, G_THREAD_SELF);
3069   UNLOCK_CONTEXT (context);
3070   
3071   return retval;
3072 }
3073
3074 /**
3075  * g_main_loop_new:
3076  * @context: (allow-none): a #GMainContext  (if %NULL, the default context will be used).
3077  * @is_running: set to %TRUE to indicate that the loop is running. This
3078  * is not very important since calling g_main_loop_run() will set this to
3079  * %TRUE anyway.
3080  * 
3081  * Creates a new #GMainLoop structure.
3082  * 
3083  * Return value: a new #GMainLoop.
3084  **/
3085 GMainLoop *
3086 g_main_loop_new (GMainContext *context,
3087                  gboolean      is_running)
3088 {
3089   GMainLoop *loop;
3090
3091   if (!context)
3092     context = g_main_context_default();
3093   
3094   g_main_context_ref (context);
3095
3096   loop = g_new0 (GMainLoop, 1);
3097   loop->context = context;
3098   loop->is_running = is_running != FALSE;
3099   loop->ref_count = 1;
3100   
3101   return loop;
3102 }
3103
3104 /**
3105  * g_main_loop_ref:
3106  * @loop: a #GMainLoop
3107  * 
3108  * Increases the reference count on a #GMainLoop object by one.
3109  * 
3110  * Return value: @loop
3111  **/
3112 GMainLoop *
3113 g_main_loop_ref (GMainLoop *loop)
3114 {
3115   g_return_val_if_fail (loop != NULL, NULL);
3116   g_return_val_if_fail (g_atomic_int_get (&loop->ref_count) > 0, NULL);
3117
3118   g_atomic_int_inc (&loop->ref_count);
3119
3120   return loop;
3121 }
3122
3123 /**
3124  * g_main_loop_unref:
3125  * @loop: a #GMainLoop
3126  * 
3127  * Decreases the reference count on a #GMainLoop object by one. If
3128  * the result is zero, free the loop and free all associated memory.
3129  **/
3130 void
3131 g_main_loop_unref (GMainLoop *loop)
3132 {
3133   g_return_if_fail (loop != NULL);
3134   g_return_if_fail (g_atomic_int_get (&loop->ref_count) > 0);
3135
3136   if (!g_atomic_int_dec_and_test (&loop->ref_count))
3137     return;
3138
3139   g_main_context_unref (loop->context);
3140   g_free (loop);
3141 }
3142
3143 /**
3144  * g_main_loop_run:
3145  * @loop: a #GMainLoop
3146  * 
3147  * Runs a main loop until g_main_loop_quit() is called on the loop.
3148  * If this is called for the thread of the loop's #GMainContext,
3149  * it will process events from the loop, otherwise it will
3150  * simply wait.
3151  **/
3152 void 
3153 g_main_loop_run (GMainLoop *loop)
3154 {
3155   GThread *self = G_THREAD_SELF;
3156
3157   g_return_if_fail (loop != NULL);
3158   g_return_if_fail (g_atomic_int_get (&loop->ref_count) > 0);
3159
3160   if (!g_main_context_acquire (loop->context))
3161     {
3162       gboolean got_ownership = FALSE;
3163       
3164       /* Another thread owns this context */
3165       LOCK_CONTEXT (loop->context);
3166
3167       g_atomic_int_inc (&loop->ref_count);
3168
3169       if (!loop->is_running)
3170         loop->is_running = TRUE;
3171
3172       if (!loop->context->cond)
3173         loop->context->cond = g_cond_new ();
3174           
3175       while (loop->is_running && !got_ownership)
3176         got_ownership = g_main_context_wait (loop->context,
3177                                              loop->context->cond,
3178                                              g_static_mutex_get_mutex (&loop->context->mutex));
3179       
3180       if (!loop->is_running)
3181         {
3182           UNLOCK_CONTEXT (loop->context);
3183           if (got_ownership)
3184             g_main_context_release (loop->context);
3185           g_main_loop_unref (loop);
3186           return;
3187         }
3188
3189       g_assert (got_ownership);
3190     }
3191   else
3192     LOCK_CONTEXT (loop->context);
3193
3194   if (loop->context->in_check_or_prepare)
3195     {
3196       g_warning ("g_main_loop_run(): called recursively from within a source's "
3197                  "check() or prepare() member, iteration not possible.");
3198       return;
3199     }
3200
3201   g_atomic_int_inc (&loop->ref_count);
3202   loop->is_running = TRUE;
3203   while (loop->is_running)
3204     g_main_context_iterate (loop->context, TRUE, TRUE, self);
3205
3206   UNLOCK_CONTEXT (loop->context);
3207   
3208   g_main_context_release (loop->context);
3209   
3210   g_main_loop_unref (loop);
3211 }
3212
3213 /**
3214  * g_main_loop_quit:
3215  * @loop: a #GMainLoop
3216  * 
3217  * Stops a #GMainLoop from running. Any calls to g_main_loop_run()
3218  * for the loop will return. 
3219  *
3220  * Note that sources that have already been dispatched when 
3221  * g_main_loop_quit() is called will still be executed.
3222  **/
3223 void 
3224 g_main_loop_quit (GMainLoop *loop)
3225 {
3226   g_return_if_fail (loop != NULL);
3227   g_return_if_fail (g_atomic_int_get (&loop->ref_count) > 0);
3228
3229   LOCK_CONTEXT (loop->context);
3230   loop->is_running = FALSE;
3231   g_main_context_wakeup_unlocked (loop->context);
3232
3233   if (loop->context->cond)
3234     g_cond_broadcast (loop->context->cond);
3235
3236   UNLOCK_CONTEXT (loop->context);
3237 }
3238
3239 /**
3240  * g_main_loop_is_running:
3241  * @loop: a #GMainLoop.
3242  * 
3243  * Checks to see if the main loop is currently being run via g_main_loop_run().
3244  * 
3245  * Return value: %TRUE if the mainloop is currently being run.
3246  **/
3247 gboolean
3248 g_main_loop_is_running (GMainLoop *loop)
3249 {
3250   g_return_val_if_fail (loop != NULL, FALSE);
3251   g_return_val_if_fail (g_atomic_int_get (&loop->ref_count) > 0, FALSE);
3252
3253   return loop->is_running;
3254 }
3255
3256 /**
3257  * g_main_loop_get_context:
3258  * @loop: a #GMainLoop.
3259  * 
3260  * Returns the #GMainContext of @loop.
3261  * 
3262  * Return value: (transfer none): the #GMainContext of @loop
3263  **/
3264 GMainContext *
3265 g_main_loop_get_context (GMainLoop *loop)
3266 {
3267   g_return_val_if_fail (loop != NULL, NULL);
3268   g_return_val_if_fail (g_atomic_int_get (&loop->ref_count) > 0, NULL);
3269  
3270   return loop->context;
3271 }
3272
3273 /* HOLDS: context's lock */
3274 static void
3275 g_main_context_poll (GMainContext *context,
3276                      gint          timeout,
3277                      gint          priority,
3278                      GPollFD      *fds,
3279                      gint          n_fds)
3280 {
3281 #ifdef  G_MAIN_POLL_DEBUG
3282   GTimer *poll_timer;
3283   GPollRec *pollrec;
3284   gint i;
3285 #endif
3286
3287   GPollFunc poll_func;
3288
3289   if (n_fds || timeout != 0)
3290     {
3291 #ifdef  G_MAIN_POLL_DEBUG
3292       if (_g_main_poll_debug)
3293         {
3294           g_print ("polling context=%p n=%d timeout=%d\n",
3295                    context, n_fds, timeout);
3296           poll_timer = g_timer_new ();
3297         }
3298 #endif
3299
3300       LOCK_CONTEXT (context);
3301
3302       poll_func = context->poll_func;
3303       
3304       UNLOCK_CONTEXT (context);
3305       if ((*poll_func) (fds, n_fds, timeout) < 0 && errno != EINTR)
3306         {
3307 #ifndef G_OS_WIN32
3308           g_warning ("poll(2) failed due to: %s.",
3309                      g_strerror (errno));
3310 #else
3311           /* If g_poll () returns -1, it has already called g_warning() */
3312 #endif
3313         }
3314       
3315 #ifdef  G_MAIN_POLL_DEBUG
3316       if (_g_main_poll_debug)
3317         {
3318           LOCK_CONTEXT (context);
3319
3320           g_print ("g_main_poll(%d) timeout: %d - elapsed %12.10f seconds",
3321                    n_fds,
3322                    timeout,
3323                    g_timer_elapsed (poll_timer, NULL));
3324           g_timer_destroy (poll_timer);
3325           pollrec = context->poll_records;
3326
3327           while (pollrec != NULL)
3328             {
3329               i = 0;
3330               while (i < n_fds)
3331                 {
3332                   if (fds[i].fd == pollrec->fd->fd &&
3333                       pollrec->fd->events &&
3334                       fds[i].revents)
3335                     {
3336                       g_print (" [" G_POLLFD_FORMAT " :", fds[i].fd);
3337                       if (fds[i].revents & G_IO_IN)
3338                         g_print ("i");
3339                       if (fds[i].revents & G_IO_OUT)
3340                         g_print ("o");
3341                       if (fds[i].revents & G_IO_PRI)
3342                         g_print ("p");
3343                       if (fds[i].revents & G_IO_ERR)
3344                         g_print ("e");
3345                       if (fds[i].revents & G_IO_HUP)
3346                         g_print ("h");
3347                       if (fds[i].revents & G_IO_NVAL)
3348                         g_print ("n");
3349                       g_print ("]");
3350                     }
3351                   i++;
3352                 }
3353               pollrec = pollrec->next;
3354             }
3355           g_print ("\n");
3356
3357           UNLOCK_CONTEXT (context);
3358         }
3359 #endif
3360     } /* if (n_fds || timeout != 0) */
3361 }
3362
3363 /**
3364  * g_main_context_add_poll:
3365  * @context: a #GMainContext (or %NULL for the default context)
3366  * @fd: a #GPollFD structure holding information about a file
3367  *      descriptor to watch.
3368  * @priority: the priority for this file descriptor which should be
3369  *      the same as the priority used for g_source_attach() to ensure that the
3370  *      file descriptor is polled whenever the results may be needed.
3371  * 
3372  * Adds a file descriptor to the set of file descriptors polled for
3373  * this context. This will very seldom be used directly. Instead
3374  * a typical event source will use g_source_add_poll() instead.
3375  **/
3376 void
3377 g_main_context_add_poll (GMainContext *context,
3378                          GPollFD      *fd,
3379                          gint          priority)
3380 {
3381   if (!context)
3382     context = g_main_context_default ();
3383   
3384   g_return_if_fail (g_atomic_int_get (&context->ref_count) > 0);
3385   g_return_if_fail (fd);
3386
3387   LOCK_CONTEXT (context);
3388   g_main_context_add_poll_unlocked (context, priority, fd);
3389   UNLOCK_CONTEXT (context);
3390 }
3391
3392 /* HOLDS: main_loop_lock */
3393 static void 
3394 g_main_context_add_poll_unlocked (GMainContext *context,
3395                                   gint          priority,
3396                                   GPollFD      *fd)
3397 {
3398   GPollRec *prevrec, *nextrec;
3399   GPollRec *newrec = g_slice_new (GPollRec);
3400
3401   /* This file descriptor may be checked before we ever poll */
3402   fd->revents = 0;
3403   newrec->fd = fd;
3404   newrec->priority = priority;
3405
3406   prevrec = context->poll_records_tail;
3407   nextrec = NULL;
3408   while (prevrec && priority < prevrec->priority)
3409     {
3410       nextrec = prevrec;
3411       prevrec = prevrec->prev;
3412     }
3413
3414   if (prevrec)
3415     prevrec->next = newrec;
3416   else
3417     context->poll_records = newrec;
3418
3419   newrec->prev = prevrec;
3420   newrec->next = nextrec;
3421
3422   if (nextrec)
3423     nextrec->prev = newrec;
3424   else 
3425     context->poll_records_tail = newrec;
3426
3427   context->n_poll_records++;
3428
3429   context->poll_changed = TRUE;
3430
3431   /* Now wake up the main loop if it is waiting in the poll() */
3432   g_main_context_wakeup_unlocked (context);
3433 }
3434
3435 /**
3436  * g_main_context_remove_poll:
3437  * @context:a #GMainContext 
3438  * @fd: a #GPollFD descriptor previously added with g_main_context_add_poll()
3439  * 
3440  * Removes file descriptor from the set of file descriptors to be
3441  * polled for a particular context.
3442  **/
3443 void
3444 g_main_context_remove_poll (GMainContext *context,
3445                             GPollFD      *fd)
3446 {
3447   if (!context)
3448     context = g_main_context_default ();
3449   
3450   g_return_if_fail (g_atomic_int_get (&context->ref_count) > 0);
3451   g_return_if_fail (fd);
3452
3453   LOCK_CONTEXT (context);
3454   g_main_context_remove_poll_unlocked (context, fd);
3455   UNLOCK_CONTEXT (context);
3456 }
3457
3458 static void
3459 g_main_context_remove_poll_unlocked (GMainContext *context,
3460                                      GPollFD      *fd)
3461 {
3462   GPollRec *pollrec, *prevrec, *nextrec;
3463
3464   prevrec = NULL;
3465   pollrec = context->poll_records;
3466
3467   while (pollrec)
3468     {
3469       nextrec = pollrec->next;
3470       if (pollrec->fd == fd)
3471         {
3472           if (prevrec != NULL)
3473             prevrec->next = nextrec;
3474           else
3475             context->poll_records = nextrec;
3476
3477           if (nextrec != NULL)
3478             nextrec->prev = prevrec;
3479           else
3480             context->poll_records_tail = prevrec;
3481
3482           g_slice_free (GPollRec, pollrec);
3483
3484           context->n_poll_records--;
3485           break;
3486         }
3487       prevrec = pollrec;
3488       pollrec = nextrec;
3489     }
3490
3491   context->poll_changed = TRUE;
3492   
3493   /* Now wake up the main loop if it is waiting in the poll() */
3494   g_main_context_wakeup_unlocked (context);
3495 }
3496
3497 /**
3498  * g_source_get_current_time:
3499  * @source:  a #GSource
3500  * @timeval: #GTimeVal structure in which to store current time.
3501  * 
3502  * Gets the "current time" to be used when checking 
3503  * this source. The advantage of calling this function over
3504  * calling g_get_current_time() directly is that when 
3505  * checking multiple sources, GLib can cache a single value
3506  * instead of having to repeatedly get the system time.
3507  *
3508  * Deprecated: 2.28: use g_source_get_time() instead
3509  **/
3510 void
3511 g_source_get_current_time (GSource  *source,
3512                            GTimeVal *timeval)
3513 {
3514   GMainContext *context;
3515   
3516   g_return_if_fail (source->context != NULL);
3517  
3518   context = source->context;
3519
3520   LOCK_CONTEXT (context);
3521
3522   if (!context->real_time_is_fresh)
3523     {
3524       context->real_time = g_get_real_time ();
3525       context->real_time_is_fresh = TRUE;
3526     }
3527   
3528   timeval->tv_sec = context->real_time / 1000000;
3529   timeval->tv_usec = context->real_time % 1000000;
3530   
3531   UNLOCK_CONTEXT (context);
3532 }
3533
3534 /**
3535  * g_source_get_time:
3536  * @source: a #GSource
3537  *
3538  * Gets the time to be used when checking this source. The advantage of
3539  * calling this function over calling g_get_monotonic_time() directly is
3540  * that when checking multiple sources, GLib can cache a single value
3541  * instead of having to repeatedly get the system monotonic time.
3542  *
3543  * The time here is the system monotonic time, if available, or some
3544  * other reasonable alternative otherwise.  See g_get_monotonic_time().
3545  *
3546  * Returns: the monotonic time in microseconds
3547  *
3548  * Since: 2.28
3549  **/
3550 gint64
3551 g_source_get_time (GSource *source)
3552 {
3553   GMainContext *context;
3554   gint64 result;
3555
3556   g_return_val_if_fail (source->context != NULL, 0);
3557
3558   context = source->context;
3559
3560   LOCK_CONTEXT (context);
3561
3562   if (!context->time_is_fresh)
3563     {
3564       context->time = g_get_monotonic_time ();
3565       context->time_is_fresh = TRUE;
3566     }
3567
3568   result = context->time;
3569
3570   UNLOCK_CONTEXT (context);
3571
3572   return result;
3573 }
3574
3575 /**
3576  * g_main_context_set_poll_func:
3577  * @context: a #GMainContext
3578  * @func: the function to call to poll all file descriptors
3579  * 
3580  * Sets the function to use to handle polling of file descriptors. It
3581  * will be used instead of the poll() system call 
3582  * (or GLib's replacement function, which is used where 
3583  * poll() isn't available).
3584  *
3585  * This function could possibly be used to integrate the GLib event
3586  * loop with an external event loop.
3587  **/
3588 void
3589 g_main_context_set_poll_func (GMainContext *context,
3590                               GPollFunc     func)
3591 {
3592   if (!context)
3593     context = g_main_context_default ();
3594   
3595   g_return_if_fail (g_atomic_int_get (&context->ref_count) > 0);
3596
3597   LOCK_CONTEXT (context);
3598   
3599   if (func)
3600     context->poll_func = func;
3601   else
3602     context->poll_func = g_poll;
3603
3604   UNLOCK_CONTEXT (context);
3605 }
3606
3607 /**
3608  * g_main_context_get_poll_func:
3609  * @context: a #GMainContext
3610  * 
3611  * Gets the poll function set by g_main_context_set_poll_func().
3612  * 
3613  * Return value: the poll function
3614  **/
3615 GPollFunc
3616 g_main_context_get_poll_func (GMainContext *context)
3617 {
3618   GPollFunc result;
3619   
3620   if (!context)
3621     context = g_main_context_default ();
3622   
3623   g_return_val_if_fail (g_atomic_int_get (&context->ref_count) > 0, NULL);
3624
3625   LOCK_CONTEXT (context);
3626   result = context->poll_func;
3627   UNLOCK_CONTEXT (context);
3628
3629   return result;
3630 }
3631
3632 /* HOLDS: context's lock */
3633 /* Wake the main loop up from a poll() */
3634 static void
3635 g_main_context_wakeup_unlocked (GMainContext *context)
3636 {
3637   if (context->poll_waiting)
3638     {
3639       context->poll_waiting = FALSE;
3640       g_wakeup_signal (context->wakeup);
3641     }
3642 }
3643
3644 /**
3645  * g_main_context_wakeup:
3646  * @context: a #GMainContext
3647  * 
3648  * If @context is currently waiting in a poll(), interrupt
3649  * the poll(), and continue the iteration process.
3650  **/
3651 void
3652 g_main_context_wakeup (GMainContext *context)
3653 {
3654   if (!context)
3655     context = g_main_context_default ();
3656   
3657   g_return_if_fail (g_atomic_int_get (&context->ref_count) > 0);
3658
3659   LOCK_CONTEXT (context);
3660   g_main_context_wakeup_unlocked (context);
3661   UNLOCK_CONTEXT (context);
3662 }
3663
3664 /**
3665  * g_main_context_is_owner:
3666  * @context: a #GMainContext
3667  * 
3668  * Determines whether this thread holds the (recursive)
3669  * ownership of this #GMainContext. This is useful to
3670  * know before waiting on another thread that may be
3671  * blocking to get ownership of @context.
3672  *
3673  * Returns: %TRUE if current thread is owner of @context.
3674  *
3675  * Since: 2.10
3676  **/
3677 gboolean
3678 g_main_context_is_owner (GMainContext *context)
3679 {
3680   gboolean is_owner;
3681
3682   if (!context)
3683     context = g_main_context_default ();
3684
3685   LOCK_CONTEXT (context);
3686   is_owner = context->owner == G_THREAD_SELF;
3687   UNLOCK_CONTEXT (context);
3688
3689   return is_owner;
3690 }
3691
3692 /* Timeouts */
3693
3694 static void
3695 g_timeout_set_expiration (GTimeoutSource *timeout_source,
3696                           gint64          current_time)
3697 {
3698   timeout_source->expiration = current_time +
3699                                (guint64) timeout_source->interval * 1000;
3700
3701   if (timeout_source->seconds)
3702     {
3703       gint64 remainder;
3704       static gint timer_perturb = -1;
3705
3706       if (timer_perturb == -1)
3707         {
3708           /*
3709            * we want a per machine/session unique 'random' value; try the dbus
3710            * address first, that has a UUID in it. If there is no dbus, use the
3711            * hostname for hashing.
3712            */
3713           const char *session_bus_address = g_getenv ("DBUS_SESSION_BUS_ADDRESS");
3714           if (!session_bus_address)
3715             session_bus_address = g_getenv ("HOSTNAME");
3716           if (session_bus_address)
3717             timer_perturb = ABS ((gint) g_str_hash (session_bus_address)) % 1000000;
3718           else
3719             timer_perturb = 0;
3720         }
3721
3722       /* We want the microseconds part of the timeout to land on the
3723        * 'timer_perturb' mark, but we need to make sure we don't try to
3724        * set the timeout in the past.  We do this by ensuring that we
3725        * always only *increase* the expiration time by adding a full
3726        * second in the case that the microsecond portion decreases.
3727        */
3728       timeout_source->expiration -= timer_perturb;
3729
3730       remainder = timeout_source->expiration % 1000000;
3731       if (remainder >= 1000000/4)
3732         timeout_source->expiration += 1000000;
3733
3734       timeout_source->expiration -= remainder;
3735       timeout_source->expiration += timer_perturb;
3736     }
3737 }
3738
3739 static gboolean
3740 g_timeout_prepare (GSource *source,
3741                    gint    *timeout)
3742 {
3743   GTimeoutSource *timeout_source = (GTimeoutSource *) source;
3744   gint64 now = g_source_get_time (source);
3745
3746   if (now < timeout_source->expiration)
3747     {
3748       /* Round up to ensure that we don't try again too early */
3749       *timeout = (timeout_source->expiration - now + 999) / 1000;
3750       return FALSE;
3751     }
3752
3753   *timeout = 0;
3754   return TRUE;
3755 }
3756
3757 static gboolean 
3758 g_timeout_check (GSource *source)
3759 {
3760   GTimeoutSource *timeout_source = (GTimeoutSource *) source;
3761   gint64 now = g_source_get_time (source);
3762
3763   return timeout_source->expiration <= now;
3764 }
3765
3766 static gboolean
3767 g_timeout_dispatch (GSource     *source,
3768                     GSourceFunc  callback,
3769                     gpointer     user_data)
3770 {
3771   GTimeoutSource *timeout_source = (GTimeoutSource *)source;
3772   gboolean again;
3773
3774   if (!callback)
3775     {
3776       g_warning ("Timeout source dispatched without callback\n"
3777                  "You must call g_source_set_callback().");
3778       return FALSE;
3779     }
3780
3781   again = callback (user_data);
3782
3783   if (again)
3784     g_timeout_set_expiration (timeout_source, g_source_get_time (source));
3785
3786   return again;
3787 }
3788
3789 /**
3790  * g_timeout_source_new:
3791  * @interval: the timeout interval in milliseconds.
3792  * 
3793  * Creates a new timeout source.
3794  *
3795  * The source will not initially be associated with any #GMainContext
3796  * and must be added to one with g_source_attach() before it will be
3797  * executed.
3798  *
3799  * The interval given is in terms of monotonic time, not wall clock
3800  * time.  See g_get_monotonic_time().
3801  * 
3802  * Return value: the newly-created timeout source
3803  **/
3804 GSource *
3805 g_timeout_source_new (guint interval)
3806 {
3807   GSource *source = g_source_new (&g_timeout_funcs, sizeof (GTimeoutSource));
3808   GTimeoutSource *timeout_source = (GTimeoutSource *)source;
3809
3810   timeout_source->interval = interval;
3811   g_timeout_set_expiration (timeout_source, g_get_monotonic_time ());
3812
3813   return source;
3814 }
3815
3816 /**
3817  * g_timeout_source_new_seconds:
3818  * @interval: the timeout interval in seconds
3819  *
3820  * Creates a new timeout source.
3821  *
3822  * The source will not initially be associated with any #GMainContext
3823  * and must be added to one with g_source_attach() before it will be
3824  * executed.
3825  *
3826  * The scheduling granularity/accuracy of this timeout source will be
3827  * in seconds.
3828  *
3829  * The interval given in terms of monotonic time, not wall clock time.
3830  * See g_get_monotonic_time().
3831  *
3832  * Return value: the newly-created timeout source
3833  *
3834  * Since: 2.14  
3835  **/
3836 GSource *
3837 g_timeout_source_new_seconds (guint interval)
3838 {
3839   GSource *source = g_source_new (&g_timeout_funcs, sizeof (GTimeoutSource));
3840   GTimeoutSource *timeout_source = (GTimeoutSource *)source;
3841
3842   timeout_source->interval = 1000 * interval;
3843   timeout_source->seconds = TRUE;
3844
3845   g_timeout_set_expiration (timeout_source, g_get_monotonic_time ());
3846
3847   return source;
3848 }
3849
3850
3851 /**
3852  * g_timeout_add_full:
3853  * @priority: the priority of the timeout source. Typically this will be in
3854  *            the range between #G_PRIORITY_DEFAULT and #G_PRIORITY_HIGH.
3855  * @interval: the time between calls to the function, in milliseconds
3856  *             (1/1000ths of a second)
3857  * @function: function to call
3858  * @data:     data to pass to @function
3859  * @notify:   function to call when the timeout is removed, or %NULL
3860  * 
3861  * Sets a function to be called at regular intervals, with the given
3862  * priority.  The function is called repeatedly until it returns
3863  * %FALSE, at which point the timeout is automatically destroyed and
3864  * the function will not be called again.  The @notify function is
3865  * called when the timeout is destroyed.  The first call to the
3866  * function will be at the end of the first @interval.
3867  *
3868  * Note that timeout functions may be delayed, due to the processing of other
3869  * event sources. Thus they should not be relied on for precise timing.
3870  * After each call to the timeout function, the time of the next
3871  * timeout is recalculated based on the current time and the given interval
3872  * (it does not try to 'catch up' time lost in delays).
3873  *
3874  * This internally creates a main loop source using g_timeout_source_new()
3875  * and attaches it to the main loop context using g_source_attach(). You can
3876  * do these steps manually if you need greater control.
3877  *
3878  * The interval given in terms of monotonic time, not wall clock time.
3879  * See g_get_monotonic_time().
3880  * 
3881  * Return value: the ID (greater than 0) of the event source.
3882  * Rename to: g_timeout_add
3883  **/
3884 guint
3885 g_timeout_add_full (gint           priority,
3886                     guint          interval,
3887                     GSourceFunc    function,
3888                     gpointer       data,
3889                     GDestroyNotify notify)
3890 {
3891   GSource *source;
3892   guint id;
3893   
3894   g_return_val_if_fail (function != NULL, 0);
3895
3896   source = g_timeout_source_new (interval);
3897
3898   if (priority != G_PRIORITY_DEFAULT)
3899     g_source_set_priority (source, priority);
3900
3901   g_source_set_callback (source, function, data, notify);
3902   id = g_source_attach (source, NULL);
3903   g_source_unref (source);
3904
3905   return id;
3906 }
3907
3908 /**
3909  * g_timeout_add:
3910  * @interval: the time between calls to the function, in milliseconds
3911  *             (1/1000ths of a second)
3912  * @function: function to call
3913  * @data:     data to pass to @function
3914  * 
3915  * Sets a function to be called at regular intervals, with the default
3916  * priority, #G_PRIORITY_DEFAULT.  The function is called repeatedly
3917  * until it returns %FALSE, at which point the timeout is automatically
3918  * destroyed and the function will not be called again.  The first call
3919  * to the function will be at the end of the first @interval.
3920  *
3921  * Note that timeout functions may be delayed, due to the processing of other
3922  * event sources. Thus they should not be relied on for precise timing.
3923  * After each call to the timeout function, the time of the next
3924  * timeout is recalculated based on the current time and the given interval
3925  * (it does not try to 'catch up' time lost in delays).
3926  *
3927  * If you want to have a timer in the "seconds" range and do not care
3928  * about the exact time of the first call of the timer, use the
3929  * g_timeout_add_seconds() function; this function allows for more
3930  * optimizations and more efficient system power usage.
3931  *
3932  * This internally creates a main loop source using g_timeout_source_new()
3933  * and attaches it to the main loop context using g_source_attach(). You can
3934  * do these steps manually if you need greater control.
3935  * 
3936  * The interval given is in terms of monotonic time, not wall clock
3937  * time.  See g_get_monotonic_time().
3938  * 
3939  * Return value: the ID (greater than 0) of the event source.
3940  **/
3941 guint
3942 g_timeout_add (guint32        interval,
3943                GSourceFunc    function,
3944                gpointer       data)
3945 {
3946   return g_timeout_add_full (G_PRIORITY_DEFAULT, 
3947                              interval, function, data, NULL);
3948 }
3949
3950 /**
3951  * g_timeout_add_seconds_full:
3952  * @priority: the priority of the timeout source. Typically this will be in
3953  *            the range between #G_PRIORITY_DEFAULT and #G_PRIORITY_HIGH.
3954  * @interval: the time between calls to the function, in seconds
3955  * @function: function to call
3956  * @data:     data to pass to @function
3957  * @notify:   function to call when the timeout is removed, or %NULL
3958  *
3959  * Sets a function to be called at regular intervals, with @priority.
3960  * The function is called repeatedly until it returns %FALSE, at which
3961  * point the timeout is automatically destroyed and the function will
3962  * not be called again.
3963  *
3964  * Unlike g_timeout_add(), this function operates at whole second granularity.
3965  * The initial starting point of the timer is determined by the implementation
3966  * and the implementation is expected to group multiple timers together so that
3967  * they fire all at the same time.
3968  * To allow this grouping, the @interval to the first timer is rounded
3969  * and can deviate up to one second from the specified interval.
3970  * Subsequent timer iterations will generally run at the specified interval.
3971  *
3972  * Note that timeout functions may be delayed, due to the processing of other
3973  * event sources. Thus they should not be relied on for precise timing.
3974  * After each call to the timeout function, the time of the next
3975  * timeout is recalculated based on the current time and the given @interval
3976  *
3977  * If you want timing more precise than whole seconds, use g_timeout_add()
3978  * instead.
3979  *
3980  * The grouping of timers to fire at the same time results in a more power
3981  * and CPU efficient behavior so if your timer is in multiples of seconds
3982  * and you don't require the first timer exactly one second from now, the
3983  * use of g_timeout_add_seconds() is preferred over g_timeout_add().
3984  *
3985  * This internally creates a main loop source using 
3986  * g_timeout_source_new_seconds() and attaches it to the main loop context 
3987  * using g_source_attach(). You can do these steps manually if you need 
3988  * greater control.
3989  * 
3990  * The interval given is in terms of monotonic time, not wall clock
3991  * time.  See g_get_monotonic_time().
3992  * 
3993  * Return value: the ID (greater than 0) of the event source.
3994  *
3995  * Rename to: g_timeout_add_seconds
3996  * Since: 2.14
3997  **/
3998 guint
3999 g_timeout_add_seconds_full (gint           priority,
4000                             guint32        interval,
4001                             GSourceFunc    function,
4002                             gpointer       data,
4003                             GDestroyNotify notify)
4004 {
4005   GSource *source;
4006   guint id;
4007
4008   g_return_val_if_fail (function != NULL, 0);
4009
4010   source = g_timeout_source_new_seconds (interval);
4011
4012   if (priority != G_PRIORITY_DEFAULT)
4013     g_source_set_priority (source, priority);
4014
4015   g_source_set_callback (source, function, data, notify);
4016   id = g_source_attach (source, NULL);
4017   g_source_unref (source);
4018
4019   return id;
4020 }
4021
4022 /**
4023  * g_timeout_add_seconds:
4024  * @interval: the time between calls to the function, in seconds
4025  * @function: function to call
4026  * @data: data to pass to @function
4027  *
4028  * Sets a function to be called at regular intervals with the default
4029  * priority, #G_PRIORITY_DEFAULT. The function is called repeatedly until
4030  * it returns %FALSE, at which point the timeout is automatically destroyed
4031  * and the function will not be called again.
4032  *
4033  * This internally creates a main loop source using
4034  * g_timeout_source_new_seconds() and attaches it to the main loop context
4035  * using g_source_attach(). You can do these steps manually if you need
4036  * greater control. Also see g_timeout_add_seconds_full().
4037  *
4038  * Note that the first call of the timer may not be precise for timeouts
4039  * of one second. If you need finer precision and have such a timeout,
4040  * you may want to use g_timeout_add() instead.
4041  *
4042  * The interval given is in terms of monotonic time, not wall clock
4043  * time.  See g_get_monotonic_time().
4044  * 
4045  * Return value: the ID (greater than 0) of the event source.
4046  *
4047  * Since: 2.14
4048  **/
4049 guint
4050 g_timeout_add_seconds (guint       interval,
4051                        GSourceFunc function,
4052                        gpointer    data)
4053 {
4054   g_return_val_if_fail (function != NULL, 0);
4055
4056   return g_timeout_add_seconds_full (G_PRIORITY_DEFAULT, interval, function, data, NULL);
4057 }
4058
4059 /* Child watch functions */
4060
4061 #ifdef G_OS_WIN32
4062
4063 static gboolean
4064 g_child_watch_prepare (GSource *source,
4065                        gint    *timeout)
4066 {
4067   *timeout = -1;
4068   return FALSE;
4069 }
4070
4071
4072 static gboolean 
4073 g_child_watch_check (GSource  *source)
4074 {
4075   GChildWatchSource *child_watch_source;
4076   gboolean child_exited;
4077
4078   child_watch_source = (GChildWatchSource *) source;
4079
4080   child_exited = child_watch_source->poll.revents & G_IO_IN;
4081
4082   if (child_exited)
4083     {
4084       DWORD child_status;
4085
4086       /*
4087        * Note: We do _not_ check for the special value of STILL_ACTIVE
4088        * since we know that the process has exited and doing so runs into
4089        * problems if the child process "happens to return STILL_ACTIVE(259)"
4090        * as Microsoft's Platform SDK puts it.
4091        */
4092       if (!GetExitCodeProcess (child_watch_source->pid, &child_status))
4093         {
4094           gchar *emsg = g_win32_error_message (GetLastError ());
4095           g_warning (G_STRLOC ": GetExitCodeProcess() failed: %s", emsg);
4096           g_free (emsg);
4097
4098           child_watch_source->child_status = -1;
4099         }
4100       else
4101         child_watch_source->child_status = child_status;
4102     }
4103
4104   return child_exited;
4105 }
4106
4107 #else /* G_OS_WIN32 */
4108
4109 static void
4110 wake_source (GSource *source)
4111 {
4112   GMainContext *context;
4113
4114   /* This should be thread-safe:
4115    *
4116    *  - if the source is currently being added to a context, that
4117    *    context will be woken up anyway
4118    *
4119    *  - if the source is currently being destroyed, we simply need not
4120    *    to crash:
4121    *
4122    *    - the memory for the source will remain valid until after the
4123    *      source finalize function was called (which would remove the
4124    *      source from the global list which we are currently holding the
4125    *      lock for)
4126    *
4127    *    - the GMainContext will either be NULL or point to a live
4128    *      GMainContext
4129    *
4130    *    - the GMainContext will remain valid since we hold the
4131    *      main_context_list lock
4132    *
4133    *  Since we are holding a lot of locks here, don't try to enter any
4134    *  more GMainContext functions for fear of dealock -- just hit the
4135    *  GWakeup and run.  Even if that's safe now, it could easily become
4136    *  unsafe with some very minor changes in the future, and signal
4137    *  handling is not the most well-tested codepath.
4138    */
4139   G_LOCK(main_context_list);
4140   context = source->context;
4141   if (context)
4142     g_wakeup_signal (context->wakeup);
4143   G_UNLOCK(main_context_list);
4144 }
4145
4146 static void
4147 dispatch_unix_signals (void)
4148 {
4149   GSList *node;
4150
4151   /* clear this first incase another one arrives while we're processing */
4152   any_unix_signal_pending = FALSE;
4153
4154   G_LOCK(unix_signal_lock);
4155
4156   /* handle GChildWatchSource instances */
4157   if (unix_signal_pending[SIGCHLD])
4158     {
4159       unix_signal_pending[SIGCHLD] = FALSE;
4160
4161       /* The only way we can do this is to scan all of the children.
4162        *
4163        * The docs promise that we will not reap children that we are not
4164        * explicitly watching, so that ties our hands from calling
4165        * waitpid(-1).  We also can't use siginfo's si_pid field since if
4166        * multiple SIGCHLD arrive at the same time, one of them can be
4167        * dropped (since a given UNIX signal can only be pending once).
4168        */
4169       for (node = unix_child_watches; node; node = node->next)
4170         {
4171           GChildWatchSource *source = node->data;
4172
4173           if (!source->child_exited)
4174             {
4175               if (waitpid (source->pid, &source->child_status, WNOHANG) > 0)
4176                 {
4177                   source->child_exited = TRUE;
4178
4179                   wake_source ((GSource *) source);
4180                 }
4181             }
4182         }
4183     }
4184
4185   /* handle GUnixSignalWatchSource instances */
4186   for (node = unix_signal_watches; node; node = node->next)
4187     {
4188       GUnixSignalWatchSource *source = node->data;
4189
4190       if (!source->pending)
4191         {
4192           if (unix_signal_pending[source->signum])
4193             {
4194               unix_signal_pending[source->signum] = FALSE;
4195               source->pending = TRUE;
4196
4197               wake_source ((GSource *) source);
4198             }
4199         }
4200     }
4201
4202   G_UNLOCK(unix_signal_lock);
4203 }
4204
4205 static gboolean
4206 g_child_watch_prepare (GSource *source,
4207                        gint    *timeout)
4208 {
4209   GChildWatchSource *child_watch_source;
4210
4211   child_watch_source = (GChildWatchSource *) source;
4212
4213   return child_watch_source->child_exited;
4214 }
4215
4216 static gboolean
4217 g_child_watch_check (GSource *source)
4218 {
4219   GChildWatchSource *child_watch_source;
4220
4221   child_watch_source = (GChildWatchSource *) source;
4222
4223   return child_watch_source->child_exited;
4224 }
4225
4226 static gboolean
4227 g_unix_signal_watch_prepare (GSource *source,
4228                              gint    *timeout)
4229 {
4230   GUnixSignalWatchSource *unix_signal_source;
4231
4232   unix_signal_source = (GUnixSignalWatchSource *) source;
4233
4234   return unix_signal_source->pending;
4235 }
4236
4237 static gboolean
4238 g_unix_signal_watch_check (GSource  *source)
4239 {
4240   GUnixSignalWatchSource *unix_signal_source;
4241
4242   unix_signal_source = (GUnixSignalWatchSource *) source;
4243
4244   return unix_signal_source->pending;
4245 }
4246
4247 static gboolean
4248 g_unix_signal_watch_dispatch (GSource    *source, 
4249                               GSourceFunc callback,
4250                               gpointer    user_data)
4251 {
4252   GUnixSignalWatchSource *unix_signal_source;
4253
4254   unix_signal_source = (GUnixSignalWatchSource *) source;
4255
4256   if (!callback)
4257     {
4258       g_warning ("Unix signal source dispatched without callback\n"
4259                  "You must call g_source_set_callback().");
4260       return FALSE;
4261     }
4262
4263   (callback) (user_data);
4264
4265   unix_signal_source->pending = FALSE;
4266
4267   return TRUE;
4268 }
4269
4270 static void
4271 ensure_unix_signal_handler_installed_unlocked (int signum)
4272 {
4273   static sigset_t installed_signal_mask;
4274   static gboolean initialized;
4275   struct sigaction action;
4276
4277   if (!initialized)
4278     {
4279       sigemptyset (&installed_signal_mask);
4280       glib_get_worker_context ();
4281       initialized = TRUE;
4282     }
4283
4284   if (sigismember (&installed_signal_mask, signum))
4285     return;
4286
4287   sigaddset (&installed_signal_mask, signum);
4288
4289   action.sa_handler = g_unix_signal_handler;
4290   sigemptyset (&action.sa_mask);
4291   action.sa_flags = SA_RESTART | SA_NOCLDSTOP;
4292   sigaction (signum, &action, NULL);
4293 }
4294
4295 GSource *
4296 _g_main_create_unix_signal_watch (int signum)
4297 {
4298   GSource *source;
4299   GUnixSignalWatchSource *unix_signal_source;
4300
4301   source = g_source_new (&g_unix_signal_funcs, sizeof (GUnixSignalWatchSource));
4302   unix_signal_source = (GUnixSignalWatchSource *) source;
4303
4304   unix_signal_source->signum = signum;
4305   unix_signal_source->pending = FALSE;
4306
4307   G_LOCK (unix_signal_lock);
4308   ensure_unix_signal_handler_installed_unlocked (signum);
4309   unix_signal_watches = g_slist_prepend (unix_signal_watches, unix_signal_source);
4310   if (unix_signal_pending[signum])
4311     unix_signal_source->pending = TRUE;
4312   unix_signal_pending[signum] = FALSE;
4313   G_UNLOCK (unix_signal_lock);
4314
4315   return source;
4316 }
4317
4318 static void 
4319 g_unix_signal_watch_finalize (GSource    *source)
4320 {
4321   G_LOCK (unix_signal_lock);
4322   unix_signal_watches = g_slist_remove (unix_signal_watches, source);
4323   G_UNLOCK (unix_signal_lock);
4324 }
4325
4326 #endif /* G_OS_WIN32 */
4327
4328 static void
4329 g_child_watch_finalize (GSource *source)
4330 {
4331   G_LOCK (unix_signal_lock);
4332   unix_child_watches = g_slist_remove (unix_child_watches, source);
4333   G_UNLOCK (unix_signal_lock);
4334 }
4335
4336 static gboolean
4337 g_child_watch_dispatch (GSource    *source, 
4338                         GSourceFunc callback,
4339                         gpointer    user_data)
4340 {
4341   GChildWatchSource *child_watch_source;
4342   GChildWatchFunc child_watch_callback = (GChildWatchFunc) callback;
4343
4344   child_watch_source = (GChildWatchSource *) source;
4345
4346   if (!callback)
4347     {
4348       g_warning ("Child watch source dispatched without callback\n"
4349                  "You must call g_source_set_callback().");
4350       return FALSE;
4351     }
4352
4353   (child_watch_callback) (child_watch_source->pid, child_watch_source->child_status, user_data);
4354
4355   /* We never keep a child watch source around as the child is gone */
4356   return FALSE;
4357 }
4358
4359 #ifndef G_OS_WIN32
4360
4361 static void
4362 g_unix_signal_handler (int signum)
4363 {
4364   unix_signal_pending[signum] = TRUE;
4365   any_unix_signal_pending = TRUE;
4366
4367   g_wakeup_signal (glib_worker_context->wakeup);
4368 }
4369
4370 #endif /* !G_OS_WIN32 */
4371
4372 /**
4373  * g_child_watch_source_new:
4374  * @pid: process to watch. On POSIX the pid of a child process. On
4375  * Windows a handle for a process (which doesn't have to be a child).
4376  * 
4377  * Creates a new child_watch source.
4378  *
4379  * The source will not initially be associated with any #GMainContext
4380  * and must be added to one with g_source_attach() before it will be
4381  * executed.
4382  * 
4383  * Note that child watch sources can only be used in conjunction with
4384  * <literal>g_spawn...</literal> when the %G_SPAWN_DO_NOT_REAP_CHILD
4385  * flag is used.
4386  *
4387  * Note that on platforms where #GPid must be explicitly closed
4388  * (see g_spawn_close_pid()) @pid must not be closed while the
4389  * source is still active. Typically, you will want to call
4390  * g_spawn_close_pid() in the callback function for the source.
4391  *
4392  * Note further that using g_child_watch_source_new() is not 
4393  * compatible with calling <literal>waitpid(-1)</literal> in 
4394  * the application. Calling waitpid() for individual pids will
4395  * still work fine. 
4396  * 
4397  * Return value: the newly-created child watch source
4398  *
4399  * Since: 2.4
4400  **/
4401 GSource *
4402 g_child_watch_source_new (GPid pid)
4403 {
4404   GSource *source = g_source_new (&g_child_watch_funcs, sizeof (GChildWatchSource));
4405   GChildWatchSource *child_watch_source = (GChildWatchSource *)source;
4406
4407   child_watch_source->pid = pid;
4408
4409 #ifdef G_OS_WIN32
4410   child_watch_source->poll.fd = (gintptr) pid;
4411   child_watch_source->poll.events = G_IO_IN;
4412
4413   g_source_add_poll (source, &child_watch_source->poll);
4414 #else /* G_OS_WIN32 */
4415   G_LOCK (unix_signal_lock);
4416   ensure_unix_signal_handler_installed_unlocked (SIGCHLD);
4417   unix_child_watches = g_slist_prepend (unix_child_watches, child_watch_source);
4418   if (waitpid (pid, &child_watch_source->child_status, WNOHANG) > 0)
4419     child_watch_source->child_exited = TRUE;
4420   G_UNLOCK (unix_signal_lock);
4421 #endif /* G_OS_WIN32 */
4422
4423   return source;
4424 }
4425
4426 /**
4427  * g_child_watch_add_full:
4428  * @priority: the priority of the idle source. Typically this will be in the
4429  *            range between #G_PRIORITY_DEFAULT_IDLE and #G_PRIORITY_HIGH_IDLE.
4430  * @pid:      process to watch. On POSIX the pid of a child process. On
4431  * Windows a handle for a process (which doesn't have to be a child).
4432  * @function: function to call
4433  * @data:     data to pass to @function
4434  * @notify:   function to call when the idle is removed, or %NULL
4435  * 
4436  * Sets a function to be called when the child indicated by @pid 
4437  * exits, at the priority @priority.
4438  *
4439  * If you obtain @pid from g_spawn_async() or g_spawn_async_with_pipes() 
4440  * you will need to pass #G_SPAWN_DO_NOT_REAP_CHILD as flag to 
4441  * the spawn function for the child watching to work.
4442  * 
4443  * Note that on platforms where #GPid must be explicitly closed
4444  * (see g_spawn_close_pid()) @pid must not be closed while the
4445  * source is still active. Typically, you will want to call
4446  * g_spawn_close_pid() in the callback function for the source.
4447  * 
4448  * GLib supports only a single callback per process id.
4449  *
4450  * This internally creates a main loop source using 
4451  * g_child_watch_source_new() and attaches it to the main loop context 
4452  * using g_source_attach(). You can do these steps manually if you 
4453  * need greater control.
4454  *
4455  * Return value: the ID (greater than 0) of the event source.
4456  *
4457  * Rename to: g_child_watch_add
4458  * Since: 2.4
4459  **/
4460 guint
4461 g_child_watch_add_full (gint            priority,
4462                         GPid            pid,
4463                         GChildWatchFunc function,
4464                         gpointer        data,
4465                         GDestroyNotify  notify)
4466 {
4467   GSource *source;
4468   guint id;
4469   
4470   g_return_val_if_fail (function != NULL, 0);
4471
4472   source = g_child_watch_source_new (pid);
4473
4474   if (priority != G_PRIORITY_DEFAULT)
4475     g_source_set_priority (source, priority);
4476
4477   g_source_set_callback (source, (GSourceFunc) function, data, notify);
4478   id = g_source_attach (source, NULL);
4479   g_source_unref (source);
4480
4481   return id;
4482 }
4483
4484 /**
4485  * g_child_watch_add:
4486  * @pid:      process id to watch. On POSIX the pid of a child process. On
4487  * Windows a handle for a process (which doesn't have to be a child).
4488  * @function: function to call
4489  * @data:     data to pass to @function
4490  * 
4491  * Sets a function to be called when the child indicated by @pid 
4492  * exits, at a default priority, #G_PRIORITY_DEFAULT.
4493  * 
4494  * If you obtain @pid from g_spawn_async() or g_spawn_async_with_pipes() 
4495  * you will need to pass #G_SPAWN_DO_NOT_REAP_CHILD as flag to 
4496  * the spawn function for the child watching to work.
4497  * 
4498  * Note that on platforms where #GPid must be explicitly closed
4499  * (see g_spawn_close_pid()) @pid must not be closed while the
4500  * source is still active. Typically, you will want to call
4501  * g_spawn_close_pid() in the callback function for the source.
4502  *
4503  * GLib supports only a single callback per process id.
4504  *
4505  * This internally creates a main loop source using 
4506  * g_child_watch_source_new() and attaches it to the main loop context 
4507  * using g_source_attach(). You can do these steps manually if you 
4508  * need greater control.
4509  *
4510  * Return value: the ID (greater than 0) of the event source.
4511  *
4512  * Since: 2.4
4513  **/
4514 guint 
4515 g_child_watch_add (GPid            pid,
4516                    GChildWatchFunc function,
4517                    gpointer        data)
4518 {
4519   return g_child_watch_add_full (G_PRIORITY_DEFAULT, pid, function, data, NULL);
4520 }
4521
4522
4523 /* Idle functions */
4524
4525 static gboolean 
4526 g_idle_prepare  (GSource  *source,
4527                  gint     *timeout)
4528 {
4529   *timeout = 0;
4530
4531   return TRUE;
4532 }
4533
4534 static gboolean 
4535 g_idle_check    (GSource  *source)
4536 {
4537   return TRUE;
4538 }
4539
4540 static gboolean
4541 g_idle_dispatch (GSource    *source, 
4542                  GSourceFunc callback,
4543                  gpointer    user_data)
4544 {
4545   if (!callback)
4546     {
4547       g_warning ("Idle source dispatched without callback\n"
4548                  "You must call g_source_set_callback().");
4549       return FALSE;
4550     }
4551   
4552   return callback (user_data);
4553 }
4554
4555 /**
4556  * g_idle_source_new:
4557  * 
4558  * Creates a new idle source.
4559  *
4560  * The source will not initially be associated with any #GMainContext
4561  * and must be added to one with g_source_attach() before it will be
4562  * executed. Note that the default priority for idle sources is
4563  * %G_PRIORITY_DEFAULT_IDLE, as compared to other sources which
4564  * have a default priority of %G_PRIORITY_DEFAULT.
4565  * 
4566  * Return value: the newly-created idle source
4567  **/
4568 GSource *
4569 g_idle_source_new (void)
4570 {
4571   GSource *source;
4572
4573   source = g_source_new (&g_idle_funcs, sizeof (GSource));
4574   g_source_set_priority (source, G_PRIORITY_DEFAULT_IDLE);
4575
4576   return source;
4577 }
4578
4579 /**
4580  * g_idle_add_full:
4581  * @priority: the priority of the idle source. Typically this will be in the
4582  *            range between #G_PRIORITY_DEFAULT_IDLE and #G_PRIORITY_HIGH_IDLE.
4583  * @function: function to call
4584  * @data:     data to pass to @function
4585  * @notify:   function to call when the idle is removed, or %NULL
4586  * 
4587  * Adds a function to be called whenever there are no higher priority
4588  * events pending.  If the function returns %FALSE it is automatically
4589  * removed from the list of event sources and will not be called again.
4590  * 
4591  * This internally creates a main loop source using g_idle_source_new()
4592  * and attaches it to the main loop context using g_source_attach(). 
4593  * You can do these steps manually if you need greater control.
4594  * 
4595  * Return value: the ID (greater than 0) of the event source.
4596  * Rename to: g_idle_add
4597  **/
4598 guint 
4599 g_idle_add_full (gint           priority,
4600                  GSourceFunc    function,
4601                  gpointer       data,
4602                  GDestroyNotify notify)
4603 {
4604   GSource *source;
4605   guint id;
4606   
4607   g_return_val_if_fail (function != NULL, 0);
4608
4609   source = g_idle_source_new ();
4610
4611   if (priority != G_PRIORITY_DEFAULT_IDLE)
4612     g_source_set_priority (source, priority);
4613
4614   g_source_set_callback (source, function, data, notify);
4615   id = g_source_attach (source, NULL);
4616   g_source_unref (source);
4617
4618   return id;
4619 }
4620
4621 /**
4622  * g_idle_add:
4623  * @function: function to call 
4624  * @data: data to pass to @function.
4625  * 
4626  * Adds a function to be called whenever there are no higher priority
4627  * events pending to the default main loop. The function is given the
4628  * default idle priority, #G_PRIORITY_DEFAULT_IDLE.  If the function
4629  * returns %FALSE it is automatically removed from the list of event
4630  * sources and will not be called again.
4631  * 
4632  * This internally creates a main loop source using g_idle_source_new()
4633  * and attaches it to the main loop context using g_source_attach(). 
4634  * You can do these steps manually if you need greater control.
4635  * 
4636  * Return value: the ID (greater than 0) of the event source.
4637  **/
4638 guint 
4639 g_idle_add (GSourceFunc    function,
4640             gpointer       data)
4641 {
4642   return g_idle_add_full (G_PRIORITY_DEFAULT_IDLE, function, data, NULL);
4643 }
4644
4645 /**
4646  * g_idle_remove_by_data:
4647  * @data: the data for the idle source's callback.
4648  * 
4649  * Removes the idle function with the given data.
4650  * 
4651  * Return value: %TRUE if an idle source was found and removed.
4652  **/
4653 gboolean
4654 g_idle_remove_by_data (gpointer data)
4655 {
4656   return g_source_remove_by_funcs_user_data (&g_idle_funcs, data);
4657 }
4658
4659 /**
4660  * g_main_context_invoke:
4661  * @context: (allow-none): a #GMainContext, or %NULL
4662  * @function: function to call
4663  * @data: data to pass to @function
4664  *
4665  * Invokes a function in such a way that @context is owned during the
4666  * invocation of @function.
4667  *
4668  * If @context is %NULL then the global default main context — as
4669  * returned by g_main_context_default() — is used.
4670  *
4671  * If @context is owned by the current thread, @function is called
4672  * directly.  Otherwise, if @context is the thread-default main context
4673  * of the current thread and g_main_context_acquire() succeeds, then
4674  * @function is called and g_main_context_release() is called
4675  * afterwards.
4676  *
4677  * In any other case, an idle source is created to call @function and
4678  * that source is attached to @context (presumably to be run in another
4679  * thread).  The idle source is attached with #G_PRIORITY_DEFAULT
4680  * priority.  If you want a different priority, use
4681  * g_main_context_invoke_full().
4682  *
4683  * Note that, as with normal idle functions, @function should probably
4684  * return %FALSE.  If it returns %TRUE, it will be continuously run in a
4685  * loop (and may prevent this call from returning).
4686  *
4687  * Since: 2.28
4688  **/
4689 void
4690 g_main_context_invoke (GMainContext *context,
4691                        GSourceFunc   function,
4692                        gpointer      data)
4693 {
4694   g_main_context_invoke_full (context,
4695                               G_PRIORITY_DEFAULT,
4696                               function, data, NULL);
4697 }
4698
4699 /**
4700  * g_main_context_invoke_full:
4701  * @context: (allow-none): a #GMainContext, or %NULL
4702  * @priority: the priority at which to run @function
4703  * @function: function to call
4704  * @data: data to pass to @function
4705  * @notify: a function to call when @data is no longer in use, or %NULL.
4706  *
4707  * Invokes a function in such a way that @context is owned during the
4708  * invocation of @function.
4709  *
4710  * This function is the same as g_main_context_invoke() except that it
4711  * lets you specify the priority incase @function ends up being
4712  * scheduled as an idle and also lets you give a #GDestroyNotify for @data.
4713  *
4714  * @notify should not assume that it is called from any particular
4715  * thread or with any particular context acquired.
4716  *
4717  * Since: 2.28
4718  **/
4719 void
4720 g_main_context_invoke_full (GMainContext   *context,
4721                             gint            priority,
4722                             GSourceFunc     function,
4723                             gpointer        data,
4724                             GDestroyNotify  notify)
4725 {
4726   g_return_if_fail (function != NULL);
4727
4728   if (!context)
4729     context = g_main_context_default ();
4730
4731   if (g_main_context_is_owner (context))
4732     {
4733       while (function (data));
4734       if (notify != NULL)
4735         notify (data);
4736     }
4737
4738   else
4739     {
4740       GMainContext *thread_default;
4741
4742       thread_default = g_main_context_get_thread_default ();
4743
4744       if (!thread_default)
4745         thread_default = g_main_context_default ();
4746
4747       if (thread_default == context && g_main_context_acquire (context))
4748         {
4749           while (function (data));
4750
4751           g_main_context_release (context);
4752
4753           if (notify != NULL)
4754             notify (data);
4755         }
4756       else
4757         {
4758           GSource *source;
4759
4760           source = g_idle_source_new ();
4761           g_source_set_priority (source, priority);
4762           g_source_set_callback (source, function, data, notify);
4763           g_source_attach (source, context);
4764           g_source_unref (source);
4765         }
4766     }
4767 }
4768
4769 static gpointer
4770 glib_worker_main (gpointer data)
4771 {
4772   while (TRUE)
4773     {
4774       g_main_context_iteration (glib_worker_context, TRUE);
4775
4776       if (any_unix_signal_pending)
4777         dispatch_unix_signals ();
4778     }
4779
4780   return NULL; /* worst GCC warning message ever... */
4781 }
4782
4783 GMainContext *
4784 glib_get_worker_context (void)
4785 {
4786   static gsize initialised;
4787
4788   g_thread_init_glib ();
4789
4790   if (g_once_init_enter (&initialised))
4791     {
4792       GError *error = NULL;
4793
4794       glib_worker_context = g_main_context_new ();
4795       if (g_thread_create (glib_worker_main, NULL, FALSE, &error) == NULL)
4796         g_error ("Creating GLib worker thread failed: %s\n", error->message);
4797
4798       g_once_init_leave (&initialised, TRUE);
4799     }
4800
4801   return glib_worker_context;
4802 }