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 Lesser 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 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser 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.
24 * Modified by the GLib Team and others 1997-2000. See the AUTHORS
25 * file for a list of people on the GLib Team. See the ChangeLog
26 * files for a list of changes. These files are distributed with
27 * GLib at ftp://ftp.gtk.org/pub/gtk/.
38 #define G_HOOKS_PREALLOC (16)
41 /* --- functions --- */
43 default_finalize_hook (GHookList
*hook_list
,
46 GDestroyNotify destroy
= hook
->destroy
;
56 g_hook_list_init (GHookList
*hook_list
,
59 g_return_if_fail (hook_list
!= NULL
);
60 g_return_if_fail (hook_size
>= sizeof (GHook
));
61 g_return_if_fail (hook_size
< 65536);
63 hook_list
->seq_id
= 1;
64 hook_list
->hook_size
= hook_size
;
65 hook_list
->is_setup
= TRUE
;
66 hook_list
->hooks
= NULL
;
67 hook_list
->hook_memchunk
= g_mem_chunk_new ("GHook Memchunk",
69 hook_size
* G_HOOKS_PREALLOC
,
71 hook_list
->finalize_hook
= default_finalize_hook
;
75 g_hook_list_clear (GHookList
*hook_list
)
77 g_return_if_fail (hook_list
!= NULL
);
79 if (hook_list
->is_setup
)
83 hook_list
->is_setup
= FALSE
;
85 hook
= hook_list
->hooks
;
88 g_mem_chunk_destroy (hook_list
->hook_memchunk
);
89 hook_list
->hook_memchunk
= NULL
;
96 g_hook_ref (hook_list
, hook
);
97 g_hook_destroy_link (hook_list
, hook
);
99 g_hook_unref (hook_list
, hook
);
103 if (hook_list
->hook_memchunk
)
104 g_warning (G_STRLOC
": failed to clear hooklist, unconsolidated references on hooks left");
109 g_hook_alloc (GHookList
*hook_list
)
113 g_return_val_if_fail (hook_list
!= NULL
, NULL
);
114 g_return_val_if_fail (hook_list
->is_setup
, NULL
);
116 hook
= g_chunk_new0 (GHook
, hook_list
->hook_memchunk
);
120 hook
->flags
= G_HOOK_FLAG_ACTIVE
;
124 hook
->destroy
= NULL
;
130 g_hook_free (GHookList
*hook_list
,
133 g_return_if_fail (hook_list
!= NULL
);
134 g_return_if_fail (hook_list
->is_setup
);
135 g_return_if_fail (hook
!= NULL
);
136 g_return_if_fail (G_HOOK_IS_UNLINKED (hook
));
137 g_return_if_fail (!G_HOOK_IN_CALL (hook
));
139 hook_list
->finalize_hook (hook_list
, hook
);
140 g_chunk_free (hook
, hook_list
->hook_memchunk
);
144 g_hook_destroy_link (GHookList
*hook_list
,
147 g_return_if_fail (hook_list
!= NULL
);
148 g_return_if_fail (hook
!= NULL
);
150 hook
->flags
&= ~G_HOOK_FLAG_ACTIVE
;
154 g_hook_unref (hook_list
, hook
); /* counterpart to g_hook_insert_before */
159 g_hook_destroy (GHookList
*hook_list
,
164 g_return_val_if_fail (hook_list
!= NULL
, FALSE
);
165 g_return_val_if_fail (hook_id
> 0, FALSE
);
167 hook
= g_hook_get (hook_list
, hook_id
);
170 g_hook_destroy_link (hook_list
, hook
);
178 g_hook_unref (GHookList
*hook_list
,
181 g_return_if_fail (hook_list
!= NULL
);
182 g_return_if_fail (hook_list
->hook_memchunk
!= NULL
);
183 g_return_if_fail (hook
!= NULL
);
184 g_return_if_fail (hook
->ref_count
> 0);
187 if (!hook
->ref_count
)
189 g_return_if_fail (hook
->hook_id
== 0);
190 g_return_if_fail (!G_HOOK_IN_CALL (hook
));
193 hook
->prev
->next
= hook
->next
;
195 hook_list
->hooks
= hook
->next
;
198 hook
->next
->prev
= hook
->prev
;
203 if (!hook_list
->is_setup
)
205 hook_list
->is_setup
= TRUE
;
206 g_hook_free (hook_list
, hook
);
207 hook_list
->is_setup
= FALSE
;
209 if (!hook_list
->hooks
)
211 g_mem_chunk_destroy (hook_list
->hook_memchunk
);
212 hook_list
->hook_memchunk
= NULL
;
216 g_hook_free (hook_list
, hook
);
221 g_hook_ref (GHookList
*hook_list
,
224 g_return_if_fail (hook_list
!= NULL
);
225 g_return_if_fail (hook
!= NULL
);
226 g_return_if_fail (hook
->ref_count
> 0);
232 g_hook_prepend (GHookList
*hook_list
,
235 g_return_if_fail (hook_list
!= NULL
);
237 g_hook_insert_before (hook_list
, hook_list
->hooks
, hook
);
241 g_hook_insert_before (GHookList
*hook_list
,
245 g_return_if_fail (hook_list
!= NULL
);
246 g_return_if_fail (hook_list
->is_setup
);
247 g_return_if_fail (hook
!= NULL
);
248 g_return_if_fail (G_HOOK_IS_UNLINKED (hook
));
249 g_return_if_fail (hook
->ref_count
== 0);
251 hook
->hook_id
= hook_list
->seq_id
++;
252 hook
->ref_count
= 1; /* counterpart to g_hook_destroy_link */
258 hook
->prev
= sibling
->prev
;
259 hook
->prev
->next
= hook
;
260 hook
->next
= sibling
;
261 sibling
->prev
= hook
;
265 hook_list
->hooks
= hook
;
266 hook
->next
= sibling
;
267 sibling
->prev
= hook
;
272 if (hook_list
->hooks
)
274 sibling
= hook_list
->hooks
;
275 while (sibling
->next
)
276 sibling
= sibling
->next
;
277 hook
->prev
= sibling
;
278 sibling
->next
= hook
;
281 hook_list
->hooks
= hook
;
286 g_hook_list_invoke (GHookList
*hook_list
,
287 gboolean may_recurse
)
291 g_return_if_fail (hook_list
!= NULL
);
292 g_return_if_fail (hook_list
->is_setup
);
294 hook
= g_hook_first_valid (hook_list
, may_recurse
);
298 gboolean was_in_call
;
300 func
= (GHookFunc
) hook
->func
;
302 was_in_call
= G_HOOK_IN_CALL (hook
);
303 hook
->flags
|= G_HOOK_FLAG_IN_CALL
;
306 hook
->flags
&= ~G_HOOK_FLAG_IN_CALL
;
308 hook
= g_hook_next_valid (hook_list
, hook
, may_recurse
);
313 g_hook_list_invoke_check (GHookList
*hook_list
,
314 gboolean may_recurse
)
318 g_return_if_fail (hook_list
!= NULL
);
319 g_return_if_fail (hook_list
->is_setup
);
321 hook
= g_hook_first_valid (hook_list
, may_recurse
);
325 gboolean was_in_call
;
326 gboolean need_destroy
;
328 func
= (GHookCheckFunc
) hook
->func
;
330 was_in_call
= G_HOOK_IN_CALL (hook
);
331 hook
->flags
|= G_HOOK_FLAG_IN_CALL
;
332 need_destroy
= !func (hook
->data
);
334 hook
->flags
&= ~G_HOOK_FLAG_IN_CALL
;
336 g_hook_destroy_link (hook_list
, hook
);
338 hook
= g_hook_next_valid (hook_list
, hook
, may_recurse
);
343 g_hook_list_marshal_check (GHookList
*hook_list
,
344 gboolean may_recurse
,
345 GHookCheckMarshaller marshaller
,
350 g_return_if_fail (hook_list
!= NULL
);
351 g_return_if_fail (hook_list
->is_setup
);
352 g_return_if_fail (marshaller
!= NULL
);
354 hook
= g_hook_first_valid (hook_list
, may_recurse
);
357 gboolean was_in_call
;
358 gboolean need_destroy
;
360 was_in_call
= G_HOOK_IN_CALL (hook
);
361 hook
->flags
|= G_HOOK_FLAG_IN_CALL
;
362 need_destroy
= !marshaller (hook
, data
);
364 hook
->flags
&= ~G_HOOK_FLAG_IN_CALL
;
366 g_hook_destroy_link (hook_list
, hook
);
368 hook
= g_hook_next_valid (hook_list
, hook
, may_recurse
);
373 g_hook_list_marshal (GHookList
*hook_list
,
374 gboolean may_recurse
,
375 GHookMarshaller marshaller
,
380 g_return_if_fail (hook_list
!= NULL
);
381 g_return_if_fail (hook_list
->is_setup
);
382 g_return_if_fail (marshaller
!= NULL
);
384 hook
= g_hook_first_valid (hook_list
, may_recurse
);
387 gboolean was_in_call
;
389 was_in_call
= G_HOOK_IN_CALL (hook
);
390 hook
->flags
|= G_HOOK_FLAG_IN_CALL
;
391 marshaller (hook
, data
);
393 hook
->flags
&= ~G_HOOK_FLAG_IN_CALL
;
395 hook
= g_hook_next_valid (hook_list
, hook
, may_recurse
);
400 g_hook_first_valid (GHookList
*hook_list
,
401 gboolean may_be_in_call
)
403 g_return_val_if_fail (hook_list
!= NULL
, NULL
);
405 if (hook_list
->is_setup
)
409 hook
= hook_list
->hooks
;
412 g_hook_ref (hook_list
, hook
);
413 if (G_HOOK_IS_VALID (hook
) && (may_be_in_call
|| !G_HOOK_IN_CALL (hook
)))
416 return g_hook_next_valid (hook_list
, hook
, may_be_in_call
);
424 g_hook_next_valid (GHookList
*hook_list
,
426 gboolean may_be_in_call
)
430 g_return_val_if_fail (hook_list
!= NULL
, NULL
);
438 if (G_HOOK_IS_VALID (hook
) && (may_be_in_call
|| !G_HOOK_IN_CALL (hook
)))
440 g_hook_ref (hook_list
, hook
);
441 g_hook_unref (hook_list
, ohook
);
447 g_hook_unref (hook_list
, ohook
);
453 g_hook_get (GHookList
*hook_list
,
458 g_return_val_if_fail (hook_list
!= NULL
, NULL
);
459 g_return_val_if_fail (hook_id
> 0, NULL
);
461 hook
= hook_list
->hooks
;
464 if (hook
->hook_id
== hook_id
)
473 g_hook_find (GHookList
*hook_list
,
474 gboolean need_valids
,
480 g_return_val_if_fail (hook_list
!= NULL
, NULL
);
481 g_return_val_if_fail (func
!= NULL
, NULL
);
483 hook
= hook_list
->hooks
;
488 /* test only non-destroyed hooks */
495 g_hook_ref (hook_list
, hook
);
497 if (func (hook
, data
) && hook
->hook_id
&& (!need_valids
|| G_HOOK_ACTIVE (hook
)))
499 g_hook_unref (hook_list
, hook
);
505 g_hook_unref (hook_list
, hook
);
513 g_hook_find_data (GHookList
*hook_list
,
514 gboolean need_valids
,
519 g_return_val_if_fail (hook_list
!= NULL
, NULL
);
521 hook
= hook_list
->hooks
;
524 /* test only non-destroyed hooks */
525 if (hook
->data
== data
&&
527 (!need_valids
|| G_HOOK_ACTIVE (hook
)))
537 g_hook_find_func (GHookList
*hook_list
,
538 gboolean need_valids
,
543 g_return_val_if_fail (hook_list
!= NULL
, NULL
);
544 g_return_val_if_fail (func
!= NULL
, NULL
);
546 hook
= hook_list
->hooks
;
549 /* test only non-destroyed hooks */
550 if (hook
->func
== func
&&
552 (!need_valids
|| G_HOOK_ACTIVE (hook
)))
562 g_hook_find_func_data (GHookList
*hook_list
,
563 gboolean need_valids
,
569 g_return_val_if_fail (hook_list
!= NULL
, NULL
);
570 g_return_val_if_fail (func
!= NULL
, NULL
);
572 hook
= hook_list
->hooks
;
575 /* test only non-destroyed hooks */
576 if (hook
->data
== data
&&
577 hook
->func
== func
&&
579 (!need_valids
|| G_HOOK_ACTIVE (hook
)))
589 g_hook_insert_sorted (GHookList
*hook_list
,
591 GHookCompareFunc func
)
595 g_return_if_fail (hook_list
!= NULL
);
596 g_return_if_fail (hook_list
->is_setup
);
597 g_return_if_fail (hook
!= NULL
);
598 g_return_if_fail (G_HOOK_IS_UNLINKED (hook
));
599 g_return_if_fail (hook
->func
!= NULL
);
600 g_return_if_fail (func
!= NULL
);
602 /* first non-destroyed hook */
603 sibling
= hook_list
->hooks
;
604 while (sibling
&& !sibling
->hook_id
)
605 sibling
= sibling
->next
;
611 g_hook_ref (hook_list
, sibling
);
612 if (func (hook
, sibling
) <= 0 && sibling
->hook_id
)
614 g_hook_unref (hook_list
, sibling
);
618 /* next non-destroyed hook */
620 while (tmp
&& !tmp
->hook_id
)
623 g_hook_unref (hook_list
, sibling
);
627 g_hook_insert_before (hook_list
, sibling
, hook
);
631 g_hook_compare_ids (GHook
*new_hook
,
634 return ((glong
) new_hook
->hook_id
) - ((glong
) sibling
->hook_id
);