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.
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
;
57 struct _GSourceCallbackFuncs
59 void (*ref
) (gpointer cb_data
);
60 void (*unref
) (gpointer cb_data
);
61 void (*get
) (gpointer cb_data
,
68 gboolean (*prepare
) (GSource
*source
,
70 gboolean (*check
) (GSource
*source
);
71 gboolean (*dispatch
) (GSource
*source
,
74 void (*destroy
) (GSource
*source
); /* Can be NULL */
77 /* Any definitions using GPollFD or GPollFunc are primarily
78 * for Unix and not guaranteed to be the compatible on all
79 * operating systems on which GLib runs. Right now, the
80 * GLib does use these functions on Win32 as well, but interprets
81 * them in a fairly different way than on Unix. If you use
82 * these definitions, you are should be prepared to recode
83 * for different operating systems.
86 * On Win32, the fd in a GPollFD should be Win32 HANDLE (*not* a file
87 * descriptor as provided by the C runtime) that can be used by
88 * MsgWaitForMultipleObjects. This does *not* include file handles
89 * from CreateFile, SOCKETs, nor pipe handles. (But you can use
90 * WSAEventSelect to signal events when a SOCKET is readable).
92 * On Win32, fd can also be the special value G_WIN32_MSG_HANDLE to
93 * indicate polling for messages. These message queue GPollFDs should
94 * be added with the g_main_poll_win32_msg_add function.
96 * But note that G_WIN32_MSG_HANDLE GPollFDs should not be used by GDK
97 * (GTK) programs, as GDK itself wants to read messages and convert them
100 * So, unless you really know what you are doing, it's best not to try
101 * to use the main loop polling stuff for your own needs on
102 * Win32. It's really only written for the GIMP's needs so
105 typedef struct _GPollFD GPollFD
;
106 typedef gint (*GPollFunc
) (GPollFD
*ufds
,
117 /* Standard priorities */
119 #define G_PRIORITY_HIGH -100
120 #define G_PRIORITY_DEFAULT 0
121 #define G_PRIORITY_HIGH_IDLE 100
122 #define G_PRIORITY_DEFAULT_IDLE 200
123 #define G_PRIORITY_LOW 300
127 GMainContext
*g_main_context_get (GThread
*thread
);
128 GMainContext
*g_main_context_default (void);
130 gboolean
g_main_context_iteration (GMainContext
*context
,
132 gboolean
g_main_context_pending (GMainContext
*context
);
134 /* For implementation of legacy interfaces
136 GSource
*g_main_context_find_source_by_id (GMainContext
*context
,
138 GSource
*g_main_context_find_source_by_user_data (GMainContext
*context
,
140 GSource
*g_main_context_find_source_by_funcs_user_data (GMainContext
*context
,
144 /* Low level functions for implementing custom main loops.
146 gboolean
g_main_context_prepare (GMainContext
*context
,
148 gint
g_main_context_query (GMainContext
*context
,
153 gint
g_main_context_check (GMainContext
*context
,
157 void g_main_context_dispatch (GMainContext
*context
);
159 void g_main_context_set_poll_func (GMainContext
*context
,
161 GPollFunc
g_main_context_get_poll_func (GMainContext
*context
);
163 /* Low level functions for use by source implementations
165 void g_main_context_add_poll (GMainContext
*context
,
168 void g_main_context_remove_poll (GMainContext
*context
,
173 GMainLoop
*g_main_loop_new (GMainContext
*context
,
174 gboolean is_running
);
175 void g_main_loop_run (GMainLoop
*loop
);
176 void g_main_loop_quit (GMainLoop
*loop
);
177 GMainLoop
*g_main_loop_ref (GMainLoop
*loop
);
178 void g_main_loop_unref (GMainLoop
*loop
);
179 gboolean
g_main_loop_is_running (GMainLoop
*loop
);
183 GSource
*g_source_new (GSourceFuncs
*source_funcs
,
185 GSource
*g_source_ref (GSource
*source
);
186 void g_source_unref (GSource
*source
);
188 guint
g_source_attach (GSource
*source
,
189 GMainContext
*context
);
190 void g_source_destroy (GSource
*source
);
192 void g_source_set_priority (GSource
*source
,
194 gint
g_source_get_priority (GSource
*source
);
195 void g_source_set_can_recurse (GSource
*source
,
196 gboolean can_recurse
);
197 gboolean
g_source_get_can_recurse (GSource
*source
);
198 guint
g_source_get_id (GSource
*source
);
200 GMainContext
*g_source_get_context (GSource
*source
);
202 void g_source_set_callback (GSource
*source
,
205 GDestroyNotify notify
);
208 /* Used to implement g_source_connect_closure and internally*/
209 void g_source_set_callback_indirect (GSource
*source
,
210 gpointer callback_data
,
211 GSourceCallbackFuncs
*callback_funcs
);
213 void g_source_add_poll (GSource
*source
,
215 void g_source_remove_poll (GSource
*source
,
218 void g_source_get_current_time (GSource
*source
,
221 /* void g_source_connect_closure (GSource *source,
225 /* Specific source types
227 GSource
*g_idle_source_new (void);
228 GSource
*g_timeout_source_new (guint interval
);
230 /* Miscellaneous functions
232 void g_get_current_time (GTimeVal
*result
);
234 /* ============== Compat main loop stuff ================== */
236 #ifndef G_DISABLE_DEPRECATED
238 /* Legacy names for GMainLoop functions
240 #define g_main_new(is_running) g_main_loop_new (NULL, is_running);
241 #define g_main_run(loop) g_main_loop_run(loop)
242 #define g_main_quit(loop) g_main_loop_quit(loop)
243 #define g_main_destroy(loop) g_main_loop_unref(loop)
244 #define g_main_is_running(loop) g_main_loop_is_running(loop)
246 /* Functions to manipulate the default main loop
249 #define g_main_iteration(may_block) g_main_context_iteration (NULL, may_block)
250 #define g_main_pending() g_main_context_pending (NULL)
252 #define g_main_set_poll_func(func) g_main_context_set_poll_func (NULL, func)
254 #endif /* G_DISABLE_DEPRECATED */
256 /* Source manipulation by ID */
257 gboolean
g_source_remove (guint tag
);
258 gboolean
g_source_remove_by_user_data (gpointer user_data
);
259 gboolean
g_source_remove_by_funcs_user_data (GSourceFuncs
*funcs
,
262 /* Idles and timeouts */
263 guint
g_timeout_add_full (gint priority
,
265 GSourceFunc function
,
267 GDestroyNotify notify
);
268 guint
g_timeout_add (guint interval
,
269 GSourceFunc function
,
271 guint
g_idle_add (GSourceFunc function
,
273 guint
g_idle_add_full (gint priority
,
274 GSourceFunc function
,
276 GDestroyNotify notify
);
277 gboolean
g_idle_remove_by_data (gpointer data
);
281 /* This is used to add polling for Windows messages. GDK (GTK+) programs
282 * should *not* use this.
284 void g_main_poll_win32_msg_add (gint priority
,
287 #endif /* G_OS_WIN32 */
291 #endif /* __G_MAIN_H__ */