glib/ghook.c

   1 /* GLIB - Library of useful routines for C programming
   2  * Copyright (C) 1995-1997  Peter Mattis, Spencer Kimball and Josh MacDonald
   3  *
   4  * GHook: Callback maintenance functions
   5  * Copyright (C) 1998 Tim Janik
   6  *
   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.
  11  *
  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.
  16  *
  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.
  21  */
  22
  23 /*
  24  * MT safe
  25  */
  26
  27 #include        "glib.h"
  28
  29
  30 /* --- defines --- */
  31 #define G_HOOKS_PREALLOC        (16)
  32
  33
  34 /* --- functions --- */
  35 void
  36 g_hook_list_init (GHookList *hook_list,
  37                   guint      hook_size)
  38 {
  39   g_return_if_fail (hook_list != NULL);
  40   g_return_if_fail (hook_size >= sizeof (GHook));
  41
  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",
  47                                               hook_size,
  48                                               hook_size * G_HOOKS_PREALLOC,
  49                                               G_ALLOC_AND_FREE);
  50   hook_list->hook_free = NULL;
  51 }
  52
  53 void
  54 g_hook_list_clear (GHookList *hook_list)
  55 {
  56   g_return_if_fail (hook_list != NULL);
  57
  58   if (hook_list->is_setup)
  59     {
  60       GHook *hook;
  61
  62       hook_list->is_setup = FALSE;
  63
  64       hook = hook_list->hooks;
  65       if (!hook)
  66         {
  67           g_mem_chunk_destroy (hook_list->hook_memchunk);
  68           hook_list->hook_memchunk = NULL;
  69         }
  70       else
  71         do
  72           {
  73             GHook *tmp;
  74
  75             g_hook_ref (hook_list, hook);
  76             g_hook_destroy_link (hook_list, hook);
  77             tmp = hook->next;
  78             g_hook_unref (hook_list, hook);
  79             hook = tmp;
  80           }
  81         while (hook);
  82     }
  83 }
  84
  85 GHook*
  86 g_hook_alloc (GHookList *hook_list)
  87 {
  88   GHook *hook;
  89
  90   g_return_val_if_fail (hook_list != NULL, NULL);
  91   g_return_val_if_fail (hook_list->is_setup, NULL);
  92
  93   hook = g_chunk_new0 (GHook, hook_list->hook_memchunk);
  94   hook->data = NULL;
  95   hook->next = NULL;
  96   hook->prev = NULL;
  97   hook->flags = G_HOOK_FLAG_ACTIVE;
  98   hook->ref_count = 0;
  99   hook->hook_id = 0;
 100   hook->func = NULL;
 101   hook->destroy = NULL;
 102
 103   return hook;
 104 }
 105
 106 void
 107 g_hook_free (GHookList *hook_list,
 108              GHook     *hook)
 109 {
 110   g_return_if_fail (hook_list != NULL);
 111   g_return_if_fail (hook_list->is_setup);
 112   g_return_if_fail (hook != NULL);
 113   g_return_if_fail (G_HOOK_IS_UNLINKED (hook));
 114
 115   if (hook_list->hook_free)
 116     hook_list->hook_free (hook_list, hook);
 117
 118   g_chunk_free (hook, hook_list->hook_memchunk);
 119 }
 120
 121 void
 122 g_hook_destroy_link (GHookList *hook_list,
 123                      GHook     *hook)
 124 {
 125   g_return_if_fail (hook_list != NULL);
 126   g_return_if_fail (hook != NULL);
 127
 128   if (hook->hook_id)
 129     {
 130       hook->hook_id = 0;
 131       hook->flags &= ~G_HOOK_FLAG_ACTIVE;
 132       if (hook->destroy)
 133         {
 134           GDestroyNotify destroy;
 135
 136           destroy = hook->destroy;
 137           hook->destroy = NULL;
 138           destroy (hook->data);
 139         }
 140       g_hook_unref (hook_list, hook); /* counterpart to g_hook_insert_before */
 141     }
 142 }
 143
 144 gboolean
 145 g_hook_destroy (GHookList   *hook_list,
 146                 guint        hook_id)
 147 {
 148   GHook *hook;
 149
 150   g_return_val_if_fail (hook_list != NULL, FALSE);
 151   g_return_val_if_fail (hook_id > 0, FALSE);
 152
 153   hook = g_hook_get (hook_list, hook_id);
 154   if (hook)
 155     {
 156       g_hook_destroy_link (hook_list, hook);
 157       return TRUE;
 158     }
 159
 160   return FALSE;
 161 }
 162
 163 void
 164 g_hook_unref (GHookList *hook_list,
 165               GHook     *hook)
 166 {
 167   g_return_if_fail (hook_list != NULL);
 168   g_return_if_fail (hook != NULL);
 169   g_return_if_fail (hook->ref_count > 0);
 170
 171   hook->ref_count--;
 172   if (!hook->ref_count)
 173     {
 174       g_return_if_fail (hook->hook_id == 0);
 175       g_return_if_fail (!G_HOOK_IN_CALL (hook));
 176
 177       if (hook->prev)
 178         hook->prev->next = hook->next;
 179       else
 180         hook_list->hooks = hook->next;
 181       if (hook->next)
 182         {
 183           hook->next->prev = hook->prev;
 184           hook->next = NULL;
 185         }
 186       hook->prev = NULL;
 187
 188       g_hook_free (hook_list, hook);
 189
 190       if (!hook_list->hooks &&
 191           !hook_list->is_setup)
 192         {
 193           g_mem_chunk_destroy (hook_list->hook_memchunk);
 194           hook_list->hook_memchunk = NULL;
 195         }
 196     }
 197 }
 198
 199 void
 200 g_hook_ref (GHookList *hook_list,
 201             GHook     *hook)
 202 {
 203   g_return_if_fail (hook_list != NULL);
 204   g_return_if_fail (hook != NULL);
 205   g_return_if_fail (hook->ref_count > 0);
 206
 207   hook->ref_count++;
 208 }
 209
 210 void
 211 g_hook_prepend (GHookList *hook_list,
 212                 GHook     *hook)
 213 {
 214   g_return_if_fail (hook_list != NULL);
 215
 216   g_hook_insert_before (hook_list, hook_list->hooks, hook);
 217 }
 218
 219 void
 220 g_hook_insert_before (GHookList *hook_list,
 221                       GHook     *sibling,
 222                       GHook     *hook)
 223 {
 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);
 229
 230   hook->hook_id = hook_list->seq_id++;
 231   hook->ref_count = 1; /* counterpart to g_hook_destroy_link */
 232
 233   if (sibling)
 234     {
 235       if (sibling->prev)
 236         {
 237           hook->prev = sibling->prev;
 238           hook->prev->next = hook;
 239           hook->next = sibling;
 240           sibling->prev = hook;
 241         }
 242       else
 243         {
 244           hook_list->hooks = hook;
 245           hook->next = sibling;
 246           sibling->prev = hook;
 247         }
 248     }
 249   else
 250     {
 251       if (hook_list->hooks)
 252         {
 253           sibling = hook_list->hooks;
 254           while (sibling->next)
 255             sibling = sibling->next;
 256           hook->prev = sibling;
 257           sibling->next = hook;
 258         }
 259       else
 260         hook_list->hooks = hook;
 261     }
 262 }
 263
 264 void
 265 g_hook_list_invoke (GHookList *hook_list,
 266                     gboolean   may_recurse)
 267 {
 268   GHook *hook;
 269
 270   g_return_if_fail (hook_list != NULL);
 271   g_return_if_fail (hook_list->is_setup);
 272
 273   hook = g_hook_first_valid (hook_list, may_recurse);
 274   while (hook)
 275     {
 276       GHookFunc func;
 277       gboolean was_in_call;
 278
 279       func = (GHookFunc) hook->func;
 280
 281       was_in_call = G_HOOK_IN_CALL (hook);
 282       hook->flags |= G_HOOK_FLAG_IN_CALL;
 283       func (hook->data);
 284       if (!was_in_call)
 285         hook->flags &= ~G_HOOK_FLAG_IN_CALL;
 286
 287       hook = g_hook_next_valid (hook_list, hook, may_recurse);
 288     }
 289 }
 290
 291 void
 292 g_hook_list_invoke_check (GHookList *hook_list,
 293                           gboolean   may_recurse)
 294 {
 295   GHook *hook;
 296
 297   g_return_if_fail (hook_list != NULL);
 298   g_return_if_fail (hook_list->is_setup);
 299
 300   hook = g_hook_first_valid (hook_list, may_recurse);
 301   while (hook)
 302     {
 303       GHookCheckFunc func;
 304       gboolean was_in_call;
 305       gboolean need_destroy;
 306
 307       func = (GHookCheckFunc) hook->func;
 308
 309       was_in_call = G_HOOK_IN_CALL (hook);
 310       hook->flags |= G_HOOK_FLAG_IN_CALL;
 311       need_destroy = !func (hook->data);
 312       if (!was_in_call)
 313         hook->flags &= ~G_HOOK_FLAG_IN_CALL;
 314       if (need_destroy)
 315         g_hook_destroy_link (hook_list, hook);
 316
 317       hook = g_hook_next_valid (hook_list, hook, may_recurse);
 318     }
 319 }
 320
 321 void
 322 g_hook_list_marshal_check (GHookList           *hook_list,
 323                            gboolean             may_recurse,
 324                            GHookCheckMarshaller marshaller,
 325                            gpointer             data)
 326 {
 327   GHook *hook;
 328
 329   g_return_if_fail (hook_list != NULL);
 330   g_return_if_fail (hook_list->is_setup);
 331   g_return_if_fail (marshaller != NULL);
 332
 333   hook = g_hook_first_valid (hook_list, may_recurse);
 334   while (hook)
 335     {
 336       gboolean was_in_call;
 337       gboolean need_destroy;
 338
 339       was_in_call = G_HOOK_IN_CALL (hook);
 340       hook->flags |= G_HOOK_FLAG_IN_CALL;
 341       need_destroy = !marshaller (hook, data);
 342       if (!was_in_call)
 343         hook->flags &= ~G_HOOK_FLAG_IN_CALL;
 344       if (need_destroy)
 345         g_hook_destroy_link (hook_list, hook);
 346
 347       hook = g_hook_next_valid (hook_list, hook, may_recurse);
 348     }
 349 }
 350
 351 void
 352 g_hook_list_marshal (GHookList               *hook_list,
 353                      gboolean                 may_recurse,
 354                      GHookMarshaller          marshaller,
 355                      gpointer                 data)
 356 {
 357   GHook *hook;
 358
 359   g_return_if_fail (hook_list != NULL);
 360   g_return_if_fail (hook_list->is_setup);
 361   g_return_if_fail (marshaller != NULL);
 362
 363   hook = g_hook_first_valid (hook_list, may_recurse);
 364   while (hook)
 365     {
 366       gboolean was_in_call;
 367
 368       was_in_call = G_HOOK_IN_CALL (hook);
 369       hook->flags |= G_HOOK_FLAG_IN_CALL;
 370       marshaller (hook, data);
 371       if (!was_in_call)
 372         hook->flags &= ~G_HOOK_FLAG_IN_CALL;
 373
 374       hook = g_hook_next_valid (hook_list, hook, may_recurse);
 375     }
 376 }
 377
 378 GHook*
 379 g_hook_first_valid (GHookList *hook_list,
 380                     gboolean   may_be_in_call)
 381 {
 382   g_return_val_if_fail (hook_list != NULL, NULL);
 383
 384   if (hook_list->is_setup)
 385     {
 386       GHook *hook;
 387
 388       hook = hook_list->hooks;
 389       if (hook)
 390         {
 391           g_hook_ref (hook_list, hook);
 392           if (G_HOOK_IS_VALID (hook) && (may_be_in_call || !G_HOOK_IN_CALL (hook)))
 393             return hook;
 394           else
 395             return g_hook_next_valid (hook_list, hook, may_be_in_call);
 396         }
 397     }
 398
 399   return NULL;
 400 }
 401
 402 GHook*
 403 g_hook_next_valid (GHookList *hook_list,
 404                    GHook     *hook,
 405                    gboolean   may_be_in_call)
 406 {
 407   GHook *ohook = hook;
 408
 409   g_return_val_if_fail (hook_list != NULL, NULL);
 410
 411   if (!hook)
 412     return NULL;
 413
 414   hook = hook->next;
 415   while (hook)
 416     {
 417       if (G_HOOK_IS_VALID (hook) && (may_be_in_call || !G_HOOK_IN_CALL (hook)))
 418         {
 419           g_hook_ref (hook_list, hook);
 420           g_hook_unref (hook_list, ohook);
 421
 422           return hook;
 423         }
 424       hook = hook->next;
 425     }
 426   g_hook_unref (hook_list, ohook);
 427
 428   return NULL;
 429 }
 430
 431 GHook*
 432 g_hook_get (GHookList *hook_list,
 433             guint      hook_id)
 434 {
 435   GHook *hook;
 436
 437   g_return_val_if_fail (hook_list != NULL, NULL);
 438   g_return_val_if_fail (hook_id > 0, NULL);
 439
 440   hook = hook_list->hooks;
 441   while (hook)
 442     {
 443       if (hook->hook_id == hook_id)
 444         return hook;
 445       hook = hook->next;
 446     }
 447
 448   return NULL;
 449 }
 450
 451 GHook*
 452 g_hook_find (GHookList    *hook_list,
 453              gboolean      need_valids,
 454              GHookFindFunc func,
 455              gpointer      data)
 456 {
 457   GHook *hook;
 458
 459   g_return_val_if_fail (hook_list != NULL, NULL);
 460   g_return_val_if_fail (func != NULL, NULL);
 461
 462   hook = hook_list->hooks;
 463   while (hook)
 464     {
 465       GHook *tmp;
 466
 467       /* test only non-destroyed hooks */
 468       if (!hook->hook_id)
 469         {
 470           hook = hook->next;
 471           continue;
 472         }
 473
 474       g_hook_ref (hook_list, hook);
 475
 476       if (func (hook, data) && hook->hook_id && (!need_valids || G_HOOK_ACTIVE (hook)))
 477         {
 478           g_hook_unref (hook_list, hook);
 479
 480           return hook;
 481         }
 482
 483       tmp = hook->next;
 484       g_hook_unref (hook_list, hook);
 485       hook = tmp;
 486     }
 487
 488   return NULL;
 489 }
 490
 491 GHook*
 492 g_hook_find_data (GHookList *hook_list,
 493                   gboolean   need_valids,
 494                   gpointer   data)
 495 {
 496   GHook *hook;
 497
 498   g_return_val_if_fail (hook_list != NULL, NULL);
 499
 500   hook = hook_list->hooks;
 501   while (hook)
 502     {
 503       /* test only non-destroyed hooks */
 504       if (hook->data == data &&
 505           hook->hook_id &&
 506           (!need_valids || G_HOOK_ACTIVE (hook)))
 507         return hook;
 508
 509       hook = hook->next;
 510     }
 511
 512   return NULL;
 513 }
 514
 515 GHook*
 516 g_hook_find_func (GHookList *hook_list,
 517                   gboolean   need_valids,
 518                   gpointer   func)
 519 {
 520   GHook *hook;
 521
 522   g_return_val_if_fail (hook_list != NULL, NULL);
 523   g_return_val_if_fail (func != NULL, NULL);
 524
 525   hook = hook_list->hooks;
 526   while (hook)
 527     {
 528       /* test only non-destroyed hooks */
 529       if (hook->func == func &&
 530           hook->hook_id &&
 531           (!need_valids || G_HOOK_ACTIVE (hook)))
 532         return hook;
 533
 534       hook = hook->next;
 535     }
 536
 537   return NULL;
 538 }
 539
 540 GHook*
 541 g_hook_find_func_data (GHookList *hook_list,
 542                        gboolean   need_valids,
 543                        gpointer   func,
 544                        gpointer   data)
 545 {
 546   GHook *hook;
 547
 548   g_return_val_if_fail (hook_list != NULL, NULL);
 549   g_return_val_if_fail (func != NULL, NULL);
 550
 551   hook = hook_list->hooks;
 552   while (hook)
 553     {
 554       /* test only non-destroyed hooks */
 555       if (hook->data == data &&
 556           hook->func == func &&
 557           hook->hook_id &&
 558           (!need_valids || G_HOOK_ACTIVE (hook)))
 559         return hook;
 560
 561       hook = hook->next;
 562     }
 563
 564   return NULL;
 565 }
 566
 567 void
 568 g_hook_insert_sorted (GHookList       *hook_list,
 569                       GHook           *hook,
 570                       GHookCompareFunc func)
 571 {
 572   GHook *sibling;
 573
 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);
 580
 581   /* first non-destroyed hook */
 582   sibling = hook_list->hooks;
 583   while (sibling && !sibling->hook_id)
 584     sibling = sibling->next;
 585
 586   while (sibling)
 587     {
 588       GHook *tmp;
 589
 590       g_hook_ref (hook_list, sibling);
 591       if (func (hook, sibling) <= 0 && sibling->hook_id)
 592         {
 593           g_hook_unref (hook_list, sibling);
 594           break;
 595         }
 596
 597       /* next non-destroyed hook */
 598       tmp = sibling->next;
 599       while (tmp && !tmp->hook_id)
 600         tmp = tmp->next;
 601
 602       g_hook_unref (hook_list, sibling);
 603       sibling = tmp;
 604     }
 605
 606   g_hook_insert_before (hook_list, sibling, hook);
 607 }
 608
 609 gint
 610 g_hook_compare_ids (GHook *new_hook,
 611                     GHook *sibling)
 612 {
 613   return ((glong) new_hook->hook_id) - ((glong) sibling->hook_id);
 614 }