GHookFinalizeFunc ()

void
(*GHookFinalizeFunc) (GHookList *hook_list,
                      GHook *hook);

Defines the type of function to be called when a hook in a list of hooks gets finalized.

GHookFunc ()

void
(*GHookFunc) (gpointer data);

Defines the type of a hook function that can be invoked by g_hook_list_invoke().

GHookCheckFunc ()

gboolean
(*GHookCheckFunc) (gpointer data);

Defines the type of a hook function that can be invoked by g_hook_list_invoke_check().

g_hook_list_init ()

void
g_hook_list_init (GHookList *hook_list,
                  guint hook_size);

Initializes a GHookList. This must be called before the GHookList is used.

g_hook_list_invoke ()

void
g_hook_list_invoke (GHookList *hook_list,
                    gboolean may_recurse);

Calls all of the GHook functions in a GHookList.

g_hook_list_invoke_check ()

void
g_hook_list_invoke_check (GHookList *hook_list,
                          gboolean may_recurse);

Calls all of the GHook functions in a GHookList. Any function which returns FALSE is removed from the GHookList.

g_hook_list_marshal ()

void
g_hook_list_marshal (GHookList *hook_list,
                     gboolean may_recurse,
                     GHookMarshaller marshaller,
                     gpointer marshal_data);

Calls a function on each valid GHook.

GHookMarshaller ()

void
(*GHookMarshaller) (GHook *hook,
                    gpointer user_data);

Defines the type of function used by g_hook_list_marshal().

g_hook_list_marshal_check ()

void
g_hook_list_marshal_check (GHookList *hook_list,
                           gboolean may_recurse,
                           GHookCheckMarshaller marshaller,
                           gpointer marshal_data);

Calls a function on each valid GHook and destroys it if the function returns FALSE.

GHookCheckMarshaller ()

gboolean
(*GHookCheckMarshaller) (GHook *hook,
                         gpointer user_data);

Defines the type of function used by g_hook_list_marshal_check().

g_hook_list_clear ()

void
g_hook_list_clear (GHookList *hook_list);

Removes all the GHook elements from a GHookList.

g_hook_alloc ()

GHook *
g_hook_alloc (GHookList *hook_list);

Allocates space for a GHook and initializes it.

g_hook_append()

#define             g_hook_append( hook_list, hook )

Appends a GHook onto the end of a GHookList.

g_hook_prepend ()

void
g_hook_prepend (GHookList *hook_list,
                GHook *hook);

Prepends a GHook on the start of a GHookList.

g_hook_insert_before ()

void
g_hook_insert_before (GHookList *hook_list,
                      GHook *sibling,
                      GHook *hook);

Inserts a GHook into a GHookList, before a given GHook.

g_hook_insert_sorted ()

void
g_hook_insert_sorted (GHookList *hook_list,
                      GHook *hook,
                      GHookCompareFunc func);

Inserts a GHook into a GHookList, sorted by the given function.

GHookCompareFunc ()

gint
(*GHookCompareFunc) (GHook *new_hook,
                     GHook *sibling);

Defines the type of function used to compare GHook elements in g_hook_insert_sorted().

g_hook_compare_ids ()

gint
g_hook_compare_ids (GHook *new_hook,
                    GHook *sibling);

Compares the ids of two GHook elements, returning a negative value if the second id is greater than the first.

g_hook_get ()

GHook *
g_hook_get (GHookList *hook_list,
            gulong hook_id);

Returns the GHook with the given id, or NULL if it is not found.

g_hook_find ()

GHook *
g_hook_find (GHookList *hook_list,
             gboolean need_valids,
             GHookFindFunc func,
             gpointer data);

Finds a GHook in a GHookList using the given function to test for a match.

GHookFindFunc ()

gboolean
(*GHookFindFunc) (GHook *hook,
                  gpointer user_data);

Defines the type of the function passed to g_hook_find().

g_hook_find_data ()

GHook *
g_hook_find_data (GHookList *hook_list,
                  gboolean need_valids,
                  gpointer data);

Finds a GHook in a GHookList with the given data.

g_hook_find_func ()

GHook *
g_hook_find_func (GHookList *hook_list,
                  gboolean need_valids,
                  gpointer func);

Finds a GHook in a GHookList with the given function.

g_hook_find_func_data ()

GHook *
g_hook_find_func_data (GHookList *hook_list,
                       gboolean need_valids,
                       gpointer func,
                       gpointer data);

Finds a GHook in a GHookList with the given function and data.

g_hook_first_valid ()

GHook *
g_hook_first_valid (GHookList *hook_list,
                    gboolean may_be_in_call);

Returns the first GHook in a GHookList which has not been destroyed. The reference count for the GHook is incremented, so you must call g_hook_unref() to restore it when no longer needed. (Or call g_hook_next_valid() if you are stepping through the GHookList.)

g_hook_next_valid ()

GHook *
g_hook_next_valid (GHookList *hook_list,
                   GHook *hook,
                   gboolean may_be_in_call);

Returns the next GHook in a GHookList which has not been destroyed. The reference count for the GHook is incremented, so you must call g_hook_unref() to restore it when no longer needed. (Or continue to call g_hook_next_valid() until NULL is returned.)

G_HOOK_FLAGS()

#define G_HOOK_FLAGS(hook)		(G_HOOK (hook)->flags)

Gets the flags of a hook.

G_HOOK()

#define G_HOOK(hook)			((GHook*) (hook))

Casts a pointer to a GHook*.

G_HOOK_IS_VALID()

#define             G_HOOK_IS_VALID(hook)

Returns TRUE if the GHook is valid, i.e. it is in a GHookList, it is active and it has not been destroyed.

G_HOOK_ACTIVE()

#define             G_HOOK_ACTIVE(hook)

Returns TRUE if the GHook is active, which is normally the case until the GHook is destroyed.

G_HOOK_IN_CALL()

#define             G_HOOK_IN_CALL(hook)

Returns TRUE if the GHook function is currently executing.

G_HOOK_IS_UNLINKED()

#define             G_HOOK_IS_UNLINKED(hook)

Returns TRUE if the GHook is not in a GHookList.

g_hook_ref ()

GHook *
g_hook_ref (GHookList *hook_list,
            GHook *hook);

Increments the reference count for a GHook.

g_hook_unref ()

void
g_hook_unref (GHookList *hook_list,
              GHook *hook);

Decrements the reference count of a GHook. If the reference count falls to 0, the GHook is removed from the GHookList and g_hook_free() is called to free it.

g_hook_free ()

void
g_hook_free (GHookList *hook_list,
             GHook *hook);

Calls the GHookList finalize_hook function if it exists, and frees the memory allocated for the GHook.

g_hook_destroy ()

gboolean
g_hook_destroy (GHookList *hook_list,
                gulong hook_id);

Destroys a GHook, given its ID.

g_hook_destroy_link ()

void
g_hook_destroy_link (GHookList *hook_list,
                     GHook *hook);

Removes one GHook from a GHookList, marking it inactive and calling g_hook_unref() on it.

struct GHookList

struct GHookList {
  gulong	    seq_id;
  guint		    hook_size : 16;
  guint		    is_setup : 1;
  GHook		   *hooks;
  gpointer	    dummy3;
  GHookFinalizeFunc finalize_hook;
  gpointer	    dummy[2];
};

The GHookList struct represents a list of hook functions.

struct GHook

struct GHook {
  gpointer	 data;
  GHook		*next;
  GHook		*prev;
  guint		 ref_count;
  gulong	 hook_id;
  guint		 flags;
  gpointer	 func;
  GDestroyNotify destroy;
};

The GHook struct represents a single hook function in a GHookList.

enum GHookFlagMask

Flags used internally in the GHook implementation.

G_HOOK_FLAG_USER_SHIFT

#define G_HOOK_FLAG_USER_SHIFT (4)

The position of the first bit which is not reserved for internal use be the GHook implementation, i.e. 1 << G_HOOK_FLAG_USER_SHIFT is the first bit which can be used for application-defined flags.