📄 glib-hook-functions.html
字号:
<html xmlns:cf="http://docbook.sourceforge.net/xmlns/chunkfast/1.0"><head><meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"><title>Hook Functions</title><meta name="generator" content="DocBook XSL Stylesheets V1.69.0"><link rel="start" href="index.html" title="GLib Reference Manual"><link rel="up" href="glib-utilities.html" title="GLib Utilities"><link rel="prev" href="glib-Random-Numbers.html" title="Random Numbers"><link rel="next" href="glib-Miscellaneous-Utility-Functions.html" title="Miscellaneous Utility Functions"><meta name="generator" content="GTK-Doc V1.4 (XML mode)"><link rel="stylesheet" href="style.css" type="text/css"><link rel="chapter" href="glib.html" title="GLib Overview"><link rel="chapter" href="glib-fundamentals.html" title="GLib Fundamentals"><link rel="chapter" href="glib-core.html" title="GLib Core Application Support"><link rel="chapter" href="glib-utilities.html" title="GLib Utilities"><link rel="chapter" href="glib-data-types.html" title="GLib Data Types"><link rel="chapter" href="tools.html" title="GLib Tools"><link rel="index" href="ix01.html" title="Index"><link rel="index" href="ix02.html" title="Index of deprecated symbols"><link rel="index" href="ix03.html" title="Index of new symbols in 2.2"><link rel="index" href="ix04.html" title="Index of new symbols in 2.4"><link rel="index" href="ix05.html" title="Index of new symbols in 2.6"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><table class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"><td><a accesskey="p" href="glib-Random-Numbers.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td><td><a accesskey="u" href="glib-utilities.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td><td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td><th width="100%" align="center">GLib Reference Manual</th><td><a accesskey="n" href="glib-Miscellaneous-Utility-Functions.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td></tr></table><div class="refentry" lang="en"><a name="glib-Hook-Functions"></a><div class="titlepage"></div><div class="refnamediv"><table width="100%"><tr><td valign="top"><h2><span class="refentrytitle">Hook Functions</span></h2><p>Hook Functions — support for manipulating lists of hook functions.</p></td><td valign="top" align="right"></td></tr></table></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">#include <glib.h> <a href="glib-Hook-Functions.html#GHookList">GHookList</a>;void (<a href="glib-Hook-Functions.html#GHookFinalizeFunc">*GHookFinalizeFunc</a>) (<a href="glib-Hook-Functions.html#GHookList">GHookList</a> *hook_list, <a href="glib-Hook-Functions.html#GHook">GHook</a> *hook); <a href="glib-Hook-Functions.html#GHook">GHook</a>;void (<a href="glib-Hook-Functions.html#GHookFunc">*GHookFunc</a>) (<a href="glib-Basic-Types.html#gpointer">gpointer</a> data);<a href="glib-Basic-Types.html#gboolean">gboolean</a> (<a href="glib-Hook-Functions.html#GHookCheckFunc">*GHookCheckFunc</a>) (<a href="glib-Basic-Types.html#gpointer">gpointer</a> data);void <a href="glib-Hook-Functions.html#g-hook-list-init">g_hook_list_init</a> (<a href="glib-Hook-Functions.html#GHookList">GHookList</a> *hook_list, <a href="glib-Basic-Types.html#guint">guint</a> hook_size);void <a href="glib-Hook-Functions.html#g-hook-list-invoke">g_hook_list_invoke</a> (<a href="glib-Hook-Functions.html#GHookList">GHookList</a> *hook_list, <a href="glib-Basic-Types.html#gboolean">gboolean</a> may_recurse);void <a href="glib-Hook-Functions.html#g-hook-list-invoke-check">g_hook_list_invoke_check</a> (<a href="glib-Hook-Functions.html#GHookList">GHookList</a> *hook_list, <a href="glib-Basic-Types.html#gboolean">gboolean</a> may_recurse);void <a href="glib-Hook-Functions.html#g-hook-list-marshal">g_hook_list_marshal</a> (<a href="glib-Hook-Functions.html#GHookList">GHookList</a> *hook_list, <a href="glib-Basic-Types.html#gboolean">gboolean</a> may_recurse, <a href="glib-Hook-Functions.html#GHookMarshaller">GHookMarshaller</a> marshaller, <a href="glib-Basic-Types.html#gpointer">gpointer</a> marshal_data);void (<a href="glib-Hook-Functions.html#GHookMarshaller">*GHookMarshaller</a>) (<a href="glib-Hook-Functions.html#GHook">GHook</a> *hook, <a href="glib-Basic-Types.html#gpointer">gpointer</a> marshal_data);void <a href="glib-Hook-Functions.html#g-hook-list-marshal-check">g_hook_list_marshal_check</a> (<a href="glib-Hook-Functions.html#GHookList">GHookList</a> *hook_list, <a href="glib-Basic-Types.html#gboolean">gboolean</a> may_recurse, <a href="glib-Hook-Functions.html#GHookCheckMarshaller">GHookCheckMarshaller</a> marshaller, <a href="glib-Basic-Types.html#gpointer">gpointer</a> marshal_data);<a href="glib-Basic-Types.html#gboolean">gboolean</a> (<a href="glib-Hook-Functions.html#GHookCheckMarshaller">*GHookCheckMarshaller</a>) (<a href="glib-Hook-Functions.html#GHook">GHook</a> *hook, <a href="glib-Basic-Types.html#gpointer">gpointer</a> marshal_data);void <a href="glib-Hook-Functions.html#g-hook-list-clear">g_hook_list_clear</a> (<a href="glib-Hook-Functions.html#GHookList">GHookList</a> *hook_list);<a href="glib-Hook-Functions.html#GHook">GHook</a>* <a href="glib-Hook-Functions.html#g-hook-alloc">g_hook_alloc</a> (<a href="glib-Hook-Functions.html#GHookList">GHookList</a> *hook_list);#define <a href="glib-Hook-Functions.html#g-hook-append">g_hook_append</a> ( hook_list, hook )void <a href="glib-Hook-Functions.html#g-hook-prepend">g_hook_prepend</a> (<a href="glib-Hook-Functions.html#GHookList">GHookList</a> *hook_list, <a href="glib-Hook-Functions.html#GHook">GHook</a> *hook);void <a href="glib-Hook-Functions.html#g-hook-insert-before">g_hook_insert_before</a> (<a href="glib-Hook-Functions.html#GHookList">GHookList</a> *hook_list, <a href="glib-Hook-Functions.html#GHook">GHook</a> *sibling, <a href="glib-Hook-Functions.html#GHook">GHook</a> *hook);void <a href="glib-Hook-Functions.html#g-hook-insert-sorted">g_hook_insert_sorted</a> (<a href="glib-Hook-Functions.html#GHookList">GHookList</a> *hook_list, <a href="glib-Hook-Functions.html#GHook">GHook</a> *hook, <a href="glib-Hook-Functions.html#GHookCompareFunc">GHookCompareFunc</a> func);<a href="glib-Basic-Types.html#gint">gint</a> (<a href="glib-Hook-Functions.html#GHookCompareFunc">*GHookCompareFunc</a>) (<a href="glib-Hook-Functions.html#GHook">GHook</a> *new_hook, <a href="glib-Hook-Functions.html#GHook">GHook</a> *sibling);<a href="glib-Basic-Types.html#gint">gint</a> <a href="glib-Hook-Functions.html#g-hook-compare-ids">g_hook_compare_ids</a> (<a href="glib-Hook-Functions.html#GHook">GHook</a> *new_hook, <a href="glib-Hook-Functions.html#GHook">GHook</a> *sibling);<a href="glib-Hook-Functions.html#GHook">GHook</a>* <a href="glib-Hook-Functions.html#g-hook-get">g_hook_get</a> (<a href="glib-Hook-Functions.html#GHookList">GHookList</a> *hook_list, <a href="glib-Basic-Types.html#gulong">gulong</a> hook_id);<a href="glib-Hook-Functions.html#GHook">GHook</a>* <a href="glib-Hook-Functions.html#g-hook-find">g_hook_find</a> (<a href="glib-Hook-Functions.html#GHookList">GHookList</a> *hook_list, <a href="glib-Basic-Types.html#gboolean">gboolean</a> need_valids, <a href="glib-Hook-Functions.html#GHookFindFunc">GHookFindFunc</a> func, <a href="glib-Basic-Types.html#gpointer">gpointer</a> data);<a href="glib-Basic-Types.html#gboolean">gboolean</a> (<a href="glib-Hook-Functions.html#GHookFindFunc">*GHookFindFunc</a>) (<a href="glib-Hook-Functions.html#GHook">GHook</a> *hook, <a href="glib-Basic-Types.html#gpointer">gpointer</a> data);<a href="glib-Hook-Functions.html#GHook">GHook</a>* <a href="glib-Hook-Functions.html#g-hook-find-data">g_hook_find_data</a> (<a href="glib-Hook-Functions.html#GHookList">GHookList</a> *hook_list, <a href="glib-Basic-Types.html#gboolean">gboolean</a> need_valids, <a href="glib-Basic-Types.html#gpointer">gpointer</a> data);<a href="glib-Hook-Functions.html#GHook">GHook</a>* <a href="glib-Hook-Functions.html#g-hook-find-func">g_hook_find_func</a> (<a href="glib-Hook-Functions.html#GHookList">GHookList</a> *hook_list, <a href="glib-Basic-Types.html#gboolean">gboolean</a> need_valids, <a href="glib-Basic-Types.html#gpointer">gpointer</a> func);<a href="glib-Hook-Functions.html#GHook">GHook</a>* <a href="glib-Hook-Functions.html#g-hook-find-func-data">g_hook_find_func_data</a> (<a href="glib-Hook-Functions.html#GHookList">GHookList</a> *hook_list, <a href="glib-Basic-Types.html#gboolean">gboolean</a> need_valids, <a href="glib-Basic-Types.html#gpointer">gpointer</a> func, <a href="glib-Basic-Types.html#gpointer">gpointer</a> data);<a href="glib-Hook-Functions.html#GHook">GHook</a>* <a href="glib-Hook-Functions.html#g-hook-first-valid">g_hook_first_valid</a> (<a href="glib-Hook-Functions.html#GHookList">GHookList</a> *hook_list, <a href="glib-Basic-Types.html#gboolean">gboolean</a> may_be_in_call);<a href="glib-Hook-Functions.html#GHook">GHook</a>* <a href="glib-Hook-Functions.html#g-hook-next-valid">g_hook_next_valid</a> (<a href="glib-Hook-Functions.html#GHookList">GHookList</a> *hook_list, <a href="glib-Hook-Functions.html#GHook">GHook</a> *hook, <a href="glib-Basic-Types.html#gboolean">gboolean</a> may_be_in_call);enum <a href="glib-Hook-Functions.html#GHookFlagMask">GHookFlagMask</a>;#define <a href="glib-Hook-Functions.html#G-HOOK-FLAGS:CAPS">G_HOOK_FLAGS</a> (hook)#define <a href="glib-Hook-Functions.html#G-HOOK-FLAG-USER-SHIFT:CAPS">G_HOOK_FLAG_USER_SHIFT</a>#define <a href="glib-Hook-Functions.html#G-HOOK:CAPS">G_HOOK</a> (hook)#define <a href="glib-Hook-Functions.html#G-HOOK-IS-VALID:CAPS">G_HOOK_IS_VALID</a> (hook)#define <a href="glib-Hook-Functions.html#G-HOOK-ACTIVE:CAPS">G_HOOK_ACTIVE</a> (hook)#define <a href="glib-Hook-Functions.html#G-HOOK-IN-CALL:CAPS">G_HOOK_IN_CALL</a> (hook)#define <a href="glib-Hook-Functions.html#G-HOOK-IS-UNLINKED:CAPS">G_HOOK_IS_UNLINKED</a> (hook)<a href="glib-Hook-Functions.html#GHook">GHook</a>* <a href="glib-Hook-Functions.html#g-hook-ref">g_hook_ref</a> (<a href="glib-Hook-Functions.html#GHookList">GHookList</a> *hook_list, <a href="glib-Hook-Functions.html#GHook">GHook</a> *hook);void <a href="glib-Hook-Functions.html#g-hook-unref">g_hook_unref</a> (<a href="glib-Hook-Functions.html#GHookList">GHookList</a> *hook_list, <a href="glib-Hook-Functions.html#GHook">GHook</a> *hook);void <a href="glib-Hook-Functions.html#g-hook-free">g_hook_free</a> (<a href="glib-Hook-Functions.html#GHookList">GHookList</a> *hook_list, <a href="glib-Hook-Functions.html#GHook">GHook</a> *hook);<a href="glib-Basic-Types.html#gboolean">gboolean</a> <a href="glib-Hook-Functions.html#g-hook-destroy">g_hook_destroy</a> (<a href="glib-Hook-Functions.html#GHookList">GHookList</a> *hook_list, <a href="glib-Basic-Types.html#gulong">gulong</a> hook_id);void <a href="glib-Hook-Functions.html#g-hook-destroy-link">g_hook_destroy_link</a> (<a href="glib-Hook-Functions.html#GHookList">GHookList</a> *hook_list, <a href="glib-Hook-Functions.html#GHook">GHook</a> *hook);</pre></div><div class="refsect1" lang="en"><a name="id3008392"></a><h2>Description</h2><p>The <a href="glib-Hook-Functions.html#GHookList"><span class="type">GHookList</span></a>, <a href="glib-Hook-Functions.html#GHook"><span class="type">GHook</span></a> and their related functions provide support forlists of hook functions. Functions can be added and removed from the lists,and the list of hook functions can be invoked.</p></div><div class="refsect1" lang="en"><a name="id3008421"></a><h2>Details</h2><div class="refsect2" lang="en"><a name="id3008426"></a><h3><a name="GHookList"></a>GHookList</h3><a class="indexterm" name="id3008437"></a><pre class="programlisting">typedef struct { gulong seq_id; guint hook_size : 16; guint is_setup : 1; GHook *hooks; GMemChunk *hook_memchunk; GHookFinalizeFunc finalize_hook; gpointer dummy[2];} GHookList;</pre><p>The <span class="structname">GHookList</span> struct represents a list of hook functions.</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><a href="glib-Basic-Types.html#gulong">gulong</a> <em class="structfield"><code>seq_id</code></em>;</span></td><td>the next free <a href="glib-Hook-Functions.html#GHook"><span class="type">GHook</span></a> id.</td></tr><tr><td><span class="term"><a href="glib-Basic-Types.html#guint">guint</a> <em class="structfield"><code>hook_size</code></em> : 16;</span></td><td>the size of the <a href="glib-Hook-Functions.html#GHookList"><span class="type">GHookList</span></a> elements, in bytes.</td></tr><tr><td><span class="term"><a href="glib-Basic-Types.html#guint">guint</a> <em class="structfield"><code>is_setup</code></em> : 1;</span></td><td>1 if the <a href="glib-Hook-Functions.html#GHookList"><span class="type">GHookList</span></a> has been initialized.</td></tr><tr><td><span class="term"><a href="glib-Hook-Functions.html#GHook">GHook</a> *<em class="structfield"><code>hooks</code></em>;</span></td><td>the first <a href="glib-Hook-Functions.html#GHook"><span class="type">GHook</span></a> element in the list.</td></tr><tr><td><span class="term"><a href="glib-Memory-Chunks.html#GMemChunk">GMemChunk</a> *<em class="structfield"><code>hook_memchunk</code></em>;</span></td><td>the <a href="glib-Memory-Chunks.html#GMemChunk"><span class="type">GMemChunk</span></a> used for allocating the <a href="glib-Hook-Functions.html#GHook"><span class="type">GHook</span></a> elements.</td></tr><tr><td><span class="term"><a href="glib-Hook-Functions.html#GHookFinalizeFunc">GHookFinalizeFunc</a> <em class="structfield"><code>finalize_hook</code></em>;</span></td><td>the function to call to finalize a <a href="glib-Hook-Functions.html#GHook"><span class="type">GHook</span></a> element. Thedefault behaviour is to call the hooks <code class="function">destroy</code> function.</td></tr><tr><td><span class="term"><a href="glib-Basic-Types.html#gpointer">gpointer</a> <em class="structfield"><code>dummy</code></em>[2];</span></td><td></td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id3008673"></a><h3><a name="GHookFinalizeFunc"></a>GHookFinalizeFunc ()</h3><a class="indexterm" name="id3008684"></a><pre class="programlisting">void (*GHookFinalizeFunc) (<a href="glib-Hook-Functions.html#GHookList">GHookList</a> *hook_list, <a href="glib-Hook-Functions.html#GHook">GHook</a> *hook);</pre><p>Defines the type of function to be called when a hook in a list of hooks gets finalized.</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><em class="parameter"><code>hook_list</code></em> :</span></td><td>a <a href="glib-Hook-Functions.html#GHookList"><span class="type">GHookList</span></a>.</td></tr><tr><td><span class="term"><em class="parameter"><code>hook</code></em> :</span></td><td>the hook in <em class="parameter"><code>hook_list</code></em> that gets finalized.</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id3008767"></a><h3><a name="GHook"></a>GHook</h3><a class="indexterm" name="id3008777"></a><pre class="programlisting">typedef struct { gpointer data; GHook *next; GHook *prev; guint ref_count; gulong hook_id; guint flags; gpointer func; GDestroyNotify destroy;} GHook;</pre><p>The <span class="structname">GHook</span> struct represents a single hook function in a <a href="glib-Hook-Functions.html#GHookList"><span class="type">GHookList</span></a>.</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><a href="glib-Basic-Types.html#gpointer">gpointer</a> <em class="structfield"><code>data</code></em>;</span></td><td>data which is passed to func when this hook is invoked.</td></tr><tr><td><span class="term"><a href="glib-Hook-Functions.html#GHook">GHook</a> *<em class="structfield"><code>next</code></em>;</span></td><td>pointer to the next hook in the list.</td></tr><tr><td><span class="term"><a href="glib-Hook-Functions.html#GHook">GHook</a> *<em class="structfield"><code>prev</code></em>;</span></td><td>pointer to the previous hook in the list.</td></tr><tr><td><span class="term"><a href="glib-Basic-Types.html#guint">guint</a> <em class="structfield"><code>ref_count</code></em>;</span></td>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -