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
);
39 gpointer callback_data
;
40 GSourceCallbackFuncs
*callback_funcs
;
42 GSourceFuncs
*source_funcs
;
45 GMainContext
*context
;
60 struct _GSourceCallbackFuncs
62 void (*ref
) (gpointer cb_data
);
63 void (*unref
) (gpointer cb_data
);
64 void (*get
) (gpointer cb_data
,
70 typedef void (*GSourceDummyMarshal
) (void);
74 gboolean (*prepare
) (GSource
*source
,
76 gboolean (*check
) (GSource
*source
);
77 gboolean (*dispatch
) (GSource
*source
,
80 void (*finalize
) (GSource
*source
); /* Can be NULL */
82 /* For use by g_source_set_closure */
83 GSourceFunc closure_callback
;
84 GSourceDummyMarshal closure_marshal
; /* Really is of type GClosureMarshal */
87 /* Any definitions using GPollFD or GPollFunc are primarily
88 * for Unix and not guaranteed to be the compatible on all
89 * operating systems on which GLib runs. Right now, the
90 * GLib does use these functions on Win32 as well, but interprets
91 * them in a fairly different way than on Unix. If you use
92 * these definitions, you are should be prepared to recode
93 * for different operating systems.
96 * On Win32, the fd in a GPollFD should be Win32 HANDLE (*not* a file
97 * descriptor as provided by the C runtime) that can be used by
98 * MsgWaitForMultipleObjects. This does *not* include file handles
99 * from CreateFile, SOCKETs, nor pipe handles. (But you can use
100 * WSAEventSelect to signal events when a SOCKET is readable).
102 * On Win32, fd can also be the special value G_WIN32_MSG_HANDLE to
103 * indicate polling for messages.
105 * But note that G_WIN32_MSG_HANDLE GPollFDs should not be used by GDK
106 * (GTK) programs, as GDK itself wants to read messages and convert them
109 * So, unless you really know what you are doing, it's best not to try
110 * to use the main loop polling stuff for your own needs on
111 * Win32. It's really only written for the GIMP's needs so
114 typedef struct _GPollFD GPollFD
;
115 typedef gint (*GPollFunc
) (GPollFD
*ufds
,
126 /* Standard priorities */
128 #define G_PRIORITY_HIGH -100
129 #define G_PRIORITY_DEFAULT 0
130 #define G_PRIORITY_HIGH_IDLE 100
131 #define G_PRIORITY_DEFAULT_IDLE 200
132 #define G_PRIORITY_LOW 300
136 GMainContext
*g_main_context_new (void);
137 void g_main_context_ref (GMainContext
*context
);
138 void g_main_context_unref (GMainContext
*context
);
139 GMainContext
*g_main_context_default (void);
141 gboolean
g_main_context_iteration (GMainContext
*context
,
143 gboolean
g_main_context_pending (GMainContext
*context
);
145 /* For implementation of legacy interfaces
147 GSource
*g_main_context_find_source_by_id (GMainContext
*context
,
149 GSource
*g_main_context_find_source_by_user_data (GMainContext
*context
,
151 GSource
*g_main_context_find_source_by_funcs_user_data (GMainContext
*context
,
155 /* Low level functions for implementing custom main loops.
157 void g_main_context_wakeup (GMainContext
*context
);
158 gboolean
g_main_context_acquire (GMainContext
*context
);
159 void g_main_context_release (GMainContext
*context
);
160 gboolean
g_main_context_wait (GMainContext
*context
,
164 gboolean
g_main_context_prepare (GMainContext
*context
,
166 gint
g_main_context_query (GMainContext
*context
,
171 gint
g_main_context_check (GMainContext
*context
,
175 void g_main_context_dispatch (GMainContext
*context
);
177 void g_main_context_set_poll_func (GMainContext
*context
,
179 GPollFunc
g_main_context_get_poll_func (GMainContext
*context
);
181 /* Low level functions for use by source implementations
183 void g_main_context_add_poll (GMainContext
*context
,
186 void g_main_context_remove_poll (GMainContext
*context
,
191 GMainLoop
*g_main_loop_new (GMainContext
*context
,
192 gboolean is_running
);
193 void g_main_loop_run (GMainLoop
*loop
);
194 void g_main_loop_quit (GMainLoop
*loop
);
195 GMainLoop
*g_main_loop_ref (GMainLoop
*loop
);
196 void g_main_loop_unref (GMainLoop
*loop
);
197 gboolean
g_main_loop_is_running (GMainLoop
*loop
);
198 GMainContext
*g_main_loop_get_context (GMainLoop
*loop
);
202 GSource
*g_source_new (GSourceFuncs
*source_funcs
,
204 GSource
*g_source_ref (GSource
*source
);
205 void g_source_unref (GSource
*source
);
207 guint
g_source_attach (GSource
*source
,
208 GMainContext
*context
);
209 void g_source_destroy (GSource
*source
);
211 void g_source_set_priority (GSource
*source
,
213 gint
g_source_get_priority (GSource
*source
);
214 void g_source_set_can_recurse (GSource
*source
,
215 gboolean can_recurse
);
216 gboolean
g_source_get_can_recurse (GSource
*source
);
217 guint
g_source_get_id (GSource
*source
);
219 GMainContext
*g_source_get_context (GSource
*source
);
221 void g_source_set_callback (GSource
*source
,
224 GDestroyNotify notify
);
227 /* Used to implement g_source_connect_closure and internally*/
228 void g_source_set_callback_indirect (GSource
*source
,
229 gpointer callback_data
,
230 GSourceCallbackFuncs
*callback_funcs
);
232 void g_source_add_poll (GSource
*source
,
234 void g_source_remove_poll (GSource
*source
,
237 void g_source_get_current_time (GSource
*source
,
240 /* void g_source_connect_closure (GSource *source,
244 /* Specific source types
246 GSource
*g_idle_source_new (void);
247 GSource
*g_timeout_source_new (guint interval
);
249 /* Miscellaneous functions
251 void g_get_current_time (GTimeVal
*result
);
253 /* ============== Compat main loop stuff ================== */
255 #ifndef G_DISABLE_DEPRECATED
257 /* Legacy names for GMainLoop functions
259 #define g_main_new(is_running) g_main_loop_new (NULL, is_running);
260 #define g_main_run(loop) g_main_loop_run(loop)
261 #define g_main_quit(loop) g_main_loop_quit(loop)
262 #define g_main_destroy(loop) g_main_loop_unref(loop)
263 #define g_main_is_running(loop) g_main_loop_is_running(loop)
265 /* Functions to manipulate the default main loop
268 #define g_main_iteration(may_block) g_main_context_iteration (NULL, may_block)
269 #define g_main_pending() g_main_context_pending (NULL)
271 #define g_main_set_poll_func(func) g_main_context_set_poll_func (NULL, func)
273 #endif /* G_DISABLE_DEPRECATED */
275 /* Source manipulation by ID */
276 gboolean
g_source_remove (guint tag
);
277 gboolean
g_source_remove_by_user_data (gpointer user_data
);
278 gboolean
g_source_remove_by_funcs_user_data (GSourceFuncs
*funcs
,
281 /* Idles and timeouts */
282 guint
g_timeout_add_full (gint priority
,
284 GSourceFunc function
,
286 GDestroyNotify notify
);
287 guint
g_timeout_add (guint interval
,
288 GSourceFunc function
,
290 guint
g_idle_add (GSourceFunc function
,
292 guint
g_idle_add_full (gint priority
,
293 GSourceFunc function
,
295 GDestroyNotify notify
);
296 gboolean
g_idle_remove_by_data (gpointer data
);
298 /* Hook for GClosure / GSource integration. Don't touch */
299 GLIB_VAR GSourceFuncs g_timeout_funcs
;
300 GLIB_VAR GSourceFuncs g_idle_funcs
;
304 #endif /* __G_MAIN_H__ */