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.
31 #define G_HOOKS_PREALLOC (16)
34 /* --- functions --- */
36 g_hook_list_init (GHookList *hook_list,
39 g_return_if_fail (hook_list != NULL);
40 g_return_if_fail (hook_size >= sizeof (GHook));
42 hook_list->seq_id = 1;
43 hook_list->hook_size = hook_size;
44 hook_list->is_setup = TRUE;
45 hook_list->hooks = NULL;
46 hook_list->hook_memchunk = g_mem_chunk_new ("GHook Memchunk",
48 hook_size * G_HOOKS_PREALLOC,
50 hook_list->hook_free = NULL;
51 hook_list->hook_destroy = NULL;
55 g_hook_list_clear (GHookList *hook_list)
57 g_return_if_fail (hook_list != NULL);
59 if (hook_list->is_setup)
63 hook_list->is_setup = FALSE;
65 hook = hook_list->hooks;
68 g_mem_chunk_destroy (hook_list->hook_memchunk);
69 hook_list->hook_memchunk = NULL;
76 g_hook_ref (hook_list, hook);
77 g_hook_destroy_link (hook_list, hook);
79 g_hook_unref (hook_list, hook);
87 g_hook_alloc (GHookList *hook_list)
91 g_return_val_if_fail (hook_list != NULL, NULL);
92 g_return_val_if_fail (hook_list->is_setup, NULL);
94 hook = g_chunk_new0 (GHook, hook_list->hook_memchunk);
98 hook->flags = G_HOOK_FLAG_ACTIVE;
102 hook->destroy = NULL;
108 g_hook_free (GHookList *hook_list,
111 g_return_if_fail (hook_list != NULL);
112 g_return_if_fail (hook_list->is_setup);
113 g_return_if_fail (hook != NULL);
114 g_return_if_fail (G_HOOK_IS_UNLINKED (hook));
116 if (hook_list->hook_free)
117 hook_list->hook_free (hook_list, hook);
119 g_chunk_free (hook, hook_list->hook_memchunk);
123 g_hook_destroy_link (GHookList *hook_list,
126 g_return_if_fail (hook_list != NULL);
127 g_return_if_fail (hook != NULL);
132 hook->flags &= ~G_HOOK_FLAG_ACTIVE;
133 if (hook_list->hook_destroy)
134 hook_list->hook_destroy (hook_list, hook);
135 else if (hook->destroy)
137 hook->destroy (hook->data);
138 hook->destroy = NULL;
140 g_hook_unref (hook_list, hook); /* counterpart to g_hook_insert_before */
145 g_hook_destroy (GHookList *hook_list,
150 g_return_val_if_fail (hook_list != NULL, FALSE);
151 g_return_val_if_fail (hook_id > 0, FALSE);
153 hook = g_hook_get (hook_list, hook_id);
156 g_hook_destroy_link (hook_list, hook);
164 g_hook_unref (GHookList *hook_list,
167 g_return_if_fail (hook_list != NULL);
168 g_return_if_fail (hook != NULL);
169 g_return_if_fail (hook->ref_count > 0);
172 if (!hook->ref_count)
174 g_return_if_fail (hook->hook_id == 0);
175 g_return_if_fail (!G_HOOK_IN_CALL (hook));
178 hook->prev->next = hook->next;
180 hook_list->hooks = hook->next;
183 hook->next->prev = hook->prev;
188 g_hook_free (hook_list, hook);
190 if (!hook_list->hooks &&
191 !hook_list->is_setup)
193 g_mem_chunk_destroy (hook_list->hook_memchunk);
194 hook_list->hook_memchunk = NULL;
200 g_hook_ref (GHookList *hook_list,
203 g_return_if_fail (hook_list != NULL);
204 g_return_if_fail (hook != NULL);
205 g_return_if_fail (hook->ref_count > 0);
211 g_hook_prepend (GHookList *hook_list,
214 g_return_if_fail (hook_list != NULL);
216 g_hook_insert_before (hook_list, hook_list->hooks, hook);
220 g_hook_insert_before (GHookList *hook_list,
224 g_return_if_fail (hook_list != NULL);
225 g_return_if_fail (hook_list->is_setup);
226 g_return_if_fail (hook != NULL);
227 g_return_if_fail (G_HOOK_IS_UNLINKED (hook));
228 g_return_if_fail (hook->func != NULL);
230 hook->hook_id = hook_list->seq_id++;
231 hook->ref_count = 1; /* counterpart to g_hook_destroy_link */
237 hook->prev = sibling->prev;
238 hook->prev->next = hook;
239 hook->next = sibling;
240 sibling->prev = hook;
244 hook_list->hooks = hook;
245 hook->next = sibling;
246 sibling->prev = hook;
251 if (hook_list->hooks)
253 sibling = hook_list->hooks;
254 while (sibling->next)
255 sibling = sibling->next;
256 hook->prev = sibling;
257 sibling->next = hook;
260 hook_list->hooks = hook;
265 g_hook_list_invoke (GHookList *hook_list,
266 gboolean may_recurse)
270 g_return_if_fail (hook_list != NULL);
271 g_return_if_fail (hook_list->is_setup);
273 hook = g_hook_first_valid (hook_list, may_recurse);
277 gboolean was_in_call;
279 func = (GHookFunc) hook->func;
281 was_in_call = G_HOOK_IN_CALL (hook);
282 hook->flags |= G_HOOK_FLAG_IN_CALL;
285 hook->flags &= ~G_HOOK_FLAG_IN_CALL;
287 hook = g_hook_next_valid (hook_list, hook, may_recurse);
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);
304 gboolean was_in_call;
305 gboolean need_destroy;
307 func = (GHookCheckFunc) hook->func;
309 was_in_call = G_HOOK_IN_CALL (hook);
310 hook->flags |= G_HOOK_FLAG_IN_CALL;
311 need_destroy = !func (hook->data);
313 hook->flags &= ~G_HOOK_FLAG_IN_CALL;
315 g_hook_destroy_link (hook_list, hook);
317 hook = g_hook_next_valid (hook_list, hook, may_recurse);
322 g_hook_list_marshal_check (GHookList *hook_list,
323 gboolean may_recurse,
324 GHookCheckMarshaller marshaller,
329 g_return_if_fail (hook_list != NULL);
330 g_return_if_fail (hook_list->is_setup);
331 g_return_if_fail (marshaller != NULL);
333 hook = g_hook_first_valid (hook_list, may_recurse);
336 gboolean was_in_call;
337 gboolean need_destroy;
339 was_in_call = G_HOOK_IN_CALL (hook);
340 hook->flags |= G_HOOK_FLAG_IN_CALL;
341 need_destroy = !marshaller (hook, data);
343 hook->flags &= ~G_HOOK_FLAG_IN_CALL;
345 g_hook_destroy_link (hook_list, hook);
347 hook = g_hook_next_valid (hook_list, hook, may_recurse);
352 g_hook_list_marshal (GHookList *hook_list,
353 gboolean may_recurse,
354 GHookMarshaller marshaller,
359 g_return_if_fail (hook_list != NULL);
360 g_return_if_fail (hook_list->is_setup);
361 g_return_if_fail (marshaller != NULL);
363 hook = g_hook_first_valid (hook_list, may_recurse);
366 gboolean was_in_call;
368 was_in_call = G_HOOK_IN_CALL (hook);
369 hook->flags |= G_HOOK_FLAG_IN_CALL;
370 marshaller (hook, data);
372 hook->flags &= ~G_HOOK_FLAG_IN_CALL;
374 hook = g_hook_next_valid (hook_list, hook, may_recurse);
379 g_hook_first_valid (GHookList *hook_list,
380 gboolean may_be_in_call)
382 g_return_val_if_fail (hook_list != NULL, NULL);
384 if (hook_list->is_setup)
388 hook = hook_list->hooks;
391 g_hook_ref (hook_list, hook);
392 if (G_HOOK_IS_VALID (hook) && (may_be_in_call || !G_HOOK_IN_CALL (hook)))
395 return g_hook_next_valid (hook_list, hook, may_be_in_call);
403 g_hook_next_valid (GHookList *hook_list,
405 gboolean may_be_in_call)
409 g_return_val_if_fail (hook_list != NULL, NULL);
417 if (G_HOOK_IS_VALID (hook) && (may_be_in_call || !G_HOOK_IN_CALL (hook)))
419 g_hook_ref (hook_list, hook);
420 g_hook_unref (hook_list, ohook);
426 g_hook_unref (hook_list, ohook);
432 g_hook_get (GHookList *hook_list,
437 g_return_val_if_fail (hook_list != NULL, NULL);
438 g_return_val_if_fail (hook_id > 0, NULL);
440 hook = hook_list->hooks;
443 if (hook->hook_id == hook_id)
452 g_hook_find (GHookList *hook_list,
453 gboolean need_valids,
459 g_return_val_if_fail (hook_list != NULL, NULL);
460 g_return_val_if_fail (func != NULL, NULL);
462 hook = hook_list->hooks;
467 /* test only non-destroyed hooks */
474 g_hook_ref (hook_list, hook);
476 if (func (hook, data) && hook->hook_id && (!need_valids || G_HOOK_ACTIVE (hook)))
478 g_hook_unref (hook_list, hook);
484 g_hook_unref (hook_list, hook);
492 g_hook_find_data (GHookList *hook_list,
493 gboolean need_valids,
498 g_return_val_if_fail (hook_list != NULL, NULL);
500 hook = hook_list->hooks;
503 /* test only non-destroyed hooks */
504 if (hook->data == data &&
506 (!need_valids || G_HOOK_ACTIVE (hook)))
516 g_hook_find_func (GHookList *hook_list,
517 gboolean need_valids,
522 g_return_val_if_fail (hook_list != NULL, NULL);
523 g_return_val_if_fail (func != NULL, NULL);
525 hook = hook_list->hooks;
528 /* test only non-destroyed hooks */
529 if (hook->func == func &&
531 (!need_valids || G_HOOK_ACTIVE (hook)))
541 g_hook_find_func_data (GHookList *hook_list,
542 gboolean need_valids,
548 g_return_val_if_fail (hook_list != NULL, NULL);
549 g_return_val_if_fail (func != NULL, NULL);
551 hook = hook_list->hooks;
554 /* test only non-destroyed hooks */
555 if (hook->data == data &&
556 hook->func == func &&
558 (!need_valids || G_HOOK_ACTIVE (hook)))
568 g_hook_insert_sorted (GHookList *hook_list,
570 GHookCompareFunc func)
574 g_return_if_fail (hook_list != NULL);
575 g_return_if_fail (hook_list->is_setup);
576 g_return_if_fail (hook != NULL);
577 g_return_if_fail (G_HOOK_IS_UNLINKED (hook));
578 g_return_if_fail (hook->func != NULL);
579 g_return_if_fail (func != NULL);
581 /* first non-destroyed hook */
582 sibling = hook_list->hooks;
583 while (sibling && !sibling->hook_id)
584 sibling = sibling->next;
590 g_hook_ref (hook_list, sibling);
591 if (func (hook, sibling) <= 0 && sibling->hook_id)
593 g_hook_unref (hook_list, sibling);
597 /* next non-destroyed hook */
599 while (tmp && !tmp->hook_id)
602 g_hook_unref (hook_list, sibling);
606 g_hook_insert_before (hook_list, sibling, hook);
610 g_hook_compare_ids (GHook *new_hook,
613 return ((glong) new_hook->hook_id) - ((glong) sibling->hook_id);