glib/gmain.h

   1 /* gmain.h - the GLib Main loop
   2  * Copyright (C) 1998-2000 Red Hat, Inc.
   3  *
   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.
   8  *
   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.
  13  *
  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.
  18  */
  19
  20 #if defined(G_DISABLE_SINGLE_INCLUDES) && !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
  21 #error "Only <glib.h> can be included directly."
  22 #endif
  23
  24 #ifndef __G_MAIN_H__
  25 #define __G_MAIN_H__
  26
  27 #include <glib/gslist.h>
  28 #include <glib/gthread.h>
  29
  30 G_BEGIN_DECLS
  31
  32 typedef struct _GMainContext            GMainContext;   /* Opaque */
  33 typedef struct _GMainLoop               GMainLoop;      /* Opaque */
  34 typedef struct _GSource                 GSource;
  35 typedef struct _GSourceCallbackFuncs    GSourceCallbackFuncs;
  36 typedef struct _GSourceFuncs            GSourceFuncs;
  37
  38 typedef gboolean (*GSourceFunc)       (gpointer data);
  39 typedef void     (*GChildWatchFunc)   (GPid     pid,
  40                                        gint     status,
  41                                        gpointer data);
  42 struct _GSource
  43 {
  44   /*< private >*/
  45   gpointer callback_data;
  46   GSourceCallbackFuncs *callback_funcs;
  47
  48   GSourceFuncs *source_funcs;
  49   guint ref_count;
  50
  51   GMainContext *context;
  52
  53   gint priority;
  54   guint flags;
  55   guint source_id;
  56
  57   GSList *poll_fds;
  58
  59   GSource *prev;
  60   GSource *next;
  61
  62   gpointer reserved1;
  63   gpointer reserved2;
  64 };
  65
  66 struct _GSourceCallbackFuncs
  67 {
  68   void (*ref)   (gpointer     cb_data);
  69   void (*unref) (gpointer     cb_data);
  70   void (*get)   (gpointer     cb_data,
  71                  GSource     *source,
  72                  GSourceFunc *func,
  73                  gpointer    *data);
  74 };
  75
  76 typedef void (*GSourceDummyMarshal) (void);
  77
  78 struct _GSourceFuncs
  79 {
  80   gboolean (*prepare)  (GSource    *source,
  81                         gint       *timeout_);
  82   gboolean (*check)    (GSource    *source);
  83   gboolean (*dispatch) (GSource    *source,
  84                         GSourceFunc callback,
  85                         gpointer    user_data);
  86   void     (*finalize) (GSource    *source); /* Can be NULL */
  87
  88   /* For use by g_source_set_closure */
  89   GSourceFunc     closure_callback;
  90   GSourceDummyMarshal closure_marshal; /* Really is of type GClosureMarshal */
  91 };
  92
  93 /* Any definitions using GPollFD or GPollFunc are primarily
  94  * for Unix and not guaranteed to be the compatible on all
  95  * operating systems on which GLib runs. Right now, the
  96  * GLib does use these functions on Win32 as well, but interprets
  97  * them in a fairly different way than on Unix. If you use
  98  * these definitions, you are should be prepared to recode
  99  * for different operating systems.
 100  *
 101  *
 102  * On Win32, the fd in a GPollFD should be Win32 HANDLE (*not* a file
 103  * descriptor as provided by the C runtime) that can be used by
 104  * MsgWaitForMultipleObjects. This does *not* include file handles
 105  * from CreateFile, SOCKETs, nor pipe handles. (But you can use
 106  * WSAEventSelect to signal events when a SOCKET is readable).
 107  *
 108  * On Win32, fd can also be the special value G_WIN32_MSG_HANDLE to
 109  * indicate polling for messages.
 110  *
 111  * But note that G_WIN32_MSG_HANDLE GPollFDs should not be used by GDK
 112  * (GTK) programs, as GDK itself wants to read messages and convert them
 113  * to GDK events.
 114  *
 115  * So, unless you really know what you are doing, it's best not to try
 116  * to use the main loop polling stuff for your own needs on
 117  * Windows.
 118  */
 119 typedef struct _GPollFD GPollFD;
 120 typedef gint    (*GPollFunc)    (GPollFD *ufds,
 121                                  guint    nfsd,
 122                                  gint     timeout_);
 123
 124 struct _GPollFD
 125 {
 126 #if defined (G_OS_WIN32) && GLIB_SIZEOF_VOID_P == 8
 127   gint64        fd;
 128 #else
 129   gint          fd;
 130 #endif
 131   gushort       events;
 132   gushort       revents;
 133 };
 134
 135 /* Standard priorities */
 136
 137 #define G_PRIORITY_HIGH            -100
 138 #define G_PRIORITY_DEFAULT          0
 139 #define G_PRIORITY_HIGH_IDLE        100
 140 #define G_PRIORITY_DEFAULT_IDLE     200
 141 #define G_PRIORITY_LOW              300
 142
 143 /* GMainContext: */
 144
 145 GMainContext *g_main_context_new       (void);
 146 GMainContext *g_main_context_ref       (GMainContext *context);
 147 void          g_main_context_unref     (GMainContext *context);
 148 GMainContext *g_main_context_default   (void);
 149
 150 gboolean      g_main_context_iteration (GMainContext *context,
 151                                         gboolean      may_block);
 152 gboolean      g_main_context_pending   (GMainContext *context);
 153
 154 /* For implementation of legacy interfaces
 155  */
 156 GSource      *g_main_context_find_source_by_id              (GMainContext *context,
 157                                                              guint         source_id);
 158 GSource      *g_main_context_find_source_by_user_data       (GMainContext *context,
 159                                                              gpointer      user_data);
 160 GSource      *g_main_context_find_source_by_funcs_user_data (GMainContext *context,
 161                                                              GSourceFuncs *funcs,
 162                                                              gpointer      user_data);
 163
 164 /* Low level functions for implementing custom main loops.
 165  */
 166 void     g_main_context_wakeup  (GMainContext *context);
 167 gboolean g_main_context_acquire (GMainContext *context);
 168 void     g_main_context_release (GMainContext *context);
 169 gboolean g_main_context_is_owner (GMainContext *context);
 170 gboolean g_main_context_wait    (GMainContext *context,
 171                                  GCond        *cond,
 172                                  GMutex       *mutex);
 173
 174 gboolean g_main_context_prepare  (GMainContext *context,
 175                                   gint         *priority);
 176 gint     g_main_context_query    (GMainContext *context,
 177                                   gint          max_priority,
 178                                   gint         *timeout_,
 179                                   GPollFD      *fds,
 180                                   gint          n_fds);
 181 gint     g_main_context_check    (GMainContext *context,
 182                                   gint          max_priority,
 183                                   GPollFD      *fds,
 184                                   gint          n_fds);
 185 void     g_main_context_dispatch (GMainContext *context);
 186
 187 void     g_main_context_set_poll_func (GMainContext *context,
 188                                        GPollFunc     func);
 189 GPollFunc g_main_context_get_poll_func (GMainContext *context);
 190
 191 /* Low level functions for use by source implementations
 192  */
 193 void     g_main_context_add_poll    (GMainContext *context,
 194                                      GPollFD      *fd,
 195                                      gint          priority);
 196 void     g_main_context_remove_poll (GMainContext *context,
 197                                      GPollFD      *fd);
 198
 199 gint     g_main_depth               (void);
 200 GSource *g_main_current_source      (void);
 201
 202
 203 /* GMainLoop: */
 204
 205 GMainLoop *g_main_loop_new        (GMainContext *context,
 206                                    gboolean      is_running);
 207 void       g_main_loop_run        (GMainLoop    *loop);
 208 void       g_main_loop_quit       (GMainLoop    *loop);
 209 GMainLoop *g_main_loop_ref        (GMainLoop    *loop);
 210 void       g_main_loop_unref      (GMainLoop    *loop);
 211 gboolean   g_main_loop_is_running (GMainLoop    *loop);
 212 GMainContext *g_main_loop_get_context (GMainLoop    *loop);
 213
 214 /* GSource: */
 215
 216 GSource *g_source_new             (GSourceFuncs   *source_funcs,
 217                                    guint           struct_size);
 218 GSource *g_source_ref             (GSource        *source);
 219 void     g_source_unref           (GSource        *source);
 220
 221 guint    g_source_attach          (GSource        *source,
 222                                    GMainContext   *context);
 223 void     g_source_destroy         (GSource        *source);
 224
 225 void     g_source_set_priority    (GSource        *source,
 226                                    gint            priority);
 227 gint     g_source_get_priority    (GSource        *source);
 228 void     g_source_set_can_recurse (GSource        *source,
 229                                    gboolean        can_recurse);
 230 gboolean g_source_get_can_recurse (GSource        *source);
 231 guint    g_source_get_id          (GSource        *source);
 232
 233 GMainContext *g_source_get_context (GSource       *source);
 234
 235 void     g_source_set_callback    (GSource        *source,
 236                                    GSourceFunc     func,
 237                                    gpointer        data,
 238                                    GDestroyNotify  notify);
 239
 240 void     g_source_set_funcs       (GSource        *source,
 241                                    GSourceFuncs   *funcs);
 242 gboolean g_source_is_destroyed    (GSource        *source);
 243
 244 /* Used to implement g_source_connect_closure and internally*/
 245 void g_source_set_callback_indirect (GSource              *source,
 246                                      gpointer              callback_data,
 247                                      GSourceCallbackFuncs *callback_funcs);
 248
 249 void     g_source_add_poll         (GSource        *source,
 250                                     GPollFD        *fd);
 251 void     g_source_remove_poll      (GSource        *source,
 252                                     GPollFD        *fd);
 253
 254 void     g_source_get_current_time (GSource        *source,
 255                                     GTimeVal       *timeval);
 256
 257  /* void g_source_connect_closure (GSource        *source,
 258                                   GClosure       *closure);
 259  */
 260
 261 /* Specific source types
 262  */
 263 GSource *g_idle_source_new        (void);
 264 GSource *g_child_watch_source_new (GPid pid);
 265 GSource *g_timeout_source_new     (guint interval);
 266 GSource *g_timeout_source_new_seconds (guint interval);
 267
 268 /* Miscellaneous functions
 269  */
 270 void g_get_current_time                 (GTimeVal       *result);
 271
 272 /* ============== Compat main loop stuff ================== */
 273
 274 #ifndef G_DISABLE_DEPRECATED
 275
 276 /* Legacy names for GMainLoop functions
 277  */
 278 #define         g_main_new(is_running)  g_main_loop_new (NULL, is_running);
 279 #define         g_main_run(loop)        g_main_loop_run(loop)
 280 #define         g_main_quit(loop)       g_main_loop_quit(loop)
 281 #define         g_main_destroy(loop)    g_main_loop_unref(loop)
 282 #define         g_main_is_running(loop) g_main_loop_is_running(loop)
 283
 284 /* Functions to manipulate the default main loop
 285  */
 286
 287 #define g_main_iteration(may_block) g_main_context_iteration      (NULL, may_block)
 288 #define g_main_pending()            g_main_context_pending        (NULL)
 289
 290 #define g_main_set_poll_func(func)   g_main_context_set_poll_func (NULL, func)
 291
 292 #endif /* G_DISABLE_DEPRECATED */
 293
 294 /* Source manipulation by ID */
 295 gboolean g_source_remove                     (guint          tag);
 296 gboolean g_source_remove_by_user_data        (gpointer       user_data);
 297 gboolean g_source_remove_by_funcs_user_data  (GSourceFuncs  *funcs,
 298                                               gpointer       user_data);
 299
 300 /* Idles, child watchers and timeouts */
 301 guint    g_timeout_add_full         (gint            priority,
 302                                      guint           interval,
 303                                      GSourceFunc     function,
 304                                      gpointer        data,
 305                                      GDestroyNotify  notify);
 306 guint    g_timeout_add              (guint           interval,
 307                                      GSourceFunc     function,
 308                                      gpointer        data);
 309 guint    g_timeout_add_seconds_full (gint            priority,
 310                                      guint           interval,
 311                                      GSourceFunc     function,
 312                                      gpointer        data,
 313                                      GDestroyNotify  notify);
 314 guint    g_timeout_add_seconds      (guint           interval,
 315                                      GSourceFunc     function,
 316                                      gpointer        data);
 317 guint    g_child_watch_add_full     (gint            priority,
 318                                      GPid            pid,
 319                                      GChildWatchFunc function,
 320                                      gpointer        data,
 321                                      GDestroyNotify  notify);
 322 guint    g_child_watch_add          (GPid            pid,
 323                                      GChildWatchFunc function,
 324                                      gpointer        data);
 325 guint    g_idle_add                 (GSourceFunc     function,
 326                                      gpointer        data);
 327 guint    g_idle_add_full            (gint            priority,
 328                                      GSourceFunc     function,
 329                                      gpointer        data,
 330                                      GDestroyNotify  notify);
 331 gboolean g_idle_remove_by_data      (gpointer        data);
 332
 333 /* Hook for GClosure / GSource integration. Don't touch */
 334 GLIB_VAR GSourceFuncs g_timeout_funcs;
 335 GLIB_VAR GSourceFuncs g_child_watch_funcs;
 336 GLIB_VAR GSourceFuncs g_idle_funcs;
 337
 338 G_END_DECLS
 339
 340 #endif /* __G_MAIN_H__ */