3194c377778286feaee91ee879f3c5fd19767f4c
[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   gint64   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   gint64      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  *
1829  * Queries the system monotonic time, if available.
1830  *
1831  * On POSIX systems with clock_gettime() and %CLOCK_MONOTONIC this call
1832  * is a very shallow wrapper for that.  Otherwise, we make a best effort
1833  * that probably involves returning the wall clock time (with at least
1834  * microsecond accuracy, subject to the limitations of the OS kernel).
1835  *
1836  * Note that, on Windows, "limitations of the OS kernel" is a rather
1837  * substantial statement.  Depending on the configuration of the system,
1838  * the wall clock time is updated as infrequently as 64 times a second
1839  * (which is approximately every 16ms).
1840  *
1841  * Returns: the monotonic time, in microseconds
1842  *
1843  * Since: 2.28
1844  **/
1845 gint64
1846 g_get_monotonic_time (void)
1847 {
1848 #ifdef HAVE_CLOCK_GETTIME
1849   /* librt clock_gettime() is our first choice */
1850   {
1851     static int clockid = CLOCK_REALTIME;
1852     struct timespec ts;
1853
1854 #ifdef HAVE_MONOTONIC_CLOCK
1855     /* We have to check if we actually have monotonic clock support.
1856      *
1857      * There is no thread safety issue here since there is no harm if we
1858      * check twice.
1859      */
1860     {
1861       static gboolean checked;
1862
1863       if G_UNLIKELY (!checked)
1864         {
1865           if (sysconf (_SC_MONOTONIC_CLOCK) >= 0)
1866             clockid = CLOCK_MONOTONIC;
1867           checked = TRUE;
1868         }
1869     }
1870 #endif
1871
1872     clock_gettime (clockid, &ts);
1873
1874     /* In theory monotonic time can have any epoch.
1875      *
1876      * glib presently assumes the following:
1877      *
1878      *   1) The epoch comes some time after the birth of Jesus of Nazareth, but
1879      *      not more than 10000 years later.
1880      *
1881      *   2) The current time also falls sometime within this range.
1882      *
1883      * These two reasonable assumptions leave us with a maximum deviation from
1884      * the epoch of 10000 years, or 315569520000000000 seconds.
1885      *
1886      * If we restrict ourselves to this range then the number of microseconds
1887      * will always fit well inside the constraints of a int64 (by a factor of
1888      * about 29).
1889      *
1890      * If you actually hit the following assertion, probably you should file a
1891      * bug against your operating system for being excessively silly.
1892      **/
1893     g_assert (G_GINT64_CONSTANT (-315569520000000000) < ts.tv_sec &&
1894               ts.tv_sec < G_GINT64_CONSTANT (315569520000000000));
1895
1896     return (((gint64) ts.tv_sec) * 1000000) + (ts.tv_nsec / 1000);
1897   }
1898 #else
1899   /* It may look like we are discarding accuracy on Windows (since its
1900    * current time is expressed in 100s of nanoseconds) but according to
1901    * many sources, the time is only updated 64 times per second, so
1902    * microsecond accuracy is more than enough.
1903    */
1904   {
1905     GTimeVal tv;
1906
1907     g_get_current_time (&tv);
1908
1909     return (((gint64) tv.tv_sec) * 1000000) + tv.tv_usec;
1910   }
1911 #endif
1912 }
1913
1914 static void
1915 g_main_dispatch_free (gpointer dispatch)
1916 {
1917   g_slice_free (GMainDispatch, dispatch);
1918 }
1919
1920 /* Running the main loop */
1921
1922 static GMainDispatch *
1923 get_dispatch (void)
1924 {
1925   static GStaticPrivate depth_private = G_STATIC_PRIVATE_INIT;
1926   GMainDispatch *dispatch = g_static_private_get (&depth_private);
1927   if (!dispatch)
1928     {
1929       dispatch = g_slice_new0 (GMainDispatch);
1930       g_static_private_set (&depth_private, dispatch, g_main_dispatch_free);
1931     }
1932
1933   return dispatch;
1934 }
1935
1936 /**
1937  * g_main_depth:
1938  *
1939  * Returns the depth of the stack of calls to
1940  * g_main_context_dispatch() on any #GMainContext in the current thread.
1941  *  That is, when called from the toplevel, it gives 0. When
1942  * called from within a callback from g_main_context_iteration()
1943  * (or g_main_loop_run(), etc.) it returns 1. When called from within 
1944  * a callback to a recursive call to g_main_context_iterate(),
1945  * it returns 2. And so forth.
1946  *
1947  * This function is useful in a situation like the following:
1948  * Imagine an extremely simple "garbage collected" system.
1949  *
1950  * |[
1951  * static GList *free_list;
1952  * 
1953  * gpointer
1954  * allocate_memory (gsize size)
1955  * { 
1956  *   gpointer result = g_malloc (size);
1957  *   free_list = g_list_prepend (free_list, result);
1958  *   return result;
1959  * }
1960  * 
1961  * void
1962  * free_allocated_memory (void)
1963  * {
1964  *   GList *l;
1965  *   for (l = free_list; l; l = l->next);
1966  *     g_free (l->data);
1967  *   g_list_free (free_list);
1968  *   free_list = NULL;
1969  *  }
1970  * 
1971  * [...]
1972  * 
1973  * while (TRUE); 
1974  *  {
1975  *    g_main_context_iteration (NULL, TRUE);
1976  *    free_allocated_memory();
1977  *   }
1978  * ]|
1979  *
1980  * This works from an application, however, if you want to do the same
1981  * thing from a library, it gets more difficult, since you no longer
1982  * control the main loop. You might think you can simply use an idle
1983  * function to make the call to free_allocated_memory(), but that
1984  * doesn't work, since the idle function could be called from a
1985  * recursive callback. This can be fixed by using g_main_depth()
1986  *
1987  * |[
1988  * gpointer
1989  * allocate_memory (gsize size)
1990  * { 
1991  *   FreeListBlock *block = g_new (FreeListBlock, 1);
1992  *   block->mem = g_malloc (size);
1993  *   block->depth = g_main_depth ();   
1994  *   free_list = g_list_prepend (free_list, block);
1995  *   return block->mem;
1996  * }
1997  * 
1998  * void
1999  * free_allocated_memory (void)
2000  * {
2001  *   GList *l;
2002  *   
2003  *   int depth = g_main_depth ();
2004  *   for (l = free_list; l; );
2005  *     {
2006  *       GList *next = l->next;
2007  *       FreeListBlock *block = l->data;
2008  *       if (block->depth > depth)
2009  *         {
2010  *           g_free (block->mem);
2011  *           g_free (block);
2012  *           free_list = g_list_delete_link (free_list, l);
2013  *         }
2014  *               
2015  *       l = next;
2016  *     }
2017  *   }
2018  * ]|
2019  *
2020  * There is a temptation to use g_main_depth() to solve
2021  * problems with reentrancy. For instance, while waiting for data
2022  * to be received from the network in response to a menu item,
2023  * the menu item might be selected again. It might seem that
2024  * one could make the menu item's callback return immediately
2025  * and do nothing if g_main_depth() returns a value greater than 1.
2026  * However, this should be avoided since the user then sees selecting
2027  * the menu item do nothing. Furthermore, you'll find yourself adding
2028  * these checks all over your code, since there are doubtless many,
2029  * many things that the user could do. Instead, you can use the
2030  * following techniques:
2031  *
2032  * <orderedlist>
2033  *  <listitem>
2034  *   <para>
2035  *     Use gtk_widget_set_sensitive() or modal dialogs to prevent
2036  *     the user from interacting with elements while the main
2037  *     loop is recursing.
2038  *   </para>
2039  *  </listitem>
2040  *  <listitem>
2041  *   <para>
2042  *     Avoid main loop recursion in situations where you can't handle
2043  *     arbitrary  callbacks. Instead, structure your code so that you
2044  *     simply return to the main loop and then get called again when
2045  *     there is more work to do.
2046  *   </para>
2047  *  </listitem>
2048  * </orderedlist>
2049  * 
2050  * Return value: The main loop recursion level in the current thread
2051  **/
2052 int
2053 g_main_depth (void)
2054 {
2055   GMainDispatch *dispatch = get_dispatch ();
2056   return dispatch->depth;
2057 }
2058
2059 /**
2060  * g_main_current_source:
2061  *
2062  * Returns the currently firing source for this thread.
2063  * 
2064  * Return value: The currently firing source or %NULL.
2065  *
2066  * Since: 2.12
2067  */
2068 GSource *
2069 g_main_current_source (void)
2070 {
2071   GMainDispatch *dispatch = get_dispatch ();
2072   return dispatch->dispatching_sources ? dispatch->dispatching_sources->data : NULL;
2073 }
2074
2075 /**
2076  * g_source_is_destroyed:
2077  * @source: a #GSource
2078  *
2079  * Returns whether @source has been destroyed.
2080  *
2081  * This is important when you operate upon your objects 
2082  * from within idle handlers, but may have freed the object 
2083  * before the dispatch of your idle handler.
2084  *
2085  * |[
2086  * static gboolean 
2087  * idle_callback (gpointer data)
2088  * {
2089  *   SomeWidget *self = data;
2090  *    
2091  *   GDK_THREADS_ENTER (<!-- -->);
2092  *   /<!-- -->* do stuff with self *<!-- -->/
2093  *   self->idle_id = 0;
2094  *   GDK_THREADS_LEAVE (<!-- -->);
2095  *    
2096  *   return FALSE;
2097  * }
2098  *  
2099  * static void 
2100  * some_widget_do_stuff_later (SomeWidget *self)
2101  * {
2102  *   self->idle_id = g_idle_add (idle_callback, self);
2103  * }
2104  *  
2105  * static void 
2106  * some_widget_finalize (GObject *object)
2107  * {
2108  *   SomeWidget *self = SOME_WIDGET (object);
2109  *    
2110  *   if (self->idle_id)
2111  *     g_source_remove (self->idle_id);
2112  *    
2113  *   G_OBJECT_CLASS (parent_class)->finalize (object);
2114  * }
2115  * ]|
2116  *
2117  * This will fail in a multi-threaded application if the 
2118  * widget is destroyed before the idle handler fires due 
2119  * to the use after free in the callback. A solution, to 
2120  * this particular problem, is to check to if the source
2121  * has already been destroy within the callback.
2122  *
2123  * |[
2124  * static gboolean 
2125  * idle_callback (gpointer data)
2126  * {
2127  *   SomeWidget *self = data;
2128  *   
2129  *   GDK_THREADS_ENTER ();
2130  *   if (!g_source_is_destroyed (g_main_current_source ()))
2131  *     {
2132  *       /<!-- -->* do stuff with self *<!-- -->/
2133  *     }
2134  *   GDK_THREADS_LEAVE ();
2135  *   
2136  *   return FALSE;
2137  * }
2138  * ]|
2139  *
2140  * Return value: %TRUE if the source has been destroyed
2141  *
2142  * Since: 2.12
2143  */
2144 gboolean
2145 g_source_is_destroyed (GSource *source)
2146 {
2147   return SOURCE_DESTROYED (source);
2148 }
2149
2150 /* Temporarily remove all this source's file descriptors from the
2151  * poll(), so that if data comes available for one of the file descriptors
2152  * we don't continually spin in the poll()
2153  */
2154 /* HOLDS: source->context's lock */
2155 static void
2156 block_source (GSource *source)
2157 {
2158   GSList *tmp_list;
2159
2160   g_return_if_fail (!SOURCE_BLOCKED (source));
2161
2162   tmp_list = source->poll_fds;
2163   while (tmp_list)
2164     {
2165       g_main_context_remove_poll_unlocked (source->context, tmp_list->data);
2166       tmp_list = tmp_list->next;
2167     }
2168 }
2169
2170 /* HOLDS: source->context's lock */
2171 static void
2172 unblock_source (GSource *source)
2173 {
2174   GSList *tmp_list;
2175   
2176   g_return_if_fail (!SOURCE_BLOCKED (source)); /* Source already unblocked */
2177   g_return_if_fail (!SOURCE_DESTROYED (source));
2178   
2179   tmp_list = source->poll_fds;
2180   while (tmp_list)
2181     {
2182       g_main_context_add_poll_unlocked (source->context, source->priority, tmp_list->data);
2183       tmp_list = tmp_list->next;
2184     }
2185 }
2186
2187 /* HOLDS: context's lock */
2188 static void
2189 g_main_dispatch (GMainContext *context)
2190 {
2191   GMainDispatch *current = get_dispatch ();
2192   guint i;
2193
2194   for (i = 0; i < context->pending_dispatches->len; i++)
2195     {
2196       GSource *source = context->pending_dispatches->pdata[i];
2197
2198       context->pending_dispatches->pdata[i] = NULL;
2199       g_assert (source);
2200
2201       source->flags &= ~G_SOURCE_READY;
2202
2203       if (!SOURCE_DESTROYED (source))
2204         {
2205           gboolean was_in_call;
2206           gpointer user_data = NULL;
2207           GSourceFunc callback = NULL;
2208           GSourceCallbackFuncs *cb_funcs;
2209           gpointer cb_data;
2210           gboolean need_destroy;
2211
2212           gboolean (*dispatch) (GSource *,
2213                                 GSourceFunc,
2214                                 gpointer);
2215           GSList current_source_link;
2216
2217           dispatch = source->source_funcs->dispatch;
2218           cb_funcs = source->callback_funcs;
2219           cb_data = source->callback_data;
2220
2221           if (cb_funcs)
2222             cb_funcs->ref (cb_data);
2223           
2224           if ((source->flags & G_SOURCE_CAN_RECURSE) == 0)
2225             block_source (source);
2226           
2227           was_in_call = source->flags & G_HOOK_FLAG_IN_CALL;
2228           source->flags |= G_HOOK_FLAG_IN_CALL;
2229
2230           if (cb_funcs)
2231             cb_funcs->get (cb_data, source, &callback, &user_data);
2232
2233           UNLOCK_CONTEXT (context);
2234
2235           current->depth++;
2236           /* The on-stack allocation of the GSList is unconventional, but
2237            * we know that the lifetime of the link is bounded to this
2238            * function as the link is kept in a thread specific list and
2239            * not manipulated outside of this function and its descendants.
2240            * Avoiding the overhead of a g_slist_alloc() is useful as many
2241            * applications do little more than dispatch events.
2242            *
2243            * This is a performance hack - do not revert to g_slist_prepend()!
2244            */
2245           current_source_link.data = source;
2246           current_source_link.next = current->dispatching_sources;
2247           current->dispatching_sources = &current_source_link;
2248           need_destroy = ! dispatch (source,
2249                                      callback,
2250                                      user_data);
2251           g_assert (current->dispatching_sources == &current_source_link);
2252           current->dispatching_sources = current_source_link.next;
2253           current->depth--;
2254           
2255           if (cb_funcs)
2256             cb_funcs->unref (cb_data);
2257
2258           LOCK_CONTEXT (context);
2259           
2260           if (!was_in_call)
2261             source->flags &= ~G_HOOK_FLAG_IN_CALL;
2262
2263           if ((source->flags & G_SOURCE_CAN_RECURSE) == 0 &&
2264               !SOURCE_DESTROYED (source))
2265             unblock_source (source);
2266           
2267           /* Note: this depends on the fact that we can't switch
2268            * sources from one main context to another
2269            */
2270           if (need_destroy && !SOURCE_DESTROYED (source))
2271             {
2272               g_assert (source->context == context);
2273               g_source_destroy_internal (source, context, TRUE);
2274             }
2275         }
2276       
2277       SOURCE_UNREF (source, context);
2278     }
2279
2280   g_ptr_array_set_size (context->pending_dispatches, 0);
2281 }
2282
2283 /* Holds context's lock */
2284 static inline GSource *
2285 next_valid_source (GMainContext *context,
2286                    GSource      *source)
2287 {
2288   GSource *new_source = source ? source->next : context->source_list;
2289
2290   while (new_source)
2291     {
2292       if (!SOURCE_DESTROYED (new_source))
2293         {
2294           new_source->ref_count++;
2295           break;
2296         }
2297       
2298       new_source = new_source->next;
2299     }
2300
2301   if (source)
2302     SOURCE_UNREF (source, context);
2303           
2304   return new_source;
2305 }
2306
2307 /**
2308  * g_main_context_acquire:
2309  * @context: a #GMainContext
2310  * 
2311  * Tries to become the owner of the specified context.
2312  * If some other thread is the owner of the context,
2313  * returns %FALSE immediately. Ownership is properly
2314  * recursive: the owner can require ownership again
2315  * and will release ownership when g_main_context_release()
2316  * is called as many times as g_main_context_acquire().
2317  *
2318  * You must be the owner of a context before you
2319  * can call g_main_context_prepare(), g_main_context_query(),
2320  * g_main_context_check(), g_main_context_dispatch().
2321  * 
2322  * Return value: %TRUE if the operation succeeded, and
2323  *   this thread is now the owner of @context.
2324  **/
2325 gboolean 
2326 g_main_context_acquire (GMainContext *context)
2327 {
2328 #ifdef G_THREADS_ENABLED
2329   gboolean result = FALSE;
2330   GThread *self = G_THREAD_SELF;
2331
2332   if (context == NULL)
2333     context = g_main_context_default ();
2334   
2335   LOCK_CONTEXT (context);
2336
2337   if (!context->owner)
2338     {
2339       context->owner = self;
2340       g_assert (context->owner_count == 0);
2341     }
2342
2343   if (context->owner == self)
2344     {
2345       context->owner_count++;
2346       result = TRUE;
2347     }
2348
2349   UNLOCK_CONTEXT (context); 
2350   
2351   return result;
2352 #else /* !G_THREADS_ENABLED */
2353   return TRUE;
2354 #endif /* G_THREADS_ENABLED */
2355 }
2356
2357 /**
2358  * g_main_context_release:
2359  * @context: a #GMainContext
2360  * 
2361  * Releases ownership of a context previously acquired by this thread
2362  * with g_main_context_acquire(). If the context was acquired multiple
2363  * times, the ownership will be released only when g_main_context_release()
2364  * is called as many times as it was acquired.
2365  **/
2366 void
2367 g_main_context_release (GMainContext *context)
2368 {
2369 #ifdef G_THREADS_ENABLED
2370   if (context == NULL)
2371     context = g_main_context_default ();
2372   
2373   LOCK_CONTEXT (context);
2374
2375   context->owner_count--;
2376   if (context->owner_count == 0)
2377     {
2378       context->owner = NULL;
2379
2380       if (context->waiters)
2381         {
2382           GMainWaiter *waiter = context->waiters->data;
2383           gboolean loop_internal_waiter =
2384             (waiter->mutex == g_static_mutex_get_mutex (&context->mutex));
2385           context->waiters = g_slist_delete_link (context->waiters,
2386                                                   context->waiters);
2387           if (!loop_internal_waiter)
2388             g_mutex_lock (waiter->mutex);
2389           
2390           g_cond_signal (waiter->cond);
2391           
2392           if (!loop_internal_waiter)
2393             g_mutex_unlock (waiter->mutex);
2394         }
2395     }
2396
2397   UNLOCK_CONTEXT (context); 
2398 #endif /* G_THREADS_ENABLED */
2399 }
2400
2401 /**
2402  * g_main_context_wait:
2403  * @context: a #GMainContext
2404  * @cond: a condition variable
2405  * @mutex: a mutex, currently held
2406  * 
2407  * Tries to become the owner of the specified context,
2408  * as with g_main_context_acquire(). But if another thread
2409  * is the owner, atomically drop @mutex and wait on @cond until 
2410  * that owner releases ownership or until @cond is signaled, then
2411  * try again (once) to become the owner.
2412  * 
2413  * Return value: %TRUE if the operation succeeded, and
2414  *   this thread is now the owner of @context.
2415  **/
2416 gboolean
2417 g_main_context_wait (GMainContext *context,
2418                      GCond        *cond,
2419                      GMutex       *mutex)
2420 {
2421 #ifdef G_THREADS_ENABLED
2422   gboolean result = FALSE;
2423   GThread *self = G_THREAD_SELF;
2424   gboolean loop_internal_waiter;
2425   
2426   if (context == NULL)
2427     context = g_main_context_default ();
2428
2429   loop_internal_waiter = (mutex == g_static_mutex_get_mutex (&context->mutex));
2430   
2431   if (!loop_internal_waiter)
2432     LOCK_CONTEXT (context);
2433
2434   if (context->owner && context->owner != self)
2435     {
2436       GMainWaiter waiter;
2437
2438       waiter.cond = cond;
2439       waiter.mutex = mutex;
2440
2441       context->waiters = g_slist_append (context->waiters, &waiter);
2442       
2443       if (!loop_internal_waiter)
2444         UNLOCK_CONTEXT (context);
2445       g_cond_wait (cond, mutex);
2446       if (!loop_internal_waiter)      
2447         LOCK_CONTEXT (context);
2448
2449       context->waiters = g_slist_remove (context->waiters, &waiter);
2450     }
2451
2452   if (!context->owner)
2453     {
2454       context->owner = self;
2455       g_assert (context->owner_count == 0);
2456     }
2457
2458   if (context->owner == self)
2459     {
2460       context->owner_count++;
2461       result = TRUE;
2462     }
2463
2464   if (!loop_internal_waiter)
2465     UNLOCK_CONTEXT (context); 
2466   
2467   return result;
2468 #else /* !G_THREADS_ENABLED */
2469   return TRUE;
2470 #endif /* G_THREADS_ENABLED */
2471 }
2472
2473 /**
2474  * g_main_context_prepare:
2475  * @context: a #GMainContext
2476  * @priority: location to store priority of highest priority
2477  *            source already ready.
2478  * 
2479  * Prepares to poll sources within a main loop. The resulting information
2480  * for polling is determined by calling g_main_context_query ().
2481  * 
2482  * Return value: %TRUE if some source is ready to be dispatched
2483  *               prior to polling.
2484  **/
2485 gboolean
2486 g_main_context_prepare (GMainContext *context,
2487                         gint         *priority)
2488 {
2489   gint i;
2490   gint n_ready = 0;
2491   gint current_priority = G_MAXINT;
2492   GSource *source;
2493
2494   if (context == NULL)
2495     context = g_main_context_default ();
2496   
2497   LOCK_CONTEXT (context);
2498
2499   context->time_is_fresh = FALSE;
2500   context->current_time_is_fresh = FALSE;
2501
2502   if (context->in_check_or_prepare)
2503     {
2504       g_warning ("g_main_context_prepare() called recursively from within a source's check() or "
2505                  "prepare() member.");
2506       UNLOCK_CONTEXT (context);
2507       return FALSE;
2508     }
2509
2510 #ifdef G_THREADS_ENABLED
2511   if (context->poll_waiting)
2512     {
2513       g_warning("g_main_context_prepare(): main loop already active in another thread");
2514       UNLOCK_CONTEXT (context);
2515       return FALSE;
2516     }
2517   
2518   context->poll_waiting = TRUE;
2519 #endif /* G_THREADS_ENABLED */
2520
2521 #if 0
2522   /* If recursing, finish up current dispatch, before starting over */
2523   if (context->pending_dispatches)
2524     {
2525       if (dispatch)
2526         g_main_dispatch (context, &current_time);
2527       
2528       UNLOCK_CONTEXT (context);
2529       return TRUE;
2530     }
2531 #endif
2532
2533   /* If recursing, clear list of pending dispatches */
2534
2535   for (i = 0; i < context->pending_dispatches->len; i++)
2536     {
2537       if (context->pending_dispatches->pdata[i])
2538         SOURCE_UNREF ((GSource *)context->pending_dispatches->pdata[i], context);
2539     }
2540   g_ptr_array_set_size (context->pending_dispatches, 0);
2541   
2542   /* Prepare all sources */
2543
2544   context->timeout = -1;
2545   
2546   source = next_valid_source (context, NULL);
2547   while (source)
2548     {
2549       gint source_timeout = -1;
2550
2551       if ((n_ready > 0) && (source->priority > current_priority))
2552         {
2553           SOURCE_UNREF (source, context);
2554           break;
2555         }
2556       if (SOURCE_BLOCKED (source))
2557         goto next;
2558
2559       if (!(source->flags & G_SOURCE_READY))
2560         {
2561           gboolean result;
2562           gboolean (*prepare)  (GSource  *source, 
2563                                 gint     *timeout);
2564
2565           prepare = source->source_funcs->prepare;
2566           context->in_check_or_prepare++;
2567           UNLOCK_CONTEXT (context);
2568
2569           result = (*prepare) (source, &source_timeout);
2570
2571           LOCK_CONTEXT (context);
2572           context->in_check_or_prepare--;
2573
2574           if (result)
2575             source->flags |= G_SOURCE_READY;
2576         }
2577
2578       if (source->flags & G_SOURCE_READY)
2579         {
2580           n_ready++;
2581           current_priority = source->priority;
2582           context->timeout = 0;
2583         }
2584       
2585       if (source_timeout >= 0)
2586         {
2587           if (context->timeout < 0)
2588             context->timeout = source_timeout;
2589           else
2590             context->timeout = MIN (context->timeout, source_timeout);
2591         }
2592
2593     next:
2594       source = next_valid_source (context, source);
2595     }
2596
2597   UNLOCK_CONTEXT (context);
2598   
2599   if (priority)
2600     *priority = current_priority;
2601   
2602   return (n_ready > 0);
2603 }
2604
2605 /**
2606  * g_main_context_query:
2607  * @context: a #GMainContext
2608  * @max_priority: maximum priority source to check
2609  * @timeout_: location to store timeout to be used in polling
2610  * @fds: location to store #GPollFD records that need to be polled.
2611  * @n_fds: length of @fds.
2612  * 
2613  * Determines information necessary to poll this main loop.
2614  * 
2615  * Return value: the number of records actually stored in @fds,
2616  *   or, if more than @n_fds records need to be stored, the number
2617  *   of records that need to be stored.
2618  **/
2619 gint
2620 g_main_context_query (GMainContext *context,
2621                       gint          max_priority,
2622                       gint         *timeout,
2623                       GPollFD      *fds,
2624                       gint          n_fds)
2625 {
2626   gint n_poll;
2627   GPollRec *pollrec;
2628   
2629   LOCK_CONTEXT (context);
2630
2631   pollrec = context->poll_records;
2632   n_poll = 0;
2633   while (pollrec && max_priority >= pollrec->priority)
2634     {
2635       /* We need to include entries with fd->events == 0 in the array because
2636        * otherwise if the application changes fd->events behind our back and 
2637        * makes it non-zero, we'll be out of sync when we check the fds[] array.
2638        * (Changing fd->events after adding an FD wasn't an anticipated use of 
2639        * this API, but it occurs in practice.) */
2640       if (n_poll < n_fds)
2641         {
2642           fds[n_poll].fd = pollrec->fd->fd;
2643           /* In direct contradiction to the Unix98 spec, IRIX runs into
2644            * difficulty if you pass in POLLERR, POLLHUP or POLLNVAL
2645            * flags in the events field of the pollfd while it should
2646            * just ignoring them. So we mask them out here.
2647            */
2648           fds[n_poll].events = pollrec->fd->events & ~(G_IO_ERR|G_IO_HUP|G_IO_NVAL);
2649           fds[n_poll].revents = 0;
2650         }
2651
2652       pollrec = pollrec->next;
2653       n_poll++;
2654     }
2655
2656 #ifdef G_THREADS_ENABLED
2657   context->poll_changed = FALSE;
2658 #endif
2659   
2660   if (timeout)
2661     {
2662       *timeout = context->timeout;
2663       if (*timeout != 0)
2664         {
2665           context->time_is_fresh = FALSE;
2666           context->current_time_is_fresh = FALSE;
2667         }
2668     }
2669   
2670   UNLOCK_CONTEXT (context);
2671
2672   return n_poll;
2673 }
2674
2675 /**
2676  * g_main_context_check:
2677  * @context: a #GMainContext
2678  * @max_priority: the maximum numerical priority of sources to check
2679  * @fds: array of #GPollFD's that was passed to the last call to
2680  *       g_main_context_query()
2681  * @n_fds: return value of g_main_context_query()
2682  * 
2683  * Passes the results of polling back to the main loop.
2684  * 
2685  * Return value: %TRUE if some sources are ready to be dispatched.
2686  **/
2687 gboolean
2688 g_main_context_check (GMainContext *context,
2689                       gint          max_priority,
2690                       GPollFD      *fds,
2691                       gint          n_fds)
2692 {
2693   GSource *source;
2694   GPollRec *pollrec;
2695   gint n_ready = 0;
2696   gint i;
2697    
2698   LOCK_CONTEXT (context);
2699
2700   if (context->in_check_or_prepare)
2701     {
2702       g_warning ("g_main_context_check() called recursively from within a source's check() or "
2703                  "prepare() member.");
2704       UNLOCK_CONTEXT (context);
2705       return FALSE;
2706     }
2707   
2708 #ifdef G_THREADS_ENABLED
2709   if (!context->poll_waiting)
2710     {
2711 #ifndef G_OS_WIN32
2712       gchar a;
2713       read (context->wake_up_pipe[0], &a, 1);
2714 #endif
2715     }
2716   else
2717     context->poll_waiting = FALSE;
2718
2719   /* If the set of poll file descriptors changed, bail out
2720    * and let the main loop rerun
2721    */
2722   if (context->poll_changed)
2723     {
2724       UNLOCK_CONTEXT (context);
2725       return FALSE;
2726     }
2727 #endif /* G_THREADS_ENABLED */
2728   
2729   pollrec = context->poll_records;
2730   i = 0;
2731   while (i < n_fds)
2732     {
2733       if (pollrec->fd->events)
2734         pollrec->fd->revents = fds[i].revents;
2735
2736       pollrec = pollrec->next;
2737       i++;
2738     }
2739
2740   source = next_valid_source (context, NULL);
2741   while (source)
2742     {
2743       if ((n_ready > 0) && (source->priority > max_priority))
2744         {
2745           SOURCE_UNREF (source, context);
2746           break;
2747         }
2748       if (SOURCE_BLOCKED (source))
2749         goto next;
2750
2751       if (!(source->flags & G_SOURCE_READY))
2752         {
2753           gboolean result;
2754           gboolean (*check) (GSource  *source);
2755
2756           check = source->source_funcs->check;
2757           
2758           context->in_check_or_prepare++;
2759           UNLOCK_CONTEXT (context);
2760           
2761           result = (*check) (source);
2762           
2763           LOCK_CONTEXT (context);
2764           context->in_check_or_prepare--;
2765           
2766           if (result)
2767             source->flags |= G_SOURCE_READY;
2768         }
2769
2770       if (source->flags & G_SOURCE_READY)
2771         {
2772           source->ref_count++;
2773           g_ptr_array_add (context->pending_dispatches, source);
2774
2775           n_ready++;
2776
2777           /* never dispatch sources with less priority than the first
2778            * one we choose to dispatch
2779            */
2780           max_priority = source->priority;
2781         }
2782
2783     next:
2784       source = next_valid_source (context, source);
2785     }
2786
2787   UNLOCK_CONTEXT (context);
2788
2789   return n_ready > 0;
2790 }
2791
2792 /**
2793  * g_main_context_dispatch:
2794  * @context: a #GMainContext
2795  * 
2796  * Dispatches all pending sources.
2797  **/
2798 void
2799 g_main_context_dispatch (GMainContext *context)
2800 {
2801   LOCK_CONTEXT (context);
2802
2803   if (context->pending_dispatches->len > 0)
2804     {
2805       g_main_dispatch (context);
2806     }
2807
2808   UNLOCK_CONTEXT (context);
2809 }
2810
2811 /* HOLDS context lock */
2812 static gboolean
2813 g_main_context_iterate (GMainContext *context,
2814                         gboolean      block,
2815                         gboolean      dispatch,
2816                         GThread      *self)
2817 {
2818   gint max_priority;
2819   gint timeout;
2820   gboolean some_ready;
2821   gint nfds, allocated_nfds;
2822   GPollFD *fds = NULL;
2823
2824   UNLOCK_CONTEXT (context);
2825
2826 #ifdef G_THREADS_ENABLED
2827   if (!g_main_context_acquire (context))
2828     {
2829       gboolean got_ownership;
2830
2831       LOCK_CONTEXT (context);
2832
2833       g_return_val_if_fail (g_thread_supported (), FALSE);
2834
2835       if (!block)
2836         return FALSE;
2837
2838       if (!context->cond)
2839         context->cond = g_cond_new ();
2840
2841       got_ownership = g_main_context_wait (context,
2842                                            context->cond,
2843                                            g_static_mutex_get_mutex (&context->mutex));
2844
2845       if (!got_ownership)
2846         return FALSE;
2847     }
2848   else
2849     LOCK_CONTEXT (context);
2850 #endif /* G_THREADS_ENABLED */
2851   
2852   if (!context->cached_poll_array)
2853     {
2854       context->cached_poll_array_size = context->n_poll_records;
2855       context->cached_poll_array = g_new (GPollFD, context->n_poll_records);
2856     }
2857
2858   allocated_nfds = context->cached_poll_array_size;
2859   fds = context->cached_poll_array;
2860   
2861   UNLOCK_CONTEXT (context);
2862
2863   g_main_context_prepare (context, &max_priority); 
2864   
2865   while ((nfds = g_main_context_query (context, max_priority, &timeout, fds, 
2866                                        allocated_nfds)) > allocated_nfds)
2867     {
2868       LOCK_CONTEXT (context);
2869       g_free (fds);
2870       context->cached_poll_array_size = allocated_nfds = nfds;
2871       context->cached_poll_array = fds = g_new (GPollFD, nfds);
2872       UNLOCK_CONTEXT (context);
2873     }
2874
2875   if (!block)
2876     timeout = 0;
2877   
2878   g_main_context_poll (context, timeout, max_priority, fds, nfds);
2879   
2880   some_ready = g_main_context_check (context, max_priority, fds, nfds);
2881   
2882   if (dispatch)
2883     g_main_context_dispatch (context);
2884   
2885 #ifdef G_THREADS_ENABLED
2886   g_main_context_release (context);
2887 #endif /* G_THREADS_ENABLED */    
2888
2889   LOCK_CONTEXT (context);
2890
2891   return some_ready;
2892 }
2893
2894 /**
2895  * g_main_context_pending:
2896  * @context: a #GMainContext (if %NULL, the default context will be used)
2897  *
2898  * Checks if any sources have pending events for the given context.
2899  * 
2900  * Return value: %TRUE if events are pending.
2901  **/
2902 gboolean 
2903 g_main_context_pending (GMainContext *context)
2904 {
2905   gboolean retval;
2906
2907   if (!context)
2908     context = g_main_context_default();
2909
2910   LOCK_CONTEXT (context);
2911   retval = g_main_context_iterate (context, FALSE, FALSE, G_THREAD_SELF);
2912   UNLOCK_CONTEXT (context);
2913   
2914   return retval;
2915 }
2916
2917 /**
2918  * g_main_context_iteration:
2919  * @context: a #GMainContext (if %NULL, the default context will be used) 
2920  * @may_block: whether the call may block.
2921  * 
2922  * Runs a single iteration for the given main loop. This involves
2923  * checking to see if any event sources are ready to be processed,
2924  * then if no events sources are ready and @may_block is %TRUE, waiting
2925  * for a source to become ready, then dispatching the highest priority
2926  * events sources that are ready. Otherwise, if @may_block is %FALSE 
2927  * sources are not waited to become ready, only those highest priority 
2928  * events sources will be dispatched (if any), that are ready at this 
2929  * given moment without further waiting.
2930  *
2931  * Note that even when @may_block is %TRUE, it is still possible for 
2932  * g_main_context_iteration() to return %FALSE, since the the wait may 
2933  * be interrupted for other reasons than an event source becoming ready.
2934  * 
2935  * Return value: %TRUE if events were dispatched.
2936  **/
2937 gboolean
2938 g_main_context_iteration (GMainContext *context, gboolean may_block)
2939 {
2940   gboolean retval;
2941
2942   if (!context)
2943     context = g_main_context_default();
2944   
2945   LOCK_CONTEXT (context);
2946   retval = g_main_context_iterate (context, may_block, TRUE, G_THREAD_SELF);
2947   UNLOCK_CONTEXT (context);
2948   
2949   return retval;
2950 }
2951
2952 /**
2953  * g_main_loop_new:
2954  * @context: a #GMainContext  (if %NULL, the default context will be used).
2955  * @is_running: set to %TRUE to indicate that the loop is running. This
2956  * is not very important since calling g_main_loop_run() will set this to
2957  * %TRUE anyway.
2958  * 
2959  * Creates a new #GMainLoop structure.
2960  * 
2961  * Return value: a new #GMainLoop.
2962  **/
2963 GMainLoop *
2964 g_main_loop_new (GMainContext *context,
2965                  gboolean      is_running)
2966 {
2967   GMainLoop *loop;
2968
2969   if (!context)
2970     context = g_main_context_default();
2971   
2972   g_main_context_ref (context);
2973
2974   loop = g_new0 (GMainLoop, 1);
2975   loop->context = context;
2976   loop->is_running = is_running != FALSE;
2977   loop->ref_count = 1;
2978   
2979   return loop;
2980 }
2981
2982 /**
2983  * g_main_loop_ref:
2984  * @loop: a #GMainLoop
2985  * 
2986  * Increases the reference count on a #GMainLoop object by one.
2987  * 
2988  * Return value: @loop
2989  **/
2990 GMainLoop *
2991 g_main_loop_ref (GMainLoop *loop)
2992 {
2993   g_return_val_if_fail (loop != NULL, NULL);
2994   g_return_val_if_fail (g_atomic_int_get (&loop->ref_count) > 0, NULL);
2995
2996   g_atomic_int_inc (&loop->ref_count);
2997
2998   return loop;
2999 }
3000
3001 /**
3002  * g_main_loop_unref:
3003  * @loop: a #GMainLoop
3004  * 
3005  * Decreases the reference count on a #GMainLoop object by one. If
3006  * the result is zero, free the loop and free all associated memory.
3007  **/
3008 void
3009 g_main_loop_unref (GMainLoop *loop)
3010 {
3011   g_return_if_fail (loop != NULL);
3012   g_return_if_fail (g_atomic_int_get (&loop->ref_count) > 0);
3013
3014   if (!g_atomic_int_dec_and_test (&loop->ref_count))
3015     return;
3016
3017   g_main_context_unref (loop->context);
3018   g_free (loop);
3019 }
3020
3021 /**
3022  * g_main_loop_run:
3023  * @loop: a #GMainLoop
3024  * 
3025  * Runs a main loop until g_main_loop_quit() is called on the loop.
3026  * If this is called for the thread of the loop's #GMainContext,
3027  * it will process events from the loop, otherwise it will
3028  * simply wait.
3029  **/
3030 void 
3031 g_main_loop_run (GMainLoop *loop)
3032 {
3033   GThread *self = G_THREAD_SELF;
3034
3035   g_return_if_fail (loop != NULL);
3036   g_return_if_fail (g_atomic_int_get (&loop->ref_count) > 0);
3037
3038 #ifdef G_THREADS_ENABLED
3039   if (!g_main_context_acquire (loop->context))
3040     {
3041       gboolean got_ownership = FALSE;
3042       
3043       /* Another thread owns this context */
3044       if (!g_thread_supported ())
3045         {
3046           g_warning ("g_main_loop_run() was called from second thread but "
3047                      "g_thread_init() was never called.");
3048           return;
3049         }
3050       
3051       LOCK_CONTEXT (loop->context);
3052
3053       g_atomic_int_inc (&loop->ref_count);
3054
3055       if (!loop->is_running)
3056         loop->is_running = TRUE;
3057
3058       if (!loop->context->cond)
3059         loop->context->cond = g_cond_new ();
3060           
3061       while (loop->is_running && !got_ownership)
3062         got_ownership = g_main_context_wait (loop->context,
3063                                              loop->context->cond,
3064                                              g_static_mutex_get_mutex (&loop->context->mutex));
3065       
3066       if (!loop->is_running)
3067         {
3068           UNLOCK_CONTEXT (loop->context);
3069           if (got_ownership)
3070             g_main_context_release (loop->context);
3071           g_main_loop_unref (loop);
3072           return;
3073         }
3074
3075       g_assert (got_ownership);
3076     }
3077   else
3078     LOCK_CONTEXT (loop->context);
3079 #endif /* G_THREADS_ENABLED */ 
3080
3081   if (loop->context->in_check_or_prepare)
3082     {
3083       g_warning ("g_main_loop_run(): called recursively from within a source's "
3084                  "check() or prepare() member, iteration not possible.");
3085       return;
3086     }
3087
3088   g_atomic_int_inc (&loop->ref_count);
3089   loop->is_running = TRUE;
3090   while (loop->is_running)
3091     g_main_context_iterate (loop->context, TRUE, TRUE, self);
3092
3093   UNLOCK_CONTEXT (loop->context);
3094   
3095 #ifdef G_THREADS_ENABLED
3096   g_main_context_release (loop->context);
3097 #endif /* G_THREADS_ENABLED */    
3098   
3099   g_main_loop_unref (loop);
3100 }
3101
3102 /**
3103  * g_main_loop_quit:
3104  * @loop: a #GMainLoop
3105  * 
3106  * Stops a #GMainLoop from running. Any calls to g_main_loop_run()
3107  * for the loop will return. 
3108  *
3109  * Note that sources that have already been dispatched when 
3110  * g_main_loop_quit() is called will still be executed.
3111  **/
3112 void 
3113 g_main_loop_quit (GMainLoop *loop)
3114 {
3115   g_return_if_fail (loop != NULL);
3116   g_return_if_fail (g_atomic_int_get (&loop->ref_count) > 0);
3117
3118   LOCK_CONTEXT (loop->context);
3119   loop->is_running = FALSE;
3120   g_main_context_wakeup_unlocked (loop->context);
3121
3122 #ifdef G_THREADS_ENABLED
3123   if (loop->context->cond)
3124     g_cond_broadcast (loop->context->cond);
3125 #endif /* G_THREADS_ENABLED */
3126
3127   UNLOCK_CONTEXT (loop->context);
3128 }
3129
3130 /**
3131  * g_main_loop_is_running:
3132  * @loop: a #GMainLoop.
3133  * 
3134  * Checks to see if the main loop is currently being run via g_main_loop_run().
3135  * 
3136  * Return value: %TRUE if the mainloop is currently being run.
3137  **/
3138 gboolean
3139 g_main_loop_is_running (GMainLoop *loop)
3140 {
3141   g_return_val_if_fail (loop != NULL, FALSE);
3142   g_return_val_if_fail (g_atomic_int_get (&loop->ref_count) > 0, FALSE);
3143
3144   return loop->is_running;
3145 }
3146
3147 /**
3148  * g_main_loop_get_context:
3149  * @loop: a #GMainLoop.
3150  * 
3151  * Returns the #GMainContext of @loop.
3152  * 
3153  * Return value: the #GMainContext of @loop
3154  **/
3155 GMainContext *
3156 g_main_loop_get_context (GMainLoop *loop)
3157 {
3158   g_return_val_if_fail (loop != NULL, NULL);
3159   g_return_val_if_fail (g_atomic_int_get (&loop->ref_count) > 0, NULL);
3160  
3161   return loop->context;
3162 }
3163
3164 /* HOLDS: context's lock */
3165 static void
3166 g_main_context_poll (GMainContext *context,
3167                      gint          timeout,
3168                      gint          priority,
3169                      GPollFD      *fds,
3170                      gint          n_fds)
3171 {
3172 #ifdef  G_MAIN_POLL_DEBUG
3173   GTimer *poll_timer;
3174   GPollRec *pollrec;
3175   gint i;
3176 #endif
3177
3178   GPollFunc poll_func;
3179
3180   if (n_fds || timeout != 0)
3181     {
3182 #ifdef  G_MAIN_POLL_DEBUG
3183       if (_g_main_poll_debug)
3184         {
3185           g_print ("polling context=%p n=%d timeout=%d\n",
3186                    context, n_fds, timeout);
3187           poll_timer = g_timer_new ();
3188         }
3189 #endif
3190
3191       LOCK_CONTEXT (context);
3192
3193       poll_func = context->poll_func;
3194       
3195       UNLOCK_CONTEXT (context);
3196       if ((*poll_func) (fds, n_fds, timeout) < 0 && errno != EINTR)
3197         {
3198 #ifndef G_OS_WIN32
3199           g_warning ("poll(2) failed due to: %s.",
3200                      g_strerror (errno));
3201 #else
3202           /* If g_poll () returns -1, it has already called g_warning() */
3203 #endif
3204         }
3205       
3206 #ifdef  G_MAIN_POLL_DEBUG
3207       if (_g_main_poll_debug)
3208         {
3209           LOCK_CONTEXT (context);
3210
3211           g_print ("g_main_poll(%d) timeout: %d - elapsed %12.10f seconds",
3212                    n_fds,
3213                    timeout,
3214                    g_timer_elapsed (poll_timer, NULL));
3215           g_timer_destroy (poll_timer);
3216           pollrec = context->poll_records;
3217
3218           while (pollrec != NULL)
3219             {
3220               i = 0;
3221               while (i < n_fds)
3222                 {
3223                   if (fds[i].fd == pollrec->fd->fd &&
3224                       pollrec->fd->events &&
3225                       fds[i].revents)
3226                     {
3227                       g_print (" [" G_POLLFD_FORMAT " :", fds[i].fd);
3228                       if (fds[i].revents & G_IO_IN)
3229                         g_print ("i");
3230                       if (fds[i].revents & G_IO_OUT)
3231                         g_print ("o");
3232                       if (fds[i].revents & G_IO_PRI)
3233                         g_print ("p");
3234                       if (fds[i].revents & G_IO_ERR)
3235                         g_print ("e");
3236                       if (fds[i].revents & G_IO_HUP)
3237                         g_print ("h");
3238                       if (fds[i].revents & G_IO_NVAL)
3239                         g_print ("n");
3240                       g_print ("]");
3241                     }
3242                   i++;
3243                 }
3244               pollrec = pollrec->next;
3245             }
3246           g_print ("\n");
3247
3248           UNLOCK_CONTEXT (context);
3249         }
3250 #endif
3251     } /* if (n_fds || timeout != 0) */
3252 }
3253
3254 /**
3255  * g_main_context_add_poll:
3256  * @context: a #GMainContext (or %NULL for the default context)
3257  * @fd: a #GPollFD structure holding information about a file
3258  *      descriptor to watch.
3259  * @priority: the priority for this file descriptor which should be
3260  *      the same as the priority used for g_source_attach() to ensure that the
3261  *      file descriptor is polled whenever the results may be needed.
3262  * 
3263  * Adds a file descriptor to the set of file descriptors polled for
3264  * this context. This will very seldomly be used directly. Instead
3265  * a typical event source will use g_source_add_poll() instead.
3266  **/
3267 void
3268 g_main_context_add_poll (GMainContext *context,
3269                          GPollFD      *fd,
3270                          gint          priority)
3271 {
3272   if (!context)
3273     context = g_main_context_default ();
3274   
3275   g_return_if_fail (g_atomic_int_get (&context->ref_count) > 0);
3276   g_return_if_fail (fd);
3277
3278   LOCK_CONTEXT (context);
3279   g_main_context_add_poll_unlocked (context, priority, fd);
3280   UNLOCK_CONTEXT (context);
3281 }
3282
3283 /* HOLDS: main_loop_lock */
3284 static void 
3285 g_main_context_add_poll_unlocked (GMainContext *context,
3286                                   gint          priority,
3287                                   GPollFD      *fd)
3288 {
3289   GPollRec *lastrec, *pollrec;
3290   GPollRec *newrec = g_slice_new (GPollRec);
3291
3292   /* This file descriptor may be checked before we ever poll */
3293   fd->revents = 0;
3294   newrec->fd = fd;
3295   newrec->priority = priority;
3296
3297   lastrec = NULL;
3298   pollrec = context->poll_records;
3299   while (pollrec && priority >= pollrec->priority)
3300     {
3301       lastrec = pollrec;
3302       pollrec = pollrec->next;
3303     }
3304   
3305   if (lastrec)
3306     lastrec->next = newrec;
3307   else
3308     context->poll_records = newrec;
3309
3310   newrec->next = pollrec;
3311
3312   context->n_poll_records++;
3313
3314 #ifdef G_THREADS_ENABLED
3315   context->poll_changed = TRUE;
3316
3317   /* Now wake up the main loop if it is waiting in the poll() */
3318   g_main_context_wakeup_unlocked (context);
3319 #endif
3320 }
3321
3322 /**
3323  * g_main_context_remove_poll:
3324  * @context:a #GMainContext 
3325  * @fd: a #GPollFD descriptor previously added with g_main_context_add_poll()
3326  * 
3327  * Removes file descriptor from the set of file descriptors to be
3328  * polled for a particular context.
3329  **/
3330 void
3331 g_main_context_remove_poll (GMainContext *context,
3332                             GPollFD      *fd)
3333 {
3334   if (!context)
3335     context = g_main_context_default ();
3336   
3337   g_return_if_fail (g_atomic_int_get (&context->ref_count) > 0);
3338   g_return_if_fail (fd);
3339
3340   LOCK_CONTEXT (context);
3341   g_main_context_remove_poll_unlocked (context, fd);
3342   UNLOCK_CONTEXT (context);
3343 }
3344
3345 static void
3346 g_main_context_remove_poll_unlocked (GMainContext *context,
3347                                      GPollFD      *fd)
3348 {
3349   GPollRec *pollrec, *lastrec;
3350
3351   lastrec = NULL;
3352   pollrec = context->poll_records;
3353
3354   while (pollrec)
3355     {
3356       if (pollrec->fd == fd)
3357         {
3358           if (lastrec != NULL)
3359             lastrec->next = pollrec->next;
3360           else
3361             context->poll_records = pollrec->next;
3362
3363           g_slice_free (GPollRec, pollrec);
3364
3365           context->n_poll_records--;
3366           break;
3367         }
3368       lastrec = pollrec;
3369       pollrec = pollrec->next;
3370     }
3371
3372 #ifdef G_THREADS_ENABLED
3373   context->poll_changed = TRUE;
3374   
3375   /* Now wake up the main loop if it is waiting in the poll() */
3376   g_main_context_wakeup_unlocked (context);
3377 #endif
3378 }
3379
3380 /**
3381  * g_source_get_current_time:
3382  * @source:  a #GSource
3383  * @timeval: #GTimeVal structure in which to store current time.
3384  * 
3385  * Gets the "current time" to be used when checking 
3386  * this source. The advantage of calling this function over
3387  * calling g_get_current_time() directly is that when 
3388  * checking multiple sources, GLib can cache a single value
3389  * instead of having to repeatedly get the system time.
3390  *
3391  * Deprecated: 2.28: use g_source_get_time() instead
3392  **/
3393 void
3394 g_source_get_current_time (GSource  *source,
3395                            GTimeVal *timeval)
3396 {
3397   GMainContext *context;
3398   
3399   g_return_if_fail (source->context != NULL);
3400  
3401   context = source->context;
3402
3403   LOCK_CONTEXT (context);
3404
3405   if (!context->current_time_is_fresh)
3406     {
3407       g_get_current_time (&context->current_time);
3408       context->current_time_is_fresh = TRUE;
3409     }
3410   
3411   *timeval = context->current_time;
3412   
3413   UNLOCK_CONTEXT (context);
3414 }
3415
3416 /**
3417  * g_source_get_time:
3418  * @source: a #GSource
3419  *
3420  * Gets the time to be used when checking this source. The advantage of
3421  * calling this function over calling g_get_monotonic_time() directly is
3422  * that when checking multiple sources, GLib can cache a single value
3423  * instead of having to repeatedly get the system monotonic time.
3424  *
3425  * The time here is the system monotonic time, if available, or some
3426  * other reasonable alternative otherwise.  See g_get_monotonic_time().
3427  *
3428  * Returns: the monotonic time in microseconds
3429  *
3430  * Since: 2.28
3431  **/
3432 gint64
3433 g_source_get_time (GSource *source)
3434 {
3435   GMainContext *context;
3436   gint64 result;
3437
3438   g_return_val_if_fail (source->context != NULL, 0);
3439
3440   context = source->context;
3441
3442   LOCK_CONTEXT (context);
3443
3444   if (!context->time_is_fresh)
3445     {
3446       context->time = g_get_monotonic_time ();
3447       context->time_is_fresh = TRUE;
3448     }
3449
3450   result = context->time;
3451
3452   UNLOCK_CONTEXT (context);
3453
3454   return result;
3455 }
3456
3457 /**
3458  * g_main_context_set_poll_func:
3459  * @context: a #GMainContext
3460  * @func: the function to call to poll all file descriptors
3461  * 
3462  * Sets the function to use to handle polling of file descriptors. It
3463  * will be used instead of the poll() system call 
3464  * (or GLib's replacement function, which is used where 
3465  * poll() isn't available).
3466  *
3467  * This function could possibly be used to integrate the GLib event
3468  * loop with an external event loop.
3469  **/
3470 void
3471 g_main_context_set_poll_func (GMainContext *context,
3472                               GPollFunc     func)
3473 {
3474   if (!context)
3475     context = g_main_context_default ();
3476   
3477   g_return_if_fail (g_atomic_int_get (&context->ref_count) > 0);
3478
3479   LOCK_CONTEXT (context);
3480   
3481   if (func)
3482     context->poll_func = func;
3483   else
3484     context->poll_func = g_poll;
3485
3486   UNLOCK_CONTEXT (context);
3487 }
3488
3489 /**
3490  * g_main_context_get_poll_func:
3491  * @context: a #GMainContext
3492  * 
3493  * Gets the poll function set by g_main_context_set_poll_func().
3494  * 
3495  * Return value: the poll function
3496  **/
3497 GPollFunc
3498 g_main_context_get_poll_func (GMainContext *context)
3499 {
3500   GPollFunc result;
3501   
3502   if (!context)
3503     context = g_main_context_default ();
3504   
3505   g_return_val_if_fail (g_atomic_int_get (&context->ref_count) > 0, NULL);
3506
3507   LOCK_CONTEXT (context);
3508   result = context->poll_func;
3509   UNLOCK_CONTEXT (context);
3510
3511   return result;
3512 }
3513
3514 /* HOLDS: context's lock */
3515 /* Wake the main loop up from a poll() */
3516 static void
3517 g_main_context_wakeup_unlocked (GMainContext *context)
3518 {
3519 #ifdef G_THREADS_ENABLED
3520   if (g_thread_supported() && context->poll_waiting)
3521     {
3522       context->poll_waiting = FALSE;
3523 #ifndef G_OS_WIN32
3524       write (context->wake_up_pipe[1], "A", 1);
3525 #else
3526       ReleaseSemaphore (context->wake_up_semaphore, 1, NULL);
3527 #endif
3528     }
3529 #endif
3530 }
3531
3532 /**
3533  * g_main_context_wakeup:
3534  * @context: a #GMainContext
3535  * 
3536  * If @context is currently waiting in a poll(), interrupt
3537  * the poll(), and continue the iteration process.
3538  **/
3539 void
3540 g_main_context_wakeup (GMainContext *context)
3541 {
3542   if (!context)
3543     context = g_main_context_default ();
3544   
3545   g_return_if_fail (g_atomic_int_get (&context->ref_count) > 0);
3546
3547   LOCK_CONTEXT (context);
3548   g_main_context_wakeup_unlocked (context);
3549   UNLOCK_CONTEXT (context);
3550 }
3551
3552 /**
3553  * g_main_context_is_owner:
3554  * @context: a #GMainContext
3555  * 
3556  * Determines whether this thread holds the (recursive)
3557  * ownership of this #GMaincontext. This is useful to
3558  * know before waiting on another thread that may be
3559  * blocking to get ownership of @context.
3560  *
3561  * Returns: %TRUE if current thread is owner of @context.
3562  *
3563  * Since: 2.10
3564  **/
3565 gboolean
3566 g_main_context_is_owner (GMainContext *context)
3567 {
3568   gboolean is_owner;
3569
3570   if (!context)
3571     context = g_main_context_default ();
3572
3573 #ifdef G_THREADS_ENABLED
3574   LOCK_CONTEXT (context);
3575   is_owner = context->owner == G_THREAD_SELF;
3576   UNLOCK_CONTEXT (context);
3577 #else
3578   is_owner = TRUE;
3579 #endif
3580
3581   return is_owner;
3582 }
3583
3584 /* Timeouts */
3585
3586 static void
3587 g_timeout_set_expiration (GTimeoutSource *timeout_source,
3588                           gint64          current_time)
3589 {
3590   timeout_source->expiration = current_time + timeout_source->interval * 1000;
3591
3592   if (timeout_source->seconds)
3593     {
3594       static gint timer_perturb = -1;
3595
3596       if (timer_perturb == -1)
3597         {
3598           /*
3599            * we want a per machine/session unique 'random' value; try the dbus
3600            * address first, that has a UUID in it. If there is no dbus, use the
3601            * hostname for hashing.
3602            */
3603           const char *session_bus_address = g_getenv ("DBUS_SESSION_BUS_ADDRESS");
3604           if (!session_bus_address)
3605             session_bus_address = g_getenv ("HOSTNAME");
3606           if (session_bus_address)
3607             timer_perturb = ABS ((gint) g_str_hash (session_bus_address)) % 1000000;
3608           else
3609             timer_perturb = 0;
3610         }
3611
3612       /* We want the microseconds part of the timeout to land on the
3613        * 'timer_perturb' mark, but we need to make sure we don't try to
3614        * set the timeout in the past.  We do this by ensuring that we
3615        * always only *increase* the expiration time by adding a full
3616        * second in the case that the microsecond portion decreases.
3617        */
3618       if (timer_perturb < timeout_source->expiration % 1000000)
3619         timeout_source->expiration += 1000000;
3620
3621       timeout_source->expiration =
3622         ((timeout_source->expiration / 1000000) * 1000000) + timer_perturb;
3623     }
3624 }
3625
3626 static gboolean
3627 g_timeout_prepare (GSource *source,
3628                    gint    *timeout)
3629 {
3630   GTimeoutSource *timeout_source = (GTimeoutSource *) source;
3631   gint64 now = g_source_get_time (source);
3632
3633   if (now < timeout_source->expiration)
3634     {
3635       /* Round up to ensure that we don't try again too early */
3636       *timeout = (timeout_source->expiration - now + 999) / 1000;
3637       return FALSE;
3638     }
3639
3640   *timeout = 0;
3641   return TRUE;
3642 }
3643
3644 static gboolean 
3645 g_timeout_check (GSource *source)
3646 {
3647   GTimeoutSource *timeout_source = (GTimeoutSource *) source;
3648   gint64 now = g_source_get_time (source);
3649
3650   return timeout_source->expiration <= now;
3651 }
3652
3653 static gboolean
3654 g_timeout_dispatch (GSource     *source,
3655                     GSourceFunc  callback,
3656                     gpointer     user_data)
3657 {
3658   GTimeoutSource *timeout_source = (GTimeoutSource *)source;
3659   gboolean again;
3660
3661   if (!callback)
3662     {
3663       g_warning ("Timeout source dispatched without callback\n"
3664                  "You must call g_source_set_callback().");
3665       return FALSE;
3666     }
3667
3668   again = callback (user_data);
3669
3670   if (again)
3671     g_timeout_set_expiration (timeout_source, g_source_get_time (source));
3672
3673   return again;
3674 }
3675
3676 /**
3677  * g_timeout_source_new:
3678  * @interval: the timeout interval in milliseconds.
3679  * 
3680  * Creates a new timeout source.
3681  *
3682  * The source will not initially be associated with any #GMainContext
3683  * and must be added to one with g_source_attach() before it will be
3684  * executed.
3685  * 
3686  * Return value: the newly-created timeout source
3687  **/
3688 GSource *
3689 g_timeout_source_new (guint interval)
3690 {
3691   GSource *source = g_source_new (&g_timeout_funcs, sizeof (GTimeoutSource));
3692   GTimeoutSource *timeout_source = (GTimeoutSource *)source;
3693
3694   timeout_source->interval = interval;
3695   g_timeout_set_expiration (timeout_source, g_get_monotonic_time ());
3696
3697   return source;
3698 }
3699
3700 /**
3701  * g_timeout_source_new_seconds:
3702  * @interval: the timeout interval in seconds
3703  *
3704  * Creates a new timeout source.
3705  *
3706  * The source will not initially be associated with any #GMainContext
3707  * and must be added to one with g_source_attach() before it will be
3708  * executed.
3709  *
3710  * The scheduling granularity/accuracy of this timeout source will be
3711  * in seconds.
3712  *
3713  * Return value: the newly-created timeout source
3714  *
3715  * Since: 2.14  
3716  **/
3717 GSource *
3718 g_timeout_source_new_seconds (guint interval)
3719 {
3720   GSource *source = g_source_new (&g_timeout_funcs, sizeof (GTimeoutSource));
3721   GTimeoutSource *timeout_source = (GTimeoutSource *)source;
3722
3723   timeout_source->interval = 1000 * interval;
3724   timeout_source->seconds = TRUE;
3725
3726   g_timeout_set_expiration (timeout_source, g_get_monotonic_time ());
3727
3728   return source;
3729 }
3730
3731
3732 /**
3733  * g_timeout_add_full:
3734  * @priority: the priority of the timeout source. Typically this will be in
3735  *            the range between #G_PRIORITY_DEFAULT and #G_PRIORITY_HIGH.
3736  * @interval: the time between calls to the function, in milliseconds
3737  *             (1/1000ths of a second)
3738  * @function: function to call
3739  * @data:     data to pass to @function
3740  * @notify:   function to call when the timeout is removed, or %NULL
3741  * 
3742  * Sets a function to be called at regular intervals, with the given
3743  * priority.  The function is called repeatedly until it returns
3744  * %FALSE, at which point the timeout is automatically destroyed and
3745  * the function will not be called again.  The @notify function is
3746  * called when the timeout is destroyed.  The first call to the
3747  * function will be at the end of the first @interval.
3748  *
3749  * Note that timeout functions may be delayed, due to the processing of other
3750  * event sources. Thus they should not be relied on for precise timing.
3751  * After each call to the timeout function, the time of the next
3752  * timeout is recalculated based on the current time and the given interval
3753  * (it does not try to 'catch up' time lost in delays).
3754  *
3755  * This internally creates a main loop source using g_timeout_source_new()
3756  * and attaches it to the main loop context using g_source_attach(). You can
3757  * do these steps manually if you need greater control.
3758  * 
3759  * Return value: the ID (greater than 0) of the event source.
3760  **/
3761 guint
3762 g_timeout_add_full (gint           priority,
3763                     guint          interval,
3764                     GSourceFunc    function,
3765                     gpointer       data,
3766                     GDestroyNotify notify)
3767 {
3768   GSource *source;
3769   guint id;
3770   
3771   g_return_val_if_fail (function != NULL, 0);
3772
3773   source = g_timeout_source_new (interval);
3774
3775   if (priority != G_PRIORITY_DEFAULT)
3776     g_source_set_priority (source, priority);
3777
3778   g_source_set_callback (source, function, data, notify);
3779   id = g_source_attach (source, NULL);
3780   g_source_unref (source);
3781
3782   return id;
3783 }
3784
3785 /**
3786  * g_timeout_add:
3787  * @interval: the time between calls to the function, in milliseconds
3788  *             (1/1000ths of a second)
3789  * @function: function to call
3790  * @data:     data to pass to @function
3791  * 
3792  * Sets a function to be called at regular intervals, with the default
3793  * priority, #G_PRIORITY_DEFAULT.  The function is called repeatedly
3794  * until it returns %FALSE, at which point the timeout is automatically
3795  * destroyed and the function will not be called again.  The first call
3796  * to the function will be at the end of the first @interval.
3797  *
3798  * Note that timeout functions may be delayed, due to the processing of other
3799  * event sources. Thus they should not be relied on for precise timing.
3800  * After each call to the timeout function, the time of the next
3801  * timeout is recalculated based on the current time and the given interval
3802  * (it does not try to 'catch up' time lost in delays).
3803  *
3804  * If you want to have a timer in the "seconds" range and do not care
3805  * about the exact time of the first call of the timer, use the
3806  * g_timeout_add_seconds() function; this function allows for more
3807  * optimizations and more efficient system power usage.
3808  *
3809  * This internally creates a main loop source using g_timeout_source_new()
3810  * and attaches it to the main loop context using g_source_attach(). You can
3811  * do these steps manually if you need greater control.
3812  * 
3813  * Return value: the ID (greater than 0) of the event source.
3814  **/
3815 guint
3816 g_timeout_add (guint32        interval,
3817                GSourceFunc    function,
3818                gpointer       data)
3819 {
3820   return g_timeout_add_full (G_PRIORITY_DEFAULT, 
3821                              interval, function, data, NULL);
3822 }
3823
3824 /**
3825  * g_timeout_add_seconds_full:
3826  * @priority: the priority of the timeout source. Typically this will be in
3827  *            the range between #G_PRIORITY_DEFAULT and #G_PRIORITY_HIGH.
3828  * @interval: the time between calls to the function, in seconds
3829  * @function: function to call
3830  * @data:     data to pass to @function
3831  * @notify:   function to call when the timeout is removed, or %NULL
3832  *
3833  * Sets a function to be called at regular intervals, with @priority.
3834  * The function is called repeatedly until it returns %FALSE, at which
3835  * point the timeout is automatically destroyed and the function will
3836  * not be called again.
3837  *
3838  * Unlike g_timeout_add(), this function operates at whole second granularity.
3839  * The initial starting point of the timer is determined by the implementation
3840  * and the implementation is expected to group multiple timers together so that
3841  * they fire all at the same time.
3842  * To allow this grouping, the @interval to the first timer is rounded
3843  * and can deviate up to one second from the specified interval.
3844  * Subsequent timer iterations will generally run at the specified interval.
3845  *
3846  * Note that timeout functions may be delayed, due to the processing of other
3847  * event sources. Thus they should not be relied on for precise timing.
3848  * After each call to the timeout function, the time of the next
3849  * timeout is recalculated based on the current time and the given @interval
3850  *
3851  * If you want timing more precise than whole seconds, use g_timeout_add()
3852  * instead.
3853  *
3854  * The grouping of timers to fire at the same time results in a more power
3855  * and CPU efficient behavior so if your timer is in multiples of seconds
3856  * and you don't require the first timer exactly one second from now, the
3857  * use of g_timeout_add_seconds() is preferred over g_timeout_add().
3858  *
3859  * This internally creates a main loop source using 
3860  * g_timeout_source_new_seconds() and attaches it to the main loop context 
3861  * using g_source_attach(). You can do these steps manually if you need 
3862  * greater control.
3863  * 
3864  * Return value: the ID (greater than 0) of the event source.
3865  *
3866  * Since: 2.14
3867  **/
3868 guint
3869 g_timeout_add_seconds_full (gint           priority,
3870                             guint32        interval,
3871                             GSourceFunc    function,
3872                             gpointer       data,
3873                             GDestroyNotify notify)
3874 {
3875   GSource *source;
3876   guint id;
3877
3878   g_return_val_if_fail (function != NULL, 0);
3879
3880   source = g_timeout_source_new_seconds (interval);
3881
3882   if (priority != G_PRIORITY_DEFAULT)
3883     g_source_set_priority (source, priority);
3884
3885   g_source_set_callback (source, function, data, notify);
3886   id = g_source_attach (source, NULL);
3887   g_source_unref (source);
3888
3889   return id;
3890 }
3891
3892 /**
3893  * g_timeout_add_seconds:
3894  * @interval: the time between calls to the function, in seconds
3895  * @function: function to call
3896  * @data: data to pass to @function
3897  *
3898  * Sets a function to be called at regular intervals with the default
3899  * priority, #G_PRIORITY_DEFAULT. The function is called repeatedly until
3900  * it returns %FALSE, at which point the timeout is automatically destroyed
3901  * and the function will not be called again.
3902  *
3903  * This internally creates a main loop source using 
3904  * g_timeout_source_new_seconds() and attaches it to the main loop context 
3905  * using g_source_attach(). You can do these steps manually if you need 
3906  * greater control. Also see g_timout_add_seconds_full().
3907  * 
3908  * Return value: the ID (greater than 0) of the event source.
3909  *
3910  * Since: 2.14
3911  **/
3912 guint
3913 g_timeout_add_seconds (guint       interval,
3914                        GSourceFunc function,
3915                        gpointer    data)
3916 {
3917   g_return_val_if_fail (function != NULL, 0);
3918
3919   return g_timeout_add_seconds_full (G_PRIORITY_DEFAULT, interval, function, data, NULL);
3920 }
3921
3922 /* Child watch functions */
3923
3924 #ifdef G_OS_WIN32
3925
3926 static gboolean
3927 g_child_watch_prepare (GSource *source,
3928                        gint    *timeout)
3929 {
3930   *timeout = -1;
3931   return FALSE;
3932 }
3933
3934
3935 static gboolean 
3936 g_child_watch_check (GSource  *source)
3937 {
3938   GChildWatchSource *child_watch_source;
3939   gboolean child_exited;
3940
3941   child_watch_source = (GChildWatchSource *) source;
3942
3943   child_exited = child_watch_source->poll.revents & G_IO_IN;
3944
3945   if (child_exited)
3946     {
3947       DWORD child_status;
3948
3949       /*
3950        * Note: We do _not_ check for the special value of STILL_ACTIVE
3951        * since we know that the process has exited and doing so runs into
3952        * problems if the child process "happens to return STILL_ACTIVE(259)"
3953        * as Microsoft's Platform SDK puts it.
3954        */
3955       if (!GetExitCodeProcess (child_watch_source->pid, &child_status))
3956         {
3957           gchar *emsg = g_win32_error_message (GetLastError ());
3958           g_warning (G_STRLOC ": GetExitCodeProcess() failed: %s", emsg);
3959           g_free (emsg);
3960
3961           child_watch_source->child_status = -1;
3962         }
3963       else
3964         child_watch_source->child_status = child_status;
3965     }
3966
3967   return child_exited;
3968 }
3969
3970 #else /* G_OS_WIN32 */
3971
3972 static gboolean
3973 check_for_child_exited (GSource *source)
3974 {
3975   GChildWatchSource *child_watch_source;
3976   gint count;
3977
3978   /* protect against another SIGCHLD in the middle of this call */
3979   count = child_watch_count;
3980
3981   child_watch_source = (GChildWatchSource *) source;
3982
3983   if (child_watch_source->child_exited)
3984     return TRUE;
3985
3986   if (child_watch_source->count < count)
3987     {
3988       gint child_status;
3989
3990       if (waitpid (child_watch_source->pid, &child_status, WNOHANG) > 0)
3991         {
3992           child_watch_source->child_status = child_status;
3993           child_watch_source->child_exited = TRUE;
3994         }
3995       child_watch_source->count = count;
3996     }
3997
3998   return child_watch_source->child_exited;
3999 }
4000
4001 static gboolean
4002 g_child_watch_prepare (GSource *source,
4003                        gint    *timeout)
4004 {
4005   *timeout = -1;
4006
4007   return check_for_child_exited (source);
4008 }
4009
4010
4011 static gboolean 
4012 g_child_watch_check (GSource  *source)
4013 {
4014   return check_for_child_exited (source);
4015 }
4016
4017 #endif /* G_OS_WIN32 */
4018
4019 static gboolean
4020 g_child_watch_dispatch (GSource    *source, 
4021                         GSourceFunc callback,
4022                         gpointer    user_data)
4023 {
4024   GChildWatchSource *child_watch_source;
4025   GChildWatchFunc child_watch_callback = (GChildWatchFunc) callback;
4026
4027   child_watch_source = (GChildWatchSource *) source;
4028
4029   if (!callback)
4030     {
4031       g_warning ("Child watch source dispatched without callback\n"
4032                  "You must call g_source_set_callback().");
4033       return FALSE;
4034     }
4035
4036   (child_watch_callback) (child_watch_source->pid, child_watch_source->child_status, user_data);
4037
4038   /* We never keep a child watch source around as the child is gone */
4039   return FALSE;
4040 }
4041
4042 #ifndef G_OS_WIN32
4043
4044 static void
4045 g_child_watch_signal_handler (int signum)
4046 {
4047   child_watch_count ++;
4048
4049   if (child_watch_init_state == CHILD_WATCH_INITIALIZED_THREADED)
4050     {
4051       write (child_watch_wake_up_pipe[1], "B", 1);
4052     }
4053   else
4054     {
4055       /* We count on the signal interrupting the poll in the same thread.
4056        */
4057     }
4058 }
4059  
4060 static void
4061 g_child_watch_source_init_single (void)
4062 {
4063   struct sigaction action;
4064
4065   g_assert (! g_thread_supported());
4066   g_assert (child_watch_init_state == CHILD_WATCH_UNINITIALIZED);
4067
4068   child_watch_init_state = CHILD_WATCH_INITIALIZED_SINGLE;
4069
4070   action.sa_handler = g_child_watch_signal_handler;
4071   sigemptyset (&action.sa_mask);
4072   action.sa_flags = SA_NOCLDSTOP;
4073   sigaction (SIGCHLD, &action, NULL);
4074 }
4075
4076 G_GNUC_NORETURN static gpointer
4077 child_watch_helper_thread (gpointer data) 
4078 {
4079   while (1)
4080     {
4081       gchar b[20];
4082       GSList *list;
4083
4084       read (child_watch_wake_up_pipe[0], b, 20);
4085
4086       /* We were woken up.  Wake up all other contexts in all other threads */
4087       G_LOCK (main_context_list);
4088       for (list = main_context_list; list; list = list->next)
4089         {
4090           GMainContext *context;
4091
4092           context = list->data;
4093           if (g_atomic_int_get (&context->ref_count) > 0)
4094             /* Due to racing conditions we can find ref_count == 0, in
4095              * that case, however, the context is still not destroyed
4096              * and no poll can be active, otherwise the ref_count
4097              * wouldn't be 0 */
4098             g_main_context_wakeup (context);
4099         }
4100       G_UNLOCK (main_context_list);
4101     }
4102 }
4103
4104 static void
4105 g_child_watch_source_init_multi_threaded (void)
4106 {
4107   GError *error = NULL;
4108   struct sigaction action;
4109
4110   g_assert (g_thread_supported());
4111
4112   if (pipe (child_watch_wake_up_pipe) < 0)
4113     g_error ("Cannot create wake up pipe: %s\n", g_strerror (errno));
4114   fcntl (child_watch_wake_up_pipe[1], F_SETFL, O_NONBLOCK | fcntl (child_watch_wake_up_pipe[1], F_GETFL));
4115
4116   /* We create a helper thread that polls on the wakeup pipe indefinitely */
4117   /* FIXME: Think this through for races */
4118   if (g_thread_create (child_watch_helper_thread, NULL, FALSE, &error) == NULL)
4119     g_error ("Cannot create a thread to monitor child exit status: %s\n", error->message);
4120   child_watch_init_state = CHILD_WATCH_INITIALIZED_THREADED;
4121  
4122   action.sa_handler = g_child_watch_signal_handler;
4123   sigemptyset (&action.sa_mask);
4124   action.sa_flags = SA_RESTART | SA_NOCLDSTOP;
4125   sigaction (SIGCHLD, &action, NULL);
4126 }
4127
4128 static void
4129 g_child_watch_source_init_promote_single_to_threaded (void)
4130 {
4131   g_child_watch_source_init_multi_threaded ();
4132 }
4133
4134 static void
4135 g_child_watch_source_init (void)
4136 {
4137   if (g_thread_supported())
4138     {
4139       if (child_watch_init_state == CHILD_WATCH_UNINITIALIZED)
4140         g_child_watch_source_init_multi_threaded ();
4141       else if (child_watch_init_state == CHILD_WATCH_INITIALIZED_SINGLE)
4142         g_child_watch_source_init_promote_single_to_threaded ();
4143     }
4144   else
4145     {
4146       if (child_watch_init_state == CHILD_WATCH_UNINITIALIZED)
4147         g_child_watch_source_init_single ();
4148     }
4149 }
4150
4151 #endif /* !G_OS_WIN32 */
4152
4153 /**
4154  * g_child_watch_source_new:
4155  * @pid: process to watch. On POSIX the pid of a child process. On
4156  * Windows a handle for a process (which doesn't have to be a child).
4157  * 
4158  * Creates a new child_watch source.
4159  *
4160  * The source will not initially be associated with any #GMainContext
4161  * and must be added to one with g_source_attach() before it will be
4162  * executed.
4163  * 
4164  * Note that child watch sources can only be used in conjunction with
4165  * <literal>g_spawn...</literal> when the %G_SPAWN_DO_NOT_REAP_CHILD
4166  * flag is used.
4167  *
4168  * Note that on platforms where #GPid must be explicitly closed
4169  * (see g_spawn_close_pid()) @pid must not be closed while the
4170  * source is still active. Typically, you will want to call
4171  * g_spawn_close_pid() in the callback function for the source.
4172  *
4173  * Note further that using g_child_watch_source_new() is not 
4174  * compatible with calling <literal>waitpid(-1)</literal> in 
4175  * the application. Calling waitpid() for individual pids will
4176  * still work fine. 
4177  * 
4178  * Return value: the newly-created child watch source
4179  *
4180  * Since: 2.4
4181  **/
4182 GSource *
4183 g_child_watch_source_new (GPid pid)
4184 {
4185   GSource *source = g_source_new (&g_child_watch_funcs, sizeof (GChildWatchSource));
4186   GChildWatchSource *child_watch_source = (GChildWatchSource *)source;
4187
4188 #ifdef G_OS_WIN32
4189   child_watch_source->poll.fd = (gintptr) pid;
4190   child_watch_source->poll.events = G_IO_IN;
4191
4192   g_source_add_poll (source, &child_watch_source->poll);
4193 #else /* G_OS_WIN32 */
4194   g_child_watch_source_init ();
4195 #endif /* G_OS_WIN32 */
4196
4197   child_watch_source->pid = pid;
4198
4199   return source;
4200 }
4201
4202 /**
4203  * g_child_watch_add_full:
4204  * @priority: the priority of the idle source. Typically this will be in the
4205  *            range between #G_PRIORITY_DEFAULT_IDLE and #G_PRIORITY_HIGH_IDLE.
4206  * @pid:      process to watch. On POSIX the pid of a child process. On
4207  * Windows a handle for a process (which doesn't have to be a child).
4208  * @function: function to call
4209  * @data:     data to pass to @function
4210  * @notify:   function to call when the idle is removed, or %NULL
4211  * 
4212  * Sets a function to be called when the child indicated by @pid 
4213  * exits, at the priority @priority.
4214  *
4215  * If you obtain @pid from g_spawn_async() or g_spawn_async_with_pipes() 
4216  * you will need to pass #G_SPAWN_DO_NOT_REAP_CHILD as flag to 
4217  * the spawn function for the child watching to work.
4218  * 
4219  * Note that on platforms where #GPid must be explicitly closed
4220  * (see g_spawn_close_pid()) @pid must not be closed while the
4221  * source is still active. Typically, you will want to call
4222  * g_spawn_close_pid() in the callback function for the source.
4223  * 
4224  * GLib supports only a single callback per process id.
4225  *
4226  * This internally creates a main loop source using 
4227  * g_child_watch_source_new() and attaches it to the main loop context 
4228  * using g_source_attach(). You can do these steps manually if you 
4229  * need greater control.
4230  *
4231  * Return value: the ID (greater than 0) of the event source.
4232  *
4233  * Since: 2.4
4234  **/
4235 guint
4236 g_child_watch_add_full (gint            priority,
4237                         GPid            pid,
4238                         GChildWatchFunc function,
4239                         gpointer        data,
4240                         GDestroyNotify  notify)
4241 {
4242   GSource *source;
4243   guint id;
4244   
4245   g_return_val_if_fail (function != NULL, 0);
4246
4247   source = g_child_watch_source_new (pid);
4248
4249   if (priority != G_PRIORITY_DEFAULT)
4250     g_source_set_priority (source, priority);
4251
4252   g_source_set_callback (source, (GSourceFunc) function, data, notify);
4253   id = g_source_attach (source, NULL);
4254   g_source_unref (source);
4255
4256   return id;
4257 }
4258
4259 /**
4260  * g_child_watch_add:
4261  * @pid:      process id to watch. On POSIX the pid of a child process. On
4262  * Windows a handle for a process (which doesn't have to be a child).
4263  * @function: function to call
4264  * @data:     data to pass to @function
4265  * 
4266  * Sets a function to be called when the child indicated by @pid 
4267  * exits, at a default priority, #G_PRIORITY_DEFAULT.
4268  * 
4269  * If you obtain @pid from g_spawn_async() or g_spawn_async_with_pipes() 
4270  * you will need to pass #G_SPAWN_DO_NOT_REAP_CHILD as flag to 
4271  * the spawn function for the child watching to work.
4272  * 
4273  * Note that on platforms where #GPid must be explicitly closed
4274  * (see g_spawn_close_pid()) @pid must not be closed while the
4275  * source is still active. Typically, you will want to call
4276  * g_spawn_close_pid() in the callback function for the source.
4277  *
4278  * GLib supports only a single callback per process id.
4279  *
4280  * This internally creates a main loop source using 
4281  * g_child_watch_source_new() and attaches it to the main loop context 
4282  * using g_source_attach(). You can do these steps manually if you 
4283  * need greater control.
4284  *
4285  * Return value: the ID (greater than 0) of the event source.
4286  *
4287  * Since: 2.4
4288  **/
4289 guint 
4290 g_child_watch_add (GPid            pid,
4291                    GChildWatchFunc function,
4292                    gpointer        data)
4293 {
4294   return g_child_watch_add_full (G_PRIORITY_DEFAULT, pid, function, data, NULL);
4295 }
4296
4297
4298 /* Idle functions */
4299
4300 static gboolean 
4301 g_idle_prepare  (GSource  *source,
4302                  gint     *timeout)
4303 {
4304   *timeout = 0;
4305
4306   return TRUE;
4307 }
4308
4309 static gboolean 
4310 g_idle_check    (GSource  *source)
4311 {
4312   return TRUE;
4313 }
4314
4315 static gboolean
4316 g_idle_dispatch (GSource    *source, 
4317                  GSourceFunc callback,
4318                  gpointer    user_data)
4319 {
4320   if (!callback)
4321     {
4322       g_warning ("Idle source dispatched without callback\n"
4323                  "You must call g_source_set_callback().");
4324       return FALSE;
4325     }
4326   
4327   return callback (user_data);
4328 }
4329
4330 /**
4331  * g_idle_source_new:
4332  * 
4333  * Creates a new idle source.
4334  *
4335  * The source will not initially be associated with any #GMainContext
4336  * and must be added to one with g_source_attach() before it will be
4337  * executed. Note that the default priority for idle sources is
4338  * %G_PRIORITY_DEFAULT_IDLE, as compared to other sources which
4339  * have a default priority of %G_PRIORITY_DEFAULT.
4340  * 
4341  * Return value: the newly-created idle source
4342  **/
4343 GSource *
4344 g_idle_source_new (void)
4345 {
4346   GSource *source;
4347
4348   source = g_source_new (&g_idle_funcs, sizeof (GSource));
4349   g_source_set_priority (source, G_PRIORITY_DEFAULT_IDLE);
4350
4351   return source;
4352 }
4353
4354 /**
4355  * g_idle_add_full:
4356  * @priority: the priority of the idle source. Typically this will be in the
4357  *            range between #G_PRIORITY_DEFAULT_IDLE and #G_PRIORITY_HIGH_IDLE.
4358  * @function: function to call
4359  * @data:     data to pass to @function
4360  * @notify:   function to call when the idle is removed, or %NULL
4361  * 
4362  * Adds a function to be called whenever there are no higher priority
4363  * events pending.  If the function returns %FALSE it is automatically
4364  * removed from the list of event sources and will not be called again.
4365  * 
4366  * This internally creates a main loop source using g_idle_source_new()
4367  * and attaches it to the main loop context using g_source_attach(). 
4368  * You can do these steps manually if you need greater control.
4369  * 
4370  * Return value: the ID (greater than 0) of the event source.
4371  **/
4372 guint 
4373 g_idle_add_full (gint           priority,
4374                  GSourceFunc    function,
4375                  gpointer       data,
4376                  GDestroyNotify notify)
4377 {
4378   GSource *source;
4379   guint id;
4380   
4381   g_return_val_if_fail (function != NULL, 0);
4382
4383   source = g_idle_source_new ();
4384
4385   if (priority != G_PRIORITY_DEFAULT_IDLE)
4386     g_source_set_priority (source, priority);
4387
4388   g_source_set_callback (source, function, data, notify);
4389   id = g_source_attach (source, NULL);
4390   g_source_unref (source);
4391
4392   return id;
4393 }
4394
4395 /**
4396  * g_idle_add:
4397  * @function: function to call 
4398  * @data: data to pass to @function.
4399  * 
4400  * Adds a function to be called whenever there are no higher priority
4401  * events pending to the default main loop. The function is given the
4402  * default idle priority, #G_PRIORITY_DEFAULT_IDLE.  If the function
4403  * returns %FALSE it is automatically removed from the list of event
4404  * sources and will not be called again.
4405  * 
4406  * This internally creates a main loop source using g_idle_source_new()
4407  * and attaches it to the main loop context using g_source_attach(). 
4408  * You can do these steps manually if you need greater control.
4409  * 
4410  * Return value: the ID (greater than 0) of the event source.
4411  **/
4412 guint 
4413 g_idle_add (GSourceFunc    function,
4414             gpointer       data)
4415 {
4416   return g_idle_add_full (G_PRIORITY_DEFAULT_IDLE, function, data, NULL);
4417 }
4418
4419 /**
4420  * g_idle_remove_by_data:
4421  * @data: the data for the idle source's callback.
4422  * 
4423  * Removes the idle function with the given data.
4424  * 
4425  * Return value: %TRUE if an idle source was found and removed.
4426  **/
4427 gboolean
4428 g_idle_remove_by_data (gpointer data)
4429 {
4430   return g_source_remove_by_funcs_user_data (&g_idle_funcs, data);
4431 }
4432
4433 /**
4434  * g_main_context_invoke:
4435  * @context: a #GMainContext, or %NULL
4436  * @function: function to call
4437  * @data: data to pass to @function
4438  *
4439  * Invokes a function in such a way that @context is owned during the
4440  * invocation of @function.
4441  *
4442  * If @context is %NULL then the global default main context — as
4443  * returned by g_main_context_default() — is used.
4444  *
4445  * If @context is owned by the current thread, @function is called
4446  * directly.  Otherwise, if @context is the thread-default main context
4447  * of the current thread and g_main_context_acquire() succeeds, then
4448  * @function is called and g_main_context_release() is called
4449  * afterwards.
4450  *
4451  * In any other case, an idle source is created to call @function and
4452  * that source is attached to @context (presumably to be run in another
4453  * thread).  The idle source is attached with #G_PRIORITY_DEFAULT
4454  * priority.  If you want a different priority, use
4455  * g_main_context_invoke_full().
4456  *
4457  * Note that, as with normal idle functions, @function should probably
4458  * return %FALSE.  If it returns %TRUE, it will be continuously run in a
4459  * loop (and may prevent this call from returning).
4460  *
4461  * Since: 2.28
4462  **/
4463 void
4464 g_main_context_invoke (GMainContext *context,
4465                        GSourceFunc   function,
4466                        gpointer      data)
4467 {
4468   g_main_context_invoke_full (context,
4469                               G_PRIORITY_DEFAULT,
4470                               function, data, NULL);
4471 }
4472
4473 /**
4474  * g_main_context_invoke_full:
4475  * @context: a #GMainContext, or %NULL
4476  * @priority: the priority at which to run @function
4477  * @function: function to call
4478  * @data: data to pass to @function
4479  * @notify: a function to call when @data is no longer in use, or %NULL.
4480  *
4481  * Invokes a function in such a way that @context is owned during the
4482  * invocation of @function.
4483  *
4484  * This function is the same as g_main_context_invoke() except that it
4485  * lets you specify the priority incase @function ends up being
4486  * scheduled as an idle and also lets you give a #GDestroyNotify for @data.
4487  *
4488  * @notify should not assume that it is called from any particular
4489  * thread or with any particular context acquired.
4490  *
4491  * Since: 2.28
4492  **/
4493 void
4494 g_main_context_invoke_full (GMainContext   *context,
4495                             gint            priority,
4496                             GSourceFunc     function,
4497                             gpointer        data,
4498                             GDestroyNotify  notify)
4499 {
4500   g_return_if_fail (function != NULL);
4501
4502   if (!context)
4503     context = g_main_context_default ();
4504
4505   if (g_main_context_is_owner (context))
4506     {
4507       while (function (data));
4508       if (notify != NULL)
4509         notify (data);
4510     }
4511
4512   else
4513     {
4514       GMainContext *thread_default;
4515
4516       thread_default = g_main_context_get_thread_default ();
4517
4518       if (!thread_default)
4519         thread_default = g_main_context_default ();
4520
4521       if (thread_default == context && g_main_context_acquire (context))
4522         {
4523           while (function (data));
4524
4525           g_main_context_release (context);
4526
4527           if (notify != NULL)
4528             notify (data);
4529         }
4530       else
4531         {
4532           GSource *source;
4533
4534           source = g_idle_source_new ();
4535           g_source_set_priority (source, priority);
4536           g_source_set_callback (source, function, data, notify);
4537           g_source_attach (source, context);
4538           g_source_unref (source);
4539         }
4540     }
4541 }