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