diff options
Diffstat (limited to 'glib/glib/gmain.h')
| -rw-r--r-- | glib/glib/gmain.h | 147 |
1 files changed, 136 insertions, 11 deletions
diff --git a/glib/glib/gmain.h b/glib/glib/gmain.h index fadf7fc..c455353 100644 --- a/glib/glib/gmain.h +++ b/glib/glib/gmain.h @@ -17,19 +17,30 @@ * Boston, MA 02111-1307, USA. */ +#ifndef __G_MAIN_H__ +#define __G_MAIN_H__ + #if !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION) #error "Only <glib.h> can be included directly." #endif -#ifndef __G_MAIN_H__ -#define __G_MAIN_H__ - #include <glib/gpoll.h> #include <glib/gslist.h> #include <glib/gthread.h> G_BEGIN_DECLS +typedef enum /*< flags >*/ +{ + G_IO_IN GLIB_SYSDEF_POLLIN, + G_IO_OUT GLIB_SYSDEF_POLLOUT, + G_IO_PRI GLIB_SYSDEF_POLLPRI, + G_IO_ERR GLIB_SYSDEF_POLLERR, + G_IO_HUP GLIB_SYSDEF_POLLHUP, + G_IO_NVAL GLIB_SYSDEF_POLLNVAL +} GIOCondition; + + /** * GMainContext: * @@ -74,12 +85,18 @@ typedef struct _GSourceCallbackFuncs GSourceCallbackFuncs; * results of the poll() call) it should return %TRUE. It can also return * a @timeout_ value which should be the maximum timeout (in milliseconds) * which should be passed to the poll() call. The actual timeout used will - * be -1 if all sources returned -1, or it will be the minimum of all the - * @timeout_ values returned which were >= 0. + * be -1 if all sources returned -1, or it will be the minimum of all + * the @timeout_ values returned which were >= 0. Since 2.36 this may + * be %NULL, in which case the effect is as if the function always returns + * %FALSE with a timeout of -1. If @prepare returns a + * timeout and the source also has a 'ready time' set then the + * nearer of the two will be used. * @check: Called after all the file descriptors are polled. The source * should return %TRUE if it is ready to be dispatched. Note that some * time may have passed since the previous prepare function was called, - * so the source should be checked again here. + * so the source should be checked again here. Since 2.36 this may + * be %NULL, in which case the effect is as if the function always returns + * %FALSE. * @dispatch: Called to dispatch the event source, after it has returned * %TRUE in either its @prepare or its @check function. The @dispatch * function is passed in a callback function and data. The callback @@ -132,18 +149,21 @@ typedef struct _GSourceFuncs GSourceFuncs; * Specifies the type of function passed to g_timeout_add(), * g_timeout_add_full(), g_idle_add(), and g_idle_add_full(). * - * Returns: %FALSE if the source should be removed + * Returns: %FALSE if the source should be removed. #G_SOURCE_CONTINUE and + * #G_SOURCE_REMOVE are more memorable names for the return value. */ typedef gboolean (*GSourceFunc) (gpointer user_data); /** * GChildWatchFunc: * @pid: the process id of the child process - * @status: Status information about the child process, - * see waitpid(2) for more information about this field + * @status: Status information about the child process, encoded + * in a platform-specific manner * @user_data: user data passed to g_child_watch_add() * - * The type of functions to be called when a child exists. + * Prototype of a #GChildWatchSource callback, called when a child + * process has exited. To interpret @status, see the documentation + * for g_spawn_check_exit_status(). */ typedef void (*GChildWatchFunc) (GPid pid, gint status, @@ -154,7 +174,7 @@ struct _GSource gpointer callback_data; GSourceCallbackFuncs *callback_funcs; - GSourceFuncs *source_funcs; + const GSourceFuncs *source_funcs; guint ref_count; GMainContext *context; @@ -282,130 +302,209 @@ struct _GSourceFuncs /* GMainContext: */ +GLIB_AVAILABLE_IN_ALL GMainContext *g_main_context_new (void); +GLIB_AVAILABLE_IN_ALL GMainContext *g_main_context_ref (GMainContext *context); +GLIB_AVAILABLE_IN_ALL void g_main_context_unref (GMainContext *context); +GLIB_AVAILABLE_IN_ALL GMainContext *g_main_context_default (void); +GLIB_AVAILABLE_IN_ALL gboolean g_main_context_iteration (GMainContext *context, gboolean may_block); +GLIB_AVAILABLE_IN_ALL gboolean g_main_context_pending (GMainContext *context); /* For implementation of legacy interfaces */ +GLIB_AVAILABLE_IN_ALL GSource *g_main_context_find_source_by_id (GMainContext *context, guint source_id); +GLIB_AVAILABLE_IN_ALL GSource *g_main_context_find_source_by_user_data (GMainContext *context, gpointer user_data); +GLIB_AVAILABLE_IN_ALL GSource *g_main_context_find_source_by_funcs_user_data (GMainContext *context, GSourceFuncs *funcs, gpointer user_data); /* Low level functions for implementing custom main loops. */ +GLIB_AVAILABLE_IN_ALL void g_main_context_wakeup (GMainContext *context); +GLIB_AVAILABLE_IN_ALL gboolean g_main_context_acquire (GMainContext *context); +GLIB_AVAILABLE_IN_ALL void g_main_context_release (GMainContext *context); +GLIB_AVAILABLE_IN_ALL gboolean g_main_context_is_owner (GMainContext *context); +GLIB_AVAILABLE_IN_ALL gboolean g_main_context_wait (GMainContext *context, GCond *cond, GMutex *mutex); +GLIB_AVAILABLE_IN_ALL gboolean g_main_context_prepare (GMainContext *context, gint *priority); +GLIB_AVAILABLE_IN_ALL gint g_main_context_query (GMainContext *context, gint max_priority, gint *timeout_, GPollFD *fds, gint n_fds); +GLIB_AVAILABLE_IN_ALL gint g_main_context_check (GMainContext *context, gint max_priority, GPollFD *fds, gint n_fds); +GLIB_AVAILABLE_IN_ALL void g_main_context_dispatch (GMainContext *context); +GLIB_AVAILABLE_IN_ALL void g_main_context_set_poll_func (GMainContext *context, GPollFunc func); +GLIB_AVAILABLE_IN_ALL GPollFunc g_main_context_get_poll_func (GMainContext *context); /* Low level functions for use by source implementations */ +GLIB_AVAILABLE_IN_ALL void g_main_context_add_poll (GMainContext *context, GPollFD *fd, gint priority); +GLIB_AVAILABLE_IN_ALL void g_main_context_remove_poll (GMainContext *context, GPollFD *fd); +GLIB_AVAILABLE_IN_ALL gint g_main_depth (void); +GLIB_AVAILABLE_IN_ALL GSource *g_main_current_source (void); /* GMainContexts for other threads */ +GLIB_AVAILABLE_IN_ALL void g_main_context_push_thread_default (GMainContext *context); +GLIB_AVAILABLE_IN_ALL void g_main_context_pop_thread_default (GMainContext *context); +GLIB_AVAILABLE_IN_ALL GMainContext *g_main_context_get_thread_default (void); +GLIB_AVAILABLE_IN_ALL GMainContext *g_main_context_ref_thread_default (void); /* GMainLoop: */ +GLIB_AVAILABLE_IN_ALL GMainLoop *g_main_loop_new (GMainContext *context, gboolean is_running); +GLIB_AVAILABLE_IN_ALL void g_main_loop_run (GMainLoop *loop); +GLIB_AVAILABLE_IN_ALL void g_main_loop_quit (GMainLoop *loop); +GLIB_AVAILABLE_IN_ALL GMainLoop *g_main_loop_ref (GMainLoop *loop); +GLIB_AVAILABLE_IN_ALL void g_main_loop_unref (GMainLoop *loop); +GLIB_AVAILABLE_IN_ALL gboolean g_main_loop_is_running (GMainLoop *loop); +GLIB_AVAILABLE_IN_ALL GMainContext *g_main_loop_get_context (GMainLoop *loop); /* GSource: */ +GLIB_AVAILABLE_IN_ALL GSource *g_source_new (GSourceFuncs *source_funcs, guint struct_size); +GLIB_AVAILABLE_IN_ALL GSource *g_source_ref (GSource *source); +GLIB_AVAILABLE_IN_ALL void g_source_unref (GSource *source); +GLIB_AVAILABLE_IN_ALL guint g_source_attach (GSource *source, GMainContext *context); +GLIB_AVAILABLE_IN_ALL void g_source_destroy (GSource *source); +GLIB_AVAILABLE_IN_ALL void g_source_set_priority (GSource *source, gint priority); +GLIB_AVAILABLE_IN_ALL gint g_source_get_priority (GSource *source); +GLIB_AVAILABLE_IN_ALL void g_source_set_can_recurse (GSource *source, gboolean can_recurse); +GLIB_AVAILABLE_IN_ALL gboolean g_source_get_can_recurse (GSource *source); +GLIB_AVAILABLE_IN_ALL guint g_source_get_id (GSource *source); +GLIB_AVAILABLE_IN_ALL GMainContext *g_source_get_context (GSource *source); +GLIB_AVAILABLE_IN_ALL void g_source_set_callback (GSource *source, GSourceFunc func, gpointer data, GDestroyNotify notify); +GLIB_AVAILABLE_IN_ALL void g_source_set_funcs (GSource *source, GSourceFuncs *funcs); +GLIB_AVAILABLE_IN_ALL gboolean g_source_is_destroyed (GSource *source); +GLIB_AVAILABLE_IN_ALL void g_source_set_name (GSource *source, const char *name); +GLIB_AVAILABLE_IN_ALL const char * g_source_get_name (GSource *source); +GLIB_AVAILABLE_IN_ALL void g_source_set_name_by_id (guint tag, const char *name); +GLIB_AVAILABLE_IN_2_36 +void g_source_set_ready_time (GSource *source, + gint64 ready_time); +GLIB_AVAILABLE_IN_2_36 +gint64 g_source_get_ready_time (GSource *source); + +#ifdef G_OS_UNIX +GLIB_AVAILABLE_IN_2_36 +gpointer g_source_add_unix_fd (GSource *source, + gint fd, + GIOCondition events); +GLIB_AVAILABLE_IN_2_36 +void g_source_modify_unix_fd (GSource *source, + gpointer tag, + GIOCondition new_events); +GLIB_AVAILABLE_IN_2_36 +void g_source_remove_unix_fd (GSource *source, + gpointer tag); +GLIB_AVAILABLE_IN_2_36 +GIOCondition g_source_query_unix_fd (GSource *source, + gpointer tag); +#endif /* Used to implement g_source_connect_closure and internally*/ +GLIB_AVAILABLE_IN_ALL void g_source_set_callback_indirect (GSource *source, gpointer callback_data, GSourceCallbackFuncs *callback_funcs); +GLIB_AVAILABLE_IN_ALL void g_source_add_poll (GSource *source, GPollFD *fd); +GLIB_AVAILABLE_IN_ALL void g_source_remove_poll (GSource *source, GPollFD *fd); +GLIB_AVAILABLE_IN_ALL void g_source_add_child_source (GSource *source, GSource *child_source); +GLIB_AVAILABLE_IN_ALL void g_source_remove_child_source (GSource *source, GSource *child_source); @@ -413,6 +512,7 @@ GLIB_DEPRECATED_IN_2_28_FOR(g_source_get_time) void g_source_get_current_time (GSource *source, GTimeVal *timeval); +GLIB_AVAILABLE_IN_ALL gint64 g_source_get_time (GSource *source); /* void g_source_connect_closure (GSource *source, @@ -421,62 +521,83 @@ gint64 g_source_get_time (GSource *source); /* Specific source types */ +GLIB_AVAILABLE_IN_ALL GSource *g_idle_source_new (void); +GLIB_AVAILABLE_IN_ALL GSource *g_child_watch_source_new (GPid pid); +GLIB_AVAILABLE_IN_ALL GSource *g_timeout_source_new (guint interval); +GLIB_AVAILABLE_IN_ALL GSource *g_timeout_source_new_seconds (guint interval); /* Miscellaneous functions */ +GLIB_AVAILABLE_IN_ALL void g_get_current_time (GTimeVal *result); +GLIB_AVAILABLE_IN_ALL gint64 g_get_monotonic_time (void); +GLIB_AVAILABLE_IN_ALL gint64 g_get_real_time (void); /* Source manipulation by ID */ +GLIB_AVAILABLE_IN_ALL gboolean g_source_remove (guint tag); +GLIB_AVAILABLE_IN_ALL gboolean g_source_remove_by_user_data (gpointer user_data); +GLIB_AVAILABLE_IN_ALL gboolean g_source_remove_by_funcs_user_data (GSourceFuncs *funcs, gpointer user_data); /* Idles, child watchers and timeouts */ +GLIB_AVAILABLE_IN_ALL guint g_timeout_add_full (gint priority, guint interval, GSourceFunc function, gpointer data, GDestroyNotify notify); +GLIB_AVAILABLE_IN_ALL guint g_timeout_add (guint interval, GSourceFunc function, gpointer data); +GLIB_AVAILABLE_IN_ALL guint g_timeout_add_seconds_full (gint priority, guint interval, GSourceFunc function, gpointer data, GDestroyNotify notify); +GLIB_AVAILABLE_IN_ALL guint g_timeout_add_seconds (guint interval, GSourceFunc function, gpointer data); +GLIB_AVAILABLE_IN_ALL guint g_child_watch_add_full (gint priority, GPid pid, GChildWatchFunc function, gpointer data, GDestroyNotify notify); +GLIB_AVAILABLE_IN_ALL guint g_child_watch_add (GPid pid, GChildWatchFunc function, gpointer data); +GLIB_AVAILABLE_IN_ALL guint g_idle_add (GSourceFunc function, gpointer data); +GLIB_AVAILABLE_IN_ALL guint g_idle_add_full (gint priority, GSourceFunc function, gpointer data, GDestroyNotify notify); +GLIB_AVAILABLE_IN_ALL gboolean g_idle_remove_by_data (gpointer data); +GLIB_AVAILABLE_IN_ALL void g_main_context_invoke_full (GMainContext *context, gint priority, GSourceFunc function, gpointer data, GDestroyNotify notify); +GLIB_AVAILABLE_IN_ALL void g_main_context_invoke (GMainContext *context, GSourceFunc function, gpointer data); @@ -485,6 +606,10 @@ void g_main_context_invoke (GMainContext *context, GLIB_VAR GSourceFuncs g_timeout_funcs; GLIB_VAR GSourceFuncs g_child_watch_funcs; GLIB_VAR GSourceFuncs g_idle_funcs; +#ifdef G_OS_UNIX +GLIB_VAR GSourceFuncs g_unix_signal_funcs; +GLIB_VAR GSourceFuncs g_unix_fd_source_funcs; +#endif G_END_DECLS |