/* gmain.h - the GLib Main loop

 * Copyright (C) 1998-2000 Red Hat, Inc.

 * Portions copyright (c) 2006 Nokia Corporation.  All rights reserved.

 *

 * This library is free software; you can redistribute it and/or

 * modify it under the terms of the GNU Library General Public

 * License as published by the Free Software Foundation; either

 * version 2 of the License, or (at your option) any later version.

 *

 * This library is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.	 See the GNU

 * Library General Public License for more details.

 *

 * You should have received a copy of the GNU Library General Public

 * License along with this library; if not, write to the

 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,

 * Boston, MA 02111-1307, USA.

 */

#ifndef __G_MAIN_H__

#define __G_MAIN_H__

#include <_ansi.h>

#include <glib/gslist.h>

#include <glib/gthread.h>

G_BEGIN_DECLS

typedef struct _GMainContext	        GMainContext;	/* Opaque */

typedef struct _GMainLoop	        GMainLoop;	/* Opaque */

typedef struct _GSource	                GSource;

typedef struct _GSourceCallbackFuncs	GSourceCallbackFuncs;

typedef struct _GSourceFuncs	        GSourceFuncs;

typedef gboolean (*GSourceFunc)       (gpointer data);

typedef void     (*GChildWatchFunc)   (GPid     pid,

				       gint     status,

				       gpointer data);

struct _GSource

{

  /*< private >*/

  gpointer callback_data;

  GSourceCallbackFuncs *callback_funcs;

  GSourceFuncs *source_funcs;

  guint ref_count;

  GMainContext *context;

  gint priority;

  guint flags;

  guint source_id;

  GSList *poll_fds;

  GSource *prev;

  GSource *next;

  gpointer reserved1;

  gpointer reserved2;

};

struct _GSourceCallbackFuncs

{

  void (*ref)   (gpointer     cb_data);

  void (*unref) (gpointer     cb_data);

  void (*get)   (gpointer     cb_data,

		 GSource     *source, 

		 GSourceFunc *func,

		 gpointer    *data);

};

typedef void (*GSourceDummyMarshal) (void);

struct _GSourceFuncs

{

  gboolean (*prepare)  (GSource    *source,

			gint       *timeout_);

  gboolean (*check)    (GSource    *source);

  gboolean (*dispatch) (GSource    *source,

			GSourceFunc callback,

			gpointer    user_data);

  void     (*finalize) (GSource    *source); /* Can be NULL */

  /* For use by g_source_set_closure */

  GSourceFunc     closure_callback;	   

  GSourceDummyMarshal closure_marshal; /* Really is of type GClosureMarshal */

};

/* Any definitions using GPollFD or GPollFunc are primarily

 * for Unix and not guaranteed to be the compatible on all

 * operating systems on which GLib runs. Right now, the

 * GLib does use these functions on Win32 as well, but interprets

 * them in a fairly different way than on Unix. If you use

 * these definitions, you are should be prepared to recode

 * for different operating systems.

 *

 *

 * On Win32, the fd in a GPollFD should be Win32 HANDLE (*not* a file

 * descriptor as provided by the C runtime) that can be used by

 * MsgWaitForMultipleObjects. This does *not* include file handles

 * from CreateFile, SOCKETs, nor pipe handles. (But you can use

 * WSAEventSelect to signal events when a SOCKET is readable).

 *

 * On Win32, fd can also be the special value G_WIN32_MSG_HANDLE to

 * indicate polling for messages.

 *

 * But note that G_WIN32_MSG_HANDLE GPollFDs should not be used by GDK

 * (GTK) programs, as GDK itself wants to read messages and convert them

 * to GDK events.

 *

 * So, unless you really know what you are doing, it's best not to try

 * to use the main loop polling stuff for your own needs on

 * Win32. It's really only written for the GIMP's needs so

 * far.

 */

typedef struct _GPollFD GPollFD;

typedef gint	(*GPollFunc)	(GPollFD *ufds,

				 guint	  nfsd,

				 gint     timeout_);

struct _GPollFD

{

  gint		fd;

  gushort 	events;

  gushort 	revents;

};

/* Standard priorities */

#define G_PRIORITY_HIGH            -100

#define G_PRIORITY_DEFAULT          0

#define G_PRIORITY_HIGH_IDLE        100

#define G_PRIORITY_DEFAULT_IDLE     200

#define G_PRIORITY_LOW	            300

/* GMainContext: */

IMPORT_C GMainContext *g_main_context_new       (void);

IMPORT_C GMainContext *g_main_context_ref       (GMainContext *context);

IMPORT_C void          g_main_context_unref     (GMainContext *context);

IMPORT_C GMainContext *g_main_context_default   (void);

IMPORT_C gboolean      g_main_context_iteration (GMainContext *context,

					gboolean      may_block);

IMPORT_C gboolean      g_main_context_pending   (GMainContext *context);

/* For implementation of legacy interfaces

 */

IMPORT_C GSource      *g_main_context_find_source_by_id              (GMainContext *context,

							     guint         source_id);

IMPORT_C GSource      *g_main_context_find_source_by_user_data       (GMainContext *context,

							     gpointer      user_data);

IMPORT_C 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.

 */

IMPORT_C void     g_main_context_wakeup  (GMainContext *context);

IMPORT_C gboolean g_main_context_acquire (GMainContext *context);

IMPORT_C void     g_main_context_release (GMainContext *context);

IMPORT_C gboolean g_main_context_is_owner (GMainContext *context);

IMPORT_C gboolean g_main_context_wait    (GMainContext *context,

				 GCond        *cond,

				 GMutex       *mutex);

IMPORT_C gboolean g_main_context_prepare  (GMainContext *context,

				  gint         *priority);

IMPORT_C gint     g_main_context_query    (GMainContext *context,

				  gint          max_priority,

				  gint         *timeout_,

				  GPollFD      *fds,

				  gint          n_fds);

IMPORT_C gint     g_main_context_check    (GMainContext *context,

				  gint          max_priority,

				  GPollFD      *fds,

				  gint          n_fds);

IMPORT_C void     g_main_context_dispatch (GMainContext *context);

IMPORT_C void      g_main_context_set_poll_func (GMainContext *context,

					GPollFunc     func);

IMPORT_C GPollFunc g_main_context_get_poll_func (GMainContext *context);

/* Low level functions for use by source implementations

 */

IMPORT_C void g_main_context_add_poll      (GMainContext *context,

				   GPollFD      *fd,

				   gint          priority);

IMPORT_C void g_main_context_remove_poll   (GMainContext *context,

				   GPollFD      *fd);

IMPORT_C int g_main_depth (void);

/* GMainLoop: */

IMPORT_C GMainLoop *g_main_loop_new        (GMainContext *context,

			    	   gboolean      is_running);

IMPORT_C void       g_main_loop_run        (GMainLoop    *loop);

IMPORT_C void       g_main_loop_quit       (GMainLoop    *loop);

IMPORT_C GMainLoop *g_main_loop_ref        (GMainLoop    *loop);

IMPORT_C void       g_main_loop_unref      (GMainLoop    *loop);

IMPORT_C gboolean   g_main_loop_is_running (GMainLoop    *loop);

IMPORT_C GMainContext *g_main_loop_get_context (GMainLoop    *loop);

/* GSource: */

IMPORT_C GSource *g_source_new             (GSourceFuncs   *source_funcs,

				   guint           struct_size);

IMPORT_C GSource *g_source_ref             (GSource        *source);

IMPORT_C void     g_source_unref           (GSource        *source);

IMPORT_C guint    g_source_attach          (GSource        *source,

				   GMainContext   *context);

IMPORT_C void     g_source_destroy         (GSource        *source);

IMPORT_C void     g_source_set_priority    (GSource        *source,

				   gint            priority);

IMPORT_C gint     g_source_get_priority    (GSource        *source);

IMPORT_C void     g_source_set_can_recurse (GSource        *source,

				   gboolean        can_recurse);

IMPORT_C gboolean g_source_get_can_recurse (GSource        *source);

IMPORT_C guint    g_source_get_id          (GSource        *source);

IMPORT_C GMainContext *g_source_get_context (GSource       *source);

IMPORT_C void g_source_set_callback          (GSource              *source,

				     GSourceFunc           func,

				     gpointer              data,

				     GDestroyNotify        notify);

/* Used to implement g_source_connect_closure and internally*/

IMPORT_C void g_source_set_callback_indirect (GSource              *source,

				     gpointer              callback_data,

				     GSourceCallbackFuncs *callback_funcs);

IMPORT_C void     g_source_add_poll         (GSource        *source,

				    GPollFD        *fd);

IMPORT_C void     g_source_remove_poll      (GSource        *source,

				    GPollFD        *fd);

IMPORT_C void     g_source_get_current_time (GSource        *source,

				    GTimeVal       *timeval);

 /* void g_source_connect_closure (GSource        *source,

                                  GClosure       *closure);

 */

/* Specific source types

 */

IMPORT_C GSource *g_idle_source_new        (void);

IMPORT_C GSource *g_child_watch_source_new (GPid pid);

IMPORT_C GSource *g_timeout_source_new     (guint interval);

/* Miscellaneous functions

 */

IMPORT_C void g_get_current_time		        (GTimeVal	*result);

/* ============== Compat main loop stuff ================== */

#ifndef G_DISABLE_DEPRECATED

/* Legacy names for GMainLoop functions

 */

#define 	g_main_new(is_running)	g_main_loop_new (NULL, is_running);

#define         g_main_run(loop)        g_main_loop_run(loop)

#define         g_main_quit(loop)       g_main_loop_quit(loop)

#define         g_main_destroy(loop)    g_main_loop_unref(loop)

#define         g_main_is_running(loop) g_main_loop_is_running(loop)

/* Functions to manipulate the default main loop

 */

#define	g_main_iteration(may_block) g_main_context_iteration      (NULL, may_block)

#define g_main_pending()            g_main_context_pending        (NULL)

#define g_main_set_poll_func(func)   g_main_context_set_poll_func (NULL, func)

#endif /* G_DISABLE_DEPRECATED */

/* Source manipulation by ID */

IMPORT_C gboolean g_source_remove                     (guint          tag);

IMPORT_C gboolean g_source_remove_by_user_data        (gpointer       user_data);

IMPORT_C gboolean g_source_remove_by_funcs_user_data  (GSourceFuncs  *funcs,

					      gpointer       user_data);

/* Idles, child watchers and timeouts */

IMPORT_C guint    g_timeout_add_full     (gint            priority,

				 guint           interval,

				 GSourceFunc     function,

				 gpointer        data,

				 GDestroyNotify  notify);

IMPORT_C guint    g_timeout_add          (guint           interval,

				 GSourceFunc     function,

				 gpointer        data);

IMPORT_C guint    g_child_watch_add_full (gint            priority,

				 GPid            pid,

				 GChildWatchFunc function,

				 gpointer        data,

				 GDestroyNotify  notify);

IMPORT_C guint    g_child_watch_add      (GPid            pid,

				 GChildWatchFunc function,

				 gpointer        data);

IMPORT_C guint    g_idle_add             (GSourceFunc     function,

				 gpointer        data);

IMPORT_C guint    g_idle_add_full        (gint            priority,

				 GSourceFunc     function,

				 gpointer        data,

				 GDestroyNotify  notify);

IMPORT_C gboolean g_idle_remove_by_data  (gpointer        data);

/* Hook for GClosure / GSource integration. Don't touch */

#ifdef __SYMBIAN32__

IMPORT_C GSourceFuncs * _g_timeout_funcs();

#endif /*__SYMBIAN32__ */

GLIB_VAR GSourceFuncs g_timeout_funcs;

#ifdef __SYMBIAN32__

IMPORT_C GSourceFuncs * _g_child_watch_funcs();

#endif /* __SYMBIAN32__ */

GLIB_VAR GSourceFuncs g_child_watch_funcs;

#ifdef __SYMBIAN32__

IMPORT_C GSourceFuncs * _g_idle_funcs();

#endif/* __SYMBIAN32__ */

GLIB_VAR GSourceFuncs g_idle_funcs;

G_END_DECLS

#endif /* __G_MAIN_H__ */