1/* GLIB - Library of useful routines for C programming
2 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
3 *
4 * SPDX-License-Identifier: LGPL-2.1-or-later
5 *
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
10 *
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
15 *
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, see <http://www.gnu.org/licenses/>.
18 */
19
20/*
21 * Modified by the GLib Team and others 1997-2000. See the AUTHORS
22 * file for a list of people on the GLib Team. See the ChangeLog
23 * files for a list of changes. These files are distributed with
24 * GLib at ftp://ftp.gtk.org/pub/gtk/.
25 */
26
27#ifndef __G_HOOK_H__
28#define __G_HOOK_H__
29
30#if !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
31#error "Only <glib.h> can be included directly."
32#endif
33
34#include <glib/gmem.h>
35
36G_BEGIN_DECLS
37
38
39/* --- typedefs --- */
40typedef struct _GHook GHook;
41typedef struct _GHookList GHookList;
42
43typedef gint (*GHookCompareFunc) (GHook *new_hook,
44 GHook *sibling);
45typedef gboolean (*GHookFindFunc) (GHook *hook,
46 gpointer data);
47typedef void (*GHookMarshaller) (GHook *hook,
48 gpointer marshal_data);
49typedef gboolean (*GHookCheckMarshaller) (GHook *hook,
50 gpointer marshal_data);
51typedef void (*GHookFunc) (gpointer data);
52typedef gboolean (*GHookCheckFunc) (gpointer data);
53typedef void (*GHookFinalizeFunc) (GHookList *hook_list,
54 GHook *hook);
55typedef enum
56{
57 G_HOOK_FLAG_ACTIVE = 1 << 0,
58 G_HOOK_FLAG_IN_CALL = 1 << 1,
59 G_HOOK_FLAG_RESERVED1 = 1 << 2, /*< private >*/
60 G_HOOK_FLAG_RESERVED2 = 1 << 3, /*< private >*/
61 G_HOOK_FLAG_MASK = 0x0f
62} G_GNUC_FLAG_ENUM GHookFlagMask;
63#define G_HOOK_FLAG_USER_SHIFT (4)
64
65
66/* --- structures --- */
67struct _GHookList
68{
69 gulong seq_id;
70 guint hook_size : 16;
71 guint is_setup : 1;
72 GHook *hooks;
73 gpointer dummy3;
74 GHookFinalizeFunc finalize_hook;
75 gpointer dummy[2];
76};
77struct _GHook
78{
79 gpointer data;
80 GHook *next;
81 GHook *prev;
82 guint ref_count;
83 gulong hook_id;
84 guint flags;
85 gpointer func;
86 GDestroyNotify destroy;
87};
88
89
90/* --- macros --- */
91#define G_HOOK(hook) ((GHook*) (hook))
92#define G_HOOK_FLAGS(hook) (G_HOOK (hook)->flags)
93#define G_HOOK_ACTIVE(hook) ((G_HOOK_FLAGS (hook) & \
94 G_HOOK_FLAG_ACTIVE) != 0)
95#define G_HOOK_IN_CALL(hook) ((G_HOOK_FLAGS (hook) & \
96 G_HOOK_FLAG_IN_CALL) != 0)
97#define G_HOOK_IS_VALID(hook) (G_HOOK (hook)->hook_id != 0 && \
98 (G_HOOK_FLAGS (hook) & \
99 G_HOOK_FLAG_ACTIVE))
100#define G_HOOK_IS_UNLINKED(hook) (G_HOOK (hook)->next == NULL && \
101 G_HOOK (hook)->prev == NULL && \
102 G_HOOK (hook)->hook_id == 0 && \
103 G_HOOK (hook)->ref_count == 0)
104
105
106/* --- prototypes --- */
107/* callback maintenance functions */
108GLIB_AVAILABLE_IN_ALL
109void g_hook_list_init (GHookList *hook_list,
110 guint hook_size);
111GLIB_AVAILABLE_IN_ALL
112void g_hook_list_clear (GHookList *hook_list);
113GLIB_AVAILABLE_IN_ALL
114GHook* g_hook_alloc (GHookList *hook_list);
115GLIB_AVAILABLE_IN_ALL
116void g_hook_free (GHookList *hook_list,
117 GHook *hook);
118GLIB_AVAILABLE_IN_ALL
119GHook * g_hook_ref (GHookList *hook_list,
120 GHook *hook);
121GLIB_AVAILABLE_IN_ALL
122void g_hook_unref (GHookList *hook_list,
123 GHook *hook);
124GLIB_AVAILABLE_IN_ALL
125gboolean g_hook_destroy (GHookList *hook_list,
126 gulong hook_id);
127GLIB_AVAILABLE_IN_ALL
128void g_hook_destroy_link (GHookList *hook_list,
129 GHook *hook);
130GLIB_AVAILABLE_IN_ALL
131void g_hook_prepend (GHookList *hook_list,
132 GHook *hook);
133GLIB_AVAILABLE_IN_ALL
134void g_hook_insert_before (GHookList *hook_list,
135 GHook *sibling,
136 GHook *hook);
137GLIB_AVAILABLE_IN_ALL
138void g_hook_insert_sorted (GHookList *hook_list,
139 GHook *hook,
140 GHookCompareFunc func);
141GLIB_AVAILABLE_IN_ALL
142GHook* g_hook_get (GHookList *hook_list,
143 gulong hook_id);
144GLIB_AVAILABLE_IN_ALL
145GHook* g_hook_find (GHookList *hook_list,
146 gboolean need_valids,
147 GHookFindFunc func,
148 gpointer data);
149GLIB_AVAILABLE_IN_ALL
150GHook* g_hook_find_data (GHookList *hook_list,
151 gboolean need_valids,
152 gpointer data);
153GLIB_AVAILABLE_IN_ALL
154GHook* g_hook_find_func (GHookList *hook_list,
155 gboolean need_valids,
156 gpointer func);
157GLIB_AVAILABLE_IN_ALL
158GHook* g_hook_find_func_data (GHookList *hook_list,
159 gboolean need_valids,
160 gpointer func,
161 gpointer data);
162/* return the first valid hook, and increment its reference count */
163GLIB_AVAILABLE_IN_ALL
164GHook* g_hook_first_valid (GHookList *hook_list,
165 gboolean may_be_in_call);
166/* return the next valid hook with incremented reference count, and
167 * decrement the reference count of the original hook
168 */
169GLIB_AVAILABLE_IN_ALL
170GHook* g_hook_next_valid (GHookList *hook_list,
171 GHook *hook,
172 gboolean may_be_in_call);
173/* GHookCompareFunc implementation to insert hooks sorted by their id */
174GLIB_AVAILABLE_IN_ALL
175gint g_hook_compare_ids (GHook *new_hook,
176 GHook *sibling);
177/* convenience macros */
178#define g_hook_append( hook_list, hook ) \
179 g_hook_insert_before ((hook_list), NULL, (hook))
180/* invoke all valid hooks with the (*GHookFunc) signature.
181 */
182GLIB_AVAILABLE_IN_ALL
183void g_hook_list_invoke (GHookList *hook_list,
184 gboolean may_recurse);
185/* invoke all valid hooks with the (*GHookCheckFunc) signature,
186 * and destroy the hook if FALSE is returned.
187 */
188GLIB_AVAILABLE_IN_ALL
189void g_hook_list_invoke_check (GHookList *hook_list,
190 gboolean may_recurse);
191/* invoke a marshaller on all valid hooks.
192 */
193GLIB_AVAILABLE_IN_ALL
194void g_hook_list_marshal (GHookList *hook_list,
195 gboolean may_recurse,
196 GHookMarshaller marshaller,
197 gpointer marshal_data);
198GLIB_AVAILABLE_IN_ALL
199void g_hook_list_marshal_check (GHookList *hook_list,
200 gboolean may_recurse,
201 GHookCheckMarshaller marshaller,
202 gpointer marshal_data);
203
204G_END_DECLS
205
206#endif /* __G_HOOK_H__ */
207