1/* GLIB - Library of useful routines for C programming
2 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
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
15 * License along with this library; if not, see <http://www.gnu.org/licenses/>.
16 */
17
18/*
19 * Modified by the GLib Team and others 1997-2000. See the AUTHORS
20 * file for a list of people on the GLib Team. See the ChangeLog
21 * files for a list of changes. These files are distributed with
22 * GLib at ftp://ftp.gtk.org/pub/gtk/.
23 */
24
25#ifndef __G_DEPRECATED_MAIN_H__
26#define __G_DEPRECATED_MAIN_H__
27
28#if !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
29#error "Only <glib.h> can be included directly."
30#endif
31
32#include <glib/gmain.h>
33
34G_BEGIN_DECLS
35
36/* ============== Compat main loop stuff ================== */
37
38/**
39 * g_main_new:
40 * @is_running: set to %TRUE to indicate that the loop is running. This
41 * is not very important since calling g_main_run() will set this
42 * to %TRUE anyway.
43 *
44 * Creates a new #GMainLoop for th default main context.
45 *
46 * Returns: a new #GMainLoop
47 *
48 * Deprecated: 2.2: Use g_main_loop_new() instead
49 */
50#define g_main_new(is_running) g_main_loop_new (NULL, is_running) GLIB_DEPRECATED_MACRO_IN_2_26_FOR(g_main_loop_new)
51
52/**
53 * g_main_run:
54 * @loop: a #GMainLoop
55 *
56 * Runs a main loop until it stops running.
57 *
58 * Deprecated: 2.2: Use g_main_loop_run() instead
59 */
60#define g_main_run(loop) g_main_loop_run(loop) GLIB_DEPRECATED_MACRO_IN_2_26_FOR(g_main_loop_run)
61
62/**
63 * g_main_quit:
64 * @loop: a #GMainLoop
65 *
66 * Stops the #GMainLoop.
67 * If g_main_run() was called to run the #GMainLoop, it will now return.
68 *
69 * Deprecated: 2.2: Use g_main_loop_quit() instead
70 */
71#define g_main_quit(loop) g_main_loop_quit(loop) GLIB_DEPRECATED_MACRO_IN_2_26_FOR(g_main_loop_quit)
72
73/**
74 * g_main_destroy:
75 * @loop: a #GMainLoop
76 *
77 * Frees the memory allocated for the #GMainLoop.
78 *
79 * Deprecated: 2.2: Use g_main_loop_unref() instead
80 */
81#define g_main_destroy(loop) g_main_loop_unref(loop) GLIB_DEPRECATED_MACRO_IN_2_26_FOR(g_main_loop_unref)
82
83/**
84 * g_main_is_running:
85 * @loop: a #GMainLoop
86 *
87 * Checks if the main loop is running.
88 *
89 * Returns: %TRUE if the main loop is running
90 *
91 * Deprecated: 2.2: Use g_main_loop_is_running() instead
92 */
93#define g_main_is_running(loop) g_main_loop_is_running(loop) GLIB_DEPRECATED_MACRO_IN_2_26_FOR(g_main_loop_is_running)
94
95/**
96 * g_main_iteration:
97 * @may_block: set to %TRUE if it should block (i.e. wait) until an event
98 * source becomes ready. It will return after an event source has been
99 * processed. If set to %FALSE it will return immediately if no event
100 * source is ready to be processed.
101 *
102 * Runs a single iteration for the default #GMainContext.
103 *
104 * Returns: %TRUE if more events are pending.
105 *
106 * Deprecated: 2.2: Use g_main_context_iteration() instead.
107 */
108#define g_main_iteration(may_block) g_main_context_iteration (NULL, may_block) GLIB_DEPRECATED_MACRO_IN_2_26_FOR(g_main_context_iteration)
109
110/**
111 * g_main_pending:
112 *
113 * Checks if any events are pending for the default #GMainContext
114 * (i.e. ready to be processed).
115 *
116 * Returns: %TRUE if any events are pending.
117 *
118 * Deprecated: 2.2: Use g_main_context_pending() instead.
119 */
120#define g_main_pending() g_main_context_pending (NULL) GLIB_DEPRECATED_MACRO_IN_2_26_FOR(g_main_context_pending)
121
122/**
123 * g_main_set_poll_func:
124 * @func: the function to call to poll all file descriptors
125 *
126 * Sets the function to use for the handle polling of file descriptors
127 * for the default main context.
128 *
129 * Deprecated: 2.2: Use g_main_context_set_poll_func() again
130 */
131#define g_main_set_poll_func(func) g_main_context_set_poll_func (NULL, func) GLIB_DEPRECATED_MACRO_IN_2_26_FOR(g_main_context_set_poll_func)
132
133G_END_DECLS
134
135#endif /* __G_DEPRECATED_MAIN_H__ */
136