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