1 /* gmain.h - the GLib Main loop
2 * Copyright (C) 1998-2000 Red Hat, Inc.
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Library General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Library General Public License for more details.
14 * You should have received a copy of the GNU Library General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
23 #include <glib/gslist.h>
24 #include <glib/gthread.h>
28 typedef struct _GMainContext GMainContext; /* Opaque */
29 typedef struct _GMainLoop GMainLoop; /* Opaque */
30 typedef struct _GSource GSource;
31 typedef struct _GSourceCallbackFuncs GSourceCallbackFuncs;
32 typedef struct _GSourceFuncs GSourceFuncs;
34 typedef gboolean (*GSourceFunc) (gpointer data);
35 typedef void (*GChildWatchFunc) (GPid pid,
41 gpointer callback_data;
42 GSourceCallbackFuncs *callback_funcs;
44 GSourceFuncs *source_funcs;
47 GMainContext *context;
62 struct _GSourceCallbackFuncs
64 void (*ref) (gpointer cb_data);
65 void (*unref) (gpointer cb_data);
66 void (*get) (gpointer cb_data,
72 typedef void (*GSourceDummyMarshal) (void);
76 gboolean (*prepare) (GSource *source,
78 gboolean (*check) (GSource *source);
79 gboolean (*dispatch) (GSource *source,
82 void (*finalize) (GSource *source); /* Can be NULL */
84 /* For use by g_source_set_closure */
85 GSourceFunc closure_callback;
86 GSourceDummyMarshal closure_marshal; /* Really is of type GClosureMarshal */
89 /* Any definitions using GPollFD or GPollFunc are primarily
90 * for Unix and not guaranteed to be the compatible on all
91 * operating systems on which GLib runs. Right now, the
92 * GLib does use these functions on Win32 as well, but interprets
93 * them in a fairly different way than on Unix. If you use
94 * these definitions, you are should be prepared to recode
95 * for different operating systems.
98 * On Win32, the fd in a GPollFD should be Win32 HANDLE (*not* a file
99 * descriptor as provided by the C runtime) that can be used by
100 * MsgWaitForMultipleObjects. This does *not* include file handles
101 * from CreateFile, SOCKETs, nor pipe handles. (But you can use
102 * WSAEventSelect to signal events when a SOCKET is readable).
104 * On Win32, fd can also be the special value G_WIN32_MSG_HANDLE to
105 * indicate polling for messages.
107 * But note that G_WIN32_MSG_HANDLE GPollFDs should not be used by GDK
108 * (GTK) programs, as GDK itself wants to read messages and convert them
111 * So, unless you really know what you are doing, it's best not to try
112 * to use the main loop polling stuff for your own needs on
113 * Win32. It's really only written for the GIMP's needs so
116 typedef struct _GPollFD GPollFD;
117 typedef gint (*GPollFunc) (GPollFD *ufds,
128 /* Standard priorities */
130 #define G_PRIORITY_HIGH -100
131 #define G_PRIORITY_DEFAULT 0
132 #define G_PRIORITY_HIGH_IDLE 100
133 #define G_PRIORITY_DEFAULT_IDLE 200
134 #define G_PRIORITY_LOW 300
138 GMainContext *g_main_context_new (void);
139 GMainContext *g_main_context_ref (GMainContext *context);
140 void g_main_context_unref (GMainContext *context);
141 GMainContext *g_main_context_default (void);
143 gboolean g_main_context_iteration (GMainContext *context,
145 gboolean g_main_context_pending (GMainContext *context);
147 /* For implementation of legacy interfaces
149 GSource *g_main_context_find_source_by_id (GMainContext *context,
151 GSource *g_main_context_find_source_by_user_data (GMainContext *context,
153 GSource *g_main_context_find_source_by_funcs_user_data (GMainContext *context,
157 /* Low level functions for implementing custom main loops.
159 void g_main_context_wakeup (GMainContext *context);
160 gboolean g_main_context_acquire (GMainContext *context);
161 void g_main_context_release (GMainContext *context);
162 gboolean g_main_context_wait (GMainContext *context,
166 gboolean g_main_context_prepare (GMainContext *context,
168 gint g_main_context_query (GMainContext *context,
173 gint g_main_context_check (GMainContext *context,
177 void g_main_context_dispatch (GMainContext *context);
179 void g_main_context_set_poll_func (GMainContext *context,
181 GPollFunc g_main_context_get_poll_func (GMainContext *context);
183 /* Low level functions for use by source implementations
185 void g_main_context_add_poll (GMainContext *context,
188 void g_main_context_remove_poll (GMainContext *context,
191 int g_main_depth (void);
195 GMainLoop *g_main_loop_new (GMainContext *context,
196 gboolean is_running);
197 void g_main_loop_run (GMainLoop *loop);
198 void g_main_loop_quit (GMainLoop *loop);
199 GMainLoop *g_main_loop_ref (GMainLoop *loop);
200 void g_main_loop_unref (GMainLoop *loop);
201 gboolean g_main_loop_is_running (GMainLoop *loop);
202 GMainContext *g_main_loop_get_context (GMainLoop *loop);
206 GSource *g_source_new (GSourceFuncs *source_funcs,
208 GSource *g_source_ref (GSource *source);
209 void g_source_unref (GSource *source);
211 guint g_source_attach (GSource *source,
212 GMainContext *context);
213 void g_source_destroy (GSource *source);
215 void g_source_set_priority (GSource *source,
217 gint g_source_get_priority (GSource *source);
218 void g_source_set_can_recurse (GSource *source,
219 gboolean can_recurse);
220 gboolean g_source_get_can_recurse (GSource *source);
221 guint g_source_get_id (GSource *source);
223 GMainContext *g_source_get_context (GSource *source);
225 void g_source_set_callback (GSource *source,
228 GDestroyNotify notify);
231 /* Used to implement g_source_connect_closure and internally*/
232 void g_source_set_callback_indirect (GSource *source,
233 gpointer callback_data,
234 GSourceCallbackFuncs *callback_funcs);
236 void g_source_add_poll (GSource *source,
238 void g_source_remove_poll (GSource *source,
241 void g_source_get_current_time (GSource *source,
244 /* void g_source_connect_closure (GSource *source,
248 /* Specific source types
250 GSource *g_idle_source_new (void);
251 GSource *g_child_watch_source_new (GPid pid);
252 GSource *g_timeout_source_new (guint interval);
254 /* Miscellaneous functions
256 void g_get_current_time (GTimeVal *result);
258 /* ============== Compat main loop stuff ================== */
260 #ifndef G_DISABLE_DEPRECATED
262 /* Legacy names for GMainLoop functions
264 #define g_main_new(is_running) g_main_loop_new (NULL, is_running);
265 #define g_main_run(loop) g_main_loop_run(loop)
266 #define g_main_quit(loop) g_main_loop_quit(loop)
267 #define g_main_destroy(loop) g_main_loop_unref(loop)
268 #define g_main_is_running(loop) g_main_loop_is_running(loop)
270 /* Functions to manipulate the default main loop
273 #define g_main_iteration(may_block) g_main_context_iteration (NULL, may_block)
274 #define g_main_pending() g_main_context_pending (NULL)
276 #define g_main_set_poll_func(func) g_main_context_set_poll_func (NULL, func)
278 #endif /* G_DISABLE_DEPRECATED */
280 /* Source manipulation by ID */
281 gboolean g_source_remove (guint tag);
282 gboolean g_source_remove_by_user_data (gpointer user_data);
283 gboolean g_source_remove_by_funcs_user_data (GSourceFuncs *funcs,
286 /* Idles, child watchers and timeouts */
287 guint g_timeout_add_full (gint priority,
289 GSourceFunc function,
291 GDestroyNotify notify);
292 guint g_timeout_add (guint interval,
293 GSourceFunc function,
295 guint g_child_watch_add_full (gint priority,
297 GChildWatchFunc function,
299 GDestroyNotify notify);
300 guint g_child_watch_add (GPid pid,
301 GChildWatchFunc function,
303 guint g_idle_add (GSourceFunc function,
305 guint g_idle_add_full (gint priority,
306 GSourceFunc function,
308 GDestroyNotify notify);
309 gboolean g_idle_remove_by_data (gpointer data);
311 /* Hook for GClosure / GSource integration. Don't touch */
312 GLIB_VAR GSourceFuncs g_timeout_funcs;
313 GLIB_VAR GSourceFuncs g_child_watch_funcs;
314 GLIB_VAR GSourceFuncs g_idle_funcs;
318 #endif /* __G_MAIN_H__ */