<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.3"/>
<title>Audacious: hook.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Audacious
 <span id="projectnumber">$Id:Doxyfile42802007-03-2104:39:00Znenolod$</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.3 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_539eecd099282e37732f96b8529d94e5.html">libaudcore</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">hook.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="hook_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * hook.h</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * Copyright 2011 John Lindgren</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * Redistribution and use in source and binary forms, with or without</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * modification, are permitted provided that the following conditions are met:</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * 1. Redistributions of source code must retain the above copyright notice,</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * this list of conditions, and the following disclaimer.</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * 2. Redistributions in binary form must reproduce the above copyright notice,</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * this list of conditions, and the following disclaimer in the documentation</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * provided with the distribution.</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * This software is provided "as is" and without any warranty, express or</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * implied. In no event shall the authors be liable for any damages arising from</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * the use of this software.</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> </div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#ifndef LIBAUDCORE_HOOK_H</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor"></span><span class="preprocessor">#define LIBAUDCORE_HOOK_H</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00023"></a><span class="lineno"><a class="code" href="hook_8h.html#a751c8ef35ff18234fce3577d7c2c5e8b"> 23</a></span> <span class="keyword">typedef</span> void (* <a class="code" href="hook_8h.html#a751c8ef35ff18234fce3577d7c2c5e8b">HookFunction</a>) (<span class="keywordtype">void</span> * data, <span class="keywordtype">void</span> * user);</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> </div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment">/* Adds <func> to the list of functions to be called when the hook <name> is</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"> * triggered. */</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="keywordtype">void</span> <a class="code" href="hook_8c.html#aa22a1a3441cacb3cdc23a90585f6c0da">hook_associate</a> (<span class="keyword">const</span> <span class="keywordtype">char</span> * <a class="code" href="plugin-init_8c.html#a8f8f80d37794cde9472343e4487ba3eb">name</a>, <a class="code" href="hook_8h.html#a751c8ef35ff18234fce3577d7c2c5e8b">HookFunction</a> <a class="code" href="plugins-api_8h.html#a140f43dbe38431fed1594811b2ae7544">func</a>, <span class="keywordtype">void</span> * user);</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment">/* Removes all instances matching <func> and <user> from the list of functions</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"> * to be called when the hook <name> is triggered. If <user> is NULL, all</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"> * instances matching <func> are removed. */</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="keywordtype">void</span> <a class="code" href="hook_8c.html#ac725944bfd2685ba82f8176b42d53219">hook_dissociate_full</a> (<span class="keyword">const</span> <span class="keywordtype">char</span> * <a class="code" href="plugin-init_8c.html#a8f8f80d37794cde9472343e4487ba3eb">name</a>, <a class="code" href="hook_8h.html#a751c8ef35ff18234fce3577d7c2c5e8b">HookFunction</a> <a class="code" href="plugins-api_8h.html#a140f43dbe38431fed1594811b2ae7544">func</a>, <span class="keywordtype">void</span> * user);</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div>
<div class="line"><a name="l00034"></a><span class="lineno"><a class="code" href="hook_8h.html#a7f87c72100a4e828bc2c69adcac76849"> 34</a></span> <span class="preprocessor">#define hook_dissociate(n, f) hook_dissociate_full (n, f, NULL)</span></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment">/* Triggers the hook <name>. */</span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="keywordtype">void</span> <a class="code" href="hook_8c.html#a921722578f3d6b91f84eb3002e64da74">hook_call</a> (<span class="keyword">const</span> <span class="keywordtype">char</span> * <a class="code" href="plugin-init_8c.html#a8f8f80d37794cde9472343e4487ba3eb">name</a>, <span class="keywordtype">void</span> * data);</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> </div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment">/* Schedules a call of the hook <name> from the program's main loop, to be</span></div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"> * executed in <time> milliseconds. If <destroy> is not NULL, it will be called</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment"> * on <data> after the hook is called. */</span></div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="keywordtype">void</span> <a class="code" href="eventqueue_8c.html#a410666d7660a186ca20a723d0471fa76">event_queue_full</a> (<span class="keywordtype">int</span> time, <span class="keyword">const</span> <span class="keywordtype">char</span> * <a class="code" href="plugin-init_8c.html#a8f8f80d37794cde9472343e4487ba3eb">name</a>, <span class="keywordtype">void</span> * data, <span class="keywordtype">void</span> (* destroy) (<span class="keywordtype">void</span> *));</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> </div>
<div class="line"><a name="l00044"></a><span class="lineno"><a class="code" href="hook_8h.html#a6a73c9d31333342d822b4d93bfd53dec"> 44</a></span> <span class="preprocessor">#define event_queue(n, d) event_queue_full (0, n, d, NULL)</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment">/* Cancels pending hook calls matching <name> and <data>. If <data> is NULL,</span></div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"> * all hook calls matching <name> are canceled. */</span></div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="keywordtype">void</span> <a class="code" href="eventqueue_8c.html#aa49ac745eabec30277e9222fdcc9f015">event_queue_cancel</a> (<span class="keyword">const</span> <span class="keywordtype">char</span> * name, <span class="keywordtype">void</span> * data);</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> </div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="preprocessor">#endif </span><span class="comment">/* LIBAUDCORE_HOOK_H */</span><span class="preprocessor"></span></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.3
</small></address>
</body>
</html>
