williamr@2: /* gmain.h - the GLib Main loop williamr@2: * Copyright (C) 1998-2000 Red Hat, Inc. williamr@2: * Portions copyright (c) 2006 Nokia Corporation. All rights reserved. williamr@2: * williamr@2: * This library is free software; you can redistribute it and/or williamr@2: * modify it under the terms of the GNU Library General Public williamr@2: * License as published by the Free Software Foundation; either williamr@2: * version 2 of the License, or (at your option) any later version. williamr@2: * williamr@2: * This library is distributed in the hope that it will be useful, williamr@2: * but WITHOUT ANY WARRANTY; without even the implied warranty of williamr@2: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU williamr@2: * Library General Public License for more details. williamr@2: * williamr@2: * You should have received a copy of the GNU Library General Public williamr@2: * License along with this library; if not, write to the williamr@2: * Free Software Foundation, Inc., 59 Temple Place - Suite 330, williamr@2: * Boston, MA 02111-1307, USA. williamr@2: */ williamr@2: williamr@2: #ifndef __G_MAIN_H__ williamr@2: #define __G_MAIN_H__ williamr@2: williamr@2: #include <_ansi.h> williamr@2: #include williamr@2: #include williamr@2: williamr@2: G_BEGIN_DECLS williamr@2: williamr@2: typedef struct _GMainContext GMainContext; /* Opaque */ williamr@2: typedef struct _GMainLoop GMainLoop; /* Opaque */ williamr@2: typedef struct _GSource GSource; williamr@2: typedef struct _GSourceCallbackFuncs GSourceCallbackFuncs; williamr@2: typedef struct _GSourceFuncs GSourceFuncs; williamr@2: williamr@2: typedef gboolean (*GSourceFunc) (gpointer data); williamr@2: typedef void (*GChildWatchFunc) (GPid pid, williamr@2: gint status, williamr@2: gpointer data); williamr@2: struct _GSource williamr@2: { williamr@2: /*< private >*/ williamr@2: gpointer callback_data; williamr@2: GSourceCallbackFuncs *callback_funcs; williamr@2: williamr@2: GSourceFuncs *source_funcs; williamr@2: guint ref_count; williamr@2: williamr@2: GMainContext *context; williamr@2: williamr@2: gint priority; williamr@2: guint flags; williamr@2: guint source_id; williamr@2: williamr@2: GSList *poll_fds; williamr@2: williamr@2: GSource *prev; williamr@2: GSource *next; williamr@2: williamr@2: gpointer reserved1; williamr@2: gpointer reserved2; williamr@2: }; williamr@2: williamr@2: struct _GSourceCallbackFuncs williamr@2: { williamr@2: void (*ref) (gpointer cb_data); williamr@2: void (*unref) (gpointer cb_data); williamr@2: void (*get) (gpointer cb_data, williamr@2: GSource *source, williamr@2: GSourceFunc *func, williamr@2: gpointer *data); williamr@2: }; williamr@2: williamr@2: typedef void (*GSourceDummyMarshal) (void); williamr@2: williamr@2: struct _GSourceFuncs williamr@2: { williamr@2: gboolean (*prepare) (GSource *source, williamr@2: gint *timeout_); williamr@2: gboolean (*check) (GSource *source); williamr@2: gboolean (*dispatch) (GSource *source, williamr@2: GSourceFunc callback, williamr@2: gpointer user_data); williamr@2: void (*finalize) (GSource *source); /* Can be NULL */ williamr@2: williamr@2: /* For use by g_source_set_closure */ williamr@2: GSourceFunc closure_callback; williamr@2: GSourceDummyMarshal closure_marshal; /* Really is of type GClosureMarshal */ williamr@2: }; williamr@2: williamr@2: /* Any definitions using GPollFD or GPollFunc are primarily williamr@2: * for Unix and not guaranteed to be the compatible on all williamr@2: * operating systems on which GLib runs. Right now, the williamr@2: * GLib does use these functions on Win32 as well, but interprets williamr@2: * them in a fairly different way than on Unix. If you use williamr@2: * these definitions, you are should be prepared to recode williamr@2: * for different operating systems. williamr@2: * williamr@2: * williamr@2: * On Win32, the fd in a GPollFD should be Win32 HANDLE (*not* a file williamr@2: * descriptor as provided by the C runtime) that can be used by williamr@2: * MsgWaitForMultipleObjects. This does *not* include file handles williamr@2: * from CreateFile, SOCKETs, nor pipe handles. (But you can use williamr@2: * WSAEventSelect to signal events when a SOCKET is readable). williamr@2: * williamr@2: * On Win32, fd can also be the special value G_WIN32_MSG_HANDLE to williamr@2: * indicate polling for messages. williamr@2: * williamr@2: * But note that G_WIN32_MSG_HANDLE GPollFDs should not be used by GDK williamr@2: * (GTK) programs, as GDK itself wants to read messages and convert them williamr@2: * to GDK events. williamr@2: * williamr@2: * So, unless you really know what you are doing, it's best not to try williamr@2: * to use the main loop polling stuff for your own needs on williamr@2: * Win32. It's really only written for the GIMP's needs so williamr@2: * far. williamr@2: */ williamr@2: typedef struct _GPollFD GPollFD; williamr@2: typedef gint (*GPollFunc) (GPollFD *ufds, williamr@2: guint nfsd, williamr@2: gint timeout_); williamr@2: williamr@2: struct _GPollFD williamr@2: { williamr@2: gint fd; williamr@2: gushort events; williamr@2: gushort revents; williamr@2: }; williamr@2: williamr@2: /* Standard priorities */ williamr@2: williamr@2: #define G_PRIORITY_HIGH -100 williamr@2: #define G_PRIORITY_DEFAULT 0 williamr@2: #define G_PRIORITY_HIGH_IDLE 100 williamr@2: #define G_PRIORITY_DEFAULT_IDLE 200 williamr@2: #define G_PRIORITY_LOW 300 williamr@2: williamr@2: /* GMainContext: */ williamr@2: williamr@2: IMPORT_C GMainContext *g_main_context_new (void); williamr@2: IMPORT_C GMainContext *g_main_context_ref (GMainContext *context); williamr@2: IMPORT_C void g_main_context_unref (GMainContext *context); williamr@2: IMPORT_C GMainContext *g_main_context_default (void); williamr@2: williamr@2: IMPORT_C gboolean g_main_context_iteration (GMainContext *context, williamr@2: gboolean may_block); williamr@2: IMPORT_C gboolean g_main_context_pending (GMainContext *context); williamr@2: williamr@2: /* For implementation of legacy interfaces williamr@2: */ williamr@2: IMPORT_C GSource *g_main_context_find_source_by_id (GMainContext *context, williamr@2: guint source_id); williamr@2: IMPORT_C GSource *g_main_context_find_source_by_user_data (GMainContext *context, williamr@2: gpointer user_data); williamr@2: IMPORT_C GSource *g_main_context_find_source_by_funcs_user_data (GMainContext *context, williamr@2: GSourceFuncs *funcs, williamr@2: gpointer user_data); williamr@2: williamr@2: /* Low level functions for implementing custom main loops. williamr@2: */ williamr@2: IMPORT_C void g_main_context_wakeup (GMainContext *context); williamr@2: IMPORT_C gboolean g_main_context_acquire (GMainContext *context); williamr@2: IMPORT_C void g_main_context_release (GMainContext *context); williamr@2: IMPORT_C gboolean g_main_context_is_owner (GMainContext *context); williamr@2: IMPORT_C gboolean g_main_context_wait (GMainContext *context, williamr@2: GCond *cond, williamr@2: GMutex *mutex); williamr@2: williamr@2: IMPORT_C gboolean g_main_context_prepare (GMainContext *context, williamr@2: gint *priority); williamr@2: IMPORT_C gint g_main_context_query (GMainContext *context, williamr@2: gint max_priority, williamr@2: gint *timeout_, williamr@2: GPollFD *fds, williamr@2: gint n_fds); williamr@2: IMPORT_C gint g_main_context_check (GMainContext *context, williamr@2: gint max_priority, williamr@2: GPollFD *fds, williamr@2: gint n_fds); williamr@2: IMPORT_C void g_main_context_dispatch (GMainContext *context); williamr@2: williamr@2: IMPORT_C void g_main_context_set_poll_func (GMainContext *context, williamr@2: GPollFunc func); williamr@2: IMPORT_C GPollFunc g_main_context_get_poll_func (GMainContext *context); williamr@2: williamr@2: /* Low level functions for use by source implementations williamr@2: */ williamr@2: IMPORT_C void g_main_context_add_poll (GMainContext *context, williamr@2: GPollFD *fd, williamr@2: gint priority); williamr@2: IMPORT_C void g_main_context_remove_poll (GMainContext *context, williamr@2: GPollFD *fd); williamr@2: williamr@2: IMPORT_C int g_main_depth (void); williamr@2: williamr@2: /* GMainLoop: */ williamr@2: williamr@2: IMPORT_C GMainLoop *g_main_loop_new (GMainContext *context, williamr@2: gboolean is_running); williamr@2: IMPORT_C void g_main_loop_run (GMainLoop *loop); williamr@2: IMPORT_C void g_main_loop_quit (GMainLoop *loop); williamr@2: IMPORT_C GMainLoop *g_main_loop_ref (GMainLoop *loop); williamr@2: IMPORT_C void g_main_loop_unref (GMainLoop *loop); williamr@2: IMPORT_C gboolean g_main_loop_is_running (GMainLoop *loop); williamr@2: IMPORT_C GMainContext *g_main_loop_get_context (GMainLoop *loop); williamr@2: williamr@2: /* GSource: */ williamr@2: williamr@2: IMPORT_C GSource *g_source_new (GSourceFuncs *source_funcs, williamr@2: guint struct_size); williamr@2: IMPORT_C GSource *g_source_ref (GSource *source); williamr@2: IMPORT_C void g_source_unref (GSource *source); williamr@2: williamr@2: IMPORT_C guint g_source_attach (GSource *source, williamr@2: GMainContext *context); williamr@2: IMPORT_C void g_source_destroy (GSource *source); williamr@2: williamr@2: IMPORT_C void g_source_set_priority (GSource *source, williamr@2: gint priority); williamr@2: IMPORT_C gint g_source_get_priority (GSource *source); williamr@2: IMPORT_C void g_source_set_can_recurse (GSource *source, williamr@2: gboolean can_recurse); williamr@2: IMPORT_C gboolean g_source_get_can_recurse (GSource *source); williamr@2: IMPORT_C guint g_source_get_id (GSource *source); williamr@2: williamr@2: IMPORT_C GMainContext *g_source_get_context (GSource *source); williamr@2: williamr@2: IMPORT_C void g_source_set_callback (GSource *source, williamr@2: GSourceFunc func, williamr@2: gpointer data, williamr@2: GDestroyNotify notify); williamr@2: williamr@2: williamr@2: /* Used to implement g_source_connect_closure and internally*/ williamr@2: IMPORT_C void g_source_set_callback_indirect (GSource *source, williamr@2: gpointer callback_data, williamr@2: GSourceCallbackFuncs *callback_funcs); williamr@2: williamr@2: IMPORT_C void g_source_add_poll (GSource *source, williamr@2: GPollFD *fd); williamr@2: IMPORT_C void g_source_remove_poll (GSource *source, williamr@2: GPollFD *fd); williamr@2: williamr@2: IMPORT_C void g_source_get_current_time (GSource *source, williamr@2: GTimeVal *timeval); williamr@2: williamr@2: /* void g_source_connect_closure (GSource *source, williamr@2: GClosure *closure); williamr@2: */ williamr@2: williamr@2: /* Specific source types williamr@2: */ williamr@2: IMPORT_C GSource *g_idle_source_new (void); williamr@2: IMPORT_C GSource *g_child_watch_source_new (GPid pid); williamr@2: IMPORT_C GSource *g_timeout_source_new (guint interval); williamr@2: williamr@2: /* Miscellaneous functions williamr@2: */ williamr@2: IMPORT_C void g_get_current_time (GTimeVal *result); williamr@2: williamr@2: /* ============== Compat main loop stuff ================== */ williamr@2: williamr@2: #ifndef G_DISABLE_DEPRECATED williamr@2: williamr@2: /* Legacy names for GMainLoop functions williamr@2: */ williamr@2: #define g_main_new(is_running) g_main_loop_new (NULL, is_running); williamr@2: #define g_main_run(loop) g_main_loop_run(loop) williamr@2: #define g_main_quit(loop) g_main_loop_quit(loop) williamr@2: #define g_main_destroy(loop) g_main_loop_unref(loop) williamr@2: #define g_main_is_running(loop) g_main_loop_is_running(loop) williamr@2: williamr@2: /* Functions to manipulate the default main loop williamr@2: */ williamr@2: williamr@2: #define g_main_iteration(may_block) g_main_context_iteration (NULL, may_block) williamr@2: #define g_main_pending() g_main_context_pending (NULL) williamr@2: williamr@2: #define g_main_set_poll_func(func) g_main_context_set_poll_func (NULL, func) williamr@2: williamr@2: #endif /* G_DISABLE_DEPRECATED */ williamr@2: williamr@2: /* Source manipulation by ID */ williamr@2: IMPORT_C gboolean g_source_remove (guint tag); williamr@2: IMPORT_C gboolean g_source_remove_by_user_data (gpointer user_data); williamr@2: IMPORT_C gboolean g_source_remove_by_funcs_user_data (GSourceFuncs *funcs, williamr@2: gpointer user_data); williamr@2: williamr@2: /* Idles, child watchers and timeouts */ williamr@2: IMPORT_C guint g_timeout_add_full (gint priority, williamr@2: guint interval, williamr@2: GSourceFunc function, williamr@2: gpointer data, williamr@2: GDestroyNotify notify); williamr@2: IMPORT_C guint g_timeout_add (guint interval, williamr@2: GSourceFunc function, williamr@2: gpointer data); williamr@2: IMPORT_C guint g_child_watch_add_full (gint priority, williamr@2: GPid pid, williamr@2: GChildWatchFunc function, williamr@2: gpointer data, williamr@2: GDestroyNotify notify); williamr@2: IMPORT_C guint g_child_watch_add (GPid pid, williamr@2: GChildWatchFunc function, williamr@2: gpointer data); williamr@2: IMPORT_C guint g_idle_add (GSourceFunc function, williamr@2: gpointer data); williamr@2: IMPORT_C guint g_idle_add_full (gint priority, williamr@2: GSourceFunc function, williamr@2: gpointer data, williamr@2: GDestroyNotify notify); williamr@2: IMPORT_C gboolean g_idle_remove_by_data (gpointer data); williamr@2: williamr@2: /* Hook for GClosure / GSource integration. Don't touch */ williamr@2: #ifdef __SYMBIAN32__ williamr@2: IMPORT_C GSourceFuncs * _g_timeout_funcs(); williamr@2: #endif /*__SYMBIAN32__ */ williamr@2: GLIB_VAR GSourceFuncs g_timeout_funcs; williamr@2: #ifdef __SYMBIAN32__ williamr@2: IMPORT_C GSourceFuncs * _g_child_watch_funcs(); williamr@2: #endif /* __SYMBIAN32__ */ williamr@2: GLIB_VAR GSourceFuncs g_child_watch_funcs; williamr@2: #ifdef __SYMBIAN32__ williamr@2: IMPORT_C GSourceFuncs * _g_idle_funcs(); williamr@2: #endif/* __SYMBIAN32__ */ williamr@2: GLIB_VAR GSourceFuncs g_idle_funcs; williamr@2: williamr@2: G_END_DECLS williamr@2: williamr@2: #endif /* __G_MAIN_H__ */