glib/ghook.h

   1 /* GLIB - Library of useful routines for C programming
   2  * Copyright (C) 1995-1997  Peter Mattis, Spencer Kimball and Josh MacDonald
   3  *
   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.
   8  *
   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.
  13  *
  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.
  18  */
  19
  20 /*
  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/.
  25  */
  26
  27 #ifndef __G_HOOK_H__
  28 #define __G_HOOK_H__
  29
  30 #include <gmem.h>
  31
  32 G_BEGIN_DECLS
  33
  34
  35 /* --- typedefs --- */
  36 typedef struct _GHook           GHook;
  37 typedef struct _GHookList       GHookList;
  38
  39 typedef gint            (*GHookCompareFunc)     (GHook          *new_hook,
  40                                                  GHook          *sibling);
  41 typedef gboolean        (*GHookFindFunc)        (GHook          *hook,
  42                                                  gpointer        data);
  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,
  50                                                  GHook          *hook);
  51 typedef enum
  52 {
  53   G_HOOK_FLAG_ACTIVE        = 1 << 0,
  54   G_HOOK_FLAG_IN_CALL       = 1 << 1,
  55   G_HOOK_FLAG_MASK          = 0x0f
  56 } GHookFlagMask;
  57 #define G_HOOK_FLAG_USER_SHIFT  (4)
  58
  59
  60 /* --- structures --- */
  61 struct _GHookList
  62 {
  63   guint             seq_id;
  64   guint             hook_size : 16;
  65   guint             is_setup : 1;
  66   GHook            *hooks;
  67   GMemChunk        *hook_memchunk;
  68   GHookFinalizeFunc finalize_hook;
  69 };
  70 struct _GHook
  71 {
  72   gpointer       data;
  73   GHook         *next;
  74   GHook         *prev;
  75   guint          ref_count;
  76   guint          hook_id;
  77   guint          flags;
  78   gpointer       func;
  79   GDestroyNotify destroy;
  80 };
  81
  82
  83 /* --- macros --- */
  84 #define G_HOOK(hook)                    ((GHook*) (hook))
  85 #define G_HOOK_FLAGS(hook)              (G_HOOK (hook)->flags)
  86 #define G_HOOK_ACTIVE(hook)             ((G_HOOK_FLAGS (hook) & \
  87                                           G_HOOK_FLAG_ACTIVE) != 0)
  88 #define G_HOOK_IN_CALL(hook)            ((G_HOOK_FLAGS (hook) & \
  89                                           G_HOOK_FLAG_IN_CALL) != 0)
  90 #define G_HOOK_IS_VALID(hook)           (G_HOOK (hook)->hook_id != 0 && \
  91                                          (G_HOOK_FLAGS (hook) & \
  92                                           G_HOOK_FLAG_ACTIVE))
  93 #define G_HOOK_IS_UNLINKED(hook)        (G_HOOK (hook)->next == NULL && \
  94                                          G_HOOK (hook)->prev == NULL && \
  95                                          G_HOOK (hook)->hook_id == 0 && \
  96                                          G_HOOK (hook)->ref_count == 0)
  97
  98
  99 /* --- prototypes --- */
 100 /* callback mainenance functions */
 101 void     g_hook_list_init               (GHookList              *hook_list,
 102                                          guint                   hook_size);
 103 void     g_hook_list_clear              (GHookList              *hook_list);
 104 GHook*   g_hook_alloc                   (GHookList              *hook_list);
 105 void     g_hook_free                    (GHookList              *hook_list,
 106                                          GHook                  *hook);
 107 void     g_hook_ref                     (GHookList              *hook_list,
 108                                          GHook                  *hook);
 109 void     g_hook_unref                   (GHookList              *hook_list,
 110                                          GHook                  *hook);
 111 gboolean g_hook_destroy                 (GHookList              *hook_list,
 112                                          guint                   hook_id);
 113 void     g_hook_destroy_link            (GHookList              *hook_list,
 114                                          GHook                  *hook);
 115 void     g_hook_prepend                 (GHookList              *hook_list,
 116                                          GHook                  *hook);
 117 void     g_hook_insert_before           (GHookList              *hook_list,
 118                                          GHook                  *sibling,
 119                                          GHook                  *hook);
 120 void     g_hook_insert_sorted           (GHookList              *hook_list,
 121                                          GHook                  *hook,
 122                                          GHookCompareFunc        func);
 123 GHook*   g_hook_get                     (GHookList              *hook_list,
 124                                          guint                   hook_id);
 125 GHook*   g_hook_find                    (GHookList              *hook_list,
 126                                          gboolean                need_valids,
 127                                          GHookFindFunc           func,
 128                                          gpointer                data);
 129 GHook*   g_hook_find_data               (GHookList              *hook_list,
 130                                          gboolean                need_valids,
 131                                          gpointer                data);
 132 GHook*   g_hook_find_func               (GHookList              *hook_list,
 133                                          gboolean                need_valids,
 134                                          gpointer                func);
 135 GHook*   g_hook_find_func_data          (GHookList              *hook_list,
 136                                          gboolean                need_valids,
 137                                          gpointer                func,
 138                                          gpointer                data);
 139 /* return the first valid hook, and increment its reference count */
 140 GHook*   g_hook_first_valid             (GHookList              *hook_list,
 141                                          gboolean                may_be_in_call);
 142 /* return the next valid hook with incremented reference count, and
 143  * decrement the reference count of the original hook
 144  */
 145 GHook*   g_hook_next_valid              (GHookList              *hook_list,
 146                                          GHook                  *hook,
 147                                          gboolean                may_be_in_call);
 148 /* GHookCompareFunc implementation to insert hooks sorted by their id */
 149 gint     g_hook_compare_ids             (GHook                  *new_hook,
 150                                          GHook                  *sibling);
 151 /* convenience macros */
 152 #define  g_hook_append( hook_list, hook )  \
 153      g_hook_insert_before ((hook_list), NULL, (hook))
 154 /* invoke all valid hooks with the (*GHookFunc) signature.
 155  */
 156 void     g_hook_list_invoke             (GHookList              *hook_list,
 157                                          gboolean                may_recurse);
 158 /* invoke all valid hooks with the (*GHookCheckFunc) signature,
 159  * and destroy the hook if FALSE is returned.
 160  */
 161 void     g_hook_list_invoke_check       (GHookList              *hook_list,
 162                                          gboolean                may_recurse);
 163 /* invoke a marshaller on all valid hooks.
 164  */
 165 void     g_hook_list_marshal            (GHookList              *hook_list,
 166                                          gboolean                may_recurse,
 167                                          GHookMarshaller         marshaller,
 168                                          gpointer                marshal_data);
 169 void     g_hook_list_marshal_check      (GHookList              *hook_list,
 170                                          gboolean                may_recurse,
 171                                          GHookCheckMarshaller    marshaller,
 172                                          gpointer                marshal_data);
 173
 174 G_END_DECLS
 175
 176 #endif /* __G_HOOK_H__ */
 177