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 Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2.1 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  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public License
  15  * along with this library; if not, see <http://www.gnu.org/licenses/>.
  16  */
  17
  18 #ifndef __G_MAIN_H__
  19 #define __G_MAIN_H__
  20
  21 #if !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
  22 #error "Only <glib.h> can be included directly."
  23 #endif
  24
  25 #include <glib/gpoll.h>
  26 #include <glib/gslist.h>
  27 #include <glib/gthread.h>
  28
  29 G_BEGIN_DECLS
  30
  31 typedef enum /*< flags >*/
  32 {
  33   G_IO_IN       GLIB_SYSDEF_POLLIN,
  34   G_IO_OUT      GLIB_SYSDEF_POLLOUT,
  35   G_IO_PRI      GLIB_SYSDEF_POLLPRI,
  36   G_IO_ERR      GLIB_SYSDEF_POLLERR,
  37   G_IO_HUP      GLIB_SYSDEF_POLLHUP,
  38   G_IO_NVAL     GLIB_SYSDEF_POLLNVAL
  39 } GIOCondition;
  40
  41
  42 /**
  43  * GMainContext:
  44  *
  45  * The `GMainContext` struct is an opaque data
  46  * type representing a set of sources to be handled in a main loop.
  47  */
  48 typedef struct _GMainContext            GMainContext;
  49
  50 /**
  51  * GMainLoop:
  52  *
  53  * The `GMainLoop` struct is an opaque data type
  54  * representing the main event loop of a GLib or GTK+ application.
  55  */
  56 typedef struct _GMainLoop               GMainLoop;
  57
  58 /**
  59  * GSource:
  60  *
  61  * The `GSource` struct is an opaque data type
  62  * representing an event source.
  63  */
  64 typedef struct _GSource                 GSource;
  65 typedef struct _GSourcePrivate          GSourcePrivate;
  66
  67 /**
  68  * GSourceCallbackFuncs:
  69  * @ref: Called when a reference is added to the callback object
  70  * @unref: Called when a reference to the callback object is dropped
  71  * @get: Called to extract the callback function and data from the
  72  *     callback object.
  73  *
  74  * The `GSourceCallbackFuncs` struct contains
  75  * functions for managing callback objects.
  76  */
  77 typedef struct _GSourceCallbackFuncs    GSourceCallbackFuncs;
  78
  79 /**
  80  * GSourceFuncs:
  81  * @prepare: Called before all the file descriptors are polled. If the
  82  *     source can determine that it is ready here (without waiting for the
  83  *     results of the poll() call) it should return %TRUE. It can also return
  84  *     a @timeout_ value which should be the maximum timeout (in milliseconds)
  85  *     which should be passed to the poll() call. The actual timeout used will
  86  *     be -1 if all sources returned -1, or it will be the minimum of all
  87  *     the @timeout_ values returned which were >= 0.  Since 2.36 this may
  88  *     be %NULL, in which case the effect is as if the function always returns
  89  *     %FALSE with a timeout of -1.  If @prepare returns a
  90  *     timeout and the source also has a ready time set, then the
  91  *     lower of the two will be used.
  92  * @check: Called after all the file descriptors are polled. The source
  93  *     should return %TRUE if it is ready to be dispatched. Note that some
  94  *     time may have passed since the previous prepare function was called,
  95  *     so the source should be checked again here.  Since 2.36 this may
  96  *     be %NULL, in which case the effect is as if the function always returns
  97  *     %FALSE.
  98  * @dispatch: Called to dispatch the event source, after it has returned
  99  *     %TRUE in either its @prepare or its @check function, or if a ready time
 100  *     has been reached. The @dispatch function receives a callback function and
 101  *     user data. The callback function may be %NULL if the source was never
 102  *     connected to a callback using g_source_set_callback(). The @dispatch
 103  *     function should call the callback function with @user_data and whatever
 104  *     additional parameters are needed for this type of event source. The
 105  *     return value of the @dispatch function should be #G_SOURCE_REMOVE if the
 106  *     source should be removed or #G_SOURCE_CONTINUE to keep it.
 107  * @finalize: Called when the source is finalized. At this point, the source
 108  *     will have been destroyed, had its callback cleared, and have been removed
 109  *     from its #GMainContext, but it will still have its final reference count,
 110  *     so methods can be called on it from within this function.
 111  *
 112  * The `GSourceFuncs` struct contains a table of
 113  * functions used to handle event sources in a generic manner.
 114  *
 115  * For idle sources, the prepare and check functions always return %TRUE
 116  * to indicate that the source is always ready to be processed. The prepare
 117  * function also returns a timeout value of 0 to ensure that the poll() call
 118  * doesn't block (since that would be time wasted which could have been spent
 119  * running the idle function).
 120  *
 121  * For timeout sources, the prepare and check functions both return %TRUE
 122  * if the timeout interval has expired. The prepare function also returns
 123  * a timeout value to ensure that the poll() call doesn't block too long
 124  * and miss the next timeout.
 125  *
 126  * For file descriptor sources, the prepare function typically returns %FALSE,
 127  * since it must wait until poll() has been called before it knows whether
 128  * any events need to be processed. It sets the returned timeout to -1 to
 129  * indicate that it doesn't mind how long the poll() call blocks. In the
 130  * check function, it tests the results of the poll() call to see if the
 131  * required condition has been met, and returns %TRUE if so.
 132  */
 133 typedef struct _GSourceFuncs            GSourceFuncs;
 134
 135 /**
 136  * GPid:
 137  *
 138  * A type which is used to hold a process identification.
 139  *
 140  * On UNIX, processes are identified by a process id (an integer),
 141  * while Windows uses process handles (which are pointers).
 142  *
 143  * GPid is used in GLib only for descendant processes spawned with
 144  * the g_spawn functions.
 145  */
 146 /* defined in glibconfig.h */
 147
 148 /**
 149  * G_PID_FORMAT:
 150  *
 151  * A format specifier that can be used in printf()-style format strings
 152  * when printing a #GPid.
 153  *
 154  * Since: 2.50
 155  */
 156 /* defined in glibconfig.h */
 157
 158 /**
 159  * GSourceFunc:
 160  * @user_data: data passed to the function, set when the source was
 161  *     created with one of the above functions
 162  *
 163  * Specifies the type of function passed to g_timeout_add(),
 164  * g_timeout_add_full(), g_idle_add(), and g_idle_add_full().
 165  *
 166  * When calling g_source_set_callback(), you may need to cast a function of a
 167  * different type to this type. Use G_SOURCE_FUNC() to avoid warnings about
 168  * incompatible function types.
 169  *
 170  * Returns: %FALSE if the source should be removed. #G_SOURCE_CONTINUE and
 171  * #G_SOURCE_REMOVE are more memorable names for the return value.
 172  */
 173 typedef gboolean (*GSourceFunc)       (gpointer user_data);
 174
 175 /**
 176  * G_SOURCE_FUNC:
 177  * @f: a function pointer.
 178  *
 179  * Cast a function pointer to a #GSourceFunc, suppressing warnings from GCC 8
 180  * onwards with `-Wextra` or `-Wcast-function-type` enabled about the function
 181  * types being incompatible.
 182  *
 183  * For example, the correct type of callback for a source created by
 184  * g_child_watch_source_new() is #GChildWatchFunc, which accepts more arguments
 185  * than #GSourceFunc. Casting the function with `(GSourceFunc)` to call
 186  * g_source_set_callback() will trigger a warning, even though it will be cast
 187  * back to the correct type before it is called by the source.
 188  *
 189  * Since: 2.58
 190  */
 191 #define G_SOURCE_FUNC(f) ((GSourceFunc) (void (*)(void)) (f))
 192
 193 /**
 194  * GChildWatchFunc:
 195  * @pid: the process id of the child process
 196  * @status: Status information about the child process, encoded
 197  *     in a platform-specific manner
 198  * @user_data: user data passed to g_child_watch_add()
 199  *
 200  * Prototype of a #GChildWatchSource callback, called when a child
 201  * process has exited.  To interpret @status, see the documentation
 202  * for g_spawn_check_exit_status().
 203  */
 204 typedef void     (*GChildWatchFunc)   (GPid     pid,
 205                                        gint     status,
 206                                        gpointer user_data);
 207 struct _GSource
 208 {
 209   /*< private >*/
 210   gpointer callback_data;
 211   GSourceCallbackFuncs *callback_funcs;
 212
 213   const GSourceFuncs *source_funcs;
 214   guint ref_count;
 215
 216   GMainContext *context;
 217
 218   gint priority;
 219   guint flags;
 220   guint source_id;
 221
 222   GSList *poll_fds;
 223
 224   GSource *prev;
 225   GSource *next;
 226
 227   char    *name;
 228
 229   GSourcePrivate *priv;
 230 };
 231
 232 struct _GSourceCallbackFuncs
 233 {
 234   void (*ref)   (gpointer     cb_data);
 235   void (*unref) (gpointer     cb_data);
 236   void (*get)   (gpointer     cb_data,
 237                  GSource     *source,
 238                  GSourceFunc *func,
 239                  gpointer    *data);
 240 };
 241
 242 /**
 243  * GSourceDummyMarshal:
 244  *
 245  * This is just a placeholder for #GClosureMarshal,
 246  * which cannot be used here for dependency reasons.
 247  */
 248 typedef void (*GSourceDummyMarshal) (void);
 249
 250 struct _GSourceFuncs
 251 {
 252   gboolean (*prepare)  (GSource    *source,
 253                         gint       *timeout_);
 254   gboolean (*check)    (GSource    *source);
 255   gboolean (*dispatch) (GSource    *source,
 256                         GSourceFunc callback,
 257                         gpointer    user_data);
 258   void     (*finalize) (GSource    *source); /* Can be NULL */
 259
 260   /*< private >*/
 261   /* For use by g_source_set_closure */
 262   GSourceFunc     closure_callback;
 263   GSourceDummyMarshal closure_marshal; /* Really is of type GClosureMarshal */
 264 };
 265
 266 /* Standard priorities */
 267
 268 /**
 269  * G_PRIORITY_HIGH:
 270  *
 271  * Use this for high priority event sources.
 272  *
 273  * It is not used within GLib or GTK+.
 274  */
 275 #define G_PRIORITY_HIGH            -100
 276
 277 /**
 278  * G_PRIORITY_DEFAULT:
 279  *
 280  * Use this for default priority event sources.
 281  *
 282  * In GLib this priority is used when adding timeout functions
 283  * with g_timeout_add(). In GDK this priority is used for events
 284  * from the X server.
 285  */
 286 #define G_PRIORITY_DEFAULT          0
 287
 288 /**
 289  * G_PRIORITY_HIGH_IDLE:
 290  *
 291  * Use this for high priority idle functions.
 292  *
 293  * GTK+ uses #G_PRIORITY_HIGH_IDLE + 10 for resizing operations,
 294  * and #G_PRIORITY_HIGH_IDLE + 20 for redrawing operations. (This is
 295  * done to ensure that any pending resizes are processed before any
 296  * pending redraws, so that widgets are not redrawn twice unnecessarily.)
 297  */
 298 #define G_PRIORITY_HIGH_IDLE        100
 299
 300 /**
 301  * G_PRIORITY_DEFAULT_IDLE:
 302  *
 303  * Use this for default priority idle functions.
 304  *
 305  * In GLib this priority is used when adding idle functions with
 306  * g_idle_add().
 307  */
 308 #define G_PRIORITY_DEFAULT_IDLE     200
 309
 310 /**
 311  * G_PRIORITY_LOW:
 312  *
 313  * Use this for very low priority background tasks.
 314  *
 315  * It is not used within GLib or GTK+.
 316  */
 317 #define G_PRIORITY_LOW              300
 318
 319 /**
 320  * G_SOURCE_REMOVE:
 321  *
 322  * Use this macro as the return value of a #GSourceFunc to remove
 323  * the #GSource from the main loop.
 324  *
 325  * Since: 2.32
 326  */
 327 #define G_SOURCE_REMOVE         FALSE
 328
 329 /**
 330  * G_SOURCE_CONTINUE:
 331  *
 332  * Use this macro as the return value of a #GSourceFunc to leave
 333  * the #GSource in the main loop.
 334  *
 335  * Since: 2.32
 336  */
 337 #define G_SOURCE_CONTINUE       TRUE
 338
 339 /* GMainContext: */
 340
 341 GLIB_AVAILABLE_IN_ALL
 342 GMainContext *g_main_context_new       (void);
 343 GLIB_AVAILABLE_IN_ALL
 344 GMainContext *g_main_context_ref       (GMainContext *context);
 345 GLIB_AVAILABLE_IN_ALL
 346 void          g_main_context_unref     (GMainContext *context);
 347 GLIB_AVAILABLE_IN_ALL
 348 GMainContext *g_main_context_default   (void);
 349
 350 GLIB_AVAILABLE_IN_ALL
 351 gboolean      g_main_context_iteration (GMainContext *context,
 352                                         gboolean      may_block);
 353 GLIB_AVAILABLE_IN_ALL
 354 gboolean      g_main_context_pending   (GMainContext *context);
 355
 356 /* For implementation of legacy interfaces
 357  */
 358 GLIB_AVAILABLE_IN_ALL
 359 GSource      *g_main_context_find_source_by_id              (GMainContext *context,
 360                                                              guint         source_id);
 361 GLIB_AVAILABLE_IN_ALL
 362 GSource      *g_main_context_find_source_by_user_data       (GMainContext *context,
 363                                                              gpointer      user_data);
 364 GLIB_AVAILABLE_IN_ALL
 365 GSource      *g_main_context_find_source_by_funcs_user_data (GMainContext *context,
 366                                                              GSourceFuncs *funcs,
 367                                                              gpointer      user_data);
 368
 369 /* Low level functions for implementing custom main loops.
 370  */
 371 GLIB_AVAILABLE_IN_ALL
 372 void     g_main_context_wakeup  (GMainContext *context);
 373 GLIB_AVAILABLE_IN_ALL
 374 gboolean g_main_context_acquire (GMainContext *context);
 375 GLIB_AVAILABLE_IN_ALL
 376 void     g_main_context_release (GMainContext *context);
 377 GLIB_AVAILABLE_IN_ALL
 378 gboolean g_main_context_is_owner (GMainContext *context);
 379 GLIB_DEPRECATED_IN_2_58_FOR(g_main_context_is_owner)
 380 gboolean g_main_context_wait    (GMainContext *context,
 381                                  GCond        *cond,
 382                                  GMutex       *mutex);
 383
 384 GLIB_AVAILABLE_IN_ALL
 385 gboolean g_main_context_prepare  (GMainContext *context,
 386                                   gint         *priority);
 387 GLIB_AVAILABLE_IN_ALL
 388 gint     g_main_context_query    (GMainContext *context,
 389                                   gint          max_priority,
 390                                   gint         *timeout_,
 391                                   GPollFD      *fds,
 392                                   gint          n_fds);
 393 GLIB_AVAILABLE_IN_ALL
 394 gboolean     g_main_context_check    (GMainContext *context,
 395                                       gint          max_priority,
 396                                       GPollFD      *fds,
 397                                       gint          n_fds);
 398 GLIB_AVAILABLE_IN_ALL
 399 void     g_main_context_dispatch (GMainContext *context);
 400
 401 GLIB_AVAILABLE_IN_ALL
 402 void     g_main_context_set_poll_func (GMainContext *context,
 403                                        GPollFunc     func);
 404 GLIB_AVAILABLE_IN_ALL
 405 GPollFunc g_main_context_get_poll_func (GMainContext *context);
 406
 407 /* Low level functions for use by source implementations
 408  */
 409 GLIB_AVAILABLE_IN_ALL
 410 void     g_main_context_add_poll    (GMainContext *context,
 411                                      GPollFD      *fd,
 412                                      gint          priority);
 413 GLIB_AVAILABLE_IN_ALL
 414 void     g_main_context_remove_poll (GMainContext *context,
 415                                      GPollFD      *fd);
 416
 417 GLIB_AVAILABLE_IN_ALL
 418 gint     g_main_depth               (void);
 419 GLIB_AVAILABLE_IN_ALL
 420 GSource *g_main_current_source      (void);
 421
 422 /* GMainContexts for other threads
 423  */
 424 GLIB_AVAILABLE_IN_ALL
 425 void          g_main_context_push_thread_default (GMainContext *context);
 426 GLIB_AVAILABLE_IN_ALL
 427 void          g_main_context_pop_thread_default  (GMainContext *context);
 428 GLIB_AVAILABLE_IN_ALL
 429 GMainContext *g_main_context_get_thread_default  (void);
 430 GLIB_AVAILABLE_IN_ALL
 431 GMainContext *g_main_context_ref_thread_default  (void);
 432
 433 /* GMainLoop: */
 434
 435 GLIB_AVAILABLE_IN_ALL
 436 GMainLoop *g_main_loop_new        (GMainContext *context,
 437                                    gboolean      is_running);
 438 GLIB_AVAILABLE_IN_ALL
 439 void       g_main_loop_run        (GMainLoop    *loop);
 440 GLIB_AVAILABLE_IN_ALL
 441 void       g_main_loop_quit       (GMainLoop    *loop);
 442 GLIB_AVAILABLE_IN_ALL
 443 GMainLoop *g_main_loop_ref        (GMainLoop    *loop);
 444 GLIB_AVAILABLE_IN_ALL
 445 void       g_main_loop_unref      (GMainLoop    *loop);
 446 GLIB_AVAILABLE_IN_ALL
 447 gboolean   g_main_loop_is_running (GMainLoop    *loop);
 448 GLIB_AVAILABLE_IN_ALL
 449 GMainContext *g_main_loop_get_context (GMainLoop    *loop);
 450
 451 /* GSource: */
 452
 453 GLIB_AVAILABLE_IN_ALL
 454 GSource *g_source_new             (GSourceFuncs   *source_funcs,
 455                                    guint           struct_size);
 456 GLIB_AVAILABLE_IN_ALL
 457 GSource *g_source_ref             (GSource        *source);
 458 GLIB_AVAILABLE_IN_ALL
 459 void     g_source_unref           (GSource        *source);
 460
 461 GLIB_AVAILABLE_IN_ALL
 462 guint    g_source_attach          (GSource        *source,
 463                                    GMainContext   *context);
 464 GLIB_AVAILABLE_IN_ALL
 465 void     g_source_destroy         (GSource        *source);
 466
 467 GLIB_AVAILABLE_IN_ALL
 468 void     g_source_set_priority    (GSource        *source,
 469                                    gint            priority);
 470 GLIB_AVAILABLE_IN_ALL
 471 gint     g_source_get_priority    (GSource        *source);
 472 GLIB_AVAILABLE_IN_ALL
 473 void     g_source_set_can_recurse (GSource        *source,
 474                                    gboolean        can_recurse);
 475 GLIB_AVAILABLE_IN_ALL
 476 gboolean g_source_get_can_recurse (GSource        *source);
 477 GLIB_AVAILABLE_IN_ALL
 478 guint    g_source_get_id          (GSource        *source);
 479
 480 GLIB_AVAILABLE_IN_ALL
 481 GMainContext *g_source_get_context (GSource       *source);
 482
 483 GLIB_AVAILABLE_IN_ALL
 484 void     g_source_set_callback    (GSource        *source,
 485                                    GSourceFunc     func,
 486                                    gpointer        data,
 487                                    GDestroyNotify  notify);
 488
 489 GLIB_AVAILABLE_IN_ALL
 490 void     g_source_set_funcs       (GSource        *source,
 491                                    GSourceFuncs   *funcs);
 492 GLIB_AVAILABLE_IN_ALL
 493 gboolean g_source_is_destroyed    (GSource        *source);
 494
 495 GLIB_AVAILABLE_IN_ALL
 496 void                 g_source_set_name       (GSource        *source,
 497                                               const char     *name);
 498 GLIB_AVAILABLE_IN_ALL
 499 const char *         g_source_get_name       (GSource        *source);
 500 GLIB_AVAILABLE_IN_ALL
 501 void                 g_source_set_name_by_id (guint           tag,
 502                                               const char     *name);
 503
 504 GLIB_AVAILABLE_IN_2_36
 505 void                 g_source_set_ready_time (GSource        *source,
 506                                               gint64          ready_time);
 507 GLIB_AVAILABLE_IN_2_36
 508 gint64               g_source_get_ready_time (GSource        *source);
 509
 510 #ifdef G_OS_UNIX
 511 GLIB_AVAILABLE_IN_2_36
 512 gpointer             g_source_add_unix_fd    (GSource        *source,
 513                                               gint            fd,
 514                                               GIOCondition    events);
 515 GLIB_AVAILABLE_IN_2_36
 516 void                 g_source_modify_unix_fd (GSource        *source,
 517                                               gpointer        tag,
 518                                               GIOCondition    new_events);
 519 GLIB_AVAILABLE_IN_2_36
 520 void                 g_source_remove_unix_fd (GSource        *source,
 521                                               gpointer        tag);
 522 GLIB_AVAILABLE_IN_2_36
 523 GIOCondition         g_source_query_unix_fd  (GSource        *source,
 524                                               gpointer        tag);
 525 #endif
 526
 527 /* Used to implement g_source_connect_closure and internally*/
 528 GLIB_AVAILABLE_IN_ALL
 529 void g_source_set_callback_indirect (GSource              *source,
 530                                      gpointer              callback_data,
 531                                      GSourceCallbackFuncs *callback_funcs);
 532
 533 GLIB_AVAILABLE_IN_ALL
 534 void     g_source_add_poll            (GSource        *source,
 535                                        GPollFD        *fd);
 536 GLIB_AVAILABLE_IN_ALL
 537 void     g_source_remove_poll         (GSource        *source,
 538                                        GPollFD        *fd);
 539
 540 GLIB_AVAILABLE_IN_ALL
 541 void     g_source_add_child_source    (GSource        *source,
 542                                        GSource        *child_source);
 543 GLIB_AVAILABLE_IN_ALL
 544 void     g_source_remove_child_source (GSource        *source,
 545                                        GSource        *child_source);
 546
 547 GLIB_DEPRECATED_IN_2_28_FOR(g_source_get_time)
 548 void     g_source_get_current_time (GSource        *source,
 549                                     GTimeVal       *timeval);
 550
 551 GLIB_AVAILABLE_IN_ALL
 552 gint64   g_source_get_time         (GSource        *source);
 553
 554  /* void g_source_connect_closure (GSource        *source,
 555                                   GClosure       *closure);
 556  */
 557
 558 /* Specific source types
 559  */
 560 GLIB_AVAILABLE_IN_ALL
 561 GSource *g_idle_source_new        (void);
 562 GLIB_AVAILABLE_IN_ALL
 563 GSource *g_child_watch_source_new (GPid pid);
 564 GLIB_AVAILABLE_IN_ALL
 565 GSource *g_timeout_source_new     (guint interval);
 566 GLIB_AVAILABLE_IN_ALL
 567 GSource *g_timeout_source_new_seconds (guint interval);
 568
 569 /* Miscellaneous functions
 570  */
 571 GLIB_AVAILABLE_IN_ALL
 572 void   g_get_current_time                 (GTimeVal       *result);
 573 GLIB_AVAILABLE_IN_ALL
 574 gint64 g_get_monotonic_time               (void);
 575 GLIB_AVAILABLE_IN_ALL
 576 gint64 g_get_real_time                    (void);
 577
 578
 579 /* Source manipulation by ID */
 580 GLIB_AVAILABLE_IN_ALL
 581 gboolean g_source_remove                     (guint          tag);
 582 GLIB_AVAILABLE_IN_ALL
 583 gboolean g_source_remove_by_user_data        (gpointer       user_data);
 584 GLIB_AVAILABLE_IN_ALL
 585 gboolean g_source_remove_by_funcs_user_data  (GSourceFuncs  *funcs,
 586                                               gpointer       user_data);
 587
 588 /**
 589  * GClearHandleFunc:
 590  * @handle_id: the handle ID to clear
 591  *
 592  * Specifies the type of function passed to g_clear_handle_id().
 593  * The implementation is expected to free the resource identified
 594  * by @handle_id; for instance, if @handle_id is a #GSource ID,
 595  * g_source_remove() can be used.
 596  *
 597  * Since: 2.56
 598  */
 599 typedef void (* GClearHandleFunc) (guint handle_id);
 600
 601 GLIB_AVAILABLE_IN_2_56
 602 void    g_clear_handle_id (guint           *tag_ptr,
 603                            GClearHandleFunc clear_func);
 604
 605 #define g_clear_handle_id(tag_ptr, clear_func)             \
 606   G_STMT_START {                                           \
 607     G_STATIC_ASSERT (sizeof *(tag_ptr) == sizeof (guint)); \
 608     guint *_tag_ptr = (guint *) (tag_ptr);                 \
 609     guint _handle_id;                                      \
 610                                                            \
 611     _handle_id = *_tag_ptr;                                \
 612     if (_handle_id > 0)                                    \
 613       {                                                    \
 614         *_tag_ptr = 0;                                     \
 615         clear_func (_handle_id);                           \
 616       }                                                    \
 617   } G_STMT_END
 618
 619 /* Idles, child watchers and timeouts */
 620 GLIB_AVAILABLE_IN_ALL
 621 guint    g_timeout_add_full         (gint            priority,
 622                                      guint           interval,
 623                                      GSourceFunc     function,
 624                                      gpointer        data,
 625                                      GDestroyNotify  notify);
 626 GLIB_AVAILABLE_IN_ALL
 627 guint    g_timeout_add              (guint           interval,
 628                                      GSourceFunc     function,
 629                                      gpointer        data);
 630 GLIB_AVAILABLE_IN_ALL
 631 guint    g_timeout_add_seconds_full (gint            priority,
 632                                      guint           interval,
 633                                      GSourceFunc     function,
 634                                      gpointer        data,
 635                                      GDestroyNotify  notify);
 636 GLIB_AVAILABLE_IN_ALL
 637 guint    g_timeout_add_seconds      (guint           interval,
 638                                      GSourceFunc     function,
 639                                      gpointer        data);
 640 GLIB_AVAILABLE_IN_ALL
 641 guint    g_child_watch_add_full     (gint            priority,
 642                                      GPid            pid,
 643                                      GChildWatchFunc function,
 644                                      gpointer        data,
 645                                      GDestroyNotify  notify);
 646 GLIB_AVAILABLE_IN_ALL
 647 guint    g_child_watch_add          (GPid            pid,
 648                                      GChildWatchFunc function,
 649                                      gpointer        data);
 650 GLIB_AVAILABLE_IN_ALL
 651 guint    g_idle_add                 (GSourceFunc     function,
 652                                      gpointer        data);
 653 GLIB_AVAILABLE_IN_ALL
 654 guint    g_idle_add_full            (gint            priority,
 655                                      GSourceFunc     function,
 656                                      gpointer        data,
 657                                      GDestroyNotify  notify);
 658 GLIB_AVAILABLE_IN_ALL
 659 gboolean g_idle_remove_by_data      (gpointer        data);
 660
 661 GLIB_AVAILABLE_IN_ALL
 662 void     g_main_context_invoke_full (GMainContext   *context,
 663                                      gint            priority,
 664                                      GSourceFunc     function,
 665                                      gpointer        data,
 666                                      GDestroyNotify  notify);
 667 GLIB_AVAILABLE_IN_ALL
 668 void     g_main_context_invoke      (GMainContext   *context,
 669                                      GSourceFunc     function,
 670                                      gpointer        data);
 671
 672 /* Hook for GClosure / GSource integration. Don't touch */
 673 GLIB_VAR GSourceFuncs g_timeout_funcs;
 674 GLIB_VAR GSourceFuncs g_child_watch_funcs;
 675 GLIB_VAR GSourceFuncs g_idle_funcs;
 676 #ifdef G_OS_UNIX
 677 GLIB_VAR GSourceFuncs g_unix_signal_funcs;
 678 GLIB_VAR GSourceFuncs g_unix_fd_source_funcs;
 679 #endif
 680
 681 G_END_DECLS
 682
 683 #endif /* __G_MAIN_H__ */