1 /* GLIB - Library of useful routines for C programming
2 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
4 * GHook: Callback maintenance functions
5 * Copyright (C) 1998 Tim Janik
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Library General Public
9 * License as published by the Free Software Foundation; either
10 * version 2 of the License, or (at your option) any later version.
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Library General Public License for more details.
17 * You should have received a copy of the GNU Library General Public
18 * License along with this library; if not, write to the
19 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 * Boston, MA 02111-1307, USA.
26 #define G_HOOKS_PREALLOC (16)
29 /* --- functions --- */
31 g_hook_list_init (GHookList *hook_list,
34 g_return_if_fail (hook_list != NULL);
35 g_return_if_fail (hook_size >= sizeof (GHook));
37 hook_list->seq_id = 1;
38 hook_list->hook_size = hook_size;
39 hook_list->is_setup = TRUE;
40 hook_list->hooks = NULL;
41 hook_list->hook_memchunk = g_mem_chunk_new ("GHook Memchunk",
43 hook_size * G_HOOKS_PREALLOC,
45 hook_list->hook_free = NULL;
49 g_hook_list_clear (GHookList *hook_list)
51 g_return_if_fail (hook_list != NULL);
53 if (hook_list->is_setup)
57 hook_list->is_setup = FALSE;
59 hook = hook_list->hooks;
62 g_mem_chunk_destroy (hook_list->hook_memchunk);
63 hook_list->hook_memchunk = NULL;
70 g_hook_ref (hook_list, hook);
71 g_hook_destroy_link (hook_list, hook);
73 g_hook_unref (hook_list, hook);
81 g_hook_alloc (GHookList *hook_list)
85 g_return_val_if_fail (hook_list != NULL, NULL);
86 g_return_val_if_fail (hook_list->is_setup, NULL);
88 hook = g_chunk_new0 (GHook, hook_list->hook_memchunk);
92 hook->flags = G_HOOK_FLAG_ACTIVE;
102 g_hook_free (GHookList *hook_list,
105 g_return_if_fail (hook_list != NULL);
106 g_return_if_fail (hook_list->is_setup);
107 g_return_if_fail (hook != NULL);
108 g_return_if_fail (G_HOOK_IS_UNLINKED (hook));
110 if (hook_list->hook_free)
111 hook_list->hook_free (hook_list, hook);
113 g_chunk_free (hook, hook_list->hook_memchunk);
117 g_hook_destroy_link (GHookList *hook_list,
120 g_return_if_fail (hook_list != NULL);
121 g_return_if_fail (hook != NULL);
126 hook->flags &= ~G_HOOK_FLAG_ACTIVE;
129 GDestroyNotify destroy;
131 destroy = hook->destroy;
132 hook->destroy = NULL;
133 destroy (hook->data);
135 g_hook_unref (hook_list, hook); /* counterpart to g_hook_insert_before */
140 g_hook_destroy (GHookList *hook_list,
145 g_return_val_if_fail (hook_list != NULL, FALSE);
146 g_return_val_if_fail (hook_id > 0, FALSE);
148 hook = g_hook_get (hook_list, hook_id);
151 g_hook_destroy_link (hook_list, hook);
159 g_hook_unref (GHookList *hook_list,
162 g_return_if_fail (hook_list != NULL);
163 g_return_if_fail (hook != NULL);
164 g_return_if_fail (hook->ref_count > 0);
167 if (!hook->ref_count)
169 g_return_if_fail (hook->hook_id == 0);
170 g_return_if_fail (!G_HOOK_IN_CALL (hook));
173 hook->prev->next = hook->next;
175 hook_list->hooks = hook->next;
178 hook->next->prev = hook->prev;
183 g_hook_free (hook_list, hook);
185 if (!hook_list->hooks &&
186 !hook_list->is_setup)
188 g_mem_chunk_destroy (hook_list->hook_memchunk);
189 hook_list->hook_memchunk = NULL;
195 g_hook_ref (GHookList *hook_list,
198 g_return_if_fail (hook_list != NULL);
199 g_return_if_fail (hook != NULL);
200 g_return_if_fail (hook->ref_count > 0);
206 g_hook_prepend (GHookList *hook_list,
209 g_return_if_fail (hook_list != NULL);
211 g_hook_insert_before (hook_list, hook_list->hooks, hook);
215 g_hook_insert_before (GHookList *hook_list,
219 g_return_if_fail (hook_list != NULL);
220 g_return_if_fail (hook_list->is_setup);
221 g_return_if_fail (hook != NULL);
222 g_return_if_fail (G_HOOK_IS_UNLINKED (hook));
223 g_return_if_fail (hook->func != NULL);
225 hook->hook_id = hook_list->seq_id++;
226 hook->ref_count = 1; /* counterpart to g_hook_destroy_link */
232 hook->prev = sibling->prev;
233 hook->prev->next = hook;
234 hook->next = sibling;
235 sibling->prev = hook;
239 hook_list->hooks = hook;
240 hook->next = sibling;
241 sibling->prev = hook;
246 if (hook_list->hooks)
248 sibling = hook_list->hooks;
249 while (sibling->next)
250 sibling = sibling->next;
251 hook->prev = sibling;
252 sibling->next = hook;
255 hook_list->hooks = hook;
260 g_hook_list_invoke (GHookList *hook_list,
261 gboolean may_recurse)
265 g_return_if_fail (hook_list != NULL);
266 g_return_if_fail (hook_list->is_setup);
268 hook = g_hook_first_valid (hook_list, may_recurse);
273 gboolean was_in_call;
275 g_hook_ref (hook_list, hook);
276 func = (GHookFunc) hook->func;
278 was_in_call = G_HOOK_IN_CALL (hook);
279 hook->flags |= G_HOOK_FLAG_IN_CALL;
282 hook->flags &= ~G_HOOK_FLAG_IN_CALL;
284 tmp = g_hook_next_valid (hook, may_recurse);
286 g_hook_unref (hook_list, hook);
292 g_hook_list_invoke_check (GHookList *hook_list,
293 gboolean may_recurse)
297 g_return_if_fail (hook_list != NULL);
298 g_return_if_fail (hook_list->is_setup);
300 hook = g_hook_first_valid (hook_list, may_recurse);
305 gboolean was_in_call;
306 gboolean need_destroy;
308 g_hook_ref (hook_list, hook);
309 func = (GHookCheckFunc) hook->func;
311 was_in_call = G_HOOK_IN_CALL (hook);
312 hook->flags |= G_HOOK_FLAG_IN_CALL;
313 need_destroy = !func (hook->data);
315 hook->flags &= ~G_HOOK_FLAG_IN_CALL;
317 g_hook_destroy_link (hook_list, hook);
319 tmp = g_hook_next_valid (hook, may_recurse);
321 g_hook_unref (hook_list, hook);
327 g_hook_list_marshal_check (GHookList *hook_list,
328 gboolean may_recurse,
329 GHookCheckMarshaller marshaller,
334 g_return_if_fail (hook_list != NULL);
335 g_return_if_fail (hook_list->is_setup);
336 g_return_if_fail (marshaller != NULL);
338 hook = g_hook_first_valid (hook_list, may_recurse);
342 gboolean was_in_call;
343 gboolean need_destroy;
345 g_hook_ref (hook_list, hook);
347 was_in_call = G_HOOK_IN_CALL (hook);
348 hook->flags |= G_HOOK_FLAG_IN_CALL;
349 need_destroy = !marshaller (hook, data);
351 hook->flags &= ~G_HOOK_FLAG_IN_CALL;
353 g_hook_destroy_link (hook_list, hook);
355 tmp = g_hook_next_valid (hook, may_recurse);
357 g_hook_unref (hook_list, hook);
363 g_hook_list_marshal (GHookList *hook_list,
364 gboolean may_recurse,
365 GHookMarshaller marshaller,
370 g_return_if_fail (hook_list != NULL);
371 g_return_if_fail (hook_list->is_setup);
372 g_return_if_fail (marshaller != NULL);
374 hook = g_hook_first_valid (hook_list, may_recurse);
378 gboolean was_in_call;
380 g_hook_ref (hook_list, hook);
382 was_in_call = G_HOOK_IN_CALL (hook);
383 hook->flags |= G_HOOK_FLAG_IN_CALL;
384 marshaller (hook, data);
386 hook->flags &= ~G_HOOK_FLAG_IN_CALL;
388 tmp = g_hook_next_valid (hook, may_recurse);
390 g_hook_unref (hook_list, hook);
396 g_hook_first_valid (GHookList *hook_list,
397 gboolean may_be_in_call)
399 g_return_val_if_fail (hook_list != NULL, NULL);
401 if (hook_list->is_setup)
405 hook = hook_list->hooks;
408 if (G_HOOK_IS_VALID (hook) && (may_be_in_call || !G_HOOK_IN_CALL (hook)))
411 return g_hook_next_valid (hook, may_be_in_call);
419 g_hook_next_valid (GHook *hook,
420 gboolean may_be_in_call)
428 if (G_HOOK_IS_VALID (hook) && (may_be_in_call || !G_HOOK_IN_CALL (hook)))
437 g_hook_get (GHookList *hook_list,
442 g_return_val_if_fail (hook_list != NULL, NULL);
443 g_return_val_if_fail (hook_id > 0, NULL);
445 hook = hook_list->hooks;
448 if (hook->hook_id == hook_id)
457 g_hook_find (GHookList *hook_list,
458 gboolean need_valids,
464 g_return_val_if_fail (hook_list != NULL, NULL);
465 g_return_val_if_fail (func != NULL, NULL);
467 hook = hook_list->hooks;
472 /* test only non-destroyed hooks */
479 g_hook_ref (hook_list, hook);
481 if (func (hook, data) && hook->hook_id && (!need_valids || G_HOOK_ACTIVE (hook)))
483 g_hook_unref (hook_list, hook);
489 g_hook_unref (hook_list, hook);
497 g_hook_find_data (GHookList *hook_list,
498 gboolean need_valids,
503 g_return_val_if_fail (hook_list != NULL, NULL);
505 hook = hook_list->hooks;
508 /* test only non-destroyed hooks */
509 if (hook->data == data &&
511 (!need_valids || G_HOOK_ACTIVE (hook)))
521 g_hook_find_func (GHookList *hook_list,
522 gboolean need_valids,
527 g_return_val_if_fail (hook_list != NULL, NULL);
528 g_return_val_if_fail (func != NULL, NULL);
530 hook = hook_list->hooks;
533 /* test only non-destroyed hooks */
534 if (hook->func == func &&
536 (!need_valids || G_HOOK_ACTIVE (hook)))
546 g_hook_find_func_data (GHookList *hook_list,
547 gboolean need_valids,
553 g_return_val_if_fail (hook_list != NULL, NULL);
554 g_return_val_if_fail (func != NULL, NULL);
556 hook = hook_list->hooks;
559 /* test only non-destroyed hooks */
560 if (hook->data == data &&
561 hook->func == func &&
563 (!need_valids || G_HOOK_ACTIVE (hook)))
573 g_hook_insert_sorted (GHookList *hook_list,
575 GHookCompareFunc func)
579 g_return_if_fail (hook_list != NULL);
580 g_return_if_fail (hook_list->is_setup);
581 g_return_if_fail (hook != NULL);
582 g_return_if_fail (G_HOOK_IS_UNLINKED (hook));
583 g_return_if_fail (hook->func != NULL);
584 g_return_if_fail (func != NULL);
586 /* first non-destroyed hook */
587 sibling = hook_list->hooks;
588 while (sibling && !sibling->hook_id)
589 sibling = sibling->next;
595 g_hook_ref (hook_list, sibling);
596 if (func (hook, sibling) <= 0 && sibling->hook_id)
598 g_hook_unref (hook_list, sibling);
602 /* next non-destroyed hook */
604 while (tmp && !tmp->hook_id)
607 g_hook_unref (hook_list, sibling);
611 g_hook_insert_before (hook_list, sibling, hook);
615 g_hook_compare_ids (GHook *new_hook,
618 return ((glong) new_hook->hook_id) - ((glong) sibling->hook_id);