1 /* GLIB - Library of useful routines for C programming
2 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
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 of the License, or (at your option) any later version.
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.
14 * You should have received a copy of the GNU Lesser 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.
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/.
30 #include <glib/gmem.h>
35 /* --- typedefs --- */
36 typedef struct _GHook GHook
;
37 typedef struct _GHookList GHookList
;
39 typedef gint (*GHookCompareFunc
) (GHook
*new_hook
,
41 typedef gboolean (*GHookFindFunc
) (GHook
*hook
,
43 typedef void (*GHookMarshaller
) (GHook
*hook
,
44 gpointer marshal_data
);
45 typedef gboolean (*GHookCheckMarshaller
) (GHook
*hook
,
46 gpointer marshal_data
);
47 typedef void (*GHookFunc
) (gpointer data
);
48 typedef gboolean (*GHookCheckFunc
) (gpointer data
);
49 typedef void (*GHookFinalizeFunc
) (GHookList
*hook_list
,
53 G_HOOK_FLAG_ACTIVE
= 1 << 0,
54 G_HOOK_FLAG_IN_CALL
= 1 << 1,
55 G_HOOK_FLAG_MASK
= 0x0f
57 #define G_HOOK_FLAG_USER_SHIFT (4)
60 /* --- structures --- */
67 GMemChunk
*hook_memchunk
;
68 GHookFinalizeFunc finalize_hook
;
80 GDestroyNotify destroy
;
85 #define G_HOOK(hook) ((GHook*) (hook))
86 #define G_HOOK_FLAGS(hook) (G_HOOK (hook)->flags)
87 #define G_HOOK_ACTIVE(hook) ((G_HOOK_FLAGS (hook) & \
88 G_HOOK_FLAG_ACTIVE) != 0)
89 #define G_HOOK_IN_CALL(hook) ((G_HOOK_FLAGS (hook) & \
90 G_HOOK_FLAG_IN_CALL) != 0)
91 #define G_HOOK_IS_VALID(hook) (G_HOOK (hook)->hook_id != 0 && \
92 (G_HOOK_FLAGS (hook) & \
94 #define G_HOOK_IS_UNLINKED(hook) (G_HOOK (hook)->next == NULL && \
95 G_HOOK (hook)->prev == NULL && \
96 G_HOOK (hook)->hook_id == 0 && \
97 G_HOOK (hook)->ref_count == 0)
100 /* --- prototypes --- */
101 /* callback maintenance functions */
102 void g_hook_list_init (GHookList
*hook_list
,
104 void g_hook_list_clear (GHookList
*hook_list
);
105 GHook
* g_hook_alloc (GHookList
*hook_list
);
106 void g_hook_free (GHookList
*hook_list
,
108 GHook
* g_hook_ref (GHookList
*hook_list
,
110 void g_hook_unref (GHookList
*hook_list
,
112 gboolean
g_hook_destroy (GHookList
*hook_list
,
114 void g_hook_destroy_link (GHookList
*hook_list
,
116 void g_hook_prepend (GHookList
*hook_list
,
118 void g_hook_insert_before (GHookList
*hook_list
,
121 void g_hook_insert_sorted (GHookList
*hook_list
,
123 GHookCompareFunc func
);
124 GHook
* g_hook_get (GHookList
*hook_list
,
126 GHook
* g_hook_find (GHookList
*hook_list
,
127 gboolean need_valids
,
130 GHook
* g_hook_find_data (GHookList
*hook_list
,
131 gboolean need_valids
,
133 GHook
* g_hook_find_func (GHookList
*hook_list
,
134 gboolean need_valids
,
136 GHook
* g_hook_find_func_data (GHookList
*hook_list
,
137 gboolean need_valids
,
140 /* return the first valid hook, and increment its reference count */
141 GHook
* g_hook_first_valid (GHookList
*hook_list
,
142 gboolean may_be_in_call
);
143 /* return the next valid hook with incremented reference count, and
144 * decrement the reference count of the original hook
146 GHook
* g_hook_next_valid (GHookList
*hook_list
,
148 gboolean may_be_in_call
);
149 /* GHookCompareFunc implementation to insert hooks sorted by their id */
150 gint
g_hook_compare_ids (GHook
*new_hook
,
152 /* convenience macros */
153 #define g_hook_append( hook_list, hook ) \
154 g_hook_insert_before ((hook_list), NULL, (hook))
155 /* invoke all valid hooks with the (*GHookFunc) signature.
157 void g_hook_list_invoke (GHookList
*hook_list
,
158 gboolean may_recurse
);
159 /* invoke all valid hooks with the (*GHookCheckFunc) signature,
160 * and destroy the hook if FALSE is returned.
162 void g_hook_list_invoke_check (GHookList
*hook_list
,
163 gboolean may_recurse
);
164 /* invoke a marshaller on all valid hooks.
166 void g_hook_list_marshal (GHookList
*hook_list
,
167 gboolean may_recurse
,
168 GHookMarshaller marshaller
,
169 gpointer marshal_data
);
170 void g_hook_list_marshal_check (GHookList
*hook_list
,
171 gboolean may_recurse
,
172 GHookCheckMarshaller marshaller
,
173 gpointer marshal_data
);
177 #endif /* __G_HOOK_H__ */