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